Round battery (#745)

* Round the battery config option

* Round the event battery levels

* Delete unused schema now migrated

* Change device class of battery_low to show nice coloured icon

* Update readme

* Update readme

* Fix icons.json

Author: andrew-codechimp

README.md

@@ -8,6 +8,7 @@
 
 Integration to add battery notes to a device, with automatic discovery via a growing [battery library](library.md) for devices.  
 Track the battery type, when the battery was replaced and also when a battery is low based on device or global thresholds.  
+A battery+ sensor provides useful attributes for easy use in dashboards, the standard battery can optionally be hidden.  
 
 *Please :star: this repo if you find it useful*  
 *If you want to show your support please*

custom_components/battery_notes/__init__.py

@@ -46,6 +46,7 @@
     CONF_DEFAULT_BATTERY_LOW_THRESHOLD,
     CONF_BATTERY_INCREASE_THRESHOLD,
     CONF_HIDE_BATTERY,
+    CONF_ROUND_BATTERY,
     DEFAULT_BATTERY_LOW_THRESHOLD,
     DEFAULT_BATTERY_INCREASE_THRESHOLD,
     SERVICE_BATTERY_REPLACED,
@@ -72,6 +73,7 @@
                     vol.Optional(CONF_SHOW_ALL_DEVICES, default=False): cv.boolean,
                     vol.Optional(CONF_ENABLE_REPLACED, default=True): cv.boolean,
                     vol.Optional(CONF_HIDE_BATTERY, default=False): cv.boolean,
+                    vol.Optional(CONF_ROUND_BATTERY, default=False): cv.boolean,
                     vol.Optional(
                         CONF_DEFAULT_BATTERY_LOW_THRESHOLD,
                         default=DEFAULT_BATTERY_LOW_THRESHOLD,
@@ -113,6 +115,7 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
         CONF_SHOW_ALL_DEVICES: False,
         CONF_ENABLE_REPLACED: True,
         CONF_HIDE_BATTERY: False,
+        CONF_ROUND_BATTERY: False,
         CONF_DEFAULT_BATTERY_LOW_THRESHOLD: DEFAULT_BATTERY_LOW_THRESHOLD,
         CONF_BATTERY_INCREASE_THRESHOLD: DEFAULT_BATTERY_INCREASE_THRESHOLD,
     }

custom_components/battery_notes/binary_sensor.py

@@ -19,6 +19,7 @@
     PLATFORM_SCHEMA,
     BinarySensorEntity,
     BinarySensorEntityDescription,
+    BinarySensorDeviceClass,
 )
 
 from homeassistant.helpers.entity import DeviceInfo, EntityCategory
@@ -44,6 +45,7 @@
     DOMAIN_CONFIG,
     DATA,
     CONF_ENABLE_REPLACED,
+    CONF_ROUND_BATTERY,
     CONF_BATTERY_INCREASE_THRESHOLD,
     EVENT_BATTERY_THRESHOLD,
     EVENT_BATTERY_INCREASED,
@@ -146,9 +148,12 @@ async def async_registry_updated(event: Event) -> None:
     device_id = async_add_to_device(hass, config_entry)
 
     enable_replaced = True
+    round_battery = False
+
     if DOMAIN_CONFIG in hass.data[DOMAIN]:
         domain_config: dict = hass.data[DOMAIN][DOMAIN_CONFIG]
         enable_replaced = domain_config.get(CONF_ENABLE_REPLACED, True)
+        round_battery = domain_config.get(CONF_ROUND_BATTERY, False)
 
     description = BatteryNotesBinarySensorEntityDescription(
         unique_id_suffix="_battery_low",
@@ -157,6 +162,7 @@ async def async_registry_updated(event: Event) -> None:
         icon="mdi:battery-alert",
         entity_category=EntityCategory.DIAGNOSTIC,
         entity_registry_enabled_default=enable_replaced,
+        device_class=BinarySensorDeviceClass.BATTERY,
     )
 
     device = hass.data[DOMAIN][DATA].devices[config_entry.entry_id]
@@ -170,6 +176,7 @@ async def async_registry_updated(event: Event) -> None:
                     description,
                     f"{config_entry.entry_id}{description.unique_id_suffix}",
                     device,
+                    round_battery,
                 )
             ]
         )
@@ -202,6 +209,7 @@ def __init__(
         description: BatteryNotesBinarySensorEntityDescription,
         unique_id: str,
         device: BatteryNotesDevice,
+        round_battery: bool,
     ) -> None:
         """Create a low battery binary sensor."""
         device_registry = dr.async_get(hass)
@@ -210,6 +218,7 @@ def __init__(
         self.entity_description = description
         self._attr_unique_id = unique_id
         self._attr_has_entity_name = True
+        self.round_battery = round_battery
 
         if coordinator.device_id and (
             device_entry := device_registry.async_get(coordinator.device_id)
@@ -261,6 +270,14 @@ async def async_state_changed_listener(
 
         await self.coordinator.async_request_refresh()
 
+        if isfloat(wrapped_battery_state.state):
+            if self.round_battery:
+                battery_level = int(wrapped_battery_state.state)
+            else:
+                battery_level = round(float(wrapped_battery_state.state), 1)
+        else:
+            battery_level = wrapped_battery_state.state
+
         if self._previous_state_last_changed:
             # Battery low event
             if battery_low != self._previous_battery_low:
@@ -273,9 +290,7 @@ async def async_state_changed_listener(
                         ATTR_BATTERY_TYPE_AND_QUANTITY: self.coordinator.battery_type_and_quantity,
                         ATTR_BATTERY_TYPE: self.coordinator.battery_type,
                         ATTR_BATTERY_QUANTITY: self.coordinator.battery_quantity,
-                        ATTR_BATTERY_LEVEL: round(float(wrapped_battery_state.state), 1)
-                        if isfloat(wrapped_battery_state.state)
-                        else wrapped_battery_state.state,
+                        ATTR_BATTERY_LEVEL: battery_level,
                         ATTR_PREVIOUS_BATTERY_LEVEL: self._previous_battery_level,
                     },
                 )
@@ -306,18 +321,14 @@ async def async_state_changed_listener(
                             ATTR_BATTERY_TYPE_AND_QUANTITY: self.coordinator.battery_type_and_quantity,
                             ATTR_BATTERY_TYPE: self.coordinator.battery_type,
                             ATTR_BATTERY_QUANTITY: self.coordinator.battery_quantity,
-                            ATTR_BATTERY_LEVEL: round(
-                                float(wrapped_battery_state.state), 1
-                            )
-                            if isfloat(wrapped_battery_state.state)
-                            else wrapped_battery_state.state,
+                            ATTR_BATTERY_LEVEL: battery_level,
                             ATTR_PREVIOUS_BATTERY_LEVEL: self._previous_battery_level,
                         },
                     )
 
                     _LOGGER.debug("battery_increased event fired")
 
-        self._previous_battery_level = float(wrapped_battery_state.state)
+        self._previous_battery_level = battery_level
         self._previous_state_last_changed = wrapped_battery_state.last_changed
         self._previous_battery_low = battery_low
 

custom_components/battery_notes/const.py

@@ -42,6 +42,7 @@
 CONF_DEFAULT_BATTERY_LOW_THRESHOLD = "default_battery_low_threshold"
 CONF_BATTERY_INCREASE_THRESHOLD = "battery_increase_threshold"
 CONF_HIDE_BATTERY = "hide_battery"
+CONF_ROUND_BATTERY = "round_battery"
 
 DATA_CONFIGURED_ENTITIES = "configured_entities"
 DATA_DISCOVERED_ENTITIES = "discovered_entities"

custom_components/battery_notes/icons.json

@@ -1,5 +1,5 @@
 {
-    "service": {
+    "services": {
         "set_battery_replaced": "mdi:battery-sync"
     }
 }

custom_components/battery_notes/sensor.py

@@ -55,6 +55,7 @@
     DOMAIN_CONFIG,
     CONF_ENABLE_REPLACED,
     CONF_HIDE_BATTERY,
+    CONF_ROUND_BATTERY,
     ATTR_BATTERY_QUANTITY,
     ATTR_BATTERY_TYPE,
     ATTR_BATTERY_TYPE_AND_QUANTITY,
@@ -157,16 +158,19 @@ async def async_registry_updated(event: Event) -> None:
     await coordinator.async_refresh()
 
     enable_replaced = True
+    round_battery = False
+
     if DOMAIN_CONFIG in hass.data[DOMAIN]:
         domain_config: dict = hass.data[DOMAIN][DOMAIN_CONFIG]
         enable_replaced = domain_config.get(CONF_ENABLE_REPLACED, True)
+        round_battery = domain_config.get(CONF_ROUND_BATTERY, False)
 
     battery_plus_sensor_entity_description = BatteryNotesSensorEntityDescription(
         unique_id_suffix="_battery_plus",
         key="battery_plus",
         translation_key="battery_plus",
         device_class=SensorDeviceClass.BATTERY,
-        suggested_display_precision=1,
+        suggested_display_precision=0 if round_battery else 1,
     )
 
     type_sensor_entity_description = BatteryNotesSensorEntityDescription(
@@ -214,6 +218,7 @@ async def async_registry_updated(event: Event) -> None:
                 f"{config_entry.entry_id}{battery_plus_sensor_entity_description.unique_id_suffix}",
                 device,
                 enable_replaced,
+                round_battery,
             )
         )
 
@@ -247,6 +252,7 @@ def __init__(
         unique_id: str,
         device: BatteryNotesDevice,
         enable_replaced: bool,
+        round_battery: bool,
     ) -> None:
         """Initialize the sensor."""
         super().__init__(coordinator)
@@ -260,6 +266,7 @@ def __init__(
         self._attr_unique_id = unique_id
         self.device = device
         self.enable_replaced = enable_replaced
+        self.round_battery = round_battery
 
         self._device_id = coordinator.device_id
         if coordinator.device_id and (
@@ -313,7 +320,10 @@ def async_state_changed_listener(
 
         self._attr_available = True
 
-        self._attr_native_value = round(float(wrapped_battery_state.state), 1)
+        if self.round_battery:
+            self._attr_native_value = int(wrapped_battery_state.state)
+        else:
+            self._attr_native_value = round(float(wrapped_battery_state.state), 1)
 
         self._wrapped_attributes = wrapped_battery_state.attributes
 

docs/configuration.md

@@ -22,6 +22,7 @@ enable_replaced | Boolean | Optional | True | If set to false new devices added
 default_battery_low_threshold | Int | Optional | 10 | The default threshold where a devices battery_low entity is set to true and the battery_notes_battery_threshold event is fired, can be overriden per device in device configuration. |
 battery_increase_threshold | Int | Optional | 25 | The threshold where the battery_notes_battery_increased event is fired, use this event for battery replaced automations. The threshold is the difference in increase between previous and current battery level. |
 hide_battery | Boolean | Optional | False | Hide the standard battery when adding Battery+. This will not effect existing dashboards, automations etc.|
+round_battery | Boolean | Optional | False | Round battery+ to whole percentages.|
 user_library | String | Optional |  | If specified then a user library file will be searched prior to the main library, the user library must be in the same format as the library and placed in the same folder. Only really used for dev purposes. |
 
 # Debug Logging