Add not state helper

Author: andrew-codechimp

README.md

@@ -8,14 +8,15 @@
 
 Label State Helpers for Home Assistant
 
-You can create both state and numeric state helpers which provide a binary sensor that turns on if any entity with an assigned label matches the criteria you specify.
+You can create state, not state and numeric state helpers which provide a binary sensor that turns on if any entity with an assigned label matches the criteria you specify.
 
 An `entities` attribute is available which lists all entities that match the criteria.
 
 ## Example use cases
 
-- Create a critical sensors label and create a Label State helper which turns on when any of those entities goes unavailable so you can get a notification.
-- If you have appliances which should always draw a certain wattage create a numeric Label State helper to turn on when any of those devices starts drawing 0 watts, triggering a notification.
+- Create a `critical sensors` label and create a State type Label State helper which turns on when any of those entities goes unavailable so you can get a notification.
+- Create a `must be on` label and create a Not State type Label State helper which turns on when any of those entities goes to any state but on so you can get a notification.
+- If you have appliances which should always draw a certain wattage create a Numeric State type Label State helper to turn on when any of those devices starts drawing 0 watts, triggering a notification.
 
 ![Helper State](https://raw.githubusercontent.com/andrew-codechimp/ha-label-state/main/images/label_state.png "Helper Label State")
 

custom_components/label_state/binary_sensor.py

@@ -24,6 +24,7 @@
     ATTR_ENTITIES,
     CONF_LABEL,
     CONF_STATE_LOWER_LIMIT,
+    CONF_STATE_NOT,
     CONF_STATE_TO,
     CONF_STATE_TYPE,
     CONF_STATE_UPPER_LIMIT,
@@ -48,6 +49,7 @@ async def async_setup_entry(
     label: str = config_entry.options[CONF_LABEL]
     state_type: str = config_entry.options[CONF_STATE_TYPE]
     state_to: str | None = config_entry.options.get(CONF_STATE_TO)
+    state_not: str | None = config_entry.options.get(CONF_STATE_NOT)
     state_lower_limit: float | None = config_entry.options.get(CONF_STATE_LOWER_LIMIT)
     state_upper_limit: float | None = config_entry.options.get(CONF_STATE_UPPER_LIMIT)
     unique_id = config_entry.entry_id
@@ -64,6 +66,7 @@ async def async_setup_entry(
                 name,
                 state_type,
                 state_to,
+                state_not,
                 state_lower_limit,
                 state_upper_limit,
                 unique_id,
@@ -83,6 +86,7 @@ async def async_setup_platform(
     name: str | None = config.get(CONF_NAME)
     state_type: str = config[CONF_STATE_TYPE]
     state_to: str | None = config.get(CONF_STATE_TO)
+    state_not: str | None = config.get(CONF_STATE_NOT)
     state_lower_limit: float | None = config.get(CONF_STATE_LOWER_LIMIT)
     state_upper_limit: float | None = config.get(CONF_STATE_UPPER_LIMIT)
     unique_id = config.get(CONF_UNIQUE_ID)
@@ -95,6 +99,7 @@ async def async_setup_platform(
                 name,
                 state_type,
                 state_to,
+                state_not,
                 state_lower_limit,
                 state_upper_limit,
                 unique_id,
@@ -118,6 +123,7 @@ def __init__(
         name: str | None,
         state_type: str,
         state_to: str | None,
+        state_not: str | None,
         state_lower_limit: float | None,
         state_upper_limit: float | None,
         unique_id: str | None,
@@ -127,6 +133,7 @@ def __init__(
         self._label = label
         self._state_type = state_type
         self._state_to = state_to
+        self._state_not = state_not
         self._state_lower_limit = state_lower_limit
         self._state_upper_limit = state_upper_limit
         self._attr_name = name
@@ -275,6 +282,21 @@ def _calc_state(self) -> None:
                         state_is_on = True
                         entities_on.append(entity_id)
 
+        if self._state_type == StateTypes.NOT_STATE:
+            for entity_id in self._state_dict.keys():
+                # Check if the state still has the label
+                entity_entry = entity_registry.async_get(entity_id)
+                if entity_entry and self._label in entity_entry.labels:
+                    entity_state = self._state_dict[entity_id]
+
+                    if (
+                        entity_state
+                        and self._state_not
+                        and entity_state.casefold() != self._state_not.casefold()
+                    ):
+                        state_is_on = True
+                        entities_on.append(entity_id)
+
         if self._state_type == StateTypes.NUMERIC_STATE:
             for entity_id in self._state_dict.keys():
                 # Check if the state still has the label

custom_components/label_state/config_flow.py

@@ -18,23 +18,22 @@
 from .const import (
     CONF_LABEL,
     CONF_STATE_LOWER_LIMIT,
+    CONF_STATE_NOT,
     CONF_STATE_TO,
     CONF_STATE_TYPE,
     CONF_STATE_UPPER_LIMIT,
     DOMAIN,
     StateTypes,
 )
 
-STATE_TYPES = [
-    "numeric_state",
-    "state",
-]
+STATE_TYPES = ["numeric_state", "state", "state_not"]
 
 STATE_TO_UNAVAILABLE = "unavailable"
 STATE_TO_UNKNOWN = "unknown"
-STATE_TO_ON = "on"
-STATE_TO_OFF = "off"
-STATE_TO_OPTIONS = [STATE_TO_UNAVAILABLE, STATE_TO_UNKNOWN, STATE_TO_ON, STATE_TO_OFF]
+STATE_ON = "on"
+STATE_OFF = "off"
+STATE_TO_OPTIONS = [STATE_TO_UNAVAILABLE, STATE_TO_UNKNOWN, STATE_ON, STATE_OFF]
+STATE_NOT_OPTIONS = [STATE_ON, STATE_OFF]
 
 
 OPTIONS_SCHEMA_NUMERIC_STATE = vol.Schema(
@@ -66,6 +65,19 @@
     }
 )
 
+OPTIONS_SCHEMA_NOT_STATE = vol.Schema(
+    {
+        vol.Required(CONF_LABEL): selector.LabelSelector(),
+        vol.Required(CONF_STATE_NOT): selector.SelectSelector(
+            selector.SelectSelectorConfig(
+                options=STATE_NOT_OPTIONS,
+                translation_key="state_not",
+                custom_value=True,
+            )
+        ),
+    }
+)
+
 CONFIG_SCHEMA_NUMERIC_STATE = vol.Schema(
     {
         vol.Required("name"): selector.TextSelector(),
@@ -78,6 +90,12 @@
     }
 ).extend(OPTIONS_SCHEMA_STATE.schema)
 
+CONFIG_SCHEMA_NOT_STATE = vol.Schema(
+    {
+        vol.Required("name"): selector.TextSelector(),
+    }
+).extend(OPTIONS_SCHEMA_NOT_STATE.schema)
+
 
 async def choose_options_step(options: dict[str, Any]) -> str:
     """Return next step_id for options flow according to label_type."""
@@ -128,6 +146,10 @@ async def _validate_user_input(
         CONFIG_SCHEMA_STATE,
         validate_user_input=validate_user_input(StateTypes.STATE),
     ),
+    StateTypes.NOT_STATE: SchemaFlowFormStep(
+        CONFIG_SCHEMA_NOT_STATE,
+        validate_user_input=validate_user_input(StateTypes.NOT_STATE),
+    ),
 }
 
 
@@ -140,6 +162,10 @@ async def _validate_user_input(
     StateTypes.STATE: SchemaFlowFormStep(
         OPTIONS_SCHEMA_STATE, validate_user_input=validate_user_input(StateTypes.STATE)
     ),
+    StateTypes.NOT_STATE: SchemaFlowFormStep(
+        OPTIONS_SCHEMA_NOT_STATE,
+        validate_user_input=validate_user_input(StateTypes.NOT_STATE),
+    ),
 }
 
 

custom_components/label_state/const.py

@@ -26,6 +26,7 @@
 CONF_LABEL = "label"
 CONF_STATE_TYPE = "state_type"
 CONF_STATE_TO = "state_to"
+CONF_STATE_NOT = "state_not"
 CONF_STATE_LOWER_LIMIT = "state_lower_limit"
 CONF_STATE_UPPER_LIMIT = "state_upper_limit"
 
@@ -37,3 +38,4 @@ class StateTypes(StrEnum):
 
     NUMERIC_STATE = "numeric_state"
     STATE = "state"
+    NOT_STATE = "state_not"

custom_components/label_state/translations/de.json

@@ -9,11 +9,12 @@
                 "description": "Create a binary sensor that is on if any sensor with the label meets the criteria.",
                 "menu_options": {
                     "numeric_state": "Numeric state",
-                    "state": "State"
+                    "state": "State",
+                    "state_not": "Not state"
                 }
             },
             "numeric_state": {
-                "title": "Label State",
+                "title": "Label Numeric State",
                 "description": "Create a binary sensor that is on if any sensor's value with the label is outside of its normal bounds.",
                 "data": {
                     "label": "Label",
@@ -24,11 +25,20 @@
             },
             "state": {
                 "title": "Label State",
-                "description": "Create a binary sensor that is on if any sensor with a label meets the criteria.",
+                "description": "Create a binary sensor that is on if any sensor with the label has the specified state.",
+                "data": {
+                    "label": "Label",
+                    "name": "Name",
+                    "state_to": "Is"
+                }
+            },
+            "state_not": {
+                "title": "Label Not State",
+                "description": "Create a binary sensor that is on if any sensor with the label does not have the specified state.",
                 "data": {
                     "label": "Label",
                     "name": "Name",
-                    "state_to": "To"
+                    "state_not": "Not"
                 }
             }
         }
@@ -39,7 +49,7 @@
         },
         "step": {
             "numeric_state": {
-                "title": "Label State",
+                "title": "Label Numeric State",
                 "description": "Create a binary sensor that is on if any sensor's value with the label is outside of its normal bounds.",
                 "data": {
                     "label": "Label",
@@ -49,10 +59,18 @@
             },
             "state": {
                 "title": "Label State",
-                "description": "Create a binary sensor that is on if any sensor with a label meets the criteria.",
+                "description": "Create a binary sensor that is on if any sensor with the label has the specified state.",
+                "data": {
+                    "label": "Label",
+                    "state_to": "Is"
+                }
+            },
+            "state_not": {
+                "title": "Label Not State",
+                "description": "Create a binary sensor that is on if any sensor with the label does not have the specified state.",
                 "data": {
                     "label": "Label",
-                    "state_to": "To"
+                    "state_not": "Not"
                 }
             }
         }
@@ -65,6 +83,13 @@
                 "on": "On",
                 "off": "Off"
             }
+        },
+        "state_not": {
+            "options": {
+                "on": "On",
+                "off": "Off"
+            }
         }
+
     }
 }

custom_components/label_state/translations/en.json

@@ -9,11 +9,12 @@
                 "description": "Create a binary sensor that is on if any sensor with the label meets the criteria.",
                 "menu_options": {
                     "numeric_state": "Numeric state",
-                    "state": "State"
+                    "state": "State",
+                    "state_not": "Not state"
                 }
             },
             "numeric_state": {
-                "title": "Label State",
+                "title": "Label Numeric State",
                 "description": "Create a binary sensor that is on if any sensor's value with the label is outside of its normal bounds.",
                 "data": {
                     "label": "Label",
@@ -24,11 +25,20 @@
             },
             "state": {
                 "title": "Label State",
-                "description": "Create a binary sensor that is on if any sensor with a label meets the criteria.",
+                "description": "Create a binary sensor that is on if any sensor with the label has the specified state.",
+                "data": {
+                    "label": "Label",
+                    "name": "Name",
+                    "state_to": "Is"
+                }
+            },
+            "state_not": {
+                "title": "Label Not State",
+                "description": "Create a binary sensor that is on if any sensor with the label does not have the specified state.",
                 "data": {
                     "label": "Label",
                     "name": "Name",
-                    "state_to": "To"
+                    "state_not": "Not"
                 }
             }
         }
@@ -39,7 +49,7 @@
         },
         "step": {
             "numeric_state": {
-                "title": "Label State",
+                "title": "Label Numeric State",
                 "description": "Create a binary sensor that is on if any sensor's value with the label is outside of its normal bounds.",
                 "data": {
                     "label": "Label",
@@ -49,10 +59,18 @@
             },
             "state": {
                 "title": "Label State",
-                "description": "Create a binary sensor that is on if any sensor with a label meets the criteria.",
+                "description": "Create a binary sensor that is on if any sensor with the label has the specified state.",
+                "data": {
+                    "label": "Label",
+                    "state_to": "Is"
+                }
+            },
+            "state_not": {
+                "title": "Label Not State",
+                "description": "Create a binary sensor that is on if any sensor with the label does not have the specified state.",
                 "data": {
                     "label": "Label",
-                    "state_to": "To"
+                    "state_not": "Not"
                 }
             }
         }
@@ -65,6 +83,13 @@
                 "on": "On",
                 "off": "Off"
             }
+        },
+        "state_not": {
+            "options": {
+                "on": "On",
+                "off": "Off"
+            }
         }
+
     }
 }

images/label_state.png

@@ -12,7 +12,7 @@ source venv/bin/activate
 ```
 
 You can then install the dependencies that will allow you to run tests:
-`pip3 install -r requirements_test.txt.`
+`pip3 install -r requirements_test.txt`
 
 This will install `homeassistant`, `pytest`, and `pytest-homeassistant-custom-component`, a plugin which allows you to leverage helpers that are available in Home Assistant for core integration tests.