All binary sensors have a platform and an optional device class. By default, the binary will chose the appropriate device class itself, but you can always override it. binary_sensor: platform: 29 rows · On means update available, Off means up-to-date. The use of this device class 21/10/ · Proposal Add a new running device class to binary sensors. This can be used for services and devices (like add-ons and appliances) that have 2 operation modes 22/01/ · As a noob to Homeassistant, I’m trying to assign a device_class to a binary_sensor as follows: platform: mqtt. state_topic: “home/sensors/window”. name: 04/05/ · Other thing, device_class isn’t listed as an option for Raspberry Pi GPIO Binary Sensor so you may need to add this to your customize config: blogger.comor: ... read more
They are digital in nature, whereas analog sensors, like temperature and weight sensors, return a range of values. Some binary sensors are created automatically when you add a device integration.
For example, adding the ecobee integration will create a binary sensor to detect room occupancy. All binary sensors have a platform and an optional device class. By default, the binary will chose the appropriate device class itself, but you can always override it. icon Optional , icon : Manually set the icon to use for the binary sensor in the frontend.
filters Optional , list : A list of filters to apply on the binary sensor values such as inverting signals. See Binary Sensor Filters. internal Optional , boolean : Mark this component as internal. Internal components will not be exposed to the frontend like Home Assistant. Only specifying an id without a name will implicitly set this to true. Requires Home Assistant Defaults to false. This means that any applicable triggers will be run. Set to "" to remove the default entity category.
If MQTT enabled, all other options from MQTT Component. With binary sensor filters you can customize how ESPHome handles your binary sensor values even more. They are similar to Sensor Filters. All filters are processed in a pipeline. This means all binary sensor filters are processed in the order given in the configuration so order of these entries matters!
Required , Time : When a signal ON is received, wait for the specified time period until publishing an ON state. If an OFF value is received while waiting, the ON action is discarded. Or in other words: Only send an ON value if the binary sensor has stayed ON for at least the specified time period.
Useful for debouncing push buttons. Required , Time : When a signal OFF is received, wait for the specified time period until publishing an OFF state. If an ON value is received while waiting, the OFF action is discarded. Define an automation trigger to update the entities. If omitted will update based on referenced entities. See trigger documentation. The unique ID for this config block. This will be prefixed to all unique IDs of all entities in this block.
Defines the units of measurement of the sensor, if any. This will also display the value based on the user profile Number Format setting and influence the graphical presentation in the history visualization as a continuous value. The sensor is on if the template evaluates as True , yes , on , enable or a positive number. Any other value will render it as off.
The amount of time e. This can also be a template. The amount of time the template state must be not met before this sensor will switch to off. Requires a trigger. Sets the class of the device, changing the device state and icon that is displayed on the UI see below. Defines actions to run when the number value changes. The variable value will contain the number entered. Defines actions to run to select an option from the options list.
The variable option will contain the option selected. An ID that uniquely identifies this entity. Will be combined with the unique ID of the configuration block if available. Defines a template to get the available state of the entity. If the template either fails to render or returns True , "1" , "true" , "yes" , "on" , "enable" , or a non-zero number, the entity will be available.
If the template returns any other value, the entity will be unavailable. If not configured, the entity will always be available. Note that the string comparison not case sensitive; "TrUe" and "yEs" are allowed. The above configuration variables describe a configuration section. The template integration allows defining multiple sections. State-based and trigger-based template entities have the special template variable this available in their templates and actions. Trigger-based entities also provide the trigger data.
When there are entities present in the template and no triggers are defined, the template will be re-rendered when one of the entities changes states. To avoid this taking up too many resources in Home Assistant, rate limiting will be automatically applied if too many states are observed.
Define a trigger to avoid a rate limit and get more control over entity updates. When states is used in a template by itself to iterate all states on the system, the template is re-rendered each time any state changed event happens if any part of the state is accessed. When merely counting states, the template is only re-rendered when a state is added or removed from the system. On busy systems with many entities or hundreds of thousands state changed events per day, templates may re-render more than desirable.
In the below example, re-renders are limited to once per minute because we iterate over all available entities:. In the below example, re-renders are limited to once per second because we iterate over all entities in a single domain sensor :. If the template accesses every state on the system, a rate limit of one update per minute is applied.
If the template accesses all states under a specific domain, a rate limit of one update per second is applied. If the template only accesses specific states, receives update events for specifically referenced entities, or the homeassistant. If you are using the state of a platform that might not be available during startup, the Template Sensor may get an unknown state.
For example, you would replace {{ states. Template entities can be triggered using any automation trigger, including webhook triggers. Use a trigger-based template entity to store this information in template entities. You can use a trigger-based template entity to convert any event or other automation trigger into a binary sensor. The below configuration will turn on a binary sensor for 5 seconds when the automation trigger triggers.
The template integration allows creating entities which derive their values from other data. This is done by specifying templates for properties of an entity, like the name or the state. For other types, please see the specific pages:. Sensor, binary sensor, button, number and select template entities are defined in your YAML configuration files, directly under the template: key and cannot be configured via the UI.
You can define multiple configuration blocks as a list. Template entities will by default update as soon as any of the referenced data in the template updates. For example, you can have a template that takes the averages of two sensors. Home Assistant will update your template sensor as soon as either source sensor updates. If you want more control over when an entity updates, you can define a trigger. Triggers follow the same format and work exactly the same as triggers in automations.
This feature is a great way to create entities based on webhook data example , or update entities based on a schedule. Whenever the trigger fires, all related entities will re-render and it will have access to the trigger data in the templates.
Trigger-based entities do not automatically update when states referenced in the templates change. This functionality can be added back by defining a state trigger for each entity that you want to trigger updates. The state, including attributes, of trigger-based sensors and binary sensors is restored when Home Assistant is restarted.
The state of other trigger-based template entities is not restored. Define an automation trigger to update the entities. If omitted will update based on referenced entities. See trigger documentation. The unique ID for this config block. This will be prefixed to all unique IDs of all entities in this block. Defines the units of measurement of the sensor, if any.
This will also display the value based on the user profile Number Format setting and influence the graphical presentation in the history visualization as a continuous value. The sensor is on if the template evaluates as True , yes , on , enable or a positive number. Any other value will render it as off. The amount of time e. This can also be a template. The amount of time the template state must be not met before this sensor will switch to off.
Requires a trigger. Sets the class of the device, changing the device state and icon that is displayed on the UI see below. Defines actions to run when the number value changes. The variable value will contain the number entered. Defines actions to run to select an option from the options list. The variable option will contain the option selected. An ID that uniquely identifies this entity. Will be combined with the unique ID of the configuration block if available.
Defines a template to get the available state of the entity. If the template either fails to render or returns True , "1" , "true" , "yes" , "on" , "enable" , or a non-zero number, the entity will be available. If the template returns any other value, the entity will be unavailable. If not configured, the entity will always be available.
Note that the string comparison not case sensitive; "TrUe" and "yEs" are allowed. The above configuration variables describe a configuration section. The template integration allows defining multiple sections. State-based and trigger-based template entities have the special template variable this available in their templates and actions. Trigger-based entities also provide the trigger data.
When there are entities present in the template and no triggers are defined, the template will be re-rendered when one of the entities changes states. To avoid this taking up too many resources in Home Assistant, rate limiting will be automatically applied if too many states are observed. Define a trigger to avoid a rate limit and get more control over entity updates.
When states is used in a template by itself to iterate all states on the system, the template is re-rendered each time any state changed event happens if any part of the state is accessed. When merely counting states, the template is only re-rendered when a state is added or removed from the system.
On busy systems with many entities or hundreds of thousands state changed events per day, templates may re-render more than desirable. In the below example, re-renders are limited to once per minute because we iterate over all available entities:. In the below example, re-renders are limited to once per second because we iterate over all entities in a single domain sensor :. If the template accesses every state on the system, a rate limit of one update per minute is applied.
If the template accesses all states under a specific domain, a rate limit of one update per second is applied. If the template only accesses specific states, receives update events for specifically referenced entities, or the homeassistant.
If you are using the state of a platform that might not be available during startup, the Template Sensor may get an unknown state. For example, you would replace {{ states. Template entities can be triggered using any automation trigger, including webhook triggers. Use a trigger-based template entity to store this information in template entities.
You can use a trigger-based template entity to convert any event or other automation trigger into a binary sensor. The below configuration will turn on a binary sensor for 5 seconds when the automation trigger triggers. This example shows a multiple line template with an if test. This example is determining if anyone is home based on the combination of device tracking and motion sensors.
This is providing a composite of Wi-Fi based device tracking and Z-Wave multisensor presence sensors. This example shows how to combine a non-GPS e. This example demonstrates how to use template to change the icon as its state changes.
This icon is referencing its own state. This example demonstrates a binary sensor that turns on momentarily, such as when a doorbell button is pressed.
The binary sensor turns on and sets the matching icon when the appropriate event is received. After 5 seconds, the binary sensor turns off automatically. To ensure the icon gets updated, there must be a trigger for when the state changes to off. This example demonstrates how the this variable can be used in templates for self-referencing.
This format still works but is no longer recommended. Use modern configuration. An ID that uniquely identifies this binary sensor. Set this to a unique value to allow customization through the UI.
Sets the class of the device , changing the device state and icon that is displayed on the frontend. The sensor is on if the template evaluates as True and off otherwise. The amount of time the template state must be met before this sensor will switch to on. This format is configured as a platform for the sensor integration and not directly under the template integration. An ID that uniquely identifies this sensor. Defines a template to get the available state of the component. If the template returns true , the device is available.
If the template returns any other value, the device will be unavailable. For other types, please see the specific pages: Alarm Control Panel Cover Fan Light Lock Switch Vacuum Weather Sensor, binary sensor, button, number and select template entities are defined in your YAML configuration files, directly under the template: key and cannot be configured via the UI.
State-based template binary sensors, buttons, numbers, selects and sensors Template entities will by default update as soon as any of the referenced data in the template updates.
Configuration Variables Looking for your configuration file? trigger list Optional. sensor map Required. List of sensors. state template Required. Defines a template to get the state of the sensor. List of binary sensors. Fields that can be used above for both sensors and binary sensors. picture template Optional. Defines a template for the entity picture of the sensor.
attributes map Optional. Defines templates for attributes of the sensor.
04/05/ · Other thing, device_class isn’t listed as an option for Raspberry Pi GPIO Binary Sensor so you may need to add this to your customize config: blogger.comor: All binary sensors have a platform and an optional device class. By default, the binary will chose the appropriate device class itself, but you can always override it. binary_sensor: platform: plant watering sensor (not thirsty/thirsty) status of alarm system (armed/disarmed) cat bowl feeder (empty/not empty) mail in mailbox (you have mail/no mail for you) broken glass detector All binary sensors have a platform and an optional device class. By default, the binary will chose the appropriate device class itself, but you can always override it. binary_sensor: platform: plant watering sensor (not thirsty/thirsty) status of alarm system (armed/disarmed) cat bowl feeder (empty/not empty) mail in mailbox (you have mail/no mail for you) broken glass detector 04/05/ · Other thing, device_class isn’t listed as an option for Raspberry Pi GPIO Binary Sensor so you may need to add this to your customize config: blogger.comor: ... read more
For example, adding the ecobee integration will create a binary sensor to detect room occupancy. Sign in to your account. You can create a value template and make a binary sensor display anything you like. log : "Single Short Clicked". Required , Time : Only send an ON or OFF value if the binary sensor has stayed in the same state for at least the specified time period.
You signed out in another tab or window. The sensor is on if the template evaluates as True and off otherwise, binary sensor device class. When a signal ON is received it is passed to the output and the first delay is started. attributes map Optional. picture template Optional. Trigger-based entities also provide the trigger data. If you are using the state of a platform that might not be available during startup, the Template Sensor may get an unknown state.