Redo the homeassistant service call API setup instructions (#3631)
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
This commit is contained in:
parent
03807510dc
commit
051ed8736d
|
@ -240,6 +240,11 @@ a:hover code {
|
||||||
background: none;
|
background: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* don't underline links that contain an image and nothing else */
|
||||||
|
a:has(> img:only-child) {
|
||||||
|
border-bottom: none;
|
||||||
|
}
|
||||||
|
|
||||||
div.body p, div.body dd, div.body li, div.body blockquote {
|
div.body p, div.body dd, div.body li, div.body blockquote {
|
||||||
hyphens: none;
|
hyphens: none;
|
||||||
}
|
}
|
||||||
|
|
|
@ -75,20 +75,35 @@ Configuration variables:
|
||||||
|
|
||||||
.. _api-actions:
|
.. _api-actions:
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
Before a newly added ESPHome device can interact with the Home Assistant API it needs to be allowed to communicate
|
|
||||||
with it. This setting can be found in the ESPHome integration (NOT in the Add-On) by clicking "CONFIGURE" for
|
|
||||||
that device and enabling the "Allow device to make service calls" option.
|
|
||||||
|
|
||||||
Actions
|
Actions
|
||||||
-------
|
-------
|
||||||
|
|
||||||
|
Before using any of the actions below, you'll need to tell Home Assistant to allow your device to
|
||||||
|
make service calls.
|
||||||
|
|
||||||
|
Open the ESPHome integration page on your Home Assistant instance:
|
||||||
|
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<a href="https://my.home-assistant.io/redirect/integration/?domain=esphome" target="_blank" rel="noreferrer noopener"><img src="https://my.home-assistant.io/badges/integration.svg" alt="Open your Home Assistant instance and show an integration." /></a>
|
||||||
|
|
||||||
|
Then:
|
||||||
|
|
||||||
|
#. Fnd your device in the device list
|
||||||
|
#. Click the "configure" button next to it
|
||||||
|
#. Check the "Allow the device to make Home Assistant service calls" box
|
||||||
|
#. Then click "submit".
|
||||||
|
|
||||||
.. _api-homeassistant_event_action:
|
.. _api-homeassistant_event_action:
|
||||||
|
|
||||||
``homeassistant.event`` Action
|
``homeassistant.event`` Action
|
||||||
******************************
|
******************************
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Be sure to :ref:`follow the instructions above <api-actions>` to tell Home Assistant to allow
|
||||||
|
your device to make service calls.
|
||||||
|
|
||||||
When using the native API with Home Assistant, you can create events in the Home Assistant event bus
|
When using the native API with Home Assistant, you can create events in the Home Assistant event bus
|
||||||
straight from ESPHome :ref:`Automations <automation>`.
|
straight from ESPHome :ref:`Automations <automation>`.
|
||||||
|
|
||||||
|
@ -117,6 +132,11 @@ Configuration variables:
|
||||||
``homeassistant.service`` Action
|
``homeassistant.service`` Action
|
||||||
********************************
|
********************************
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Be sure to :ref:`follow the instructions above <api-actions>` to tell Home Assistant to allow
|
||||||
|
your device to make service calls.
|
||||||
|
|
||||||
When using the native API with Home Assistant, you can create Home Assistant service
|
When using the native API with Home Assistant, you can create Home Assistant service
|
||||||
calls straight from ESPHome :ref:`Automations <automation>`.
|
calls straight from ESPHome :ref:`Automations <automation>`.
|
||||||
|
|
||||||
|
@ -189,6 +209,11 @@ Then, in ESPHome:
|
||||||
``homeassistant.tag_scanned`` Action
|
``homeassistant.tag_scanned`` Action
|
||||||
************************************
|
************************************
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Be sure to :ref:`follow the instructions above <api-actions>` to tell Home Assistant to allow
|
||||||
|
your device to make service calls.
|
||||||
|
|
||||||
When using the native API with Home Assistant, you can push tag_scanned to Home Assistant
|
When using the native API with Home Assistant, you can push tag_scanned to Home Assistant
|
||||||
straight from ESPHome :ref:`Automations <automation>`.
|
straight from ESPHome :ref:`Automations <automation>`.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue