Merge pull request #504 from sparkfun/release_candidate

Merge v2 into main

Author: nseidle

.gitignore

@@ -7,6 +7,9 @@ ehthumbs.db
 *.b#?
 *.l#?
 *.lck
+.vscode/*
+/Firmware/LoRaSerial_Firmware/.vscode/*
+/Firmware/build/*
 
 # Folder config file
 Desktop.ini
@@ -27,16 +30,29 @@ $RECYCLE.BIN/
 # OSX
 # =========================
 
-.DS_Store
-.AppleDouble
-.LSOverride
-
-# Icon must ends with two \r.
-Icon
-
-# Thumbnails
-._*
-
-# Files that might appear on external disk
-.Spotlight-V100
-.Trashes
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must ends with two \r.
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes
+
+# Linux
+# =========================
+
+# Object files
+*.o
+
+# Archives (Libraries)
+*.a
+
+# Executables
+Firmware/Tools/VcServerTest

Binaries/Programming_Tools/SparkFun_LoRaSerial_RC-Feb_09_2023_with_bootloader.bin

@@ -0,0 +1,26 @@
+@echo off
+if [%1]==[] goto usage
+
+@echo Programming for SparkFun LoRaSerial
+@pause
+:loop
+
+@echo -
+@echo Programming binary: %1
+
+@echo Unlock bootloader
+atprogram.exe -t samice -i swd -cl 20mhz -d atsamd21g18a write --fuses --offset 0x804000 --values 0xFFC7E0D8
+
+@echo Programming firmware
+atprogram.exe -t samice -i swd -cl 20mhz -d atsamd21g18a chiperase program -f %1 --verify
+
+@echo Lock bootloader
+atprogram.exe -t samice -i swd -cl 20mhz -d atsamd21g18a write --fuses --offset 0x804000 --values 0xFAC7E0D8
+
+@echo Done programming! Ready for next board.
+@pause
+
+goto loop
+
+:usage
+@echo Missing the hex file. Ex: batch_program.bat LoRaSerial_Firmware_v10_Combined.hex

Binaries/Programming_Tools/atprogram.exe

@@ -0,0 +1 @@
+atprogram.exe -t atmelice -i swd -cl 10mhz -d atsamd21g18a read --file production.hex --size 244000

Binaries/Programming_Tools/batch_program.bat

@@ -0,0 +1,28 @@
+LoRaSerial Documents and Airspeed Calculations
+========================================
+
+[![SparkFun LoRaSerial Airspeed Spreadsheet](LoRaSerial%20Airspeed%20Spreadsheet.jpg)](https://docs.google.com/spreadsheets/d/1qyJa3ldE-KDUHwHNSctBMccPTVRwKbmAsodkdvOc3-8/edit?usp=sharing)
+
+The available airspeeds (40 to 38400) used in LoRaSerial were picked to, as closely as possible, mimic modem baud rates. Other spread factors, bandwidths, and coding rates can be used if desired.
+
+[This spreadsheet](https://docs.google.com/spreadsheets/d/1qyJa3ldE-KDUHwHNSctBMccPTVRwKbmAsodkdvOc3-8/edit?usp=sharing) can be used to inspect the airtime formulas.
+
+Additionally, this folder contains the various datasheets for the SX1276 IC, common to all LoRaSerial modules, as well as the individual datasheets for the different module types (915, 868, 433, etc).
+
+[Atmel SAM D21G Datasheet](https://cdn.sparkfun.com/datasheets/Dev/Arduino/Boards/Atmel-42181-SAM-D21_Datasheet.pdf)
+
+## Modes of Operation
+
+The LoRaSerial radio operates in one of three modes:
+* Point-to-Point (default)
+* Multipoint
+* Virtual Circuit
+* Training
+
+Point-to-Point mode provides guaranteed message delivery or the link breaks.  The radio performs data retransmission if either the data frame was lost or its acknowledgement was lost.  This can continue indefinitely if MaxResends equals zero (default) or for a limited number of retries in the range of (1 - 255).
+
+Multipoint mode provides a datagram service.  The LoRaSerial radios will send the data frame without a guarantee that the frame will be received by the remote radio. Lost frames are lost, the radio does no perform retransmission.  If the application is not able to tolerate the lost frames then another protocol layer needs to be implemented on the host computer between the radio and the application that provides the necessary services to the application.
+
+Virtual circuit mode enables a group of radios to communicate with each other. The radio links provide guaranteed message delivery or the link is broken. One radio in the group is designated as the server and provides the channel timer synchronization for the client radios, think of a star configuration with the server at the center.  Data communications with the virtual circuit mode is all point-to-point.  Communications between the radio and the host CPU use a special virtual circuit header to identify where to send the host to radio data, or where to deliver the radio to host data.  More information is available [here](https://github.com/sparkfun/SparkFun_LoRaSerial/blob/release_candidate/Documents/Virtual_Circuits.md).
+
+Training is a temporary mode of operation to initialize a set of radios for one of the other modes of operation.  There are one or more clients and a single server during training.  The mode specific parameters for the other mode of operation are passed from the server to each of the clients.  Upon completion all of the radios in the set will be able to communicate with one another.  More information on training is available [here](https://github.com/sparkfun/SparkFun_LoRaSerial/blob/release_candidate/Documents/Training.md).