specification for bu1805gu series tcp/ip built-in …...1.43 apr 2,2013 add the explanation of a...
TRANSCRIPT
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
1/172
Specification for BU1805GU Series
TCP/IP Built-in WLAN
Version 1.52
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
2/172
Notice 1 This document is for informational and instructional purposes. ROHM CO., LTD. reserves the right to
make changes in this document without prior notice. The reader should consult ROHM CO., LTD. to know whether any changes have been made.
2 ROHM CO., LTD. makes no warranty of any kind with regard to this document including, but not limited to, the implied warranties or merchantability and fitness for a particular purpose.
3 ROHM CO., LTD. does not warrant or represent that any license, either express or implied, is granted under any patent right, copyright or other intellectual property right of ROHM CO., LTD. and any other companies.
4 Any duplication in whole or in part is not allowed without prior written agreement from ROHM CO., LTD.
Revision History
Ver. Data Description of Revision
1.00 Nov 10, 2011
First Edition
1.10 Nov 28, 2011
Change WID_START_SCAN_REQ from W only to R/W Add antenna switch control description to WID_ANTENNA_SELECTION page Add 0x09 to the communication mode transition code (FW v394 or later) Add ip_http command (FW v394 or later) Add Reboot function to Web setting (FW v394 or later) Add WID_IP_HTTP (FW v394 or later)
1.11 Dec 16, 2011
Add explanation about WID_UART_RESET in WID_UART_CFG description Add 17. Communication Mode Operation Example Add 18. Power Management Mode Overview Delete company name from Web setting
1.20 Jan 30, 2012
Add max channel setting (FW v411 or later) Add comment to WID_POWER_SAVE Add description about wake character for 7bit data width mode Clarify configuration mode parameters which are also used as initial value in communication mode
1.30 Feb 8, 2012 Add WID_TX_POWER_RATE Correct the maximum number of information read by WID_SITE_SURVEY_RESULT to 8.
1.31 Apr 25,2012 Change the explanation of WID_TX_POWER_RATE Change the explanation of WID_BCAST_SSID Add WPS Registrar processing Correct error writing 6.5 chapter AP Mentioning of a mode Add ICMP Echo Request of the transmission function Add DHCP of the server function
1.32 Apr 27,2012 Add WID_SOC_CONNECT, WID_SOC_ACCEPT and WID_SOC_RCVTMO
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
3/172
1.33 Jun 1,2012 Change of specifications of WID_IP_DHCP_TIM Change of specifications of ip_dhcp_tim command Change the explanation which is at the time of DHCP server choice of TCP/IP communication setting (web) Add the explanation about a set value reflection that 4 chapter and 8 chapter Add the explanation about a communication frame
1.34 Jun 4,2012 Add WID * WID_KEY_ID (VSIE function) * WID_VSIE_FRAME * WID_VSIE_INFO_ENABLE * WID_VSIE_RX_OUI * WID_VSIE_TX_DATA * WID_VSIE_RX_DATA (AP function) * WID_DISCONNECT * WID_REKEY_POLICY * WID_DTIM_PERIOD * WID_REKEY_PERIOD * WID_STA_JOIN_INFO * WID_CONNECTED_STA_LIST
1.35 Jun 29,2012 Cahnge the explanation about a reply of WID_UART_RESET Change the default value of the default gateway and DNS Change the description of the user name of 8.1 chapter (web Authentication)
1.36 Jul 19,2012 "Station Mode" transcription is unified in "STA Mode" It's written clearly to be different in the default value of the ip_dhcp command every mode 13 chapter and 14 chapter are integrated and add firmware change procedure
1.37 Jul 20,2012 An order of the setting is added to the ip_dhcp_start command and WID_IP_DHCP_ADDR Add the explanation of WID_MAINTE_SAVE Add 'N' to the message type.
1.38 Aug 18,2012 Correct the echo request size in 9.4.2 chapter Crrect a line in 6.3 chapter
1.39 Jan 18,2013 Crrect the data size in WID_SOC_RCVTMO Add the explanation to the delimiter setting of the shell command (UART) Add the explanation to the delimiter setting of web setting (serial communication setting)
1.40 Feb 27,2013 Add the target setting item of the preservation in WID_MAINTE_SAVE Add WID_IP_SNDDISCON
1.41 Mar 11,2013 Add ARP table clear of the functions * WID_ARP_DELETE * arp command Add multicast send and receive of the functions * WID_IP_MCAST_TTL * WID_IP_MCAST_JOIN * WID_IP_MCAST_DROP
1.42 Mar 15,2013 Add a packet example of ICMP to 6.3 chapter Writing error correction
1.43 Apr 2,2013 Add the explanation of a command parameter to 4.1 chapter
1.44 Apr 16,2013 Crrect the explanation about a UDP block(9.4.4 Chapter)
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
4/172
1.45 Jul 31,2013 3 chapter: Change the shift explanation to KONFIGUMODO 5 chapter: Add the "a binary frame" form to the communication mode 7.1 chapter: Add uart_dlnum 0 to the command parameter 8.3 chapter: Add the explanation of the end number of characters of the serial communication setting 7.1 chapters and 8.3 chapters: It's changed so that setting of a field separator isn't reflected in config mode 6.3 chapter: Add RP and RADR to the explanation of the data packet structure 10.2.66 chapter: Add the explanation of RP and RADR to WID_SOC_BIND 14 chapter: Writing error correction
1.46 Sept 24,2013
7.1 chapter: Crrect uart_intvl command 7.3 chapter: Add the explanation ip_gate command and the ip_dns command 8.6 chapters: Add the explanation to the gateway address and the DNS address of the TCP/IP communication setting 10.2 chapters :Add the explanation which is at the time of DHCP server function setting of WID_IP_DHCP
1.47 Oct 30,2013 17 chapters :Add a connection procedure example of the AP mode
1.48 Jun 16,2014 Crrect the specified range of WID_JOIN_REQ
1.49 Feb 21,2014 9.1 chapters and 9.4.1 chapters: Crrect the explanation of a multicast
1.50 Feb 25,2014 2 chapter: Add BP3599 and BP3595 to the model list 2.1 Chapter: Add multicast support 2.4.2, 2.5, 3.1 Chapter: Add binary frame format to the communication mode with ASCII – HEX 3 chapter: Renew display contents of a mode of initials 5.1.3 chapter :Corrct WPS of a connection procedure 9.4.10 chapter :Add IGMP Block (Internet Group Management Protorol) The whole: Format unification and wrong word correction
1.51 Jul 25,2014 10.2.28 Chapter: Add the format in case of the AP mode and a status code to WID_WPS_STATUS
1.52 Jul 28,2014 10.2.28 Chapter: The contents of WID_WPS_STATUS are unified with a software development specification
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
5/172
1. CONTENTS TCP/IP Built-in WLAN .............................................................. 1
1. CONTENTS ................................................................... 5
2. Overview ................................................................... 9
2.1. Features ................................................................. 9
2.2. Block Diagram ........................................................... 10
2.3. Examples of System Applications .......................................... 11
2.3.1. Terminal software ................................................... 11
2.3.2. Remote controller ................................................... 11
2.3.3. Monitoring and control system ....................................... 12
2.4. Function Overview ....................................................... 13
2.4.1. Terminal mode ....................................................... 13
2.4.2. Communication mode .................................................. 13
2.4.3. Setting function .................................................... 13
2.5 Operation Mode .......................................................... 14
3. Initial Mode .............................................................. 15
3.1. Automatic Baud Rate Detection ............................................ 17
4. Config Mode ............................................................... 18
4.1. List of Setting Items ................................................... 18
5. Terminal Mode ............................................................. 20
5.1. Features of Communication Protocol ....................................... 20
5.2. Communication Method .................................................... 20
5.3. Support for Power Saving ................................................ 20
6. Communication Mode......................................................... 22
6.1. Features of Communication Protocol ....................................... 22
6.2. Communication Frame ..................................................... 22
6.2.1 ASCII-HEX Frame format ................................................ 23
6.2.2 Binary Frame format ................................................... 23
6.3. Data Packet Structure ................................................... 24
6.4. Configuration Packet Structure ........................................... 26
6.5. NULL Packet Structure ................................................... 29
6.6. Sockets ................................................................. 30
6.7. Support for Power Saving ................................................ 30
7. Shell Command Settings ..................................................... 33
7.1. UART Setting ............................................................ 33
7.2. WLAN Setting ............................................................ 36
7.3. TCP/IP Setting .......................................................... 42
7.4. Setting Reference ....................................................... 47
7.5. System .................................................................. 47
8. Web Setting ............................................................... 50
8.1. Authentication .......................................................... 50
8.2. Main Window ............................................................. 50
8.3. Serial Communication Setting............................................. 51
8.4. Wireless Config Setting ................................................. 54
8.5. WPS Setting ............................................................. 55
8.6. TCP/IP Setting .......................................................... 56
8.7. System .................................................................. 57
8.8. Scan .................................................................... 58
9. TCP/IP Protocol Stack ...................................................... 60
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
6/172
9.1. Features ................................................................ 60
9.2. Host Communication Data ................................................. 60
9.3. Setting Parameters ...................................................... 60
9.4. Specification of Each Block.............................................. 61
9.4.1. IP block (Internet Protocol) ........................................ 61
9.4.2. ICMP (Internet Control Message Protocol) ............................ 61
9.4.3. ARP block (Address Resolution Protocol) ............................. 61
9.4.4. UDP block (User Datagram Protocol) .................................. 61
9.4.5. TCP block (Transmission Control Protocol) ........................... 62
9.4.6. HTTPs block (Hyper Text Transfer Protocol Server).................... 62
9.4.7. DHCPc block (Dynamic Host Configuration Protocol Client) ............. 62
9.4.8. DNSc block (Domain Name System Client) .............................. 62
9.4.9. DHCPc block (Dynamic Host Configuration Protcol Sever) ............... 62
9.4.10. IGMP block (Internet Group Management Protcol) ...................... 62
10. WID Commands .............................................................. 63
10.1. List of WID Commands .................................................. 63
10.2. Detailed WID Specification ............................................ 65
10.2.1. WID_UART_CFG 0x2F10 32bit R/W ...................................... 66
10.2.2. WID_UART_TIMEOUT 0x0F10 8bit R/W ................................... 67
10.2.3. WID_UART_DELAY 0x0F11 8bit R/W ...................................... 68
10.2.4. WID_UART_RESET 0x0F12 8bit W ........................................ 69
10.2.5. WID_UART_PM_ACTIVE_TIME 0x1F10 16bit R/W ............................ 70
10.2.6. WID_BSS_TYPE 0x0000 8bit R/W ........................................ 71
10.2.7. WID_CURRENT_CHANNEL 0x0002 8bit R/W ................................. 72
10.2.8. WID_SSID 0x3000 String R/W .......................................... 73
10.2.9. WID_DEVICE_READY 0x003D 8bit I ...................................... 74
10.2.10. WID_STATUS 0x0005 8bit N/A .......................................... 75
10.2.11. WID_CURRENT_MAC_STATUS 0x0031 8bit R ................................ 76
10.2.12. WID_BSSID 0x3003 String R ........................................... 77
10.2.13. WID_WEP_KEY_VALUE 0x3004 String R/W ................................. 78
10.2.14. WID_11I_PSK 0x3008 String R/W ....................................... 79
10.2.15. WID_11I_MODE 0x000C 8bit R/W ........................................ 80
10.2.16. WID_KEY_ID 0x0009 8bit R/W .......................................... 82
10.2.17. WID_AUTH_TYPE 0x000D 8bit R/W ....................................... 83
10.2.18. WID_MAC_ADDR 0x300C String R ........................................ 84
10.2.19. WID_BCAST_SSID 0x0015 8bit R/W ...................................... 85
10.2.20. WID_POWER_MANAGEMENT 0x000B 8bit R/W ................................ 86
10.2.21. WID_POWER_SAVE 0x010D 8bit W ........................................ 87
10.2.22. WID_LISTEN_INTERVAL 0x000F 8bit R/W ................................. 88
10.2.23. WID_WPS_DEV_MODE 0x0044 8bit R/W .................................... 89
10.2.24. WID_WPS_START 0x0043 8bit R/W ....................................... 90
10.2.25. WID_WPS_PASS_ID 0x1017 16bit R/W .................................... 91
10.2.26. WID_WPS_PIN 0x3025 String R/W ....................................... 92
10.2.27. WID_WPS_CRED_LIST 0x4006 Binary R/W ................................. 93
10.2.28. WID_WPS_STATUS 0x3024 String I ...................................... 95
10.2.29. WID_RSSI 0x001F 8bit R .............................................. 99
10.2.30. WID_SCAN_TYPE 0x0007 8bit R/W ...................................... 100
10.2.31. WID_SITE_SURVEY 0x000E 8bit R/W .................................... 101
10.2.32. WID_START_SCAN_REQ 0x001E 8bit R/W ................................. 102
10.2.33. WID_SITE_SURVEY_RESULTS 0x3012 String R ............................ 103
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
7/172
10.2.34. WID_SCAN_FILTER 0x0036 8bit R/W .................................... 105
10.2.35. WID_JOIN_REQ 0x0020 8bit W ......................................... 106
10.2.36. WID_BEACON_INTERVAL 0x1006 16bit R/W ............................... 107
10.2.37. WID_ENABLE_CHANNEL 0x2024 32bit R/W ................................ 108
10.2.38. WID_ANTENNA_SELECTION 0x0021 8bit R/W .............................. 109
10.2.39. WID_TX_POWER_RATE 0x1006 16bit R/W ................................. 110
10.2.40. WID_FIRMWARE_VERSION 0x3001 String R ............................... 111
10.2.41. WID_SERIAL_NUMBER 0x3018 String R .................................. 112
10.2.42. WID_DTIM_PERIOD 0x0010 8bit R/W .................................... 113
10.2.43. WID_STA_JOIN_INFO 0x4008 Binery N ................................. 114
10.2.44. WID_CONNECTED_STA_LIST 0x4009 Binary R ............................. 117
10.2.45. WID_DISCONNECT 0x0016 8bit W ...................................... 119
10.2.46. WID_REKEY_POLICY 0x0019 8bit R/W .................................. 120
10.2.47. WID_REKEY_PERIOD 0x2010 32bit R/W ................................. 121
10.2.48. WID_VSIE_FRAME 0x00B4 8bit R/W .................................... 122
10.2.49. WID_VSIE_INFO_ENABLE 0x00B5 8bit R/W .............................. 123
10.2.50. WID_VSIE_RX_OUI 0x2084 32bit R/W .................................. 124
10.2.51. WID_VSIE_TX_DATA 0x4085 Binary R/W ................................ 125
10.2.52. WID_VSIE_RX_DATA 0x4086 Binary R/I ................................ 126
10.2.53. WID_IP_DHCP 0x0F20 8bit R/W ....................................... 127
10.2.54. WID_IP_HTTP 0x0F21 8bit R/W ....................................... 128
10.2.55. WID_IP_DHCP_NUM 0x0F22 8bit R/W ................................... 129
10.2.56. WID_IP_DHCP_TIM 0x0F23 8bit R/W ................................... 130
10.2.57. WID_IP_SNDDISCON 0x0F24 8bit R/W .................................. 131
10.2.58. WID_IP_ADDR 0x3F20 String R/W ..................................... 132
10.2.59. WID_IP_NETMSK 0x3F21 String R/W ................................... 133
10.2.60. WID_IP_GATEWAY 0x3F22 String R/W .................................. 134
10.2.61. WID_IP_DNS 0x3F23 String R/W ...................................... 135
10.2.62. WID_IP_RESOLVE 0x3F24 String R/W .................................. 136
10.2.63. WID_IP_DHCP_ADDR 0x3F25 String R/W ................................ 137
10.2.64. WID_SOC_ACCEPT 0x4F00 Binary R/W .................................. 138
10.2.65. WID_SOC_CONNECT 0x4F01 Binary R/W ................................. 140
10.2.66. WID_SOC_BIND 0x4F02 Binary R/W .................................... 142
10.2.67. WID_SOC_REF 0x4F03 Binary R/W ..................................... 144
10.2.68. WID_SOC_RCVTMO 0x4F04 Binary R/W .................................. 146
10.2.69. WID_ARP_DELETE 0x0F26 8bit R/W .................................... 147
10.2.70. WID_IP_MCAST_TTL 0x0F25 8bit R/W .................................. 148
10.2.71. WID_IP_MCAST_JOIN 0x3F26 String R/W ............................... 149
10.2.72. WID_IP_MCAST_DROP 0x3F27 String W ................................. 150
10.2.73. WID_MAINTE_DEFAULT 0x0FF1 8bit W .................................. 151
10.2.74. WID_MAINTE_SAVE 0x0FF0 8bit W ..................................... 152
10.2.75. WID_MAINTE_PASSWD 0x3FF0 String R/W ............................... 153
10.2.76. WID_MAINTE_CRDL 0x0FF2 8bit R/W ................................... 154
11. Hardware Setting ......................................................... 155
11.1 Connection to Host ..................................................... 155
11.2 Reset Latch Setting .................................................... 155
11.3 Recommended Circuit .................................................... 156
12. Firmware Execution........................................................ 158
12.1 Downloading ............................................................ 158
12.1.1 Commands ........................................................... 158
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
8/172
12.1.2 Procedure .......................................................... 158
12.2 Firmware Start ......................................................... 159
13. Firmware Writing ......................................................... 160
13.1 Firmware Writing Procedure.............................................. 160
13.2 Flash ROM Boot ......................................................... 161
13.3 Initialize Setting ..................................................... 161
13.4 Change in firmware ..................................................... 161
13.1 Change procedure by a download start .................................... 162
13.1 Change procedure by FLASH ROM start ..................................... 162
13.1 About the set value of EEPROM ........................................... 163
13.1 About default value setting............................................. 163
14. UART Communication Specification .......................................... 164
14.1. Setting .............................................................. 164
14.2. UART Flow Control .................................................... 164
15. WPS Connection Examples ................................................... 165
15.1. Connection example of Enrollee ....................................... 165
15.2. Shell Setting ........................................................ 165
15.3. Web setting .......................................................... 165
15.4. WID Setting .......................................................... 166
16. GPIO ..................................................................... 167
16.1. Initialization Button ................................................ 167
16.2. WPS Connection Start Button .......................................... 167
16.3. Status Monitor LED ................................................... 167
17. Communication Mode Operation Example ...................................... 168
18. Power Management Mode Overview ............................................ 170
19. Restrictions ............................................................. 172
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
9/172
2. Overview This is a specification for the ROHM BU1805GU Series TCP/IP Built-in WLAN. The following section describes Part Numbers contained in this Specification.
Part No. Description
BU1805GU Wireless LAN baseband IC
BP3580 Wireless LAN module integrating BU1805 baseband IC
BP3591 Wireless LAN module with built-in antenna integrating BP3580 module
BP3599 Wireless LAN module built-in FlashROM integrating BP3591 module
BP3595 Small edition of BP3591
For the purposes of this Specification, wireless LAN hardware is referred to as “BU1805GU”. However, since hardware that is used for practical purposes serves as a module, replace the BU1805GU with BP3580 or BP3591.
2.1. Features Features of the BU1805GU series TCP/IP built-in WLAN include:
■ Built-in TCP/IP stack (IPv4); ■ Built-in UART host interface facilitates communication; ■ Selectable two communication modes according to the intended use; ■ Selectable from TCP server, TCP client, and UDP server; ■ A maximum of 8 sessions (4 each TCP and UDP sessions) can be used simultaneously ■ Built in ARP/ICMP/DHCP client and DNS client; ■ Support remote setting using Web browser; ■ Support unicast (TCP and UDP) and broadcast (only UDP); ■ Station Firmware (in the following, STA Mode) answers to with WLAN infrastructure(in the
following, IBSS Station Mode) and ad-hoc(in the following, IBSS Station Mode); ■ Access Point firmware (in the following, AP mode) corresponds to at most 5 WLAN
infrastructure connections; ■ Support WLAN security (WEP64, WEP128, WPA-Personal, WPA2-Personal, TKIP, and
AES) ■ Built-in access point and ad hoc survey function (site survey function); ■ Support power saving (power management compliant with IEEE802.11 and sleep under the
ROHM’s unique standards); ■ Built-in received signal strength indicator (RSSI) acquisition function ■ Built-in WPS (Wi-Fi protected setup) function
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
10/172
2.2. Block Diagram The following block diagram shows a system configuration.
BU1805GU
TCP/IP Protocol Stack
MAC Controller
WLAN Hardware
WLAN Driver
ARP
IP IGMP
TCP UDP
API
DNSc DHCPc
Host
UART
Host I/F Driver
Host I/F Driver
Application
TCP/IP Protocol Stack
WPS
HTTPs
ICMP
The system shown above reduces burdens involved in host software development by integrating a TCP/IP protocol stack in the WLAN module. User only needs to prepare a host interface driver. For data sent from the host, the BU1805GU automatically add headers according to the TCP/IP, UDP/IP, and WLAN protocols. This allows user to facilitate wireless LAN communication. The system incorporates an UART for host interface focusing in its manageability and versatility even though it has low throughput. The system also incorporates protocols to ensure data transmission and reception, thus enhancing the reliability of data.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
11/172
2.3. Examples of System Applications The TCP/IP built-in WLAN is intended for the following applications.
2.3.1. Terminal software The TCP/IP built-in WLAN achieves WLAN communications as if devices were connected with each other via UART.
Terminal software
BU1805GU
Telnet
UART
AP
"Hello."
"How are you?"
2.3.2. Remote controller Connecting devices via ad hoc network allows for communications without using AP.
Remote controller
BU1805GU
TV
UART
Switch ON
Host microcontroller
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
12/172
2.3.3. Monitoring and control system The TCP/IP built-in WLAN allows for the application of WLAN communications to systems that have used RS-232C interface in the past. Data request
Monitoring & control terminal
BU1805GU
PLC
Temperature request
156C
AP
Control / Reaction
Monitoring and control terminal
BU1805GU
PLC
Control
Reaction
AP
State change notification
Monitoring and control terminal
BU1805GU
PLC
State change
State change
AP
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
13/172
2.4. Function Overview The TCP/IP built-in WLAN provides two communication modes according to their intended use (i.e., terminal mode and communication mode) and setting function.
2.4.1. Terminal mode Terminal mode is a communication mode allowing for WLAN communications as if devices were connected with each other via RS-232C interface. As the terminal mode is the same communication method as that for performing communication via the COM port using terminal software (e.g. Hyper Terminal), the said mode is called like this. The terminal mode is initiated by reading the TCP/IP or WLAN setting that was saved in advance at the time of startup. For detail, refer to information in “5. Terminal Mode”.
2.4.2. Communication mode Communication mode is able to achieve a more complex function compared to terminal mode. Since the TCP/IP built-in WLAN employs a packet communication system, it allows communication mode not only to start a system according to preset values of setting parameters like terminal mode, but also make setting changes while in operation. In addition, the communication mode allows for monitoring of device status in real time and use of more advanced functions (e.g. access point detection function). For detail, refer to information in “6. Communication Mode”.
2.4.3. Setting function The setting function allows for setting of UART, WLAN, and TCP/IP. The setting functions are available in two procedures: setting with the use of interactive shell via UART and that with the use of Web browser via HTTP. Setting items can be saved in WLAN device and reflected at the time of a subsequent startup. For detail, refer to information in “4. Config Mode”.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
14/172
2.5 Operation Mode The figure below shows an operation mode transition diagram. The system always starts with initial mode and transit to a selected operation mode.
Initial Mode
Communication Mode
Terminal Mode
Config Mode
Time-out
run command
System receives “020” consecutive 8 times
System receives “0F1” or “0x09” consecutive 8 times (ASCII - HEX Frame format)
System receives “0F0” or “0x08” consecutive 8 times (Binary Frame format)
The following table describes the overview of each operation mode.
Mode Description
Initial mode Initial mode is a mode to which the system is set right after the system starts up and used to select an operation mode. While in initial mode, the system waits for an instruction for mode selection from the host for a given period of time (mode selection time). For details of initial mode, refer to information in “3. Initial Mode”.
Config mode Config mode is a mode used to change settings and save setting items.
The system will transit to this mode when “020” is sent in consecutive eight bytes within a period of mode selection time while in initial mode. For details of config mode, refer to information in “4. Config Mode”.
Terminal mode Terminal mode is a communication mode designed to pursue facilitating communications. The system will transit to this mode if no command is sent within a period of mode selection time while in initial mode or run command is entered while in config mode. For details of terminal mode, refer to information in “5. Terminal Mode”.
Communication mode
The communication mode which considered use of the high function. When 0xF0 or 0x08 is sent to a communication mode of ASCII-HEX frame format continuously 8 bytes when 0xF1 or 0x09 is sent continuously 8 bytes in the mode selected time by a mode of initials, I transfer to a communication mode of binary frame format(When shifting to a communication mode, it's notified of by a NULL packet (0x2A and 0x0D)). Data width of UART be 0x09 or 0x08 in case of 7 bits, and please do shifting between terminal modes. Refer to "6. Communication mode" for details of a communication mode.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
15/172
3. Initial Mode Initial mode is a mode to which the system is set right after the system starts up and used to select an operation mode.
While in this mode, the system sends “’’ (02B)” to the host with a period of 100 ms until the mode selection time is completed (the default is 1 seconds). (It is not sent for a period of one second right
after startup.) The system will transit to config mode when receiving “’ ‘(020)” in consecutive eight
bytes during the said period of time, or will transit to communication mode when receiving “0F1 / 0x09” or “0xF0 / 0x08” in consecutive eight bytes. The system will transit to terminal mode if it receives no command until the mode selection time is completed.
Contents displayed while in initial mode: /********************************/ IEEE802.11n 1x1 LSI BU1805 Bootloader on ROM (C) 2010 ROHM CO.,LTD. /********************************/ H/w version = 00000013 ROM version = 3.0.2 reset_latch = 00000002 mode2 Flash region1 boot /********************************/ UART-Wireless Conversion Copyright (C) 2010 ROHM CO.,LTD. /********************************/
++++++++++ ← ‘” is being displayed with a period of 100 ms.
Contents displayed when the system transits to config mode:
/********************************/ IEEE802.11n 1x1 LSI BU1805 Bootloader on ROM (C) 2010 ROHM CO.,LTD. /********************************/ H/w version = 00000013 ROM version = 3.0.2 reset_latch = 00000002 mode2 Flash region1 boot /********************************/ UART-Wireless Conversion Copyright (C) 2010 ROHM CO.,LTD. /********************************/
++++++++++ ← Inputs “020” (space) eight times, and then transits to config mode
#
#hlp ← Command used to display a list of commands
SYNTAX : cmd arg1 arg2 arg3 cmd arg desc -------------------- -------------------- -------------------------------- uart_cfg {dir} [r][d][p][s][f] UART: Configuration uart_to {dir} [sec] UART: Start timeout (Snip)
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
16/172
arp {permit} ARP table erase passwd {dir} [password] Password of WEB setting Show: all commands help
Contents of display when the system transits to terminal mode:
/********************************/ IEEE802.11n 1x1 LSI BU1805 Bootloader on ROM (C) 2010 ROHM CO.,LTD. /********************************/ H/w version = 00000013 ROM version = 3.0.2 reset_latch = 00000002 mode2 Flash region1 boot
++++++++++++++++++++ ← No inputs results in transition to terminal mode
Contents of display when the system transits to communication mode:
/********************************/ IEEE802.11n 1x1 LSI BU1805 Bootloader on ROM (C) 2010 ROHM CO.,LTD. /********************************/ H/w version = 00000013 ROM version = 3.0.2 reset_latch = 00000002 mode2 Flash region1 boot ++++++++++++++* ←
The system transfers “0F1” or “0x09” in consecutive eight bytes, and then transits to communication mode
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
17/172
3.1. Automatic Baud Rate Detection While in initial mode, baud rate adjustment can be performed with the automatic baud rate detection function. Note that this function can be used only when data bit is set to 8bit.
The host can trigger baud rate adjustment by continuously sending ‘A’ or ’a’ (“041” or “061”). When
a baud rate is determined, the system will receive “02A” and “00D”.
Sending eight byte of given characters (020 or 0F1/0x09 or 0F0/0x08) after the baud rate is determined allows the system to make a mode selection. Automatic baud rate detection sequence:
020 or
0F1/0x09 or 0xF0/0x08 ?
Transit mode with eight consecutive bytes
YES
NO
0x41 or 0x61 ? YES
Determine baud rate and
Send “02A” and “00D” to the host
NO
Extend mode selection time by 100 msec
Reduce the baud rate in the order presented below
921600 bps 460800 bps 230400 bps 115200 bps 57600 bps 38400 bps 19200 bps 9600 bps 4800 bps 2400 bps 1200 bps
Reduce the baud rate every 6-time other than
0x41 or 0x61 is detected
Receive data from host
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
18/172
4. Config Mode Config mode is used to make various configuration settings. Settings and information reference listed below is possible by command operations using shell command via UART or using Web browser (over WLAN).
Function Description
UART setting Used to make UART-related settings including baud rate, data width, parity on/off, stop bit length, and flow control on/off as well as buffer size and delimiter settings, etc.
WLAN setting Used to set communication mode (BSS or IBSS), channel, SSID, encryption mode, and passphrase, etc.
TCP/IP setting Used to set IP address, subnet mask, gateway, DHCP, DNS, and port number, etc.
Setting reference Used to refer to all setting parameters of UART, WLAN, and TCP/IP.
Maintenance and management
Used to save setting parameters, display a list of commands, and change operation mode to terminal mode.
4.1. List of Setting Items The table below is a list of setting items in config mode. For details of the setting items, refer to description provided hereinafter.
Function Shell Command Setting Item Target (*1)
UART uart_cfg UART parameters (e.g. baud rate) ALL ○
setting uart_to Mode selection time (in seconds) ALL ○
uart_delay Inter-character send delay time ALL ○
uart_dlnum Number of delimiters ALL ×
uart_dl1 First byte of delimiter ALL ×
uart_dl2 Second byte of delimiter ALL ×
uart_udpdl With or without delimiter used to receive UDP
ALL ×
uart_intvl Send intervals (in ms) ALL ×
uart_bufsz Send buffer size (in bytes) ALL ×
uart_pmact Power save mode active time BSS-STA ○
WLAN wlan_type Communication mode (BSS or IBSS) ALL ○
setting wlan_chan Channel IBSS-STA/AP ○
wlan_ssid SSID ALL ○
wlan_wep WEP key ALL ○
wlan_psk WPA/WPA2 passphrase BSS-STA/AP ○
wlan_sec Encryption mode ALL ○
wlan_pm Power save mode BSS-STA ○
wlan_pin WPS pin code BSS-STA/AP ○
wlan_wps WPS connection BSS-STA/AP ---
wlan_crdl Connection using credentials on start-up
BSS-STA ○
wlan_mac MAC address ALL ---
wlan_max_chan Maximum channel number ALL ○
wlan_con WLAN status ALL ---
TCP/IP ip_dhcp DHCP enabled/disabled ALL ○
setting ip_addr IP address ALL ○
ip_mask Subnet mask ALL ○
ip_gate Gateway ALL ○
ip_current IP address acquired with DHCP ALL ○
ip_dns DNS server IP address ALL ○
ip_dhcp_start DHCP lease starting IP address AP ○
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
19/172
Function Shell Command Setting Item Target (*1)
ip_dhcp_num The number of DHCP lease IP addresses
AP ○
ip_dhcp_tim DHCP lease time AP ○
ip_http HTTP setting ALL ○
ip_term_prot Protocol (e.g. UDP, TCPs, or TCPc) used in terminal mode
ALL ×
ip_term_hp Own port number used in terminal mode ALL ×
ip_term_rp Remote port number used in terminal mode
ALL ×
ip_term_ra Remote IP address (or DNS name) used in terminal mode
ALL ×
ip_sock Socket information ALL ---
Setting uart Batch reference to the setting parameters of UART
ALL ---
reference wlan Batch reference to the setting parameters of WLAN
ALL ---
ip Batch reference to the setting parameters of TCP/IP
ALL ---
ver Version reference ALL ---
Maintenance hlp Used to display a list of commands. ALL ---
and default Used to restore default setting. ALL ---
Management save Used to save setting. ALL ---
run Used to transit to terminal mode. ALL ---
ping ICMP Echo Request transmission. ALL ---
arp ARP clearance in a table. ALL ---
passwd Used to change login password for Web setting
---
Target : Firmware includes the following operation mode, and it's different in WID which can be used every mode. ROM :It's practicable by a ROM program (boot loader). ALL :It's practicable by all firmware modes except for ROM. STA :It's practicable by IBSS/BSS-STA mode. BSS-STA :It's practicable by BSS-STA mode. BSS-STA/AP :It's practicable by BSS-STA mode and the AP mode. IBSS-STA/AP :It's practicable by IBSS-STA mode and the AP mode. (*1) ○ means the parameters set in Config Mode or Web setting are also used as initial value in communication mode. For details of commands, refer to information in “7. Shell Command Settings”. For details of Web setting, refer to information in “8. Web Setting. The case which includes a blank in a parameter character string of each command, " " ", please, please conclude and designate it." " " Please, the character string bound up handles "\" as the special character, and the character next to "\" becomes effective.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
20/172
5. Terminal Mode Terminal mode is the best suited mode to perform WLAN communications in the same way as that to perform UART communications. Once the configuration has been done, the system can initiate communication without making any setting at the time of startup. Consequently, terminal mode allows for WLAN communications as if devices were connected with each other via RS-232C interface. However, it is not allowed to make any change to TCP/IP and WLAN settings in this mode.
5.1. Features of Communication Protocol Features of the communication protocol used in terminal mode include:
■ Data communications can be done using terminal software ■ Communications performed by the character (No frame needs to be created); ■ Automatic startup/connection (Presetting needs to be done); ■ No online setting changes are allowed ■ Support for power saving ■ Only stand alone mode can be used for WPS The AP More than one STA and Wireless LAN access are made of a mode, but it's only to 1 of STA that you can communicate by a terminal mode.
5.2. Communication Method Terminal mode allows for sending and receiving of data in the range of “000” to “0FF”.
Data are sent in a batch over WLAN after a lapse of set send interval (default 100 ms), or when a
delimiter (default 00D) is sent from the host or data reaches the send buffer size (default 1,460 bytes). Until then, data are accumulated in the internal buffer. Received data from WLAN side are not accumulated in the internal buffer, but sent to the host at the time when the data is received. Note: It is possible to change send intervals with the “uart_intvl” command, delimiter with the
“uart_dlnum” and “uart_dl1/uart_dl2” commands, and send buffer size with the “uart_bufsz” command.
5.3. Support for Power Saving In terminal mode, the power management function compliant with the IEEE802.11 standard can be used as a power saving function. The power management function can be enabled in config mode. When the power management function is enabled, the BU1805GU will be normally in sleep mode. Consequently, the BU1805GU should be awaked to send data. To awaken it, awake characters should be sent as described below. ■ Awake character and limitations
The awake character is four-byte(8bit data only) / five-byte(no data width restriction) “U” (055) character. Although BU1805GU will wake up by other character, DO NOT not use such character other than “U”. There are some implementation which assume “U” as awake character. The following transfer limitations are levied on the awake character:
1) A wait for a period of not less than 300 sec should be provided between first two bytes (or three bytes) and last two bytes. (However, the said wait is not required to transfer data at the baud rate of not faster than 9600 bps.)
2) The four-byte (or five-byte) awake character should be transferred within a limited period of time. This period of time is referred to as a limitation on awake character transfer time and served as a limit value that varies with baud rate.
3) A given wait is required after the BU1805GU is waken up with the awake character until data is
sent (i.e., it is required to wait for the BU1805GU to awake).
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
21/172
■ Baud rates and limit values
Baud Rate (bps)
Limitation 1 [Wait between awake characters]
Limitation 2 [Limitation on awake character transfer time]
Limitation 3 [Wait between awake character and data]
1200 Not required (4/5 bytes) 45 msec 96 msec
2400 Not required (4/5 bytes) 22 msec 48 msec
4800 Not required (4/5 bytes) 12 msec 24 msec
9600 Not required (4/5 bytes) 6 msec 12 msec
19200 Required (5/6 bytes) 3600 μsec 8 msec
38400 Required (6/7 bytes) 2000 μsec 6 msec
57600 Required (7/8 bytes) 1600 μsec 5 msec
115200 Required (8/9 bytes) 1000 μsec 4 msec
230400 Required (12/13 bytes) 1000 μsec 4 msec
460800 Required (22/23 bytes) 1000 μsec 4 msec
921600 Required (32/33 bytes) 1000 μsec 4 msec
Reference value of the number of awake characters with consideration of Limitation 1 wait. (4byte case/5byte case) Limitation 1 is satisfied by sending specified number of awake characters.
■ No procedures are required to receive data. Just receive data sent from the BU1805GU in the normal way.
■ Awake characters may be sent as WLAN data. (Since the BU1805GU wakes up at a constant period, receiving awake characters at this time will send them as WLAN data.) Consequently, some handling to ignore the awake characters on the receiver side might be required.
■ When the configured power save mode active time (default 10,000 ms) is completed after the BU1805GU wakes up, it will return to the sleep state again. In order to send data from the host after the awake time has elapsed, execute the awake sequence once again. (The power save mode active time can be changed with the “uart_pmact” command.)
■ If only awake character is sent when the power management function is enabled, BU1805GU keep awaking and will not go into sleep state. Therefore make sure to send awake character and data without violating the limitations.
H
L
Limitation 1: Wait of not less than 300 sec
Limitation 2: Limitation on awake
character transfer time
Awake character: 2byte (8bit data only) or 3byte
Limitation 3: Wait between awake character and data
Awake character: 2byte
Data
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
22/172
6. Communication Mode Communication mode is suitable to build a more advanced system compared to terminal mode. For terminal mode, settings should be made before the system starts up. In contrast, communication mode allows setting changes to be made online while the system is in operation. Furthermore, utilizing the WLAN functions with the use of configuration packet called WID allows for use of more advanced functions (e.g. the function of detecting access points (site survey function) and that of received signal strength indicator (RSSI)).
6.1. Features of Communication Protocol Features of the communication protocol used in communication mode include:
■ Variable packet length ■ Data form is "ASCII-HEX Frame" or "binary frame". ■ Data transfer identification by socket ■ Online setting changes enabled by using WID ■ Support for power saving As data transfer is performed by frame in communication mode, the data is sent to WLAN when End of Frame (EOF) is detected.
6.2. Communication Frame The following section describes the format of communication frame for communication mode.
HDR MSG
L2 PT L0 L1
PT Packet type
L2-0 Packet length
01(DATAOUT)
02(DATAIN)
03(CONFIGRSP)
04(CONFIGREQ)
Byte length of MSG region (L21, L12, and L03 for 0x123 byte)
2 bytes
MSG Message body Body of MSG region (0 to 1468 bytes)
SOF
SOF Start of frame Character that can start a frame ‘’(02A)
1 byte 0 to 1468 bytes
EOF
1 byte
EOF End of frame Character that can end a frame CR(00D)
HOST→ BU1805GU WLAN communication packet
HOST← BU1805GU WLAN communication packet
HOST← BU1805GU WID packet
HOST→ BU1805GU WID packet
There are "ASCII-HEX frame" and "binary frame" in communication frame format of a communication mode. You decide about choice of communication frame format by the data which is at the time of a communication mode shift. ■0xF1/0x09 is received continuously 8 bytes → ASCII-HEX Frame format ■0xF0/0x08 is received continuously 8 bytes → Binary Frame format
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
23/172
6.2.1 ASCII-HEX Frame format Data between SOF and EOF of the communication frame should be converted into ASCII-HEX format. It's mentioned by the binary form so that it may be easy to judge from this specification but an actual length starts to be the next example(HDR=4byte and MSG=0-2936byte).
SOF HDR MSG EOF
Before conversion: * 0 8 4 0 5 1 0 A 0 8 0 0 0 2 0 0 0 1 0 B CR
After conversion: 2A 30 38 34 30 35 31 30 41 30 38 30 30 30 32 30 30 30 31 30 42 0D
6.2.2 Binary Frame format
The system the data inserted into SOF and EOF is binary and to which is forwarded. An escape sequence is used to classify cable in the data as SOF/EOF. An escape code is 0x1B (ESC). When 0x2A (SOF) and 0x0D (EOF) exist in whole binary data inserted into SOF and EOF (HDR and MSG), an escape code (0x1B) is added in front of it. Please include an increment of the number of characters by the escape code of MSG in frame size of HDR.(The escape code number of characters of HDR isn't included in frame size of HDR.)
SOF HDR MSG EOF
Before conversion: * 0 8 4 0 5 1 0 A 0 8 0 0 0 2 0 0 0 1 0 B CR
After conversion: 2A 0A 40 51 1B 2A 08 00 02 1B 0D 01 0B 0D
(1) Start of Frame (SOF) SOF is an identifier that indicates the head of a frame (‘’ (02A)) and can be used to detect data misalignment. If data misalignment occurs, the data will be skipped until end of frame (EOF) is received.
(2) Packet type (Parameter “PT” of HDR) Packet type is an identifier that identifies the types of packets. Packets are classified broadly into WLAN communication packets, WID packets, and control packets. WLAN communication packets (DATAIN, DATAOUT) and WID packets (CONFIGRSP, CONFIGREQ) are bidirectional.
(3) Packet length (Parameter “L2-0” of HDR) Used to specify the byte length of MSG region by 12 bits. Since control packets have no MSG region, this parameter is set to “0”.
(4) Message body (MSG) MSG is the body of MSG region. The structure varies with packet types.
The number of characters of the
escape code. (2byte) is included.
Add 0x1B Add 0x1B
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
24/172
Control packets have no MSG region. The contents of WLAN communication packets become the payload of TCP/IP or UDP/IP.
(5) End of frame (EOF) EOF is an identifier that indicates the end of frame (CR (00D)). Data is accepted as frame at the time when this character is received.
6.3. Data Packet Structure The following section shows a data packet structure.
HDR MSG
L2 PT L0 L1
SID RSV RP MBODY
PT Packet type
L2-L0 Packet length
1 Packet to WLAN, 2 Packet from WLAN
Byte length of MSG region
SID Socket ID
RSV Reserved
TCP 1 to 4, UDP 11 to 14, ICMP = 0
Fixed to 000
RP
RADR
Remote port
Remote address
Send (see Note-1) Destination port number, Receipt Source port number
Send (see Note-2) Destination IP address, Receipt(see Note-3) Source IP address
2 bytes
1 byte 1 byte 2 bytes n bytes
HDR MSG SOF EOF
RADR
4 bytes
MBODY Message body Only payload of communication data (1 to 1460 bytes)
Note-1, -2: Can be specified only for UDP and a little-endian host byte ordering format is used. Note-1: Setting the parameter to “0” will disable RP and RADR and a value set with
WID_SOC_BIND will be enabled. Note-2: It's possible to designate only UDP and ICMP. ICMP is indispensable and when RP is
besides 0, UDP is effective. [About ICMP Echo Request] ■ Transmission Setting of a socket (10.2.WID in-depth specification referring) isn't necessary like TCP and UDP by a transmission of ICMP Echo Request. The socket ID is set as 0 and the remote address (RADR) is designated. Please give dummy data of a sent length to the message body (MBODY). Data of ICMP Echo Request sent actually (the ID and the sequence number, etc.) is generated by firmware. ■ Reception When firmware receives ICMP Echo Reply to sent ICMP Echo Request, data of socket ID=0 is sent to the host. The sender address is stocked in the remote address (RADR Note-3). ■ Time-out
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
25/172
Retransmission processing is performed as follows by firmware. A host can judge that time-out occurred when the remote address (RADR Note-3) received data of 0. (It'll be sent to a host at most 14 seconds later.) When data of socket ID=0 doesn't return to a host, there is a possibility of (lack of dummy data/data Lost) that ICMP Echo Request from a host isn't normally reaching firmware. ■ Packet example When ICMP Echo Request was sent to "192.168.3.8", and ICMP Echo Reply was received. When ICMP Echo Request was sent to "192.168.3.1" and time-out was done.
Data of socket ID=0 is received from a host
Echo Request is sent
Is ICMP Echo Reply
received?
The resending
frequency = 3 times?
NO
NO
Time-out
The 1st time: 2 seconds
The 2nd time: 4 seconds
The 3rd time: 8 seconds
1-3 times of time-out occurs.
(Total of 14 seconds)
Set the remote address(RADR Note-3) 0 clears the remote address(RADR Note-3)
YES YES
Data of socket ID=0 is sent to a host
TX: 4010000000000803A8C000000000000000000000000000000000000000000000000000
00000000000000000000000000000000000000000000000000000000000000
RX: 4020000000000803A8C045000054906B00008001220FC0A80308C0A803D60000D1DA35
120200000102030405060708090A0B0C0D0E0F101112131415161718191A1B
TX: 4010000000000103A8C000000000000000000000000000000000000000000000000000
00000000000000000000000000000000000000000000000000000000000000
RX: 402000000000000000000800000038120500000102030405060708090A0B0C0D0E0F10
1112131415161718191A1B1C1D1E1F202122232425262728292A2B2C2D2E2F
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
26/172
6.4. Configuration Packet Structure The following section shows a configuration packet structure.
HDR MSG
L2 PT L0 L1
MTYP SN MLEN MBODY
PT Packet type
L2-L0 Packet length
3 Packet from WLAN, 4 Packet to WLAN
Byte length of MSG region
MTYP Message type
SN Sequence number
051('Q') Query, 052('R') Response, 0x57('W') Write, 049('I') Information
Sequential number from 000
MLEN
MBODY
Message length
Message body
Byte length of MSG region
Data body (For detail, refer to information provided later in this Specification)
2 bytes
1 byte 1 byte 2 byte n bytes
HDR MSG SOF EOF
WID message is put in the MSG region. For details of WID message, refer to information in “10. WID”.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
27/172
(1) Message types (MTYP) Message types include the following:
Message Type Value Function
Query 'Q' Used to acquire a WID value.
Write 'W' Used to set WID value.
Response 'R' Used for response to a query and write request.
Information 'I' Used to notice asynchronous information from WLAN.
Network ‘N’ Used to notice network information from WLAN
The following chart shows the sequence of each message type.
HOST WLAN
'Q' (Query)
'R' (Response) WID_*****
'W' (Write)
'R' (Response) WID_STATUS
'I' (Information)
'Q' (Queried) WID value is responded by 'R' Response”.
In order to indicate that 'W' (Write) request has been accepted, WID_STATUS(0x0005) is responded by 'R' (Response).
WLAN state change is noticed by 'I' (Information).
'N' (Network) Network state change is noticed by ‘N’(Network)
(2) Sequence Number (SN) Sequence number is used to recognize a correspondence between request and response. To ‘Q’ (Query) or ‘W’ (Write) message from HOST, ‘R’ (Response) message have the same sequence number as that of ‘Q’ or ‘R’.
The sequence number starts with “000” and HOST increments it by packet. (Make SN
setting so that the sequence number after “0FF” will return to “000”). For 'I' (information) message, the BU1805GU increments the sequence number.
(3) Message length (MLEN) Byte length in MSG (Byte length in MTYP + SN + MLEN + MBODY) is indicated. * ASCII-HEX frame fromat: The length of the front changed to ASCII-HEX (half of ASCII-HEX)
* Binary frame format: The length not including the increments of the number of characters by the escape code
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
28/172
(4) Message body (MBODY) The structure of message body varies with message types (MTYP). The following section describes the structure of each message body. Please make the size (SIZ) following byte length. * ASCII-HEX frame fromat: The length of the front changed to ASCII-HEX (half of ASCII-HEX)
* Binary frame format: The length not including the increments of the number of characters by the escape code
■ Message type ‘Q’ (Query) Specify one data you want to query.
WID
2 byte
WID WID number For details of WID number, refer to description provided hereinafter.
■ Message type 'W' (Write) Specify one data you want to write. The format of 8bit, 16bit, 32bit, and string message types are shown below.
WID SIZ VAL
2 1 byte
WID WID number For details of WID number, refer to description provided hereinafter.
SIZ Size Byte length of VAL
VAL WID set value Value to be set to WID
n
The format of binary message type is as shown below.
WID SIZ VAL
2 2 byte
WID WID number For details of WID number, refer to description provided hereinafter.
SIZ Size Byte length of VAL
VAL WID set value Value to be set to WID
n
SUM
SUM Checksum Lower one byte of the result of summing values set with VAL in terms of bytes
1
■ Message type ''R' (Response) This message type is used to make a response to a query (‘Q) and write (‘W’) request. WID value queried is stored in a response to the query (‘Q’). ”WID_STATUS” is used to make a response to write (‘W’) request. The format of 8bit, 16bit, 32bit, and string message types are shown below:
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
29/172
WID SIZ VAL
2 1 byte
WID WID number For details of WID number, refer to description provided hereinafter.
SIZ Size Byte length of VAL
VAL WID value WID value in a response
n
The format of binary message type is as shown below.
WID SIZ VAL
2 2 byte
WID WID number For details of WID number, refer to description provided hereinafter.
SIZ Size Byte length of VAL
VAL WID value WID value in a response
n
SUM
SUM Checksum Lower one byte of the result of summing values set with VAL in terms of bytes
1
■ Message type 'I'(Information) An event issued asynchronously from WLAN.
WID SIZ VAL
2 1 byte
WID WID number For details of WID number, refer to description provided hereinafter.
SIZ Size Byte length of VAL
VAL WID value Value reported by WID
n
6.5. NULL Packet Structure A null packet structure is shown below.
SOF EOF
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
30/172
6.6. Sockets The following combinations are referred to as a socket, respectively. • UDP socket: Local IP Address and Local Port Number • TCP socket: Local/Remote IP Address and Local/Remote Port Number While in communication mode, settings, reference, and data transfer are executed to sockets. A maximum of eight sockets (four each for TCP and UDP) can be used. Accesses to the sockets are identified by relevant socket ID.
Application Socket
ID
Default Information
Protocol Local IP Address
Local Port
Remote Port
Remote IP Address
Receive Time-out
TCP
1 Unused 192.168.0.1 16384 16384 192.168.0.2 0 (None)
2 〃 〃 16385 16385 〃 〃
3 〃 〃 16386 16386 〃 〃
4 〃 〃 16387 16387 〃 〃
UDP
11 〃 〃 16384 16384 〃 〃
12 〃 〃 16385 16385 〃 〃
13 〃 〃 16386 16386 〃 〃
14 〃 〃 16387 16387 〃 〃
Note: For further details, refer to: 6.3 Data Packet Structure
10.2 WID_SOC_ACCEPT 10.2 WID_SOC_CONNECT 10.2 WID_SOC_BIND 10.2 WID_SOC_REF 10.2 WID_SOC_RCVTMO
6.7. Support for Power Saving Two types of power saving functions are available for use in communication mode.
■ IEEE802.11-compatible power management function (set by WID_POWER_MANAGEMENT)
■ Sleep function of the ROHM’s proprietary specification (set by WID_POWER_SAVE) These power saving functions can be used only by STA mode. The power management of IEEE802.11 standard is practicable only by BSS-STA mode. In order to execute the IEEE802.11-compatible power management function, set “WID_POWER_MANAGEMENT” to “Enabled”. While the power management function is set to “Enabled”, the BU1805GU repeats awake and sleep modes at its own timing. To send a frame from the host, the BU1805GU should be set to the awake state in advance. In order to execute the sleep function of the ROHM’s proprietary specification, set “WID_POWER_SAVE” to “Sleep”. While in sleep mode, all functions except for the function of detecting UART reception are disabled. Setting “WID_POWER_SAVE” to “Active” will return the BU1805GU to the state before sleep mode. In both power saving modes, BU1805GU should be set to the awake state in advance to send data.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
31/172
■ Awake character and limitations
The awake character is four-byte(8bit data only) / five-byte(no data width restriction) “U” (055) character. Althgouh BU1805GU will wake up by other character, DO NOT use such character other than “U”. There are some implementation which assume “U” as awake character. The following transfer limitations are levied on the awake character:
1) A wait for a period of not less than 300 sec should be provided between first two bytes (or three bytes) and last two bytes. (However, the said wait is not required to transfer data at the baud rate of not faster than 9600 bps.)
2) The four-byte (or five-byte) awake character should be transferred within a limited period of time. This period of time is referred to as a limitation on awake character transfer time and served as a limit value that varies with baud rate.
3) A given wait is required after the BU1805GU is waken up with the awake character until data is
sent (i.e., it is required to wait for the awake of the BU1805GU). ■ Baud rates and limit values
Baud Rate (bps)
Limitation 1 [Wait between awake characters]
Limitation 2 [Limitation on awake character transfer time]
Limitation 3 [Wait between awake character and data]
1200 Not required (4/5 bytes) 45msec 96msec
2400 Not required (4/5 bytes) 22msec 48msec
4800 Not required (4/5 bytes) 12msec 24msec
9600 Not required (4/5 bytes) 6msec 12msec
19200 Required (5/6 bytes) 3600μsec 8msec
38400 Required (6/7 bytes) 2000μsec 6msec
57600 Required (7/8 bytes) 1600μsec 5msec
115200 Required (8/9 bytes) 1000μsec 4msec
230400 Required (12/13 bytes) 1000μsec 4msec
460800 Required (22 /23bytes) 1000μsec 4msec
921600 Required (32/33 bytes) 1000μsec 4msec
Reference value of the number of awake characters with consideration of Limitation 1 wait. (4byte case / 5byte case) Limitation 1 is satisfied by sending the specified number of awake characters.
■ No procedures are required to receive data. Just receive data sent from the BU1805GU in the normal way.
■ Awake characters may be sent as WLAN data. (Since the BU1805GU wakes up at a constant period, receiving awake characters at this time will send them as WLAN data.) It
H
L
Limitation 1: Wait of not less than 300 sec
Limitation 2: Limitation on awake
character transfer time
Limitation 3: Wait between awake character and data
Awake character: 2byte
Data
Awake character: 2byte (8bit data only) or 3byte
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
32/172
might be required to implement some handling procedure to ignore the awake characters on the receiver side.
■ When the configured power save mode active time (default 10,000 ms) is completed after the BU1805GU wakes up, it will return to the sleep state again. In order to send data from the host after the awake time has elapsed, execute the awake sequence once again. (The power save mode active time can be changed with the “uart_pmact” command.)
■ If only awake character is sent when the power management function is enabled, BU1805GU keep awaking and will not go into sleep state. Therefore make sure to send awake character and data without violating the limitations.
Note: Limitation 3 [Wait between awake character and data]
Communication mode allows for making a query about awake using null packet (02A, 00D). Sending a null packet instead of Limitation 3 (wait between awake character and data) and then waiting for another null packet makes it possible to confirm that the BU1805GU wakes up.
Host BU1805GU
Awake character
Null packet
Null packet
Null packet
Awake
Null packet
Confirm that BU1805GU awakes
Data
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
33/172
7. Shell Command Settings This Chapter describes all shell commands used in config mode.
7.1. UART Setting
(1) uart_cfg command Used to set UART communication parameters and refer to the setting.
■ Command formats uart_cfg set baudrate {datawidth {parity {stopbit {flowctrl}}}} uart_cfg get
■ Command arguments
Argument Setting Parameter Set Value
set/get Selection of setting or reference
set: Setting
get: Reference
baudrate Baud rate 1200: 1,200(baud)
2400: 2,400(baud)
4800: 4,800(baud)
9600: 9,600(baud)
19200: 19,200(baud)
38400: 38,400(baud)
57600: 57,600(baud)
115200: 115,200(baud) <Default>
230400: 230,400(baud)
460800: 460,800(baud)
921600: 921,600(baud)
datawidth Data width 7: 7(bit)
8: 8(bit) <Default>
parity Parity none: no parity <Default>
odd: Odd parity
even: Even parity
stopbit Stop bit 1: 1(bit) <Default>
2: 2(bit)
flowctrl Flow control off: Disabled <Default>
on: Enabled
(2) uart_to command Used to set initial mode selection time and refer to the setting.
■ Formats uart_to set time uart_to get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
Time Mode selection time 1 to 60 (sec) <Default 3 (sec)>
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
34/172
(3) uart_delay command Used to set delay time between consecutive bytes sent from BU1805GU to host, and refer to the setting.
■ Formats uart_delay set time uart_delay get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
time Send delay time 0 to 3 (100us) <Default 0 (100us)>
(4) uart_dlnum command Used to set the number of delimiters and refer to the setting. Delimiter is a character indicating the end of an input string of characters and maximum two
characters can be used as a delimiter such as CRLF. The number of delimiters specifies the number of the characters. This setting is effective by a terminal mode. Example of delimiter setting:
Delimiter Number First Byte Second Byte
None 0 --- ---
CR 1 CR(0x0D) ---
CR+LF 2 CR(0x0D) LF(0x0A)
■ Formats uart_dlnum set num uart_dlnum get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
num Number of delimiters 1: 1 (byte) <Default>
2: 2 (byte)
(5) uart_dl1 command Used to set the first byte of a delimiter and refer to the setting. This setting is effective by a terminal mode.
■ Formats uart_dl1 set char uart_dl1 get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
Char First byte of delimiter 000 to 0FF <Default CR(00D)>
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
35/172
(6) uart_dl2 command Used to set the second byte of a delimiter and refer to the setting. This setting is effective by a terminal mode.
■ Formats uart_dl2 set char uart_dl2 get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
char Second byte of delimiter 000 to 0FF <Default LF(00A)>
(7) uart_udpdl command Used to select Add or Not add of delimiters for UDP receive, and refer to the setting. Setting this command to “Add” will add delimiters (i.e., delimiters set with the “uart_dlnum”, “uart_dl1”, and “uart_dl2” commands).
■ Formats uart_udpdl set mode uart_udpdl get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
Reference get: Reference
mode Add or Not add off: Not add <Default>
delimiters on: Add
(8) uart_intvl command Used to set time intervals to send buffered data to WLAN and refer to the setting.
■ Formats uart_intvl set interval uart_intvl get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
interval Send intervals 1 to 3000 (ms) <Default 100 (ms)>
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
36/172
(9) uart_bufsz command Used to set buffer size to be accumulated before data is transmitted via WLAN and, refer to the setting. While in terminal mode, the data will be sent to WLAN when a delimiter is inserted or accumulated data reaches the set buffer size, or the time interval set by uart_intvl command elapsed.
■ Formats uart_bufsz set size uart_bufsz get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
size Buffer size 100 to 1460 (byte) <Default 1460 (byte)>
(10) uart_pmact command Used to set awake time during power management (i.e., a period of time after the BU1805GU receives an instruction for awaking from the host until it goes into sleep mode) and refer to the setting. It's effective only by BSS-STA mode.
■ Formats uart_pmact set time uart_pmact get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
time Awake time 100~10,000 (ms) <Default 10000 (ms)>
7.2. WLAN Setting
(1) wlan_type command Used to set WLAN communication type and refer to the setting.
■ Formats wlan_type set type wlan_type get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
Type Communication type infra: Infrastructure <Default of AP mode>
ad-hoc: Ad hoc <Default of STA mode>
off: WLAN POWER OFF
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
37/172
(2) wlan_chan command Used to set WLAN channel and refer to the setting. If the “wlan_type” is set to “infra”, the WLAN channel will be automatically changed to the selected channel by AP (access point) after connecting to AP.
■ Formats wlan_chan set channel wlan_chan get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
channel Channel 1 to 13 <Default 11>
(3) wlan_ssid command Used to set SSID for WLAN and refer to the setting.
■ Formats wlan_ssid set ssid wlan_ssid get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
ssid SSID Any string of up to 32 characters
<Default WIFI>
(4) wlan_sec command Used to set security type for WLAN and refer to the setting.
■ Formats wlan_sec set ssid wlan_sec get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
sec Securty type none : None security <Default>
wep64 : WEP64bit
wep128 : WEP128bit
wpa-tkip : WPA-PSK TKIP
wpa2-aes : WPA2-PSK AES
wpa-mix : WPA/WPA2-PSK MIXED
(5) wlan_wep command Used to set WEP key for WLAN and refer to the setting.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
38/172
Unless the “wlan_sec” is set, the command will not be executed with error message.
■ Formats wlan_wep set key wlan_wep get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
Reference get: Reference
key WEP key Null-terminated hex string of 10 or 26 characters
<Default None>
(6) wlan_psk command Used to set WPA/WPA2 passphrase for WLAN and refer to the setting. Unless the “wlan_sec” is set, the command will not be executed with error message.
■ Formats wlan_psk set phrase wlan_psk get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
phrase Passphrase PSK string (of 8 to 63 characters) or hex string in 64 digits
<Default None>
(7) wlan_pm command Used to select whether to enable or disable power management and refer to the setting. It's effective only by BSS-STA mode.
■ Formats wlan_pm set mode wlan_pm get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting set: Setting
or reference get: Reference
Mode Mode off: Disabled <Default>
min_f: High-speed power management (Normal)
max_f: High-speed power management (Max)
min_l: PS-POLL power management (Normal)
max_l: PS-POLL power management (Max)
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
39/172
(8) wlan_pin command Used to set WPS PIN code and refer to the setting. WPS PIN code is used only when PIN method is selected by the “wlan_wps” command.
■ Formats wlan_pin set pincode wlan_pin get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
pincode PIN code Decimal string of 8 characters
<Default None>
(9) wlan_wps command Used to set WPS type and refer to the setting. Setting WPS type will initiate WPS connection according to the selected type. (For connection with PIN, preset PIN code using the “wlan_pin” command. ) [BSS-STA mode] If WPS connection is successfully finished, credential information will be automatically saved. The user can specify with the “wlan_crdl” command whether or not to enable WPS connection for the next startup. In case of WPS connection, parameters set with the “wlan_sec” “wlan_wep”, and “wlan_psk” commands will be ignored. [IBSS-STA mode] It's impossible to use it (The ad hoc connection by WPS is bad.) [AP mode] Movement of WPS Registrar is established. After movement starting of WPS-PIN system and WPS-PBC system, a connection from WPS Enrollee is accepted during about 120 seconds.
■ Formats wlan_wps set type wlan_wps get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
Reference get: Reference
type WPS type stop: Suspend connection <Default>
pin: PIN (PIN method)
pbc: PBC (Push button method)
clr: Clear credential
(10) wlan_crdl command Used to select whether to enable or disable connection with credential for startup and refer to the setting. To enable connection with credential, credential should be saved into EEPROM by connecting to
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
40/172
AP with the “wlan_wps” command.
■ Formats wlan_crdl set flag wlan_crdl get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
flag WPS connection for off: Disabled <Default>
startup on: Enabled (Connection with credential)
(11) wlan_mac command Used to refer to MAC address of WLAN device.
■ Formats wlan_mac {get}
■ Arguments
Argument Setting Parameter Set value
get Selection of setting or reference
get: Reference
(12) wlan_max_chan command Used to set maximum channel number. 11 or 13 can be set.
■ Formats wlan_max_chan set chan wlan_max_chan get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or reference
set: Setting get: Reference
Chan Maximum channel number 11: 11CH <Default for Engllish version firmware> 13: 13CH <Default for Japanese version firmware>
(13) wlan_con command Used to refer to WLAN connection status. [BSS-STA mode] The state of the connection with the access point is indicated. [ISBB-STA mode] It'll be always the state of the connection. [AP mode] The state of the connection with the station is indicated. (When 1 is connected, the number of connected stations will be the state of the connection, and is indicated.)
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
41/172
■ Formats wlan_con {get}
■ Arguments
Argument Setting Parameter Set value
get Selection of setting or reference
get: Reference
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
42/172
7.3. TCP/IP Setting
(1) ip_dhcp command Used to set whether to enable or disable DHCP client and refer to the setting.
■ Formats ip_dhcp set mode ip_dhcp get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
Mode Communication type off: Disabled <Default of STA mode>
on/clt: Client
srv: sever<Default of AP mode> (It's impossible to establish it by a STA mode.)
(2) ip_addr command Used to set IP address and refer to the setting.
■ Formats ip_addr set addr ip_addr get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
Addr IP address String include ‘.’
<Default 192.168.0.1>
(3) ip_mask command Used to set subnet mask and refer to the setting.
■ Formats ip_mask set mask ip_mask get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
mask Subnet mask String include ’.’
<Default 255.255.255.0>
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
43/172
(4) ip_gate command Used to set gateway address and refer to the setting.
■ Formats ip_gate set addr ip_gate get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
addr Gateway address String include ’.’
<Default of STA mode 192.168.0.254> <Default of AP mode = 192.168.0.1> 0.0.0.0 designation which is at the time of DHCP server choice doesn't stock the gateway address.
(5) ip_current command Used to refer to IP address acquired by DHCP.
■ Formats ip_current {get}
■ Arguments
Argument Setting Parameter Set value
get Selection of setting or reference
get: Reference
(6) ip_dns command Used to set DNS server address and refer to the setting.
■ Formats ip_dns set addr ip_dns get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
addr DNS server address String include ’.’
<Default of STA mode 192.168.0.100> <Default of AP mode = 192.168.0.1> 0.0.0.0 designation which is at the time of DHCP server choice doesn't stock the DNS server address.
(7) ip_dhcp_start command A DHCP server establishes a leased starting IP address and refers to it. The address by which setting is possible is the same network address as oneself. (ip_addr establishes the address of the confidence using the ip_mask command.) It's effective only by the AP mode.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
44/172
■ Formats ip_dhcp_start set addr ip_dhcp_start get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
Addr DNS server address String include ’.’
<Default 192.168.0.10>
(8) ip_dhcp_num command A DHCP server establishes the number of the leased IP address and refers to it. It's effective only by the AP mode.
■ Formats ip_dhcp_num set num ip_dhcp_start get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
num The number of the lease IP address
1-16<Default=16>
(9) ip_dhcp_tim command A DHCP server sets time to complete lease and refers to it. It's effective only by the AP mode.
■ Formats ip_dhcp_tim set unit val ip_dhcp_tim get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
Reference get: Reference
unit unit “none”= Unlimited, “minute”=minute, “hour”=hour <Default=”hour”>
val value 1-63(The time of unlimitedness is omitted.) <Default=63>
(10) ip_http command Used to set whether to enable or disable Web setting using HTTP, and refer to the setting. When HTTP setting is disabled, TCP/IP port 80 is opened to the user.
■ Formats ip_http set flag ip_http get
■ Arguments
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
45/172
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
flag HTTP setting off: Disabled
On: Enabled <Default>
(11) ip_term_prot command Used to select terminal mode protocol and refer to the setting.
■ Formats ip_term_prot set protocol ip_term_prot get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
Protocol Protocol type none: Unused
udp: UDP
tcps: TCP server <Default>
tcpc: TCP client
(12) ip_term_hp command Used to set local port number for terminal mode and refer to the setting Use this command when the terminal mode protocol is set to UDP or TCP server. Set this parameter to any number that does not overlap DHCP (68) and HTTP (80).
■ Formats ip_term_rp set port ip_term_rp get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
port Port number 1 to 65535 <Default 16384>
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
46/172
(13) ip_term_rp command Used to set remote port number for terminal mode and refer to the setting. This command is used when the terminal mode protocol is set to UDP or TCP clients.
■ Formats ip_term_rp set port ip_term_rp get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
Reference get: Reference
port Port number 1 to 65535 <Default 16384>
(14) ip_term_ra command Used to set remote address for terminal mode and refer to the setting.
■ Formats ip_term_ra set addr ip_term_ra get
■ Arguments
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
addr Remote IP address String include ‘.’ or DNS name having a maximum of 34 characters
<Default 192.168.0.2>
(15) ip_sock command Used to refer to socket status.
■ Formats ip_sock {get}
■ Arguments
Argument Setting Parameter Set value
get Selection of setting or reference
get: Reference
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
47/172
7.4. Setting Reference
(1) uart command Used to perform a batch reference to UART settings.
■ Format uart
■ Argument None
(2) wlan command Used to perform a batch reference to WLAN settings.
■ Formats wlan
■ Argument None
(3) ip command Used to perform a batch reference to TCP/IP settings.
■ Formats ip
■ Argument None
(4) ver command Used to refer firmware version and MAC address.
■ Formats ver
■ Argument None
7.5. System
(1) hlp command Used to refer to a list of commands.
■ Formats hlp
■ Argument None
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
48/172
(2) default command Used to reset setting parameters to default (not save the value).
■ Formats default permit
■ Argument
Argument Setting Parameter Set value
permit Command permission Fixed to “permit”.
(3) save command Used to save setting parameters.
■ Formats save permit
■ Argument
Argument Setting Parameter Set value
permit Command permission Fixed to “permit”.
(4) run command Used to switch operation mode to terminal mode.
■ Formats run permit
■ Argument
Argument Setting Parameter Set value
permit Command permission Fixed to “permit”.
(5) ping command ICMP Echo Request is sent.
■ Formats ping ip
■ Argument
Argument Setting Parameter Set value
ip IP address of a transmission destination
When ICMP Echo Reply is received, it indicates "is alive!". When it can't be received in the fixed hour, it indicates "No response from".
(6) arp command ARP table inside the firmware is cleared.
■ Formats arp delete
■ Argument
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
49/172
Argument Setting Parameter Set value
Delete Clear of ARP table Fixed to “delete”
(7) passwd command Used to change login password for Web setting and refer to the setting.
■ Formats passwd set password passwd get
■ Argument
Argument Setting Parameter Set value
set/get Selection of setting or set: Setting
reference get: Reference
Phrase New password Any string of 1 to 8 characters
<Default password>
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
50/172
8. Web Setting Web setting is possible by accessing TCP/IP Built-in WLAN using Web browser. Setting items are the same as those for shell command settings. The item which can be established is same as the item of the shell command setting.
8.1. Authentication Accessing TCP/IP Built-in WLAN with Web browser will display the Authentication window as shown below.
The user name is adminXXX (XXX is randomly changed).
Enter “adminXXX” out of user.adminXXX/password.defaultpassword shown on the window in the “User Name” box.
Enter a password in one to eight characters (Default password).
8.2. Main Window The Main window display version information at the beginning. To switch to each window, select an item in the frame shown on the left hand of the Main window.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
51/172
( "Scan" on the menu is indicated only by a STA mode. It'll be "status" by the AP mode.)
(1) Firmware Version Indicates the version of WLAN firmware.
(2) System Version Indicates the version of TCP/IP Built-in WLAN (including firmware).
(3) MAC Address Indicates the MAC address of WLAN module.
8.3. Serial Communication Setting The window shown below is used to make settings of parameters related to serial communication.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
52/172
(1) Baud Rate Used to select any of 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400, 460800, and 921600.
(2) Data Bit Used to select either 7 or 8 bits.
(3) Parity Used to select any of No parity Odd parity, or Even parity.
(4) Stop Bit Used to select either 1 or 2 bits for stop bit.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
53/172
(5) Flow Control Used to select either “Disable” or “Enable”.
(6) Startup Timeout Used to set startup timeout time in the range of 0 to 60 seconds.
(7) Inter-character Delay Used to select any of None, 1, 2, and 3. Actual delay between consecutive bytes sent from WLAN to host, is <value x 100us>.
(8) Power Management Awake Time Used to set awake time during power management (i.e., a period of time after the BU1805GU receives an instruction for awaking from the host until it goes into sleep mode).
(9) Number of Delimiter Used to set the number of bytes of delimiter. (Setting this parameter to “1” will enable only the top of the delimiter.)
(10) First/Second bytes of Delimiter Used to specify delimiter in hex.
(11) Delimiter for UDP Receive Used to select whether to add or not add delimiter for UDP receive.
(12) Send Interval Used to set intervals to send data in the buffer with millisecond (ms) time scale.
(13) Send Buffer Size Used to set a size of data buffering before sending it through WLAN. Buffered data in WLAN module is transmitted when the delimiter is inserted, the data reach to defined buffer size, or at the time when the interval timer expire.
(14) Apply button Used to apply the selected serial communication setting parameters. To protect the contents even if the system is reset, use “Save” parameter in the System window to save them.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
54/172
8.4. Wireless Config Setting The window shown below is used to make settings of parameters related to WLAN communication.
(1) Communication Type Used to select any of Ad hoc, Infrastructure, and OFF. Ad hook can't be chosen by the AP mode.
(2) Channel Used to select channel from 1 to 13.
(3) SSID Used to specify any string of 32 characters or less as SSID.
(4) Security Used to select any of None, WEP64, WEP128, WPA-PSK (TKIP), WPA2-PSK (AES), and WPA/WPA2 (MIXED) as security mode.
(5) WEP Key Used to specify a hexadecimal string of 10 or 26 characters for WEP key.
(6) WPA/WPA2 Pre-Shared Key Used to specify PSK string (of 8 to 63 characters) or hex string in 64 digits.
(7) Power Management Used to select any of OFF (Disabled), min_f (High-speed power management (Normal)), max_f (High-speed power management (Max )), min_l (PS-POLL power management (Normal)), and max_l (PS-POLL power management (Max)). Only BSS-STA mode is effective.
(8) Credential Connection for Startup Used to select either “Disable” or “Enable”.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
55/172
Only BSS-STA mode is effective. (When this setting is made effective by a STA mode, it'll be BSS-STA mode.)
(9) The maximum channel to be used Select 11 or 13 as max channel number. When 11CH is selected, 12CH and 13CH can not be used.
(10) Apply button Used to apply selected WLAN communication setting parameters. To protect the contents even if the system is reset, use “Save” parameter in the System window to save them.
8.5. WPS Setting The window shown below is used to make settings of parameters related to WPS. Note that, unlike other setting parameters, the setting will take effect immediately when the Apply button is pressed. (A wireless LAN is cut once by a STA mode, so, please be careful in particular.)
(1) WPS Type Used to select PBC or PIN as WPS type. Movement of WPS Enrollee is begun by a STA mode. Movement of WPS Registrar is begun by a AP mode.
(2) PIN Code Used to specify a PIN code. (This parameter is used only when the WPS Type parameter is set to PIN method.)
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
56/172
8.6. TCP/IP Setting The window shown below is used to make settings of parameters related to TCP/IP communications.
(1) DHCP [STA mode] Used to set DHCP client to “Disable” or “Enable”. [AP mode] DHCP invalidity, a client and a server are chosen. The following setting is effective at the time of DHCP server choice. * Starting IP address: Leased starting IP address * The number of distribution addresses: The number of the leased IP address * The unit of lease time: "Unlimitedness", "minute" and "hour" are chosen. * Lease time: Lease, time to expire
(2) IP Address Used to specify IP address (fixed IP address) when the DHCP parameter is set to “Disable”.
(3) Subnet Mask Used to specify subnet mask when the DHCP parameter is set to “Disable”.
(4) Gateway Address Used to specify gateway address when the DHCP parameter is set to “Disable”. It'll be the address of the gateway distributed by a DHCP message (Router) at the time of DHCP server choice. (The gateway address isn't stocked at the time of 0.0.0.0 designation.)
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
57/172
(5) DNS Address Used to specify IP address of the DNS server. It'll be the address of DNS distributed by a DHCP message at the time of DHCP server choice. (The DNS address isn't stocked at the time of 0.0.0.0 designation.)
(6) Protocol Used to select a protocol for terminal mode from Unused, UDP, TCP (Server), and TCP (Client).
(7) Port Number Used to specify a local port number for terminal mode. (Use this parameter when the Protocol parameter is set to UDP or TCP (Server).) Set this parameter to any number that does not overlap with DHCP (68) or HTTP (80).
(8) Remote IP Address Used to specify remote IP address for terminal mode. (Use this parameter when the Protocol parameter is set to UDP or TCP (Client).) User can also specify a DNS name having a maximum of 20 characters.
(9) Remote Port Number Used to specify remote port number for terminal mode. (Use this parameter when the Protocol parameter is set to UDP or TCP (Client).)
(10) Apply button Used to apply entered TCP/IP communication parameters. To protect the contents even if the system is reset, use “Save” parameter in the System window to save them.
8.7. System Setting Management window is shown below.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
58/172
(1) Change Password Select “Yes” to change password.
(2) New Password / New Password (Confirmation) Used to specify a password in one to eight characters.
(3) Restore Default Select “Yes” to restore default setting.
(4) Save Select “Yes” to save setting. The saved-area of a setting is common by a STA mode and the AP mode. It's interchangeable with a STA mode by the AP mode, but it's overwritten, so please be careful.
(5) Reboot Select “Yes” to reboot the WLAN module after the parameters are saved.
(6) Apply button The table below describes processing for “Restore Default” and “Save” parameter combination.
Restore Default Save Processing
No No No processing is conducted.
Yes No Restore default (but not saved into EEPROM)
No Yes Save the current setting into EEPROM.
Yes Yes Default setting is saved into in EEPROM.
8.8. Scan The Scan window is used to execute network scan (Site Survey) and display detected information. It's effective only by a STA mode.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
59/172
(1) Start Scan Used to start executing wireless network scan. After a message saying “Scan Started” appears on the window, select “Scan” from the setting menu to display the Scan window once again. The scan results will be displayed on the window.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
60/172
9. TCP/IP Protocol Stack This Chapter describes specification for TCP/IP protocol stack.
9.1. Features ■ Support IPv4, ARP, ICMP, UDP, and TCP protocols ■ Support DHCP client and DNS client functions ■ TCP/IP configuration allowed in config mode or using WID in communication mode
9.2. Host Communication Data User can perform communications just by exchanging the payload of TCP/IP and UDP/IP according to the frame format specified in “14. UART Communication Specification”, without regard to TCP/IP, UDP/IP, and WLAN.
Payload FCS
Portion user sends and receives
Ethernet header
IP header
TCP, UDP header
WLAN header
ARP and ICMP are automatically processed by internal TCP/IP protocol stack of the BU1805GU. As described in “6.3 Data Packet Structure”, the information of the remote terminal can be derived from the received data in communication mode. In addition, the destinations of UDP/IP can be changed for each data.
9.3. Setting Parameters The table shown below lists user-configurable parameters related to TCP/IP protocol stack.
Setting Parameter Setting Item Default
Use of DHCP DHCP function enabled or disabled Disabled
IP Address Local IP address 192.168.0.1
Subnet Mask Subnet mask 255.255.255.0
Gateway IP address of default gateway 192.168.0.254
DNS Address IP address of DNS 192.168.0.100
Protocol Protocol (UDP, TCPs, or TCPc) TCP server (*)
Local Port Number Local port number 16384 (*)
Remote Port Number Port number of remote terminal 16384 (*)
Remote Port Address IP address of remote terminal 192.168.0.2 (*)
(*) Valid only in terminal mode For detailed specification, refer to information in “10. WID”.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
61/172
9.4. Specification of Each Block This Section describes the specification of each block contained in the TCP/IP protocol stack.
9.4.1. IP block (Internet Protocol) The BU1805GU receives and processes a packet only when the destination IP address of the packet corresponds to own IP address, or it is broadcast IP address.
(1) TOS (Type of Service) TOS is a value indicating the service quality of IP being sent. With the BU1805GU, TOS is set to “0”.
(2) TTL (Time to Live) TTL is a value indicating how many routers data is allowed to pass through. With the BU1805GU, TTL is set to “64”. If the number of router passed exceeds this value, the packet will be discarded.
(3) Broadcast and Multicast It is always ready to send and receive broadcast frame. UDP protocol must be used to send and receive broadcast frame. BU1805GU supports directed broadcast addresses such as “192.168.11.255” and limited broadcast address such as “255.255.255.255”. The reception of a multicast and the setting are possible by only a communication mode.
(4) Fragmentation No fragmentation is performed on frames.
9.4.2. ICMP (Internet Control Message Protocol) Echo Reply and Time Exceeded message of ICMP is supported. Due to a limitation on internal buffer size, echo reply will not be returned if echo request size exceeds 1,460 bytes (That ICMP Hedda is included, 1468 bytes).
9.4.3. ARP block (Address Resolution Protocol) APP cache size is “8”. APP entry information that has not been used for a period of 20 minutes is automatically deleted.
9.4.4. UDP block (User Datagram Protocol) UDP sends and receives data without being connected to the remote host. The number of ports that can be used at a time is a maximum of 4 (1 in terminal mode). Broadcast frame can be sent and received only with UDP.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
62/172
9.4.5. TCP block (Transmission Control Protocol) Unlike UDP, TCP is the connection type and thereby sends and receives data after securing a communication channel with remote terminal. TCP supports only unicast frame communication. The number of ports that can be used at a time is a maximum of 4 (1 in terminal mode).
(1) Number of Session The number of sessions that can be used at a time is 4 (1 in terminal mode).
(2) Time-out Value The table below shows time-out value settings.
Parameter Set time
Connection time-out 75 sec.
Disconnection time-out 75 sec.
Send time-out 64 sec.
Resend time-out Default: 3 sec., Setting range: 500 ms to 60 sec.
Delay ACK time-out 200 ms
(3) TCP Congestion Control This control supports high-speed resend and high-speed restore. The number of duplicate ACK is 4.
9.4.6. HTTPs block (Hyper Text Transfer Protocol Server) The HTTPs block is provided to make settings of TCP/IP Built-in WLAN using Web browser, and not available for communications.
9.4.7. DHCPc block (Dynamic Host Configuration Protocol Client) DHCP client acquires IP address that can be used over a network from the DHCP server. The IP address acquired can be retrieved.
9.4.8. DNSc block (Domain Name System Client) The DNSc block allows for specifying a destination by name of 255 or less characters (34 or less
characters in terminal mode) in place of IP address. IP address is acquired by DNS client by making an inquiry to the DNS server.
See WID_IP_RESOLVE.
9.4.9. DHCPc block (Dynamic Host Configuration Protcol Sever) A DHCP server distributes an IP address to a DHCP client. It's possible to establish distributed IP address and lease time.
9.4.10. IGMP block (Internet Group Management Protcol) IGMPv2 is being supported. (IGMPv1 plug-compatible is also supported.) Participation in a multicast group (Join), Leaving from a multicast group (Leave), Maintenance of a multicast group (Report reply to Query), There is a function which says so. A Report response time to Query is 10 seconds.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
63/172
10. WID Commands This Chapter describes parameters that can be set from the host while in communication mode. (This function is not available for use while in terminal mode.) Virtual variables called WID command (hereinafter referred to as “WID”) are provided for each parameter and accessed from the host. Accesses to WID are done by sending and receiving configuration packet. For the packet structure, refer to information in “6.4.Configuration Packet Structure”.
10.1. List of WID Commands
Category WID Name WID Number
Target Function
Serial WID_UART_CFG 0x2F10 ALL UART setting
WID_UART_TIMEOUT 0x0F10 ALL Startup time-out
WID_UART_DELAY 0x0F11 ALL Inter-character delay
WID_UART_RESET 0x0F12 ALL UART reset (reflect
setting)
WID_UART_PM_ACTIVE_TIME 0x1F10 BSS-STA Power save mode active
timer
WLAN WID_BSS_TYPE 0x0000 ALL Communication type
WID_CURRENT_CHANNEL 0x0002 IBSS-STA/API Channel
WID_SSID 0x3000 ALL SSID
WID_DEVICE_READY 0x003D ALL Notice of device startup
WID_STATUS 0x0005 ALL Status
WID_CURRENT_MAC_STATUS 0x0031 STA Acquisition of MAC status
WID_BSSID 0x3003 ALL BSSID
WID_WEP_KEY_VALUE 0x3004 ALL WEP key
WID_11I_PSK 0x3008 BSS-STA/AP WPA/WPA2 Pre-Shared
Key
WID_11I_MODE 0x000C ALL Encryption/Authentication
mode
WID_KEY_ID 0x0009 ALL WEP coding key index
WID_AUTH_TYPE 0x000D ALL Security authentication
type
WID_MAC_ADDR 0x300C ALL MAC address reference
WID_BCAST_SSID 0x0015 BSS-STA/AP Broadcast SSID
WID_POWER_MANAGEMENT 0x000B BSS-STA Power save mode
WID_POWER_SAVE 0x0100 STA Sleep mode
WID_LISTEN_INTERVAL 0x000F BSS-STA Listen interval
WID_WPS_DEV_MODE 0x0044 BSS-STA WPS mode
WID_WPS_START 0x0043 BSS-STA/AP WPS start
WID_WPS_PASS_ID Ox1017 AP Device password ID
setting
WID_WPS_PIN 0x3025 BSS-STA/AP WPS PIN code setting
WID_WPS_CRED_LIST 0x4006 BSS-STA WPS credential list
WID_WPS_STATUS 0x3024 BSS-STA/AP Notice of WPS protocol
status
WID_RSSI 0x001F STA RSSI (Receive Signal
Strength Indicator)
WID_SCAN_TYPE 0x0007 STA Scanning type
WID_SITE_SURVEY 0x000E STA Site survey mode
WID_START_SCAN_REQ 0x001E STA Start site survey scan
WID_SITE_SURVEY_RESULTS 0x3012 STA Refer to scan results
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
64/172
Category WID Name WID Number
Target Function
WID_SCAN_FILTER 0x0036 STA BSS scan filter
WID_JOIN_REQ 0x0020 STA Connection request to
the network detected by scan
WID_BEACON_INTERVAL 0x1006 ALL Beacon interval setting
WID_ENABLE_CHANNEL 0x2024 ALL Select channel
WID_ANTENNA_SELECTION 0x0021 STA Antenna and diversity
setting
WID_TX_POWER_RATE 0x0106 ALL TX power change
WID_FIRMWARE_VERSION 0x3001 ALL Firmware version
WID_SERIAL_NUMBER 0x3018 ALL WLAN module
identification number
WID_DTIM_PERIOD 0x0010 AP DTIM cycle
WID_STA_JOIN_INFO 0x4008 AP Connection information
notice
WID_CONNECTED_STA_LIST 0x4009 AP Connection information
referring
WID_DISCONNECT 0x0016 AP Link cutoff
WID_REKEY_POLICY 0x0019 AP RSNA GTK Key
exchange policy
WID_REKEY_PERIOD 0x2010 AP GTK renewal cycle
(timebase)
WID_VSIE_FRAME 0x00B4 ALL VSIE frame choice
WID_VSIE_INFO_ENABLE 0x00B5 ALL VSIE reception notice
designation
WID_VSIE_RX_OUI 0x2084 ALL VSIE receive filter setting
WID_VSIE_TX_DATA 0x4085 ALL VSIE transmission data
WID_VSIE_RX_DATA 0x4086 ALL VSIE reception data
TCP/IP WID_IP_DHCP 0x0F20 ALL DHCP setting
WID_IP_HTTP 0x0F21 ALL HTTP setting function
WID_IP_DHCP_NUM 0x0F22 AP DHCP the number of
lease IP addresses
WID_IP_DHCP_TIM 0x0F23 AP DHCP of lease time
WID_IP_SNDDISCON 0x0F24 ALL The cutoff time-out which
is at the time of a TCP transmission
WID_IP_ADDR 0x3F20 ALL IP address
WID_IP_NETMSK 0x3F21 ALL Subnet mask
WID_IP_GATEWAY 0x3F22 ALL Gateway IP address
WID_IP_DNS 0x3F23 ALL DNS IP address
WID_IP_RESOLVE 0x3F24 ALL Setting of / reference to
IP address solution
WID_IP_DHCP_ADDR 0x3F25 AP DHCP lease starting IP
address
WID_SOC_ACCEPT 0x4F00 ALL Setting of / reference to
TCP server socket
WID_SOC_CONNECT 0x4F01 ALL Setting of / reference to
TCP client socket
WID_SOC_BIND 0x4F02 ALL Setting of / reference to
UDP socket
WID_SOC_REF 0x4F03 ALL Socket status reference
WID_SOC_RCVTMO 0x4F04 ALL Setting of / reference to
reception time-out
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
65/172
Category WID Name WID Number
Target Function
WID_ARP_DELETE 0x0F26 ALL Clear of ARP table
WID_IP_MCAST_TTL 0x0F25 ALL TTL setting of multicast
WID_IP_MCAST_JOIN 0x3F26 ALL Multicast participation
WID_IP_MCAST_DROP 0x3F27 ALL Multicast release
System WID_MAINTE_DEFAULT 0x0FF1 Resetting parameter to
default
WID_MAINTE_SAVE 0x0FF0 Parameter save
WID_MAINTE_PASSWD 0x3FF0 Web setting password
WID_MAINTE_CRDL 0x0FF2 Connection using
Credential on startup
Target : Firmware includes the following operation mode, and it's different in WID which can be used every mode. ROM :It's practicable by a ROM program (boot loader). ALL :It's practicable by all firmware modes except for ROM. STA :It's practicable by IBSS/BSS-STA mode. BSS-STA :It's practicable by BSS-STA mode. BSS-STA/AP :It's practicable by BSS-STA mode and the AP mode. IBSS-STA/AP :It's practicable by IBSS-STA mode and the AP mode.
10.2. Detailed WID Specification This Section describes specification for each WID.
(CAUTION) Data on packet examples do not includes SOF and EOF for communication mode. An escape code of binary frame format (0x1B) isn't included.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
66/172
10.2.1. WID_UART_CFG 0x2F10 32bit R/W
Description: Used to set UART parameters and refer to the setting. Note that parameters are not reflected until WID_UART_RESET is issued.
Set values:
Bit Setting Parameter
Set Value
Remark
7:0 Reserved
11:8 Flow control 0x0 Disabled
0x1 Enabled
15:12 Reserved
19:16 Parity 0x0 None
0x1 Odd
0x2 Even
23:20 Stop bit 0x1 1(bit)
0x2 2(bit)
27:24 Baud rate 0x0 1200(baud)
0x1 2400(baud)
0x2 4800(baud)
0x3 9600(baud)
0x4 19200(baud)
0x5 38400(baud)
0x6 57600(baud)
0x7 115200(baud)
0x8 230400(baud)
0x9 460800(baud)
0xA 921600(baud)
31:28 Data width 0x7 7(bit)
0x8 8(bit)
Packet example:
Example where it turned out that Baud rate had been set to 115200 (baud), Data width to 8 (bit), Parity to None, Stop bit to 1 (bit) and Flow control set to Disabled, when referring to the UART parameter settings:
TX: 064051010600102F
RX: 0B3052010B00102F0400001087
Example of making the UART parameter settings, such as Baud rate to 921600 (baud), data width to 8 (bit), Parity to None, Stop bit to 1 (bit), and Flow control to Enabled:
TX: 0B4057020B00102F040001108A
RX: 08305202080005000101
Related WID:
WID_UART_RESET 0x0F12 8bit W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
67/172
10.2.2. WID_UART_TIMEOUT 0x0F10 8bit R/W
Description: Used to set startup time-out time for initial mode and refer to the setting.
Set value: 1 to 60 (sec.)
Default 3 (sec.) If this WID is set to “0”, the device will make transition to terminal mode without wait time.
Packet example: Example where it turned out that this WID had been set to 3 sec., when referring to the startup time-out time setting:
TX: 064051010600100F
RX: 083052010800100F0103
Example of setting startup time-out time to 0 sec.:
TX: 084057020800100F0100
RX: 08305202080005000101
Related WID:
None
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
68/172
10.2.3. WID_UART_DELAY 0x0F11 8bit R/W
Description: Used to set inter-character delay time and refer to the setting.
Set value: 0 to 3 (×100 us)
Default 0 (100 us)
Packet example: Example where it turned out that this WID had been set to 0 us, when referring to the inter-character delay time setting:
TX: 064051010600110F
RX: 083052010800110F0100
Example of setting inter-character delay time to 300us (3 100us):
TX: 084057020800110F0103
RX: 08305202080005000101
Related WID:
None
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
69/172
10.2.4. WID_UART_RESET 0x0F12 8bit W
Description: Used to reflect the UART parameter settings. Since UART parameter settings are changed, no WID response is returned.
Set value:
Set Value Description Remark
0x01 Used to reflect UART parameter settings and switch operation mode to initial mode.(NOTE1)
NOTE1: User need to wait WID_DEVICE_READY on entering communication mode after power up. However WID_DEVICE_READY is not sent to the host on entering communication mode after WID_UART_RESET.
Packet example: Example of reflect UART parameter settings
TX: 084057020800120F0101
Related WID:
WID_UART_CFG 0x2F10 32bit R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
70/172
10.2.5. WID_UART_PM_ACTIVE_TIME 0x1F10 16bit R/W
Description: Used to set awake time during power management (i.e., a period of time after the BU1805GU receives an instruction for awaking from the host until it goes into sleep mode) and refer to the setting. It's effective only by BSS-STA mode.
Set value: 100 to 10,000 (ms)
Default 10,000 (ms)
Packet example: Example where it turned out that this WID time had been set to 100 ms, when referring to the awake time setting:
TX: 064051010600101F
RX: 093052010900101F026400
Example of setting awake time to 1 sec (1000 msec):
TX: 094057020900101F02E803
RX: 08305202080005000101
Related WID:
WID_POWER_MANAGEMENT 0x000B 8bit R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
71/172
10.2.6. WID_BSS_TYPE 0x0000 8bit R/W
Description Used to set communication type and refer to the setting.
Set values
Set Value Description Remark
0x00 BSS-STA (Infrastructure)
0x01 IBSS-STA (Ad hoc) Default of STA mode
0x02 AP (Access point) Default of AP mode
0x80 WLAN POWER OFF
Packet example:
Example where it turned out that this WID had been set to “IBSS-STA”, when referring to the communication type setting:
TX: 0640510106000000
RX: 08305201080000000101
Example of setting communication mode to “BSS-STA”:
TX: 08405702080000000100
RX: 08305202080005000101
Related WID
None
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
72/172
10.2.7. WID_CURRENT_CHANNEL 0x0002 8bit R/W
Description: Used to select channel and refer to the setting.
Set value (channel): CH1 to CH13 (0x01 to 0x0D)
Default 11 If this WID is being set to invalid value, the value will not be updated. Setting of whether or not to use channel can be made with WID_ENABLE_CHANNEL.
Packet example: Example where it turned out that this WID had been set to CH6, when referring to the channel setting:
TX: 0640510106000200
RX: 08305201080002000106
Example of setting the channel to CH11:
TX: 0840570208000200010B
RX: 08305202080005000101
Related WID
WID_ENABLE_CHANNEL 0x2024 32bit R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
73/172
10.2.8. WID_SSID 0x3000 String R/W
Description: Used to set SSID and refer to the setting. If operation mode is switched to forced connection mode by issuing WID_JOIN_REQ, forced connection mode will be able to be canceled by issuing this WID.
Set value: SSID string (Maximum 32 bytes)
Default "WIFI"
Packet example: Example where it turned out that this WID had been set to "dnet" (0x646E6574), when referring to the SSID setting:
TX: 0640510106000030
RX: 0B3052010B00003004646E6574
Example of setting the SSID to "WIFI":
TX: 0B4057020B000030055749464900
RX: 08305202080005000101
Or:
TX: 0B4057020B0000300457494649
RX: 08305202080005000101
Related WID: WID_JOIN_REQ 0x0020 8bit W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
74/172
10.2.9. WID_DEVICE_READY 0x003D 8bit I
Description: This WID will be issued when the firmware of the BU1805GU starts up and the WLAN device is switched to a state in which it is ready to accept WID command. Unless the host receives this WID, it is not allowed to issue any other WID. This WID is notified as the message type 'I' (Information).
Set value:
Set Value Description Remark
0x01 WLAN device is switched to a READY state.
Packet example:
Example where WLAN device was switched to a READY state ('I'):
RX: 0830490108003D000101
Related WID
None
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
75/172
10.2.10. WID_STATUS 0x0005 8bit N/A
Description: This is a special WID that is not available for query and write. If the Message Type parameter is set to ‘R' (Response), this WID will indicate that write processing has been accepted. Please note that “Succeeded” response does not guarantee successful value update. It is recommended to read back the WID and check the value. If the Message Type parameter is set to 'I' (Information), the WID indicates WLAN connection status.
Set values: If the Message Type parameter is set to ‘R' (Response):
Set Value Description Remark
0x00 Failed
0x01 Succeeded
0xFF Message type error Specified message type is incorrect.
0xFE Sequence number error Specified sequence number is incorrect.
0xFD Message length error Specified WID message length is incorrect.
0xFC WID number error Specified WID command number is incorrect.
If the Message Type parameter is set to 'I' (Information):
Set Value Description Remark
0x00 WLAN line disconnected (DISCONNECTED)
0x01 WLAN line connected (CONNECTED)
Packet example:
Example where write processing has normally been accepted ('R'):
TX: 08405701080004000100
RX: 08305201080005000101
Example where the WLAN line has been connected ('I'):
RX: 08304901080005000101
Related WID
None
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
76/172
10.2.11. WID_CURRENT_MAC_STATUS 0x0031 8bit R
Description: Used to refer to the current MAC status.
Set values:
Bit Description Remark
0 Line status 0Disconnected, 1Connected
1 Reserved
2 Reserved
3 Reserved
4 Reserved
5 Reserved
6 Reserved
7 Reserved
Packet example:
Example where it turned out that the MAC had been connected, when referring to the current MAC status:
TX: 0640510106003100
RX: 08305201080031000101
Related WID:
None
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
77/172
10.2.12. WID_BSSID 0x3003 String R
Description: Used to refer to BSSID. When the device is not connected to the network, 00:00:00:00:00:00 will be returned.
Set value: BSSID (Example if BSSID is C6:2D:DC:B3:64:17: 0xC62DDCB36417)
Default Dependent on BSSID
Packet example: Example where "C6:2D:DC:B3:64:17" was returned when making a query about BSSID:
TX: 0640510106000330
RX: 0D3052010D00033006C62DDCB36417
Related WID:
None
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
78/172
10.2.13. WID_WEP_KEY_VALUE 0x3004 String R/W
Description: Used to set WEP key and refer to the setting. Before setting WEP key, be sure to make setting of the “WID_802_11I_MODE” command. This WID command supports only WEP key index “0”. (Be sure to set the WEP key on the AP side to index “0”.)
Set value: Null-terminated hex string of 10 or 26 characters
Default "0000000000" Make WEP key setting with a hex string of 10 characters for WEP64 and a hex string of 26 characters for WEP128. WEP key setting with insufficient number of characters impairs operation guarantee. Example:
To use the registration key of “AIR01” with WEP64, the registration key setting comes to "4149523031", and further converts the characters to ASCII code 0x34 0x31 0x34 0x39 0x35 0x32 0x33 0x30 0x33 0x31. Then, take these values as set values.
'A' → 0x41 → 0x34, 0x31 'I' → 0x49 → 0x34, 0x39 'R' → 0x52 → 0x35, 0x32 '0' → 0x30 → 0x33, 0x30 '1' → 0x31 → 0x33, 0x31
Packet example:
Example where it turned out that WEP key had been set to "0001020304", when making a query about the WEP key with WEP 64:
TX: 0640510106000430
RX: 11305201110004300A30303031303230333034
Example of setting the WEP key to "AIR01":
TX: 11405702110004300A34313439353233303331
RX: 08305202080005000101
Related WID:
WID_11I_MODE 0x000C 8bit R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
79/172
10.2.14. WID_11I_PSK 0x3008 String R/W
Description: Used to make setting of PSK (Pre-Shared Key) passphrase for WPA/WPA2 network.
Set value: PSK string (of 8 to 63 characters) or 64-digit hex string
Default "00000000" Example:
In order to set passphrase to "PASS", take 0x50, 0x41, 0x53, and 0x53 as set values. 'P' → 0x50 'A' → 0x41 'S' → 0x53 'S' → 0x53
Example: In order to make setting of passphrase using a 64-digit hex string like
("0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF"), take 0x30, 0x31, 0x32, … 0x44, 0x45, 0x46 as set values.
'0' → 0x31 '1' → 0x32 '2' → 0x33 … 'D' → 0x44 'E' → 0x45 'F' → 0x46
Packet example:
Example where "12345678" was returned when making a query about WPA/WPA2 network PSK passphrase:
TX: 0640510106000830
RX: 0F3052010F000830083132333435363738
Example of setting WPA/WPA2 network PSK passphrase to "PRESHARED":
TX: 104057011000083009505245534841524544
RX: 08305201080005000101
Example of setting this WID to 64-digit hex string (0123456789ABCDEF…0123456789ABCDEF):
TX:
474057014700083040303132333435363738394142434445463031323334353637
383941424344454630313233343536373839414243444546303132333435363738
39414243444546
RX: 08305201080005000101
Related WID:
WID_11I_MODE 0x000C 8bit R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
80/172
10.2.15. WID_11I_MODE 0x000C 8bit R/W
Description: Used to select encryption mode for WLAN and refer to the setting. In order to set this WID command to WEP64 or WEP128, be sure to make setting of “WID_11I_MODE” first, and then passphrase (WID_WEP_KEY_VALUE). Setting this WID to TKIP or AES will perform calculation for key generation, resulting in longer response time. If any change is made to SSID (WID_SSID) or passphrase (WID_11I_PSK), the key will be regenerated. In order to complete key generation in one shot, it is recommended to make setting of SSID and passphrase, and then WID_11I_MODE.
Set values:
Bit Parameter Remark
0 Encryption 0Disabled, 1Enabled
1 WEP 0Disabled, 1Enabled
2 WEP64/128 0=WEP64 1=WEP128
3 WPA 0Disabled, 1Enabled
4 WPA2 0Disabled, 1Enabled
5 CCMP(AES) 0Disabled, 1Enabled
6 TKIP 0Disabled, 1Enabled
7 Reserved
Default 0x00 (No security provided) <Setting example>
Security Set Value No security provided 0x00
In order to use WEP64 0x03
In order to use WEP128 0x07
In order to use WPA-AES(PSK) 0x29
In order to use WPA-TKIP(PSK) 0x49
In order to use WPA-TKIP/AES(PSK) 0x69
In order to use WPA2-AES(PSK) 0x31
In order to use WPA2-TKIP 0x51
In order to use WPA2-TKIP/AES(PSK) 0x71
In order to use WPA/WPA2 Mixed mode 0x79
Packet example:
Example where it turned out that the Encryption mode had been set to “No security”, when referring to the encryption mode setting:
TX: 0640510106000C00
RX: 0830520108000C000100
Example of setting the Encryption parameter to “WEP128”:
TX: 0840570208000C000107
RX: 08305202080005000101
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
81/172
Related WID:
WID_SSID 0x3000 String R/W WID_WEP_KEY_VALUE 0x3004 String R/W WID_11I_PSK 0x3008 String R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
82/172
10.2.16. WID_KEY_ID 0x0009 8bit R/W
Description: Establish and refer to a WEP key. The WEP key by which setting is possible is only 0. (0-3 is notified of in WPS credential, but it can't be connected to an access point of 1-3.)
Set values: 0-3 Default = 0
Packet example: The example which was "0" when you referred to the index number
TX: 0640510106000900
RX: 08305201080009000100
Related WID: WID_WEP_KEY_VALUE 0x3004 String R/W WID_WPS_CRED_LIST 0x4006 Binary R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
83/172
10.2.17. WID_AUTH_TYPE 0x000D 8bit R/W
Description: Used to set authentication type (Open System or Shared Key) and refer to the setting. Authentication type setting is required only for WEP. DO NOT ISSUE this WID when the encryption mode other than WEP is used. In that case, this WID return 0x03 as a reference value.
Set values:
Set Value Function Remark 0x01 Open System authentication 0x02 Shared Key authentication 0x03 Others (other than WEP) : DO NOT SET
Packet example:
Example where it turned out that this WID had been set to “Shared Key authentication”, when referring to the authentication type setting:
TX: 0640510106000D00
RX: 0830520108000D000102
Example of setting the authentication system to “Open authentication”:
TX: 0840570208000D000101
RX: 08305202080005000101
Related WID:
WID_11I_MODE 0x000C 8bit R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
84/172
10.2.18. WID_MAC_ADDR 0x300C String R
Description: Used to refer to MAC address.
Set value: (6 bytes) MAC address (Example: 0x001D12F10020= 00:1D:12:F1:00:20)
Packet example: Example where "0x001D12F10020" was returned when making a query about MAC address:
TX: 0640510106000C30
RX: 0D3052010D000C3006001D12F10020
Related WID:
None
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
85/172
10.2.19. WID_BCAST_SSID 0x0015 8bit R/W
Description: Used to set broadcast SSID option and refer to the setting.
Set value:
Set Value Function Remark
0x00 Disabled 0x01 Enabled
Default = 0x00(Disabled) [BSS-STA mode] ■ Enabled: A connection is connected to the possible AP automatically. ■ Disabled: It's connected to set SSID. [IBSS-STA mode] ■ It's impossible to use it.(Invalid) [AP mode] ■ Enabled: It'll be the stealth AP. ■ Disabled: It'll be non-stealth AP.
Packet example: Example where it turned out that this WID had been set to “Disabled”, when referring to the broadcast SSID option setting:
TX: 0640510106001500
RX: 08305201080015000100
Example of setting the broadcast SSID option to “Enabled”:
TX: 08405702080015000101
RX: 08305202080005000101
Related WID: WID_SSID 0x3000 String R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
86/172
10.2.20. WID_POWER_MANAGEMENT 0x000B 8bit R/W
Description: Used to make setting of IEEE802.11-compatible power management function and refer to the setting. Setting the power management function to “Enabled” will allow for data communication while achieving reduction of power consumption and maintaining connection to AP. (However, this results in communication performance degradation.) The following section describes precautions to be taken during the power management function is being executed:
Processing while in AP scan mode is changed to intermittent processing. While in any mode other than scan mode, the system is put into a sleep mode.
Setting this WID to Power management (Max) will ignore the DTIM interval of AP. Consequently, communications may present problems depending on applications to use.
Set values:
Set Value Function Remark 0x00 Power management disabled
0x01 High-speed power management (Normal)
0x02 High-speed power management (Max)
0x03 PS-POLL power management (Normal)
0x04 PS-POLL power management (Max)
The high-speed power management is a process that, when AP provides notification that it wants to send data, temporarily exits from power save mode (sends a awake NULL frame) and receives data sent from AP all at one time, and subsequently returns to power save mode (sends a sleep NULL frame). In contrast, the PS-POLL power management is a standard process that, when AP provides notification that it wants to send data, sends a data request frame called PS-POLL while maintaining the power save mode to receive MSDUs one after another. Consequently, if two or more MSDUs are accumulated at AP, the high-speed power management function provides higher responsiveness.
Packet example: Example where it turned out that this WID had been set to “Disabled”, when referring to the power management function setting:
TX: 0640510106000B00
RX: 0830520108000B000100
Example of setting the power management function to “High-speed power management (Normal)”:
TX: 0840570208000B000101
RX: 08305202080005000101
Related WID:
WID_UART_PM_ACTIVE_TIME 0x1F10 16bit R/W WID_POWER_SAVE 0x0100 8bit W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
87/172
10.2.21. WID_POWER_SAVE 0x010D 8bit W
Description: Used to make setting of power save function of the ROHM’s proprietary specification and refer to the setting. This function can be used to stop WLAN for an extended period of time. If this WID command is set to “Sleep”, the system will be put into a sleep mode as soon as it receives the WID command. Since it is the same even if AP is connected, data frames that have been sent later may be discarded. Returning from the quiescent mode impairs guarantee for line connection to AP. If AP already disconnects the line, the device tries to reconnect the line. To return from sleep mode, set this WID to “Active”. CAUTION: Do not set this WID to “Sleep” while in sleep mode. Be sure to set the WID to “Active” once, and then issue a sleep instruction again. While in sleep mode, the time management function in the module stops and the time maintained by the timer is not guaranteed.
Set value:
Set Value Function Remark
0x00 Active
0x02 Sleep
Packet example:
Example of setting the power control status to “Sleep”:
TX: 08405702080000010102
RX: 08305202080005000101
Related WID:
WID_POWER_MANAGEMENT 0x000B 8bit R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
88/172
10.2.22. WID_LISTEN_INTERVAL 0x000F 8bit R/W
Description: Used to set listen intervals and refer to the setting. This WID is designed to make adjustment of awake timing of the BU1805GU in power management mode. The larger the set value, a period of time to continue sleep mode becomes increasingly longer. This contributes to power saving, but correspondingly results in longer time to respond to communication. Furthermore, setting this WID to an excessively-large value may cause the AP side to refuse connection. (Whether or not the AP side refuses connection depends on the AP specification.)
Set value: 1 to 255
Default 3 The set value means the number of beacons. Beacon interval setting is done by the “WID_BEACON_INTERVAL” command.
Packet example: Example where it turned out that this WID had been set to “3”, when referring to the listen interval setting:
TX: 0640510106000F00
RX: 0830520108000F000103
Example of setting the listen interval to “10”:
TX: 0840570208000F00010A
RX: 08305202080005000101
Related WID:
WID_BEACON_INTERVAL 0x1006 16bit R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
89/172
10.2.23. WID_WPS_DEV_MODE 0x0044 8bit R/W
Description: Used to set WPS device mode. Device mode is designed to specify whether to maintain a credential within the device (stand-alone mode) or by the host (host control mode). While in stand-alone mode, a credential is recorded in EEPROM within the device and the device tries to make connection according to the stored credential for the subsequent startup. Note that only one credential can be recorded. Host control mode is designed not to record any credential in EEPROM. The host will save and set credentials instead. This mode allows two or more credentials to be managed by performing WPS protocols with two or more APs. Setting this WID to “Stand-alone mode” will automatically initiate connecting to the relevant AP after completion of WPS protocol. In contrast, setting the WID to “Host managed mode” will not initiate connecting to the AP even after completion of WPS protocol until the host makes credential setting.
Set value:
Set Value Function Remark
0x00 Stand-alone mode
0x01 Host managed mode
Packet example:
Example where it turned out that this WID had been set to “Stand-alone mode”, when referring to the WPS device mode setting:
TX: 0640510106004400
RX: 08305201080044000100
Example of setting WPS device mode to “Host control mode”:
TX: 08405702080044000101
RX: 08305202080005000101
Related WID:
WID_WPS_START 0x0043 8bit R/W WID_WPS_PIN 0x3025 String R/W WID_WPS_CRED_LIST 0x4006 Binary R/W WID_WPS_STATUS 0x3024 String I WID_MAINTE_CRDL 0x0FF2 8bit R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
90/172
10.2.24. WID_WPS_START 0x0043 8bit R/W
Description: Used to make setting of WPS authentication operation mode and also indicate the current authentication operation mode by acquiring the set value. [BSS-STA mode] ■ Movement of WPS Enrollee is established. ■ When the “WID_WPS_DEV_MODE” is set to “Stand-alone mode”, a credential will be
recorded in EEPROM. However, it can be erased by setting “003” to this WID. [IBSS-STA mode] ■ It's impossible to use it.(Invalid) [AP mode] ■ Movement of WPS Registrar is established. ■ After movement starting of WPS-PIN system and WPS-PBC system, a connection from WPS
Enrollee is accepted during about 120 seconds.
Set value:
Set Value Function Remark
0x00 WPS protocol stop (for setting) WPS protocol end (for referring)
Stop setting is only BSS-STA mode
0x01 WPS-PIN method 0x02 WPS-PBC method 0x03 EEPROM credential erase Only BSS-STA mode
Packet example:
Example where it turned out that this WID had been set to “WPS-PIN method”, when referring to the WPS authentication operation mode setting:
TX: 0640510106004300
RX: 08305201080043000101
Example of setting authentication operation mode to “WPS-PBC method”:
TX: 08405702080043000102
RX: 08305202080005000101
Related WID:
WID_WPS_DEV_MODE 0x0044 8bit R/W WID_WPS_PIN 0x3025 String R/W WID_WPS_CRED_LIST 0x4006 Binary R/W WID_WPS_STATUS 0x3024 String I WID_MAINTE_CRDL 0x0FF2 8bit R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
91/172
10.2.25. WID_WPS_PASS_ID 0x1017 16bit R/W
Description: Device Password ID of WPS is established. Before beginning WPS Registrar movement in WID_WPS_START, it's necessary to establish it.
Set value:
Set Value Function Remark
0x00 WPS-PIN method 0x01 WPS-PBC method
Default = 0x00(PIN method)
Packet example: Example where it turned out that this WID had been set to “WPS-PIN method”, when referring to the WPS authentication operation mode setting:
TX: 0640510106004300
RX: 08305201080043000101
Example of setting authentication operation mode to “WPS-PBC method”:
TX: 08405702080043000102
RX: 08305202080005000101
Related WID:
WID_WPS_START 0x0043 8bit R/W WID_WPS_PIN 0x3025 String R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
92/172
10.2.26. WID_WPS_PIN 0x3025 String R/W
Description: Used to set PIN code when WPS-PIN method is used.
Set value:
Make setting of 8-digit PIN code in ASCII code (e.g. '1’031). Set same PIN code which is set to Access Point (WPS Registrar).
Packet example: Example where it turned out that PIN code had been set to “39494962”:
TX: 0640510106002530
RX: 0F3052010F002530083339343934393632
Example of setting PIN code to “39494962”:
TX: 0F40570208002530083339343934393632
RX: 08305202080005000101
Related WID:
WID_WPS_DEV_MODE 0x0044 8bit R/W WID_WPS_START 0x0043 8bit R/W WID_WPS_CRED_LIST 0x4006 Binary R/W WID_WPS_STATUS 0x3024 String I WID_MAINTE_CRDL 0x0FF2 8bit R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
93/172
10.2.27. WID_WPS_CRED_LIST 0x4006 Binary R/W
Description: Used to acquire credentials (information on connection to AP) that was acquired by WPS authentication, and set credentials.
Set value: The following table shows a format of credential.
Field Name Size Function
Credential Number 1 Number of credentials.
Credential 1 Length 1 Size of Credential 1.
Credential 1 Value Refer to a format of credential value.
…
Credential N Length 1 Size of Credential N.
Credential N Value Refer to a format of credential value.
The following table shows a format of Credential Value.
Field Name Size Function
SSID Parameter WID 2 WID_SSID number
WID Length 1
WID Value 0 to 32 Field varies with WID Length setting.
11i Mode Parameter WID 2 WID_11I_MODE number
WID Length 1
WID Value 1
Auth Type Parameter WID 2 WID_AUTH_TYPE number
WID Length 1
WID Value 1
WEP Key ID Parameter WID 2 WID_KEY_ID number (only when WEP setting is enabled).
WID Length 1
WID Value 1
WEP Key Parameter WID 2 WID_WEP_KEY_VALUE0 number (only when WEP setting is enabled).
WID Length 1
WID Value 5 or 13 Field varies with WID Length setting.
PSK Parameter WID 2 WID_11I_PSK number setting.
WID Length 1
WID Value 0 to 64 Field varies with WID Length setting.
BSSID Parameter WID 2 Used to make WID_BSSID number setting.
WID Length 1
WID Value 6
Packet example: Example where it turned out that credential information acquired had been set as follows:
SSID"AP1", SecurityWPA2-AES, PSK12345678, and MAC00:1D:12:00:00:01 TX: 0640510106000640
RX:2D3052012D000640240001210030034150310C0001310D000103083008313233343536
3738033006001D12000001ADB3
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
94/172
Example of setting credential information as follows:
SSID"AP1", SecurityWPA2-AES, PSK12345678, and MAC00:1D:12:00:00:01
TX: 2D4057022D000640240001210030034150310C0001310D000103083008313233343536
3738033006001D12000001ADB3
RX: 08305202080005000101
Related WID:
WID_WPS_DEV_MODE 0x0044 8bit R/W WID_WPS_START 0x0043 8bit R/W WID_WPS_PIN 0x3025 String R/W WID_WPS_STATUS 0x3024 String I WID_MAINTE_CRDL 0x0FF2 8bit R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
95/172
10.2.28. WID_WPS_STATUS 0x3024 String I
Description: Used to provide notification of progress and error status in WPS authentication. Asynchronous notification of this WID is provided as the message type of 'I' (Information).
Set value: The AP mode is different from BSS-STA mode in the format. Value of the BSS-STA mode The format of the BSS-STA mode is as follows. The Status String field is variable by a status cord.
Field Name Size Function
Status Code 1 Status code
Status String n Status string information (variable)
A status cord is defined as follows.
Value Status code Status String
Function
0x00 IN_PROGRESS Not provided
WPS session start
0x01 ASSOC_PASS Not provided
It's connected in WPS registrar.
0x02 REG_PROT_SUCC_COMP Not provided
WPS session normal end
0x40 RCV_CRED_VALUE Not provided
Unused
0x41 CRED_JOIN_FAILURE Not provided
Connection failure in designated credential
0x42 CRED_JOIN_SUCCESS Provided Connection success in designated credential
0x43 CRED_JOIN_LIST_NULL Not provided
Designated credential is empty.
0x80 ERR_ASSOC_FAIL Not provided
It was connected with WPS registrar, but I fail in WPS session
0x81 ERR_SYSTEM Not provided
System error
0x82 ERR_WALK_TIMEOUT Not provided
WPS session, uncompleted condition time-out
0x83 SESSION_OVERLAP_DETECTED
Not provided
Overlap of a PBC session is detected.
0x84 ERR_PBC_REC_FAIL Not provided
FAIL message is received during PBC session.
0x85 ERR_REC_FAIL Not provided
Unplanned EAP-FAIL message is received during WPS session
0x86 ERR_REC_NACK Not provided
Unplanned EAP-WSC_NACK message is received during WPS session.
0x87 ERR_DIFF_PASS_ID_M2 Not provided
Device password ID for M2 message isn't identical.
0x88 ERR_REC_WRONG_M2 Not provided
Abnormal M2 message is received
0x89 REC_M2D Provided M2D message is received (Not
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
96/172
ready for a registrar)
0x8A ERR_REC_WRONG_M4 Not provided
Abnormal M4 message is received
0x8B ERR_REC_WRONG_M6 Not provided
Abnormal M6 message is received
0x8C ERR_REC_WRONG_M8 Not provided
Abnormal M8 message is received
0x8D ERR_REG_MSG_TIMEOUT Not provided
WPS-EAP message reception time-out
0x8F ERR_REG_PROT_TIMEOUT Not provided
WPS-EAP protocol timeout
0x90 ERR_STA_DISCONNECT Not provided
It's cut with registrar during WPS session.
0x91 ERR_REC_M2_AUTH_FAIL Not provided
M2_AHTU_FAIL message is received
0x92 ERR_REC_AUTH_FAIL Not provided
AHTU_FAIL message is received
0xC0 WLAN_DIS_WPS_PROT Not provided
WPS session stop by WLAN cutoff
The following section describes details of status string fields in case of REC_M2D error:
Field Name Size Function
Registrar UUID 16 Registrar UUID (Universally Unique Identifier)
Registrar Manufacturer 64 Registrar manufacturer name.
Registrar Manufacturer Length 1 The number of valid characters of registrar manufacturer.
Registrar Model Name 32 Registrar model name.
Registrar Model Name Length 1 The number of valid characters of registrar model name.
Registrar Model Number 32 Registrar model number.
Registrar Model Number Length 1 The number of valid characters of registrar model number.
Registrar Serial Number 32 Registrar serial number.
Registrar Serial Number Length 1 The number of valid characters of registrar serial number.
Registrar Device Name 32 Registrar device name.
Registrar Device Name Length 1 The number of valid characters of registrar device name.
For detail of status string field in case of CRED_JOIN_SUCCESS error, refer to “Credential value” section of WID_WPS_CRED_LIST. Value of the AP mode The format of the AP mode is as follows.
Field Name Size Function
Mode 1 0x00 fixed(WPS-Regstrar)
Status Code 1 Status code
Config Error 2 The number of configuration error(Value prescribed by Wi-Fi Alliance)
Status codes are defined as shown in the table below.
Set Value Status Code Status String Remark
0x00 START_REQ Not provided Registrar requests protocol starting
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
97/172
(normality)
0x01 PBC_SESSION_OVERLAP Not provided Registrar detects PBC session overlap (abnormality)
0x02 REGPROT_START Not provided Registrar begins a protocol (normality)
0x03 M2D_TX Not provided Registrar sends M2D(abnormality)
0x04 NACK_RX_FAIL Provided NACK reception from Enrollee(abnormal)
0x05 PROT_COMP_SUCCESS Not provided Protocol normal end of Registrar (normality)
0x07 RXED_WRONG_M3 Not provided M3 abnormal from Enrollee message is received(Abnormality)
0x08 RXED_WRONG_M5 Not provided M5 abnormal from Enrollee message is received(Abnormality)
0x09 RXED_WRONG_M7 Not provided M7 abnormal from Enrollee message is received(Abnormality)
0x0A EAP_MSG_TIMEOUT Not provided Unused
0x0B CONF_METH_MISMATCH Not provided Registrar detects the adjustment-lessness of Config Method(abnormality)
0x0C CONN_TYPE_MISMSTCH Not provided Registrar detects the adjustment-lessness of Connection Type(abnormality)
0x0D AUTH_TYPE_MISMATCH Not provided Registrar detects the adjustment-lessness of Authentication Type(abnormality)
0x0E ENCR_TYPE_MISMATCH Not provided Registrar detects the adjustment-lessness of Encryption Type(abnormality)
0x0F UNEXP_MSG_M3 Not provided Unused
0x10 UNEXP_MSG_M5 Not provided Unused
0x11 UNEXP_MSG_M7 Not provided Unused
0x12 PASS_ID_MISMATCH Not provided Registrar detects the adjustment-lessness of the Device Password ID (abnormality)
0x13 EAP_MSG_RETRY_LIMIT Not provided Registrar exceeds the transmission retry number of times of the EAP message (abnormality)
0x14 EAP_BUFFER_NULL Not provided Registrar fails in the merit of the memory for EAP messages (abnormality)
0x15 M2D_SUCCESS Not provided M2D message transmission success
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
98/172
from Registrar(abnormal)
0x16 MULTIPLE_REG_ATTEMPT Not provided Unused
0x17 PIN_FAILURE_M5 Not provided Registrar detects SNonce1 abnormally by M5 message check of PIN(abnormality)
0x18 PIN_FAILURE_M7 Not provided Registrar detects SNonce2 abnormally by M7 message check of PIN(abnormality)
0x19 REG_PROT_WAIL_TIMEOUT Not provided Registrar session uncompleted condition time-out (abnormality)
Packet example:
BSS-STA mode Example where it turned out that status code acquired had been “ASSOC_PASS”:
RX: 08304901080024300101
AP mode Example where it turned out that status code acquired had been “PROT_COMP_SUCCESS”:
RX: 0930490109002430020005
Related WID:
WID_WPS_DEV_MODE 0x0044 8bit R/W WID_WPS_START 0x0043 8bit R/W WID_WPS_PIN 0x3025 String R/W WID_WPS_CRED_LIST 0x4006 Binary R/W WID_MAINTE_CRDL 0x0FF2 8bit R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
99/172
10.2.29. WID_RSSI 0x001F 8bit R
Description: Used to refer to RSSI value after making a correction to individual variability among modules. Since the value is negative value, it is expressed in 2’s complement. However, RSSI values are not averaged like WID_HUT_RSSI_EX or WID_HUT_ADJ_RSSI_EX.
Set value:
100dBm to 0dBm (0x9C to 0x00)
If “100dBm” is returned, this means the device is not connected to any device.
Packet example:
Example where it turned out that this WID had been set to “100dBm (09C)”, when referring to the RSSI value setting:
TX: 0640510106001F00
RX: 0830520108001F00019C
Related WID:
None
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
100/172
10.2.30. WID_SCAN_TYPE 0x0007 8bit R/W
Description: Used to set scanning type and refer to the setting. This setting is applicable to the following operations: ■ Automatic AP scanning
(in cases when firmware automatically executes AP scan) ■ Site survey AP scanning
(in cases when the host issues the “WID_START_SCAN_REQ” command to execute AP scan)
Set value:
Bit Parameter Remark
0 Method 0Passive scan
1Active scan
Packet example:
Example where it turned out that this WID had been set to “Passive scan”, when referring to the scanning type setting:
TX: 0640510106000700
RX: 08305201080007000100
Example of setting the scanning method to “Active scan”:
TX: 08405702080007000101
RX: 08305202080005000101
Related WID:
None
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
101/172
10.2.31. WID_SITE_SURVEY 0x000E 8bit R/W
Description: Used to set mode of site survey (AP/STA scan) function and refer to the setting. Site survey is the function of consciously searching for AP and STA and acquiring a list of them. The following section describes the procedure for connecting to intended AP and STA. 1. Select a mode with the “WID_SITE_SURVEY” command. 2. Make filter setting with the “WID_SCAN_FILTER” command. 3. Start a site survey with the “WID_START_SCAN_REQ” command. 4. Acquire the results of the site survey with the “WID_SITE_SURVEY_RESULTS” command. 5. Request connection to the intended destination with the “WID_JOIN_REQ” command. Making a connection request with the “WID_JOIN_REQ” command will automatically return the
set value of the “WID_SITE_SURVEY” command to “Site survey disabled” (002). When connection is made with the “WID_JOIN_REQ” command, the connection operation will be continued until it is detected even if the specified AP cannot be detected for some reason (Forced connection mode). To clear forced connection mode, use the “WID_SSID” command to make SSID setting again.
Set value:
Set Value Function Remark
0x00 Single channel scan mode
0x01 All channels scan mode
0x02 Site survey disabled
Single channel mode is used to execute AP and STA scan on the channel set with the “WID_CURRENT_CHANNEL”. (There are cases where AP and STA of adjacent channels are included.) All channels scan mode is used to execute AP and STA scan on all channels. When site survey disabled is selected, site survey is not performed and the device will try to connect to the AP of specified SSID. Unless this WID is set to “Site survey disabled”, the function of automatic connection to the specified SSID will not become enabled. (In order to autonomously maintain the connection wait status while in ad hoc mode, set this WID to “Site survey disabled”.)
Packet example: Example where it turned out that this WID had been set to “Single channel scan mode”, when referring to the site survey setting:
TX: 0640510106000E00
RX: 0830520108000E000100
Example of setting the site survey to “All channels scan mode”:
TX: 0840570208000E000101
RX: 08305202080005000101
Related WID:
WID_CURRENT_CHANNEL 0x0002 8bit R/W WID_START_SCAN_REQ 0x001E 8bit R/W WID_JOIN_REQ 0x0020 8bit W WID_SCAN_FILTER 0x0036 8bit R/W WID_SITE_SURVEY_RESULTS 0x3012 String R
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
102/172
10.2.32. WID_START_SCAN_REQ 0x001E 8bit R/W
Description: Used to start a site survey scan. For the procedure for connecting to intended AP and STA, refer to information in “WID_SITE_SURVEY” section.
Set value:
Set Value Function Remark
0x00 Disabled
0x01 Enabled
Setting this WID to “Enabled” will start a scan to prepare for acquiring scan information. Upon completion of the scan, the WID setting returns to “Disabled”. Scan information can be acquired by the use of the “WID_SITE_SURVEY_RESULTS” command. Be sure to make mode setting by the “WID_SITE_SURVEY” command before starting a scan.
Packet example: Example of setting scan start to “Enabled”.
TX: 0840570208001E000101
RX: 08305202080005000101
Related WID:
WID_CURRENT_CHANNEL 0x0002 8bit R/W WID_JOIN_REQ 0x0020 8bit W WID_SITE_SURVEY 0x000E 8bit R/W WID_SCAN_FILTER 0x0036 8bit R/W WID_SITE_SURVEY_RESULTS 0x3012 String R
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
103/172
10.2.33. WID_SITE_SURVEY_RESULTS 0x3012 String R
Description: Used to refer to site survey result. For the procedure for connecting to intended AP and STA, refer to information in “WID_SITE_SURVEY” section.
Set value: A maximum of 5 information can be acquired by one request, and a maximum of 8 information can be acquired by making a request twice. The number of scan information contained can be calculated from size parameter.
Name Size Function
size 1 Size of info block (in bytes)
index 1 Request index number
0 First request, 1 Second request
Info [1 to 5]
ssid 33 SSID string (maximum of 33 characters (including Null terminator)). For SSID of stealth AP, ssid[0] becomes null.
bsstype 1 Information indicating network configuration。
0x00 BSS-STA (Infrastructure)
0x01 IBSS-STA (Ad hoc)
channel 1 Channel number in use
security 1 Information indicating encryption mode
bit0 Encryption (0Disabled, 1Enabled)
bit1 WEP (0Disabled, 1Enabled)
bit2 WEP64/128 (0=WEP64、1=WEP128)
bit3 WPA (0Disabled, 1Enabled)
bit4 WPA2 (0Disabled, 1Enabled)
bit5 CCMP (0Disabled, 1Enabled)
bit6 TKIP (0Disabled, 1Enabled) bit7 (Reserved) (CAUTION) If bit0 is enabled and all values from Bit1 to Bit6 are disabled, this means that detailed encryption information is unknown.
bssid 6 BSSID (6 bytes)
rxpower 1 Received signal strength (dB). range: 100 to 0dB
reserved 1 Reserved (1 byte)
Packet example:
Example where information shown below was returned when making a query about scanned information:
ssid "WIFI"
bsstype IBSS-STA (Ad hoc)
channel 11
security 0
bssid 11:22:33:44:55:66
rxpower 70
TX: 0640510106001230
RX: 35305201350012302E2C005749464900000000000000000000000000000000
00000000000000000000000000010B00001122334455BA00
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
104/172
Related WID: WID_CURRENT_CHANNEL 0x0002 8bit R/W WID_START_SCAN_REQ 0x001E 8bit R/W WID_JOIN_REQ 0x0020 8bit W WID_SITE_SURVEY 0x000E 8bit R/W WID_SCAN_FILTER 0x0036 8bit R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
105/172
10.2.34. WID_SCAN_FILTER 0x0036 8bit R/W
Description: Used to make various filter settings for BSS scan. The parameters of this WID apply to all BSS information scan processing.
Set value:
Bit Parameter Remark
1:0 BSS attribute filter
00: All acquired 01: Only BSS-AP acquired 10: Only IBSS-STA acquired 11: Not acquired
Default 00
3:2 Scan priority 00: Prioritized in descending order of RSSI value 01: Prioritized in ascending order of RSSI value 10: Prioritized in the order of detection
BSS information that can be obtained by the “WID_SITE_SURVEY_RESULTS” command is not meant to apply to data sorting.
Default 00
4 CH filter 0: Not provided 1: Provided
If this parameter is set to “Provided”, BSS information on adjacent channels (except set channel) detected during scanning of the set channel will be discarded.
Default 0
Packet example:
Example of referring to set value (with the “BSS attribute filter” parameter set to “Only BSS-AP acquired” and “CH filter” parameter to “Provided”):
TX: 0640510106003600
RX: 08305201080036000111
Example of setting the “BSS attribute filter” to “Only BSS-AP acquired” and “CH filter” parameter to “Provided”:
TX: 08405702080036000111
RX: 08305202080005000101
Related WID:
WID_CURRENT_CHANNEL 0x0002 8bit R/W WID_START_SCAN_REQ 0x001E 8bit R/W WID_JOIN_REQ 0x0020 8bit W WID_SITE_SURVEY 0x000E 8bit R/W WID_SITE_SURVEY_RESULTS 0x3012 String R
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
106/172
10.2.35. WID_JOIN_REQ 0x0020 8bit W
Description: Used to go through the procedure for participation to the network of AP and STA acquired through site survey. For the procedure for connecting to the intended AP and STA, refer to information in “WID_SITE_SURVEY” section. Making a connection request with this WID will switch operation mode to forced connection mode. To cancel this mode, use the “WID_SSID” command to make SSID setting again.
Set value: 0 to 7 (Index number of site survey result) This value specifies information numbers (indexes) of AP and STA acquired through site survey.
Packet example: Example of going through the procedure for participation to third AP:
TX: 08405702080020000103
RX: 08305202080005000101
Related WID:
WID_CURRENT_CHANNEL 0x0002 8bit R/W WID_START_SCAN_REQ 0x001E 8bit R/W WID_SITE_SURVEY 0x000E 8bit R/W WID_SCAN_FILTER 0x0036 8bit R/W WID_SITE_SURVEY_RESULTS 0x3012 String R
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
107/172
10.2.36. WID_BEACON_INTERVAL 0x1006 16bit R/W
Description: Used to set Beacon interval and refer to the setting.
Set value:
1 to 60000 (TU) … TU (Time Unit) 1024 (us)
Default 100
Packet example: Example where it was turned out that this WID had been set to “100”, when referring to the Beacon interval setting:
TX: 0640510106000610
RX: 0930520109000610026400
Example of setting the Beacon interval to “500”:
TX: 094057020900061002F401
RX: 08305202080005000101
Related WID:
WID_LISTEN_INTERVAL 0x000F 8bit R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
108/172
10.2.37. WID_ENABLE_CHANNEL 0x2024 32bit R/W
Description: Used to make setting of channel to be used. For the channels configured as “Disabled” by this WID, scan and connection operations will not be performed. To protect output in undesirable channel, set this WID before radio output is activated by following operations. (1) Ad-Hoc mode (output to specified channel) (2) Infrastructure mode (output to all channel in scan operation)
Set value:
Bit Parameter Remark
0 1ch 0Disabled, 1Enabled
1 2ch 0Disabled, 1Enabled
2 3ch 0Disabled, 1Enabled
3 4ch 0Disabled, 1Enabled
4 5ch 0Disabled, 1Enabled
5 6ch 0Disabled, 1Enabled
6 7ch 0Disabled, 1Enabled
7 8ch 0Disabled, 1Enabled
8 9ch 0Disabled, 1Enabled
9 10ch 0Disabled, 1Enabled
10 11ch 0Disabled, 1Enabled
11 12ch 0Disabled, 1Enabled
12 13ch 0Disabled, 1Enabled
31:13 Reserved
Japanese version firmware Default 0x00001FFF (Use 1ch to 13ch)
English version firmware Default 0x000007FF (Use 1ch to 11ch)
Packet example: Example where it turned out that this WID had been set to “Use 1ch to 13ch” (0x00001FFF), when referring to the channel setting:
TX: 0640510106002420
RX: 0B3052010B00242004FF1F0000
Example of setting channel to “Use 1ch to 11ch (0x000007FF):
TX: 0B4057020B00242004FF070000
RX: 08305202080005000101
Related WID:
WID_CURRENT_CHANNEL 0x0002 8bit R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
109/172
10.2.38. WID_ANTENNA_SELECTION 0x0021 8bit R/W
Description: Used to select antenna to be used and refer to the setting. Setting this WID to “Diversity” will automatically select a best-suited antenna according to radio wave conditions. When referring to the setting, a currently-selected antenna will be returned. The same will apply to when this WID is set to “Diversity”. (This means the set value “0x02” is not returned.) Recommended antenna switch IC is μPD5713TK and it is controlled as shown below.
BU1805GU(Output) GPIO8
μPD5713TK(Input) Vcont
Antenna 1 Select 1
Antenna 2 Select 0
Set value:
Set Value Function Remark
0x00 Antenna 1
0x01 Antenna 2
0x02 Diversity
Packet example:
Example where it turned out that this WID had been set to “Antenna 1”, when referring to the antenna in use:
TX: 0640510106002100
RX: 08305201080021000100
Example of setting the antenna to use to “Diversity”:
TX: 08405702080021000102
RX: 08305202080005000101
Related WID:
None
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
110/172
10.2.39. WID_TX_POWER_RATE 0x1006 16bit R/W
Description: Used to change TX power and refer to the setting. This setting has effect only when Automatic Power Control (APC) is enabled. This setting is not stored in EEPROM and default Tx power after reset is always 100%.
Set value:
Set Value Function Remark
0x00 100% (maximum power)
0x01 70%
0x02 50%
0x03 35%
0x04 25%
Default = 0x00(100%)
Packet example: Example where “70%” was returned when making a query about Tx power:
TX: 0640510106000601
RX: 08305201080006010101
Example of setting the Tx power to “50%”:
TX: 08405702080006010102
RX: 08305202080005000101
Related WID:
None
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
111/172
10.2.40. WID_FIRMWARE_VERSION 0x3001 String R
Description: Used to refer to firmware version.
Set value: Firmware version string (of a maximum of 128 bytes)
Default Dependent on firmware version
Packet example: Example where “3.5.0” was returned when making a query about firmware version:
TX: 0640510106000130
RX: 0C3052010C00013005332E352E30
Related WID:
None
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
112/172
10.2.41. WID_SERIAL_NUMBER 0x3018 String R
Description: Used to refer to the individual identification serial number of WLAN module. This serial number is a number individually assigned to each WLAN module.
Set value: 16 bytes of hex serial number string are returned in ASCII code.
Packet example: Example where it turned out that this WID had set to "0806041622320011233445566778899", when referring to serial number setting:
TX: 0640510106001830
RX:13305201130018302030383036303431363232333230303131323233333434353536363737
38383939
Related WID:
None
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
113/172
10.2.42. WID_DTIM_PERIOD 0x0010 8bit R/W
Description: Setting in a period and reference of DTIM notice.
Set value: 1 to 255. Default = 3 Beacon interval is designated in WID_BEACON_INTERVAL.
Packet example: The example which was "3" when you referred to a period of DTIM notice
TX: 0640510106001000
RX: 08305201080010000103
DTIM the example which sets a period of notice as "10".
TX: 0840570208001000010A
RX: 08305202080005000101
Related WID: WID_BEACON_INTERVAL 0x1006 16bit R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
114/172
10.2.43. WID_STA_JOIN_INFO 0x4008 Binery N
Description: When STA connected or cut, I notify a host of information on the STA as asynchronous message.
Set value: The format is as follows.
Name Size Remark
AID 1 1 byte of lower rank of the association ID
MAC Address 6 MAC address of connected STA
STA type 1 Refer to STA type details
11g infomation 1 Refer to 11g infomation details
Security infomation 1 Refer to secrty infomation details
WMM infomation 2 Refer to WMM infomation details
11n infomation 2 Refer to 11n infomation details
Reserve 2 Always 0
STA type details
Value Fanction Remark
0 It isn't connected (It was cut)
1 STA which supported only 11a (5GHz) connects
2 STA which supported only 11a (2.4GHz) connects
3 STA which supported only 11b (2.4GHz) connects
4 STA which supported both 11a and b (2.4GHz) connects
5 STA which supported only 11n (2.4GHz) connects
6 STA which supported only 11bn(5GHz) connects
11g infomation details
Value Fanction Remark
0 Preamble : 0=Long, 1=short
1 Slot time : 0=Long, 1=short
7:2 Reserve : Always 0
Securty infomation details
Bit Fanction Remark
0 Security : 0=Disenable, 1=Enable
1 WEP64 : 0=Non-support, 1=Support
2 WEP128 : 0=Non-support, 1=Support
3 WPA : 0=Non-support, 1=Support
4 WPA2 : 0=Non-support, 1=Support
5 AES : 0=Non-support, 1=Support
6 TKIP : 0=Non-support, 1=Support
7 TSN : Always 0
WMM infomation details
Bit Fanction Remark
0 WMM : 0=Non-support, 1=Support
2:1 Max service period 0=All frame 1=2 frame
How many frames during buffering delivery?
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
115/172
2=4 frame 3=6frame
7:3 Reserve : Always 0
8 AC_VO trigger : 0=Non-support, 1=Support
9 AC_VO delivery : 0=Non-support, 1=Support
10 AC_VI trigger : 0=Non-support, 1=Support
11 AC_VI delivery : 0=Non-support, 1=Support
12 AC_BE trigger : 0=Non-support, 1=Support
13 AC_BE delivery : 0=Non-support, 1=Support
14 AC_BK trigger : 0=Non-support, 1=Support
15 AC_BK delivery : 0=Non-support, 1=Support
11n infomation details
Bit Fanction Remark
0 High throughput 0=Non-support, 1=Support
1 ACK which will be blocked immediately
0=Non-support, 1=Support
2 HT control field 0=Non-support, 1=Support
3 Longest A-MSDU frame size
0=3,839(byte) 1=7,935(byte)
5:4 Biggest Rx A-MPDU factor
0=8KB,1=16KB,2=32KB,3=64KB
7:6 Antenna composition 0=1x1,1=2x2,2=3x3,3=4x4
8 Band width 0=20MHz,1=40MHz
9 20MHz SGI 0=Non-support, 1=Support
10 40MHz SGI 0=Non-support, 1=Support
11 Greenfield 0=Non-support, 1=Support
12 LDPC code 0=Non-support, 1=Support
13 L-SIG TXOP 0=Non-support, 1=Support
15:14 SMPS mode 0=Reserve,1=Static,2=Dynamic,3=MIMO
Packet example:
Communication example.
RX : 1930520119000840100001001D1200A00705033100004702000059
Field name Remark
AID 0x01
MAC address 00:1D:12:00:A0:07
STA type STA which supported only 11n (2.4GHz) connects
11g information Short Preamble, Short slot time
Security information WPA2-AES
WMM information WMM none-support
11n information High throughput=Support, ACK which will be blocked immediately=Support, HT control field=Support, Longest A-MSDU frame size=3839byte, Biggest Rx A-MPDU factor=8KB, Antenna composition=1x1, Band width=20MHz, 20MHz SGI=Support,40MHz SGI=Non-support,Greenfield=Non-support,LDPC code=Non-support,L-SIG TXOP=Non-support,SMPS mode=statics
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
116/172
Related WID:
WID_CONNECTED_STA_LIST 0x4009 Binary R
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
117/172
10.2.44. WID_CONNECTED_STA_LIST 0x4009 Binary R
Description: Refer to connected STA information.
Set value: Format is as follows.
Name Size Fanction
STA information 1 16 Connected STA information 1
STA information 2 16 Connected STA information 2
,,,,,
STA information n 16 Connected STA information n
Format of each STA information is same as WID_STA_JOIN_INFO. Please divide the length of this information by 16 (the size of the STA information) to find the number of connected STA.
Packet example: Reference example
TX: 0640510106000940
RX: 2930520129000940200001001D1200A00705033100004702000002001D1200
A008050331000047020000B4
Example above-mentioned is when 2 of STA connects follows. SAT1
Field name Remark
AID 0x01
MAC address 00:1D:12:00:A0:07
STA type STA which supported only 11n (2.4GHz) connects
11g information Short Preamble, Short slot time
Security information WPA2-AES
WMM information WMM non-support
11n information High throughput=Support, ACK which will be blocked immediately=Support, HT control field=Support, Longest A-MSDU frame size=3839byte, Biggest Rx A-MPDU factor=8KB, Antenna composition=1x1, Band width=20MHz, 20MHz SGI=Support,40MHz SGI=Non-support,Greenfield=Non-support,LDPC code=Non-support,L-SIG TXOP=Non-support,SMPS mode=statics
STA2
Field name Remark
AID 0x02
MAC address 00:1D:12:00:A0:08
STA type STA which supported only 11n (2.4GHz) connects
11g information Short Preamble, Short slot time
Security information WPA2-AES
WMM information WMM non-support
11n information High throughput=Support, ACK which will be blocked immediately=Support, HT control field=Support, Longest A-MSDU frame size=3839byte, Biggest Rx A-MPDU
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
118/172
factor=8KB, Antenna composition=1x1, Band width=20MHz, 20MHz SGI=Support,40MHz SGI=Non-support,Greenfield=Non-support,LDPC code=Non-support,L-SIG TXOP=Non-support,SMPS mode=statics
Related WID:
WID_STA_JOIN_INFO 0x4008 Binary N
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
119/172
10.2.45. WID_DISCONNECT 0x0016 8bit W
Description: It's possible to cut a connection with STA of the designated association ID. When 0 is designated, it's possible to cut all STA connected at present together.
Set value: The cutoff which is whole STA in 0,Cutoff of STA optional by the association ID
Packet example: Example from which a connection with all connected STA is severed compulsorily
TX: 08405702080016000100
RX: 08305202080005000101
Related WID:
None
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
120/172
10.2.46. WID_REKEY_POLICY 0x0019 8bit R/W
Description: Establish renewal method of GTK (group key) and refer to it.
Set value:
Value Fanction Remark
0x01 Disenable
0x02 Time base WID_REKEY_PERIOD is used for the renewal cycle
Default = 0x02(Time base)
Packet example: Example GTK renewal method which referred to "timebase"
TX: 0640510106001900
RX: 08305201080019000102
Example which sets GTK renewal method as "invalidity"
TX: 08405702080019000101
RX: 08305202080005000101
Related WID: WID_REKEY_PERIOD 0x2010 32bit R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
121/172
10.2.47. WID_REKEY_PERIOD 0x2010 32bit R/W
Description: Establish renewal method of GTK (time base) and refer to it.
Set value: 0,60 to 86400 second(0 without renewals,0x0000003C to 0x00015180) Default = 86,400(=24 hour) The renewal cycle of GTK (group key) is designated by timebase. Only when timebase is chosen in WID_REKEY_POLICY, it's effective.
Packet example: Example which was 86,400 (0x15180) when referred to the GTK renewal cycle.
TX: 0640510106001020
RX: 0B3052010B0010200480510100
The example which sets the GTK renewal cycle as 3600 (0x0E10)
TX: 0B4057020B00102004100E0000
RX: 08305202080005000101
Related WID: WID_REKEY_POLICY 0x0019 8bit R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
122/172
10.2.48. WID_VSIE_FRAME 0x00B4 8bit R/W
Description: The frame classification which receives the frame to which VSIE is sent and VSIE is designated.
Set value:
Bit Fanction Remark
0 Beacon transmission (0=Disenable, 1=Enable)
1 Probe Request transmission (0=Disenable, 1=Enable)
2 Probe Response transmission (0=Disenable, 1=Enable)
3 Reserved
4 Beacon reception (0=Disenable, 1=Enable)
5 Probe Request reception (0=Disenable, 1=Enable)
6 Probe Response reception (0=Disenable, 1=Enable)
7 Reserved
Default = 0x00 (Everything is invalid in a transmission and reception)
Packet example: Refer to setting, " Beacon reception is an effective" example.
TX: 064051010600B400
RX: 083052010800B4000110
" Of a Beacon transmission and Probe Request transmission, it's effective" an established example
TX: 084057020800B4000103
RX: 08305202080005000101
Related WID: WID_VSIE_INFO_ENABLE 0x00B5 8bit R/W WID_VSIE_RX_OUI 0x2084 32bit R/W
WID_VSIE_TX_DATA 0x4085 Binary R/W WID_VSIE_RX_DATA 0x4086 Binary R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
123/172
10.2.49. WID_VSIE_INFO_ENABLE 0x00B5 8bit R/W
Description: When receiving VSIE, frame notice is designated. (This setting can also acquire the latest reception VSIE data by a Q frame by invalidity.)
Set value:
Value Fanction Remark
0x00 Disenable (Without “I” frame notice)
0x01 Enable (“I” frame notice)
Default = 0x00 (Without “I” frame notice)
Packet example: Example which was" invalidity (without "I" frame notice)" when referred to setting
TX: 064051010600B500
RX: 083052010800B5000100
" Effective ("I" frame notice.)" an established example
TX: 084057020800B5000101
RX: 08305202080005000101
Related WID: WID_VSIE_FRAME 0x00B4 8bit R/W WID_VSIE_RX_OUI 0x2084 32bit R/W
WID_VSIE_TX_DATA 0x4085 Binary R/W WID_VSIE_RX_DATA 0x4086 Binary R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
124/172
10.2.50. WID_VSIE_RX_OUI 0x2084 32bit R/W
Description: OUI in received VSIE is designated. (A filter is done in designated OUI, and it's received) The VSIE data which is already received by doing this setting is cleared.
Set value: OUI is designated using 3 bytes of lower rank. Default = 0x00000000
Packet example: The example which was 0x00,0x1D,0x012 when referred to received OUI
TX: 0640510106008420
RX: 0B3052010B00842004121D0000
The example which sets received OUI as 0x00,0x1D,0x012
TX: 0B4057020B00842004121D0000
RX: 08305202080005000101
Related WID: WID_VSIE_FRAME 0x00B4 8bit R/W WID_VSIE_INFO_ENABLE 0x00B5 32bit R/W
WID_VSIE_TX_DATA 0x4085 Binary R/W WID_VSIE_RX_DATA 0x4086 Binary R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
125/172
10.2.51. WID_VSIE_TX_DATA 0x4085 Binary R/W
Description: Sent VSIE data is established. It's possible to designate a sent management frame in WID_VSIE_FRAME.
Set value: The most large size by which setting is possible is 1000 bytes.When 1 of Element ID consists of 6-257 bytes and is within 1000 bytes, restriction of the number is not. It's able to establish Element ID up to 3 in case of the biggest composition (257 bytes). " It's assumed to be used with Vendor Specific information element", so after confirming IEEE802.11 standard, please use. Format is as follows.
Name Size Fanction
Element ID 1 Identifier
Length 1 The length of OUI and Data (byte)
OUI 3 Organizationally unique identifier
DATA 1 - 252 Data
,,,, ,,,,
Element ID 1
Length 1
OUI 3
Data 1 – 252
Packet example:
Setting example
TX: 12405701120085400900DD07001D12ABCDEF017B
RX: 08305201080005000101
Reference example
TX: 0640510206008540
RX: 12305202120085400900DD07001D12ABCDEF017B
Related WID: WID_VSIE_FRAME 0x00B4 8bit R/W WID_VSIE_INFO_ENABLE 0x00B5 8bit R/W
WID_VSIE_RX_OUI 0x2084 32bit R/W WID_VSIE_RX_DATA 0x4086 Binary R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
126/172
10.2.52. WID_VSIE_RX_DATA 0x4086 Binary R/I
Description: Refer to received VSIE data.It's possible to designate a management frame of the reception target in WID_VSIE_FRAME.Filtered OUI defines it in WID_VSIE_RX_OUI.
Set value: The format is same as WID_VSIE_TX_DATA. “When it's connected to an access point by a STA mode, a frame besides BSSID which belongs is broken, so reception VSIE data isn't renewed. (When receiving VSIE data of different BSSID, it's necessary to cut from an access point.)” “The frame of all except for for BSSID is broken except for a broadcast by the AP mode. (VSIE where other equipment is usually included in sent Probe Response Data isn't received.)”
Packet example: Reference example.
TX: 0640510106008640
RX: 12305201120086400900DD07001D12ABCDEF017B
Related WID:
WID_VSIE_FRAME 0x00B4 8bit R/W WID_VSIE_INFO_ENABLE 0x00B5 8bit R/W
WID_VSIE_RX_OUI 0x2084 Binary R/W WID_VSIE_TX_DATA 0x4085 Binary R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
127/172
10.2.53. WID_IP_DHCP 0x0F20 8bit R/W
Description: Used to make DHCP function setting to “Enabled” or “Disabled” and refer to the setting.
Set value:
Set Value Function Remark
0x00 DHCP disabled Default of STA mode
0x01 DHCP client
0x02 DHCP server (Only AP mode) Default of AP mode
[DHCP client fanction] IP address is acquired in this setting time and the time of WLAN access. [DHCP sever fanction] When this setting is performed, the setting contents of WID_IP_DHCP_NUM, WID_IP_DHCP_TIM and WID_IP_DHCP_ADDR are reflected, and a table for DHCP server management is cleared. It becomes possible to distribute it to stop an overlap of an IP address, please set DHCP at the front (before setting of WLAN). When changing the setting at WID_IP_GATEWAY and WID_IP_DNS, it becomes effective in (after DHCP server restart) after this setting.
Packet example: The example which was "invalidity" when referred to DHCP setting
TX: 064051010600200F
RX: 083052010800200F0100
DHCP setting "effective" an established example.
TX: 084057020800200F0101
RX: 08305202080005000101
Related WID:
WID_IP_ADDR 0x3F20 String R/W WID_IP_NETMSK 0x3F21 String R/W WID_IP_GATEWAY 0x3F22 String R/W WID_IP_DHCP_NUM 0x0F22 8bit R/W WID_IP_DHCP_TIM 0x0F23 8bit R/W WID_IP_DHCP_ADDR 0x3F25 String R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
128/172
10.2.54. WID_IP_HTTP 0x0F21 8bit R/W
Description: Used to enable or disable Web setting using HTTP, and refer to the setting. When this is disabled, TCP/IP port 80 is opened to the user.
Set value:
Set Value Function Remark
0x00 HTTP disabled
0x01 HTTP enabled
Packet example:
Example where it turned out that this WID had been set to “HTTP enabled”, when referring to the HTTP setting:
TX: 064051010600210F
RX: 083052010800210F0101
Example of setting HTTP to “HTTP disabled”:
TX: 084057020800210F0100
RX: 08305202080005000101
Related WID: None
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
129/172
10.2.55. WID_IP_DHCP_NUM 0x0F22 8bit R/W
Description: DHCP server establishes the number of the leased IP address and refers to it.
Set value: 1 to 16 Default = 16 [DHCP client fanction] IP address is acquired in this setting time and the time of WLAN access. [DHCP sever fanction] When this setting is performed, the setting contents of WID_IP_DHCP_NUM, WID_IP_DHCP_TIM and WID_IP_DHCP_ADDR are reflected, and a table for DHCP server management is cleared. It becomes possible to distribute it to stop an overlap of an IP address, please set DHCP at the front (before setting of WLAN). When changing the setting at WID_IP_GATEWAY and WID_IP_DNS, it becomes effective in (after DHCP server restart) after this setting.
Packet example: The example which was "invalidity" when referred to DHCP setting
TX: 064051010600200F
RX: 083052010800200F0100
DHCP setting "effective" an established example.
TX: 084057020800200F0101
RX: 08305202080005000101
Related WID:
WID_IP_ADDR 0x3F20 String R/W WID_IP_NETMSK 0x3F21 String R/W WID_IP_GATEWAY 0x3F22 String R/W WID_IP_DHCP_NUM 0x0F22 8bit R/W WID_IP_DHCP_TIM 0x0F23 8bit R/W WID_IP_DHCP_ADDR 0x3F25 String R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
130/172
10.2.56. WID_IP_DHCP_TIM 0x0F23 8bit R/W
Description: DHCP server sets time to complete lease and refers to it.
Set value:
bit Function Remark
5 - 0 Value 1 - 63,0(When unlimited) Default = 63
7:6 Unit 0 : Unlimited 1 : Reserved(Impossible to designate) 2 : Minute 3 : Hour
Default = 63 hour When WID_IP_DHCP is made 0x02 (DHCP server), setting is reflected.
Packet example: Lease example which was "63 hours" when referred to time to expire.
TX: 064051010600230F
RX: 083052010800230F01FF
Example which sets time to complete lease as "1 minute"
TX: 084057020800230F0141
RX: 08305202080005000101
Related WID: WID_IP_DHCP 0x0F20 8bit R/W WID_IP_DHCP_NUM 0x0F22 8bit R/W WID_IP_DHCP_ADDR 0x3F25 String R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
131/172
10.2.57. WID_IP_SNDDISCON 0x0F24 8bit R/W
Description: The session cutoff time-out which is at the time of TCP/IP transmission. When this set time (second) is exceeded after TCP data transmission, a session is cut. A buffer inside the firmware is limited, so when doing transmission processing in more than one session, for example the buffer which is used for only 1 session in it at the other sessions when retransmission processing of TCP is repeated, becomes little.Advance cutoff of TCP/IP by making this set value short and do communication of a normal session smoothly by such case. But, when this setting is established short, the cutoff measure which is at the time of TCP/IP transmission is advanced, so please be careful.
Set value: 1 to 255 (Unit : Second) Default = 64 second It's necessary to establish this setting before building of TCP/IP session. This timer is exercised in the time when a transmission timer of TCP/IP has expired. In other words, the session cutoff time-out when sending, will be this setting + the expiration time of a transmission timer. (Choose a transmission timer in the communication state by the price of at most 60 seconds and fluctuate)
Packet example: Example which was "63 seconds" when referred to it
TX: 064051010600240F
RX: 083052010800240F0140
Example set as "10 seconds"
TX: 084057020800240F010A
RX: 08305202080005000101
Related WID: WID_SOC_ACCEPT 0x4F00 Binary R/W WID_SOC_CONNECT 0x4F01 Binary R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
132/172
10.2.58. WID_IP_ADDR 0x3F20 String R/W
Description: To set IP address and refer to the setting.
Set value: Null-terminated string of 7 to 15 characters
Default "192.168.0.1" If this WID is read when DHCP is enabled and address is unresolved, "0.0.0.0" will be returned.
Packet example: Example where "192.168.0.1" was returned when making a query about IP address:
TX: 064051010600203F
RX: 123052011200203F0B3139322E3136382E302E31
Example of setting the IP address to "192.168.164.123":
TX: 164057011600203F0F3139322E3136382E3136342E313233
RX: 08305201080005000101
Related WID:
WID_IP_DHCP 0x0F20 8bit R/W WID_IP_NETMSK 0x3F21 String R/W WID_IP_GATEWAY 0x3F22 String R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
133/172
10.2.59. WID_IP_NETMSK 0x3F21 String R/W
Description: To set subnet mask and refer to the setting.
Set value: Null-terminated string of 7 to 15 characters
Default "255.255.255.0" If this WID is read when DHCP is enabled and address is unresolved, "0.0.0.0".is returned
Packet example: Example where "255.255.255.0" was returned when making a query about subnet mask:
TX: 064051010600213F
RX: 143052011400213F0D3235352E3235352E3235352E30
Example of setting the subnet mask to "255.255.0.0":
TX: 124057011200213F0B3235352E3235352E302E30
RX: 08305201080005000101
Related WID:
WID_IP_DHCP 0x0F20 8bit R/W WID_IP_ADDR 0x3F20 String R/W WID_IP_GATEWAY 0x3F22 String R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
134/172
10.2.60. WID_IP_GATEWAY 0x3F22 String R/W
Description: Used to set default gateway and refer to the setting. This setting will be valid when DHCP is set to “Disabled”.
Set value: Null-terminated string of 7 to 15 characters
STA mode default "192.168.0.254"
AP mode default "192.168.0.1" If this WID is read when DHCP is enabled and address is unresolved, "0.0.0.0" will be returned.
Packet example: Example where "192.168.0.254" was returned when making a query about default gateway:
TX: 064051010600223F
RX: 143052011400223F0D3139322E3136382E302E323534
Example of setting default gateway to “192.168.164.254":
TX: 164057011600223F0F3139322E3136382E3136342E323534
RX: 08305201080005000101
Related WID:
WID_IP_DHCP 0x0F20 8bit R/W WID_IP_ADDR 0x3F20 String R/W WID_IP_NETMSK 0x3F21 String R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
135/172
10.2.61. WID_IP_DNS 0x3F23 String R/W
Description: Used to set DNS IP address and refer to the setting.
Set value: Null-terminated string of 7 to 15 characters
STA mode default "192.168.0.255"
AP mode default "192.168.0.1"
Packet example: Example where "192.168.0.100" was returned when making a query about DNS address:
TX: 064051010600233F
RX: 143052011400233F0D3139322E3136382E302E313030
Example of setting DNS address to "192.168.164.100":
TX: 164057011600233F0F3139322E3136382E3136342E313030
RX: 08305201080005000101
Related WID:
WID_IP_RESOLVE 0x3F24 String R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
136/172
10.2.62. WID_IP_RESOLVE 0x3F24 String R/W
Description: Used to make IP address resolution (forward lookup) setting and refer to the setting.
Set value:
(1) For ’W’ frame:
(2) For ’Q’ frame:
(3) For ’R’ frame:
Set Value Function Remark NAME Host name (Forward IP address lookup is tried until the
address is resolved. Even if host name is set again during address resolution process, a previously-set host name is used and the new host name is ignored. In order to suspend address resolution, set DNS address using the “WID_IP_DNS” command.
IP IP address (Nothing returned when address is
unresolved (LEN0)). IP address the string separated by “.”.
Example: 192.168.0.2
Packet example: Example to set “yahoo.co.jp” for forward lookup:
TX: 124057631200243F0B7961686F6F2E636F2E6A70
RX: 08305263080005000101
Example where "203.216.243.240" was returned when referring to the resolved address:
TX: 064051640600243F
RX: 163052641600243F0F3230332E3231362E3234332E323430
Related WID: WID_IP_DNS 0x3F23 String R/W
NAME WID LEN
2byte 1byte
WID
2byte
1 to 255byte
IP WID LEN
2byte 1byte 0 to 255byte
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
137/172
10.2.63. WID_IP_DHCP_ADDR 0x3F25 String R/W
Description: DHCP server establishes a leased starting IP address and refers to it. Address by which setting is possible is the same network address as oneself. (Address is established at WID_IP_ADDR and WID_IP_NETMSK)
Set value: Null-terminated string of 7 to 15 characters
Default "192.168.0.10" When WID_IP_DHCP is made 0x02 (DHCP server), setting is reflected.
Packet example: When "192.168.0.100" has been returned when a starting IP address is inquired.
TX: 064051010600253F
RX: 143052011400253F0D3139322E3136382E302E313030
Example which sets a starting IP address as "192.168.164.100"
TX: 164057021600253F0F3139322E3136382E3136342E313030
RX: 08305202080005000101
Related WID:
WID_IP_DHCP 0x0F20 8bit R/W WID_IP_DHCP_NUM 0x0F22 8bit R/W WID_IP_DHCP_TIM 0x0F23 8bit R/W WID_IP_DHCP_ADDR 0x3F25 String R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
138/172
10.2.64. WID_SOC_ACCEPT 0x4F00 Binary R/W
Description: Used to make TCP server socket setting and refer to the setting. Depend infinitely until a session establishes a TCP server socket. When needing measure of time-out, please watch by WID_SOC_REF.
Set value: (1) For ’W’ frame:
(2) For ’Q’ frame:
(3) For ’R’ frame:
Parameter Function Remark SID Socket ID: 1 to 4 PRT Protocol:
(1) For ’W’ frame
Unused0, TCP server2 (2) For ’R’ frame (Notification is done only
for sockets using TCP server)
TCP server2
HP Local port number: 0 to 65535 (Duplication is acceptable)
Little-endian host byte ordering
Packet example: Example where the following information was returned when making a query about TCP server socket:
"Socket ID1, TCP server port16401"
TX: 064051660600004F
RX: 0D3052660D00004F04000102114054
Example of making parameter settings as "Socket ID2, TCP server port16402":
TX: 0D4057670D00004F04000202124056
RX: 08305267080005000101
WID SID LEN SUM
2byte
PRT HP
2byte 2byte 1byte 1byte 1byte
4byte
WID
2byte
WID SID LEN SUM
2byte
PRT HP
2byte 2byte 1byte 1byte 1byte
4byte
0 to 16byte (0 to 4 sets)
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
139/172
Related WID: WID_SOC_REF 0x4F03 Binary R
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
140/172
10.2.65. WID_SOC_CONNECT 0x4F01 Binary R/W
Description: Used to make TCP client socket setting and refer to the setting. TCP client socket keeps trying establishment of a connection in a fixed interval (2 seconds). When needing measure of time-out, please watch by WID_SOC_REF.
Set value: (1) For ’W’ frame:
(2) For ’Q’ frame:
(3) For ’R’ frame:
Parameter Function Remark SID Socket ID: 1 to 4 PRT Protocol:
(1) For ’W’ frame
Unused0, TCP client3 (2) For ’R’ frame (Notification is done only for sockets
using TCP client)
TCP client3
HP Local port number: 0 to 65535 (Duplication acceptable) Little-endian host byte ordering RP Remote port number: 0 to 65535 (Duplication acceptable)
RADR Remote IP address
Packet example: Example where the following information was returned when making a query about TCP client socket:
"Socket ID3, Local port16403, Server port15403, and server IP address192.168.0.10"
TX: 064051690600014F
RX: 133052691300014F0A00030313402B3C0A00A8C032
Example of making parameter settings as "Socket ID4, Source port16404, Server port15404,
and server IP address192.168.0.14":
TX: 1340576B1300014F0A00040314402C3C0E00A8C039
RX: 0830526B080005000101
WID LEN
2byte 2byte
WID
2byte
WID LEN
2byte 2byte
10byte
0 to 40byte (0 to 4 sets)
SID SUM PRT HP RP
2byte 2byte 1byte 1byte 1byte
10byte
SID SUM PRT HP RP RADR
2byte 2byte 1byte 1byte 1byte 4byte
RADR
4byte
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
141/172
Related WID: WID_SOC_REF 0x4F03 Binary R
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
142/172
10.2.66. WID_SOC_BIND 0x4F02 Binary R/W
Description: Used to make UDP socket setting and refer to the setting.
Set value: (1) For ’W’ frame:
(2) For ’Q’ frame:
(3) For ’R’ frame:
Parameter Function Remark SID Socket ID: 11 to 14 PRT Protocol:
(1) For ’W’ frame
Unused0, UDP1 (3) For ’R’ frame (Notification is done only for sockets
using UDP)
UDP1
HP Local port number: 0 to 65535 (Duplication acceptable) Little-endian host byte ordering RP Remote port number: 0 to 65535 (Duplication acceptable)
RADR Remote IP address
It's possible to change RP and RADR by a data packet, but the reference value will be the price established in book WID.
Packet example: Example where the following information was returned when making a query about UDP socket:
"Socket ID11, Local port16411, Remote port16511, and Remote IP address192.168.3.1"
TX: 064051780600024F
RX: 133052781300024F0A000B011B407F400103A8C092
Example of making parameter settings as "Socket ID12, Local port16412, Remote
port16512, and Remote IP address192.168.3.2":
TX: 134057791300024F0A000C011C4080400203A8C096
RX: 08305279080005000101
WID LEN
2byte 2byte
WID
2byte
WID LEN
2byte 2byte
10byte
0 to 40byte (0 to 4 sets)
SID SUM PRT HP RP
2byte 2byte 1byte 1byte 1byte
10byte
SID SUM PRT HP RP RADR
2byte 2byte 1byte 1byte 1byte 4byte
RADR
4byte
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
143/172
Related WID: WID_SOC_REF 0x4F03 Binary R
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
144/172
10.2.67. WID_SOC_REF 0x4F03 Binary R/W
Description: Used to refer to socket status.
Set value:
(1) For ’Q’ frame:
(2) For ’R’ frame:
(3) For ’I’ frame:
Parameter Function Remark SID Socket ID: 1 to 4, 11 to 14 PRT Protocol: Unused0, UDP1, TCP server2, TCP
client3
ST Status: (2) For ’R’ frame: UDP socket:
0Unused status, 1BIND completed, Any value other than 0 and 1Error
TCP socket: 0 Unused status 1Wait for connection (Wait for accept/connect) 2Connection established Any value other than 0, 1, and 2Error
(3) For ’I’ frame: UDP socket:
0Occurrence of receive time-out TCP socket:
0Occurrence of receive time-out 1Occurrence of disconnection (Transit to wait for
reconnection) 2Occurrence of connection established
RSV Reserved
WID
2byte
WID LEN
2byte
RSV
2byte 1byte
SID PRT ST
1byte 1byte 1byte
4byte
32byte (8 sets)
SUM
1byte
WID LEN
2byte
RSV
2byte 1byte
SID PRT ST
1byte 1byte 1byte
4byte
SUM
1byte
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
145/172
Notification of TCP connection change ‘I’ frame provides notification of the occurrence of TCP connection terminated/established. “SID, PRT, ST, RSV” come to 1 set (4 bytes).
Notification of TCP connection status ‘R’ frame corresponding to ‘Q’ frame provides notification of socket information including TCP connection information. “SID, PRT, ST, RSV” come to 8 set (32 bytes).
Notification of receive time-out If TCP/UDP socket causes receive time-out, ‘I’ frame provides notification of that (when any value other than “0” is set to the “WID_SOC_RCVTMO” command). “SID, PRT, ST, RSV” come to 1 set (4 bytes).
Packet example:
Example where notification of “TCP connection change, Socket ID1, TCP connection established” was provided:
RX: 0D3049000D00034F04000102020005
Related WID: WID_SOC_ACCEPT 0x4F00 Binary R/W WID_SOC_CONNECT 0x4F01 Binary R/W WID_SOC_BIND 0x4F02 Binary R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
146/172
10.2.68. WID_SOC_RCVTMO 0x4F04 Binary R/W
Description: Used to make receive time-out setting of socket and refer to the setting. When not receiving data in designated time, reception time-out notice by "I" frame (WID_SOC_REF) is performed. (It isn't time-out time designation of TCP session establishment)
Set value: (1) For ’W’ frame:
(2) For ’Q’ frame:
(3) For ’R’ frame:
Parameter Function Remark SID Socket ID: 1 to 4, 11 to 14 RSV Reserved TMO Receive time-out value: 0 (No time-out), 1 to 3600 (sec)
Packet example
Example of setting receive time-out to 10 seconds for ”Socket ID1”:
TX: 0D4057900D00044F040001000A000B
RX: 08305290080005000101
Example of notification of receive time-out for ”Socket ID1”:
RX: 0D3049030D00034F04000102000003
Related WID: WID_SOC_REF 0x4F03 Binary R
WID SID LEN SUM
2byte
RSV TMO
2byte 2byte 1byte 1byte 1byte
4byte
WID
2byte
WID SID LEN SUM
2byte
RSV TMO
2byte 2byte 1byte 1byte 1byte
4byte
0 to 16byte (0 to 4 sets)
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
147/172
10.2.69. WID_ARP_DELETE 0x0F26 8bit R/W
Description: ARP table inside the firmware is cleared. ARP frame is issued automatically by sending data after ARP table clearance, and it's possible to renew relating of an IP address inside the firmware and the MAC address.
Set value: It's cleared besides 0.
Packet example: Example which clears a ARP table
TX: 084057010800260F0101
RX: 08305201080005000101
Related WID:
None
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
148/172
10.2.70. WID_IP_MCAST_TTL 0x0F25 8bit R/W
Description: TTL of transmission multicast frame is set. Please use a UDP socket for sending and receiving of a multicast. This setting becomes effective to all UDP sockets. It can't be established every socket.
Set value: 1 to 255 Default = 1
Packet example: Example which was "1" when referred to it
TX: 064051010600250F
RX: 083052010800250F0101
Example set as "3"
TX: 084057020800250F0103
RX: 083052020800050F0101
Related WID:
WID_IP_MCAST_JOIN 0x3F26 String R/W WID_IP_MCAST_DROP 0x3F27 String W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
149/172
10.2.71. WID_IP_MCAST_JOIN 0x3F26 String R/W
Description: The multicast IP address with which participate in a multicast group is registered. It's possible to register at most 8 IP addresses, but the one which can be registered together is one, so when registering, 8 IP addresses have to put it into effect 8 times. When referring to it, a registered IP address can be acquired sometime. Please use a UDP socket for sending and receiving of a multicast. This setting becomes effective to all UDP sockets. It can't be established every socket.
Set value: (At the time of setting) NULL termination character string of 7-15 character Dominance 4bit will be the address of 1110 for a multicast IP address. (At the time of a reference) The NULL termination character string into which a registered IP address of 7-15 character was divided by "&" Default = “None”
Packet example: When I refer to it" with 224.1.0.1" and " 224.2.0.2" is a registered example.
TX: 064051010600263F
RX: 1A3052011A00263F133232342E312E302E31263232342E322E302E32
Example with which "224.1.0.1" is registered
TX: 104057021000263F093232342E312E302E31
RX: 083052020800050F0101
Related WID:
WID_IP_MCAST_TTL 0x0F25 8bit R/W WID_IP_MCAST_DROP 0x3F27 String W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
150/172
10.2.72. WID_IP_MCAST_DROP 0x3F27 String W
Description: The multicast IP address with which participate in a multicast group is released. Please refer to a registered multicast IP address by WID_IP_MCAST_JOIN. Please use a UDP socket for sending and receiving of a multicast. This setting becomes effective to all UDP sockets. It can't be established every socket.
Set value: NULL termination character string of 7-15 character Dominance 4bit will be the address of 1110 for a multicast IP address.
Packet example: Example from which "224.1.0.1" is released
TX: 104057011000273F093232342E312E302E31
RX: 083052010800050F0101
Related WID:
WID_IP_MCAST_TTL 0x0F25 8bit R/W WID_IP_MCAST_JOIN 0x3F26 String R/W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
151/172
10.2.73. WID_MAINTE_DEFAULT 0x0FF1 8bit W
Description: Used to restore default parameter setting.
Set value:
Set Value Function Remark
0x01 Used to restore default.
Packet example:
Example of restore default parameter setting:
TX: 084057020800F10F0101
RX: 08305202080005000101
Related WID:
WID_MAINTE_SAVE 0x0FF0 8bit W
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
152/172
10.2.74. WID_MAINTE_SAVE 0x0FF0 8bit W
Description: Used to save parameter setting into EEPROM. WLAN, TCP/IP, and UART parameters are saved and the actual WID parameters saved are described in the table below. The saved-area of a setting value is common by a STA mode and the AP mode. It's interchangeable with a STA mode by the AP mode, but it's overwritten, so please be careful.
Set value:
Set Value Function Remark
0x01 For WLAN parameters, the currently valid setting is saved. (These are the value which can be referred by WID and can be different from the value user specified.
0x02 For WLAN parameters, the value user specified are saved,
Use this value to return the parameter setting to default.
(The set value of the saved-area is called the user set value. When WID_MAINTE_DEFAULT is carried out, the user set value will be default, but effective setting won't be default at present from the necessity which can continue and communicate.)
Packet example: Example of saving parameter setting into EEPROM (i.e., save currently valid WLAN setting:
TX: 084057020800F00F0101
RX: 08305202080005000101
Related WID:
The table shown below lists settings to be saved:
WID Name WID Number Setting to be saved
WID_BSS_TYPE 0x0000 Communication type
WID_CURRENT_CHANNEL 0x0002 Channel
WID_SSID 0x3000 SSID
WID_WEP_KEY_VALUE 0x3004 WEP key
WID_11I_PSK 0x3008 WPA/WPA2 Pre-Shared Key
WID_11I_MODE 0x000C Encryption / Authentication mode
WID_POWER_MANAGEMENT 0x000B Power save mode
WID_IP_DHCP 0x0F20 DHCP client
WID_IP_DHCP_NUM 0x0F22 Number of DHCP lease IP addresses
WID_IP_DHCP_TIM 0x0F23 DHCP lease time
WID_IP_DHCP_ADDR 0x3F25 DHCP lease start IP address
WID_IP_ADDR 0x3F20 IP address
WID_IP_NETMSK 0x3F21 Subnet mask
WID_IP_GATEWAY 0x3F22 Gateway IP address
WID_IP_DNS 0x3F23 DNS IP address
WID_MAINTE_PASSWD 0x3FF0 Password for Web setting
WID_MAINTE_CRDL 0x0FF2 Credential connection for startup
WID_UART_CFG 0x2F10 UART communication parameter
WID_UART_TIMEOUT 0x0F10 Startup timeout time
WID_UART_DELAY 0x0F11 UART Inter-character delay
WID_UART_PM_ACTIVE_TIME 0x1F10 Awake time during power management
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
153/172
10.2.75. WID_MAINTE_PASSWD 0x3FF0 String R/W
Description: Used to change login password for Web setting and refer to the setting.
Set value: Password string (of a maximum of 8 bytes)
Default "password"
Packet example: Example where it turned out that the password had been set to "password" (70 61 73 73 77 6F 72 64), when referring to the password setting:
TX: 064051010600F03F
RX: 0F3052010F00F03F0870617373776F7264
Example of setting password to "1%pass&" (31 25 70 61 73 73 26):
TX: 0E4057020E00F03F0731257061737326
RX: 08305202080005000101
Related WID:
None
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
154/172
10.2.76. WID_MAINTE_CRDL 0x0FF2 8bit R/W
Description: Used to make setting of credential connection for startup and refer to the setting.
Set value:
Set Value Function Remark
0x00 Credential connection disabled
0x01 Credential connection enabled
Setting credential connection to “enabled” will try to make WPS connection using credentials for startup. Setting this WID to “disabled” will enable WLAN settings except for WPS.
Packet example: Example where it turned out that this WID had been set to “disabled”, when referring to the WPS connection for startup:
TX: 064051010600F20F
RX: 083052010800F20F0100
Example of setting WPS connection for startup to “enabled”:
TX: 084057020800F20F0101
RX: 08305202080005000101
Related WID:
WID_WPS_DEV_MODE 0x0044 8bit R/W WID_WPS_START 0x0043 8bit R/W WID_WPS_PIN 0x3025 String R/W WID_WPS_CRED_LIST 0x4006 Binary R/W WID_WPS_STATUS 0x3024 String I
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
155/172
11. Hardware Setting This Chapter describes information on hardware setting.
11.1 Connection to Host Make connection between the host and the BU1805GU as follows: (Arrows indicate I/O direction.)
Host side BU1805GU side
UART_TXD
UART_RXD
SDDATA1(UART_RTS)
SDDATA0(UART_CTS)
TXD
RXD
RTS
CTS
SDCLK
SDCMD
3.3V
11.2 Reset Latch Setting The operation mode of BU1805GU is determined by the signal levels of some specific pins when the PRST (Power On Reset) is deactivated. The table below shows the select pin setting of each operation mode which is used by TCP/IP Built-In WLAN.
Signal UART host load mode Flash ROM load mode BOOT_SEL1 H H
BOOT_SEL0 H L
HOST_SEL L L
FLASH_SEL L = flash area 0 H = flash area 1
L = flash area 0 H = flash area 1
Usage - WLAN operation after downloading firmware from UART
- Write firmware into external serial flash memory
- WLAN operation after downloading firmware from external flash memory
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
156/172
11.3 Recommended Circuit The following diagram shows a recommended circuit for BP3580 (module) when external flash memory is used.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
157/172
The following diagram shows a recommended circuit for BP3591 (module with antenna) when external flash memory is used.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
158/172
12. Firmware Execution This Chapter describes the procedure from downloading through start firmware execution. This operation can be done when the BU1805GU is in UART host load mode (“Refer to 11.2 Reset Latch Setting“).
12.1 Downloading This Section describes the procedure for downloading firmware from UART. The table shown below describes UART setting for downloading firmware.
Parameter Setting
Baud rate 115200
Date width 8 bits
Parity No parity
Stop bit 1 bit
Line feed code ReceiveCR(0x0D), SendCR(0x0D)
Firmware is downloaded and activated by sending a command to the boot loader of the BU1805GU.
12.1.1 Commands The table shown below describes commands used to download firmware.
Command Function
fld Used to set the system to firmware download mode. For this purpose, baud rate must be set to “115200”.
fgo Used to start firmware execution.
12.1.2 Procedure ■ After starting terminal software, power up BU1805GU in UART host load mode. Then a
prompt “ROM>” is sent from BU1805GU and displayed on the console. ■ When the "fld" command is sent after the prompt is received, the boot loader will be put into
download mode. ■ After sending the "fld" command, send the binary file of firmware as continuous data. ■ By sending “fgo” command after the "ROM>" prompt is received, the downloaded firmware
execution will start. Downloading flow is as described below. (Characters sent from the host are italicized.)
/********************************/ IEEE802.11n 1x1 LSI BU1805 Bootloader on ROM (C) 2010 ROHM CO.,LTD. /********************************/ H/w version = 00000013 ROM version = 3.0.2 reset_latch = 00000003 mode3 Serial ROM> fld Please send the firmware with Binary mode. Loading..........completed. ver 3.3.2 (UART) load 0x10000000(201356 bytes) ROM> fgo
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
159/172
12.2 Firmware Start When the firmware is started with the “fgo” command, the banner of the TCP/IP built-in WLAN firmware will be displayed and the system will go into initial mode.
/********************************/ UART-Wireless Conversion Copyright (C) 2010 ROHM CO.,LTD. /********************************/ #++++++++++
《CAUTION》
If communication mode is selected, the BU1805GU will send the “WID_DEVICE_READY”. The host should not send configuration packet (WID packet) until it receives the “WID_DEVICE_READY”.
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
160/172
13. Firmware Writing This section assumes the external flash memory is used in the system, and describes about flash writing procedure and how to start executing firmware. Flash writing must be done in UART host load mode and the firmware execution with the program store in the flash memory must be done in Flash ROM load mode. The UART setting and the commands used in the procedure are same as that described in “12 Firmware Execution”
13.1 Firmware Writing Procedure ■ After starting terminal software, power up BU1805GU in UART host load mode. Then a
prompt “ROM>” is sent from BU1805GU and displayed on the console. ■ After the prompt is received, download firmware and the flash writing program as binary data
using “fld” command. ■ (flash writing program is different for flash area 0 and 1). ■ After receiving "ROM>" prompt, entering “fgo” command will start flash writing program
execution and the firmware is written into flash memory. These operation flow is shown below.(Characters sent from the host are italicized)
/********************************/
IEEE802.11n 1x1 LSI BU1805
Bootloader on ROM
(C) 2010 ROHM CO.,LTD.
/********************************/
H/w version = 00000013
ROM version = 3.0.2
reset_latch = 00000003
mode3 Serial
ROM> fld Please send the firmware with Binary mode.
Loading..........completed.
ver 3.6.2 (UART)
load 0x10000000(209772 bytes)
ROM> fld Please send the firmware with Binary mode.
Loading.completed.
ver 1.3.0 (FLASH)
load 0x10040000(9012 bytes)
ROM> fgo Flash Writer 1.3.0 Region 1
written 252KBytes.
finished writing successfully!
After this message appears, send firmware from terminal software as
binary data (e.g., fwimage362d_STA_UART.fbin)
After this message appears, send firmware writing program from terminal
software as binary data (e.g., BU1805GU_FLASH_WRITER_AREA_0.bin)
Flash writing completed
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
161/172
13.2 Flash ROM Boot In order to start operation with the firmware stored in the external flash memory, power on BU1805GU in Flash ROM load mode. Then the firmware is automatically downloaded from the external flash memory after the reset is released and the firmware execution start. FLASH_SEL pin is used to select the flash area 0 or 1 where the firmware is loaded from. Refer to “3 Initial Mode” for operating mode selection after firmware execution start. The following example shows the flow of entering config mode and confirm firmware version by ver command.
13.3 Initialize Setting When the firmware is updated, default setting needs to be restored. The procedure is shown below.
13.4 Change in firmware It's returned in the state before a firmware start by a PRST (power-on reset) signal and firmware is started once again based on setting of reset latch (11.2. Setting referring of reset latch) to change moving firmware. (STA calls the AP mode STA and the AP firmware at this chapter.) Please confirm the "notice which is a hardware specification about control of a PRST signal concerned with movement in 14 chapter (P22) reset movement.
********************************/
IEEE802.11n 1x1 LSI BU1805
Bootloader on ROM
(C) 2010 ROHM CO.,LTD.
/********************************/
H/w version = 00000013
ROM version = 3.0.2
reset_latch = 00000002
mode2 Flash region1 boot
/********************************/
UART-Wireless Conversion
Copyright (C) 2010 ROHM CO.,LTD.
/********************************/
+++++++++
#ver Show: versions = 3.6.2
Continuously pressing space key
stops「+++」and enter config mode
Confirm firmware version by “ver”command
#default permit
Default value of setting success.
#save permit
Preservation of setting success.
Restore default setting by
“default” command
Save restored parameters by “save”
command
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
162/172
13.1 Change procedure by a download start The example from which STA firmware is switched to the AP firmware is indicated. (The procedure switched from the AP firmware to STA firmware, like, it becomes) ■ Setting of reset latch (11.2. Setting referring of reset latch) is a host load mode here, and STA firmware will move. ■ PRST asserting and negate. ■ The AP firmware is started with a procedure of "12.1. Download start". The above mentioned flow is as follows.
13.1 Change procedure by FLASH ROM start The example from which STA firmware is switched to AP firmware is indicated.(The procedure switched from the AP firmware to STA firmware is also same.)
■ Setting of reset latch (11.2. Setting referring of reset latch) is FLASH ROM load mode here, and the AP
firmware will be written in STA firmware and flash territory 2 in flash territory 1.
■ 11.2. The FLASH_SEL signal of reset latch is made flash territory 2 (High).
■PRST asserting and nagate.
■ The AP firmware starts.
During STA firmware movement (Establishing of reset latch= host loading, mode)
PRST asserting and nagate
The AP firmware is downloaded & start
During STA firmware movement (Establishing of reset latch= Flash ROM loading, mode)
PRST asserting and nagate
FLASH_SEL signal is set as flash territory 2 (High)
The AP firmware is downloaded & start
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
163/172
13.1 About the set value of EEPROM The setting is reflected by the preserved set value at the time of a firmware start in EEPROM.A host can change it to the optional price after a firmware start by a communication mode, so while it "is until a host establishes it from a firmware start that the set value in EEPROM influences", it'll be. The set value in EEPROM is interchangeable by STA and the AP firmware. It's possible to share and use, but please confirm the following about the function to which each firmware is peculiar. [Function to which STA firmware is peculiar] * The communication type :IBSS-STA (ad hoc) and BSS - STA (infrastructure) After preserving this setting by STA firmware, when the AP firmware is started, the communication type
will be "The AP (wlan of an access point/a terminal mode_type It's transcribed with infrastructure by the command.)".
[Function to which AP firmware is peculiar] * The communication type :AP(Accsess point) After preserving this setting by the AP firmware, when STA firmware is started, the communication type
will be "BSS-STA (infrastructure)". * DHCP fanction :DHCP server After preserving this setting by the AP firmware, when STA firmware is started, the DHCP function will
be "invalidity".
13.1 About default value setting One copy is different in the default value of STA and the AP firmware. When returning it to the default value, please be careful.
Setting Default of STA firmware Default of AP firmware Gateway address 192.168.0.254 192.168.0.1 DNS address 192.168.0.254 192.168.0.1 DHCP fanction Disenable Server
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
164/172
14. UART Communication Specification This Chapter describes the specification for UART communication between the host and the BU1805GU.
14.1. Setting The table shown below describes UART setting specification.
Parameter Setting
Baud rate 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400, 460800, 921600
Data width 7, 8 (bits)
Parity None, Odd, Even
Stop bit 1, 2 (bits)
Flow control None, RTS/CTS
Inter-character delay time 0, 100, 200, 300 (us)
14.2. UART Flow Control BU1805GU is designed to support hardware flow control with RTS/CTS. Signal specification is compliant with the RTS/CTS flow control of UART. RTS is used to request not to send data. If data is too much to be received, the BU1805GU will set RTS to “High”. If data becomes able to be received, it will set RTS to “Low”. CTS is used to confirm the receive ready status of the counterpart. Data cannot be sent while CTS is set to “High”, and be sent when it is set to “Low”. (Using the flow control allows for enhancing the reliability of communication data, but this does not guarantee of the prevention of data loss at the UART level.)
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
165/172
15. WPS Connection Examples The function with which security information on WLAN is registered is called Registrar. The function which receives a delivery of WLAN security information is called Enrollee. It's possible to use the Enrollee function by BSS-STA mode. It's possible to use the Registrar function by the AP mode. A setting example of a WPS connection of the Enrollee function and the Registrar function is indicated.
15.1. Connection example of Enrollee
15.2. Shell Setting The following section describes the procedure for making a WPS connection using the Shell command. Only WPS stand-alone mode (that automatically saves credentials in EEPROM) can be used with shell setting. ■PBC method … Push PBC button of AP and then enter the following command.
wlan_wps set pbc Start a WPS connection using PBC method.
■PIN method … Set the PIN code to AP and then enter the following command.
wlan_pin set xxxxxxxx Enter PIN code.
wlan_wps set pin Start WPS connection using PIN method.
■Confirm a WPS connection.
wlan_wps get If “stop” is displayed, this means that WPS has been completed.
wlan_con If “Connected” is displayed, this means that the connection has been completed. (CAUTION: While in ad hoc mode, “Connected” is displayed at all times. However, by starting a WPS connection, “Disconnected” is displayed.)
■To enable WPS connection using credentials when turning ON the power supply, enter the following
command.
wlan_crdl set on Enable a WPS connection at startup.
15.3. Web setting The following section describes the procedure for making a WPS connection using the Web setting. Same as the Shell setting, only WPS stand-alone mode (that automatically saves credentials in EEPROM) can be used with Web setting. In the following description, the parameters shown in the table below (same as default) are assumed to be used for connection. The IP address of access point is assumed to be “192.168.0.254”.
Communication Type Parameter Set Value
WLAN
BSS type Ad hoc
Channel 11ch
SSID WIFI
TCP/IP IP address 192.168.0.1
Subnet mask 255.255.255.0
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
166/172
■Connection procedure (Example of PBC method) (1) Disconnect the wired LAN cable from a personal computer. (2) Enable the WLAN of the personal computer and the set IP address to “192.168.0.2”. (3) Make the WLAN setting of the personal computer to the parameters listed in the table
above. (4) Access to “192.168.0.1” using the Web browser. (5) Press the WPS push button of AP. (6) Set the “WPS Connection” parameter in the “WPS Window” in the Web browser to “PBC”,
and then press the “Apply” button. (7) Disable the WLAN of the personal computer. (8) Connect the personal computer to AP using the wired LAN cable, and then set the IP
address of the wired network to “192.168.0.2”. (9) Access to “192.168.0.1” using the Web browser. (If the access is possible and the setting
menu is displayed, this means that the WPS connection has been successfully completed.) (10) In order to enable a WPS connection using credentials for the next startup, Set the
“Credential connection on startup” parameter in the “Wireless Config Window” to “Enable”, and then press the “Apply” button. Subsequently, set the “Save" parameter in the “System Window” to “On”, and then press the “Apply” button. WLAN will be connected to AP according to the credential information even after turning OFF and ON the power supply.
(11) If Step (10) is not conducted, WLAN connection will be done based on WLAN setting without using credential after OFF and ON the power supply. Since the credential information is saved, setting the “Credential connection on startup” parameter in the “Wireless Config Window” to “Enable” and “Save” it will allow WLAN to be connected to AP after turning OFF and ON the power supply.
15.4. WID Setting The following section describes the procedure for making a WPS connection using the WID command. The WPS stand-alone mode (that automatically saves credentials in EEPROM) and the host managed mode (credentials are retained by the host) are available for selection. ■Connection procedure (Example of PIN connection using the stand-alone mode)
(1) Set the “BSS type” parameter to “Infrastructure” (WID_BSS_TYPE0).
(2) Set to WPS stand-alone mode (WID_WPS_DEV_MODE0). (3) Set PIN code (WID_WPS_PIN). (4) Put AP into a WPS ready state (Enter the PIN code to AP).
(5) Start WPS connection (WID_WPS_START1). (6) Set the “Credential connection for startup” parameter to “Enabled” when turning ON the
power supply (WID_MAINTE_CRDL1). ■Connection procedure (Example of PBC connection using the host managed mode)
(1) Set the “BSS type” parameter to “Infrastructure” (WID_BSS_TYPE0).
(2) Set to WPS host managed mode (WID_WPS_DEV_MODE1). (3) Put AP into a WPS ready state (Press the push button).
(4) Start WPS connection (WID_WPS_START2).
(5) After completion of the WPS connection (WID_WPS_START0), acquire credential (WID_WPS_CRED_LIST).
(6) Make setting of the acquired credential (WID_WPS_CRED_LIST). Note: For the next startup, conduct Steps (1), (2), and (6).
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
167/172
16. GPIO This Chapter is described on the basis that general-purpose inputs/outputs (GPIO) are connected to the buttons and LED listed in the table below.
GPIO Number Function
0 Initialization button
1 WPS Connection Start button
2 Status monitor LED
16.1. Initialization Button If the Initialization button is pressed and held for three or more seconds when turning ON the power supply in Flash ROM Boot mode, default parameters are restored and saved in EEPROM. After completion of setting initialization, initial mode (see Chapter 3) will start up. When the firmware is downloaded from UART, press the button and hold for three or more seconds after program is started by “fgo” command.
16.2. WPS Connection Start Button If the WPS Connection Start button is pressed and held for three or more seconds while in any mode other than initial mode. WPS connection will start (by PBC method). (The system will be put into infrastructure mode and the connection is terminated once.) Starting a WPS connection with this button will automatically enable IP address acquisition by using DHCP. To start a WPS connection with the “Fixed IP address”, this button and the Initialization button should be pressed together. When the connection is done by this button, “Enable” setting of the credential connection for startup parameter (WID_MAINTE_CRDL) and the selected DHCP parameter (WID_IP_DHCP) will be saved.
16.3. Status Monitor LED WLAN statuses are indicated by a LED.
LED Status Function
OFF In “Sleep” power control state (see “WID_POWER_SAVE” section)
ON Connected (always on in ad hoc mode)
Slow blink (at intervals of 1 sec.) Disconnected
Quick blink (at intervals of 100 msec.) WPS processing in progress
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
168/172
17. Communication Mode Operation Example The packet exchange of the following operation are shown.
1. Change UART setting 2. Connect to AP 3. Configure TCP server 4. TELNET connection from AP side 5. Data transmit 6. Terminate TELNET
/********************************/ IEEE802.11n 1x1 LSI BU1805 Bootloader on ROM (C) 2010 ROHM CO.,LTD. /********************************/ H/w version = 00000013 ROM version = 3.0.2 reset_latch = 00000002 mode2 Flash region1 boot +++* *0830490108003D000101 *0B4057020B00102F0400012173 *08305202080005000101 *064051030600102F *0B3052030B00102F0400012173 *084057040800120F0101 +++ * *08405705080000000100 *08305205080005000101 *15405706150000300E726F686D5F776966695F74657374 *08305206080005000101 *0F4057070F000830083132333435363738 *08305207080005000101 *0840570808000C000131 *08305208080005000101 *0640510906000000 *08305209080000000100 *0640510A06000030 *1530520A150000300E726F686D5F776966695F74657374 *0640510B06000C00 *0830520B08000C000131 *0640510C06000830 *0F30520C0F000830083132333435363738 *08304907080005000101 *1640570D1600203F0F3139322E3136382E3136342E313730
Initial message
Wait +++ and send 8 bytes of 0xF1(8bit data
only) or 0x09 to enter communication mode
Wait DEVICE READY state, then start operation
UART setting(baud rate 9600, data 7bit, odd
parity, stop bit 2, flow control on)
Read back UART setting
Issue WID_UART_RESET to reflect UART setting
change
Wait initial mode after WID_UART_RESET, and
enter communication mode again
(only 0x09 can be used because data is 7 bit)
Set to Infrastructure mode
Set SSID to rohm_wifi_test
Set PSK to 12345678
Set security to WPA2-AES(PSK)
Read back WID_BSS_TYPE
Read back WID_SSID
Read back WID_11I_MODE
Read back WID_11I_PSK
WLAN Connected
Message timing depends on the environment
(same for disconnect message)
Set IP address to
192.168.164.170
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
169/172
*0830520D080005000101 *0640510E0600203F *1630520E1600203F0F3139322E3136382E3136342E313730 *0D40570F0D00004F0400040217001D *0830520F080005000101 *064051100600004F *0D3052100D00004F0400040217001D *0D3049000D00034F04000402020008 *19100400000000000000436F6E67726174756C6174696F6E732121 *0D3049010D00034F04000402010007
Read back WID_IP_ADDR
TCP/IP server setting
(socket ID 4, Local Port 23)
Read back WID_SOC_ACCEPT
Execute TELNET 192.168.164.170 from AP side
TCP Connected
Send data
“Congraturations!!”
Terminate TELNET
TCP Disconnected
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
170/172
18. Power Management Mode Overview Overview of each power management mode are shown in the figure below. Note that these figures show idel behavior, and can be different due to the existence of transmit data or wireless condition.
High-speed power management (Normal)
High-speed power management (Max)
Beacon Interval
Access Point
・DTIM Interval=2
TIM DTIM TIM DTIM TIM DTIM TIM
DTIM Interval
Station
・Listen Interval=3
Wake-Up at
Listen Interval
Sleep State
Power
No receive data
Receive State
Power Send NULL frame
Transmit State Power
Receive data buffered
NULL frame before data receive trigger mode transition to active mode, and NULL frame after data receive cause mode transition to power management mode.
Wake-Up at Listen Interval (DTIM is ignored)!
BU1805GU is in active mode during data receive !
Data Receive
Receive State Power
+ACK Transmit Power
Wake-Up at
Listen Interval
TIM
Beacon Interval
Access Point
・DTIM Inerval=2
TIM DTIM TIM DTIM TIM DTIM
DTIM Interval
Station
・Listen Interval=3
Wake-Up at
Listen Interval
Wake-up at
DTIM Interval
Sleep State
Power
No receive data
Receive State
Power Send NULL frame
Transmit State Power
Recevei data buffered
NULL frame before data receive trigger mode transition to active mode, and NULL frame after data receive cause mode transition to power management mode.
Wake-Up at DTIM and Listen Interval !
BU1805GU is in active mode during data receive !
Data Receive
Receive State Power
+ACK Transmit Power
Wake-up at
DTIM Interval
Wake-Up at DTIM/Listen
Interval
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
171/172
PS-POLL power management (Normal)
PS-POLL power management (Max)
Beacon Inerval
隔
Access Point
・DTIM Interval=2
TIM DTIM TIM DTIM TIM DTIM TIM
DTIM Interval
Station
・Listen Interval=3
Wake-Up at
Listen Interval
Sleep State
Power
No receive data
Receive State
Power
Receive data buffered
Request data by PS-POLL frame and stay in power management mode
Wake-Up at Listen Interval(DTIM is ignored)!
BU1805GU stay in power management mode !
Send PS-POLL frame
Transmit State Power
Data Receive
Receive State Power
+ACK Transmit Power
Wake-Up at
Listen Interval
Beacon Interval
Access Point
・DTIM Interval=2
TIM DTIM TIM DTIM TIM DTIM TIM
DTIM Interval
Station
・Listen Interval=3
Wake-Up at
Listen Interval
Wake-Up at
DTIM Interval
Sleep State
Power
No receive data
Receive State
Power Send PS-POLL frame
Transmit State Power
Receive data buffered
Request data by PS-POLL frame and stay in power management mode
Wake-Up at DTIM and Listen Interval!
BU1805GU stay in power management mode !
Data Receive
Receive State Power
+ACK Transmit Power
Wake-Up at
DTIM Interval
Wake-Up at DTIM/Listen
Interval
Specification for TCP/IP Built-in WLAN
2015-06-02
PROPRIETARY AND CONFIDENTIAL
Confidential
Confidential
172/172
19. Restrictions There are some restrictions as described below.
■ When TKIP or WEP is used in IEEE802.11b/g/n BSS, BU1805GU use only IEEE802.11b/g data rate. (IEEE802.11n function and data rate are disabled).
■ It is not possible to connect to IEEE802.11n BSS with TKIP or WEP. ■ In ad hoc mode, IEEE802.11n is not supported. ■ In ad hoc mode, only WEP can be used (CCMP and TKIP can not be used) ■ In ad hoc mode, only Open System Authentication and Shared Key Authentication set by
WID_AUTH_TYPE (*1) can be selected. It is not possible to use WPA or WPA2 which is selected by WID_11I_MODE (*2).
■ Power management function is enabled only when the device is connected to AP. (*1) This can not be set by shell command and Web setting. (*2) This can be set wlan_sec shell command or Web setting, in addition to the WID command from host.