Skip to content

Commit b7b8298

Browse files
authored
[api] Add homeassistant_services configuration option (#5178)
1 parent fdea232 commit b7b8298

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

components/api.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ Configuration variables:
9898
WiFi performance with many rapidly-changing sensors. Only use this setting when necessary.
9999

100100
- **custom_services** (*Optional*, boolean): Enable compilation of custom API services for external components that use the C++ ``CustomAPIDevice`` class. Only needed when external components register their own services via the native API. Defaults to ``false``.
101+
- **homeassistant_services** (*Optional*, boolean): Enable compilation of Home Assistant service call support for external components that use the C++ ``CustomAPIDevice::call_homeassistant_service()`` or ``CustomAPIDevice::fire_homeassistant_event()`` methods. This is automatically enabled when using ``homeassistant.service`` or ``homeassistant.event`` actions, or the ``homeassistant`` platform for number or switch components. Only needs to be manually set when external components call Home Assistant services without using the built-in actions. Defaults to ``false``.
101102
- **homeassistant_states** (*Optional*, boolean): Enable compilation of Home Assistant state subscription support for external components that use the C++ ``CustomAPIDevice::subscribe_homeassistant_state()`` method. This is automatically enabled when using any ``homeassistant`` platform components (sensor, binary_sensor, text_sensor, switch, or number). Only needs to be manually set when external components subscribe to Home Assistant states without using the built-in components. Defaults to ``false``.
102103
- **reboot_timeout** (*Optional*, :ref:`config-time`): The amount of time to wait before rebooting when no
103104
client connects to the API. This is needed because sometimes the low level ESP functions report that

0 commit comments

Comments
 (0)