Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-12-26 17:27:47 +01:00
Code Issues Projects Releases Wiki Activity

Minor changes to the setup steps (#327)

Browse Source
This commit is contained in:
Fabian Affolter 2019-08-27 19:30:06 +02:00 committed by Otto Winter
parent 2ade2f4982
commit d65872a9ec
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
components/api.rst
View File

@ -7,17 +7,17 @@ Native API Component
:keywords: Native API, ESPHome, Home Assistant :keywords: Native API, ESPHome, Home Assistant
The ESPHome native API is used to communicate with clients directly, with a highly-optimized The ESPHome native API is used to communicate with clients directly, with a highly-optimized
network protocol. Currently, only the esphome tool and Home Assistant use this native API. network protocol. Currently, only the ESPHome tool and Home Assistant use this native API.
After adding an ``api:`` line to your esphome configuration you can go to the Home Assistant After adding an ``api:`` line to your ESPHome configuration you can go to the Home Assistant
webinterface and navigate to the "Integrations" screen in the "Configuration" panel. Then wait web interface and navigate to the "Integrations" screen in the "Configuration" panel. Then wait
for the ESPHome device to show up under the discovered section (can take up to 5 minutes) or add for the ESPHome device to show up under the discovered section (can take up to 5 minutes) or add
the device manually by clicking "CONFIGURE" on the ESPHome integration and entering the device manually by choosing "ESPHome" from the integration overview and entering
"<NODE_NAME>.local" as the address. "<NODE_NAME>.local" or the IP address of the unit in the "Host" field.
The ESPHome native API is based on a custom TCP protocol using protocol buffers. You can find The ESPHome native API is based on a custom TCP protocol using protocol buffers. You can find
the protocol data structure definitions here: https://github.com/esphome/esphome/blob/dev/src/esphome/components/api/api.proto the protocol data structure definitions here: https://github.com/esphome/esphome/blob/dev/src/esphome/components/api/api.proto
A python library that implements this protocol can be found `here <https://github.com/esphome/aioesphomeapi>`__. A Python library that implements this protocol is `aioesphomeapi <https://github.com/esphome/aioesphomeapi>`__.
.. code-block:: yaml .. code-block:: yaml
@ -66,7 +66,7 @@ You can repeat these steps for all your nodes, or convert them over to the new n
3. Go to your Home Assistant configuration folder and go to the ``.storage`` folder (might be hidden 3. Go to your Home Assistant configuration folder and go to the ``.storage`` folder (might be hidden
depending on your operating system). In there you will find a file called ``core.entity_registry`` - open depending on your operating system). In there you will find a file called ``core.entity_registry`` - open
the file with a text editor and paste the contents below the file with a text editor and paste the contents below:
.. raw:: html .. raw:: html