diff --git a/docs/core/entity/binary-sensor.md b/docs/core/entity/binary-sensor.md index 4c0f5706..f1fab4a7 100644 --- a/docs/core/entity/binary-sensor.md +++ b/docs/core/entity/binary-sensor.md @@ -3,7 +3,7 @@ title: Binary Sensor Entity sidebar_label: Binary Sensor --- -A binary sensor is a sensor that can only have two states. +A binary sensor is a sensor that can only have two states. Derive entity platforms from [`homeassistant.components.binary_sensor.BinarySensorEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/binary_sensor/__init__.py) ## Properties diff --git a/docs/core/entity/remote.md b/docs/core/entity/remote.md index 20129b3c..20bc731a 100644 --- a/docs/core/entity/remote.md +++ b/docs/core/entity/remote.md @@ -3,6 +3,8 @@ title: Remote Entity sidebar_label: Remote --- +Derive entity platforms from [`homeassistant.components.remote.RemoteEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/remote/__init__.py) + ## Properties :::tip diff --git a/docs/core/entity/sensor.md b/docs/core/entity/sensor.md index db2c3c55..555f8818 100644 --- a/docs/core/entity/sensor.md +++ b/docs/core/entity/sensor.md @@ -3,7 +3,7 @@ title: Sensor Entity sidebar_label: Sensor --- -A sensor is a read-only entity that provides some information. Information has a value and optionally, a unit of measurement. +A sensor is a read-only entity that provides some information. Information has a value and optionally, a unit of measurement. Derive entity platforms from [`homeassistant.components.sensor.SensorEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/sensor/__init__.py) ## Properties diff --git a/docs/core/entity/vacuum.md b/docs/core/entity/vacuum.md index a7a8f90d..c1b2f573 100644 --- a/docs/core/entity/vacuum.md +++ b/docs/core/entity/vacuum.md @@ -3,12 +3,18 @@ title: Vacuum Entity sidebar_label: Vacuum --- +Derive entity platforms from [`homeassistant.components.vacuum.StateVacuumEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/vacuum/__init__.py) + ## Properties :::tip Properties should always only return information from memory and not do I/O (like network requests). Implement `update()` or `async_update()` to fetch data. ::: +:::note +`VacuumEntity` is deprecated and will be removed in future releases. Please use or migrate to the `StateVacuumEntity` +::: + :::caution VacuumEntity and StateVacuumEntity do not support attribute shorthand for [property implementation](../entity.md#entity-class-or-instance-attributes) ::: diff --git a/docs/core/entity/water-heater.md b/docs/core/entity/water-heater.md index 7a0e9944..5993902b 100644 --- a/docs/core/entity/water-heater.md +++ b/docs/core/entity/water-heater.md @@ -3,6 +3,8 @@ title: Water Heater Entity sidebar_label: Water Heater --- +Derive entity platforms from [`homeassistant.components.water_heater.WaterHeaterEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/water_heater/__init__.py) + ## Properties :::tip diff --git a/docs/core/entity/weather.md b/docs/core/entity/weather.md index 6beed2e3..e57757eb 100644 --- a/docs/core/entity/weather.md +++ b/docs/core/entity/weather.md @@ -3,6 +3,8 @@ title: Weather Entity sidebar_label: Weather --- +Derive entity platforms from [`homeassistant.components.weather.WeatherEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/weather/__init__.py) + ## Properties :::tip