Skip to content

Rename CoverDevice to CoverEntity #476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MartinHjelmare merged 4 commits into from
Apr 25, 2020
Merged

Rename CoverDevice to CoverEntity #476

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9c33ada
Rename CoverDevice to CoverEntity
emontnemery Apr 25, 2020
929c0cb
Tweak
emontnemery Apr 25, 2020
63dcd29
Tweak
emontnemery Apr 25, 2020
58267d0
Wording
MartinHjelmare Apr 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/entity_cover.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Cover Entity
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

Expand Down Expand Up @@ -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.

```python
class MyCover(CoverDevice):
class MyCover(CoverEntity):
# Implement one of these methods.

def open_cover(self, **kwargs):
Expand All @@ -88,7 +88,7 @@ class MyCover(CoverDevice):
Only implement this method if the flag `SUPPORT_CLOSE` is set.

```python
class MyCover(CoverDevice):
class MyCover(CoverEntity):
# Implement one of these methods.

def close_cover(self, **kwargs):
Expand All @@ -103,7 +103,7 @@ class MyCover(CoverDevice):
Only implement this method if the flag `SUPPORT_SET_POSITION` is set.

```python
class MyCover(CoverDevice):
class MyCover(CoverEntity):
# Implement one of these methods.

def set_cover_position(self, **kwargs):
Expand All @@ -118,7 +118,7 @@ class MyCover(CoverDevice):
Only implement this method if the flag `SUPPORT_STOP` is set.

```python
class MyCover(CoverDevice):
class MyCover(CoverEntity):
# Implement one of these methods.

def stop_cover(self, **kwargs):
Expand All @@ -133,7 +133,7 @@ class MyCover(CoverDevice):
Only implement this method if the flag `SUPPORT_OPEN_TILT` is set.

```python
class MyCover(CoverDevice):
class MyCover(CoverEntity):
# Implement one of these methods.

def open_cover_tilt(self, **kwargs):
Expand All @@ -148,7 +148,7 @@ class MyCover(CoverDevice):
Only implement this method if the flag `SUPPORT_CLOSE_TILT` is set.

```python
class MyCover(CoverDevice):
class MyCover(CoverEntity):
# Implement one of these methods.

def close_cover_tilt(self, **kwargs):
Expand All @@ -163,7 +163,7 @@ class MyCover(CoverDevice):
Only implement this method if the flag `SUPPORT_SET_TILT_POSITION` is set.

```python
class MyCover(CoverDevice):
class MyCover(CoverEntity):
# Implement one of these methods.

def set_cover_tilt_position(self, **kwargs):
Expand All @@ -178,7 +178,7 @@ class MyCover(CoverDevice):
Only implement this method if the flag `SUPPORT_STOP_TILT` is set.

```python
class MyCover(CoverDevice):
class MyCover(CoverEntity):
# Implement one of these methods.

def stop_cover_tilt(self, **kwargs):
Expand Down