RAK RAK477 Instruction Manual

RAK RAK477 Instruction Manual

Uart wifi module
Table of Contents

Advertisement

Quick Links

RAK477 UART WiFi Module
Instruction Manual V1.2
Shenzhen Rakwireless Technology Co., Ltd.
www.rakwireless.com
info@rakwireless.com
© RAK copyright. All rights reserved.
Companies and product names referred in
the instruction belong to trademarks of
their respective owners.
Any part of this document may not be
reproduced, and may not be stored in any
retrieval system, or delivered without RAK's
written permission.
The document will be updated without
prior notice.
Copyright © Shenzhen Rakwireless Technology Co., Ltd
1
RAK477 Instruction Manual
ETDX1602241830

Advertisement

Table of Contents
loading

Summary of Contents for RAK RAK477

  • Page 1 RAK477 UART WiFi Module Instruction Manual V1.2 Shenzhen Rakwireless Technology Co., Ltd. www.rakwireless.com info@rakwireless.com © RAK copyright. All rights reserved. Companies and product names referred in the instruction belong to trademarks of their respective owners. Any part of this document may not be...
  • Page 2: Table Of Contents

    RAK477 Instruction Manual Content 1. Rapid usage............................ 4 1.1 Introduction to the development board................4 1.2 The method for the module to reset to Factory Defaults..........5 1.3 Inspection prior to powering on..................6 1.4 The status after powering on....................6 1.5 Transparent transmission data test..................
  • Page 3 RAK477 Instruction Manual 4.9 Information storage commands for the user networking list.........53 4.9.1 Read the number of current list................53 4.9.2 Read the networking information in the indicated lists........54 4.9.3 Write the networking information to the indicated lists........55 4.9.4 Delete the networking information in the indicated lists........56 4.10 Upgrading of serial port firm ware................57...
  • Page 4: Rapid Usage

    1. Rapid usage 1.1 Introduction to the development board RAK477 serial port transparent transmission module focuses on transparent transmission supported by AT Command; it has the advantages of simple operation and rich functions and can meet the requirements of various kinds of customers.
  • Page 5: The Method For The Module To Reset To Factory Defaults

    RAK477 Instruction Manual Connecting to the network Flash interval of 1 second Getting IP Flash interval of 2 seconds The network is connected Normally on Socket event Flash for three times AP is not established Normally off AP is established, and not...
  • Page 6: Inspection Prior To Powering On

    RAK477 Instruction Manual 1.3 Inspection prior to powering on The evaluation suits mainly include: antenna of Micro USB line, development board, IPEX connector interface. If the module is external antenna module, please plug in the antenna. Connect the module’s serial port and computer’s serial port (the USB to serial port of the computer).
  • Page 7: Transparent Transmission Data Test

    RAK477 Instruction Manual wait for well distributed IP address. 2.Through the mobile phone APP set the module serial port and socket parameters. 1.5 Transparent transmission data test Open the serial port tools, select the COM port connected to the module. The default baud rate is 115200, data bit is 8, stop bit is 1, with no parity, no flow control.
  • Page 8 RAK477 Instruction Manual Figure 1-6: Factory Defaults mode transparent transmission test Copyright © Shenzhen Rakwireless Technology Co., Ltd ETDX1602241830...
  • Page 9: Function Features

    2. Function features 2.1 Overview RAK477 module is a Wi-Fi module that fully compliant with IEEE 802.11b/g/n wireless standards, It combines an ARM-CM3 MCU, WLAN MAC, a 1T1R capable WLAN baseband, and RF in the module. It have onboard antenna, and external antenna interface, RF output PIN also exist in the board.
  • Page 10: Product Features

    RAK477 Instruction Manual Household security and automation  Medical field, for example, patients monitoring, medical diagnosis  Measurement (parking meter, metering instrument, ammeter and the like)  2.3 Product features Application  Support at commands and transparent transmission mode ...
  • Page 11 RAK477 Instruction Manual Low latency immediate High-Throughput Block Acknowledgement (HT-BA)  Long NAV for media reservation with CF-End for NAV release  PHY-level spoofing to enhance legacy compatibility  Power saving mechanism   WLAN PHY Feature 802.11n OFDM ...
  • Page 12: Instruction Encyclopedia

    (Can write once) In order to transfer from the delivery mode to the user mode easily, RAK477 transparent transmission module provides two kinds of flexible configuration methods to connect to the user’s router:...
  • Page 13: Ap Configuration

    RAK477 Instruction Manual 3.2 AP configuration When the module is delivered, the default configuration is AP configuration with “status” light always on and “link” light slowly flashing. The mobile phone is connected to the hot point of RAK477_AP_XXXXXX with “link”...
  • Page 14 RAK477 Instruction Manual Confirm that the mobile phone has been connected to the module hot spot, and then click NEXT: Select the router to connect, input the password, click Connect, and the module will automatically save after receiving SSID and password.
  • Page 15: Easyconfig Configuration

    First, the mobile phone is connected to the router which is to be connected by the module. RAK477 Use the mobile phone to open RAK47XConfigure software, and select the module type of RAK477. Copyright © Shenzhen Rakwireless Technology Co., Ltd...
  • Page 16 RAK477 Instruction Manual Enter into the Config option, and select SimpleConfig configuration: SSID is automatically filled in, input PSK Press the development pad’s “default” key, the “link” light begins to slowly flash Click Connect to start configuration. Copyright © Shenzhen Rakwireless Technology Co., Ltd...
  • Page 17: Upgrading

    RAK477 Instruction Manual Return to the module’s “mac” address after successful configuration: 3.4 Upgrading The module supports upgrading under the AP, STA and AP+STA mode. The following mainly introduces the upgrading of the module under STA mode. Copyright © Shenzhen Rakwireless Technology Co., Ltd...
  • Page 18 Select OTA option, click “CetInfo” to obtain the module's “mac” and “ip” address and other information; Click the module information area, and enter into the upgrading interface. The module’s upgrading firm ware is saved under the RAK47X\RAK477 folder of mobile phone,...
  • Page 19: Usage Of Scanning Configuration Tools

    RAK477 Instruction Manual After the completion of firm wares’ upgrading, wait for 30 seconds (the module loads the firm ware and connects the router again) 3.5 Usage of scanning configuration tools Mobile phone APP——RAK47XScanConfig When the module works under AP mode, using the tool can scan the module after the mobile adds the module AP;...
  • Page 20 RAK477 Instruction Manual module; When the module works under AP+STA mode, the mobile phone is added to module AP or to the router connected to the module, the tool can scan the module. Next, we will mainly introduce the usage of the module under STA mode.
  • Page 21 RAK477 Instruction Manual Mode configuration interface  The item mainly sets the mode and power consumption of the module, involving three modes, namely, AP, STA and AP+STA mode. The power consumption mode includes: full power consumption and automatic saving power consumption. After modifying the configuration, click “Save”...
  • Page 22 RAK477 Instruction Manual Set the parameters of STA  Set basic parameters of STA mode. Clicking “Search” button can search out the nearby available wireless network. After modifying the configuration, click “Save” button, as shown below: The parameters setting of the serial port ...
  • Page 23 RAK477 Instruction Manual Set the “socket” parameters  Set basic parameters of “socket”, supporting single socket and double socket. After modifying the configuration, click “Save” button, as shown below: Copyright © Shenzhen Rakwireless Technology Co., Ltd ETDX1602241830...
  • Page 24 RAK477 Instruction Manual Advanced settings  Advance settings include: modifying the module’s user name and password (namely, authentication information), modifying the module’s name and group name, resetting the module and recover the ex-factory settings. Click “Reset” button, then all the configured parameters will be effective. As shown below: Copyright ©...
  • Page 25: Aided At Commands

    RAK477 Instruction Manual 4. Aided AT commands 4.1 Basic flow chart Module’s work status gives priority to direct transparent transmission mode, but also provides an auxiliary command mode in order to manage and query the parameters for the module. Module interpret based on the MODE pin level, (high level by default) and enter into the transparent transmission mode.
  • Page 26: At Command Set

    RAK477 Instruction Manual 4.2 AT command set Table 4-1 AT command set AT command Description Module management instruction at+ascii=<mode>\r\n Open ASCII display at+mac\r\n Query the module’s MAC address Enter into transparent at+easy_txrx\r\n transmission mode at+version\r\n Query the software version at+reset \r\n...
  • Page 27: Command Format

    RAK477 Instruction Manual at+tcp_status=0\r\n Query the connection status of TCP Query the connected network at+net_info\r\n information Instruction for receiving and sending data at+send_data=0,dest_port,dest_ip,datalen,datab Send data from Socket uffer\r\n at+recv_data=0,dest_port,dest_ip,datalen,datab Receive data from Socket uffer\r\n Information storage commands for the user networking list...
  • Page 28: Enter Into Aided Commands

    RAK477 Instruction Manual OK\r\n HEX=4F 4B 0D 0A-------------------------------- No parameter OK@\r\n HEX=4F 4B 64 0D 0A---------------------------- parameter =0x64 If the command is unsuccessfully carried out, then the returned values shall be: ERROR<code> Note: Wherein, ERROR is ASCII code, <code> is hexadecimal system code ...
  • Page 29: Module Management Instruction

    RAK477 Instruction Manual Timing for 200ms, wait for the module to return “U”(0x55) , if the module did not return in the specified time, then the timing of 200ms will again send “+++”, and requests to enter the command mode until the module successfully return “U”(0x55) .It shows that the module is ready to enter into...
  • Page 30: Query The Module's Mac Address

    RAK477 Instruction Manual debug and be familiar with the AT command. There is no need to open while programming. Parameter instruction Parameter Parameter value Instruction Prohibit conversion <mode> Open conversion Instruction for returned value Parameter Format Length (byte) Instruction The command is successfully carried out...
  • Page 31: Enter Into The Transparent Transmission Mode

    RAK477 Instruction Manual Instruction for returned value Parameter Format Length (byte) Instruction The command is successfully carried out ASCII MAC address \r\n ASCII End character The command is unsuccessfully carried out ERROR ASCII ERROR <CODE> For details see ERROR list...
  • Page 32: Query The Software Version

    RAK477 Instruction Manual The command is successfully carried out ASCII \r\n ASCII End character The command is unsuccessfully carried out ERROR ASCII ERROR <CODE> For details see ERROR list \r\n ASCII End character Remarks Query the software version 4.5.4 Command...
  • Page 33: Reset To Restart The Module

    RAK477 Instruction Manual STRING Character string \r\n ASCII End character The command is unsuccessfully carried out ERROR ASCII ERROR <CODE> For details see ERROR list \r\n ASCII End character Remarks Reset to restart the module 4.5.5 Command at+reset \r\n Description...
  • Page 34: Reset To Factory Defaults

    RAK477 Instruction Manual <CODE> For details see ERROR list \r\n ASCII End character Remarks Reset to Factory Defaults 4.5.6 Command at+restore\r\n Description Recover the module parameters to the Factory Defaults parameters Parameter instruction NULL Instruction for returned value Parameter Format...
  • Page 35: Parameter Configuration Instruction

    RAK477 Instruction Manual 4.6 Parameter configuration instruction For the keywords and its parameters of the following configuration, please see the appendix - configuration parameters encyclopedia". Write user configuration 4.6.1 Command at+write_config=<data_length> ,<data_stream>\r\n Description Write the user configuration parameters with one step, the user send all the configuration parameters to the module at one-time.
  • Page 36: Read The User Configuration

    RAK477 Instruction Manual The command is successfully carried out ASCII The reset is successful \r\n ASCII End character The command is unsuccessfully carried out ERROR ASCII ERROR <CODE> For details see ERROR list \r\n ASCII End character Remarks Read the user configuration 4.6.2...
  • Page 37: Reproduce The User Configuration

    RAK477 Instruction Manual Parameter Format Length(byte) Instruction The command is successfully carried out ASCII STRING Character string \r\n ASCII End character The command is unsuccessfully carried out ERROR ASCII ERROR <CODE> For details see ERROR list \r\n ASCII End character...
  • Page 38: Read Factory Defaults

    RAK477 Instruction Manual The command is unsuccessfully carried out ERROR ASCII ERROR <CODE> For details see ERROR list \r\n ASCII End character Remarks Read Factory Defaults 4.6.4 Command at+read_restoreconfig\r\n Descripion Read Factory Defaults parameters configuration of the module, returning structure is the same with reading user's configuration.
  • Page 39: Read Factory Defaults

    RAK477 Instruction Manual \r\n ASCII End character Remarks Read Factory Defaults 4.6.5 Command at+write_restoreconfig=<data_length>,<data_stream>\r\n Description Read Factory Defaults parameters configuration of the module, returning structure is the same with reading user's configuration. Parameter instruction Parameter Parameter value Instruction Written length of written configuration <data_length>...
  • Page 40: Ap Sta Operating Instruction

    RAK477 Instruction Manual \r\n ASCII End character Remarks 4.7 AP STA operating instruction Query the connection status of STA 4.7.1 Command at+con_status\r\n Description If the module works under the STA mode, the command will be used for the wireless network connection status of the module.
  • Page 41: Query The Connection Status Of Ap

    RAK477 Instruction Manual \r\n ASCII End character Remarks Query the connection status of AP 4.7.2 Command at+ap_status\r\n Description If the module works under the AP mode , the command will be used for determining the connection status of the equipment.
  • Page 42: The Wireless Signal Intensity Of Sta

    RAK477 Instruction Manual Remarks The wireless signal intensity of STA 4.7.3 Command at+rssi\r\n Description Querying the wireless network intensity under STA mode will be effective. Parameter instruction NULL Instruction for returned value Length(byte Parameter Format Instruction The command is successfully carried out...
  • Page 43: Scan The Wireless Network

    RAK477 Instruction Manual under AP mode. \r\n ASCII End character Remarks Scan the wireless network 4.7.4 Command at+scan=<channel>,<ssid>\r\n Description Scan the wireless network through this command, and access the wireless information, including encryption information, channel, signal strength, BSSID, etc. Parameter instruction The scan command includes two parameters, wherein <channel>...
  • Page 44 RAK477 Instruction Manual at+scan=0,RAKwireless\r\n------------- Scan the wireless network with the network name of “RAKwireless” in all the channels. at+scan=8,RAKwireless\r\n------------- Scan the wireless network with the network name of “RAKwireless” in channel 8. at+scan=6 \r\n------------------------ Scan all the SSID in channel 6.
  • Page 45: Get The Wireless Network

    RAK477 Instruction Manual Remark Get the wireless network 4.7.5 Command at+get_scan=<scan_num>\r\n Description Read the scanned information from the command, this command must be called after the at+scan scan wireless network command. Note: If the wireless network information is not required, the command can be omitted.
  • Page 46 RAK477 Instruction Manual Instruction for returned value Forma Length(b Parameter Instruction yte) The command is successfully carried out ASCII Get the information correctly <SSID> SSID <BSSID> BSSID <CHANNEL Channel > <RSSI> signal intensity (negative value) encryption method <Security Mode> 802.1...
  • Page 47: Easyconfig Networking

    RAK477 Instruction Manual EasyConfig networking 4.7.6 Command at+easy_config\r\n Description Send the command, the module enters into an instant configuration mode, waiting for the phone to send configuration information. Customers can query whether the network is connected or not through querying network status command.
  • Page 48 RAK477 Instruction Manual at+ipconfig\r\n Description Query the current module’s MAC address information, IP address, subnet mask, gateway, DNS server, etc., if the DHCP is not assigned while setting; check out the module address of 127.0.0.1. Parameter instruction NULL Instruction for returned value...
  • Page 49: Query The Connected Network Information

    RAK477 Instruction Manual Remark Query the connected network information 4.7.8 Command at+net_info\r\n Description Read the current network parameters, all the network parameters will be read at one time and returned back to the corresponding structure. Example OKwlan_mode=2&sta_ssid=RAK_2.4GHz&sta_bssid=8C:21:0A:D9:EB:7B&sta_se c_mode=1&sta_psk=rakwireless205&sta_dhcp=1&sta_ip=192.168.1.119&sta_netm ask=255.255.255.0&sta_gateway=192.168.1.1&sta_dns1=192.168.1.1&sta_dns2=0.0. 0.0ap_ssid=RAK477_AP_38A55D&ap_channel=9&ap_sec_mode=0&ap_psk=123456 789&ap_max_clts=0&ap_bdcast=1&ap_ip=192.168.7.1...
  • Page 50: Instruction For Receiving And Sending The Data

    RAK477 Instruction Manual <CODE> For details see ERROR list \r\n ASCII End character Remark 4.8 Instruction for receiving and sending the data Send data 4.8.1 Command at+send_data=<uuid>,<dest_port>,<dest_ip>,<data_length> ,<data_stream>\r\n Description Send data to the target connection (port identifier) through the command, with the maximum data length of 1024, wherein <data_stream>...
  • Page 51: Receive Data

    RAK477 Instruction Manual For example: at+send_data=0,0,0,4,ABCD\ r\n----------- send 4bytes data to the connection with the identifier of 0, the data content is “ABCD”. Instruction for returned value Length(b Parameter Format Instruction yte) The command is successfully carried out ASCII The data was sent successfully...
  • Page 52 RAK477 Instruction Manual Description Receives the UUID data of the corresponding Socket (A, B), when the ASCII display is disabled, receive 16 Decimal system data. The sequence is the same. Suggest using ASCII to display disable mode when programming. If socket is set to the UDP type, the UDP receives a packet of less than 1024B per packet.
  • Page 53: Information Storage Commands For The User Networking List

    RAK477 Instruction Manual The command is unsuccessfully carried out <CMD> ASCII Command header <CODE> For details see ERROR list \r\n ASCII End character Remark Information storage commands for the user networking list Read the number of current list 4.9.1 Command...
  • Page 54: Read The Networking Information In The Indicated Lists

    RAK477 Instruction Manual ERROR ASCII ERROR <CODE> For details see ERROR list \r\n ASCII End character Remark Read the networking information in the indicated lists 4.9.2 Command at+read_userlist=<index>\r\n Description Read the networking information in the current list Parameter instruction Parameter...
  • Page 55: Write The Networking Information To The Indicated Lists

    RAK477 Instruction Manual STRING Character string \r\n ASCII End character Information read failed <CMD> ASCII Command header <CODE> 0XFE=-2 Invalid storage information \r\n ASCII End character Remark Write the networking information to the indicated lists 4.9.3 Command at+write_userlist=<index>,<len>,<data>\r\n Description Write the networking information to the indicated lists...
  • Page 56: Delete The Networking Information In The Indicated Lists

    RAK477 Instruction Manual eless205&sta_bssid=8C:21:0A:D9:EB:7B\r\n Instruction for returned value Parameter Format Length(byte) Instruction The command is successfully carried out ASCII \r\n ASCII End character The command is unsuccessfully carried out ERROR ASCII ERROR <CODE> For details see ERROR list \r\n ASCII...
  • Page 57: Upgrading Of Serial Port Firm Ware

    RAK477 Instruction Manual Instruction for returned value Parameter Forma Length(byte) Instruction The command is successfully carried out ASCII /r/n ASCII End character The command is unsuccessfully carried out ERROR ASCII ERROR <CODE> 0XFE=-2 Invalid stored information \r\n ASCII End character Remark 4.10 Upgrading of serial port firm ware...
  • Page 58 RAK477 Instruction Manual step 1. Until the module return “OKC”, utilize xmodem protocol to send firm ware to the module. If the module did not return "OKC", returned to carry out step 1 to 3 Parameter instruction NULL Instruction for returned value...
  • Page 59: Appendix-Configuration Parameter Encyclopedia

    RAK477 Instruction Manual 5. Appendix-configuration parameter encyclopedia Table 5-1 Configuration parameter table Keywords Parameter Remarks Mode selection 0: STA mode wlan_mode 1: AP mode 2: Coexistence AP and STA mode AP mode parameter SSID name is ap_ssid RAK477_AP_SSID less than...
  • Page 60 RAK477 Instruction Manual sta_ip 192.168.1.100 sta_netmask 255.255.255.0 sta_gateway 192.168.1.1 sta_dns1 192.68.1.1 sta_dns2 0.0.0.0 UART communication parameter 9600,19200,38400,57600,115200,230400,460800,9 uart_baudrate 21600 uart_datalen (5-8) 0: No uart_parity_en 1: Odd parity check 3: Even parity check uart_stoplen (1-2) 0: disable uart_rtscts_en 1: enable Timeout time...
  • Page 61 RAK477 Instruction Manual 0: Disabled WEB configuration web_func_en unused 1: Enable WEB configuration Mdns 0: Local discovery is disabled function local_find_en 1: Local discovery is enabled opened default When user configured from Factory Defaults parameter to user parameter, 0: disable...
  • Page 62 RAK477 Instruction Manual parameter Socket communication parameter socket_multi_en 1: Double socket SocketA parameter 0: tcpc 1: ltcp socketA_type 2: udpc 3: ludp maximum connecting number socketA_max_clts Tcp server maximum number is 4 socketA_localport 25000 (1-65535) IP or domain socketA_destip 192.168.1.101...
  • Page 63 RAK477 Instruction Manual Interval time unit of socketB_tcp_reconv 0: disable 1-600 : valid reconnectio n: s Module name module_name RAK477 (16B) WEB setting user_name admin (16B) user_password admin (16B) Copyright © Shenzhen Rakwireless Technology Co., Ltd ETDX1602241830...
  • Page 64: Version

    RAK477 Instruction Manual 6. Version Version Date Modified records Create a document V1.0 2016-3-1 Add the related tools section V1.1 2016-6-11 Updata document V1.2 2017-1-16 Copyright © Shenzhen Rakwireless Technology Co., Ltd ETDX1602241830...

This manual is also suitable for:

Rak477ma

Table of Contents