{"id":13331,"date":"2016-06-22T10:51:38","date_gmt":"2016-06-22T15:51:38","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=13331"},"modified":"2019-12-02T17:16:59","modified_gmt":"2019-12-02T23:16:59","slug":"wifi","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/mtr-software\/mtr-api-reference\/collection-endpoints\/wifi\/","title":{"rendered":"wifi"},"content":{"rendered":"<p>Description: settings for Wi-Fi services : OBJECT<\/p>\n<table style=\"width: 600px; border-collapse: collapse;\" border=\"1\" cellspacing=\"0\" cellpadding=\"0\">\n<tbody>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; background: #4F81BD; padding: 0in .01in 0in .01in; color: white;\" valign=\"top\" width=\"150\"><strong>Element<\/strong><\/td>\n<td style=\"border: solid #4F81BD 1.0pt; background: #4F81BD; padding: 0in .01in 0in .01in; color: white;\" valign=\"top\" width=\"75\"><strong>Type<\/strong><\/td>\n<td style=\"border: solid #4F81BD 1.0pt; background: #4F81BD; padding: 0in .01in 0in .01in; color: white;\" valign=\"top\" width=\"350\"><strong>Description<\/strong><\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">ap<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">OBJECT<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the Wi-Fi access point settings<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0 beaconInterval<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">UINT<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the time between beacon frames in milliseconds (default:100)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0 channel<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the preferred wireless channel, use 1-14 (depending on the country code) or AUTO (default:AUTO)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0 countryCode<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the two-character operating country code<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0 dtimInterval<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">UINT<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the number of frames between delivery traffic indication messages for buffered multicast\/broadcast data (default:1)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0 enabled<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">BOOL<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Enables or disables the Wi-Fi access point (default:false)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0 maxClients<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">UINT<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the maximum number of clients allowed on the access point at any given time (default: 8)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0 networkMode<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the radio mode of operation for the access point, [b, n, bg, or bgn] (default:bgn)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0 \u00a0region<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the region to control configuration of 5 GHz channels<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0 rtsThreshold<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">UINT<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the RTS (Request To Send) threshold (default:2347)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0 security<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">OBJECT<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Contains the Wi-Fi access point security settings<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0\u00a0\u00a0\u00a0 algorithm<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the algorithm used with WPA modes, TKIP, AES, or TKIP+AES (default:TKIP+AES)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0 \u00a0 \u00a0 hidden<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">BOOL<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Enable to connect to hidden network even if the network is not broadcasting<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0\u00a0\u00a0\u00a0 mode<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the security mode used on the access point: NONE, WEP, WPA-PSK or WPA2-PSK (default:NONE)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0\u00a0\u00a0\u00a0 psk<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the pre-shared key for client authentication<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0 ssid<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the network SSID, which may contain only alpha-numeric characters and symbols not including ?, &#8220;, $, [, n, ] and + characters<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">client<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">OBJECT<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the Wi-Fi client settings<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0 enabled<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">BOOL<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Enables or disables the Wi-Fi client (default:false)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0 mode<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the mode used for the Wi-Fi interface, currently the only mode available is WAN<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0 savedNetworks<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">ARRAY<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Contains a list of networks the Wi-Fi client uses to find a connection<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0\u00a0\u00a0\u00a0 enabled<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">BOOL<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Enables or disables the use of a saved network when trying to connect<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0\u00a0\u00a0\u00a0 name<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the name of the saved network<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0\u00a0\u00a0\u00a0 security<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">OBJECT<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the Wi-Fi client security settings<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 algorithm<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the algorithm used with WPA modes: TKIP, AES, or TKIP+AES (default:TKIP+AES)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 mode<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the security mode (default:NONE)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 password<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the password used to connect to the network<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 psk<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the pre-shared key used to connect to the network<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 username<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the\u00a0username used to connect to the network<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0\u00a0\u00a0\u00a0 ssid<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies\u00a0 the network SSID<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0 wpaConfig<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">OBJECT<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the settings gathered from a Wi-Fi scan<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">dual_band<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">BOOL<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Reports capability to transmit on the 5 GHz and 2.4 GHz wireless bands<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">networks<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">ARRAY<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Contains a list of networks found during the most recent Wi-Fi scan<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>&nbsp;<\/p>\n<p>&nbsp;<\/p>\n<p><span style=\"color: #000000; font-family: Verdana, Arial, Helvetica, sans-serif; font-size: 11px;\">\u00a0<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Description: settings for Wi-Fi services : OBJECT Element Type Description ap OBJECT Specifies the Wi-Fi access point settings \u00a0\u00a0 beaconInterval UINT Specifies the time between beacon frames in milliseconds (default:100) \u00a0\u00a0 channel STRING Specifies the preferred wireless channel, use 1-14 (depending on the country code) or AUTO (default:AUTO) \u00a0\u00a0 countryCode STRING Specifies the two-character operating [&hellip;]<\/p>\n","protected":false},"author":1872,"featured_media":0,"parent":13129,"menu_order":67,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-13331","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13331","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/users\/1872"}],"replies":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/comments?post=13331"}],"version-history":[{"count":6,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13331\/revisions"}],"predecessor-version":[{"id":18570,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13331\/revisions\/18570"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13129"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=13331"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}