Skip to content

Commit 69215be

Browse files
committed
Update docs
1 parent a28dbc9 commit 69215be

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

docs/at_commands.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
LoRaSerial radios are very flexible. By default, the radio is looking for serial communication at 57600bps. Open the terminal of your choice and enter +++ and wait for an OK. The radio is now ready for an AT command.
44

5+
A PDF of *all* AT commands is available [here](img/LoRaSerial%20AT%20Commands%20v2.0.pdf).
6+
57
Below is a brief list of commands:
68

79
| AT Command | Command Description |
@@ -32,18 +34,27 @@ Below is a brief list of commands:
3234

3335
*Table of AT Commands*
3436

35-
[![Table of common radio parameters](img/SparkFun_LoRaSerial_AT_Radio_Commands_v2.0.png)](img/LoRaSerial%20AT%20Radio%20Commands%20-%20v2.0.pdf)
37+
The commands are best discussed in groups:
3638

37-
*Table of common radio link parameters*
38-
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.
39+
* [Radio Commands](http://docs.sparkfun.com/SparkFun_LoRaSerial/at_commands/#radio-commands)
40+
* [Serial Commands](http://docs.sparkfun.com/SparkFun_LoRaSerial/at_commands/#serial-commands)
41+
* [Info Commands](http://docs.sparkfun.com/SparkFun_LoRaSerial/at_commands/#info-commands)
42+
* Debug Commands
4043

4144
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**.
4245

4346
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.
4447

4548
## Radio Commands
4649

50+
[![Table of common radio parameters](img/SparkFun_LoRaSerial_AT_Radio_Commands_v2.0.png)](img/LoRaSerial%20AT%20Radio%20Commands%20-%20v2.0.pdf)
51+
52+
*Table of common radio link parameters*
53+
54+
A table of the subset of the common Radio Link Parameters is available [here](img/LoRaSerial%20AT%20Commands%20v2.0.pdf) in PDF format.
55+
56+
**Note:** Some settings must be identical on both radios for the link to be possible. These settings are used to generate the unique hop table. If settings are not compatible between radios, they will not be able to communicate.
57+
4758
| AT Command | Command Description |
4859
|------------|------------------------------------------|
4960
| AT-AirSpeed | Data rate over the air. Overrides bandwidth, spread, and coding.

docs/training.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This mode (Training as Server) is convenient when multiple clients need to be pa
2727

2828
## Simple Point-To-Point Training
2929

30-
If a radio is set for P2P mode, entering training mode as a server will generate a new random NetID and AES key. In other words, holding the Train button for 5 seconds on one radio will cause that radio to generate new, unique/secure P2P settings. On the other radio, hold the Train button for 2 seconds. This is helpful in the field if you need to put a pair of radios onto a different network and encryption key from other radios that may be nearby.
30+
If a radio is set for P2P mode, entering training mode as a server will generate a new random NetID and AES key. In other words, holding the Train button for 5 seconds on one radio will cause that radio to generate new, unique/secure P2P settings. On the other radio, hold the Train button for 2 seconds. The radios will be trained to these new AES key and NetID, the radios will reset, and immediately link up. This is helpful in the field if you need to put a pair of radios onto a different network and encryption key from other radios that may be nearby.
3131

3232
## Factory Reset
3333

0 commit comments

Comments
 (0)