Skip to content

Commit 5c22266

Browse files
committed
Docs: Typo fixes
1 parent 5fdde7f commit 5c22266

File tree

3 files changed

+11
-10
lines changed

3 files changed

+11
-10
lines changed

docs/operating_modes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Radio Linkup is performed during a discovery phase: The Server radio immediately
3535

3636
Benefits of Multipoint:
3737

38-
* Similar to P2P, simple to setup and use. Whatever serial comes in gets broadcast.
38+
* Similar to P2P, simple to set up and use. Whatever serial comes in gets broadcast.
3939
* Supports up to 32 radios. Data can be broadcast/shared between multiple receivers. This is helpful in setups such as GNSS RTK where a Base receiver broadcasts correction data to multiple Rovers simultaneously.
4040
* A larger continuous data stream can be transmitted. This assumes the user's application layer can handle lost packets graciously.
4141
* This mode is most friendly to very long distance transmissions where an ACK may not be possible.
@@ -90,7 +90,7 @@ The following parameters should be set to enable virtual circuit mode:
9090
* AT-Server=1 - Define this radio as the virtual circuit server
9191
* ATW - Write the parameters to the non-volatile memory (NVM).
9292

93-
Now enter training mode with the ATT command. The training enables the server to pass these parameters (except for server) to the client radios. On the client radios, with power applied, press the button at the top of the client radio to enter training mode. The radio will obtain the parameters from the server, write them to NVM and then reboot using the new parameters.
93+
Now enter training mode with the ATT command. The training enables the server to pass these parameters (excluding the AT-Server setting itself) to the client radios. On the client radios, with power applied, press the button at the top of the client radio to enter training mode. The radio will obtain the parameters from the server, write them to NVM and then reboot using the new parameters.
9494

9595
After all of the client radios are trained, the ATZ command may be entered on the server radio to cause it to reboot.
9696

docs/quick_start.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,18 @@ LoRaSerial is designed to get small amounts of data from point A to point B as e
2929

3030
## Additional Documentation
3131

32-
The LoRaSerial products are described in the [introduction](http://docs.sparkfun.com/SparkFun_LoRaSerial/intro/). The [radios](http://docs.sparkfun.com/SparkFun_LoRaSerial/hardware_overview/) support several [operating modes](http://docs.sparkfun.com/SparkFun_LoRaSerial/operating_modes/).
32+
The LoRaSerial products are described in the [introduction](http://docs.sparkfun.com/SparkFun_LoRaSerial/intro/). The [radios](http://docs.sparkfun.com/SparkFun_LoRaSerial/hardware_overview/) support several [operating modes](http://docs.sparkfun.com/SparkFun_LoRaSerial/operating_modes/).
3333

3434
* [Point-to-Point](https://docs.sparkfun.com/SparkFun_LoRaSerial/operating_modes/#point-to-point) with guaranteed delivery or the link breaks
35-
* [Multipoint](https://docs.sparkfun.com/SparkFun_LoRaSerial/operating_modes/#multipoint), two or more LoRaSerial radios, is best for realtime applications but uses broadcast datagrams that may be lost
36-
* [Virtual-Circuit](https://docs.sparkfun.com/SparkFun_LoRaSerial/operating_modes/#virtual-circuits) supports multipoint with guaranteed delivery or the link breaks. This mode uses a special serial interface.
35+
* [Multipoint](https://docs.sparkfun.com/SparkFun_LoRaSerial/operating_modes/#multipoint), two or more LoRaSerial radios, is best for real-time applications but uses broadcast datagrams that may be lost
36+
* [Virtual-Circuit](https://docs.sparkfun.com/SparkFun_LoRaSerial/operating_modes/#virtual-circuits) supports multipoint with guaranteed delivery or the link breaks. This mode uses a special serial interface.
3737

38-
Enter [command mode](http://docs.sparkfun.com/SparkFun_LoRaSerial/at_commands/) to change modes and adjust the parameters for that mode of operation. [Training ](http://docs.sparkfun.com/SparkFun_LoRaSerial/training/) is the process to distribute the set of parameters from a server radio (server=1) to the other client radios (server=0). Training can be done one radio at a time or multiple radios at once.
38+
Enter [command mode](http://docs.sparkfun.com/SparkFun_LoRaSerial/at_commands/) to change modes and adjust the parameters for that mode of operation. [Training](http://docs.sparkfun.com/SparkFun_LoRaSerial/training/) is the process to distribute the set of parameters from a server radio (server=1) to the other client radios (server=0). Training can be done one radio at a time or multiple radios at once.
3939

40-
The green LEDs by default display a received signal strength indication. The more LEDs that are on the better the signal. However other [LED patterns](http://docs.sparkfun.com/SparkFun_LoRaSerial/led_states/) are available to provide more data on the radio behavior.
40+
The green LEDs by default display a received signal strength indication. The more LEDs that are on the better the signal. However other [LED patterns](http://docs.sparkfun.com/SparkFun_LoRaSerial/led_states/) are available to provide more data on the radio behavior.
4141

42-
Occasionally, SparkFun may release new firmware for LoRaSerial. The
43-
[firmware update](http://docs.sparkfun.com/SparkFun_LoRaSerial/firmware_update/) procedure enables you to load the firmware into the LoRaSerial radio. Advanced users may also want to [build](http://docs.sparkfun.com/SparkFun_LoRaSerial/firmware_build/) the [open source LoRaSerial firmware](https://github.com/sparkfun/SparkFun_LoRaSerial).
42+
Occasionally, SparkFun may release new firmware for LoRaSerial. The
43+
[firmware update](http://docs.sparkfun.com/SparkFun_LoRaSerial/firmware_update/) procedure enables you to load the firmware into the LoRaSerial radio. Advanced users may also want to [build](http://docs.sparkfun.com/SparkFun_LoRaSerial/firmware_build/) the [open source LoRaSerial firmware](https://github.com/sparkfun/SparkFun_LoRaSerial).
4444

4545
### Hardware Documentation
4646

docs/training.md

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

3232
## Simple Point-To-Point Training
3333

34-
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.
34+
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 the new AES key and NetID, and the radios will reset, then 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.
3535

3636
## Factory Reset
3737

@@ -128,6 +128,7 @@ Client:
128128
* Reboots
129129

130130
Client:
131+
131132
* Connect to the LoRaSerial radio via USB or the serial port
132133
* Enter command mode using +++
133134
* Enter training using the ATT command

0 commit comments

Comments
 (0)