add has_built_in_endstop docs (#302)

* add has_built_in_endstop docs

* Added info about commands behavior with built in end stop
This commit is contained in:
Guillermo Ruffino 2019-08-31 14:53:15 -03:00 committed by Otto Winter
parent 1e4660f023
commit a4a4495844
1 changed files with 13 additions and 2 deletions

View File

@ -46,11 +46,22 @@ Configuration variables:
- **close_duration** (**Required**, :ref:`config-time`): The amount of time it takes the cover
to close from the fully-open state.
- **stop_action** (**Required**, :ref:`Action <config-action>`): The action that should
be performed when the remote requests the cover to be closed or the cover has been opening/closing
for the given durations.
be performed to stop the cover when the remote requests the cover to be stopped or
when the cover has been opening/closing for the given durations.
- **has_built_in_endstop** (*Optional*, boolean): Indicates that the cover has built in end stop
detectors. In this configuration the ``stop_action`` is not perfomed when the open or close
time is completed and if the cover is commanded to open or close the corresponding actions
will be performed without checking current state. Defaults to ``False``.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Cover <config-cover>`.
.. note::
The stop button on the UI is always enabled even when the cover is stopped and each press
on the button will cause the ``stop_action`` to be performed.
See Also
--------