Merge pull request #342 from mtlynch/no-trailing-spaces

Eliminate trailing whitespace

Author: samuelbles07

.github/workflows/check.yml

@@ -1,5 +1,36 @@
 on: [push, pull_request]
 jobs:
+  trailing-whitespace:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4.2.2
+        with:
+          fetch-depth: 0
+      - name: Check for trailing whitespace
+        run: |
+          set -u
+
+          # Don't enforce checks on vendored libraries.
+          readonly EXCLUDED_DIR='src/Libraries'
+
+          has_trailing_whitespace=false
+
+          while read -r line; do
+            if grep \
+              "\s$" \
+              --line-number \
+              --with-filename \
+              --binary-files=without-match \
+              "${line}"; then
+              has_trailing_whitespace=true
+            fi
+          done < <(git ls-files | grep --invert-match "^${EXCLUDED_DIR}/")
+
+          if [ "$has_trailing_whitespace" = true ]; then
+            echo "ERROR: Found trailing whitespace"
+            exit 1
+          fi
+
   compile:
     strategy:
       fail-fast: false

README.md

@@ -32,7 +32,7 @@ Each GitHub release note will also include the planned rollout date for wider av
 
 ## Help & Support
 
-If you have any questions or problems, check out [our forum](https://forum.airgradient.com/). 
+If you have any questions or problems, check out [our forum](https://forum.airgradient.com/).
 
 ## Development
 

docs/howto-compile.md

@@ -16,15 +16,15 @@ Arduino IDE version 2.x ([download](https://www.arduino.cc/en/software))
 
 #### Version < 3.2.0
 
-Using library manager install the latest version (Tools ➝ Manage Libraries... ➝ search for `"airgradient"`) 
+Using library manager install the latest version (Tools ➝ Manage Libraries... ➝ search for `"airgradient"`)
 
 ![Aigradient Library](images/ag-lib.png)
 
 #### Version >= 3.3.0
 
 - From your terminal, go to Arduino libraries folder (windows and mac: `Documents/Arduino/libraries` or linux: `~/Arduino/Libraries`).
-- With **git** cli, execute this command `git clone --recursive https://github.com/airgradienthq/arduino.git AirGradient_Air_Quality_Sensor` 
-- Restart Arduino IDE 
+- With **git** cli, execute this command `git clone --recursive https://github.com/airgradienthq/arduino.git AirGradient_Air_Quality_Sensor`
+- Restart Arduino IDE
 
 3. On tools tab, follow settings below
 
@@ -57,15 +57,15 @@ Upload Speed ➝ 921600
 
 ![board manager](images/esp8266-board.png)
 
-3. Install AirGradient library on library manager using the latest version (Tools ➝ Manage Libraries... ➝ search for `"airgradient"`) 
+3. Install AirGradient library on library manager using the latest version (Tools ➝ Manage Libraries... ➝ search for `"airgradient"`)
 
 ![Aigradient Library](images/ag-lib.png)
 
 4. On tools tab, set board to `LOLIN(WEMOS) D1 R2 & mini`, and let other settings to default
 
 ![settings esp8266](images/settings-esp8266.png)
 
-5. Open sketch to compile (File ➝ Examples ➝ AirGradient Air Quality Sensor ➝ `<Model Option>`). Depends on the DIY model, either `BASIC`, `DiyProIndoorV3_3` and `DiyProIndoorV4_2` 
+5. Open sketch to compile (File ➝ Examples ➝ AirGradient Air Quality Sensor ➝ `<Model Option>`). Depends on the DIY model, either `BASIC`, `DiyProIndoorV3_3` and `DiyProIndoorV4_2`
 6. Compile
 
 ![compiled esp8266](images/compiled-esp8266.png)
@@ -78,13 +78,13 @@ ModuleNotFoundError: No module named ‘serial’
 
 ![Linux Failed](images/linux-failed.png)
 
-Make sure python pyserial module installed globally in the environment by executing: 
+Make sure python pyserial module installed globally in the environment by executing:
 
 `$ sudo apt install -y python3-pyserial`
 
-or 
+or
 
-`$ pip install pyserial` 
+`$ pip install pyserial`
 
 Choose based on how python installed on your machine. But most user, using `apt` is better.
 

docs/local-server.md

@@ -1,6 +1,6 @@
 ## Local Server API
 
-From [firmware version 3.0.10](firmwares) onwards, the AirGradient ONE and Open Air monitors have below API available. 
+From [firmware version 3.0.10](firmwares) onwards, the AirGradient ONE and Open Air monitors have below API available.
 
 ### Discovery
 
@@ -20,7 +20,7 @@ http://airgradient_ecda3b1eaaaf.local/measures/current
 “ecda3b1eaaaf” being the serial number of your monitor.
 
 You get the following response:
-```json 
+```json
 {
   "wifi": -46,
   "serialno": "ecda3b1eaaaf",
@@ -84,7 +84,7 @@ Compensated values apply correction algorithms to make the sensor values more ac
 
 "/config" path returns the current configuration of the monitor.
 
-```json 
+```json
 {
   "country": "TH",
   "pmStandard": "ugm3",
@@ -118,22 +118,22 @@ Configuration parameters can be changed with a PUT request to the monitor, e.g.
 Example to force CO2 calibration
 
  ```bash
- curl -X PUT -H "Content-Type: application/json" -d '{"co2CalibrationRequested":true}' http://airgradient_84fce612eff4.local/config 
+ curl -X PUT -H "Content-Type: application/json" -d '{"co2CalibrationRequested":true}' http://airgradient_84fce612eff4.local/config
  ```
 
 Example to set monitor to Celsius
 
  ```bash
- curl -X PUT -H "Content-Type: application/json" -d '{"temperatureUnit":"c"}' http://airgradient_84fce612eff4.local/config 
+ curl -X PUT -H "Content-Type: application/json" -d '{"temperatureUnit":"c"}' http://airgradient_84fce612eff4.local/config
  ```
 
  If you use command prompt on Windows, you need to escape the quotes:
- 
+
   ``` -d "{\"param\":\"value\"}" ```
 
 ### Avoiding Conflicts with Configuration on AirGradient Server
 
-If the monitor is set up on the AirGradient dashboard, it will also receive the configuration parameters from there. In case you do not want this, please set `configurationControl` to `local`. In case you set it to `cloud` and want to change it to `local`, you need to make a factory reset. 
+If the monitor is set up on the AirGradient dashboard, it will also receive the configuration parameters from there. In case you do not want this, please set `configurationControl` to `local`. In case you set it to `cloud` and want to change it to `local`, you need to make a factory reset.
 
 ### Configuration Parameters (GET/PUT)
 
@@ -204,34 +204,34 @@ Example correction configuration:
 Field Name: `pm02`
 
 | Algorithm | Value | Description | SLR required |
-|------------|-------------|------|---------| 
+|------------|-------------|------|---------|
 | Raw | `"none"` | No correction (default) | No |
 | EPA 2021 | `"epa_2021"` | Use EPA 2021 correction factors on top of raw value | No |
-| PMS5003_20240104 | `"slr_PMS5003_20240104"` | Correction for PMS5003 sensor batch 20240104| Yes | 
+| PMS5003_20240104 | `"slr_PMS5003_20240104"` | Correction for PMS5003 sensor batch 20240104| Yes |
 | PMS5003_20231218 | `"slr_PMS5003_20231218"` | Correction for PMS5003 sensor batch 20231218| Yes |
 | PMS5003_20231030 | `"slr_PMS5003_20231030"` | Correction for PMS5003 sensor batch 20231030| Yes |
 
-**NOTES**: 
+**NOTES**:
 
 - Set `useEpa2021` to `true` if want to apply EPA 2021 correction factors on top of SLR correction value, otherwise `false`
 - `intercept` and `scalingFactor` values can be obtained from [this article](https://www.airgradient.com/blog/low-readings-from-pms5003/)
-- If `configurationControl` is set to `local` (eg. when using Home Assistant), correction need to be set manually, see examples below 
+- If `configurationControl` is set to `local` (eg. when using Home Assistant), correction need to be set manually, see examples below
 
 **Examples**:
 
-- PMS5003_20231030 
+- PMS5003_20231030
 
 ```bash
 curl --location -X PUT 'http://airgradient_84fce612eff4.local/config' --header 'Content-Type: application/json' --data '{"corrections":{"pm02":{"correctionAlgorithm":"slr_PMS5003_20231030","slr":{"intercept":0,"scalingFactor":0.02838,"useEpa2021":true}}}}'
 ```
 
-- PMS5003_20231218 
+- PMS5003_20231218
 
 ```bash
 curl --location -X PUT 'http://airgradient_84fce612eff4.local/config' --header 'Content-Type: application/json' --data '{"corrections":{"pm02":{"correctionAlgorithm":"slr_PMS5003_20231218","slr":{"intercept":0,"scalingFactor":0.03525,"useEpa2021":true}}}}'
 ```
 
-- PMS5003_20240104 
+- PMS5003_20240104
 
 ```bash
 curl --location -X PUT 'http://airgradient_84fce612eff4.local/config' --header 'Content-Type: application/json' --data '{"corrections":{"pm02":{"correctionAlgorithm":"slr_PMS5003_20240104","slr":{"intercept":0,"scalingFactor":0.02896,"useEpa2021":true}}}}'
@@ -244,10 +244,10 @@ Field Name:
 - Humidity: `rhum`
 
 | Algorithm | Value | Description | SLR required |
-|------------|-------------|------|---------| 
+|------------|-------------|------|---------|
 | Raw | `"none"` | No correction (default) | No |
 | AirGradient Standard Correction | `"ag_pms5003t_2024"` | Using standard airgradient correction (for outdoor monitor)| No |
-| Custom | `"custom"` | custom corrections constant, set `intercept` and `scalingFactor` manually | Yes | 
+| Custom | `"custom"` | custom corrections constant, set `intercept` and `scalingFactor` manually | Yes |
 
 *Table above apply for both Temperature and Humidity*
 

docs/ota-updates.md

@@ -1,6 +1,6 @@
 ## OTA Updates
 
-From [firmware version 3.1.1](https://github.com/airgradienthq/arduino/tree/3.1.1) onwards, the AirGradient ONE and Open Air monitors support over the air (OTA) updates. 
+From [firmware version 3.1.1](https://github.com/airgradienthq/arduino/tree/3.1.1) onwards, the AirGradient ONE and Open Air monitors support over the air (OTA) updates.
 
 #### Mechanism
 
@@ -10,7 +10,7 @@ The device attempts to update to the latest version on startup and in regular in
 
 http://hw.airgradient.com/sensors/{deviceId}/generic/os/firmware.bin?current_firmware={GIT_VERSION}
 
-If does pass the version it is currently running on along to the server through URL parameter 'current_firmware'. 
+If does pass the version it is currently running on along to the server through URL parameter 'current_firmware'.
 This allows the server to identify if the device is already running on the latest version or should update.
 
 The following scenarios are possible

examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino

@@ -249,7 +249,7 @@ void loop() {
   configUpdateHandle();
 
   localServer._handle();
-  
+
   if (configuration.hasSensorSGP) {
     ag.sgp41.handle();
   }