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-23 09:17:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add docs for timeout kwarg to Python API (#673)

Browse Source
This commit is contained in:
Nathan Henrie 2016-07-25 23:46:08 -06:00 committed by Paulus Schoutsen
parent 1f75907e4c
commit ee87fdc05e
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
source/developers/python_api.markdown
View File

@ -142,6 +142,30 @@ time.sleep(5)
remote.call_service(api, domain, 'turn_off', {'entity_id': '{}'.format(switch_name)})
```
### {% linkable_title Specify a timeout %}
The default timeout for an API call with `call_service` is 5 seconds. Service
taking longer than this to return will raise
`homeassistant.exceptions.HomeAssistantError: Timeout` unless provided with a
longer timeout.
```python
import homeassistant.remote as remote
api = remote.API('host', 'password')
domain = 'switch'
# Assuming switch.timeout_switch takes 10 seconds to return
switch_name = 'switch.timeout_switch'
# Raises homeassistant.exceptions.HomeAssistantError: Timeout when talking to
remote.call_service(api, domain, 'turn_on', {'entity_id': switch_name})
# Runs withous exception
remote.call_service(api, domain, 'turn_on', {'entity_id': switch_name},
timeout=11)
```
### {% linkable_title Send a notification %}
The example uses the jabber notification platform to send a single message to the given recipient in the `configuration.yaml` file.