Skip to content

Commit a8d9b5c

Browse files
committed
Quick Start: Add references to command mode
Mention that command mode can be used to change the network ID and encryption key. Add links to the other documentation. ------ Note that the various web browsers behave differently. While Microsoft Edge might display the menu as a list of items on the left, Google Chrome only displays a menu icon and unless the user knows that there is a menu, the icon is easy to miss. As such, I recommend adding a short paragraphs describing the other sections of the documentation and include a link in the paragraph. This way if the user does not notice the menu button they still have access to the full documentation.
1 parent 1223973 commit a8d9b5c

File tree

1 file changed

+33
-7
lines changed

1 file changed

+33
-7
lines changed

docs/quick_start.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,44 @@ LoRaSerial radios are very easy to use and ship ready to connect out of the box.
99
The default settings are as follows:
1010

1111
* **Mode:** Point to Point
12-
* **Frequency:** 902 to 928MHz
12+
* **Frequency:** 902 to 928 MHz
1313
* **Channels:** 50
1414
* **Frequency Hopping:** Enabled
15-
* **Broadcast Power:** 30dbm
16-
* **Airspeed:** 4800bps
17-
* **Serial:** 57600bps
15+
* **Broadcast Power:** 30 dbm
16+
* **Airspeed:** 4800 bps
17+
* **Serial:** 57600 bps
1818
* **Encryption:** Enabled
1919
* **Encryption Key:** Default<sup>1</sup>
2020
* **Software CRC:** Enabled
2121

22-
Serial can be passed into the unit either through the USB port, or over the serial connector. If the serial connector is used, the baud rate is 57600bps by default.
22+
<sup>1</sup> The radios default to a published encryption key. For maximum security, we recommend changing the key and network ID value using command mode or the [training process](http://docs.sparkfun.com/SparkFun_LoRaSerial/training/).
2323

24-
<sup>1</sup> The radios default to a published encryption key. For maximum security, we recommend changing the key using the [training process](http://docs.sparkfun.com/SparkFun_LoRaSerial/training/).
24+
Serial can be passed into the unit either through the USB port, or over the serial connector. If the serial connector is used, the baud rate is 57600 bps by default.
2525

26-
LoRaSerial is designed to get small amounts of data from point A to point B as easily as possible. If you've got a sensor, or Arduino, or any device that can output serial, then it can transmit data over long distances. LoRaSerial has been used to send data over 9 miles (14km) line-of-sight.
26+
LoRaSerial is designed to get small amounts of data from point A to point B as easily as possible. If you've got a sensor, or Arduino, or any device that can output serial, then it can transmit data over long distances. LoRaSerial has been used to send data over 9 miles (14 km) line-of-sight.
27+
28+
## Additional Documentation
29+
30+
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/).
31+
32+
* [Point-to-Point](https://docs.sparkfun.com/SparkFun_LoRaSerial/operating_modes/#point-to-point) with guaranteed delivery or the link breaks
33+
* [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
34+
* [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+
36+
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.
37+
38+
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.
39+
40+
Occasionally, SparkFun may release new firmware for LoRaSerial. The
41+
[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+
43+
### Hardware Documentation
44+
45+
The following hardware documents are available:
46+
47+
* [Schematic](https://cdn.sparkfun.com/assets/b/e/9/a/d/SparkFun_LoRaSerial_915MHz_-_1W.pdf)
48+
* [Eagle Files](https://cdn.sparkfun.com/assets/f/b/b/6/f/SparkFun_LoRaSerial_915MHz_-_1W.zip)
49+
* [Semtech SX1276 datasheet](https://cdn.sparkfun.com/assets/7/7/3/2/2/SX1276_Datasheet.pdf)
50+
* [Ebyte E19-915M30S Datasheet](https://cdn.sparkfun.com/assets/6/3/e/e/3/E19-915M30S_Usermanual_EN_v1.20.pdf)
51+
* [Atmel SAMD-21 datasheet](https://cdn.sparkfun.com/datasheets/Dev/Arduino/Boards/Atmel-42181-SAM-D21_Datasheet.pdf)
52+
* [Understanding LoRa PHY](https://wirelesspi.com/understanding-lora-phy-long-range-physical-layer/) - A good article on the math behind Semtec's Long Range modulation technique

0 commit comments

Comments
 (0)