jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-25 22:27:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add link to docs and update some docstrings

Browse Source
This commit is contained in:
Fabian Affolter 2015-11-07 23:56:00 +01:00
parent fda65a4934
commit 64d5ca4da0
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
homeassistant/remote.py
View File

@ -1,14 +1,15 @@
""" """
homeassistant.remote homeassistant.remote
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
A module containing drop in replacements for core parts that will interface A module containing drop in replacements for core parts that will interface
with a remote instance of home assistant. with a remote instance of Home Assistant.
If a connection error occurs while communicating with the API a If a connection error occurs while communicating with the API a
HomeAssistantError will be raised. HomeAssistantError will be raised.
"""
For more details about the Python API, please refer to the documentation at
https://home-assistant.io/developers/python_api/
"""
import threading import threading
import logging import logging
import json import json
@ -69,7 +70,7 @@ class API(object):
return self.status == APIStatus.OK return self.status == APIStatus.OK
def __call__(self, method, path, data=None): def __call__(self, method, path, data=None):
""" Makes a call to the Home Assistant api. """ """ Makes a call to the Home Assistant API. """
if data is not None: if data is not None:
data = json.dumps(data, cls=JSONEncoder) data = json.dumps(data, cls=JSONEncoder)
@ -189,7 +190,7 @@ class EventForwarder(object):
def connect(self, api): def connect(self, api):
""" """
Attach to a HA instance and forward events. Attach to a Home Assistant instance and forward events.
Will overwrite old target if one exists with same host/port. Will overwrite old target if one exists with same host/port.
""" """
@ -380,8 +381,7 @@ def get_state(api, entity_id):
""" Queries given API for state of entity_id. """ """ Queries given API for state of entity_id. """
try: try:
req = api(METHOD_GET, req = api(METHOD_GET, URL_API_STATES_ENTITY.format(entity_id))
URL_API_STATES_ENTITY.format(entity_id))
# req.status_code == 422 if entity does not exist # req.status_code == 422 if entity does not exist