E103-W02 UserManual EN V3.0
E103-W02 UserManual EN V3.0
Content
1. Product introduction ...................................................................................................................... 4
Brief introduction ...................................................................................................................... 4
Basic usage ................................................................................................................................ 5
Electrical parameter .................................................................................................................. 5
Electrical characteristic ............................................................................................................. 6
2. Function description ...................................................................................................................... 7
Pin definition ............................................................................................................................. 7
Application schematic ............................................................................................................... 8
3.Quick start ...................................................................................................................................... 9
3.1 Traditional mode(NORMAL) ........................................................................................... 10
3.1.1 Link preparation ..................................................................................................... 10
3.1.2 Set the module as AP to establishes TCP SERVER and PC wireless connection 11
3.1.3 Set the module as AP to establish a UDP server wireless connection with a PC ... 13
3.1.4 Set module as STA(Station)to connect other WiFi hot spots ............................ 15
......................................................................................................................................... 21
3.1.5 Web page configuration .......................................................................................... 21
......................................................................................................................................... 22
3.1.6 Remote AT command ............................................................................................. 22
3.2 MQTT Client mode(MQTT) ............................................................................................. 23
1.1 3.2.1 Setting process.................................................................................................. 23
3.2.2 Device access demo ............................................................................................ 24
3.2.3 MQTT precautions ................................................................................................. 27
3.3 HTTP Client mode (HTTP) ............................................................................................... 27
3.3.1 Setting process........................................................................................................ 27
3.3.2 Use of POST request method ................................................................................. 28
3.3.3 Use of GET request method ................................................................................... 29
3.3.4 HTTP Client precautions ........................................................................................ 31
3.4 Server multi-Link mode (MULTIS) .................................................................................. 31
3.4.1 Setting process........................................................................................................ 31
3.4.2 Multi-Client access demo .................................................................................... 31
3.4.3 MULTIS precautions .............................................................................................. 33
3.5 Client Multi-link Mode (MULTIC) ........................................................................... 34
3.5.1 Setting process........................................................................................................ 34
3.5.2 Demo of A B general client access server .............................................................. 34
3.5.3 EBT Private Network Access Demo ...................................................................... 36
3.5.4 MULTIC precautions ............................................................................................. 38
3.6 Change UART baud rate ................................................................................................... 38
3.7 Low power consumption configuration description .......................................................... 38
4.Specification for networking ........................................................................................................ 39
Networking role ...................................................................................................................... 39
Networking model ................................................................................................................... 40
5. AT Command .............................................................................................................................. 41
1. Product introduction
Brief introduction
1`212 Support EBYTE Access to EBYTE cloud platform, simple cloud platform setting can
12 cloud access quickly realize remote transparent transmission of different equipment
1313 Pin status reminder Pin level reminder varies according to different operating status
Basic usage
Electrical parameter
Electrical characteristic
2. Function description
Pin definition
Application schematic
Note:supply voltage must be 2.4V~3.6V, 500mA LDO is recommended for steady operation
of module
3.Quick start
E103-W02 module is easy to use. In order to allow users to quickly familiarize with the module,
the following guides users to quickly use the module for different modes, and to configure and
communicate in various modes through simple settings.
All the commands are used during testing are AT commands. We developed HTTP web page for
users to access the module and conduct quick configuration.
The tests in this chapter are conducted with Serial debugging assistant, the module will return the
current commands so that users could quickly learn the way to use AT commands. (Notes: All AT
commands shall be followed with a line break except for “+++” commands)
•In addition, users could use external MCU instead of baseboard to connect the UART of the module
for AT commands communication to realize secondary development.
Hardware:
3 PC with Wi-Fi*1
1 AccessPort/XCOM
③ Set the serial port debugging parameters (baud rate: 115200bps, data bit: 8bit, parity bit: no parity,
stop bit: 1bit).(See the picture below)
④. We open the wireless network on the PC, find the wireless network with SSID beginning with
"EBT" (such as: EBT_9BB311), and click on "Next" to connect. ("9BB311" here is the last 6 digits of
the module MAC address. The MAC address of different modules is different, so the SSID of different
modules is also different.)
⑤. After the connection is successful, the LED1 light on the module baseboard is always on (GPIO9
is pulled low), and the PC shows that the connection is successful, otherwise please repeat the above
steps.
3.1.2 Set the module as AP to establishes TCP SERVER and PC wireless connection
①. Open the TCP & UDP testing tool, create a connection, and set the parameters (see the figure below).
(The parameter value can be sent through the serial debugging assistant to send the corresponding AT
command for query and then exit the AT command mode to realize the subsequent two-way
communication between the PC and the module)
②. Click on the "Create" button to complete the creation, and then click on the "Connect" button.
③ The LED 2 on the module baseboard is always on (GPIO10 is pulled low), indicating that the
connection is completed,then the PC and the module can communicate with each other mutually (it means
TCP & UDP testing tool and AccessPort can communicate with each other mutually), if not, please repeat
above steps.
3.1.3 Set the module as AP to establish a UDP server wireless connection with a PC
Now let’s try to set up UDP communication, which needs some simple configuration on the module.
①. Make sure the link preparation is completed successfully.
② Enter AT command mode for simple configuration. (Please make sure to complete the
operation of No. 1 first. Since it is sending commands, please turn off the Real Time Send function of
the port in order to configure the module, if there is no Real Time Send function in your AccessPort,
please ignore this notice)
a. Start to configure the port, input command “+++”in the sending textbox (please do not add line
break), and click on Send button to start sending command.
b. If the port returns “Entered AT mode”, it means the module has entered AT command mode, if
not, please repeat the above steps.
④. By step ④, we have entered AT command mode, now let‘s start to configure Socket protocol.
a. Input“AT+SOCK=UDP,SERVER,192.168.1.2,8887,8889”in the sending textbox (please add
line break, which means to press Enter after “AT+SOCK=UDP,SERVER,192.168.1.2,8887,8889”),
click on Send button to start sending.
b. If the port returns “Socket update OK”, it means the command has successfully set the
protocol parameters, if not, please repeat the above steps.
④. Reset the module or restart when power off after setting parameters to validate the settings; If
there are still other parameters to set, please complete the setting before reset or repower. Because we
only configure Socket protocol, so just directly reset or repower (GPT010 is pulled low), the LED2 will
be lit up on the baseboard, it means the UDP protocol is available.
④. Open the TCP&UDP testing tools, create connection and set parameters (See the picture below).
④. It can transmit document (it is better to be in TXT format), just have a try.
In addition, customers can also set the socket link as TCP Client in AP mode. The setting method is
the same as above, which will not be explained here.
④.Set UART parameters (baud rate: 115200bps, data bit: 8 bits, parity bit: none, stop bit: 1 bit).
(refer to the picture below)
a. Start UART configuration, input “+++”in the sending textbox (no line break), click on Send button
to send command.
b. If the UART returns “Entered AT mode”, it means the module has entered AT command mode, if
not, please reset and repeat above steps.
④.Now our module is connecting other AP as STA, so please set the mode as STA mode.
a. Input AT command “AT+ROLE=STA”in the sending textbox (with line break), which means
pressing Enter after inputting “AT+ROLE=STA”), and then click on Send button.
b. If the UART returns “Set STA mode”, it means the module has been set as STA mode, if not,
please repeat above steps.
④.Reset or repower the module, if the Wi-Fi modules are far from each other, please install antennas.
④.If LED1 is lit up(GPI09 is pulled low), it means the module is successfully connected to Wi-Fi hot
spot.
Connect other Wi-Fi hot spots as STA (Station) through SmartConfig (one-click config.)
④.Connect the E103-W02 baseboard and PC with Micro USB data line.
④.Open AccessPort, select COM number; if you are not clear about the COM number, please check in
your Device Manager (see the picture below).
④.Set UART parameters (baud rate: 115200bps, data bit: 8 bits, parity bit: none, stop bit: 1 bit).(see the
picture below)
④.If the modules are far from each other, please install antennas. If the LED1 on baseboard is lit
up(GPIO9 is pulled low), it means the module is successfully connected to Wi-Fi hot spot, if not, please
repeat above steps. (when successfully connected, the module will remember the Wi-Fi hot spot
(including passwords), it will automatically connect to it upon reset or repower next time)
Here, users can also use the AT + AIRKISS command to implement the AIRKISS configuration.
The E103-W02 can use the web page to reconfigure the module parameters. Before performing this
operation, the module needs to connect to the PC wirelessly. After the PC displays the connection
successfully, open the IP address of the browser input module (if the module is not clear) The IP address
can be queried using the serial port AT command "AT+APIP=?")
Then enter the module parameter configuration page, where you can reset multiple parameters of
the module.
After the parameters are reconfigured, the module needs to be restarted and the configuration
parameters take effect.
The E103-W02 in NORMAL mode can use the remote AT command to send an AT command to the
module 12476 port using the UDP communication protocol. When using the remote AT command, you
do not need to use "+++" for mode switching. Remote command is only allowed in the module NORMAL
mode, and will not be used when switching to other modes (such as MQTT, HTTP).
In the NORMAL mode chapter, we introduced the module setting process and the use of AT
instruction in detail. In this chapter and the introduction of other modes, we only make some simple
introduction and use of the AT instruction for functions.
MQTT is a client-server based message publish / subscribe transmission protocol. The MQTT
protocol is lightweight, simple, open, and easy to implement. These characteristics make it applicable to
a wide range. In many cases, including restricted environments, such as machine-to-machine (M2M)
communication and the Internet of Things (IoT). It has been widely used in satellite sensors to
communicate with sensors, occasionally dialing medical devices, smart homes, and some miniaturized
devicesAmong them, communication sensors through satellite links, medical devices that occasionally
dial, smart homes, and some miniaturized devices have been widely used.
1.1 3.2.1 Setting process
When the module works in MQTT mode, at this time, some sub-functions of other modes will not
be enabled (such as NORMAL remote AT command will not be allowed to be used). MQTT mode is the
module's role as an MQTT client to access users in the target MQTT server, when users use the MQTT
mode, if they want to access the public network for long-distance transmission or access to the cloud
server, they need to know that the network role of the module should be set to the STA mode. The
following uses ONENET as an example to introduce the access method and communication.
Login to our ONENET MQTT device management platform, when there is no access, the offline status
is displayed, as shown in the picture below
After the setting is completed, the ONENET cloud platform management displays the online status after
successful access.
At this time, when the ONENET is successfully connected, the GPIO10 pin is pulled low at to indicate
the status of successful access, and the disconnection it will be pulled high.
In order to demonstrate the data transmission process of the device intuitively, we use another W02 to
follow the above steps (note that the path of subscription and reporting needs to be exchanged)
As shown in the picture below:
1. Enter AT mode and put the current network role in STA mode
+++
AT + ROLE = STA
2. Connect to WIFI (AP) and connect to the network
AT + STA = EBYTE, 2, JSZXE880
3. Switch the mode and set the operating mode to HTTP mode
AT + MODE = HTTP
4. Set the HTTP connection information, connect to the destination IP and monitor port of the
HTTP server
AT + HCADDR = 192.168.0.136,80 (HTTP server address of local LAN)
In the serial port, each time the data is sent, it will trigger the request data of the HTTP client, while
the corresponding data input by the serial port is reported to the server data, and the data is sent in the
serial port: 123, the module will request data from the server according to the set request path and method.
After requesting data, the server will return the file to the serial port, as shown in the picture below: The
red box in the figure is the request information of the module as an HTTP client.
The POST method is generally recommended for customers when uploading large data to the server.
If you only request data from the server, you can choose the GET method.
When you need to request data, you need to specify the HTTP Client access path before sending
serial data, as shown in the picture below
In the above picture, you can see the request method and path resolved by the server, and when
using the GET method, the access path in the serial data needs to be specified (remember to add "?" and
a space)
The GET method is more flexible and suitable for small data uploads, but the request path often
becomes the case.
The access path set by the AT command is only valid for the POST request method. The GET
method requires the data header in the serial port data to specify the access path.
The HTTP client's default request header attributes are:
Host: xxx.xxx.xxx.xxx
Accept: * / *
Content-Length: xx
This can ensure that customers can request data without setting the header.
Customers can set the header information through the data format of AT + HCHEAD = XX: XX,
XXX: XXX. If customers want to add after the default request header
Connection: keep-alive
Content-Type: application / json
They need to use the following AT format, the total length cannot exceed 180 bytes:
AT + HCHEAD = Connection: keep-alive, Content-Type: application / json
When the module works in MULTIS mode, other modes or sub-functions will not be used. MULTIS
means that the module as a server can support the connection mode of multiple clients. At present, this
mode supports the connection of 4 clients at the same time. The modules are listed bunder the role of AP
below, realizing multi-client communication.
The operation of A complete set of AT commands operation in MULTIS mode is shown below:
After restarting, at this time, the module works in MULTIS mode. It has been established after
the server is turned on. The port number and local IP are set by users. The SSID of the module connected
by the computer is that the computer and the module are in the same LAN. After the computer
successfully connects to the module, the GPIO9 pin is pulled low.
After successfully connecting, we create 4 clients on the computer and fill in the IP and port the
module server(Module IP: 192.168.1.1 port number is 5002)
As shown in the picture below:
The data received by the module's serial port will be broadcast to each client connection.
If more than two links are established and the link has a TCP type link, the server (TCP) needs to
be established before the module is restarted. The reason will be explained in the following notes. Under
normal circumstances, the local TCP server and the The UDP server is connected by the A B client of
the module, as shown in the picture below:
When the serial port sends data, it is sent to each server connected to the module client by broadcast,
and the data sent by each server is printed to the module serial port.
3. After entering the login interface, add a device in the device list and enter the module's MAC
address and SN code correctly, as shown in the picture below:
4.After adding correctly, as shown in the picture below, in this way, multiple modules can be
established on the cloud platform to correspond to the device.
5. Restart the module to access the Ebyte cloud platform server. At this time, check the information
related to cloud platform device, the device is already online, as shown in the picture below:
If users want to achieve remote forwarding between multiple devices, or data forwarding with other
products of our company through W02, they can set it in the relevant setting column. We will not repeat
them here.
No. Remark
1 E103-W02 Wi-Fi module supports 300 ~ 3000000bps UART baud rate.
By sending AT+UART command, the user can modify the UART parameters. For example:
2
AT+UART=115200, 8, 0,1
3 Please refer to AT command set for detailed command.
Baud rate 300-3000000bps(default115200)
NONE(default)
Parity bit support EVEN
ODD
5 bits
6 bits
Data bit
7 bits
8 bits
1 bit
Stop bit
2bits
E103-W02 can be configured to four power consumption modes: Active, Sleep, LPDS, Hibernate.
By sending AT+PM command, the user can configure the module to corresponding low power
consumption mode. For example: AT+PM=1, 5
Tips:
1.Set low-power mode in AP mode. The module will not enter low-power mode immediately after startup.
Only when connected to the network (as AP mode, there are devices connected to the module) will enter
low-power mode.
2. After receiving the network data and the serial port data, the delay time for entering the low power
consumption mode will be refreshed. For example: in hibernate mode, after sending serial port data to
wake up the module and wait for connection to the server, you can continuously send data for a long time
without worrying that the module will re-enter hibernate mode. When the serial port or network data
reception is completed, the timing of the delay entry into the low-power mode starts immediately, and
the module re-enters the hibernate mode after the delay time is reached.
3. In low power mode, all IO are in a high-impedance state, so the status indicator is invalid, and it will
not reflect the current actual connection status.
Networking role
No Remark
1 As physical connection, E103-W02 supports AP mode (router) and STATION (Wi-Fi
Networking model
Module builds TCP Client to connect with remote server when working at STATION mode
(classic)
Module builds TCP Server to connect with Wi-Fi device when working at STATION mode
This module is similar to type one, the only difference is module builds TCP Server instead of TCP
Client when working at STATION mode.
At most 4 remote devices can be connected when module connects with network.
One module build TCP Server when works at AP mode, and the other module build TCP
Client when works at STATION mode to communicate with it.
The network model can be referred to as intra-module networking. A module in an AP mode can
connect up to three STATIONs, that is, up to four module devices in the network. The TCP Server
can be established on any module under the condition of completing the internal networking, and
the remaining three modules can communicate with it using the TCP Client.
5.AT Command
Test method:
(Remember to add
Enter and a line feed.
Example AT command
The query command Function
No. Command Test example response
is AT + XXX = ?, the description
following only
describes how to use
it)
Parameter
specification:
0 +++ No parameter Entered AT mode
Response:
Entered AT mode
AT+AIRKISS Enter
Parameter AIRKISS
2 AT+AIRKISS specification: mode and AT+AIRKISS Enter into AirKiss
No parameter
wait for AP
Response:
Enter into AirKiss access
specification:
SSID:Service set
identifier
<1~32Byte>
4 AT+AP SecType:Encryption
type(0: no password, AT+AP=EBYTE,
1: WEP encryption, 2: Set AP AP update OK
2,12345678
WPA2 encryption)
Password:
<8~63Byte>
Response:
AP Update OK
AT+CHAN=<Channe Query AP
AT+CHAN=? AP Channel:11
5 AT+CHAN l> channel
Parameter AT+CHAN=1 AP channel update OK
Query the
AT+SOCKEBT=<ON
access status
/OFF> AT+SOCKEBT=? +SOCKEBT State:OFF
of EBYTE
Parameter
specification:
<ON/OFF>: Enable
35 AT+SOCKEBT switch,default is off.
When it is off, the
following parameter Set the
settings are invalid. access status AT+SOCKEBT=
+SOCKEBT
Response: of EBYTE ON
+SOCKEBT OK
AT+SOCK=<Protoco Query
l>,<CS>,<RemoteIP> Protocol:TCP CS:CLIENT
,<RemotePort>,< related
RemoteIP:183.230.40.40
LocalPort > parameters AT+SOCK=?
Parameter RemotePort:1811
specification: of the main
LocalPort:8887
Protocol:protocol socket
36 AT+SOCK ( TCP or UDP)
CS:(CLIENT or Set related
SERVER) AT+SOCK=TCP,
parameters
RemoteIP:Remote CLIENT ,183.230 Socket update OK
IP address of the main
.40.40,1811,8887
RemotePort:Remote socket
port number
6. Antenna selection
The default 0R resistor is soldered as shown above (left), and the antenna interface is PCB. If you
need to change the antenna interface mode to IPEX, please change the 0R resistor to the above (right).
7. Customized cooperation
8. Revision history
Version Date Description Issued by
1.0 2017-10-16 Initial version huaa
1.1 2018-5-23 Content addition huaa
1.2 2018-9-18 Manual split huaa
1.3 2019-2-17 Error correction Ray
1.4 2019-8-9 Content addition All
3.0 2019-12-18 version update Blue
9. About us