SOLID and automated test examples for AirGradient

.github/workflows/build.yml

@@ -0,0 +1,18 @@
+name: Publish docs to GitHub Pages
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout main
+        uses: actions/checkout@v1
+
+      - name: Deploy docs
+        uses: mhausenblas/mkdocs-deploy-gh-pages@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pullrequest.yml

@@ -0,0 +1,25 @@
+# todo! need to get or clone all referenced libraries
+
+# name: Run AUnit tests with EpoxyDuino
+# on:
+#   pull_request:
+#     branches:
+#       - main
+
+# jobs:
+#   build:
+
+#     runs-on: ubuntu-latest
+
+#     steps:
+#       - uses: actions/checkout@v3
+
+#       - name: Setup environment
+#         run: | 
+#           cd ..
+#           git clone https://github.com/bxparks/EpoxyDuino
+
+#       - name: Run Tests
+#         run: |
+#           make -C tests
+#           make -C tests runtests

.gitignore

@@ -0,0 +1,39 @@
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+
+# Environment Files
+*.env
+
+# Root directory of EpoxyFS
+epoxyfsdata
+epoxyeepromdata

.vscode/arduino.json

@@ -0,0 +1,4 @@
+{
+    "configuration": "xtal=80,vt=flash,exception=disabled,stacksmash=disabled,ssl=all,mmu=3232,non32xfer=fast,eesz=4M2M,ip=lm2f,dbg=Disabled,lvl=None____,wipe=none,baud=921600",
+    "board": "esp8266:esp8266:d1_mini"
+}

Makefile

@@ -0,0 +1,8 @@
+all:
+	$(MAKE) -C tests
+
+runtests:
+	$(MAKE) -C tests runtests
+
+clean:
+	$(MAKE) -C tests clean

README.md

@@ -1,77 +1,17 @@
-# AirGradient MQTT
+# AirGradient for Arduino with Automated Tests
 
-Simple script that reads AirGradient air quality sensors and publishes data to an MQTT server.
+<img src="./docs/assets/images/airgradient.png" align="right" width="200">
 
-I use it along with my DIY AirGradient boards. Information on how to get the components and build the boards is available [here](https://www.airgradient.com/open-airgradient/instructions/diy/) 
+This is an Arduino software implementation for the AirGradient DIY Air Quality Sensor Pro, PCB version 4.2. I have paused development for this project.
 
-This script allows you to host your own solution instead of connecting the DIY Sensor to the AirGradient Dashboard. That's a very convenient option if you don't want to host yourself, you can find all the information you need [here](https://www.airgradient.com/open-airgradient/instructions/diy-connect-to-dashboard/)
+I created this fork of [AirGradient's Arduino code](https://github.com/airgradienthq/arduino) prior to their implementation of MQTT and local web server support. My intention was to add that functionality while also bringing in other software development best practices such as automated testing and Continuous Integration and patterns like SOLID. [Click here for detailed documentation about the implementation](https://ericlauber.github.io/airgradient_with_tests/).
 
-Instead of running an HTTP server and polling from Prometheus as in Jeff Geerling’s solution, I like better the approach of the boards reporting the values to the MQTT server. This code is based on the solution that Jeff describes in [his blog](https://www.jeffgeerling.com/blog/2021/airgradient-diy-air-quality-monitor-co2-pm25)
+Please feel free to use this project as an example of applying modern software development best practices to Arduino projects.
 
-I'm not using the OLED display to show the values, but you can find the relevant code in the blog post above.
+## Getting Started and uploading this sketch
 
-## Configuration
-
-Update the `arduino_config.h` file with your details. I use one config file per device.
-
-- `SECRET_SSID`: WiFi ssid
-- `SECRET_PASS`: WiFi password
-- `MQTT_SERVER_ADDRESS`: The MQTT server address, you can use `test.mosquitto.org` if you're not running your own MQTT server yet. I use a dockerized Mosquitto MQTT server https://mosquitto.org/
-- `IP_LAST_CHUNK`: 
-- `MQTT_TOPIC`: The MQTT topic that the values will be published to. I define one topic per device.
-- `DEVICE_ID`: A friendly name for your device
-- `TEMP_DEVIATION`: The temperature deviation from the sensor to the room. I use 2.5 degrees in my setup. I guess the deviation comes from the heat generated by the board.
-- `HUM_DEVIATION`: Same idea as `TEMP_DEVIATION`. I use 2% in my setup. 
-
-## Home Assistant
-
-I use Home Assistant to track and display the sensor status. Define the sensors in your `configuration.yaml` as follows:
-
-```yaml
-# Air Gradient sensors
-mqtt:
-  sensor:
-    - name: 'Temperature office'
-      state_topic: 'esp/dht/office'
-      unit_of_measurement: '..C'
-      value_template: '{{ value_json.atmp | round(1) }}'
-
-    - name: 'Humidity office'
-      state_topic: 'esp/dht/office'
-      unit_of_measurement: '%'
-      value_template: '{{ value_json.rhum }}'
-
-    - name: 'CO2 office'
-      state_topic: 'esp/dht/office'
-      unit_of_measurement: 'ppm'
-      value_template: '{{ value_json.rco2 }}'
-
-    - name: 'PM2 office'
-      state_topic: 'esp/dht/office'
-      unit_of_measurement: 'ppm'
-      value_template: '{{ value_json.pm02 }}'
-```
-
-## License
-
-MIT License
-
-Copyright (c) 2022 @nsbk
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+1. Download and Install the [Arduino IDE](https://www.arduino.cc/en/software), [Arduino CLI](https://arduino.github.io/arduino-cli/0.19/installation/), or [VS Code](https://code.visualstudio.com/) with the [Arduino extension](https://marketplace.visualstudio.com/items?itemName=vsciot-vscode.vscode-arduino) to your system.
+1. Clone this repo or download the latest release (a zip of the source code).
+1. Open `airgradient_mqtt.ino` with your chosen Arduino tools.
+1. Install all required Arduino reference libraries.
+1. Plug in the microcontroller for your AirGradient (such as an ESP8266 Wemos LOLIN D1 mini) and upload the sketch to the controller.