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-07-16 05:46:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename CoverDevice to CoverEntity (#476)

Browse Source
This commit is contained in:
Erik Montnemery 2020-04-25 18:19:57 +02:00 committed by GitHub
parent 9dce45bf85
commit 93387a520d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/entity_cover.md
View File

@ -3,7 +3,7 @@ title: Cover Entity
sidebar_label: Cover sidebar_label: Cover
--- ---
A cover entity is a device that controls an opening or cover, such as a garage door and window shade. Derive entity platforms from [`homeassistant.components.cover.CoverDevice`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/cover/__init__.py). A cover entity controls an opening or cover, such as a garage door or a window shade. Derive a platform entity from [`homeassistant.components.cover.CoverEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/cover/__init__.py).
## Properties ## Properties
@ -73,7 +73,7 @@ Supported features constants are combined using the bitwise or (`|`) operator.
Only implement this method if the flag `SUPPORT_OPEN` is set. Only implement this method if the flag `SUPPORT_OPEN` is set.
```python ```python
class MyCover(CoverDevice): class MyCover(CoverEntity):
# Implement one of these methods. # Implement one of these methods.
def open_cover(self, **kwargs): def open_cover(self, **kwargs):
@ -88,7 +88,7 @@ class MyCover(CoverDevice):
Only implement this method if the flag `SUPPORT_CLOSE` is set. Only implement this method if the flag `SUPPORT_CLOSE` is set.
```python ```python
class MyCover(CoverDevice): class MyCover(CoverEntity):
# Implement one of these methods. # Implement one of these methods.
def close_cover(self, **kwargs): def close_cover(self, **kwargs):
@ -103,7 +103,7 @@ class MyCover(CoverDevice):
Only implement this method if the flag `SUPPORT_SET_POSITION` is set. Only implement this method if the flag `SUPPORT_SET_POSITION` is set.
```python ```python
class MyCover(CoverDevice): class MyCover(CoverEntity):
# Implement one of these methods. # Implement one of these methods.
def set_cover_position(self, **kwargs): def set_cover_position(self, **kwargs):
@ -118,7 +118,7 @@ class MyCover(CoverDevice):
Only implement this method if the flag `SUPPORT_STOP` is set. Only implement this method if the flag `SUPPORT_STOP` is set.
```python ```python
class MyCover(CoverDevice): class MyCover(CoverEntity):
# Implement one of these methods. # Implement one of these methods.
def stop_cover(self, **kwargs): def stop_cover(self, **kwargs):
@ -133,7 +133,7 @@ class MyCover(CoverDevice):
Only implement this method if the flag `SUPPORT_OPEN_TILT` is set. Only implement this method if the flag `SUPPORT_OPEN_TILT` is set.
```python ```python
class MyCover(CoverDevice): class MyCover(CoverEntity):
# Implement one of these methods. # Implement one of these methods.
def open_cover_tilt(self, **kwargs): def open_cover_tilt(self, **kwargs):
@ -148,7 +148,7 @@ class MyCover(CoverDevice):
Only implement this method if the flag `SUPPORT_CLOSE_TILT` is set. Only implement this method if the flag `SUPPORT_CLOSE_TILT` is set.
```python ```python
class MyCover(CoverDevice): class MyCover(CoverEntity):
# Implement one of these methods. # Implement one of these methods.
def close_cover_tilt(self, **kwargs): def close_cover_tilt(self, **kwargs):
@ -163,7 +163,7 @@ class MyCover(CoverDevice):
Only implement this method if the flag `SUPPORT_SET_TILT_POSITION` is set. Only implement this method if the flag `SUPPORT_SET_TILT_POSITION` is set.
```python ```python
class MyCover(CoverDevice): class MyCover(CoverEntity):
# Implement one of these methods. # Implement one of these methods.
def set_cover_tilt_position(self, **kwargs): def set_cover_tilt_position(self, **kwargs):
@ -178,7 +178,7 @@ class MyCover(CoverDevice):
Only implement this method if the flag `SUPPORT_STOP_TILT` is set. Only implement this method if the flag `SUPPORT_STOP_TILT` is set.
```python ```python
class MyCover(CoverDevice): class MyCover(CoverEntity):
# Implement one of these methods. # Implement one of these methods.
def stop_cover_tilt(self, **kwargs): def stop_cover_tilt(self, **kwargs):