AT Command Reference and Applications User s Guide

Transcription

1 A module/product solution provider AT Command Reference and Applications User s Guide V For Ameba firmware V 1.02 SW Engineer SW Supervisor Center Supervisor Nathan Kuo Austin Huang Austin Huang ~ 1 ~

2 Table of Contents Table of Contents... 2 Manual History Introduction Architecture Module Features GPIO pins Pin Out Definition Introduction to GPIO pins UART Port for User Features Command Reference Command Syntax The format to send an AT command is as follows: The received response is show in followings Returning system and error codes Command List AT Commands for Wi-Fi Setting Introduction Client Mode AP Mode Web Server AP Mode Client Mode AT Commands for Networking ATWZ (Read MAC message): ATWD(Disconnect from a network): ATWI (Ping Test): ATWP (Power on/off): ATWS (Scan for Network): ATWR (Scan for Network): ATW? (Show network information): ASDS (Set DNS Server IP): AGDS (Get DNS Server IP): AMDS (Set and Start MDNS ): TCP Client Socket ~ 2 ~

3 Sequence to create a Socket to connect to a dedicate IP: Close Client Socket: TCP Server Socket Sequence to a Socket to accept connections: Close Server Socket: UDP Client Socket Sequence to create a Socket to connect to a dedicate IP: Close UDP Socket: UDP Server Socket Sequence to a Socket to accept connections: Close UDP Socket: TCP and UDP Socket application Introduction: Create a connection to a TCP server: Accept a connection for a TCP client: Connection to UDP server: Accept connection for UDP client: Setting up a Secure (SSL)Connection AT Commands for System Setting ASLP (Deep Sleep): AVRR (Get Version Firmware& Hardware): ARST(Reset System): ACLR(Erase AP or Clien Wi-Fi information): ABUD(Set and query baud rate of the UART in user mode): Over-the-air (OTA) Update ATWO (For firmware update) Appendix A - UART Utility Screenshot Configuration Send AT Command Transmit Data Receive Data Appendix B - Reference ~ 3 ~

4 Manual History Date Releases Features 2016/10/04 V0.1.0 Initial Release 2017/01/03 V0.1.1 Updated AT command and FW OTA function for Ameba firmware V /06/15 V0.1.2 Updated AT command and FW OTA function for Ameba firmware V Section SSL command and usage changed. 2017/07/15 V0.1.3 Updated ACLC and ACLA to ACLR command and Figure2 and 3. ~ 4 ~

5 WG6611 AT command User s Guide 1. Introduction 1.1. Architecture Jorjin Low Power Wi-Fi WG6611 Module is able to be used as a standalone system with Wi-Fi internet capability or a Wi-Fi interface connecting to an existing MCU. The architectures of these two types are shown as follows: AT AT WG6611 WG6611 MCU Command Command (1) (2) Figure 1. Architectures of (1) standalone system and (2) Wi-Fi interface with an existing MCU. The details of how to use USB-URAT dongle to connect to WG6611 Module is shown in Figure 2. By using the dongle, one can send commands WG6611 modules and receives the responses from it. Figure 2. Using USB-URAT dongle to connect to WG6611 Module. ~ 5 ~

6 WG6611 AT command User s Guide 1.2. Module Features Figure 3. Connections of a WG6611 module and an MCU. 1. IC: RTL8711AM 2. Package: QFN56 3. External flash:2m bytes 4. I/O: GPIO pin 6 Reset/Default pin 1 UART command/data mode pin 1 UART PORT 1 JTAG PORT 1 5. AT command FW with UART baud rate default is ~ 6 ~

7 1.3. GPIO pins WG6611 AT command User s Guide Pin Out Definition The definitions of the GPIO pins of Jorjin WG6611 WiFi modules are listed in the following tables. Figure 4. Map for Jorjin WG6611 Module. ~ 7 ~

8 WG6611 AT command User s Guide PIN name PIN defined State Note GPIOA_3 UART_RTS Input PH GPIOA_5 UART_CTS Output PH GPIOA_6 UART_RX Input PH User UART GPIOA_7 UART_TX Output HI GPIOB_0 LOG_TX Output HI GPIOB_1 LOG_RX Input PH Debug UART GPIOB_2 IO Output PL GPIOB_3 IO Output PL GPIOC_0 IO Output PL GPIOC_1 IO Output PL GPIO GPIOC_2 IO Output PL GPIOC_3 IO Output PL GPIOC_4 GPIO INT Input PH GPIO GPIOC_5 GPIO INT Input PL GPIO GPIOE_0 JTAG_TRST Input PH GPIOE_1 JTAG_TDI Input PH GPIOE_2 JTAG_TDO Output PH JTAG GPIOE_3 JTAG_TMS/SWDIO Input PH GPIOE_4 JTAG_CLK/SWCLK Input PH Note : PH = Pull-High, PL=Pull-Low, HI = High-impedance Table 1. GPIO pin definition of Jorjin WG6611 Module Introduction to GPIO pins In the following, the GPIO pins with specified will introduced. Please refer [1] to see the details of those are not addressed GPIOC_4: GPIOC_4 can be used to reset the system and to clean the Wi-Fi setting (AP and Client Mode) by pulling GPIOC_4 from high to low keep over 100 ms to reset system. When pulling GPIOC_4 from high to low and keep over 5 seconds, the system will clean Wi-Fi setting. Notice that, only the Wi-Fi setting of the current Wi-Fi mode will be cleaned and the Wi-Fi mode will not change by the reset action GPIOC_5: GPIOC_5 is used for User UART Port. When it is pulled Hi, the port will be in Command Mode, in which AT Commands can be used. On the contrary, the port will be in Transparent Mode. ~ 8 ~

9 1.4. UART Port for User WG6611 AT command User s Guide Features UART port can be used to send AT commands or transfer data based on the pull-up/down of GPIOC_5(pull-up for Command Mode and pull-down for Transparent Mode, respectively). An AT command is only sent in the Command Mode and composed of ASCII Code. The interval between two characters of a command is 1ms and the interval between two AT Commands is 10ms. As for Transparent Mode, only the data is forwarded. For instance, when a TCP connection is constructed, a user can use UART port to send/receive the data to/from the peer via Wi-Fi, as indicated in Figure 5. The setting of the UART port is listed as follows: Default baud rate: 9600bps. 1. UART TX Pin = GPIOA_7 2. UARTRX Pin = GPIOA_6. Notice that when the data size is over 1.4 KB or no data is received during 50us, all data in buff will be sent out directly. Figure 5. Transparent Transmission via UART port. ~ 9 ~

10 WG6611 AT command User s Guide 2. Command Reference 2.1. Command Syntax The format to send an AT command is as follows: ATW0=SSID \r \n Data to send out: 0x41,0x54,0x57,0x30,0x3D,0x53,0x53,0x49,0x44,0x0D,0x0A The received response is show in followings Command send success OK\r \n Data to send out: 0x4F,0x4B,0x0D,0x0A Command send success and return messages OK:-70\r \n Data to send out: 0x4F,0x4B, 0x3A, 0x2D,0x37, 0x31,0x0D,0x0A Command send fail and return error messages ERR:0\r \n Data to send out: 0x45,0x52,0x52,0x3A,0x30,0x0D,0x0A ~ 10 ~

11 2.2. Returning system and error codes WG6611 AT command User s Guide Responding Status Code ASCII System Code 0 WIFI status disconnect 1 WIFI status connect 2 WIFI connect fail* 3 WIFI connect timeout* 4 AP mode start 5 AP mode stop 6 web mode start 7 web mode stop 8 WIFI auto connect* 9 socket open* 10 socket close* 11 OTA success 12 OTA fail ASCII Error Code 0 error parameter 1 error format 2 SSID empty 3 IP and port empty 4 WIFI start fail 5 AP start fail 6 WIFI connect fail 7 WIFI disconnect fail 8 WIFI scan fail 9 Ping timeout 10 socket initial fail 11 socket not exist 12 DNS timeout 13 Show network information fail 14 MDNS Initial Failed 15 Unknown Host ~ 11 ~

12 Note: message can show on data mode if marked as* Command List Wi-Fi Setting Commands Client Mode ATW0 Network Set SSID ATW1 Network Set Passphrase ATW2 Network Set Key ID ATWC Join a Network AP Mode ATW3 Set Access Point SSID ATW4 Set Access Point Security Key ATW5 Set Access Point Channel ATWA Activate Access Point ATWE Start Web Server Network Setting and Connecting Commands TCP & UDP Socket ATCP Set IP and Port to Start/Stop TCP Server or Client Mode AUDP Set IP and Port to Start/Stop UDP Server or Client Mode SSL Client ATCP Set IP and Port to connect SSL Server Network ATWZ MAC Address Read and Write ATWD Disconnect From a Network ATWI Ping Test ATWS Scan for Network Access Point ATWR Get RSSI of Associated Network Access Point ATW? Show Network Information ASDS Set DNS Server IP address AGDS Get DNS Server IP address AMDS Set Name and service to start MDNS System Commands ATWP Power On/Off Wi-Fi Module ASLP Deep Sleep AVRR Read Version Firmware & Hardware ARST Reset System WG6611 AT command User s Guide ~ 12 ~

13 ACLR ABUD ATWO Erase AP or Client Wi-Fi Information Set and query baud rate of the UART in user mode Over-the-air (OTA) Update WG6611 AT command User s Guide 3. AT Commands for Wi-Fi Setting 3.1. Introduction Jorjin WG6611 module has two modes, including AP mode and Client Mode. A device with WG6611 module in AP mode can be connected by the other devices WG6611 modules. Notice that, when in AP mode, the device is unable to connect to internet. Normally, AP mode is used by user to setup the device with WG6611 module so that the device can connect to an existing AP. The scenario of a WG6611 device in AP mode is shown in Figure 6. Figure 6. Scenario for WG6611 Module in AP Mode. WG6611 device in client mode can connect to an existing AP with Internet capability so that the device can send data to the Internet, as shown in Figure 7. ~ 13 ~

14 WG6611 AT command User s Guide Figure 7. Scenario for 8711AM Module in Client Mode Client Mode When trying to connect to an existing AP, you have to set the SSID and the passphrase of the AP first and then use command ATWC to connect to the AP. When connect to the existing AP, WG6611 module will receive a DHCP IP automatically. The commands are listed as follows: ATW0=SSID<CR> ATW1=passphrase<CR> ATW2=key id (key id range is 0~3, only needed for WEP mode) ATWC<CR> ATW0=JORJIN ATW1= ATWC The received response messages are as follows: Example (WEP mode): ATW0=JORJIN ATW1= ATW2=1 ATWC ~ 14 ~

15 The received response messages are as follows: WG6611 AT command User s Guide 3.3. AP Mode When acting as an AP, you have to set the SSID, passphrase, and the channel to use. Finally, use command ATWA to activate the setting. Users can connect to the AP by using the setting SSID and passphrase. ATW3=SSID(SSID length can't exceed 30 byte) ATW4=passphrase (passphrase length can't exceed 60 byte) ATW5=Channel (Channel range is 0~11) ATWA<CR> Example : ATW3=JORJIN ATW4= ATW5=5 ATWA If trying to set up the AP, you need to start the web server by using command ATWE after finishing the above setting. ATWE<CR> ATWE ~ 15 ~

16 3.4. Web Server WG6611 AT command User s Guide Web server of WG6611 Module works only on AP mode. After associating with the AP, as shown in Figure 88, and get right IP address, a client can open web browser and visit the web site by entering in the browser to get/set AP and Client settings. Figure 8. Connect to Ameba WG6611 WiFi Module AP Mode In the interface of SoftAP configuration, you can modify the SSID, Security Type, AP Password and Channel of the module. After submitting, the module will reboot to adapt the setting. Figure 9. Interface to setup Ameba 8711AM module for AP mode. Figure 10. Response after pressing submit button in AP mode ~ 16 ~

17 WG6611 AT command User s Guide Client Mode In the interface of SoftAP configuration, you can modify the STA SSID, and STA Password of upper tier AP that the module tries to connect. After submitting, the module will reboot to adapt the setting. Figure 11. Interface to setup Ameba 8711AM module Client mode. Figure 12. Response after pressing submit button in Client Mode. ~ 17 ~

18 WG6611 AT command User s Guide 4. AT Commands for Networking 4.1. ATWZ (Read MAC message): ATWZ=read_mac 4.2. ATWD(Disconnect from a network): ATWD 4.3. ATWI (Ping Test): ATWI=IP address[y] Comment: y = number of ECHO REQUEST packets. Ping an unused IP, e.g., ATWI= [5]. Message (Ping Success): Message (Ping fail): ~ 18 ~

19 WG6611 AT command User s Guide 4.4. ATWP (Power on/off): ATWP=1 Comment: 1 for Power on ATWP=1 ATWP=0 Comment: 0 for Power off ATWP= ATWS (Scan for Network): ATWS ATWS ATWS:SSID,MAC, SECURITY (report format) ~ 19 ~

20 WG6611 AT command User s Guide Table 2: Wi-Fi security algorithms mapping table ATWR (Scan for Network): ATWR ATWR 4.7. ATW? (Show network information): ATW? ATW? CODE:MODE,SSID,CHANNEL,SECURITY,PASSWORD,MAC,IP,GW,DNS Note: CL=client mode, AP= AP Mode, UN : unknow ~ 20 ~

21 4.8. ASDS (Set DNS Server IP): ASDS=n,IP Comment: n = Choose DNS server(1 or 2). IP = DNS server IP. ASDS=1, WG6611 AT command User s Guide ASDS=2, AGDS (Get DNS Server IP): AGDS=n Comment: n = Choose DNS server(1 or 2). AGDS=1 AGDS= AMDS (Set and Start MDNS ): ~ 21 ~

22 AMDS=name,services ; services=_ services._tcp Comment: n = Choose DNS server(1 or 2). AGDS=user_name,_http._tcp WG6611 AT command User s Guide TCP Client Socket Sequence to create a Socket to connect to a dedicate IP: ATCP=c,<IP>:<port><CR> /c:client; IP=IP or Domain Name; port=port Number/ ATCP=l,<IP><CR> /l:ssl Link; IP=IP or Domainame/ ATCP=c, :5001 AHML=GET / ATCP=c, ~ 22 ~

23 WG6611 AT command User s Guide Close Client Socket: ATCP=close<CR> /close:close TCP Socket/ TCP Server Socket Sequence to a Socket to accept connections: ATCP=s:<port><CR> /s:server; port=port Number/ ATCP=s: Close Server Socket: ATCP=close ~ 23 ~

24 WG6611 AT command User s Guide UDP Client Socket Sequence to create a Socket to connect to a dedicate IP: AUDP=c,<IP>:<port><CR> /c:client; IP=IP or Domain Name; port=port Number/ AUDP=c, : Close UDP Socket: AUDP=close AUDP=close UDP Server Socket Sequence to a Socket to accept connections: AUDP=s:<port><CR> /s:server; port=port Number/ ~ 24 ~

25 AUDP=s:5001 WG6611 AT command User s Guide Close UDP Socket: AUDP=close<CR> /close:close UDP Socket/ AUDP=close TCP and UDP Socket application Introduction: GPIOA_6 GPIOA_7 GPIOC_5 UART_RX UART_TX Command_Mode MCU Command_Mode(GPIOC_5) Hight Level Low Level Command Data Figure 13. Hardware setting of the application scenario Create a connection to a TCP server: Step 1. Switch user UART (reference GPIO pin definition) to Command mode (GPIOC_5 Hi level). Step 2. Connection TCP server (refer to 4.11). ~ 25 ~

26 WG6611 AT command User s Guide Step 3. Switch user UART to Data mode (GPIOC_5 Low level). Step 4. Start to transfer data transfer by using any networking tool. Figure 14. TCP/UDP tools to receive TCP packets from a 8711AM module Accept a connection for a TCP client: Step 1. Switch user UART (reference GPIO pin definition) to command mode(gpioc_5 Hi level). Step 2. Create a TCP socket with a given port to accept TCP connections (refer to 4.12). Step 3. Switch user UART to data mode (GPIOC_5 Low level). Step 4. Start to transfer data. ~ 26 ~

27 WG6611 AT command User s Guide Figure 15. TCP/UDP tools to send TCP packets to a 8711AM module Connection to UDP server: Step 1. Switch user UART (reference GPIO pin definition) to command mode(gpioc_5 Hi level). Step 2. Give the IP and PORT, then connect to a UDP server(refer to 4.13). Step 3. Switch user UART to data mode (GPIOC_5 Low level). Step 4. Start to Transfer data. ~ 27 ~

28 WG6611 AT command User s Guide Figure 16. UDP tools to receive UDP packets from a 8711AM module Accept connection for UDP client: Step 1. Switch user UART (reference GPIO pin definition) to command mode(gpioc_5 Hi level). Step 2. Start an UDP socket and wait for connections (Refer to 4.14). Step 3. Switch user UART to data mode (GPIOC_5 Low level). Step 4. Use UART to transfer data. ~ 28 ~

29 WG6611 AT command User s Guide Figure 17. UDP tools to send UDP packets to a 8711AM module Setting up a Secure (SSL)Connection ATCP = l,host NAME Comment: 1. Connect to a SSL server. 2. l is L lower case. 3. Use Uartutility tool v4.0. ATCP=I, Switch to Data Mode GET / HTTP/1.1 then click Enter twice. Then press button Send block ~ 29 ~

30 5. AT Commands for System Setting 5.1. ASLP (Deep Sleep): WG6611 AT command User s Guide ASLP=sec Comment: sec is seconds for the module to be in the deep sleep mode. It can be set form 0 to 3600.sec=0 indicates that the module will be in the deep sleep mode forever and only CHIP_EN pin can be used to wake up the system. ASLP=0 ASLP= AVRR (Get Version Firmware& Hardware): AVRR = [F, H] Comment: F:Firmwareversion, H: Hardware version. AVRR =F AVRR:SDK + firmware Version(report format) AVRR =H ~ 30 ~

31 WG6611 AT command User s Guide *No version information is set in the system ARST(Reset System): ARST ARST 5.4. ACLR(Erase AP or Clien Wi-Fi information): ACLR=[AP, CL] ACLR=AP ACLR=CL Erase AP connection Erase Client connection 5.5. ABUD(Set and query baud rate of the UART in user mode): Set baud rate of the UART in user mode. ABUD=baud rate(9600 bps ~ bps) Comment: Default baud rate is 9600 bps. ABUD= ~ 31 ~

32 Query the current baud rate of the UART in user mode. WG6611 AT command User s Guide ABUD=? ABUD=? ~ 32 ~

33 WG6611 AT command User s Guide 6. Over-the-air (OTA) Update 6.1. ATWO (For firmware update) 1. Put the firmware image file in the folder where the Download Server locates. 2. Edit batch file start.bat to indicate the port and the firmware image file. For the example in the following figure, the port is set to 8082 and the image file is ota.bin, as show in the following figure. Figure 18. Files used for OTA update. Figure 19. The modification of start.bat for OTA update. 3. After executing start.bat, a server is up and waiting for client s request. Figure 20. OTA server waiting for client s request 4. Connect to AP and make sure that the Ameba module and the computer that have the OTA server connect to the same AP 5. Enter command to perform OTA update: ATWO=IP[PORT]. ~ 33 ~

34 WG6611 AT command User s Guide 6. Starting update.after finishing downloading image, device will be auto-rebooted and the boot loader will load new image if it exist. If the update finishes, you can see the progress in OTA server side, as shown in Figure 21. The result of the OTA update will be indicated in the UART console, as indicated in UART log: Update success: Figure 21. OTA update progress shown in OTA server side. Update fail: ~ 34 ~

35 7. Appendix A - UART Utility WG6611 AT command User s Guide 7.1. Screenshot 7.2. Configuration User has to ensure the port number and baud rate in area 1 are correct for the COM port, before clicking Connect button. RTS status shows the state of MODE pin Send AT Command User can send AT command in area 2. Please be noted that the line feed is needed for each command for this application, therefore, please tick Add Line Feed The. utility will automatically changes the state of MODE pin, when clicking Send CMD button. ~ 35 ~

36 7.4. Transmit Data WG6611 AT command User s Guide The data, e.g. HTTP command, could be sent in area 3. If the same data needs to be transmitted periodically, user can tick Auto option of Active Type and set the time interval Receive Data The command response, system information and control signal etc. will be shown in area 4. Hex code is displayed in the left hand side, whereas the ASCII is shown in the right hand side. 8. Appendix B - Reference [1] AT Command Application Note, Realtek, August 25, ~ 36 ~