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

Updated README.md with API documentation.

Browse Source
This commit is contained in:
Paulus Schoutsen 2013-09-28 11:24:14 -07:00
parent 495b107346
commit 2460ff748e
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -22,7 +22,27 @@ Installation instructions
Done. Start it now by running `python start.py` Done. Start it now by running `python start.py`
Home Assistent architecture Web interface and API
---------------------
Home Assistent runs a webserver accessible by default on port 8080. At / it will provide a debug interface showing the current state of the system. At /api/ it provides an API so it can be controlled from other devices through HTTP POST requests.
To interface with the API requests should include the parameter api_password which matches the api_password in home-assistant.conf.
The following API commands are currently supported:
/api/state/change - POST
parameter: api_password - string
parameter: category - string
parameter: new_state - string
Changes category 'category' to 'new_state'
/api/event/fire - POST
parameter: api_password - string
parameter: event_name - string
parameter: event_data - object encoded as JSON string (optional)
Fires an 'event_name' event containing data from 'event_data'
Architecture
--------------------------- ---------------------------
Home Assistent has been built from the ground up with extensibility and modularity in mind. It is easy to swap in a different device tracker that polls another wireless router for example. Home Assistent has been built from the ground up with extensibility and modularity in mind. It is easy to swap in a different device tracker that polls another wireless router for example.