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

Document requirements for entity service schemas (#2301)

Browse Source 
* Documented requirements for entity service schema

* Update docs/dev_101_services.md

Co-authored-by: Robert Resch <robert@resch.dev>

---------

Co-authored-by: Robert Resch <robert@resch.dev>
This commit is contained in:
Erik Montnemery 2024-09-02 15:17:15 +02:00 committed by GitHub
parent 268ef66481
commit c87281edc4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/dev_101_services.md
View File

@ -234,7 +234,14 @@ The following example shows how to provide an icon for the `advanced_options` se
Sometimes you want to provide extra actions to control your entities. For example, the Sonos integration provides action to group and ungroup devices. Entity service actions are special because there are many different ways a user can specify entities. It can use areas, a group or a list of entities. Sometimes you want to provide extra actions to control your entities. For example, the Sonos integration provides action to group and ungroup devices. Entity service actions are special because there are many different ways a user can specify entities. It can use areas, a group or a list of entities.
You need to register entity service actions in your platforms, like `<your-domain>/media_player.py`. These service actions will be made available under your domain and not the media player domain. Example code: You need to register entity service actions in your platforms, like `<your-domain>/media_player.py`. These service actions will be made available under your domain and not under the platform domain (e.g. media player domain). A schema can be passed to `async_register_entity_service` if the entity service action has fields. The schema must be either of:
- A dictionary which will automatically be passed to `cv._make_entity_service_schema`
- A validator returned by `cv._make_entity_service_schema`
- A validator returned by `cv._make_entity_service_schema`, wrapped in a `vol.Schema`
- A validator returned by `cv._make_entity_service_schema`, wrapped in a `vol.All`
Example code:
```python ```python
from homeassistant.helpers import config_validation as cv, entity_platform, service from homeassistant.helpers import config_validation as cv, entity_platform, service