RAK10702 Indoor Comfort Node AT Command Manual
To make it easy to set up the LoRaWAN credentials and LoRa P2P settings, an AT command interface over USB and BLE is implemented. The AT command format is compatible with the RUI3 AT Command interface with some exceptions because the used LoRaWAN stack is different from RUI3.
REMARK 1:
After changing the LoRaWAN parameters or LoRa P2P settings, the device must be reset by either the ATZ command or by pushing the reset button.
REMARK 2:
The Serial port connection is lost after the ATZ command or pushing the reset button. The connection must be re-established on the connected computer before log output can be seen or AT commands can be entered again.
REMARK 3: The Serial port is set up for 115200 baud, 8N1. It cannot be changed by AT commands.
AT Command Syntax
The AT command is based on ASCII characters. In general, the AT Command starts with the prefix AT and ends with <CR><LF> (i.e. \r\n). For the rest of the manual, the \r\n part is omitted for the sake of clarity.
The AT commands have the standard format AT+XXX with XXX denoting the command.
There are four available command formats:
| AT COMMAND FORMAT | Description |
|---|---|
AT+XXX? | Provides a short description of the given command |
AT+XXX=? | Reading the current value on the command |
AT+XXX=<input parameter> | Writing configuration on the command |
AT+XXX | Used to run a command |
The output of the commands is returned via UART.
The format of the reply is divided into two parts: returned value and the status return code.
<CR> stands for carriage return and <LF> stands for line feed.
-
<value><CR><LF>is the first reply whenAT+XXX?command description orAT+XXX=?reading value is executed, then it will be followed by the status return code. The formats with no return value likeAT+XXX=<input parameter>writing configuration command andAT+XXXrun command will just reply to the status return code. -
<CR><LF><STATUS><CR><LF>is the second part of the reply, which is the status return code.
The possible status codes are:
| STATUS RETURN CODE | Description |
|---|---|
OK | Command executed correctly without error. |
+CME ERROR:1 | Generic error or input is not supported. |
+CME ERROR:2 | Command not allowed. |
+CME ERROR:5 | The input parameter of the command is wrong. |
+CME ERROR:6 | The parameter is too long. |
+CME ERROR:8 | Value out of range. |
More details on each command description and examples are given in the remainder of this section.
Send Interval Setup
Description: Get and set the data send interval
This command allows the user to get the current device status.
| Command | Input Parameter | Return Value | Return Code |
|---|---|---|---|
ATC+SENDINT? | - | ATC+SENDINT: Send interval, Get or Set the automatic send interval | OK |
ATC+SENDINT=? | - | < interval > | OK |
ATC+SENDINT=<Input Parameter> | < interval in seconds > | - | OK or AT_PARAM_ERROR |
Examples:
atc+sendint?
AT+SENDINT:"Send interval, Get or Set the automatic send interval"
OK
atc+sendint=?
AT+SENDINT=600
OK
atc+sendint=600
OK
Set fPort
Description: fPort settings
This command allows the user to access and configure port settings.
| Command | Input Parameter | Return Value | Return Code |
|---|---|---|---|
ATC+PORT? | - | AT+PORT=<Port><CR>. Get or Set the Port | OK |
ATC+PORT=? | - | 1-223 | OK |
ATC+PORT=<Input Parameter> | 1-223 | - | OK or AT_PARAM_ERROR |
Examples:
ATC+PORT?
ATC+PORT: Get or Set the Port=[1..223]
OK
ATC+PORT=?
ATC+PORT:2
OK
ATC+PORT=2
OK
UI Selection
The default UI can be set with an AT command.
| Command | Input Parameter | Return Value | Return Code |
|---|---|---|---|
ATC+UI? | - | ATC+UI: Switch display UI, 0 = scientific, 1 = iconized | OK |
ATC+UI=? | - | <current UI> | OK |
ATC+UI=<Input Parameter> | <0 = scientific, 1 = iconized> | - | OK or +CME ERROR:6 |
Examples:
Check function
ATC+UI?
ATC+UI:"Switch display UI, 0 = scientific, 1 = iconized"
OK
Get current default
ATC+UI=?
1
OK
Set new default
ATC+UI=1
OK
Wrong selection
ATC+UI=3
+CME ERROR:6
RTC Setup
If the RAK12002 RTC module is used, an additional user AT command is available to set the RTC time and date.
| Command | Input Parameter | Return Value | Return Code |
|---|---|---|---|
ATC+RTC? | - | ATC+RTC: Get/Set RTC time and date | OK |
ATC+RTC=? | - | <date & time> | OK |
ATC+RTC=<Input Parameter> | <date & time> | - | OK or +CME ERROR:6 |
Examples:
Check function
ATC+RTC?
ATC+RTC:"Get/Set RTC time and date"
OK
Get time
ATC+RTC=?
2023.07.02 20:44:45
OK
Set time
ATC+RTC=2023:7:2:20:49
OK
Wrong time format
ATC+RTC=2023:7:2:25:61
+CME ERROR:6
CO2 Sensor Calibration
The SCD30 CO2 Sensor from Sensirion has a calibration function. If the sensor results are not within the expected range, the CO2 sensor can be calibrated with a value retrieved from a calibration device.
| Command | Input Parameter | Return Value | Return Code |
|---|---|---|---|
ATC+CO2? | - | ATC+CO2: Set CO2 calibration value, 400 ... 2000ppm | OK |
ATC+CO2=? | - | <calibration> | OK |
ATC+CO2=<Input Parameter> | <calibration> | - | OK or +CME ERROR:6 |
Examples:
Check function
ATC+CO2?
ATC+CO2:"Set CO2 calibration value, 400 ... 2000ppm"
OK
Get current calibration value
ATC+CO2=?
400
OK
Set new calibration value
ATC+CO2=400
OK
Wrong calibration value
ATC+CO2=2300
+CME ERROR:6
Differences to RUI3 AT commands
As the firmware of the RAK10702 Indoor Comfort Node is not based on RUI3, the following AT commands are not supported or have a different behaviour:
| RUI3 AT command | Remark |
|---|---|
AT+BOOT | Restarts device in Arduino bootloader mode with DFU/UF2 mode |
AT+BUILDTIME | Returns the build time of the application, not the RUI3 build time |
AT+CLIVER | Returns fixed version 1.5.8, not the RUI3 CLI version |
AT+APIVER | Returns fixed version 3.2.3, not the RUI3 API version |
AT+SN | Returns the MCU unique ID, cannot be changed |
AT+NETID | Returns always 0, cannot be changed |
AT+LPM | RUI3 low power mode is not supported |
AT+DCS | Returns the current duty cycle setting, cannot be changed |
AT+PNM | Returns the current network selection, cannot be changed |
AT+CHE | Returns the current network selection, cannot be changed |
AT+CHS | Returns the current network selection, cannot be changed |
AT+JN1DL | Returns the current delay, cannot be changed |
AT+JN2DL | Returns the current delay, cannot be changed |
AT+RX1DL | Returns the current delay, cannot be changed |
AT+RX2DL | Returns the current delay, cannot be changed |
AT+RX2DR | Returns the current delay, cannot be changed |
AT+RX2FQ | Returns the current delay, cannot be changed |
AT+ARSSI | Returns the only last data RSSI, not all channels |
AT+LINKCHECK | Returns always 0 |
AT+LSTMULC | Returns always no multicast channels defined |
Appendix
Appendix I Data Rate by Region
EU433/EU868/RU864/AS923| Data Rate | Configuration | Indicative Physical Bit Rate [bit/s] |
|---|---|---|
| 0 | LoRa: SF12 / 125 kHz | 250 |
| 1 | LoRa: SF11 / 125 kHz | 440 |
| 2 | LoRa: SF10 / 125 kHz | 980 |
| 3 | LoRa: SF9 / 125 kHz | 1760 |
| 4 | LoRa: SF8 / 125 kHz | 3125 |
| 5 | LoRa: SF7 / 125 kHz | 5470 |
| 6 | LoRa: SF7 / 250 kHz | 11000 |
| 7 | FSK: 50 kbps | 50000 |
| 8 ~ 15 | RFU |
| Data Rate | Configuration | Indicative Physical Bit Rate [bit/s] |
|---|---|---|
| 0 | LoRa: SF12 / 125 kHz | 250 |
| 1 | LoRa: SF11 / 125 kHz | 440 |
| 2 | LoRa: SF10 / 125 kHz | 980 |
| 3 | LoRa: SF9 / 125 kHz | 1760 |
| 4 | LoRa: SF8 / 125 kHz | 3125 |
| 5 | LoRa: SF7 / 125 kHz | 5470 |
| 6 ~ 15 | RFU |
| Data Rate | Configuration | Indicative Physical Bit Rate [bit/s] |
|---|---|---|
| 0 | LoRa: SF10 / 125 kHz | 980 |
| 1 | LoRa: SF9 / 125 kHz | 1760 |
| 2 | LoRa: SF8 / 125 kHz | 3125 |
| 3 | LoRa: SF7 / 125 kHz | 5470 |
| 4 | LoRa: SF8 / 500 kHz | 12500 |
| 5 ~ 7 | RFU | |
| 8 | LoRa: SF12 / 500 kHz | 980 |
| 9 | LoRa: SF11 / 500 kHz | 1760 |
| 10 | LoRa: SF10 / 500 kHz | 3900 |
| 11 | LoRa: SF9 / 500 kHz | 7000 |
| 12 | LoRa: SF8 / 500 kHz | 12500 |
| 13 | LoRa: SF7 / 500 kHz | 21900 |
| 14 ~ 15 | RFU |
| Data Rate | Configuration | Indicative Physical Bit Rate [bit/s] |
|---|---|---|
| 0 | LoRa: SF12 / 125 kHz | 250 |
| 1 | LoRa: SF11 / 125 kHz | 440 |
| 2 | LoRa: SF10 / 125 kHz | 980 |
| 3 | LoRa: SF9 / 125 kHz | 1760 |
| 4 | LoRa: SF8 / 125 kHz | 3125 |
| 5 | LoRa: SF7 / 125 kHz | 5470 |
| 6 | LoRa: SF8 / 500 kHz | 12500 |
| 7 | RFU | RFU |
| 8 | LoRa: SF12 / 500 kHz | 980 |
| 9 | LoRa: SF11 / 500 kHz | 1760 |
| 10 | LoRa: SF10 / 500 kHz | 3900 |
| 11 | LoRa: SF9 / 500 kHz | 7000 |
| 12 | LoRa: SF8 / 500 kHz | 12500 |
| Data Rate | Configuration | Indicative Physical Bit Rate [bit/s] |
|---|---|---|
| 0 | LoRa: SF12 / 125 kHz | 250 |
| 1 | LoRa: SF11 / 125 kHz | 440 |
| 2 | LoRa: SF10 / 125 kHz | 980 |
| 3 | LoRa: SF9 / 125 kHz | 1760 |
| 4 | LoRa: SF8 / 125 kHz | 3125 |
| 5 | LoRa: SF7 / 125 kHz | 5470 |
| 6 | RFU | RFU |
| 7 | FSK: 50 kbps | 50000 |
| 8 ~ 15 | RFU | RFU |
Appendix II TX Power by Region
EU868By default, MaxEIRP is considered to be +16 dBm.
| TXPower | Configuration (EIRP) |
|---|---|
| 0 | MaxEIRP |
| 1 | MaxEIRP - 2 dB |
| 2 | MaxEIRP - 4 dB |
| 3 | MaxEIRP - 6 dB |
| 4 | MaxEIRP - 8 dB |
| 5 | MaxEIRP - 10 dB |
| 6 | MaxEIRP - 12 dB |
| 7 | MaxEIRP - 14 dB |
| 8 ~ 15 | RFU |
| TXPower | Configuration (Conducted Power) |
|---|---|
| 0 | 30 dBm - 2*TXpower |
| 1 | 28 dBm |
| 2 | 26 dBm |
| 3 ~ 9 | - |
| 10 | 10 dBm |
| 11 ~ 15 | RFU |
By default, MaxEIRP is considered to be +30 dBm.
| TXPower | Configuration (EIRP) |
|---|---|
| 0 | MaxEIRP |
| 1 ~ 10 | MaxEIRP - 2*TXPower |
| 11 ~ 10 | RFU |
By default, MaxEIRP is considered to be +14 dBm.
| TXPower | Configuration (EIRP) |
|---|---|
| 0 | MaxEIRP |
| 1 | MaxEIRP - 2 dB |
| 2 | MaxEIRP - 4 dB |
| 3 | MaxEIRP - 6 dB |
| 4 | MaxEIRP - 8 dB |
| 5 | MaxEIRP - 10 dB |
| 6 | MaxEIRP - 12 dB |
| 7 | MaxEIRP - 14 dB |
| 8 ~ 15 | RFU |
By default, Max EIRP is considered to be 16 dBm.
| TXPower | Configuration (EIRP) |
|---|---|
| 0 | MaxEIRP |
| 1 | MaxEIRP - 2 dB |
| 2 | MaxEIRP - 4 dB |
| 3 | MaxEIRP - 6 dB |
| 4 | MaxEIRP - 8 dB |
| 5 | MaxEIRP - 10 dB |
| 6 | MaxEIRP - 12 dB |
| 7 | MaxEIRP - 14 dB |
| 8 ~ 15 | RFU |
By default, MaxEIRP is considered to be 30 dBm.
| TXPower | Configuration (EIRP) |
|---|---|
| 0 | MaxEIRP |
| 1 | MaxEIRP - 2 dB |
| 2 | MaxEIRP - 4 dB |
| 3 | MaxEIRP - 6 dB |
| 4 | MaxEIRP - 8 dB |
| 5 | MaxEIRP - 10 dB |
| 6 | MaxEIRP - 12 dB |
| 7 | MaxEIRP - 14 dB |
| 8 | MaxEIRP - 16 dB |
| 9 | MaxEIRP - 18 dB |
| 10 | MaxEIRP - 20 dB |
| 11 ~ 15 | RFU |
By default, MaxEIRP is considered to be +16 dBm.
| TXPower | Configuration (EIRP) |
|---|---|
| 0 | MaxEIRP |
| 1 | MaxEIRP - 2 dB |
| 2 | MaxEIRP - 4 dB |
| 3 | MaxEIRP - 6 dB |
| 4 | MaxEIRP - 8 dB |
| 5 | MaxEIRP - 10 dB |
| 6 | MaxEIRP - 12 dB |
| 7 | MaxEIRP - 14 dB |
| 8 ~ 15 | RFU |
By default, MaxEIRP is considered to be +19.15 dBm.
| TXPower | Configuration (EIRP) |
|---|---|
| 0 | MaxEIRP |
| 1 | MaxEIRP 2 dB |
| 2 | MaxEIRP 4 dB |
| 3 | MaxEIRP 6 dB |
| 4 | MaxEIRP 8 dB |
| 5 | MaxEIRP - 10 dB |
| 6 | MaxEIRP - 12 dB |
| 7 | MaxEIRP - 14 dB |
| 8 ~ 15 | RFU |
By default, MAxEIRP is considered to be +12.15 dBm.
| TXPower | Configuration (EIRP) |
|---|---|
| 0 | MaxEIRP |
| 1 | MaxEIRP - 2 dB |
| 2 | MaxEIRP - 4 dB |
| 3 | MaxEIRP - 6 dB |
| 4 | MaxEIRP - 8 dB |
| 5 | MaxEIRP - 10 dB |
| 6 ~ 15 | RFU |
Appendix III Maximum Transmission Load by Region
M in the following list is the length with MAC header, N is the maximum usable payload size for the user data without MAC header.
EU868| Data Rate | M | N |
|---|---|---|
| 0 | 59 | 51 |
| 1 | 59 | 51 |
| 2 | 59 | 51 |
| 3 | 123 | 115 |
| 4 | 250 | 242 |
| 5 | 250 | 242 |
| 6 | 250 | 242 |
| 7 | 250 | 242 |
| 8 ~ 15 | Not Defined | Not Defined |
| Data Rate | M | N |
|---|---|---|
| 0 | 19 | 11 |
| 1 | 61 | 53 |
| 2 | 133 | 125 |
| 3 | 250 | 242 |
| 4 | 250 | 242 |
| 5 ~ 7 | Not Defined | Not Defined |
| 8 | 61 | 53 |
| 9 | 137 | 129 |
| 10 | 250 | 242 |
| 11 | 250 | 242 |
| 12 | 250 | 242 |
| 13 | 250 | 242 |
| 14 ~ 15 | Not Defined | Not Defined |
| Data Rate | M | N |
|---|---|---|
| 0 | 59 | 51 |
| 1 | 59 | 51 |
| 2 | 59 | 51 |
| 3 | 123 | 115 |
| 4 | 250 | 242 |
| 5 | 250 | 242 |
| 6 | 250 | 242 |
| 7 | Not Defined | Not Defined |
| 8 | 61 | 53 |
| 9 | 137 | 129 |
| 10 | 250 | 242 |
| 11 | 250 | 242 |
| 12 | 250 | 242 |
| 13 | 250 | 242 |
| 14 ~ 15 | Not Defined | Not Defined |
| Data Rate | M | N |
|---|---|---|
| 0 | 59 | 51 |
| 1 | 59 | 51 |
| 2 | 59 | 51 |
| 3 | 123 | 115 |
| 4 | 250 | 242 |
| 5 | 250 | 242 |
| 6 ~ 15 | Not Defined | Not Defined |
| Data Rate | Uplink MAC Payload Size (M) | Downlink MAC Payload Size (M) | ||
|---|---|---|---|---|
| UplinkDwellTime = 0 | UplinkDwellTime = 1 | DownlinkDwellTime = 0 | DownlinkDwellTime = 1 | |
| 0 | 59 | N/A | 59 | N/A |
| 1 | 59 | N/A | 59 | N/A |
| 2 | 59 | 19 | 59 | 19 |
| 3 | 123 | 61 | 123 | 61 |
| 4 | 250 | 133 | 250 | 133 |
| 5 | 250 | 250 | 250 | 250 |
| 6 | 250 | 250 | 250 | 250 |
| 7 | 250 | 250 | 250 | 250 |
| 8 | RFU | RFU | ||
| Data Rate | M | N |
|---|---|---|
| 0 | 59 | 51 |
| 1 | 59 | 51 |
| 2 | 59 | 51 |
| 3 | 123 | 115 |
| 4 | 250 | 242 |
| 5 | 250 | 242 |
| 6 | 250 | 242 |
| 7 | 250 | 242 |
| 8 ~ 15 | Not Defined | Not Defined |
| Data Rate | M | N |
|---|---|---|
| 0 | 59 | 51 |
| 1 | 59 | 51 |
| 2 | 59 | 51 |
| 3 | 123 | 115 |
| 4 | 230 | 222 |
| 5 | 230 | 222 |
| 6 | 230 | 222 |
| 7 | 230 | 222 |
| 8 ~ 15 | Not Defined | Not Defined |
| Data Rate | M | N |
|---|---|---|
| 0 | 59 | 51 |
| 1 | 59 | 51 |
| 2 | 59 | 51 |
| 3 | 123 | 115 |
| 4 | 250 | 242 |
| 5 | 250 | 242 |
| 6 ~ 15 | Not Defined | Not Defined |
| Data Rate | M | N |
|---|---|---|
| 0 | 59 | 51 |
| 1 | 59 | 51 |
| 2 | 59 | 51 |
| 3 | 123 | 115 |
| 4 | 250 | 242 |
| 5 | 250 | 242 |
| 6 | 250 | 242 |
| 7 | 250 | 242 |
| 8 ~ 15 | Not Defined | Not Defined |
