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-24 01:36:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve remote documentation (#633)

Browse Source 
Co-authored-by: Paulus Schoutsen <balloob@gmail.com>
This commit is contained in:
Chris Talkington 2020-09-02 02:17:30 -05:00 committed by GitHub
parent c5c8ea1826
commit 9e76aefbf0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/core/entity/remote.md
View File

@ -3,10 +3,6 @@ title: Remote Entity
sidebar_label: Remote
---
:::info Incomplete
This entry is incomplete. Contribution welcome.
:::
## Properties
:::tip
@ -16,4 +12,36 @@ Properties should always only return information from memory and not do I/O (lik
| Name | Type | Default | Description
| ---- | ---- | ------- | -----------
## Supported Features
| Constant | Description
| -------- | -----------
| `SUPPORT_LEARN_COMMAND` | Entity allows learning commands from devices.
## Methods
### Send Command
```python
class MyRemote(RemoteEntity):
def send_command(self, command: Iterable[str], **kwargs):
"""Send commands to a device."""
async def async_send_command(self, command: Iterable[str], **kwargs):
"""Send commands to a device."""
```
### Learn Command
Only implement this method if the flag `SUPPORT_LEARN_COMMAND` is set.
```python
class MyRemote(RemoteEntity):
def learn_command(self, **kwargs):
"""Learn a command from a device."""
async def async_learn_command(self, **kwargs):
"""Learn a command from a device."""
```