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

Update documentation for filtering services by supported features (#1834)

Browse Source
This commit is contained in:
Erik Montnemery 2023-07-10 15:08:06 +02:00 committed by GitHub
parent 2d4d6fe0b2
commit c1bd9c3155
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/dev_101_services.md
View File

@ -94,6 +94,11 @@ set_speed:
# listed supported features. # listed supported features.
supported_features: supported_features:
- fan.FanEntityFeature.SET_SPEED - fan.FanEntityFeature.SET_SPEED
# If a service requires more than one supported feature, the item should
# be given as a list of required supported features. For example, if the
# service requires both SET_SPEED and OSCILLATE it would be expressed like this
- - fan.FanEntityFeature.SET_SPEED
- fan.FanEntityFeature.OSCILLATE
# Different fields that your service accepts # Different fields that your service accepts
fields: fields:
# Key of the field # Key of the field
@ -258,4 +263,4 @@ Service calls are registered with a `SupportsResponse` value to indicate respons
| Value | Description | | Value | Description |
| ---------- | -------------------------------------------- | | ---------- | -------------------------------------------- |
| `OPTIONAL` | The service performs an action and can optionally return response data. The service should conditionally check the `ServiceCall` property `return_response` to decide whether or not response data should be returned, or `None`. | | `OPTIONAL` | The service performs an action and can optionally return response data. The service should conditionally check the `ServiceCall` property `return_response` to decide whether or not response data should be returned, or `None`. |
| `ONLY` | The service doesn't perform any actions and always returns response data. | | `ONLY` | The service doesn't perform any actions and always returns response data. |