Merge pull request #10 from sparkfun/main

Move main to the develop branch
sparkfun · Jan 14, 2025 · e24603c · e24603c
2 parents b725e6e + 6cbc05c
commit e24603c
Show file tree

Hide file tree

Showing 51 changed files with 863 additions and 216 deletions.
diff --git a/.github/workflows/build-iotnode-lorawan-develop.yml b/.github/workflows/build-iotnode-lorawan-develop.yml
diff --git a/.github/workflows/build-iotnode-lorawan-release1.0.0.yml b/.github/workflows/build-iotnode-lorawan-release1.0.0.yml
diff --git a/.github/workflows/build-iotnode-lorawan.yml b/.github/workflows/build-iotnode-lorawan.yml
@@ -1,11 +1,14 @@
 name: IoT Node - LoRaWAN -  Firmware build Action
 on:
   push:
-    branches:
-      - main
 
   workflow_dispatch:
     branches:
+      - 'main'
+      - 'develop'
+      - 'feature/**'
+      - 'release/**'
+      - 'hotfix/**'
 
 env:
   ARDUINO_RP2040_DIR: .arduino15/packages/rp2040/hardware/rp2040/4.3.1
@@ -20,8 +23,6 @@ jobs:
     steps:
       - name: Checkout Repo and submodules
         uses: actions/checkout@v3
-        with:
-          ref: main
 
       # checkout flux-sdk
       - name: Checkout the flux-sdk

diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml
@@ -0,0 +1,37 @@
+name: Run mkdocs
+on:
+  push:
+    branches:
+      - main
+
+  workflow_dispatch:
+    branches:
+
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Python runtime
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+
+      - name: Install Python dependencies
+        run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-with-pdf weasyprint mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2
+
+      - name: Set up build cache
+        uses: actions/cache@v2
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+
+      - name: Install Insiders build
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+        run: pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
+      - run: mkdocs gh-deploy --force
diff --git a/README.md b/README.md
@@ -1,8 +1,41 @@
-# sfe-iot-node-lorawan
-IoT Node Firmware for a Dig LoRaWAN deployment
 
-### Compile command
+![SparkFun IoT Node - LoRaWAN Firmware](https://github.com/sparkfun/sfe-iot-node-lorawan/blob/main/docs/assets/img/IoT-Node-LoRaWAN-Banner.jpg "SparkFun IoT Node - LoRaWAN")
 
-```
-arduino-cli compile --fqbn rp2040:rp2040:sparkfun_promicrorp2350 --export-binaries ./sfeIoTNodeLoRaWAN/sfeIoTNodeLoRaWAN.ino --library `pwd`/SparkFun_Flux
-```
+# SparkFun IoT Node - LoRaWAN
+
+Firmware and associated Documentation and Firmware for the SparkFun IoT Node - LoRaWAN product
+
+![Release](https://img.shields.io/github/v/release/sparkfun/sfe-iot-node-lorawan)
+![Release Date](https://img.shields.io/github/release-date/sparkfun/sfe-iot-node-lorawan?display_date=published_at)
+![Documentation - build](https://img.shields.io/github/actions/workflow/status/sparkfun/sfe-iot-node-lorawan/pages%2Fpages-build-deployment?label=Documentation)
+[![IoT Node - LoRaWAN - build](https://github.com/sparkfun/sfe-iot-node-lorawan/actions/workflows/build-iotnode-lorawan-develop.yml/badge.svg)](https://github.com/sparkfun/sfe-iot-node-lorawan/actions/workflows/build-iotnode-lorawan-develop.yml)
+![GitHub issues](https://img.shields.io/github/issues/sparkfun/sfe-iot-node-lorawan)
+
+This repository contains the latest firmware for the SparkFun IoT Node - LoRaWAN development board. While the IoT Node - LoRaWAN development board is programmable using Arduino, the IoT Node - LoRa board ships with a firmware application that enables rapid sensor definition and deployment on a Digi LoRaWAN XON network. This repository contains the source for this LoRaWAN application and well as firmware releases.
+
+The IoT Node - LoRaWAN firmware is pre-programmed to automatically log data from 25+ SparkFun [Qwiic](https://www.sparkfun.com/qwiic) sensors, all without requiring any hardware setup or code development. Just plug in a qwiic board, and log data to the LoRaWAN network. The IoT Node - LoRaWAN board automatically detects the connected sensor, configures the device and enables logging to the serial console and, if connected, to the Digi LoRaWAN network.
+
+The SparkFun IoT Node - LoRaWAN board and firmware are designed to enable posting data to the LoRaWAN network within minutes, requiring no development or configuration. The SparkFun IoT Node - LoRaWAN board is configured to work with the Dig LoRaWAN network. Once the board is registered with your Digi XON account (via the on-board digital data tag - which is similar to a QR code), the board with this firmware should automatically connect to your Digi LoRaWAN account. Connect a supported qwiic sensor and data is automatically posted to the LoRaWAN network.
+
+The IoT Node - LoRaWAN firmware is highly configurable via an easily to use serial interface. Simply plug in a USB C cable and open a terminal at 115200 Kbps. By default the logging output is automatically streamed to the serial terminal - pressing any key will bring up the menu system. 
+
+Details are outlined in [IoT Node - LoRaWAN Documentation](https://docs.sparkfun.com/sfe-iot-node-lorawan).
+
+
+## Latest Firmware
+
+* Version 01.00.00 - [Release](https://github.com/sparkfun/sfe-iot-node-lorawan/releases/tag/v01.00.00)
+
+## Documentation
+
+* **[Hardware Hookup Guide](https://docs.sparkfun.com/SparkFun_IoT_Node_LoRaWAN/quick_start/)** - Basic hookup guide for the SparkFun IoT Node - LoRaWAN board
+* **GitHub Hardware Repo**
+  * **[SparkFun IoT Node - LoRaWAN](https://github.com/sparkfun/SparkFun_IoT_Node_LoRaWAN)**
+
+## Supported Products
+
+* **[DEV-26060](https://www.sparkfun.com/products/26060)** - SparkFun IoT Node - LoRaWAN
+
+### Latest Release
+
+Details on the latest Firmware release are listed on the [Release Page](https://github.com/sparkfun/sfe-iot-node-lorawan/releases)
diff --git a/docs/assets/img/IoT-Node-LoRaWAN-Banner.jpg b/docs/assets/img/IoT-Node-LoRaWAN-Banner.jpg
diff --git a/docs/assets/img/advanced-data-encoding-output.png b/docs/assets/img/advanced-data-encoding-output.png
diff --git a/docs/assets/img/digi-device-list.png b/docs/assets/img/digi-device-list.png
diff --git a/docs/assets/img/digi-device-messages.png b/docs/assets/img/digi-device-messages.png
diff --git a/docs/assets/img/digi-lora-provision-end.png b/docs/assets/img/digi-lora-provision-end.png
diff --git a/docs/assets/img/digi-lora-scan-begin.png b/docs/assets/img/digi-lora-scan-begin.png
diff --git a/docs/assets/img/digi-xon-a-device.png b/docs/assets/img/digi-xon-a-device.png
diff --git a/docs/assets/img/digi-xon-devices.png b/docs/assets/img/digi-xon-devices.png
diff --git a/docs/assets/img/node-sent-messages.png b/docs/assets/img/node-sent-messages.png
diff --git a/docs/assets/img/opreation-led-cmd.png b/docs/assets/img/opreation-led-cmd.png
diff --git a/docs/assets/img/settings-device-page.png b/docs/assets/img/settings-device-page.png
diff --git a/docs/assets/img/settings_all_settings.png b/docs/assets/img/settings_all_settings.png
diff --git a/docs/assets/img/settings_application.png b/docs/assets/img/settings_application.png
diff --git a/docs/assets/img/settings_device_ens160.png b/docs/assets/img/settings_device_ens160.png
diff --git a/docs/assets/img/settings_device_list.png b/docs/assets/img/settings_device_list.png
diff --git a/docs/assets/img/settings_entry_range.png b/docs/assets/img/settings_entry_range.png
diff --git a/docs/assets/img/settings_entry_select.png b/docs/assets/img/settings_entry_select.png
diff --git a/docs/assets/img/settings_function.png b/docs/assets/img/settings_function.png
diff --git a/docs/assets/img/settings_function_prompt.png b/docs/assets/img/settings_function_prompt.png
diff --git a/docs/assets/img/settings_logger.png b/docs/assets/img/settings_logger.png
diff --git a/docs/assets/img/settings_lorawan.png b/docs/assets/img/settings_lorawan.png
diff --git a/docs/assets/img/settings_prompt_simple.png b/docs/assets/img/settings_prompt_simple.png
diff --git a/docs/assets/img/settings_save_settings.png b/docs/assets/img/settings_save_settings.png
diff --git a/docs/assets/img/settings_startupmenu.png b/docs/assets/img/settings_startupmenu.png
diff --git a/docs/assets/img/settings_system.png b/docs/assets/img/settings_system.png
diff --git a/docs/assets/img/settings_time.png b/docs/assets/img/settings_time.png
diff --git a/docs/assets/img/settings_timer.png b/docs/assets/img/settings_timer.png
diff --git a/docs/assets/img/settings_top_menu.png b/docs/assets/img/settings_top_menu.png
diff --git a/docs/assets/img/verbose-lora-message.png b/docs/assets/img/verbose-lora-message.png
diff --git a/docs/assets/img/verbose-startup.png b/docs/assets/img/verbose-startup.png
diff --git a/docs/assets/img/verbose-value-type.png b/docs/assets/img/verbose-value-type.png
diff --git a/docs/console_commands.md b/docs/console_commands.md
@@ -0,0 +1,35 @@
+# IOT Node - LoRaWAN - Console Commands
+
+The serial console interactive menu system of the IoT Node - LoRaWAN an intuitive, dynamic and flexible methodology to interact with the system configuration.While extremely capable, when performing common admin or debugging tasks the menu system is an impediment to the desired operation. A fast, interactive solution is needed.
+
+To provide rapid access to common administration and debugging commands, the IoT Node - LoRaWAN firmware provides a set of commands that are entered directly into the console. Starting with a "!" (bang), these commands are referred to as ***Console Commands*** or ***Bang Commands***.
+
+## Available Commands
+
+The following commands are available:
+
+|Command | Description|
+|:---|:----|
+|<nobr>!reset-device-forced</nobr>|Resets the device (clears settings and restarts the device) without a prompt|
+|<nobr>!reset-device</nobr>| Resets the device (clears settings and restarts the device) with a [Yes/No] prompt|
+|<nobr>!clear-settings</nobr>|Clears the on-device saved settings with a [Yes/No] prompt|
+|<nobr>!clear-settings-forced</nobr>|Clears the on-device saved settings without a prompt|
+|<nobr>!restart</nobr>|Restarts the device with a [Yes/No] prompt|
+|<nobr>!restart-forced</nobr>|Restarts the device without a prompt|
+|<nobr>!log-rate</nobr>|Outputs the current log-rate of the device (milliseconds between logging transactions)|
+|<nobr>!log-rate-toggle</nobr>|Toggle the on/off state of the log rate data recording by the system. This value is not persisted to on-board settings unless the settings are saved.|
+|<nobr>!devices</nobr>|Lists the currently connected devices|
+|<nobr>!save-settings</nobr>|Saves the current system settings to the preference system|
+|<nobr>!verbose</nobr>|Toggles Verbose output/message mode. This value is not persistent|
+|<nobr>!heap</nobr>|Outputs the current statistics of the system heap memory|
+|<nobr>!log-now</nobr>|Trigger a data logging event|
+|<nobr>!lora-status</nobr>|Display the status and settings of the LoRaWAN|
+|<nobr>!about</nobr>|Outputs the full *About* page of the Node Board|
+|<nobr>!version</nobr>|Outputs the firmware version|
+|<nobr>!help</nobr>|Outputs the available *!* commands|
+
+### Command Usage
+
+To use a *Bang Command*, connect to the target IoT Node - LoRaWAN device via a serial console. and enter the command, starting with a `!` symbol  Entering any other character will launch the standard DataLogger IoT menu system. When the `!` symbol is pressed, a prompt **>** should appear. 
+
+> Note: Since most *Bang Commands* are not interactive, they also enable commanding by another device, such as a computer attached to the IoT Node board.