Add a battery sensor to battery powered devices

hatasmota/const.py

@@ -36,6 +36,7 @@
 CONF_OPTIONS: Final = "so"
 CONF_PREFIX: Final = "tp"
 CONF_SENSOR: Final = "sn"
+CONF_BATTERY: Final = "bat"
 CONF_SHUTTER_OPTIONS: Final = "sho"
 CONF_SHUTTER_TILT: Final = "sht"
 CONF_STATE: Final = "state"
@@ -161,6 +162,8 @@
 SENSOR_STATUS_SSID: Final = "status_ssid"
 SENSOR_STATUS_VERSION: Final = "status_version"
 
+SENSOR_STATUS_BATTERY_PERCENTAGE: Final = "status_battery_percentage"
+
 SENSOR_UNIT_PRESSURE: Final = "PressureUnit"
 SENSOR_UNIT_SPEED: Final = "SpeedUnit"
 SENSOR_UNIT_TEMPERATURE: Final = "TempUnit"

hatasmota/device_status.py

@@ -38,6 +38,7 @@
 #  "Module or Template":"Generic",             <NONE>
 #  "RestartReason":"Software/System restart",  stat/STATUS1:"StatusPRM"."RestartReason"
 #  "Uptime":"1T17:04:28",                      stat/STATUS11:"StatusSTS"."Uptime"; tele/STATE:"Uptime"
+#  "BatteryPercentage":60,                     tele/STATE: "BatteryPercentage"
 #  "Hostname":"tasmota_B94927",                stat/STATUS5:"StatusNET":"Hostname"
 #  "IPAddress":"192.168.0.114",                stat/STATUS5:"StatusNET":"IPAddress"
 #  "RSSI":"100",                               stat/STATUS11:"StatusSTS":"RSSI"; tele/STATE:"RSSI"

hatasmota/discovery.py

@@ -10,6 +10,7 @@
 from . import config_validation as cv
 from .button import TasmotaButtonTrigger, TasmotaButtonTriggerConfig
 from .const import (
+    CONF_BATTERY,
     CONF_BUTTON,
     CONF_DEVICENAME,
     CONF_FRIENDLYNAME,
@@ -122,6 +123,9 @@
         CONF_OPTIONS: TASMOTA_OPTIONS_SCHEMA,
         CONF_PREFIX: vol.All(cv.ensure_list, [cv.string]),
         CONF_STATE: vol.All(cv.ensure_list, [cv.string]),
+        vol.Optional(
+            CONF_BATTERY, default=0
+        ): cv.positive_int,  # Added in Tasmota 13.0.0.3
         vol.Optional(CONF_SHUTTER_OPTIONS, default=[]): vol.All(
             cv.ensure_list, [cv.positive_int]
         ),  # Added in Tasmota 9.2

hatasmota/status_sensor.py

@@ -10,10 +10,13 @@
 import attr
 
 from .const import (
+    CONF_BATTERY,
     CONF_DEVICENAME,
     CONF_IP,
     CONF_MAC,
     PERCENTAGE,
+    SENSOR_BATTERY,
+    SENSOR_STATUS_BATTERY_PERCENTAGE,
     SENSOR_STATUS_IP,
     SENSOR_STATUS_LAST_RESTART_TIME,
     SENSOR_STATUS_LINK_COUNT,
@@ -46,6 +49,7 @@
 #  "Module or Template":"Generic",             <NONE>
 #  "RestartReason":"Software/System restart",  stat/STATUS1:"StatusPRM"."RestartReason"
 #  "Uptime":"1T17:04:28",                      stat/STATUS11:"StatusSTS"."Uptime"; tele/STATE:"Uptime"
+#  "BatteryPercentage":60,                     tele/STATE: "BatteryPercentage"
 #  "Hostname":"tasmota_B94927",                stat/STATUS5:"StatusNET":"Hostname"
 #  "IPAddress":"192.168.0.114",                stat/STATUS5:"StatusNET":"IPAddress"
 #  "RSSI":"100",                               stat/STATUS11:"StatusSTS":"RSSI"; tele/STATE:"RSSI"
@@ -74,6 +78,7 @@
     SENSOR_STATUS_LINK_COUNT: "WiFi Connect Count",
     SENSOR_STATUS_MQTT_COUNT: "MQTT Connect Count",
     SENSOR_STATUS_RESTART_REASON: "Restart Reason",
+    SENSOR_BATTERY: "Battery Level",
     SENSOR_STATUS_RSSI: "RSSI",
     SENSOR_STATUS_SIGNAL: "Signal",
     SENSOR_STATUS_SSID: "SSID",
@@ -89,6 +94,7 @@
 STATE_PATHS: dict[str, list[str | int]] = {
     SENSOR_STATUS_LINK_COUNT: ["Wifi", "LinkCount"],
     SENSOR_STATUS_MQTT_COUNT: ["MqttCount"],
+    SENSOR_STATUS_BATTERY_PERCENTAGE: ["BatteryPercentage"],
     SENSOR_STATUS_RSSI: ["Wifi", "RSSI"],
     SENSOR_STATUS_SIGNAL: ["Wifi", "Signal"],
 }
@@ -121,6 +127,7 @@
     SENSOR_STATUS_LINK_COUNT: SENSOR_STATUS_LINK_COUNT,
     SENSOR_STATUS_MQTT_COUNT: SENSOR_STATUS_MQTT_COUNT,
     SENSOR_STATUS_RESTART_REASON: SENSOR_STATUS_RESTART_REASON,
+    SENSOR_STATUS_BATTERY_PERCENTAGE: SENSOR_BATTERY,
     SENSOR_STATUS_RSSI: SENSOR_STATUS_RSSI,
     SENSOR_STATUS_SIGNAL: SENSOR_STATUS_SIGNAL,
     SENSOR_STATUS_SSID: SENSOR_STATUS_SSID,
@@ -133,6 +140,7 @@
     SENSOR_STATUS_LINK_COUNT: None,
     SENSOR_STATUS_MQTT_COUNT: None,
     SENSOR_STATUS_RESTART_REASON: None,
+    SENSOR_STATUS_BATTERY_PERCENTAGE: PERCENTAGE,
     SENSOR_STATUS_RSSI: PERCENTAGE,
     SENSOR_STATUS_SIGNAL: SIGNAL_STRENGTH_DECIBELS_MILLIWATT,
     SENSOR_STATUS_SSID: None,
@@ -155,6 +163,9 @@ def from_discovery_message(
         cls, config: dict, platform: str
     ) -> list[TasmotaStatusSensorConfig]:
         """Instantiate from discovery message."""
+        sensor_types = list(SENSORS)
+        if config[CONF_BATTERY] == 1:
+            sensor_types.append(SENSOR_STATUS_BATTERY_PERCENTAGE)
         sensors = [
             cls(
                 endpoint="status_sensor",
@@ -172,7 +183,7 @@ def from_discovery_message(
                 state_topic=get_topic_tele_state(config),
                 status_topic=get_topic_stat_status(config, STATUS_TOPICS.get(sensor)),
             )
-            for sensor in SENSORS
+            for sensor in sensor_types
         ]
         return sensors