Merge pull request #12 from sparkfun/develop

Develop

Author: gigapod

.github/workflows/build-iotnode-lorawan.yml

@@ -27,7 +27,7 @@ jobs:
       # checkout flux-sdk
       - name: Checkout the flux-sdk
         run: |
-          git clone --branch release/iot-node-lorawan-release https://github.com/sparkfun/flux-sdk.git
+          git clone --branch release/iot-node-lorawan-release-v1.0.0 https://github.com/sparkfun/flux-sdk.git
           echo "FLUX_SDK_PATH=`pwd`/flux-sdk" >> $GITHUB_ENV
 
       # Run cmake - this will build a custom SparkFun_Flux library we can use with
@@ -86,7 +86,7 @@ jobs:
           --export-binaries --clean --library `pwd`/SparkFun_IoTNodeLoRaWAN
 
       # Upload the build files - bootloader, paritions, firmware
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: Upload Build
           path: sfeIoTNodeLoRaWAN/build/rp2040.rp2040.sparkfun_iotnode_lorawanrp2350/sfeIoTNodeLoRaWAN.ino.uf2

README.md

@@ -8,7 +8,7 @@ Firmware and associated Documentation and Firmware for the SparkFun IoT Node - L
 ![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)
+[![IoT Node - LoRaWAN - build](https://github.com/sparkfun/sfe-iot-node-lorawan/actions/workflows/build-iotnode-lorawan.yml/badge.svg)](https://github.com/sparkfun/sfe-iot-node-lorawan/actions/workflows/build-iotnode-lorawan.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.

sfeIoTNodeLoRaWAN/sfeIoTNodeLoRaWAN.cpp

@@ -500,7 +500,11 @@ uint8_t sfeIoTNodeLoRaWAN::get_logTypeSer(void)
 {
     return _logTypeSer;
 }
-//---------------------------------------------------------------------------
+/**
+ * @brief      Sets the log type for serial output
+ *
+ * @param[in]  logType  The log type
+ */
 void sfeIoTNodeLoRaWAN::set_logTypeSer(uint8_t logType)
 {
     if (logType == _logTypeSer)
@@ -521,11 +525,22 @@ void sfeIoTNodeLoRaWAN::set_logTypeSer(uint8_t logType)
 
 //---------------------------------------------------------------------------
 // local/board name things
+/**
+ * @brief      Getter for the  the local name property
+ *
+ * @return     The local name.
+ */
+
 std::string sfeIoTNodeLoRaWAN::get_local_name(void)
 {
     return flux.localName();
 }
 //---------------------------------------------------------------------------
+/**
+ * @brief      Setter for the local name property
+ *
+ * @param[in]  name  The name
+ */
 
 void sfeIoTNodeLoRaWAN::set_local_name(std::string name)
 {
@@ -730,7 +745,7 @@ void sfeIoTNodeLoRaWAN::checkBatteryLevels(void)
 }
 
 //---------------------------------------------------------------------------
-// Terminal Baudrate things
+// Terminal Baud-rate things
 //---------------------------------------------------------------------------
 uint32_t sfeIoTNodeLoRaWAN::get_termBaudRate(void)
 {