![]() |
RUI3 (RAK Unified Interface 3) - RAK4631
|
This command allows the user to access the version of the bootloader. (bootloader only)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+VER=? | – | RUI nRF52840 Bootloader v0.6 | OK |
This command allows the user to access the version of the bootloader. (bootloader only)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+VERSION | – | RUI nRF52840 Bootloader v0.6 | OK |
This command gets the status of the bootloader. (bootloader only)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+BOOTSTATUS | – | Boot Mode | OK |
This command leaves bootloader and boot into application. (bootloader only)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+RUN | – | Stop Boot Mode | – |
This command resets device. (bootloader only)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+RESET | – | – | – |
This section provides a set of certification commands.
This command is used to start the RF RSSI tone test of the device
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+TRSSI? | – | AT+TRSSI: start RF RSSI tone test | OK |
AT+TRSSI | – | – | OK / AT_BUSY_ERROR |
Example AT+TRSSI | – | – | OK |
This command is used to start the RF tone test of the device
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+TTONE? | – | AT+TTONE: start RF tone test | OK |
AT+TTONE | – | – | OK / AT_BUSY_ERROR |
Example AT+TTONE | – | – | OK |
This command is used to set the number of packets to be sent for a PER RF TX test
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+TTX? | – | AT+TTX: set number of packets to be sent for PER RF TX test | OK |
AT+TTX=<input> | <integer> | – | OK / AT_BUSY_ERROR |
Example AT+TTX= | 3 | – | OK |
This command is used to set the number of packets to be received for a PER RF TX test
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+TRX? | – | AT+TRX: set number of packets to be received for PER RF RX test | OK |
AT+TRX=<input> | <integer> | – | OK / AT_BUSY_ERROR |
Example AT+TRX= | 3 | – | OK |
This command is used to access and set LoRa configuration test
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+TCONF? | – | AT+TCONF: configure LoRa RF test | OK |
AT+TCONF=<input> | <Freq>:<Power>:<Bandwidth>:<SpreadingFactor>:<CodingRate>:<LNA>:<PABoost>:<Modulation>:<PayloadLen>:<FskDeviation>:<LowDRopt>:<BTproduct> | – | OK / AT_BUSY_ERROR |
Example AT+TCONF= | AT+TCONF=868000000:14:4:12:0:0:0:1:16:25000:2:3 | – | OK |
<freq>
<power> : output power [dBm]
<bw> : bandwidth. (LoRa mode in Khz) 0=125, 1=250, 2=500, 3=7.8, 4=10.4, 5=15.63, 6=20.83, 7=31.25, 8=41.67, 9=62.5; (FSK mode in Hz): 4800-467000
<sf> : datarate. FSK : 600..300000 bits/s; LoRa: [5-12]
<cr> : coding rate (LoRa only). FSK : N/A ( set to 0 ); LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
<lna> : not implemented yet
<pa_boost> : not implemented yet
<mod> : radio modem to be used [0: FSK, 1: LoRa]
<len> : payload length when fixed length is used
<fdev> : Freq deviation (only fsk 600 - 200000 Hz)
<lowdropt> : not implemented yet
<bt> : not implemented yet
This command is used to access and configure RF Tx hopping test.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+TTH? | – | AT+TTH: start RF TX hopping test from Fstart to Fstop, with Fdelta steps | OK |
AT+TTH=<input> | <Fstart>:<Fstop>:<Fdelta>:<PacketNb> | – | OK / AT_BUSY_ERROR |
Example AT+TTH= | 868000000:868300000,100000,4 | – | OK |
This command is used to stop the ongoing RF test.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+TOFF? | – | AT+TOFF: stop ongoing RF test | OK |
AT+TOFF | – | – | OK / AT_BUSY_ERROR |
Example AT+TOFF | – | – | OK |
This command set the module in LoraWAN certification mode
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+CERTIF? | – | AT+CERTIF: set the module in LoraWAN certification mode (0 = normal mode, 1 = certification mode)) | OK |
AT+CERTIF=? | – | 0 or 1 | OK |
AT+CERTIF=<Input> | 0 or 1 | OK / AT_PARAM_ERROR | |
Example AT+CERTIF= | 1 | – | OK |
Example AT+CERTIF=? | 1 | OK |
This command is used to enable continuous RF tranmissions with configurable frequency, transmit power and duration
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+CW? | – | AT+CW: start continuous wave | OK |
AT+CW=<input> | <freq>:<power>:<time> | – | OK / AT_BUSY_ERROR |
Example AT+CW | – | – | OK |
<freq> : RAK3172(L) is needed to use the low frequency range 150000000 - 600000000; RAK3172(H) is needed to use the high frequency range 600000000 - 960000000
<power> : 5 - 22 dBm
<time> : 0 - 65535 ms
This command is used to access and configure RF Tx hopping test in random sequence.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+TRTH? | – | AT+TRTH: start RF TX hopping test from Fstart to Fstop, with Fdelta interval in random sequence | OK |
AT+TRTH=<input> | <Fstart>:<Fstop>:<Fdelta>:<PacketNb> | – | OK / AT_BUSY_ERROR |
Example AT+TRTH= | 868000000:868300000,100000,4 | – | OK |
This section provides a set of commands for Class B mode management
This command allows the user to set or to get the unicast ping slot periodicity.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+PGSLOT? | – | AT+PGSLOT: get or set the unicast ping slot periodicity (0-7) | OK |
AT+PGSLOT=? | – | 0, 1, 2, 3, 4, 5, 6 or 7 | OK |
AT+PGSLOT=<Input> | 0, 1, 2, 3, 4, 5, 6 or 7 | – | OK / AT_PARAM_ERROR |
Example AT+PGSLOT= | 1 | – | OK |
Example AT+PGSLOT=? | – | 2 | OK |
This command allows the user to access the current beacon (default broadcast) frequency.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+BFREQ? | – | AT+BFREQ: get the data rate and beacon frequency (MHz) | OK |
AT+BFREQ=? | – | BCON: <0,1,2,3,4,5,6 or 7>, <float> | OK |
Example AT+BFREQ=? | – | BCON: 3, 869.525 | OK |
This command allows the user to access the current beacon time.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+BTIME? | – | AT+BTIME: get the beacon time (seconds since GPS Epoch time) | OK |
AT+BTIME=? | – | BTIME: <integer> | OK |
Example AT+BTIME=? | – | BTIME: 1226592311 | OK |
This command allows the user to access the gateway GPS coordinate, NetID and GwID.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+BGW? | – | AT+BGW: get the gateway GPS coordinate, NetID and GwID | OK |
AT+BGW=? | – | BGW: <INFO>, <netid>, <gwid>, <longitude>, <latitude> | OK |
This command allows the user to access the local time in UTC format.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+LTIME? | – | AT+LTIME: get the local time | OK |
AT+LTIME=? | – | LTIME: <HOUR>h<MINUTE>m<SECOND>s <YEAR>-<MONTH>-<DAY> | OK |
Example AT+LTIME=? | – | LTIME: 00h37m58s 2018-11-14 | OK |
This section describes the commands related to attention, reset, restore to default, device firmware upgrade, echo, FW version, battery level, etc.
This command is used to check that the link is working properly.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT | – | – | OK |
This command provides short help for all the supported commands.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT? | – | AT+<CMD>?: help on <CMD> AT+<CMD>: run <CMD> AT+<CMD>=<value>: set the value AT+<CMD>=?: get the value <followed by the help of all commands> | OK |
This command is used to trig a MCU reset.
Command | Input parameter | Return value | Return code |
---|---|---|---|
ATZ? | – | ATZ: triggers a reset of the MCU | OK |
ATZ | – | – | – |
This command is used to restore all parameters to the initial default values. MCU will reset after restore the initial default values.
Command | Input parameter | Return value | Return code |
---|---|---|---|
ATR? | – | ATR: restore default parameters | OK |
ATR | – | – | OK / AT_PARAM_ERROR / AT_BUSY_ERROR / AT_ERROR |
Example ATR | – | – | OK |
This command is used to enter Bootloader mode to upgrade firmware.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+BOOT? | – | AT+BOOT: enter bootloader mode for firmware upgrade | OK |
AT+BOOT | – | – | – |
This command is used to show or hide the AT command input.
Command | Input parameter | Return value | Return code |
---|---|---|---|
ATE? | – | ATE: show or hide the AT command input | OK |
ATE | – | – | – |
This command allows the user to access the serial number of the device.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+SN? | – | AT+SN: get the serial number of the device (max 18 char) | OK |
AT+SN=? | – | <1-18 char> | OK |
This command allows the user to access the battery level.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+BAT? | – | AT+BAT: get the battery level (volt) | OK |
AT+BAT=? | – | <float> | OK |
Example AT+BAT=? | – | 3.000000 | OK |
This command allows the user to access the build time of the firmware.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+BUILDTIME? | – | AT+BUILDTIME: get the build time of the firmware | OK |
AT+BUILDTIME=? | – | <string>-<string> | OK |
Example AT+BUILDTIME=? | – | 20220324-153217 | OK |
This command allows the user to access the commit ID of the firmware.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+REPOINFO? | – | AT+REPOINFO: get the commit ID of the firmware | OK |
AT+REPOINFO=? | – | <string>:<string>:<string>:<string>:<string>:<string>:<string>:<string>, | OK |
Example AT+REPOINFO=? | – | 713fbcca:6ecbb45f:e198f620:b43f5395:4a6defb9:c9438443:5ccb8eec:70e5bb3f | OK |
This command allows the user to access the version of the firmware.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+VER? | – | AT+VER: get the version of the firmware | OK |
AT+VER=? | – | <string> | OK |
Example AT+VER=? | – | 1.0.0 | OK |
This command allows the user to access the version of the AT command.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+CLIVER? | – | AT+CLIVER: get the version of the AT command | OK |
AT+CLIVER=? | – | <string> | OK |
Example AT+CLIVER=? | – | 1.0.0 | OK |
This command allows the user to access the version of the RUI API.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+APIVER? | – | AT+APIVER: get the version of the RUI API | OK |
AT+APIVER=? | – | <string> | OK |
Example AT+APIVER=? | – | 1.0.0 | OK |
This command allows the user to access the string of the hardware model.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+HWMODEL? | – | AT+HWMODEL: get the string of the hardware model | OK |
AT+HWMODEL=? | – | <string> | OK |
Example AT+HWMODEL=? | – | rak4631 | OK |
This command allows the user to access the string of the hardware ID.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+HWID? | – | AT+HWID: get the string of the hardware ID | OK |
AT+HWID=? | – | <string> | OK |
Example AT+HWID=? | – | nrf52840 | OK |
This command allows the user to set an alias name for device.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+ALIAS? | – | AT+ALIAS: add an alias name to the device | OK |
AT+ALIAS=? | – | <string, 16 char> | OK |
AT+ALIAS=<Input> | <string,16 char> | – | OK / AT_PARAM_ERROR / AT_ERROR |
Example AT+ALIAS= | mydevice | – | OK |
Example AT+ALIAS=? | – | mydevice | OK |
This command allows the user to get the System Voltage.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+SYSV? | – | AT+SYSV: get the System Voltage | OK |
AT+SYSV=? | – | <float> | OK |
Example AT+SYSV=? | – | 3.0 | OK |
This command allows the user to get or set the BLE Mac address
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+BLEMAC? | – | AT+BLEMAC: get or set the BLE Mac address | OK |
AT+BLEMAC=? | – | <string>:<string>:<string>:<string>:<string>:<string> | OK |
AT+BLEMAC=<Input> | <string,12 char> | <string> | OK |
Example AT+BLEMAC=? | – | dc:a1:26:1e:e6:84 | OK |
Example AT+BLEMAC= | ffffffffffff | – | OK |
This command allows the user to get the version of RUI Bootloader
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+BOOTVER? | – | AT+BOOTVER: get the version of RUI Bootloader | OK |
AT+BOOTVER=? | – | <string> | OK |
Example AT+BOOTVER=? | – | RUI STM32WLE5CC Bootloader v0.5 | OK |
This section provides a set of commands for battery level, RF signal quality and FW version.
This command allows the user to access the RSSI on reception.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+RSSI? | – | AT+RSSI: get the RSSI of the last received packet | OK |
AT+RSSI=? | – | <interger> | OK |
Example AT+RSSI=? | – | -31 | OK |
This command access all open channel rssi
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+ARSSI? | – | AT+ARSSI: access all open channel RSSI | OK |
AT+ARSSI=? | – | OK | |
Example AT+ARSSI=? | 0,-16 1,-18 2,-30 | OK |
This command allows the user to access the SNR of the last received packet.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+SNR? | – | AT+SNR: get the SNR of the last received packet | OK |
AT+SNR=? | – | <interger> | OK |
Example AT+SNR=? | – | 32 | OK |
This section gives description of the commands related to the join procedure and to the data path.
This command allows the user to access the notification on received data coming from network.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+CFM? | – | AT+CFM: get or set the confirm mode (0 = off, 1 = on) | OK |
AT+CFM=? | – | 0 or 1 | OK |
AT+CFM=<Param> | 0 or 1 | – | OK / AT_PARAM_ERROR |
Example AT+CFM= | 1 | – | OK |
Example AT+CFM=? | 1 | OK |
This command allows the user to access the status of the last "SEND" command
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+CFS? | – | AT+CFS: get the confirmation status of the last AT+SEND (0 = failure, 1 = success) | OK |
AT+CFS=? | – | 0 or 1 | OK |
Example AT+CFS=? | 0 | OK |
This command does a join request to the network.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+JOIN? | – | AT+JOIN: join network | OK |
AT+JOIN=? | – | <integer1>,<integer2>,<integer3>,<integer4> | OK / AT_BUSY_ERROR |
AT+JOIN=<input> | <integer1>:<integer2>:<integer3>:<integer4> | – | OK / AT_BUSY_ERROR |
Example AT+JOIN=? | – | 0,0,8,0 | OK |
Example AT+JOIN= | 1,1,10,8 | – | OK |
<integer1> represents manually join network: 0 means stop to join network; 1 means start to join network. The default value is 0.
<integer2> represents automatically join network: 0 means stop automatically joining network; 1 means start automatically joining network. The default value is 0.
<integer3> represents the join attempt period. The acceptance values are 7 to 255 (in seconds). The default value is 8.
<integer4> represents the maximum number of join attempts. The acceptance values are 0 to 255 (in seconds). The default value is 0.
This is an asynchronous command. OK means that the join is being run. The completion of the JOIN can be verified with AT+NJS=?.
This command allows the user to access the network join mode.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+NJM? | – | AT+NJM: get or set the network join mode (0 = ABP, 1 = OTAA) | OK |
AT+NJM=? | – | 0 or 1 | OK |
AT+NJM=<input> | 0 or 1 | – | OK / AT_PARAM_ERROR |
Example AT+NJM= | 1 | – | OK |
Example AT+NJM= | 2 | – | AT_PARAM_ERROR |
Example AT+NJM=? | 1 | OK |
This command allows the user to access the current status of the LoRa link.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+NJS? | – | AT+NJS: get the join status (0 = not joined, 1 = joined) | OK |
AT+NJS=? | – | 0 or 1 | OK |
Example AT+NJS=? | 0 (network not joined) | OK | |
Example AT+NJS=? | 1 (network joined) | OK |
This command allows the user to access the last received data in hex format.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+RECV? | – | AT+RECV: : print the last received data in hex format | OK |
AT+RECV=? | – | Raw (HEX) | OK |
Example AT+RECV=? | 45:112233 | OK |
This command provides the way to send data on a dedicated port number.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+SEND? | – | AT+SEND: send data along with the application port | OK |
AT+SEND=<input> | <port>:<payload> | OK / AT_PARAM_ERROR / AT_BUSY_ERROR / AT_NO_NETWORK_JOINED | |
Example AT+SEND= | 12:112233 | OK |
This command provides the way to send long packet data
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+LPSEND? | – | AT+LPSEND: send long packet data (max 1024 bytes) | OK |
AT+LPSEND=<port>:<ack>:<payload> | <port>:<ack>:<payload> | OK / AT_PARAM_ERROR | |
Example AT+LPSEND= | 2:1:123456 | – | OK |
This command configure the number of retransmission of confirm packet data.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+RETY? | – | AT+RETY: get or set the number of retransmission of confirm packet data | OK |
AT+RETY=<input> | [0,1,2,3,4,5,6, | OK / AT_PARAM_ERROR | |
Example AT+RETY= | 2 | OK |
This section describes the commands related to the activation of the end device. EUIs and Keys are MSB first.
This command allows the user to access the global application identifier.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+APPEUI? | – | AT+APPEUI: get or set the application EUI (8 bytes in hex) | OK |
AT+APPEUI=? | – | <8 hex> | OK |
AT+APPEUI=<Param> | <8 hex> | – | OK / AT_PARAM_ERROR |
Example AT+APPEUI= | 0102030405060708 | – | OK |
Example AT+APPEUI= | 010203040506070809 | – | AT_PARAM_ERROR |
Example AT+APPEUI=? | 0102030405060708 | OK |
This command allows the user to access the application key.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+APPKEY? | – | AT+APPKEY: get or set the application key (16 bytes in hex) | OK |
AT+APPKEY=? | – | <16 hex> | OK |
AT+APPKEY=<Param> | <16 hex> | – | OK / AT_PARAM_ERROR |
Example AT+APPKEY= | 0102030405060708090A0B0C0D0E0F00 | – | OK |
Example AT+APPKEY= | 010203040506070809 | – | AT_PARAM_ERROR |
Example AT+APPKEY=? | 0102030405060708090A0B0C0D0E0F00 | OK |
This command allows the user to access the application session key.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+APPSKEY? | – | AT+APPSKEY: get or set the application session key (16 bytes in hex) | OK |
AT+APPSKEY=? | – | <16 hex> | OK |
AT+APPSKEY=<Param> | <16 hex> | – | OK / AT_PARAM_ERROR |
Example AT+APPSKEY= | 0102030405060708090A0B0C0D0E0F00 | – | OK |
Example AT+APPSKEY= | 010203040506070809 | – | AT_PARAM_ERROR |
Example AT+APPSKEY=? | 0102030405060708090A0B0C0D0E0F00 | OK |
This command allows the user to access the device address.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+DEVADDR? | – | AT+DEVADDR: get or set the device address (4 bytes in hex) | OK |
AT+DEVADDR=? | – | <4 hex> | OK |
AT+DEVADDR=<Param> | <4 hex> | – | OK / AT_PARAM_ERROR |
Example AT+DEVADDR= | 01020304 | – | OK |
Example AT+DEVADDR= | 0102030405 | – | AT_PARAM_ERROR |
Example AT+DEVADDR=? | 01020304 | OK |
This command allows the user to access the global end-device ID.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+DEVEUI? | – | AT+DEVEUI: get or set the device EUI (8 bytes in hex) | OK |
AT+DEVEUI=? | – | <8 hex> | OK |
AT+DEVEUI=<Param> | <8 hex> | – | OK / AT_PARAM_ERROR |
Example AT+DEVEUI= | 0102030405060708 | – | OK |
Example AT+DEVEUI= | 010203040506070809 | – | AT_PARAM_ERROR |
Example AT+DEVEUI=? | 0102030405060708 | OK |
This command allows the user to access the network identifier (NetID) of 3 octets.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+NETID? | – | AT+NETID: get the network identifier (NetID) (3 bytes in hex) | OK |
AT+NETID=? | – | <3 hex> | OK |
AT+NETID=<Param> | <3 hex> | – | OK / AT_PARAM_ERROR |
Example AT+NETID=? | 010203 | OK |
This command allows the user to access the network session key.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+NWKSKEY? | – | AT+NWKSKEY: get or set the network session key (16 bytes in hex) | OK |
AT+NWKSKEY=? | – | <16 hex> | OK |
AT+NWKSKEY=<Param> | <16 hex> | – | OK / AT_PARAM_ERROR |
Example AT+NWKSKEY= | 0102030405060708090A0B0C0D0E0F00 | – | OK |
Example AT+NWKSKEY= | 010203040506070809 | – | AT_PARAM_ERROR |
Example AT+NWKSKEY=? | 0102030405060708090A0B0C0D0E0F00 | OK |
This command allows the user to get the mc root key.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+MCROOTKEY? | – | AT+APPKEY: get the mc root key (16 bytes in hex) | OK |
AT+MCROOTKEY=? | – | <16 hex> | OK |
This section provides a set of multicast group commands.
This command add a new multicast group to configure multicast parameters.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+ADDMULC? | – | AT+ADDMULC: add a new multicast group | OK |
AT+ADDMULC=<Input> | <Class>:<Dev Addr>:<Nwk SKey>:<App SKey>:<Freq>:<DR>:<Periodicity> | OK / AT_PARAM_ERROR | |
Example AT+ADDMULC= | B:01020304:0102030405060708:0102030405060708:868000000:0:0 | – | OK |
This command allows the remove of a configured multicast group.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+RMVMULC? | – | AT+RMVMULC: delete a multicast group | OK |
AT+RMVMULC=<Input> | <Dev addr>=""> | – | OK / AT_PARAM_ERROR |
Example AT+RMVMULC= | 01020304 | – | OK |
This command can view all the current configured multicast group information.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+LSTMULC? | – | AT+LSTMULC: view multicast group information | OK |
AT+LSTMULC=<Input> | – | MC1:<Class>:<Dev Addr>:<Nwk SKey>:<App SKey>:<Freq>:<DR>:<Periodicity> | OK |
Example AT+LSTMULC= | – | MC1:C:01020304:0102030405060708:0102030405060708:868000000:0:0 MC2:C:01020304:0102030405060708:0102030405060708:868000000:0:0 | OK |
This section provides a set of commands for network management.
This command allows the user to access the adaptive data rate.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+ADR? | – | AT+ADR: get or set the adaptive data rate setting 0 = off 1 = on | OK |
AT+ADR=? | – | 0 or 1 | OK |
AT+ADR=<Input> | 0 or 1 | – | OK / AT_PARAM_ERROR |
Example AT+ADR= | 0 | – | OK |
Example AT+ADR=? | – | 0 | OK |
This command allows the user to access the LoRaWAN class.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+CLASS? | – | AT+CLASS: get or set the device class (A = class A, B = class B, C = class C) | OK |
AT+CLASS=? | – | A, B or C | OK |
AT+CLASS=<Input> | A, B or C | – | OK / AT_PARAM_ERROR |
Example AT+CLASS=? | – | A | OK |
This command allows the user to access the duty cycle parameter.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+DCS? | – | AT+DCS: get the ETSI duty cycle setting: 0 = disabled 1 = enabled | OK |
AT+DCS=? | – | 0 or 1 | OK |
AT+DCS=<Input> | 0 or 1 | – | OK / AT_PARAM_ERROR |
Example AT+DCS=? | – | 1 | OK |
Example AT+DCS= | 1 | – | OK |
This command allows the user to access the data rate.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+DR? | – | AT+DR: get or set the data rate | OK |
AT+DR=? | – | 0, 1, 2, 3, 4, 5, 6 or 7 | OK |
AT+DR=<Input> | 0, 1, 2, 3, 4, 5, 6 or 7 | – | OK / AT_PARAM_ERROR |
Example AT+DR=? | – | 3 | OK |
Example AT+DR= | 2 | – | OK |
This command allows the user to access the join delay on RX window 1.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+JN1DL? | – | AT+JN1DL: get or set the join accept delay between the end of TX and the join Rx window 1 in seconds | OK |
AT+JN1DL=? | – | <integer> | OK / AT_BUSY_ERROR |
AT+JN1DL=<Input> | <integer> | – | OK / AT_PARAM_ERROR / AT_BUSY_ERROR |
Example AT+JN1DL=? | – | 5 | OK |
Example AT+JN1DL= | 10 | – | OK |
This command allows the user to access the join delay on RX window 2.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+JN2DL? | – | AT+JN2DL: get the join accept delay between the end of TX and the join Rx window 2 in seconds | OK |
AT+JN2DL=? | – | <integer> | OK / AT_BUSY_ERROR |
Example AT+JN2DL=? | – | 6 | OK |
This command allows the user to access the public network mode.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+PNM? | – | AT+PNM: get or set the public network mode (0 = off, 1 = on) | OK |
AT+PNM=? | – | 0 or 1 | OK |
AT+PNM=<Input> | 0 or 1 | – | OK / AT_PARAM_ERROR |
Example AT+PNM=? | – | 0 | OK |
Example AT+PNM= | 1 | – | OK |
Example AT+PNM= | 2 | – | AT_PARAM_ERROR |
This command allows the user to access the delay of the received window 1.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+RX1DL? | – | AT+RX1DL: get or set the delay between the end of TX and the RX window 1 in seconds (1-15) | OK |
AT+RX1DL=? | – | <integer> | OK / AT_BUSY_ERROR |
AT+RX1DL=<Input> | <integer> | – | OK / AT_PARAM_ERROR / AT_BUSY_ERROR |
Example AT+RX1DL=? | – | 1 | OK |
Example AT+RX1DL= | 1 | – | OK |
This command allows the user to access the delay of the received window 2.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+RX2DL? | – | AT+RX2DL: get or set the delay between the end of TX and the RX window 2 in seconds (2-16) | OK |
AT+RX2DL=? | – | <integer> | OK / AT_BUSY_ERROR |
Example AT+RX2DL=? | – | 2 | OK |
This command allows the user to access the data rate of received window 2.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+RX2DR? | – | AT+RX2DR: get or set the RX2 window data rate | OK |
AT+RX2DR=? | – | 0, 1, 2, 3, 4, 5, 6 or 7 | OK / AT_BUSY_ERROR |
AT+RX2DR=<Input> | 0, 1, 2, 3, 4, 5, 6 or 7 | – | OK / AT_PARAM_ERROR / AT_BUSY_ERROR |
Example AT+RX2DR=? | – | 6 | OK |
Example AT+RX2DR= | 5 | – | OK |
This command allows the user to access the frequency of the received window 2.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+RX2FQ? | – | AT+RX2FQ: get or set the RX2 window frequency (Hz) | OK |
AT+RX2FQ=? | – | <integer> | OK / AT_BUSY_ERROR |
AT+RX2FQ=<Input> | <integer> | – | OK / AT_PARAM_ERROR / AT_BUSY_ERROR |
Example AT+RX2FQ=? | – | 869535000 | OK |
Example AT+RX2FQ= | 869535000 | – | OK |
This command allows the user to access the transmit power
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+TXP? | – | AT+TXP: get or set the transmitting power | OK |
AT+TXP=? | – | <integer> | OK |
AT+TXP=<Input> | <integer> | – | OK / AT_PARAM_ERROR |
Example AT+TXP=? | – | 1 | OK |
Example AT+TXP= | 4 | – | OK |
This command allows the user to send the link check command
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+LINKCHECK? | – | AT+LINKCHECK: get or set the link check setting (0 = disabled, 1 = once, 2 = everytime) | OK |
AT+LINKCHECK=? | – | <0-2> | OK |
AT+LINKCHECK=<Input> | <0-2> | – | OK / AT_PARAM_ERROR |
Example AT+LINKCHECK=? | – | 1 | OK |
Example AT+LINKCHECK= | 2 | – | OK |
This command allows the user to request the current date and time
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+TIMEREQ? | – | AT+TIMEREQ: request the current date and time (0 = disabled, 1 = enabled) | OK |
AT+TIMEREQ=? | – | <0-1> | OK |
AT+TIMEREQ=<Input> | <0-1> | – | OK / AT_PARAM_ERROR |
Example AT+TIMEREQ=? | – | 1 | OK |
Example AT+TIMEREQ= | 1 | – | OK |
This command allows the user to enable or disable LoRaWAN LBT
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+LBT? | – | AT+LBT: get or set the LoRaWAN LBT (support Korea Japan) (0 = disabled, 1 = enabled) | OK |
AT+LBT=? | – | <0-1> | OK |
AT+LBT=<Input> | <0-1> | – | OK / AT_PARAM_ERROR |
Example AT+LBT=? | – | 1 | OK |
Example AT+LBT= | 1 | – | OK |
This command allows the user to set or get LoRaWAN LBT RSSI
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+LBTRSSI? | – | AT+LBT: get or set the LoRaWAN LBT rssi (support Korea Japan) | OK |
AT+LBTRSSI=? | – | <RSSI> | OK |
AT+LBTRSSI=<Input> | <RSSI> | – | OK / AT_PARAM_ERROR |
Example AT+LBT=? | – | -80 | OK |
Example AT+LBT= | -80 | – | OK |
This command allows the user to set or get LoRaWAN LBT scantime
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+LBTSCANTIME? | – | AT+LBT: get or set the LoRaWAN LBT scantime (support Korea Japan) | OK |
AT+LBTSCANTIME=? | – | <time> | OK |
AT+LBTSCANTIME=<Input> | <time> | – | OK / AT_PARAM_ERROR |
Example AT+LBTSCANTIME=? | – | 5 | OK |
Example AT+LBTSCANTIME= | 5 | – | OK |
This section provides a set of commands for battery level, RF signal quality and FW version.
This command switchs between LoRaWAN P2P mode and LoRaWAN mode (0:LoRaWAN P2P, 1:LoRaWAN, 2: LoRaWAN P2P FSK)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+NWM? | – | AT+NWM: get or set the network working mode (0 = P2P_LORA, 1 = LoRaWAN, 2 = P2P_FSK) | OK |
AT+NWM=? | – | 0 or 1 or 2 | OK |
AT+NWM=<Param> | 0 or 1 | – | OK / AT_PARAM_ERROR |
Example AT+NWM= | 1 | – | OK |
Example AT+NWM=? | 1 | OK |
This command allows the user to access the frequency in p2p mode. Note: This command will be deleted in the future
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+PFREQ? | – | AT+PFREQ: configure P2P Frequency | OK |
AT+PFREQ=? | – | <interger> | OK |
AT+PFREQ=<Param> | <interger> | – | OK / AT_PARAM_ERROR |
Example AT+PFREQ=? | – | 868000000 | OK |
This command allows the user to access the spreading factor in p2p mode. Note: This command will be deleted in the future
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+PSF? | – | AT+PSF: configure P2P Spreading Factor (5-12) | OK |
AT+PSF=? | – | <interger> | OK |
AT+PSF=<Param> | <interger> | – | OK / AT_PARAM_ERROR |
Example AT+PSF=? | – | 7 | OK |
This command allows the user to access the bandwidh in p2p mode. Note: This command will be deleted in the future
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+PBW? | – | AT+PBW: configure P2P Bandwidth(LORA:0=125,1=250,2=500,3=7.8,4=10.4,5=15.63,6=20.83,7=31.25,8=41.67,9=62.5 FSK:4800-467000) | OK |
AT+PBW=? | – | <interger> | OK |
AT+PBW=<Param> | <interger> | – | OK / AT_PARAM_ERROR |
Example AT+PSF=? | – | 0 | OK |
This command allows the user to access the codingrate in p2p mode. Note: This command will be deleted in the future
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+PCR? | – | AT+PCR: configure P2P Code Rate(0=4/5, 1=4/6, 2=4/7, 3=4/8) | OK |
AT+PCR=? | – | <interger> | OK |
AT+PCR=<Param> | <interger> | – | OK / AT_PARAM_ERROR |
Example AT+PCR=? | – | 1 | OK |
This command allows the user to access the length of preamble in p2p mode. This command will be deleted in the future
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+PPL? | – | AT+PPL: configure P2P Preamble Length (5-65535) | OK |
AT+PPL=? | – | <interger> | OK |
AT+PPL=<Param> | <interger> | – | OK / AT_PARAM_ERROR |
Example AT+PPL=? | – | 8 | OK |
This command allows the user to access the tx power in p2p mode. This command will be deleted in the future
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+PTP? | – | AT+PTP: configure P2P TX Power(5-22) | OK |
AT+PTP=? | – | <interger> | OK |
AT+PTP=<Param> | <interger> | – | OK / AT_PARAM_ERROR |
Example AT+PTP=? | – | 14 | OK |
This command allows the user to send data in p2p mode.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+PSEND? | – | AT+PSEND: send data in P2P mode | OK |
AT+PSEND=? | – | <interger> | OK |
Example AT+PSEND=? | – | 32 | OK |
This command allows the user to receive data in p2p mode.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+PRECV? | – | AT+PRECV: enter P2P RX mode for a period of time (ms) | OK |
AT+PRECV=? | – | P2P_RX_OFF or P2P_RX_ON | OK |
AT+PRECV=<integer> | <integer> | – | OK |
Example AT+PRECV= | 5000 | – | OK |
This command allows the user to access the crypt status in p2p mode.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+PCRYPT? | – | AT+PCRYPT: get or set the encryption status of P2P mode | OK |
AT+PCRYPT=? | – | <0 or 1> | OK |
AT+PCRYPT= | <0 or 1> | – | OK |
Example AT+PCRYPT= | 0 | – | OK |
Example AT+PCRYPT=? | – | 1 | OK |
This command allows the user to access the encryption and decryption key in p2p mode.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+PKEY? | – | AT+PKEY: get or set the encryption key of P2P mode (8 bytes in hex) | OK |
AT+PKEY=? | – | <8 hex> | OK |
AT+PKEY= | <8 hex> | – | OK |
Example AT+PKEY= | 0011223344556677 | – | OK |
Example AT+PKEY=? | – | 0011223344556677 | OK |
This command provides a way to access all parameters for P2P mode
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+P2P? | – | AT+P2P: get or set all P2P parameters | OK |
AT+P2P=? | – | <freq>,<sf>,<bw>,<cr>,<preamble length>,<txp> | OK |
AT+P2P= | <freq>,<sf>,<bw>,<cr>,<preamble length>,<txp>,<Runtime Setting> | OK | |
Example AT+P2P= | 868500000,12,0,0,10,22 868500000,8,250,2,24,20:1 | – | OK |
Example AT+P2P=? | – | 868000000,7,0,0,8,14 | OK |
Freq: 150000000-960000000
SF: 6,7,8,9,10,11,12
Bandwidth: 0 = 125,1 = 250,2 = 500,3 = 7.8,4 = 10.4,5 = 15.63,6 = 20.83,7 = 31.25,8 = 41.67,9 = 62.5
CR: 0 = 4/5, 1 = 4/6, 2 = 4/7, 3 = 4/8
Preamble Length: 5-65535
TX Power = 5-22
Runtime Setting = 0-1. Optional. When Runtime Setting is 1, the configure will not store in Flash memory.
This command allows the user to get or set the P2P FSK modem bitrate (600b/s-300000b/s)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+PBR? | – | AT+PBR: get or set the P2P FSK modem bitrate (600-300000 b/s) | OK |
AT+PBR=? | – | <fbitrate> | OK |
AT+PBR=<Param> | <bitrate> | – | OK / AT_PARAM_ERROR |
Example AT+PBR=? | – | 4915 | OK |
This command allows the user to get or set the P2P FSK modem frequency deviation (600-200000 hz)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+PFDEV? | – | AT+PFDEV: get or set the P2P FSK modem frequency deviation (600-200000 hz) | OK |
AT+PFDEV=? | – | <frequency deviation>=""> | OK |
AT+PFDEV=<Param> | <frequency deviation>=""> | – | OK / AT_PARAM_ERROR |
Example AT+PFDEV=? | – | 5000 | OK |
This command allows the user to get or set P2P IQ inversion (1 = on, 0 = off)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+IQINVER? | – | AT+IQINVER: get or set P2P IQ inversion (1 = on, 0 = off) | OK |
AT+IQINVER=? | – | <0 or 1> | OK |
AT+IQINVER=<Param> | <0 or 1> | – | OK / AT_PARAM_ERROR |
Example AT+IQINVER=? | – | 0 | OK |
This command allows the user to get or set P2P syncword (0x0000 - 0xffff)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+SYNCWORD? | – | AT+SYNCWORD: get or set P2P syncword (0x0000 - 0xffff) | OK |
AT+SYNCWORD=? | – | <2 Hex> | OK |
AT+SYNCWORD=<Param> | <2 Hex> | – | OK / AT_PARAM_ERROR |
Example AT+SYNCWORD=? | – | 3444 | OK |
This command allows the user to access the frequency in p2p mode.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+RFFREQUENCY? | – | AT+RFFREQUENCY: get or set P2P Frequency | OK |
AT+RFFREQUENCY=? | – | <interger> | OK |
AT+RFFREQUENCY=<Param> | <interger> | – | OK / AT_PARAM_ERROR |
Example AT+RFFREQUENCY=? | – | 0 | OK |
This command allows the user to get or set P2P Tx Power(5-22)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+TXOUTPUTPOWER? | – | AT+TXOUTPUTPOWER: get or set P2P Tx Power(5-22) | OK |
AT+TXOUTPUTPOWER=? | – | <powerlevel> | OK |
AT+TXOUTPUTPOWER=<Param> | <powerlevel> | – | OK / AT_PARAM_ERROR |
Example AT+TXOUTPUTPOWER=? | – | 20 | OK |
This command allows the user to get or set P2P Bandwidth(LORA: 0 = 125, 1 = 250, 2 = 500, 3 = 7.8, 4 = 10.4, 5 = 15.63, 6 = 20.83, 7 = 31.25, 8 = 41.67, 9 = 62.5 FSK:4800-467000)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+BANDWIDTH? | – | AT+BANDWIDTH: get or set P2P Bandwidth(LORA:0=125,1=250,2=500,3=7.8,4=10.4,5=15.63,6=20.83,7=31.25,8=41.67,9=62.5 FSK:4800-467000) | OK |
AT+BANDWIDTH=? | – | <bandwidth> | OK |
AT+BANDWIDTH=<Param> | <bandwidth> | – | OK / AT_PARAM_ERROR |
Example AT+BANDWIDTH=? | – | 0 | OK |
This command allows the user to get or set P2P Spreading Factor (5-12)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+SPREADINGFACTOR? | – | AT+SPREADINGFACTOR: get or set P2P Spreading Factor (5-12) | OK |
AT+SPREADINGFACTOR=? | – | <Spreading Factor> | OK |
AT+SPREADINGFACTOR=<Param> | <Spreading Factor> | – | OK / AT_PARAM_ERROR |
Example AT+SPREADINGFACTOR=? | – | 5 | OK |
This command allows the user to get or set P2P Code Rate(0=4/5, 1=4/6, 2=4/7, 3=4/8)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+SPREADINGFACTOR? | – | AT+SPREADINGFACTOR:get or set P2P Code Rate(0=4/5, 1=4/6, 2=4/7, 3=4/8) | OK |
AT+SPREADINGFACTOR=? | – | <coding rate> | OK |
AT+SPREADINGFACTOR=<Param> | <coding rate> | – | OK / AT_PARAM_ERROR |
Example AT+SPREADINGFACTOR=? | – | 0 | OK |
This command allows the user to get or set P2P Preamble Length (5-65535)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+PREAMBLELENGTH? | – | AT+PREAMBLELENGTH:set get or set P2P Preamble Length (5-65535) | OK |
AT+PREAMBLELENGTH=? | – | <interger> | OK |
AT+PREAMBLELENGTH=<Param> | <interger> | – | OK / AT_PARAM_ERROR |
Example AT+PREAMBLELENGTH=? | – | 10 | OK |
This command allows the user to get or set P2P symbolTimeout (0-248)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+SYMBOLTIMEOUT? | – | AT+SYMBOLTIMEOUT:get or set P2P symbolTimeout (0-248) | OK |
AT+SYMBOLTIMEOUT=? | – | <interger> | OK |
AT+SYMBOLTIMEOUT=<Param> | <interger> | – | OK / AT_PARAM_ERROR |
Example AT+SYMBOLTIMEOUT=? | – | 0 | OK |
This command allows the user to get or set P2P fix length payload on/off ( 1 = on, 0 = off)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+FIXLENGTHPAYLOAD? | – | AT+FIXLENGTHPAYLOAD: get or set P2P fix length payload on/off ( 1 = on, 0 = off) | OK |
AT+FIXLENGTHPAYLOAD=? | – | <0 or 1> | OK |
AT+FIXLENGTHPAYLOAD=<Param> | <0 or 1> | – | OK / AT_PARAM_ERROR |
Example AT+FIXLENGTHPAYLOAD=? | – | 0 | OK |
This command allows the user to get or set the encryption status of P2P mode ( 1 = on, 0 = off)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+ENCRY? | – | AT+ENCRY: get or set the encryption status of P2P( 1 = on, 0 = off) | OK |
AT+ENCRY=? | – | <0 or 1> | OK |
AT+ENCRY=<Param> | <0 or 1> | – | OK / AT_PARAM_ERROR |
Example AT+ENCRY=? | – | 0 | OK |
This command allows the user to get or set the encryption key of P2P mode (16 bytes in hex)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+ENCKEY? | – | AT+ENCKEY: get or set the encryption key of P2P mode (16 bytes in hex) | OK |
AT+ENCKEY=? | – | <16 hex> | OK |
AT+ENCKEY=<Param> | <16 hex> | – | OK |
Example AT+ENCKEY= | 0011223344556677 | – | OK |
Example AT+ENCKEY=? | – | 0011223344556677 | OK |
This command allows the user to get or set the encryption IV of P2P mode (16 bytes in hex)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+CRYPIV? | – | AT+CRYPIV: get or set the encryption key of P2P mode (16 bytes in hex) | OK |
AT+CRYPIV=? | – | <16 hex> | OK |
AT+CRYPIV=<Param> | <16 hex> | – | OK |
Example AT+CRYPIV= | 0011223344556677 | – | OK |
Example AT+CRYPIV=? | – | 0011223344556677 | OK |
This command allows the user to get or set the Channel Activity Detection of P2P mode
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+CAD? | – | AT+CAD: get or set the Channel Activity Detection of P2P mode ( 1 = on, 0 = off) | OK |
AT+CAD=? | – | <0 or 1> | OK |
AT+CAD=<Param> | <16 hex> | – | OK |
Example AT+CAD= | <0 or 1> | – | OK |
Example AT+CAD=? | – | 0 | OK |
This command locks the AT command serial port.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+LOCK? | – | AT+LOCK: lock the serial port | OK |
AT+LOCK=? | – | <string> | OK |
AT+LOCK | – | – | OK |
Example AT+LOCK=? | – | unlocked | OK |
This command sets the password for locking the AT command serial port.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+PWORD? | – | AT+PWORD: set the serial port locking password (max 8 char) | OK |
AT+PWORD=? | – | <1-8 hex> | OK |
AT+PWORD=<Input> | <1-8 hex> | – | OK |
Example AT+PWORD=88888888 | <1-8 hex> | – | OK |
This command allows the user to access the serial port baudrate.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+BAUD? | – | AT+BAUD: get or set the serial port baudrate | OK |
AT+BAUD=? | – | <integer> | OK |
AT+BAUD=<input> | <integer> | – | OK / AT_PARAM_ERROR |
Example AT+BAUD= | 115200 | – | OK |
Example AT+BAUD= | abc | – | AT_PARAM_ERROR |
Example AT+BAUD=? | – | 115200 | OK |
This command provides a way to switch to AT command mode
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+ATM? | – | AT+ATM: switch to AT command mode | OK |
AT+ATM | – | OK |
This command provides a way to switch to API mode
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+APM? | – | AT+APM: switch to API mode | OK |
AT+APM | – | OK |
This section describes the commands related to sleep.
This command provides a way to enter sleep mode
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+SLEEP? | – | AT+SLEEP: enter sleep mode for a period of time (ms) | OK |
AT+SLEEP=<positive integer> | <positive integer>=""> | OK / AT_PARAM_ERROR | |
Example AT+SLEEP= | 1000 | – | OK |
This command provides a way to enable/disable low power mode
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+LPM? | – | AT+LPM: get or set the low power mode 0 = off 1 = on | OK |
AT+LPM=? | – | <string> | OK |
AT+LPM=<Input> | 0 or 1 | OK / AT_PARAM_ERROR | |
Example AT+LPM= | 1 | – | OK |
Example AT+LPM=? | 1 | OK |
This command provides a way to setting sleep level for low power mode to support STM32 STOP Mode.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+LPMLVL? | – | AT+LPMLVL: get or set the sleep level for low power mode 1 = STOP1 Mode 2 = STOP2 Mode | OK |
AT+LPMLVL=? | – | 1 or 2 | OK |
AT+LPMLVL=<Input> | 1 or 2 | – | OK / AT_PARAM_ERROR |
Example AT+LPMLVL= | 1 | – | OK |
Example AT+LPMLVL=? | 1 | OK |
This section provides a set of supplementary commands.
This command configures the channel of the device by setting the hexadecimal channel mask.
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+MASK? | – | AT+MASK: get or set the channel mask to close or open the channel (only for US915, AU915, CN470) | OK |
AT+MASK=? | – | <2 hex> | OK |
AT+MASK=<Input> | <2 hex> | – | OK / AT_PARAM_ERROR |
Example AT+MASK= | 0001 | – | OK |
Example AT+MASK=? | 0001 | OK |
This command get or set the active region
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+BAND? | – | AT+BAND: get or set the active region (0 = EU433, 1 = CN470, 2 = RU864, 3 = IN865, 4 = EU868, 5 = US915, 6 = AU915, 7 = KR920, 8 = AS923-1 , 9 = AS923-2 , 10 = AS923-3 , 11 = AS923-4) | OK |
AT+BAND=? | – | [0,1,2,3,4,5,6,7,8,9,10,11] | OK |
AT+BAND=<Input> | [0,1,2,3,4,5,6,7,8,9,10,11] | – | OK / AT_PARAM_ERROR |
Example AT+BAND= | 1 | – | OK |
Example AT+BAND=? | 3 | OK |
This command get or set eight channels mode (only for US915 AU915 CN470)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+CHE? | – | AT+CHE: get or set eight channels mode (only for US915 AU915 CN470) | OK |
AT+CHE=? | – | [0,1,2,3,4,5,6,7,8] | OK |
AT+CHE=<Input> | [0,1,2,3,4,5,6,7,8] | – | OK / AT_PARAM_ERROR |
Example AT+CHE= | 1 | – | OK |
Example AT+CHE=? | 3 | OK |
This command get or set single channels mode (only for US915 AU915 CN470)
Command | Input parameter | Return value | Return code |
---|---|---|---|
AT+CHS? | – | AT+CHE: get or set single channels mode (only for US915 AU915 CN470) | OK |
AT+CHS=? | – | Frequency | OK |
AT+CHS=<Input> | Frequency | OK / AT_PARAM_ERROR | |
Example AT+CHS= | 902300000 | – | OK |
Example AT+CHS=? | 902300000 | OK |