GL-S10 User Manual¶

Version	Date	Commit
V2.0.0	2021-10-25	-

General Product Introduction¶

Product introduction¶

The GL-S10 is an IoT gateway device that supports BLE and Wi-Fi, providing a cost-effective solution for transmitting BLE broadcast data to the cloud. BLE supports GAP and GATT certification and can be used as either Master or Slave to connect and communicate with other BLE devices. GL-S10 can use Wi-Fi as a Station to connect to a parent route or can connect to the Internet through a WAN port. It has a built-in standard MQTT Client that can connect to any standard MQTT Servers to forward incoming BLE messages to the cloud server.

The GL-S10 is ideally deployed in warehouses, shopping malls, airports, exhibition halls, tourist attractions and other scenarios for personnel management, asset management, environmental monitoring, indoor navigation, etc.

Product feature¶

Runs on Dual-core Xtensa® 32-bit LX6 microprocessor, supports BLE, Wi-Fi, and Ethernet
BLE supports BLE 4.2 Certification
BLE communication distance is measured up to 80m (in an open and non-interference environment)
Supports multiple encryption methods
Supports upgrading firmware via OTA and local serial port
Supports MQTT and integrating to multiple server platforms
Includes application for configuration with customized connection to Wi-Fi and MQTT servers
Supports 802.3at/af standard POE input power

Technical specification¶

Project	Description
CPU	ESP32-DOWD Dual-core Xtensa ® 32-bit LX6 microprocessor
Nor-Flash	4MB
RAM	SRAM 520KB + PSRAM 8MB
BLE	Supports BLE 4.2 Certification Coverage of 80m (in an open and non-interference environment) Receiving sensitivity - 97dBm
WiFi	802.11b/g/n Coverage of 80m (in an open and non-interference environment). Transmitting power 11n: 13dBm; 11b: 18.5dBm Speed 150Mbps
WAN	1 Megabit Ethernet port
Button	1 Reset button Configuration mode, Resetting and OTA upgrading can be accessed by pressing the button
LED	3 LED lights: Power, BLE and Network Indicator Lights
Power Supply	Supports 1x Micro USB, 5V/1A input Supports 802.3at/af standard POE input power Note: Charging with both methods simultaneously may cause damage to the device.
Power Consumption	Normal operations: < 0.5W Operating at full capacity: < 1.5W
Shell Size	57 * 57 * 25mm(L * M * H)
Shell Material	ABS
Antenna Type	External antenna
Working Temperature	0~40°C
Storage Temperature	-20~70°C
Working humidity	5% ~ 90%, no condensation
Storage humidity	5% ~ 95%, no condensation

Package list¶

Project	Quantity
GL-S10 Gateway	1
BLE Beacon (optional accessory)	1
External Antenna	1
USB Power Cord	1
User Manual	1

Device and APP Installation¶

Device installation¶

Take out the product from its package and attach the external antenna as shown below.

Figure 1

Note:

Avoid plugging in the PoE power supply and 5V power supply simultaneously, it may cause damage to the device.
Do not connect to any power supply (including PoE & 5V) before installing the antenna.

Button function list¶

Pairing mode	Reset to factory setting	OTA upgrade
When it is not connected to any power supply, press, and hold the "Reset" button while plugging in the power cord.	While pressing the "Reset" button, turn on the power, press and hold the "Reset" button for 5 seconds and release.	While pressing the "Reset" button, turn on the power, press and hold the "Reset" button for 10 seconds and release.

LED description¶

LED Light	Status	Reset to factory setting	Enter OTA mode	OTA upgrade process
Power (Green light)	Light on: Device is on Light off: Device is off	Blinks slowly	Blinks fast	Blinks alternatively
BLE (Green light)	Light blinks: Paring Mode(Disconnected) Light on: Paring Mode(Connected) Light off: Scanning Mode	Blinks slowly	Blinks fast	Blinks alternatively
Network (White light)	Light blinks: Wi-Fi connected Light on: Ethernet connected Light off: Not connected	Blinks slowly	Blinks fast	Blinks alternatively

BLE beacon¶

BLE Beacon is an optional accessory. User can purchase gateway kit with beacon for a quick Demo. The beacon can also be used for indoor positioning, asset management and other scenarios. The rotating base makes the device easy to disassemble; and the base has 3M adhesive which makes it easy to fix in place.

After turning on the BLE switch at the bottom of the beacon, the beacon will broadcast BLE signals at an interval of 300ms. Select the filter function of GL-S10 and identify the devices by the BLE MAC address printed at the bottom of the beacon.

Figure 2

APP installation¶

Download and install GL-S10 Tool App on your phone, turn on the Bluetooth function of your phone (For Android phone users, please turn on Bluetooth and GPS), and follow the instructions in this user manual to configure your GL-S10.

App Configuration¶

Set configuration mode¶

Before using the app for configuration, set GL-S10 into its paring mode by pressing the Reset button of GL-S10 when the power is off, then turn on the power. Release the button when you see the BLE indicator in the middle flashes, and your GL-S10 will enter its pairing mode.

App language¶

Start the app and select the app language, you can choose between English and Simplified Chinese.

Connecting your GL-S10¶

Click the "scan" button in the upper right corner. The scanning result automatically filters out non-GL-S10 devices. If more than one GL-S10 are scanned, select the devices you want to connect according to the BLE MAC address on the label at the bottom of your GL-S10 shell (as shown below).

Note: WAN MAC address is BLE MAC address minus 1, WiFi MAC address is BLE MAC address minus 2

Home page¶

Select a GL-S10 device and enter the "Manage Device" interface as shown below

Figure 8

Device Info¶

You can click to view the details of the device as shown below

Protocal configuration¶

To setup uplink connection using a Protocal on the WAN port, click "Manage Device" > "Protocal" > "Protocal". You can configure "DHCP" and "Static IP" mode, then click "Done" to save the settings as shown below.

Wi-Fi configuration¶

To connect to a primary gateway, click "Manage Device" > "WiFi" > "Connect WiFi" > "Scan WiFi", and select your WiFi SSID. You can also select "None", "WPA2" or "WPA2 Enterprise" mode. Click "Done" on the upper right corner to confirm the setting as shown below. If you want to upgrade your WPA2 ENTERPRISE certificate, click “Upgrade certificate”.

Figure 15

MQTT Configuration¶

To configure MQTT, click "Manage Device" > "MQTT Server". Enter the address of your MQTT broker in the "Host" field, fill in the port number, username, and password. The "TLS" selection switches between TSL/SSL link and the TCP link. Enter a SUBSCRIBE message in the "Command" field and a SUBACK acknowledgement message in the "Respond Topic" field. You can also click "Update Certificate" below to update the MQTT encryption certificate. Click "Done" on the upper right corner to save the settings.

Report Configuration¶

Click "Report Configuration" in the interface of "Manage Device" to enter the interface of "Report Configuration".

Click "Report interval", "Topic", "Bluetooth RSSI threshold filtering" to enter the relevant information configuration interface, fill in the configuration information and click the upper left corner to return to the previous page to save your settings.

Click “BLE MAC Filter”, “Complete Local Name Filter”, or “Manufacturer Specific Data Filter” at the bottom and enter the relevant information to activate the filter.

Note: Filter Rules Instructions

MAC Filter: The value range is 0~f, the characters are lowercase, and colons must be included; the string should be full match.
Complete Local Name Filter: the characters are case-sensitive,the string should be full match; for any unsure information, please download the nFR Connect software to check.
Manufacture Specific Data Filter: The value range is 0~f/F, the characters are case-sensitive and should be matched according to regular expressions.

If you purchased a gateway kit with the BLE Beacon, you also have the option to set BLE MAC filtering rules for the beacon in the app by entering the BLE MAC address information printed on the bottom of the beacon.

Click "Add New Rule" or "Remove" to edit the filter settings and click "Done" on the upper right corner to save the settings.

Data & Time configuration¶

Click "Manage Device" > "Date & Time". Select your time zone, fill in the SNTP service address and click the upper left corner to return to the previous page to save your settings, as shown below.

Auto Reboot configuration¶

Click "Manage Device" > "Auto Reboot". You can schedule a time to reboot GL-S10 on a daily-basis. Click the upper left corner to return to the previous page to save your settings, as shown below.

OTA upgrade¶

Click "Manage Device" > "Upgrade OTA". Under "OTA URL", enter the http server address and click "Save" on the upper right corner. Click "Upgrade OTA" to save the URL path and initiate the upgrade. Click "Update Certificate" to update the OTA encryption certificate as shown below.

Please keep your GL-S10 connected to the internet and do NOT turn off the power during the OTA upgrade. After the OTA upgrade is completed, your GL-S10 will automatically enter Scanning mode, and your app will not be able to search for GL-S10.

Reboot device¶

Click "Manage Device" > "Reboot", and a pop-up window will ask for a reboot confirmation. The device will reboot after clicking "Sure". After rebooting, the device will automatically enter Scanning mode, and your app will not be able to search for GL-S10.

Figure 30

Reset device¶

Click "Manage Device" > "Reset". A pop-up window will ask for a reset confirmation. When you click "Sure", all device configurations will be restored to the factory default settings. After resetting the device, it will automatically enter Scanning mode, and your app will be able to search for GL-S10.

Figure 31

MQTT Configuration¶

When the GL-S10 is connected to the MQTT server, you can also use the MQTT API to configure the GL-S10.

You can configure MQTT using a third-party tool - MQTT X, downloadable from https://mqttx.app/.

The default MQTT setting is configured to connect with the beta cloud platform. Enter the configuration for GL-S10 and MQTT X client to activate the connection. The beta cloud platform is for testing only and not for other usage.

Network Configuration¶

GL-S10 supports wired transmission and Wi-Fi for connecting to the router or gateway. The setting procedure can be found in section 3.6 Cable configuration and 3.7 Wi-Fi configuration.

MQTT X client configuration¶

Before doing the MQTT X client configuration, we need to configure the configuration of the MQTT server on S10 first. Find MQTT Server session in the S10 Tool APP.

Here we are using the test MQTT server: iot-s10-test.gl-inet.cn. And the Port is: 1884, so we need to set the Host in the following figure: iot-s10-test.gl-inet.cn. And set Port: 1884.

On the windows version of the MQTT X client, start the MQTT X software and add a new connection. To configure the beta cloud platform, enter the URL address iot-s10-test.gl-inet.cn and port 1884. Click the upper right corner of the page to connect. A successful connection is shown below in Figure 33.

Figure 34

Figure 35

MQTT Message Editing and Communicating with S10¶

The default command topic for this firmware is GL-IoT/comTopic/{dev_MAC}, and the command reply topic is GL-IoT/rspTopic/{dev_MAC}.

The BLE MAC address of the GL-S10 device we use in this example is: E8DB841E2B1E (The BLE MAC address is printed on the bottom of the device or in the app).

In our testing, MQTT X sends data via GL-IoT/comTopic/E8DB841E2B1E and receives data from GL-S10 by subscribing to GL-IoT/rspTopic/E8DB841E2B1E.

Below is a demo of how to set data (SET_DEV_MESSAGE) and obtain data from GL-S10 (GET_DEV_MESSAGE):

Step 1: Subscribe to the GL-IoT/rspTopic/E8DB841E2B1E topic using MQTT X.

Figure 36

Step 2: SET_WIFI_CONFIG

API Function: Configure SSID and PWD of WIFI or SSID, user name, user password of WIFI WPA2, and try to connect to the corresponding route.

{

"jsonrpc": "2.0",

"method": "SET_WIFI_CONFIG",

"params": {

"type":0,

"ssid": "Test",

"pwd": "123456"

},

"id": 1

}

Here we use "Test" for the SSID and "123456" for the user passward.

When type is equal to 0, SSID, PASSWORD can be set.
When type is equal to 1, SSID, USERNAME, USERPASSWORD can be set.
SSID: route name, length 0 - 32 characters.
PWD: route password, length 0 - 64 characters.
USERNAME: User name, length 0 - 32 characters.
USERPWD: User password, length 0 - 64 characters.

Figure 37

Set data successfully:

Figure 38

Step 3: GET_WIFI_CONFIG

API Function: Get the SSID and PWD of WIFI or SSID, user name, user password of WIFI WPA2\

{

"jsonrpc" : "2.0" ,

"method" : "GET_WIFI_CONFIG" ,

"params" : {

"type" : 0

},

"id" : 2

}

When type is equal to 0, get SSID, PASSWORD.
When type is equal to 1, get SSID, USERNAME, USERPASSWORD

Figure 39

Get data successfully:

Figure 40

BLE Data Uploading¶

After successfully establishing connection, GL-S10 automatically enters Scanning mode and scans for BLE signal during startup. If the MQTT server is connected, the BLE scan data will be packaged and uploaded to "GL-IoT/dataTopic/{dev_MAC}" topic in JSON format. ({dev_MAC} is the local BLE MAC address, in this example, the BLE MAC address of the GL-S10 device used is: E8DB841E2B1E).

As shown above, the JSON fields have the following definitions

MAC : Broadcast source address
rssi : Broadcast source signal strength
n : Broadcast source device name (this field will not appear if the broadcast source does not have a name)
ad : Broadcast data advData
ts : receive timestamp

If you purchased a gateway kit with a BLE Beacon and adds filtering rules for the beacon BLE MAC address according to section 3.9, the JSON information viewed here is the BLE information broadcast by the beacon. The beacons are placed at different distances from the GL-S10 gateway (distance up to the decimeter level), and the value of rssi (broadcast source signal strength) may fluctuate based on distance.

Figure 41

Figure 42

GL-S10 Config API¶

This chapter define the commands to configure the GL-S10 device using the MQTT method. Command summary sheet

Command summary sheet¶

Command Code	Command	Whether parameters are required	Description
0x01	SET_WiFi_CONFIG	Y	Set up Wi-Fi configuration
0x02	GET_WiFi_CONFIG	N	Get Wi-Fi configuration
0x03	SET_NETWORK_CONFIG	Y	Set static IP or dynamic IP
0x04	GET_NETWORK_CONFIG	N	Get static IP or dynamic IP
0x05	GET_NETWORK_STATE	N	Get the current network status
0x06	WiFi_CONNECT_OR_DISCONNECT	Y	Wi-Fi connected or disconnected
0x07	SET_MQTT_URL	Y	Set MQTT URL
0x08	GET_MQTT_URL	N	Get MQTT URL
0x09	MQTT_CONNECT_OR_DISCONNECT	Y	MQTT connected or disconnected
0x0A	SET_MQTT_TOPIC	Y	Set MQTT topic name
0x0B	GET_MQTT_TOPIC	N	Get MQTT topic name
0x0C	SET_MQTT_TI	Y	Set the MQTT data reporting time interval
0x0D	GET_MQTT_TI	N	Get the MQTT data reporting time interval
0x0E	SET_SNTP_TZ	Y	Set the SNTP server time zone
0x0F	GET_SNTP_TZ	N	Get the SNTP server time zone
0x10	SET_SNTP_SERVER	Y	Set the SNTP server
0x11	GET_SNTP_SERVER	N	Get the SNTP server
0x12	SET_AUTO_REBOOT	Y	Set auto reboot time
0x13	GET_AUTO_REBOO	N	Get auto reboot timeL
0x14	SET_MAC_FILTER	Y	Add and remove MAC filter table entries
0x15	GET_MAC_FILTER	Y	Get MAC filter table entries
0x16	SET_CLN_FILTER	Y	Add and remove BLE Complete Local Name filter table entries
0x17	GET_CLN_FILTER	N	Get BLE Complete Local Name filter table entries
0x18	SET_MSD_FILTER	Y	Add and remove Manufacturer Specific Data filter table entries
0x19	GET_MSD_FILTER	N	Get Manufacturer Specific Data filter table entries
0x1A	UPDATE_MQTT_CERT	Y	Update MQTT encryption certificates
0x1B	UPDATE_WPA2_CERT	Y	Update Wi-Fi WPA2 encryption certificate
0x1C	UPDATE_HTTPS_CERT	Y	Update HTTPS OTA encryption certificate
0x1D	SET_OTA_URL	Y	Set the URL of the OTA server
0x1E	GET_OTA_URL	N	Get the URL of the OTA server
0x1F	OTA_STATUS	N	OTA upgrade status notification
0x20	GET_DEV_STATUS	N	Get device status
0x21	GET_DEV_MESSAGE	N	Get device message
0x22	RESTART_DEV	N	Reboot device
0x23	RESET_DEV	N	Reset device
0x24	SET_BLE_RSSI_FILTER	Y	Set RSSI filter thresholds
0x25	GET_BLE_RSSI_FILTER	N	Get RSSI filter thresholds
0x26	GET_WiFi_AP_LIST	N	Get a list of surrounding Wi-Fi AP information

Command detail¶

SET_WiFi_CONFIG¶

API function: Configure the WiFi’s SSID and password, or WiFi WPA2’s SSID, username and password, then connect to the router.

Data segment at reception:

CmdID	Data
0x01
	0x00\n	SSID\nPWD\n
	0x01\n	SSID\nUSERNAME\nUSERPASSWORD\n

Note: Each paragraph of data is separated by the '\n' character, as shown above, please follow the format.

When data[0] is equal to 0x00, SSID and PASSWORD are configurable.
When data[0] is equal to 0x01, SSID, USERNAME, USERPASSWORD are configurable.
SSID: router’s name, maximum length of 1-32 characters.
PWD: router’s password, maximum length of 8-64 characters.
USERNAME: username, maximum length of 1-32 characters.
USERPASSWORD: user password, maximum length 1-64 characters.

Data segment at response:

CmdID	Data
0x01	Result\n

Note: Each paragraph of data is separated by the '\n' character, as shown above, please follow the format.

Result：0x00 represents execution success; 0x01 represents execution failure.

GET_WiFi_CONFIG¶

API Function:

Get Wi-Fi SSID and PWD, or Wi-Fi WPA2 SSID, user name, user password

Data segment at reception:

CmdID	Data
0x02
	0x00\n
	0x01\n

When data[0] is equal to 0x00, get SSID, PASSWORD.
When data[0] is equal to 0x01, get SSID, USERNAME, USERPASSWORD.

Data segment at response:

CmdID	Data
0x02	Result\n
		0x00\n	SSID\nPWD\n
		0x01\n	SSID\nUSERNAME\nUSERPASSWORD\n

Result: 0x00 represents execution success; 0x01 represents execution failure.
When data[1] is equal to 0x00, get SSID, PASSWORD.
When data[1] is equal to 0x01, get SSID, USERNAME, USERPASSWORD.
SSID: router’s name, maximum length of 1-32 characters.
PWD: router’s password, maximum length of 8-64 characters.
USERNAME: username, length 1-32 characters.
USERPASSWORD: user password, length 1-64 characters.

SET_NETWORK_CONFIG¶

API function:

Set static IP or dynamic IP.

Data segment at reception:

CmdID	Data
0x03
	0x00\n
	0x01\n

When data[0] is equal to 0x00, the device is set to DHCP auto-get IP mode.
When data[0] is equal to 0x01, the device is set to static IP mode, and IP, Netmask, Gw can be set.
IP: fixed length, xxx is a number between 0-255, format XXX.XXX.XXX.XXX.
Netmask: fixed length, xxx is a number between 0-255, format XXX.XXX.XXX.XXX.
Gw: fixed length, xxx is a number between 0-255, format XXX.XXX.XXX.XXX.

Data segment at response:

CmdID	Data
0x03	Result\n

Result: 0x00 represents execution success; 0x01 represents execution failure.

GET_NETWORK_CONFIG¶

API Function:

Get the network configuration of static IP or dynamic IP.

Data segment at reception:

CmdID	Data
0x04
	0x00\n
	0x01\n

When mode is equal to 0x00, it indicates that the device is in DHCP auto-allocation state without any data. When mode equals to 0x01, it indicates that the device is in static IP allocation state, and available to receive IP, Netmask and Gw.

Data segment at response:

CmdID	Data
0x04	Result\n
		0x00\n	/
		0x01\n	IP\nNetmask\nGw\n

Result: 0x00 represent execution success; 0x01 represents execution failure.
When data[1] is equal to 0x00, it indicates that the device is in DHCP auto-assignment state, and the data behind is empty.
When data[1] is equal to 0x01, it indicates that the device is in static IP allocation state, and available to receive IP, Netmask, and Gw.
IP: fixed length, xxx is a number from 0-255, format XXX.XXX.XXX.
Netmask: fixed length, xxx is a number from 0-255, format XXX.XXX.XXX.XXX.
Gw: fixed length, xxx is a number from 0-255, format XXX.XXX.XXX.XXX.

GET_NETWORK_STATE¶

API Function:

Get the current network state: State, Mode, isDhcp , IP, SSID.

Data segment at reception:

CmdID	Data
0x05	/

Data is equal to null.

Data segment at response:

CmdID	Data
0x05	Result\n	State\nMode\nisDhcp\nIP\nSSID\n

Result: 0x00 represents execution success; 0x01 represents execution failure.
State: indicates the status of the connection (MQTT server connection), character '0' means connected, character '1' means disconnected, occupies one byte.
Mode: indicates the connection mode, character '0' indicates connection via Wi-Fi, character '1' indicates connection via Ethernet cable, occupies one byte.
isDhcp: character '0' means it is automatically assigned, character '1' means it is not automatically assigned, occupies one byte.
IP: local IP address, xxx is a number between 0-255, format XXX.XXX.XXX.XXX.
SSID: SSID of the connected router, length 1-32 characters.

WiFi_CPNNECT_OR_DISCONNECT¶

API function:

Trigger Wi-Fi connection or disconnects.

Data segment at reception:

CmdID	Data
0x06
	0x00\n
	0x01\n

When data[0] is equal to 0x00, it triggers the device to connect to Wi-Fi.
When data[0] is equal to 0x01, it triggers the device to disconnect Wi-Fi.

Data segment at response:

CmdID	Data
0x06	Result\n

Result: 0x00 represents execution success; 0x01 represents execution failure.

SET_MQTT_URL¶

API function:

Set MQTT_URL.

Data segment at reception:

CmdID	Data
0x07	MQTT_URL\n

MQTT_URL field:

Data field format: mqtt(s)://username:password@host:port
mqtt : TCP connection
mqtts : TSL/SSL connection
username : Username, length 0-32 characters
password : User password, length 0-64 characters
host : Host name, length 7-128 characters
port ：Host port, range 0-65535, length 1-5 characters

Data segment at response:

CmdID	Data
0x07	Result\n

Result: 0x00 Execution success; 0x01 Execution failure.

GET_MQTT_URL¶

API Function:

Get MQTT_URL.

Data segment at reception:

CmdID	Data
0x08	/

Data is equal to null.

Data segment at response:

CmdID	Data
0x08	Result\n	MQTT_URL\n

Result: 0x00 represents execution success; 0x01 represents execution failure.

MQTT_URL field:

Data field format: mqtt(s)://username:password@host:port
mqtt : TCP connection
mqtts : TSL/SSL connection
username : Username, length 0-32 characters
password : User password, length 0-64 characters
host : Host name, length 7-128 characters
port ：Host port, range 0-65535, length 1-5 characters

MQTT_CONNECT_OR_DISCONNECT¶

API function:

Activate trigger to connect to the MQTT server.

Data segment at reception:

CmdID	Data
0x09
	0x00\n
	0x01\n

When data[0] shows 0x00, it triggers the device to connect to the MQTT server.
When data[0] shows 0x01, it triggers the device to disconnect with the MQTT server.

Data segment at response:

CmdID	Data
0x09	Result\n

Result: 0x00 represents execution success; 0x01 represents execution failure.

SET_MQTT_TOPIC¶

API function:

Configure comTopic, dataTopic and rspTopic topics.

Data segment on reception.

CmdID	Data
0x0A	comTopic\ndataTopic\nrspTopic\n

comTopic: command for subscribing a topic, does not support Chinese, length 1-128 characters.
dataTopic: publishing a topic, does not support Chinese, maximum length of 1-128 characters.
rspTopic: Unsuback a topic, does not support Chinese, maximum length of 1-128 characters.

Data segment at response:

CmdID	Data
0x0A	Result\n

Result: 0x00 represents execution success; 0x01 represents execution failure.

GET_MQTT_TOPIC¶

API Function:

Get comTopic, dataTopic and rspTopic topics.

Data segment at reception:

CmdID	Data
0x0B	/

data equals to null.

Data segment at response:

CmdID	Data
0x0B	Result\n	comTopic\ndataTopic\nrspTopic\n

Result：0x00 represents execution success; 0x01 represents execution failure.
comTopic: command for subscribing a topic, does not support Chinese, length 1-128 characters
dataTopic: publishing a topic, does not support Chinese, maximum length of 1-128 characters
rspTopic: Unsuback a topic, does not support Chinese, maximum length of 1-128 characters

SET_MQTT_TI¶

API Function:

Set the MQTT data upload time interval.

Data segment at reception:

CmdID	Data
0x0C	IntervalTime\n

IntervalTime: MQTT data reporting time interval, 100ms - 4294967294ms, length 3-10.

Data segment at response:

CmdID	Data
0x0C	Result\n

Result: 0x00 represents execution success; 0x01 represents execution failure.

GET_MQTT_TI¶

API Function:

Get the MQTT data upload interval.

Data segment at reception:

CmdID	Data
0x0D	/

data is equal to null.

Data segment at response:

CmdID	Data
0x0D	Result\n	IntervalTime\n

Result: 0x00 represents execution success; 0x01 represents execution failure.
IntervalTime: MQTT data reporting time interval, 100ms - 4294967294ms, length 3-10.

SET_SNTP_TZ¶

API function:

Set the device time zone.

Data segment at reception:

CmdID	Data
0x0E	Timezone\n

Timezone: Time zone format, UTC+X or UTC-X (X range 0-12), default Timezone = UTC+8.

Data segment at response:

CmdID	Data
0x0E	Result\n

Result: 0x00 represents execution success; 0x01 represents execution failure.

GET_SNTP_TZ¶

API Function:

Get the device time zone.

Data segment at reception:

CmdID	Data
0x0F	/

Data is equal to null.

Data segment at response:

CmdID	Data
0x0F	Result\n	Timezone\n

Result: 0x00 represents execution success; 0x01 represents execution failure.
Timezone: Time zone format, UTC+X or UTC-X (X range 0-12), default Timezone = UTC-8.

SET_SNTP_SERVER¶

API function:

Set the SNTP server address.

Data segment at reception:

CmdID	Data
0x10	ServerURL\n

ServerURL: SNTP server URL setting, maximum length of 1-128 characters.

Data segment at response:

CmdID	Data
0x10	Result\n

Result: 0x00 represents execution success; 0x01 represents execution failure.

GET_SNTP_SERVER¶

API Function:

Get the SNTP server address.

Data segment at reception:

CmdID	Data
0x11	/

Data is equal to null

Data segment at response:

CmdID	Data
0x11	Result\n	ServerURL\n

Result: 0x00 represents execution success; 0x01 represents execution failure.
ServerURL: SNTP server URL setting, maximum length of 1-128 characters.

SET_AUTO_REBOOT¶

API Function:

Set the auto restart time and switch status.

Data segment at reception:

CmdID	Data
0x12	RstState\nRstTime\n

RstState: indicates whether to turn on the daily restart, character '0' means turn on, character '1' means turn off, occupies one byte.
RstTime: daily restart time, format XX:XX 24 hours, range 00:00 - 23:59, occupies five bytes.

Data segment at response:

CmdID	Data
0x12	Result\n

Result: 0x00 represents execution success; 0x01 represents execution failure.

GET_AUTO_REBOOT¶

API Function:

Get the auto restart time and switch status.

Data segment at reception:

CmdID	Data
0x13	/

Data is equal to null.

Data segment at response:

CmdID	Data
0x13	Result\n	RstState\nRstTime\n

Result：0x00 represents execution success; 0x01 represents execution failure.
RstState: indicates whether to turn on the daily restart, character '0' means turn on, character '1' means not turn on, takes up one byte.
RstTime: daily restart time, format XX:XX 24 hours, range 00:00 - 23:59, occupies five bytes.

SET_MAC_FILTER¶

API Function:

Add or remove MAC filter table entries.

Data segment on reception.

CmdID	Data
0x14	MODE\nAddMAC\n

MODE : 0x00 is Add mode, which adds the AddMAC field to the MAC table of the device; 0x01 is Delete mode, which removes the AddMAC field from the MAC table.
AddMAC: Format XX:XX:XX:XX:XX:XX, XX range [0-9a-fA-F].

Data segment at response:

CmdID	Data
0x14	Result\n

Result：0x00 represents execution success; 0x01 represents execution failure.

GET_MAC_FILTER¶

API Function:

Get MAC filter table entries.

Data segment at reception:

CmdID	Data
0x15	/

Data is equal to null.

Data segment at response:

CmdID	Data
0x15	Result\n	AddMAC0\nAddMAC1\n…\n

Result：0x00 represents execution success; 0x01 represents execution failure.
AddMAC: AddMAC0, AddMAC1 are single MAC, it will send all the data in the MAC filter table in a batch according to the format shown above, single format XX:XX:XX:XX:XX:XX, XX range [0-9a-fA-F].

SET_CLN_FILTER¶

API Function:

Adds or removes a BLE device name filter table entry.

Data segment at reception:

CmdID	Data
0x16	MODE\nAddCLN\n

MODE : 0x00 is Add mode, which adds the AddCLN field to the device's BLE device name table; 0x01 is Delete mode, which removes the AddCLN field from the BLE device name table.
AddCLN: Single device name, length 1-32 characters.

Data segment at response:

CmdID	Data
0x16	Result\n

Result：0x00 represents execution success; 0x01 represents execution failure.

GET_CLN_FILTER¶

API Function:

Get the BLE device name filter table entry.

Data segment at reception:

CmdID	Data
0x17	/

Data is equal to null

Data segment at response:

CmdID	Data
0x17	Result\n	AddCLN0\n AddCLN1\n…\n

Result：0x00 represents execution success; 0x01 represents execution failure.
AddCLN: AddCLN0, AddCLN1 are single CLN, which will send all the data in the CLN filter table together.
CLN: BLE Complete Local Name.

SET_MSD_FILTER¶

API Function:

Add or remove BLE vendor custom data filter table entries.

Data segment on reception.

CmdID	Data
0x18	MODE\nAddMSD\n

MODE : 0x00 is Add mode which adds the AddMSD field to the device's BLE vendor custom data table; 0x01 is Delete mode which removes the AddMSD field from the BLE vendor custom data table.
AddMSD: single BLE vendor-defined data, length 2-64 characters, and length must be a multiple of 2, character range [0-9a-fA-F].

Data segment at response:

CmdID	Data
0x18	Result\n

Result：0x00 represents execution success; 0x01 represents execution failure.

GET_MSD_FILTER¶

API Function:

Get BLE vendor custom data filter table entries.

Data segment on reception.

CmdID	Data
0x19	/

Data is equal to null

Data segment at response:

CmdID	Data
0x19	Result\n	AddMSD0\n AddMSD1\n…\n

Result: 0x00 represents execution success; 0x01 represents execution failure.
AddMSD: AddMSD0, AddMSD1 are single MSD, which will send all the data in the MSD filter table together.
MSD: Manufacturer Specific Data.

UPDATE_MQTT_CERT¶

API functionality:

Update MQTT encryption certificate.

Data segment at reception:

CmdID	Data
0x1A	MODE\nMqttCertURL\n

MODE: 0x00 updates certificate immediately, 0x01 only saves certificate URL, and does not update certificate immediately. Occupies 1 character.
MQTT encrypted certificate URL address, length 1-500 characters.

Note: If the Data segment is null, the MqttCertURL will be restored to the default configuration, and the certificate will be updated.

Data segment at response:

CmdID	Data
0x1A	Result\n

Result: 0x00 represents execution success; 0x01 represents execution failure.

UPDATE_WPA2_CERT¶

API function:

Update Wi-Fi WPA2 encryption certificate.

Data segment at reception:

CmdID	Data
0x1B	MODE\nWpa2CertURL\n

MODE: 0x00 updates certificate immediately, 0x01 only saves certificate URL, and does not update certificate immediately. Occupies 1 character.
Wpa2CertURL: WPA2 encryption certificate URL address, length 1-500 characters.

Note: If the Data segment is null, the Wpa2CertURL will be restored to the default configuration, and the certificate will be updated.

Data segment at response:

CmdID	Data
0x1B	Result\n

Result: 0x00 represents execution success; 0x01 represents execution failure.

UPDATE_HTTPS_CERT¶

API functions:

Update HTTPS encryption certificate.

Data segment at reception:

CmdID	Data
0x1C	MODE\nHttpsCertURL\n

MODE: 0x00 updates certificate immediately, 0x01 only saves certificate URL, and does not update certificate immediately. Occupies 1 character.
HttpsCertURL: HTTPS encrypted certificate URL address, length 1-500 characters.

Note: If the Data segment is null, the HttpsCertURL will be restored to the default configuration, and the certificate will be updated.

Data segment at response:

CmdID	Data
0x1C	Result\n

Result: 0x00 represents execution success; 0x01 represents execution failure.

SET_OTA_URL¶

API function:

Set the OTA URL.

Data segment at reception:

CmdID	Data
0x1D	updateNow\nOtaURL\n

updateNow: whether to upgrade OTA immediately, occupies 1 byte, character '0' will save the URL and upgrade immediately, character '1' will only save the url without upgrading.
OtaURL: the server link for OTA upgrade, length 1-512 characters.

Note: If the Data segment is null, OtaURL will be restored to the default configuration, but will not trigger OTA.

Data segment at response:

CmdID	Data
0x1D	Result\n

Result: 0x00 represents execution success; 0x01 represents execution failure.

GET_OTA_URL¶

API Function:

Get the OTA URL.

Data segment at reception:

CmdID	Data
0x1E	/

Data is equal to null.

Data segment at response:

CmdID	Data
0x1E	Result\n	OtaURL\n

Result: 0x00 represents execution success; 0x01 represents execution failure.
OtaURL: the server link of OTA upgrade, length 1-512 characters.

OTA_STATUS¶

API function:

Reply result after OTA completion, initiated by the device after OTA completion.

Data segment at response:

CmdID	Data
0x1F	Result\n	/

Result：0x00 represents execution success; 0x01 represents execution failure.

GET_DEV_STATUS¶

API Function:

Get device Wi-Fi RSSI, networking status, server connection status.

Data segment at reception:

CmdID	Data
0x20	/

Data is equal to null

Data segment at response:

CmdID	Data
0x20	Result\n	WiFi_RSSI\nIS_CONNECT_NETWORK\nIS_CONNECT_SERVER\nWiFi_MODE\n

Result：0x00 represents execution success; 0x01 represents execution failure.
WiFi_RSSI: RSSI of the connected router, range -96 ~ 0, occupies 1 byte, signed character.
IS_CONNECT_NETWORK: network connection status 0x00 means not connected; 0x01 means connected.
IS_CONNECT_SERVER: MQTT server connection status 0x00 means not connected; 0x01 means connected.
WiFi_MODE: Wi-Fi connection mode [0x00 -> no password] [0x01 -> wpa2 personal encryption] [0x02 -> wpa2 enterprise encryption]

GET_DEV_MESSAGE¶

API Function:

Get device Wi-Fi MAC, BLE MAC, SN, Device ID, firmware version number.

Data segment at reception:

CmdID	Data
0x21	/

Data is equal to null

Data segment at response:

CmdID	Data
0x21	Result\n	BLE_MAC\nWiFi_MAC\nSN\nDevice_ID\nFirmwareVersion\n

Result: 0x00 represents execution success; 0x01 represents execution failure.
WiFi_MAC: Format XX:XX:XX:XX:XX:XX, XX range [0-9a-fA-F].
BLE_MAC: Format XX:XX:XX:XX:XX:XX:XX , XX range [0-9a-fA-F].
SN: Device SN code, length 16 characters.
Device_ID: device ID code, length 7 characters.
FirmwareVersion: firmware version number, length 0-32 characters.

RESTART_DEV¶

API function:

Reboot the device.

Data segment at reception:

CmdID	Data
0x22	/

Data is equal to null

Data segment at response:

CmdID	Data
0x22	Result\n

Result: 0x00 represents execution success; 0x01 represents execution failure.

RESET_DEV¶

API function:

Reset the device.

Data segment at reception:

CmdID	Data
0x23	/

Data is equal to null

Data segment at response:

CmdID	Data
0x23	Result\n

Result: 0x00 represents execution success; 0x01 represents execution failure.

SET_BLE_RSSI_FILTER¶

API function:

Set the BLE_RSSI filter threshold.

Data segment at reception:

CmdID	Data
0x24	BLERssiFilter\n

BLERssiFilter: char type Range -100 ~ 0. Default value: -100

Data segment at response:

CmdID	Data
0x24	Result\n

Result: 0x00 represents execution success; 0x01 represents execution failure.

GET_BLE_RSSI_FILTER¶

API Function:

Get the BLE_RSSI filter threshold.

Data segment at reception:

CmdID	Data
0x25	/

Data segment at response:

CmdID	Data
0x25	Result\n
		BLERssiFilter\n

Result: 0x00 represents execution success; 0x01 represents execution failure.
BLERssiFilter: char type Range -100 ~ 0.

GET_WiFi_AP_LIST¶

API Function:

Get the list of surrounding Wi-Fi AP information.

Data segment at reception:

CmdID	Data
0x26	/

Data segment at response:

CmdID	Data
0x26	Result\n	{ "WiFi_AP_LIST": [ {"SSID": "XXXX","RSSI":XXX,"authMode": X}, {"SSID": "XXXX","RSSI":XXX, "authMode":X}, {"SSID": "XXXX","RSSI": XXX, "authMode": X}, …… ] }

Result: 0x00 represents execution success; 0x01 represents execution failure.
SSID: router name, in string form, valid length 0-32
RSSI: Routing signal strength, numeric type, valid range -96 ~ 0.
AUTH_MODE: Routing encryption method, numeric type, valid range 0 ~ 7. See the following table for the meaning.

CmdID	Data
0	authenticate mode : open
1	authenticate mode : WEP
2	authenticate mode : WPA_PSK
3	authenticate mode : WPA2_PSK
4	authenticate mode : WPA_WPA2_PSK
5	authenticate mode : WPA2_ENTERPRISE
5	authenticate mode : WPA2_ENTERPRISE
6	authenticate mode : WPA3_PS
7	authenticate mode : WPA2_WPA3_PSK
-	default