Hide battery low (#4962)

Author: andrew-codechimp

custom_components/battery_notes/__init__.py

@@ -46,6 +46,7 @@
     CONF_ENABLE_REPLACED,
     CONF_FILTER_OUTLIERS,
     CONF_HIDE_BATTERY,
+    CONF_HIDE_BATTERY_LOW,
     CONF_HW_VERSION,
     CONF_MANUFACTURER,
     CONF_MODEL,
@@ -88,6 +89,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_HIDE_BATTERY_LOW, default=False): cv.boolean,
                     vol.Optional(CONF_ROUND_BATTERY, default=False): cv.boolean,
                     vol.Optional(
                         CONF_DEFAULT_BATTERY_LOW_THRESHOLD,
@@ -158,6 +160,9 @@ async def async_setup_entry(
     domain_config.enable_replaced = config_entry.options[CONF_ADVANCED_SETTINGS][
         CONF_ENABLE_REPLACED
     ]
+    domain_config.hide_battery_low = config_entry.options[CONF_ADVANCED_SETTINGS].get(
+        CONF_HIDE_BATTERY_LOW, False
+    )
     domain_config.user_library = config_entry.options[CONF_ADVANCED_SETTINGS][
         CONF_USER_LIBRARY
     ]

custom_components/battery_notes/binary_sensor.py

@@ -256,6 +256,35 @@ def extra_state_attributes(self) -> dict[str, Any] | None:
         return attrs
 
 
+class BatteryNotesNonTemplateBatteryLowSensor(BatteryNotesBatteryLowBaseSensor):
+    """Low battery binary sensor base for non templated entities."""
+
+    entity_description: BatteryNotesBinarySensorEntityDescription
+
+    def __init__(
+        self,
+        hass: HomeAssistant,
+        coordinator: BatteryNotesSubentryCoordinator,
+        entity_description: BatteryNotesBinarySensorEntityDescription,
+    ):
+        """Initialize the low battery binary sensor."""
+
+        super().__init__(
+            hass, entity_description=entity_description, coordinator=coordinator
+        )
+
+        registry = er.async_get(hass)
+        entity = registry.async_get(self.entity_id)
+
+        if entity is not None and entity.hidden_by != er.RegistryEntryHider.USER:
+            registry.async_update_entity(
+                self.entity_id,
+                hidden_by=er.RegistryEntryHider.INTEGRATION
+                if hass.data[MY_KEY].hide_battery_low
+                else None,
+            )
+
+
 class BatteryNotesBatteryLowBinaryTemplateSensor(
     BatteryNotesBatteryLowBaseSensor, RestoreEntity
 ):
@@ -436,7 +465,9 @@ def is_on(self) -> bool | None:
         return self._state
 
 
-class BatteryNotesBatteryPercentageTemplateLowSensor(BatteryNotesBatteryLowBaseSensor):
+class BatteryNotesBatteryPercentageTemplateLowSensor(
+    BatteryNotesNonTemplateBatteryLowSensor
+):
     """Represents a low battery threshold binary sensor from a template percentage."""
 
     _attr_should_poll = False
@@ -485,7 +516,7 @@ def _handle_coordinator_update(self) -> None:
         )
 
 
-class BatteryNotesBatteryWrappedLowSensor(BatteryNotesBatteryLowBaseSensor):
+class BatteryNotesBatteryWrappedLowSensor(BatteryNotesNonTemplateBatteryLowSensor):
     """Represents a low battery threshold binary sensor from a device percentage."""
 
     _attr_should_poll = False
@@ -547,7 +578,7 @@ def _handle_coordinator_update(self) -> None:
         )
 
 
-class BatteryNotesBatteryBinaryLowSensor(BatteryNotesBatteryLowBaseSensor):
+class BatteryNotesBatteryBinaryLowSensor(BatteryNotesNonTemplateBatteryLowSensor):
     """Represents a low battery binary sensor from a binary sensor."""
 
     _attr_should_poll = False

custom_components/battery_notes/config_flow.py

@@ -42,6 +42,7 @@
     CONF_ENABLE_REPLACED,
     CONF_FILTER_OUTLIERS,
     CONF_HIDE_BATTERY,
+    CONF_HIDE_BATTERY_LOW,
     CONF_HW_VERSION,
     CONF_INTEGRATION_NAME,
     CONF_MANUFACTURER,
@@ -88,6 +89,9 @@
                 {
                     vol.Required(CONF_ENABLE_AUTODISCOVERY): selector.BooleanSelector(),
                     vol.Required(CONF_ENABLE_REPLACED): selector.BooleanSelector(),
+                    vol.Required(
+                        CONF_HIDE_BATTERY_LOW, default=False
+                    ): selector.BooleanSelector(),
                     vol.Optional(CONF_USER_LIBRARY): selector.TextSelector(),
                 }
             ),
@@ -291,6 +295,7 @@ async def async_step_integration_discovery(
                 CONF_ADVANCED_SETTINGS: {
                     CONF_ENABLE_AUTODISCOVERY: True,
                     CONF_ENABLE_REPLACED: True,
+                    CONF_HIDE_BATTERY_LOW: False,
                     CONF_USER_LIBRARY: "",
                 },
             }
@@ -342,6 +347,7 @@ async def async_step_user(
                 CONF_ADVANCED_SETTINGS: {
                     CONF_ENABLE_AUTODISCOVERY: True,
                     CONF_ENABLE_REPLACED: True,
+                    CONF_HIDE_BATTERY_LOW: False,
                     CONF_USER_LIBRARY: "",
                 },
             }

custom_components/battery_notes/const.py

@@ -51,6 +51,7 @@
 CONF_BATTERY_PERCENTAGE_TEMPLATE = "battery_percentage_template"
 CONF_FILTER_OUTLIERS = "filter_outliers"
 CONF_ADVANCED_SETTINGS = "advanced_settings"
+CONF_HIDE_BATTERY_LOW = "hide_battery_low"
 
 DATA_CONFIGURED_ENTITIES = "configured_entities"
 DATA_DISCOVERED_ENTITIES = "discovered_entities"

custom_components/battery_notes/coordinator.py

@@ -88,6 +88,7 @@ class BatteryNotesDomainConfig:
     show_all_devices: bool = False
     enable_replaced: bool = True
     hide_battery: bool = False
+    hide_battery_low: bool = False
     round_battery: bool = False
     default_battery_low_threshold: int = DEFAULT_BATTERY_LOW_THRESHOLD
     battery_increased_threshod: int = DEFAULT_BATTERY_INCREASE_THRESHOLD

custom_components/battery_notes/translations/en.json

@@ -173,11 +173,13 @@
                         "data": {
                             "enable_autodiscovery": "Auto discovery",
                             "enable_replaced": "Enable battery replaced",
+                            "hide_battery_low": "Hide battery low",
                             "user_library": "User library"
                         },
                         "data_description": {
                             "enable_autodiscovery": "Auto discovery of devices that are in the library.",
                             "enable_replaced": "Enable the battery replaced button on each battery note.",
+                            "hide_battery_low": "Hide the battery low binary sensor when a battery percentage is available, avoiding duplication on generated dashboards.",
                             "user_library": "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 `config/.storage/battery_notes`."
                         }
                     }