Update Readme

Author: spuder

.github/workflows/pages-version.yaml

@@ -32,5 +32,5 @@ jobs:
           committer_name: GitHub Actions
           committer_email: actions@github.com      
           message: Update manifest.json
-          add: "docs/*.md"
+          add: "docs/*.md README.md"
           push: true

firmware/common.yaml

@@ -6,7 +6,7 @@ esphome:
   name_add_mac_suffix: true
   project:
     name: spuder.openspool
-    version: ${version} #TODO: why is this changing in github actions, but not sticking in 'make' command?
+    version: ${version}
     # on_update:
   min_version: 2024.10.1
   platformio_options:

firmware/conf.d/debug.yaml

@@ -6,23 +6,33 @@ debug:
 
 logger:
   level: debug
-#   level: VERBOSE #TODO: drop to debug
+
 
 text_sensor:
-  - platform: version
-    name: "Current Firmware Version"
-    hide_timestamp: true
+  # Note that this only returns the esphome compiled version
+  # It does not return esphome.platform.version, as that value is only available through the api
+  # - platform: version
+  #   name: "Current Firmware Version"
+  #   hide_timestamp: true
+  #   state_topic:
+  #   # web_server:
+  #   #   sorting_group_id: sorting_group_firmware
+
+  - platform: template
+    name: "OpenSpool Version"
+    lambda: |-
+      return to_string(ESPHOME_PROJECT_VERSION);
     state_topic:
-    # web_server:
-    #   sorting_group_id: sorting_group_firmware
+    entity_category: diagnostic
+    icon: mdi:new-box
 
-  - platform: debug
-    device:
-      name: "Device Info"
-      state_topic:
-    reset_reason:
-      name: "Reset Reason"
-      state_topic:
+  # - platform: debug
+  #   device:
+  #     name: "Device Info"
+  #     state_topic:
+  #   reset_reason:
+  #     name: "Reset Reason"
+  #     state_topic:
 
 sensor:
   - platform: debug

firmware/conf.d/improv.yaml

@@ -1,2 +1,2 @@
 improv_serial:
-  next_url: http://{{ip_address}}
+  next_url: "http://{{ip_address}}"

firmware/conf.d/leds.yaml

@@ -10,6 +10,7 @@ light:
     default_transition_length: 0.4s
     restore_mode: ALWAYS_OFF
     state_topic:
+    entity_category: diagnostic
     effects:
       - addressable_rainbow:
           name: Rainbow