Skip to content

Commit

Permalink
Preparing for repo name change.
Browse files Browse the repository at this point in the history
  • Loading branch information
EricLauber committed Aug 13, 2024
1 parent 758449f commit 12f3f04
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Publish docs to GitHub Pages
on:
push:
branches:
- add-diy4_2-sensors-and-capabilities
- main

jobs:
build:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

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.

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_mqtt/).
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/).

Please feel free to use this project as an example of applying modern software development best practices to Arduino projects.

Expand Down
2 changes: 1 addition & 1 deletion docs/implementation/networking.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Todo:

- networking dependency injection
- MQTT
- HTTP Verbs
- HTTP Verbs
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

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.

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_mqtt/).
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.

The previous base configuration for an AirGradient product is for it to log data to AirGradient's servers. This sketch augments that functionality with MQTT capabilities to log data to a server of your choice.

Expand Down
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Project information
site_name: AirGradient Arduino MQTT
site_url: https://ericlauber.github.io/airgradient_mqtt/
site_url: https://ericlauber.github.io/airgradient_with_tests/
site_author: Eric Lauber
site_description: >-
Arduino sketch for AirGradient DIY PRO V4.2 with added MQTT support, based around an ESP8266 Microcontroller.
# Repository
repo_name: EricLauber/airgradient_mqtt
repo_url: https://github.com/EricLauber/airgradient_mqtt
repo_name: EricLauber/airgradient_with_tests
repo_url: https://github.com/EricLauber/airgradient_with_tests

# Configuration
theme:
Expand Down

0 comments on commit 12f3f04

Please sign in to comment.