jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-06-04 09:16:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add blog about renaming entity classes (#526)

Browse Source
This commit is contained in:
Paulus Schoutsen 2020-05-14 12:07:11 -07:00 committed by GitHub
parent e6bce19d17
commit 415deac62a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
blog/2020-05-14-entity-class-names.md Normal file
View File

@ -0,0 +1,32 @@
---
author: Paulus Schoutsen
authorURL: https://github.com/balloob
authorTwitter: balloob
title: Entity class names
---
Ever wondered when implementing entities for our entity integrations why you had to extend `BinarySensorDevice` and not `BinarySensorEntity`? Wonder no longer, as we have addressed the situation in Home Assistant 0.110 by renaming all classes that incorrectly had Device in their name. The old classes are still around but will log a warning when used.
All integrations in Home Assistant have been upgraded. Custom component authors need to do the migration themselves. You can do this while keeping backwards compatibility by using the following snippet:
```python
try:
from homeassistant.components.binary_sensor import BinarySensorEntity
except ImportError:
from homeassistant.components.binary_sensor import BinarySensorDevice as BinarySensorEntity
```
The following classes have been renamed:
| Old Class Name | New Class Name |
| -------------------- | -------------------- |
| `BinarySensorDevice` | `BinarySensorEntity` |
| `MediaPlayerDevice` | `MediaPlayerEntity` |
| `LockDevice` | `LockEntity` |
| `ClimateDevice` | `ClimateEntity` |
| `CoverDevice` | `CoverEntity` |
| `VacuumDevice` | `VacuumEntity` |
| `RemoteDevice` | `RemoteEntity` |
| `Light` | `LightEntity` |
| `SwitchDevice` | `SwitchEntity` |
| `WaterHeaterDevice` | `WaterHeaterEntity` |