Skip to content

Conversation

@LeeLeahy2
Copy link
Contributor

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.

@LeeLeahy2
Copy link
Contributor Author

Quick Start Guide

LoRaSerial radios are very easy to use and ship ready to connect out of the box. Simply attach the antennas, plug two units into USB ports, open a terminal at each of the USB serial ports, and start passing data back and forth.

Passing text between two terminals

Passing simple text data between two radios

The default settings are as follows:

  • Mode: Point to Point
  • Frequency: 902 to 928 MHz
  • Channels: 50
  • Frequency Hopping: Enabled
  • Broadcast Power: 30 dbm
  • Airspeed: 4800 bps
  • Serial: 57600 bps
  • Encryption: Enabled
  • Encryption Key: Default1
  • Software CRC: Enabled

1 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.

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.

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.

Additional Documentation

The LoRaSerial products are described in the introduction. The radios support several operating modes.

  • Point-to-Point with guaranteed delivery or the link breaks
  • Multipoint, two or more LoRaSerial radios, is best for realtime applications but uses broadcast datagrams that may be lost
  • Virtual-Circuit supports multipoint with guaranteed delivery or the link breaks. This mode uses a special serial interface.

Enter command mode to change modes and adjust the parameters for that mode of operation. 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.

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 are available to provide more data on the radio behavior.

Occasionally, SparkFun may release new firmware for LoRaSerial. The
firmware update procedure enables you to load the firmware into the LoRaSerial radio. Advanced users may also want to build the open source LoRaSerial firmware.

Hardware Documentation

The following hardware documents are available:

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.
@nseidle nseidle merged commit a93ef6a into sparkfun:main Feb 21, 2023
@LeeLeahy2 LeeLeahy2 deleted the quick-start branch September 3, 2023 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants