Use packages and github repo

Packages to neatly collect different ESPHome pieces together with a single associated feature,
such as the display having fonts, display, pages, switches, and intervals in a single file

Reference Github repo, so end users only need a single file to create their entry in ESPHome

Also added a full_config folder with the fully expanded config in a single file so it is completely stand-alone, if users desire it

Author: MallocArray

airgradient-basic.yaml

@@ -1,317 +1,29 @@
 ---
-# Reference for substitutions: https://github.com/ajfriesen/ESPHome-AirGradient/blob/main/air-gradient-pro-diy.yaml
+# AirGradient DIY Basic
+# https://www.airgradient.com/open-airgradient/instructions/overview/
+
 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:
-  name: "${devicename}"
-  friendly_name: "${upper_devicename}"
-  name_add_mac_suffix: true  # Set to false if you don't want part of the MAC address in the name
-
-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
+  friendly_devicename: "AG Basic"
+  ag_esphome_config_version: 1.0.0
+  add_mac_suffix: "true"  # Must have quotes around value
 
 # Enable Home Assistant API
-api:
+api:  # Add encryption key as desired
 
-ota:
+ota:  # Add password as desired
 
 wifi:
   # Enable fallback hotspot (captive portal) in case wifi connection fails
   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
-  - rx_pin: D4
-    tx_pin: D3
-    baud_rate: 9600
-    id: senseair_s8_uart
-
-  - rx_pin: D5
-    tx_pin: D6
-    baud_rate: 9600
-    id: pms5003_uart
-
-i2c:
-  sda: D2
-  scl: D1
-
-sensor:
-  - platform: pmsx003
-    # 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"
-      id: pm_2_5
-      filters:
-        - sliding_window_moving_average:
-            window_size: 30
-            send_every: 30
-    pm_1_0:
-      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"
-      id: pm_10_0
-      filters:
-        - sliding_window_moving_average:
-            window_size: 30
-            send_every: 30
-    pm_0_3um:
-      name: "PM 0.3"
-      id: pm_0_3um
-      filters:
-        - sliding_window_moving_average:
-            window_size: 30
-            send_every: 30
-
-  - platform: template
-    # 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
-    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
-    # SenseAir S8 https://esphome.io/components/sensor/senseair.html
-    # https://senseair.com/products/size-counts/s8-lp/
-    co2:
-      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
-    id: senseair_s8
-    uart_id: senseair_s8_uart
-
-  # - platform: sht4x
-  #   # SHT40 https://esphome.io/components/sensor/sht4x.html
-  #   temperature:
-  #     name: "Temperature"
-  #     id: temp
-  #   humidity:
-  #     name: "Humidity"
-  #     id: humidity
-  #   address: 0x44
-
-  - platform: sht3xd
-    # SHT30 https://esphome.io/components/sensor/sht3xd.html
-    temperature:
-      name: "Temperature"
-      id: temp
-    humidity:
-      name: "Humidity"
-      id: humidity
-    address: 0x44
-
-  - platform: wifi_signal
-    name: "WiFi Signal"
-    id: wifi_dbm
-    update_interval: 60s
-
-  - platform: uptime
-    name: "Uptime"
-    id: device_uptime
-    update_interval: 10s
-
-
-font:
-    # Font to use on the display
-    # Open Source font Liberation Sans by Red Hat
-    # https://www.dafont.com/liberation-sans.font
-  - file: './fonts/liberation_sans/LiberationSans-Regular.ttf'
-    id: font1
-    size: 24
-
-display:
-  - platform: ssd1306_i2c
-    # https://esphome.io/components/display/ssd1306.html?highlight=display
-    model: "SSD1306 64x48"
-    id: oled_display
-    reset_pin: D0
-    address: 0x3C
-    # rotation: 180 # Enable to 180 to flip screen around
-    pages:
-      - id: display_pm2
-        lambda: |-
-          it.print(0, 0, id(font1), "PM2");
-          it.printf(64, 24, id(font1), TextAlign::TOP_RIGHT, "%.0f",id(pm_2_5).state);
-      - id: display_co2
-        lambda: |-
-          it.print(0, 0, id(font1), "CO2");
-          it.printf(64, 24, id(font1), TextAlign::TOP_RIGHT, "%.0f",id(co2).state);
-      # - id: display_temp
-      #   lambda: |-
-      #     it.print(0, 0, id(font1), "°C");
-      #     it.printf(64, 24, id(font1), TextAlign::TOP_RIGHT, "%.1f",id(temp).state);
-      - id: display_tempf
-        lambda: |-
-          it.print(0, 0, id(font1), "°F");
-          it.printf(64, 24, id(font1), TextAlign::TOP_RIGHT, "%.1f",id(temp).state*9/5+32);
-      - id: display_humidity
-        lambda: |-
-          it.print(0, 0, id(font1), "HUM");
-          it.printf(64, 24, id(font1), TextAlign::TOP_RIGHT, "%.0f%%",id(humidity).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
-  - platform: template
-    name: SenseAir S8 Calibration
-    id: senseair_s8_calibrate_button
-    on_press:
-      then:
-        - 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
-
-  - 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: 5s
-    # Automatically switch to the next page every five seconds
-    then:
-      - 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: 2.5min
-    # Send data to AirGradient API server
-    then:
-      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);
+packages:
+  board: github://MallocArray/airgradient_esphome/packages/airgradient_d1_mini_board.yaml
+  pm_2.5: github://MallocArray/airgradient_esphome/packages/sensor_pms5003.yaml
+  co2: github://MallocArray/airgradient_esphome/packages/sensor_s8.yaml
+  temp_humidity: github://MallocArray/airgradient_esphome/packages/sensor_sht30.yaml
+  display: github://MallocArray/airgradient_esphome/packages/display_ssd1306.yaml
+  airgradient_api: github://MallocArray/airgradient_esphome/packages/airgradient_api_d1_mini_no_sgp41.yaml
+  wifi: github://MallocArray/airgradient_esphome/packages/sensor_wifi.yaml
+  uptime: github://MallocArray/airgradient_esphome/packages/sensor_uptime.yaml
+  safe_mode: github://MallocArray/airgradient_esphome/packages/switch_safe_mode.yaml