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-20 17:16:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename SwitchDevice to SwitchEntity (#480)

Browse Source
This commit is contained in:
Erik Montnemery 2020-04-26 21:55:08 +02:00 committed by GitHub
parent 762d1da8ca
commit 5b21c9475f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/entity_switch.md
View File

@ -3,6 +3,10 @@ title: Switch Entity
sidebar_label: Switch sidebar_label: Switch
--- ---
A switch entity turns on or off something, for example a relay. Derive a platform entity from [`homeassistant.components.switch.SwitchEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/switch/__init__.py).
To represent something which can be turned on or off but can't be controlled, for example a wall switch which transmits its state but can't be turned on or off from Home Assistant, a Binary Sensor is a better choice.
To represent something which doesn't have a state, for example a door bell push button, a custom event or a Device Trigger is a better choice.
## Properties ## Properties
:::tip :::tip
@ -23,7 +27,7 @@ Properties should always only return information from memory and not do I/O (lik
Turn the switch on. Turn the switch on.
```python ```python
class MySwitch(SwitchDevice): class MySwitch(SwitchEntity):
# Implement one of these methods. # Implement one of these methods.
def turn_on(self, **kwargs) -> None: def turn_on(self, **kwargs) -> None:
@ -38,7 +42,7 @@ class MySwitch(SwitchDevice):
Turn the switch off. Turn the switch off.
```python ```python
class MySwitch(SwitchDevice): class MySwitch(SwitchEntity):
# Implement one of these methods. # Implement one of these methods.
def turn_off(self, **kwargs): def turn_off(self, **kwargs):
@ -53,7 +57,7 @@ class MySwitch(SwitchDevice):
Optional. If not implemented will default to checking what method to call using the `is_on` property. Optional. If not implemented will default to checking what method to call using the `is_on` property.
```python ```python
class MySwitch(SwitchDevice): class MySwitch(SwitchEntity):
# Implement one of these methods. # Implement one of these methods.
def toggle(self, **kwargs): def toggle(self, **kwargs):