jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document user-provided services.yaml file (#10186)

Browse Source 
* Document user-provided services.yaml file

* ✏️ Tweak
This commit is contained in:
Jeff Irion 2019-08-22 11:02:36 -07:00 committed by Paulus Schoutsen
parent 6d76203c89
commit 66288827a2
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
source/_components/python_script.markdown
View File

@ -45,6 +45,7 @@ hass.bus.fire(name, { "wow": "from a Python script!" })
The following example shows how to call a service from `python_script`. This script takes two parameters: `entity_id` (required), `rgb_color` (optional) and calls `light.turn_on` service by setting the brightness value to `255`. The following example shows how to call a service from `python_script`. This script takes two parameters: `entity_id` (required), `rgb_color` (optional) and calls `light.turn_on` service by setting the brightness value to `255`.
```python ```python
# turn_on_light.py
entity_id = data.get('entity_id') entity_id = data.get('entity_id')
rgb_color = data.get('rgb_color', [255, 255, 255]) rgb_color = data.get('rgb_color', [255, 255, 255])
if entity_id is not None: if entity_id is not None:
@ -57,4 +58,21 @@ The above `python_script` can be called using the following JSON as an input.
{"entity_id": "light.bedroom", "rgb_color": [255, 0, 0] } {"entity_id": "light.bedroom", "rgb_color": [255, 0, 0] }
``` ```
## Documenting your Python scripts
You can add descriptions for your Python scripts that will be shown in the Call Services tab of the Developer Options page. To do so, simply create a `services.yaml` file in your `<config>/python_scripts` folder. Using the above Python script as an example, the `services.yaml` file would look like:
```yaml
# services.yaml
turn_on_light:
description: Turn on a light and set its color.
fields:
entity_id:
description: The light that will be turned on.
example: light.bedroom
rgb_color:
description: The color to which the light will be set.
example: [255, 0, 0]
```
For more examples, visit the [Scripts section](https://community.home-assistant.io/c/projects/scripts) in our forum. For more examples, visit the [Scripts section](https://community.home-assistant.io/c/projects/scripts) in our forum.