Skip to content

Latest commit

 

History

History
1895 lines (1321 loc) · 57.4 KB

AT-Commands.md

File metadata and controls

1895 lines (1321 loc) · 57.4 KB
Raw

AT-Commands

To make it easy to setup the LoRaWAN® credentials and LoRa® P2P settings, an AT command interface over USB is implemented. It includes the basic commands required to define the node.

Credits:
Taylor Lee (taylor.lee@rakwireless.com)

REMARK 1 After changing LoRaWAN® parameters or LoRa P2P settings, the device must be reset by either the ATZ command or 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 setup for 115200 baud, 8N1. It cannot be changed by AT commands.

REMARK 4 In LoRaWAN® Class C mode the received data is not shown in the AT Command interface. The data has to be handled in the user application In P2P LoRa® mode the received data is not shown in the AT Command interface. The data has to be handled in the user application

REMARK 5 LoRa® is a registered trademark or service mark of Semtech Corporation or its affiliates. LoRaWAN® is a licensed mark.

Content

General commands

LoRaWAN commands

Device Information

LoRa P2P commands

  • AT+NWM Set Device Workmode
  • AT+PFREQ Set/Get LoRa® P2P Frequency
  • AT+PSF Set/Get LoRa® P2P Spreading Factor
  • AT+PBW Set/Get LoRa® P2P Bandwidth
  • AT+PCR Set/Get LoRa® P2P Coding Rate
  • AT+PPL Set/Get LoRa® P2P Preamble Length
  • AT+PTP Set/Get LoRa® P2P TX Power
  • AT+P2P Set/Get LoRa® P2P Configuration
  • AT+PSEND Send LoRa® P2P packet
  • AT+PRECV Set LoRa® P2P RX mode

GNSS specific commands

Appendix

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 document, 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”

  1. <value><CR><LF> is the first reply when (AT+XXX?) command description or (AT+XXX=?) reading value is executed then it will be followed by the status return code. The formats with no return value like (**AT+XXX=<input parameter>) writing configuration command and (AT+XXX) run command will just reply the status return code.

  2. <CR><LF><STATUS><CR><LF> is the second part of the reply which is the status return code.

The possible status 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.

AT?

Description: Help

Returns a list of all available commands with a short description

Command Input Parameter Return Value Return Code
AT? - List of commands OK 
AT?
AT?

+++++++++++++++
AT command list
+++++++++++++++
AT?         AT commands
ATR         Restore default
ATZ		ATZ Trig a MCU reset
AT+APPEUI   Get or set the application EUI
AT+APPKEY   Get or set the application key
AT+DEVEUI   Get or set the device EUI
AT+APPSKEY  Get or set the application session key
AT+NWKSKEY  Get or Set the network session key
AT+DEVADDR  Get or set the device address
AT+CFM      Get or set the confirm mode
AT+JOIN     Join network
AT+NJS      Get the join status
AT+NJM      Get or set the network join mode
AT+SENDFREQ Get or Set the automatic send time
AT+SEND	Send data
AT+ADR      Get or set the adaptive data rate setting
AT+CLASS    Get or set the device class
AT+DR       Get or Set the Tx DataRate=[0..7]
AT+TXP      Get or set the transmit power
AT+BAND     Get and Set number corresponding to active regions
AT+MASK     Get and Set channels mask
AT+BAT      Get battery level
AT+RSSI     Last RX packet RSSI
AT+SNR      Last RX packet SNR
AT+VER      Get SW version
AT+STATUS	Show LoRaWAN status
AT+NWM	Switch LoRa workmode
AT+PFREQ	Set P2P frequency
AT+PSF	Set P2P spreading factor
AT+PBW	Set P2P bandwidth
AT+PCR	Set P2P coding rate
AT+PPL	Set P2P preamble length
AT+PTP	Set P2P TX power
AT+P2P	Set P2P configuration
AT+PSEND	P2P send data
AT+PRECV	P2P receive mode
+++++++++++++++

OK

Back

ATR

This command restores all parameters to the initial default values of the module.

Command Input Parameter Return Value Return Code
ATR? - - OK
ATR - - OK

Back

ATZ

Description: MCU reset

This command is used to trigger an MCU reset.

Command Input Parameter Return Value Return Code
ATZ? - ATZ: Trig a MCU reset OK
ATZ - No return. MCU resets. OK

Back

AT+APPEUI

Description: Application unique identifier

This command allows the user to access and configure the APPEUI.

Command Input Parameter Return Value Return Code
AT+APPEUI? - AT+APPEUI: Get or Set the App Eui OK
AT+APPEUI=? - < 8 hex > OK
AT+APPEUI=<Input Parameter> < 8 hex > - OK or AT_PARAM_ERROR

Examples:

AT+APPEUI?

+APPEUI: Get or set the application EUI 
OK

AT+APPEUI=?

AT+APPEUI:70b3d57ed00201e1
OK

AT+APPEUI=70b3d57ed00201e1

OK

AT+APPEUI=70b3d57ed00201eh

+CME ERROR:5

Back

AT+APPKEY

Description: Application key

This command allows the user to access and configure the APPKEY.

Command Input Parameter Return Value Return Code
AT+APPKEY? - AT+APPKEY: Get or Set the Application Key OK
AT+APPKEY=? - < 16 hex > OK
AT+APPKEY=<Input Parameter> < 16 hex > - OK or AT_PARAM_ERROR

Examples:

AT+APPKEY?

AT+APPKEY: Get or set the application key 
OK

AT+APPKEY=?

AT+APPKEY:2b84e0b09b68e5cb42176fe753dcee79
OK

AT+APPKEY=2b84e0b09b68e5cb42176fe753dcee79

OK

AT+APPKEY=2b84e0b09b68e5cb42176fe753dcee7x

+CME ERROR:5

Back

AT+DEVEUI

Description: Device EUI or DEVEUI

This command allows the user to access and configure the device EUI or DEVEUI.

Command Input Parameter Return Value Return Code
AT+DEVEUI? - AT+DEVEUI: Get or Set the Device EUI OK
AT+DEVEUI=? - < 8 hex > OK
AT+DEVEUI=<Input Parameter> < 8 hex > - OK or AT_PARAM_ERROR

Examples:

AT+DEVEUI?

+DEVEUI: Get or set the device EUI 
OK

AT+DEVEUI=?

+DEVEUI:ac1f09fffe03efdc
OK

AT+DEVEUI=ac1f09fffe03efdc

OK

AT+DEVEUI=ac1f09fffe03efdx

+CME ERROR:5

Back

AT+APPSKEY

Description: Application session key

This command allows the user to access and configure the application session key or APPSKEY.

Command Input Parameter Return Value Return Code
AT+APPSKEY? - AT+APPSKEY: Get or Set the Application Session Key OK
AT+APPSKEY=? - < 16 hex > OK
AT+APPSKEY=<Input Parameter> < 16 hex > - OK or AT_PARAM_ERROR

Examples:

AT+APPSKEY?

AT+APPSKEY: Get or set the application session key 
OK

AT+APPSKEY=?

AT+APPSKEY:3f6a66459d5edca63cbc4619cd61a11e
OK

AT+APPSKEY=3f6a66459d5edca63cbc4619cd61a11e

OK

AT+APPSKEY=3f6a66459d5edca63cbc4619cd61a11x

+CME ERROR:5

Back

AT+NWKSKEY

Description: Network session keys

This command allows the user to access and configure the network session keys or NWKSKEY.

Command Input Parameter Return Value Return Code
AT+NWKSKEY? - AT+NWKSKEY: Get or Set the Network Session Key OK
AT+NWKSKEY=? - < 16 hex > OK
AT+NWKSKEY=<Input Parameter> < 16 hex > - OK or AT_PARAM_ERROR

Examples:

AT+NWKSKEY?

AT+NWKSKEY: Get or Set the network session key 
OK

AT+NWKSKEY=?

AT+NWKSKEY:323d155a000df335307a16da0c9df53f
OK

AT+NWKSKEY=323d155a000df335307a16da0c9df53f

OK

AT+NWKSKEY=323d155a000df335307a16da0c9df53f0

+CME ERROR:5

Back

AT+DEVADDR

Description: Device address or DEVADDR

This command allows the user to access and configure the device address or DEVADDR. If in OTAA mode and device has joined the network, AT+DEVADDR=? will return the device address assigned by the network server

Command Input Parameter Return Value Return Code
AT+DEVADDR? - AT+DEVADDR: Get or Set the Device address OK
AT+DEVADDR=? - < 4 hex > OK
AT+DEVADDR=<Input Parameter> < 4 hex > - OK or AT_PARAM_ERROR

Examples:

AT+DEVADDR?

AT+DEVADDR: Get or set the device address 
OK

AT+DEVADDR=?

AT+DEVADDR:26021FB0

OK

AT+DEVADDR=26021FB0

OK

AT+DEVADDR=26021FBX

+CME ERROR:5

Back

AT+CFM

Description: Confirmed payload mode

This command allows the user to access and configure type of payload of the device.

Command Input Parameter Return Value Return Code
AT+CFM? - AT+CFM: get or set the confirm mode OK
AT+CFM=? - 0 (if Unconfirmed) or 1 (if confirmed) OK
AT+CFM=<Input Parameter> 0 or 1 - OK or AT_PARAM_ERROR

Examples:

AT+CFM?

AT+CFM: Get or set the confirm mode 
OK

AT+CFM=?

AT+CFM:0
OK

AT+CFM=0

OK

AT+CFM=3

+CME ERROR:5

Back

AT+JOIN

Description: Join LoRaWAN® network

This command allows the user to join a LoRaWAN® network.

Command Input Parameter Return Value Return Code
AT+JOIN? - AT+JOIN: join network OK
AT+JOIN=? - Param1, Param2, Param3, Param4 OK or AT_BUSY_ERROR
AT+JOIN=<Input Parameter> Param1:Param2:Param3:Param4 - OK
Param1 = Join command: 1 for joining the network , 0 for stop joining
Param2 = Auto-Join config: 1 for Auto-join on power up) , 0 for no auto-join. (0 is default)
Param3 = Reattempt interval: 7 - 255 seconds (30 is default)
Param4 = No. of join attempts: 0 - 255 (0 is default)

This is an asynchronous command. OK means that the device is joining. The completion of the JOIN can be verified with AT+NJS=? command.
The asynchronous responses can be:
+EVT:JOINED after successful join
+EVT:JOIN FAILED if the join process did not succeed.

Param3 is not supported yet and is fixed to 30s always

Examples:

AT+JOIN?

AT+JOIN: Join network 
OK

AT+JOIN=?

AT+JOIN=0:1:8:10
OK

AT+JOIN=1:1:8:10

OK

+EVT:JOINED

AT+JOIN=3:1:8:10

+CME ERROR:5

Back

AT+NJS

Description: Network join status

This command allows the user to check the status of the devices if it is connected to a LoRaWAN® network.

Command Input Parameter Return Value Return Code
AT+NJS? - AT+NJS: get the join status OK
AT+NJS=? - 0 (not joined) or 1 (joined) OK

Examples:

AT+NJS?

AT+NJS: Get the join status 
OK

AT+NJS=?

AT+NJS:1
OK

Back

AT+NJM

Description: LoRaWAN® network join mode

This command allows the user to access and configure the activation method of the device either OTAA or ABP. A value of 1 means OTAA join mode, a value of 0 means ABP join mode

Command Input Parameter Return Value Return Code
AT+NJM? - AT+NJM Get or set the network join mode OK
AT+NJM=? - 0 or 1 OK
AT+NJM=<Input Parameter> 0 or 1 - OK or AT_PARAM_ERROR

Examples:

AT+NJM?

AT+NJM: Get or set the network join mode 
OK

AT+NJM=?

AT+NJM:0
OK

AT+NJM=0

OK

AT+NJM=2

+CME ERROR:5

Back

AT+SENDFREQ

Description: Set the automatic transmission period

This command allows to set the period in seconds between automatic packet transmissions. If set to 0, automatic packet transmission is disabled.

Command Input Parameter Return Value Return Code
AT+SENDFREQ? - AT+SENDFREQ: Get or Set the automatic send time OK
AT+SENDFREQ=? - <period in seconds> OK
AT+SENDFREQ=<Input Parameter> <period in seconds> - OK or AT_PARAM_ERROR

Examples:

AT+SENDFREQ?

AT+SENDFREQ: Get or Set the automatic send time 
OK

AT+SENDFREQ=?

AT+SENDFREQ:60
OK

AT+SENDFREQ=60

OK

Back

AT+SEND

Description: Send payload data

This command is used to send LoRaWAN® payload on specific port.

Command Input Parameter Return Value Return Code
AT+SEND? - AT+SEND Send data OK
AT+SEND=<Input Parameter> port:payload - OK , AT_NO_NETWORK_JOINED , AT_PARAM_ERROR or AT_BUSY_ERROR

Examples:

AT+SEND?

AT+SEND: Send data
OK

Unconfirmed Payload

AT+SEND=2:1234

OK

AT+SEND=SUCCESS

Confirm Payload

AT+SEND=2:1234

OK

AT+SEND=SUCCESS

Downlink packet received

AT+SEND=5:10AAFF45

OK

AT+SEND=SUCCESS
RX:2:6:-46:11:48656C6C6F0A
OK

REMARK In Class C mode the received data is not shown in the AT Command interface. The data has to be handled in the user application

Back

AT+ADR

Description: Adaptive data rate

This command allows the user to access and configure the adaptive data rate of the module.

Command Input Parameter Return Value Return Code
AT+ADR? - AT+ADR: Get or Set the Adaptive Data Rate setting OK
AT+ADR=? - 0 (ADR off) or 1 (ARD on) OK
AT+ADR=<Input Parameter> 0 or 1 - OK or AT_PARAM_ERROR

Examples:

AT+ADR?

+ADR: Get or set the adaptive data rate setting 
OK

AT+ADR=?

AT+ADR:0
OK

AT+ADR=0

OK

AT+ADR=3

+CME ERROR:5

Back

AT+CLASS

Description: LoRaWAN® class

This command allows the user to access and configure the the LoRaWAN® class of the module.

Command Input Parameter Return Value Return Code
AT+CLASS? - AT+CLASS: Get or Set the Device Class=[A, B, C] OK
AT+CLASS=? - A or C (B not supported) OK
AT+CLASS=<Input Parameter> A or C - OK or AT_PARAM_ERROR

This FW of the device supports the LoRaWAN® V1.0.2 stack

Examples:

AT+CLASS?

+CLASS: Get or set the device class 
OK

AT+CLASS=?

AT++CLASS:A
OK

AT+CLASS=A

OK

AT+CLASS=F

+CME ERROR:5

Back

AT+DR

Description: Data rate settings

This command allows the user to access and configure data rate settings.

Command Input Parameter Return Value Return Code
AT+DR? - AT+DR=<DataRate><CR>. Get or Set the Tx DataRate OK
AT+DR=? - 0,1,2,3,4,5,6,7 OK
AT+DR=<Input Parameter> 0,1,2,3,4,5,6,7 - OK or AT_PARAM_ERROR

Check Appendix I for the input parameter depending on the frequency band selected.

Examples:

AT+DR?

AT+DR: Get or Set the Tx DataRate=[0..7] 
OK

AT+DR=?

AT+DR:3
OK

AT+DR=3

OK

Back

AT+TXP

Description: Transmit Power

This command allows the user to access and configure the transmit power.

Command Input Parameter Return Value Return Code
AT+TXP? - AT+TXP: Get or set the transmit power OK
AT+TXP=? - < value > OK or AT+PARAM_ERROR
AT+TXP=<Input Parameter> < value > - OK or AT_PARAM_ERROR

Check Appendix II for the input parameter depending on the frequency band selected.

For example, at EU868, a value of 2 represents MaxEIRP - 4 dB where MaxEIRP = +16 dBm.

Examples:

AT+TXP?

AT+TXP: Get or set the transmit power 
OK

AT+TXP=?

AT+TXP:0
OK

AT+TXP=0

OK

Back

AT+BAND

Description: Regional frequency band

This command allows the user to access and configure the regional frequency band.

Command Input Parameter Return Value Return Code
AT+BAND? - AT+BAND: Get and Set number corresponding to active regions OK
AT+BAND=? - 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 , 11 , 12 , 8 OK
AT+BAND=<Input Parameter> < 0 to 12 > - OK or AT_PARAM_ERROR

List of Band Parameter Options

Code Regional Band Code Regional Band
0 AS923-1 7 IN865
1 AU915 8 US915
2 CN470 9 AS923-2
3 CN779 10 AS923-3
4 EU433 11 AS923-4
5 EU868 12 RU864
6 KR920

Examples:

AT+BAND?

AT+BAND: Get and Set number corresponding to active regions 
OK

AT+BAND=?

AT+BAND:10
OK

AT+BAND=10

OK

AT+BAND=22

+CME ERROR:8

Back

AT+MASK

Description: Regional channel mask

This command allows the user to access and configure the regional channel mask. Channel mask can only be set for following regions: AU915, CN470 and US915

Command Input Parameter Return Value Return Code
AT+MASK? - AT+MASK: Get and Set channels mask OK
AT+MASK=? - 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 , 11 , 12 , 8 OK
AT+MASK=<Input Parameter> < 0 to 12 > - OK or AT_PARAM_ERROR

List of channel masks

Regional Band Available Channels
AU915 1 - 9
CN470 1 - 12
US915 1 - 9

Examples:

AT+MASK?

AT+MASK: Get and Set channels mask
OK

AT+MASK=?

AT+MASK:10
OK

AT+MASK=10

OK

AT+MASK=13

+CME ERROR:8

Back

AT+BAT

Description: Read the battery voltage

This command allows to read the battery voltage of the device

Command Input Parameter Return Value Return Code
AT+BAT? - AT+BAT: Get battery level OK
AT+BAT=? - < value > OK or AT+PARAM_ERROR

The battery level is returned as a value between 0 and 255

Examples:

AT+BAT?

+BAT:"Get battery level"
OK

AT+BAT=?

+BAT:254
OK

Back

AT+RSSI

Description: Receive signal strength indicator

This command allows the user to get RSSI value of the last packet received.

Command Input Parameter Return Value Return Code
AT+RSSI? - AT+RSSI: Get the RSSI of the last received packet OK
AT+RSSI=? - < integer > in dBm OK

Examples:

AT+RSSI?

AT+RSSI: Last RX packet RSSI 
OK

AT+RSSI=?

AT+RSSI:-41
OK

Back

AT+SNR

Description: Signal to Noise Ratio

This command allows the user to get SNR value of the last packet received.

Command Input Parameter Return Value Return Code
AT+SNR? - AT+SNR: Get the SNR of the last received packet OK
AT+SNR=? - < integer > OK

Examples:

AT+SNR?

AT+SNR: Last RX packet SNR 
OK

AT+SNR=?

AT+SNR:11
OK

Back

AT+VER

Description: Version of the firmware

This command allows the user to get firmware version installed on the device.

Command Input Parameter Return Value Return Code
AT+VER? - AT+VER: Get the version of the firmware OK
AT+VER=? - < V.x.y > OK

Examples:

AT+VER?

AT+VER: Get SW version 
OK

AT+VER=?

AT+VER:1.0.0.0 May 27 2021 17:11:12
OK

Back

AT+STATUS

Description: Show device status

This command allows the user to get the current device status.

Command Input Parameter Return Value Return Code
AT+STATUS? - AT+STATUS: Show LoRaWAN status OK
AT+STATUS=? - < status > OK

Examples:

AT+STATUS?

AT+STATUS: Show LoRaWAN status
OK

AT+STATUS=?
LoRaWAN status:
   Auto join disabled
   OTAA enabled
   Dev EUI 5032333338350012
   App EUI 1200353833333250
   App Key 50323333383500121200353833333250
   NWS Key 50323333383500121200353833333250
   Apps Key 50323333383500121200353833333250
   Dev Addr 83986D12
   Repeat time 120000
   ADR disabled
   Public Network
   Dutycycle disabled
   Join trials 10
   TX Power 0
   DR 3
   Class 0
   Subband 1
   Fport 2
   Unconfirmed Message
   Region 10
   Network joined

+STATUS: 
OK

Back

AT+NWM

Description: LoRa® network work mode (LoRaWAN® or P2P)

This command is used to switch to LoRaWAN® or (P2P)point-to-point mode.

Command Input Parameter Return Value Return Code
AT+NWM? - AT+NWM: Get or set the network work NWM (0:P2P, 1:LoRaWAN) OK
AT+NWM=? - *< 0 *> (P2P) or < 1 > (LoRaWAN)` -
AT+NWM=<Input Parameter> < 0 P2P or 1 LoRaWAN > - OK

Examples: Query status

AT+NWM=?

+NWM:0
OK

Switch from LoRa P2P to LoRaWAN

AT+NWM=1

Module will restart

Switch from LoRaWAN to LoRa P2P

AT+NWM=0

Module will restart

Back

AT+PFREQ

Description: P2P mode frequency

This command is used to access and configure P2P mode frequency.

Command Input Parameter Return Value Return Code
AT+PFREQ? - AT+NWM: Set P2P frequency OK
AT+PFREQ=? - < frequency > in Hz -
AT+PFREQ=<Input Parameter> < frequency > in Hz - OK

Examples:

AT+PFREQ=868000000

OK
AT+PFREQ=?

+PFREQ:916000000
OK

Back

AT+PSF

Description: P2P mode spreading factor

This command is used to access and configure P2P mode spreading factor.

Command Input Parameter Return Value Return Code
AT+PSF? - AT+NWM: Set P2P frequency OK
AT+PSF=? - < Spreading factor > -
AT+PSF=<Input Parameter> < 7 to 12 > - OK

Examples:

AT+PSF=9

OK
AT+PSF=?

+PSF:7
OK

Back

AT+PBW

Description: P2P mode bandwidth

This command is used to access and configure P2P mode bandwidth.

Command Input Parameter Return Value Return Code
AT+PBW? - AT+PBW: Set P2P bandwidth OK
AT+PBW=? - 125, 250, 500, 062, 041, 031, 020, 015, 010, 007 -
AT+PBW=<Input Parameter> < 125, 250, 500, 062, 041, 031, 020, 015, 010, 007 > - OK

Examples:

AT+PBW=125

OK
AT+PBW=?

+PBW:125
OK

Back

AT+PCR

Description: P2P mode coding rate

This command is used to access and configure P2P mode coding rate. (4/5=1, 4/6=2, 4/7=3, 4/8=4)

Command Input Parameter Return Value Return Code
AT+PCR? - AT+PCR: Set P2P coding rate OK
AT+PCR=? - 1, 2, 3, 4 -
AT+PCR=<Input Parameter> < 1, 2, 3, 4 > - OK

Examples:

AT+PCR=1

OK
AT+PCR=?

+PCR:1
OK

Back

AT+PPL

Description: P2P mode preamble length

This command is used to access and configure P2P mode preamble length.

Command Input Parameter Return Value Return Code
AT+PPL? - AT+PPL: Set P2P preamble length OK
AT+PPL=? - 1 to 254 -
AT+PPL=<Input Parameter> < 1 to 254 > - OK

Examples:

AT+PPL=8

OK
AT+PPL=?

+PPL:8
OK

Back

AT+PTP

Description: P2P mode coding rate

This command is used to access and configure P2P mode coding rate. (4/5=1, 4/6=2, 4/7=3, 4/8=4)

Command Input Parameter Return Value Return Code
AT+PTP? - AT+PTP: Set P2P TX power OK
AT+PTP=? - 0 to 22 -
AT+PTP=<Input Parameter> < 0 to 22 > - OK

Examples:

AT+PTP=22

OK
AT+PTP=?

+PTP:22
OK

Back

AT+P2P

Description: P2P configuration settings

This command is used to access and configure all P2P mode settings. Frequency, Spreading Factor, Bandwidth, Codingrate, Preamble Length, TX Power

Command Input Parameter Return Value Return Code
AT+P2P? - AT+PTP: Set P2P TX power OK
AT+P2P=? - Freq:SF:BW:CR:PPL:PWR -
AT+P2P=<Input Parameter> < Freq:SF:BW:CR:PPL:PWR* >* - OK

Examples:

AT+P2P=916000000:7:0:1:8:10

OK
AT+P2P=?

+P2P:916000000:7:0:1:8:10
OK

AT+PSEND

Description: P2P send data

This command is used to send P2P data.

Command Input Parameter Return Value Return Code
AT+PSEND? - AT+PSEND: P2P send data OK
AT+PSEND=<Input Parameter> < Payload > - OK

Examples:

AT+PSEND=313233

OK

REMARK Received data is not shown in the AT Command interface. The data has to be handled in the user application

Back

AT+PRECV

Description: P2P receive mode

This command is used to set the P2P RX mode and timeout for RX window.

Command Input Parameter Return Value Return Code
AT+PRECV? - AT+PRECV: P2P receive mode OK
AT+PRECV=? - *RX timeout in milliseconds OK
AT+PRECV=<Input Parameter> < Payload > - OK

Examples:

AT+PRECV=15000

OK

REMARK

  • If the value is set to 65534, the device will continuously listen to P2P LoRa TX packets without any timeout. This is the same as setting the device in RX mode.
  • If the value is set to 65535, the device will listen to P2P TX packets without a timeout. But it will stop listening once a P2P LoRa packet is received to save power.
  • If the value is 0, the device will stop listening to P2P TX packets. The device is in TX mode.

Back

AT+GNSS

Description: Set GNSS packet format

This command is used to switch the format of the LoRaWAN packet between three options.
0 => 4 digit standard CayenneLPP location format (smaller packet format)
1 => 6 digit extended CayenneLPP location format (higher location precision, requires custom payload decoders) 2 => Helium Mapper location format (for Helium Hotspot Mapper Application)

Command Input Parameter Return Value Return Code
AT+GNSS? - Get/Set the GNSS precision and format 0 = 4 digit, 1 = 6 digit, 2 = Helium Mapper OK
AT+GNSS=? - *0, 1 or 2 depending on the current format OK
AT+GNSS=<Input Parameter> < 0, 1 or 2 > - OK

Examples:

AT+GNSS=0

OK

REMARK

  • If 0, the payload can be decoded with standard CayenneLPP payload decoders that are available in most LoRaWAN servers, Helium Console and many integrations. This format works with Cayenne MyDevices.
  • If 1, the payload requires a custom payload decoder. Decoders can be found in the decoders folder. This format does NOT work with Cayenne MyDevices.
  • If 2, the payload is only working with the Helium Hotspot Mapper Application. More details can be found in the Make a Helium Mapper article.

Back

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

CN470/KR920

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

US915

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

AU915

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

IN865

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

Back

Appendix II TX Power by Region

EU868

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

US915

TXPower Configuration (Conducted Power)
0 30 dBm - 2*TXpower
1 28 dBm
2 26 dBm
3 ~ 9 -
10 10 dBm
11 ~ 15 RFU

AU915

By default, MaxEIRP is considered to be +30 dBm.

TXPower Configuration (EIRP)
0 MaxEIRP
1 ~ 10 MaxEIRP - 2*TXPower
11 ~ 10 RFU

KR920

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

AS923

By default, Max EIRP isconsidered 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

IN865

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

RU864

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

CN470

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

EU433

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

Back

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

US915

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

AU915

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

KR920

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

AS923

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

IN865

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

RU864

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

CN470

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

EU433

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

Back

LoRa® is a registered trademark or service mark of Semtech Corporation or its affiliates.
LoRaWAN® is a licensed mark.