Update configs for current models

Switches to keep LED disabled and adjust brightness
Switch to upload to AirGradient Dashboard
Switches to enable/disable Automatic Baseline Calibration on S8 CO2 sensor

Author: MallocArray

airgradient-basic.yaml

@@ -3,6 +3,7 @@
 substitutions:
   devicename: "ag-basic"
   upper_devicename: "AG Basic"
+  ag_esphome_config_version: 0.1.1
 
   # Instructions: https://esphome.io/guides/getting_started_hassio.html
 esphome:
@@ -14,24 +15,48 @@ esp8266:
   board: d1_mini
 
 # Enable logging
+# https://esphome.io/components/logger.html
 logger:
+  logs:
+    component: ERROR  # Hiding warning messages about component taking a long time https://github.com/esphome/issues/issues/4717
 
 # Enable Home Assistant API
 api:
-  password: ""
 
 ota:
-  password: ""
 
 wifi:
-  # https://esphome.io/components/wifi.html
-  ssid: !secret wifi_ssid
-  password: !secret wifi_password
   # Enable fallback hotspot (captive portal) in case wifi connection fails
-  # Defaults to device name with no password
-  ap: {}
+  ap:
+
+# The captive portal is a fallback mechanism for when connecting to the configured WiFi fails.
+# https://esphome.io/components/captive_portal.html
 captive_portal:
 
+http_request:
+  # Used to support POST request to send data to AirGradient
+  # https://esphome.io/components/http_request.html
+
+switch:
+  - platform: safe_mode
+    # Create a switch for safe_mode in order to flash the device
+    # Solution from this thread:
+    # https://community.home-assistant.io/t/esphome-flashing-over-wifi-does-not-work/357352/1
+    name: "Flash Mode (Safe Mode)"
+    icon: "mdi:cellphone-arrow-down"
+
+  - platform: template
+    name: "Display Temperature in °F"
+    icon: "mdi:thermometer"
+    id: display_in_f
+    restore_mode: RESTORE_DEFAULT_ON
+    optimistic: True
+
+  - platform: template
+    name: "Upload to AirGradient Dashboard"
+    id: upload_airgradient
+    restore_mode: RESTORE_DEFAULT_ON
+    optimistic: True
 
 uart:
   # https://esphome.io/components/uart.html#uart
@@ -51,73 +76,92 @@ i2c:
 
 sensor:
   - platform: pmsx003
-    # https://esphome.io/components/sensor/pmsx003.html
+    # Default interval of updating every second, but using an average over the last 30 seconds/readings
+    # PMS5003 https://esphome.io/components/sensor/pmsx003.html
     type: PMSX003
+    uart_id: pms5003_uart
     pm_2_5:
-      name: "PM <2.5µm Concentration"
+      name: "PM 2.5"
       id: pm_2_5
-      on_value:
-        lambda: |-
-          // https://en.wikipedia.org/wiki/Air_quality_index#Computing_the_AQI
-          // Borrowed from https://github.com/kylemanna/sniffer/blob/master/esphome/sniffer_common.yaml
-          if (id(pm_2_5).state <= 12.0) {
-            // good
-            id(pm_2_5_aqi).publish_state((50.0 - 0.0) / (12.0 - 0.0) * (id(pm_2_5).state - 0.0) + 0.0);
-          } else if (id(pm_2_5).state <= 35.4) {
-            // moderate
-            id(pm_2_5_aqi).publish_state((100.0 - 51.0) / (35.4 - 12.1) * (id(pm_2_5).state - 12.1) + 51.0);
-          } else if (id(pm_2_5).state <= 55.4) {
-            // usg
-            id(pm_2_5_aqi).publish_state((150.0 - 101.0) / (55.4 - 35.5) * (id(pm_2_5).state - 35.5) + 101.0);
-          } else if (id(pm_2_5).state <= 150.4) {
-            // unhealthy
-            id(pm_2_5_aqi).publish_state((200.0 - 151.0) / (150.4 - 55.5) * (id(pm_2_5).state - 55.5) + 151.0);
-          } else if (id(pm_2_5).state <= 250.4) {
-            // very unhealthy
-            id(pm_2_5_aqi).publish_state((300.0 - 201.0) / (250.4 - 150.5) * (id(pm_2_5).state - 150.5) + 201.0);
-          } else if (id(pm_2_5).state <= 350.4) {
-            // hazardous
-            id(pm_2_5_aqi).publish_state((400.0 - 301.0) / (350.4 - 250.5) * (id(pm_2_5).state - 250.5) + 301.0);
-          } else if (id(pm_2_5).state <= 500.4) {
-            // hazardous 2
-            id(pm_2_5_aqi).publish_state((500.0 - 401.0) / (500.4 - 350.5) * (id(pm_2_5).state - 350.5) + 401.0);
-          } else {
-            id(pm_2_5_aqi).publish_state(500);
-          }
+      filters:
+        - sliding_window_moving_average:
+            window_size: 30
+            send_every: 30
     pm_1_0:
-      name: "PM <1.0µm Concentration"
+      name: "PM 1.0"
       id: pm_1_0
+      filters:
+        - sliding_window_moving_average:
+            window_size: 30
+            send_every: 30
     pm_10_0:
-      name: "PM <10.0µm Concentration"
+      name: "PM 10.0"
       id: pm_10_0
+      filters:
+        - sliding_window_moving_average:
+            window_size: 30
+            send_every: 30
     pm_0_3um:
-      name: "PM >0.3µm Count"
+      name: "PM 0.3"
       id: pm_0_3um
-    update_interval: 2min
-    uart_id: pms5003_uart
+      filters:
+        - sliding_window_moving_average:
+            window_size: 30
+            send_every: 30
 
   - platform: template
-    name: "PM <2.5 AQI"
+    # Depends on another sensor providing an ID of pm_2_5 such as a pms5003
+    name: "PM 2.5 AQI"
+    id: pm_2_5_aqi
+    update_interval: 5 min
     unit_of_measurement: "AQI"
     icon: "mdi:air-filter"
     accuracy_decimals: 0
-    id: pm_2_5_aqi
+    filters:
+      - skip_initial: 10  # Need valid data from PM 2.5 sensor before able to calculate
+    lambda: |-
+      // https://en.wikipedia.org/wiki/Air_quality_index#Computing_the_AQI
+      // Borrowed from https://github.com/kylemanna/sniffer/blob/master/esphome/sniffer_common.yaml
+      if (id(pm_2_5).state <= 12.0) {
+      // good
+      return((50.0 - 0.0) / (12.0 - 0.0) * (id(pm_2_5).state - 0.0) + 0.0);
+      } else if (id(pm_2_5).state <= 35.4) {
+      // moderate
+      return((100.0 - 51.0) / (35.4 - 12.1) * (id(pm_2_5).state - 12.1) + 51.0);
+      } else if (id(pm_2_5).state <= 55.4) {
+      // usg
+      return((150.0 - 101.0) / (55.4 - 35.5) * (id(pm_2_5).state - 35.5) + 101.0);
+      } else if (id(pm_2_5).state <= 150.4) {
+      // unhealthy
+      return((200.0 - 151.0) / (150.4 - 55.5) * (id(pm_2_5).state - 55.5) + 151.0);
+      } else if (id(pm_2_5).state <= 250.4) {
+      // very unhealthy
+      return((300.0 - 201.0) / (250.4 - 150.5) * (id(pm_2_5).state - 150.5) + 201.0);
+      } else if (id(pm_2_5).state <= 350.4) {
+      // hazardous
+      return((400.0 - 301.0) / (350.4 - 250.5) * (id(pm_2_5).state - 250.5) + 301.0);
+      } else if (id(pm_2_5).state <= 500.4) {
+      // hazardous 2
+      return((500.0 - 401.0) / (500.4 - 350.5) * (id(pm_2_5).state - 350.5) + 401.0);
+      } else {
+      return(500);
+      }
 
   - platform: senseair
-    # https://esphome.io/components/sensor/senseair.html
+    # SenseAir S8 https://esphome.io/components/sensor/senseair.html
+    # https://senseair.com/products/size-counts/s8-lp/
     co2:
-      name: "SenseAir S8 CO2 Value"
+      name: "SenseAir S8 CO2"
       id: co2
       filters:
         - skip_initial: 2
         - clamp:
             min_value: 400  # 419 as of 2023-06 https://gml.noaa.gov/ccgg/trends/global.html
-    update_interval: 30s
     id: senseair_s8
     uart_id: senseair_s8_uart
 
   # - platform: sht4x
-  #   # SHT41 https://esphome.io/components/sensor/sht4x.html
+  #   # SHT40 https://esphome.io/components/sensor/sht4x.html
   #   temperature:
   #     name: "Temperature"
   #     id: temp
@@ -135,34 +179,17 @@ sensor:
       name: "Humidity"
       id: humidity
     address: 0x44
-    heater_enabled: false  # Only enable if in conditions that may have high condensation
 
   - platform: wifi_signal
     name: "WiFi Signal"
     id: wifi_dbm
     update_interval: 60s
 
   - platform: uptime
-    name: Uptime Sensor
+    name: "Uptime"
     id: device_uptime
     update_interval: 10s
 
-  # - platform: sgp30
-  # # https://esphome.io/components/sensor/sgp30.html
-  # # Unable to get to work when OLED shield is also connected
-  #   eco2:
-  #     name: "eCO2"
-  #     id: eco2
-  #     accuracy_decimals: 1
-  #   tvoc:
-  #     name: "TVOC"
-  #     id: tvoc
-  #     accuracy_decimals: 1
-  #   update_interval: 30s
-
-  - platform: uptime
-    name: Uptime Sensor
-    id: airgradient_basement_uptime
 
 font:
     # Font to use on the display
@@ -201,14 +228,20 @@ display:
         lambda: |-
           it.print(0, 0, id(font1), "HUM");
           it.printf(64, 24, id(font1), TextAlign::TOP_RIGHT, "%.0f%%",id(humidity).state);
-      # - id: display_eco2
-      #   lambda: |-
-      #     it.print(0, 0, id(font1), "eCO2");
-      #     it.printf(64, 24, id(font1), TextAlign::TOP_RIGHT, "%.0f",id(eco2).state);
-      # - id: display_tvoc
-      #   lambda: |-
-      #     it.print(0, 0, id(font1), "TVOC");
-      #     it.printf(64, 24, id(font1), TextAlign::TOP_RIGHT, "%.0f",id(tvoc).state);
+      - id: boot
+        lambda: |-
+          it.printf(0, 0, id(font1), TextAlign::TOP_RIGHT, "%s", get_mac_address().substr(6,11).c_str());
+    on_page_change:
+      to: boot
+      then:
+        - if:
+            # Skip the boot page after initial boot
+            condition:
+                lambda: 'return id(device_uptime).state > 30;'
+            then:
+              - display.page.show_next: oled_display
+              - component.update: oled_display
+
 
 button:
   # https://github.com/esphome/issues/issues/2444
@@ -220,47 +253,65 @@ button:
         - senseair.background_calibration: senseair_s8
         - delay: 70s
         - senseair.background_calibration_result: senseair_s8
+
   - platform: template
     name: SenseAir S8 Enable Automatic Calibration
     id: senseair_s8_enable_calibrate_button
     on_press:
       then:
         - senseair.abc_enable: senseair_s8
+
   - platform: template
     name: SenseAir S8 Disable Automatic Calibration
     id: senseair_s8_disable_calibrate_button
     on_press:
       then:
         - senseair.abc_disable: senseair_s8
 
-http_request:
-  # Used to support POST request to send data to AirGradient
-  # https://esphome.io/components/http_request.html
-
+  - platform: template
+    name: SenseAir S8 Show Calibration Interval
+    id: senseair_s8_show_calibrate_interval
+    on_press:
+      then:
+        - senseair.abc_get_period: senseair_s8
 
 interval:
-  - interval: 3s
-    # Cycle through page on display
+  - interval: 5s
+    # Automatically switch to the next page every five seconds
     then:
-      - display.page.show_next: oled_display
-      - component.update: oled_display
+      - if:
+          # Show boot screen for first 10 seconds with serial number and config version
+          condition:
+              lambda: 'return id(device_uptime).state < 10;'
+          then:
+            - display.page.show: boot
+            - lambda: id(device_uptime).set_update_interval(1);
+          else:
+            # Change page on display
+            - display.page.show_next: oled_display
+            - component.update: oled_display
 
-  - interval: 300s
+  - interval: 2.5min
     # Send data to AirGradient API server
     then:
-      - http_request.post:
-          # AirGradient URL with the last 3 bytes of the MAC address in Hex format all lower case
-          url: !lambda |-
-            return "http://hw.airgradient.com/sensors/airgradient:" + get_mac_address().substr(6,11) + "/measures";
-          headers:
-              Content-Type: application/json
-          # "!lambda return to_string(id(pm_2_5).state);" Converts sensor output from double to string
-          json:
-            wifi: !lambda return to_string(id(wifi_dbm).state);
-            pm01: !lambda return to_string(id(pm_1_0).state);
-            pm02: !lambda return to_string(id(pm_2_5).state);
-            pm10: !lambda return to_string(id(pm_10_0).state);
-            pm003_count: !lambda return to_string(id(pm_0_3um).state);
-            rco2: !lambda return to_string(id(co2).state);
-            atmp: !lambda return to_string(id(temp).state);
-            rhum: !lambda return to_string(id(humidity).state);
+      if:
+        condition:
+          switch.is_on: upload_airgradient
+        then:
+          - http_request.post:
+              # https://api.airgradient.com/public/docs/api/v1/
+              # AirGradient URL with the MAC address all lower case
+              url: !lambda |-
+                return "http://hw.airgradient.com/sensors/airgradient:" + get_mac_address().substr(6,11) + "/measures";
+              headers:
+                  Content-Type: application/json
+              # "!lambda return to_string(id(pm_2_5).state);" Converts sensor output from double to string
+              json:
+                wifi: !lambda return to_string(id(wifi_dbm).state);
+                pm01: !lambda return to_string(id(pm_1_0).state);
+                pm02: !lambda return to_string(id(pm_2_5).state);
+                pm10: !lambda return to_string(id(pm_10_0).state);
+                pm003_count: !lambda return to_string(id(pm_0_3um).state);
+                rco2: !lambda return to_string(id(co2).state);
+                atmp: !lambda return to_string(id(temp).state);
+                rhum: !lambda return to_string(id(humidity).state);

airgradient-one.yaml

@@ -508,7 +508,6 @@ interval:
             - display.page.show_next: oled_display
             - component.update: oled_display
 
-
   - interval: 2.5min
     # Send data to AirGradient API server
     then: