You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/at_commands.md
+14-17Lines changed: 14 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,17 +32,15 @@ Below is a brief list of commands:
32
32
33
33
*Table of AT Commands*
34
34
35
-
For a PDF of the AT commands, click [here](https://cdn.sparkfun.com/assets/learn_tutorials/2/6/1/7/LoRaSerial_Radio_Registers_-_AT_Commands.pdf).
35
+
[](img/LoRaSerial%20AT%20Radio%20Commands%20-%20v2.0.pdf)
36
36
37
-
The main user settable parameters are listed below and available [here](https://cdn.sparkfun.com/assets/learn_tutorials/2/6/1/7/LoRaSerial_Radio_Registers_-_Parameters.pdf) in PDF format. A parameter is set using the ATSx command. For example sending ‘ATS21=1’ will enable debug printing. This setting can be stored in NVM (non-volatile memory) by sending the ‘ATW’ command.
37
+
*Table of common radio link parameters*
38
38
39
-
Remote configuration is supported. If two radios are linked, all AT commands can be sent to the remote radio using the RT equivalent (ie, RTZ will reboot the remote radio). **Be careful** as it is very possible to break the link. For example, setting the remote AES key should be done first before setting the local AES key.
40
-
41
-
[](https://cdn.sparkfun.com/assets/learn_tutorials/2/6/1/7/LoRaSerial_Radio_Registers_-_Parameters.pdf)
39
+
A PDF of *all* AT commands is available [here](img/LoRaSerial%20AT%20Commands%20v2.0.pdf). A table of the subset of the common Radio Link Parameters is available [here](img/LoRaSerial%20AT%20Commands%20v2.0.pdf) in PDF format.
42
40
43
-
*Table of common parameters*
41
+
A parameter is set using the **AT-** prefix, followed by the name of the command with an equals sign and the value to set. For example sending **AT-Echo=1** will enable serial echo. This setting can be stored in NVM (non-volatile memory) by sending the **ATW** command. To query a setting, sending the AT command without a value and the device will respond with the current value. For example sending **AT-FrequencyMax** will generate the response **928.000** followed by **OK**.
44
42
45
-
The table of common parameters is available [here](https://cdn.sparkfun.com/assets/learn_tutorials/2/6/1/7/LoRaSerial_Radio_Registers_-_Parameters.pdf) in PDF format.
43
+
Remote configuration is supported. If two radios are linked, all AT commands can be sent to the remote radio using the RT equivalent (ie, RTZ will reboot the remote radio). **Be careful** as it is very possible to break the link. For example, setting the remote AES key should be done first before setting the local AES key.
46
44
47
45
## Radio Commands
48
46
@@ -81,17 +79,16 @@ The table of common parameters is available [here](https://cdn.sparkfun.com/asse
81
79
82
80
*Table of Radio Commands*
83
81
84
-
***AirSpeed** - This is the effective rate in bits-per-second at which data is sent over the air. In general, the lower the air speed, the greater the transmission distance. LoRaSerial uses buffers to receive and send serial over USB or UART at the *SerialSpeed* and begins sending that data in chunks over the air at the AirSpeed. The *AirSpeed* setting does not have to match the SerialSpeed. It is recommended to limit the total incoming data to match the AirSpeed. For example, regularly sending a group of 300 bytes with an air speed of 4800 bps (480 bytes per second) will allow the radio sufficient bandwidth. Sending 1,000 bytes per second with an air speed of 4800 bps (480 bytes per second) will within a few seconds overwhelm the link leading to buffer overflow and data loss. Default is 4800bps. Allowed values are 400, 1200, 2400, 4800, 9600, and 19200 bits per second.
85
-
86
-
Changing the AirSpeed value overwrites the following settings:
87
82
88
-
* HeartbeatTimeout
89
-
* RadioBandwidth
90
-
* RadioCodingRate
91
-
* RadioSpreadFactor
92
-
* TxToRxUsec
83
+
***AirSpeed** - This is the effective rate in bits-per-second at which data is sent over the air. In general, the lower the air speed, the greater the transmission distance. LoRaSerial uses buffers to receive and send serial over USB or UART at the *SerialSpeed* and begins sending that data in chunks over the air at the AirSpeed. The *AirSpeed* setting does not have to match the SerialSpeed. It is recommended to limit the total incoming data to match the AirSpeed. For example, regularly sending a group of 300 bytes with an air speed of 4800 bps (480 bytes per second) will allow the radio sufficient bandwidth. Sending 1,000 bytes per second with an air speed of 4800 bps (480 bytes per second) will within a few seconds overwhelm the link leading to buffer overflow and data loss. Default is 4800bps. Allowed values are 400, 1200, 2400, 4800, 9600, and 19200 bits per second. Changing the AirSpeed value overwrites the following 5 parameters:
93
84
94
-
After AirSpeed is set, it is possible to modify any of the parameters above. Note that AirSpeed is just an easy way to set the parameters above to known value. AirSpeed is not a parameter that is transmitted during training, merely a convenient way to set the above parameters in one step.
85
+
+ HeartbeatTimeout
86
+
+ RadioBandwidth
87
+
+ RadioCodingRate
88
+
+ RadioSpreadFactor
89
+
+ TxToRxUsec
90
+
91
+
After AirSpeed is set, it is possible to modify any of the above five parameters. Note that AirSpeed is just an easy way to set the five parameters to known values. AirSpeed is not a parameter that is transmitted during training, merely a convenient way to set the five parameters in one step.
95
92
96
93
***AutoTune** - Enabling autotune will cause the radio to tune the receiver frequency based on the calculated frequency error. This is used for testing and is not recommended for general use.
97
94
@@ -231,4 +228,4 @@ After AirSpeed is set, it is possible to modify any of the parameters above. Not
231
228
232
229
***ATI14** - Displays the contents of the current transmit buffer.
233
230
234
-
***ATI15** - Displays a list of all the unique IDs of the Virtual Circuit known clients.
231
+
***ATI15** - Displays a list of all the unique IDs of the known clients used in Virtual Circuit mode.
0 commit comments