For a generic introduction of entities, see entities architecture.
Below is an example switch entity that keeps track of their state in memory.
That's all there is to it to build a switch entity! Continue reading to learn more or check out the video tutorial.
An entity represents a device. There are various strategies to keep your entity in sync with the state of the device, the most popular one being polling.
With polling, Home Assistant will ask the entity from time to time (depending on the update interval of the component) to fetch the latest state. Home Assistant will poll an entity when the
should_poll property returns
True (the default value). You can either implement your update logic using
update() or the async method
async_update(). This method should fetch the latest state from the device and store it in an instance variable for the properties to return it.
When you subscribe to updates, your code is responsible for letting Home Assistant know that an update is available. Make sure you have the
should_poll property return
Whenever you receive new state from your subscription, you can tell Home Assistant that an update is available by calling
schedule_update_ha_state() or async callback
async_schedule_update_ha_state(). Pass in the boolean
True to the method if you want Home Assistant to call your update method before writing the update to Home Assistant.
The entity base class has a few properties that are common among all entities in Home Assistant. These can be added to any entity regardless of the type. All these properties are optional and don't need to be implemented.
Properties should always only return information from memory and not do I/O (like network requests). Implement
async_update() to fetch data.
|available||boolean||Indicate if Home Assistant is able to read the state and control the underlying device.|
|device_class||string||Extra classification of what the device is. Each domain specifies their own. Device classes can come with extra requirements for unit of measurement and supported features.|
|extra_state_attributes||dict||Extra information to store in the state machine. It needs to be information that further explains the state, it should not be static information like firmware version.|
|entity_picture||URL||Url of a picture to show for the entity.|
|name||string||Name of the entity|
|should_poll||boolean||Should Home Assistant check with the entity for an updated state. If set to |
|unique_id||string||A unique identifier for this entity. Needs to be unique within a platform (ie |
The following properties are also available on entities. However, they are for advanced use only and should be used with caution.
|force_update||boolean||Write each update to the state machine, even if the data is the same. Example use: when you are directly reading the value from a connected sensor instead of a cache. Use with caution, will spam the state machine.|
|icon||icon||Icon to use in the frontend. Icons start with |
|entity_registry_enabled_default||boolean||Indicate if the entity should be enabled or disabled when it is first added to the entity registry.|
The following properties are used and controlled by Home Assistant, and should not be overridden by integrations.
|enabled||boolean||Indicate if entity is enabled in the entity registry. It also returns |
Use these lifecycle hooks to execute code when certain events happen to the entity. All lifecycle hooks are async methods.
Called when an entity has their entity_id and hass object assigned, before it is written to the state machine for the first time. Example uses: restore the state, subscribe to updates or set callback/dispatch function/listener.
Called when an entity is about to be removed from Home Assistant. Example use: disconnect from the server or unsubscribe from updates.
If you want to add a new feature to an entity or any of its subtypes (light, switch, etc), you will need to propose it first in our architecture repo. Only additions will be considered that are common features among various vendors.