Extend and update API documentation (#4485)
This commit is contained in:
parent
a7a467065d
commit
1330075f56
7 changed files with 66 additions and 9 deletions
|
@ -12,7 +12,10 @@ footer: true
|
|||
Home Assistant provides various APIs. For detail please refer to [Home Assistant API](https://dev-docs.home-assistant.io/en/dev/) documentation.
|
||||
|
||||
* [Python API](https://dev-docs.home-assistant.io/)
|
||||
* [Websocket API](/developers/websocket_api/)
|
||||
* [WebSocket API](/developers/websocket_api/)
|
||||
* [REST API](/developers/rest_api/)
|
||||
* [Python REST API](/developers/python_api/)
|
||||
* [Server-sent events](/developers/server_sent_events/)
|
||||
|
||||
If you are not using the [`frontend`](/components/frontend/) in your setup then you need to enable the components by adding them to your `configuration.yaml` file. E.g., [`websocket_api:`](/components/websocket_api/) for the WebSocket API or [`api:`](/components/api/) for the [REST API](/developers/rest_api/) and the [Python REST API](/developers/python_api/).
|
||||
|
||||
|
|
|
@ -13,7 +13,7 @@ See the [developer documentation][devdocs] for a full overview of the documentat
|
|||
|
||||
[devdocs]: https://dev-docs.home-assistant.io/en/master/api/homeassistant.html#module-homeassistant.remote
|
||||
|
||||
In the package [`homeassistant.remote`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/remote.py) a Python API on top of the [HTTP API](/developers/api/) can be found.
|
||||
In the package [`homeassistant.remote`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/remote.py) a Python API on top of the [HTTP API](/developers/api/) can be found. If you are not using the [`frontend`](/components/frontend/) in your setup then you need to add the [`api` component](/components/api/) to your `configuration.yaml` file to use the Python Remote API.
|
||||
|
||||
A simple way to get all current entities is to visit the "Set State" page in the "Developer Tools". For the examples below just choose one from the available entries. Here the sensor `sensor.office_temperature` and the switch `switch.livingroom_pin_2` are used.
|
||||
|
||||
|
|
|
@ -16,6 +16,8 @@ Home Assistant runs a web server accessible on port 8123.
|
|||
|
||||
The API accepts and returns only JSON encoded objects. All API calls have to be accompanied by the header `X-HA-Access: YOUR_PASSWORD` (YOUR_PASSWORD as specified in your `configuration.yaml` file in the [`http:` section](/components/http/)).
|
||||
|
||||
If you are not using the [`frontend`](/components/frontend/) in your setup then you need to add the [`api` component](/components/api/) to your `configuration.yaml` file.
|
||||
|
||||
There are multiple ways to consume the Home Assistant Rest API. One is with `curl`:
|
||||
|
||||
```bash
|
||||
|
|
|
@ -17,16 +17,18 @@ Home Assistant contains a WebSocket API. This API can be used to stream informat
|
|||
|
||||
Connect your websocket implementation to `ws://localhost:8123/api/websocket`.
|
||||
|
||||
If you are not using the [`frontend`](/components/frontend/) in your setup then you need to add the [`websocket_api` component](/components/websocket_api/) to your `configuration.yaml` file to use the WebSocket API.
|
||||
|
||||
## {% linkable_title Server states %}
|
||||
|
||||
1. Client connects
|
||||
1. Client connects.
|
||||
2. Authentication phase starts
|
||||
- If no further authentication necessary for the user: go to 3
|
||||
- Server sends `auth_required` message
|
||||
- Client sends `auth` message
|
||||
- If no further authentication necessary for the user: go to 3.
|
||||
- Server sends `auth_required` message.
|
||||
- Client sends `auth` message.
|
||||
- If `auth` message correct: go to 3.
|
||||
- Server sends `auth_invalid`. Go to 6.
|
||||
3. Send `auth_ok` message
|
||||
3. Send `auth_ok` message.
|
||||
4. Authentication phase ends.
|
||||
5. Command phase starts.
|
||||
1. Client can send commands.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue