README update

hudsonvalleydigitalnetwork · Aug 2, 2020 · cb5481b · cb5481b
1 parent 414a0d0
commit cb5481b
Showing 1 changed file with 45 additions and 4 deletions.
diff --git a/stable/README.md b/stable/README.md
@@ -1,6 +1,6 @@
-# RC (Release Candidate)
+# Stable
 
-All code in this folder is candidate for next release.
+All core application and supporting code in this folder is considered stable.
 
 ## Required Dependencies
 
@@ -20,14 +20,20 @@ ans libraries
 ### HASviolet.ini
 * Config file used by HASviolet apps
 
+### HASviolet-duckhunt.ini
+* Config file used by DuckHunt
+
 ### HASvioletHID
 * Library used by HASviolet apps that contains all HID Module related classes and methods
 
 ### HASvioletRF
 * Library used by HASviolet apps that contains all RF Module related classes and methods
 
+### HASviolet.service
+* Systemd service file to start HASviolet-handheld.py
+
 
-## HASviolet Applications
+## HASviolet Core Applications
 
 Standalone applications
 
@@ -46,8 +52,17 @@ Standalone applications
 ### HASviolet-chat.py
   Interactive half-duplex chat program
 
+### HASviolet-config.py
+  Setup HASviolet device. Generates HASviolet.ini
+
+### HASviolet-duckhunt-config.py
+  Setup DuckHunt. Generates HASviolet-duckhunt.ini
+
 ### HASviolet-handheld.py
-  Currently only a menu demo of Hanheld feature
+  Background app started by systemd to use HASviolet with  HAT buttons and OLED
+
+### HASviolet-service.sh
+  Disable HASviolet-handheld from ssh session
 
 ### HASviolet-rx.py
  Listens for messages from other LoRa stations
@@ -71,3 +86,29 @@ Standalone applications
            -d Destination (if omitted BEACON-99 is default)
            -m message to be sent within double quotes
   ```
+
+## HASviolet Handheld Use
+With the OLED and three buttons on the bonnet, core functionality is available to you
+on startup.
+
+Systemd runs HASviolet.service on startup
+HASviolet.service starts HASviolet-handheld.py
+
+No other RF transmissions can occur when running as handheld. To disable you
+can select EXIT from the OLED menu or SSH into the Pi and run
+
+  HASviolet-service.sh stop
+
+If you would like to remove from startup then
+
+  HASviolet-service.sh remove
+
+
+## Sample Applications
+
+This includes applications used with USB and i2c based sensors
+
+* HASviolet-atmos.py
+* HASviolet-distance.py
+* HASviolet-gps.py
+* HASviolet-sensors.py