From 5d69b7c7dfa31746cf020658ca06db10f75d2e4e Mon Sep 17 00:00:00 2001 From: Daniel Baulig Date: Fri, 3 May 2024 22:55:06 -0700 Subject: [PATCH] web_server: Update documentation for changes in PR #6269 (#3626) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * web_server: Update documentation for changes in PR #6269 Also fixed a small formatting bug in the color_temp documentation * Remove linebreaks --------- Co-authored-by: H. Árkosi Róbert --- web-api/index.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/web-api/index.rst b/web-api/index.rst index 026c7bda6..96e6f793a 100644 --- a/web-api/index.rst +++ b/web-api/index.rst @@ -182,7 +182,7 @@ creating a POST request at ``/light//turn_on?brightness=128&transition=2`` w - **flash**: Flash the color provided by the other properties for a duration in seconds. - **transition**: Transition to the specified color values in this duration in seconds. - **effect**: Set an effect for the light. -- ***color_temp***: Set the color temperature of the light, in mireds. +- **color_temp**: Set the color temperature of the light, in mireds. ``turn_off`` optional URL parameters: @@ -239,9 +239,10 @@ stopped midway. An example GET request for ``/cover/front_window_blinds`` might - **id**: The ID of the cover, prefixed with ``cover-``. - **state**: ``OPEN`` or ``CLOSED``. Any position other than 0.0 is considered open. -- **value**: Current cover position as a float number. +- **value**: Current cover position as a float number. If the cover component does not support cover position reporting, then this will either be 1.0 when open or 0.0 when closed. - **current_operation**: ``OPENING``, ``CLOSING`` or ``IDLE``. - **tilt**: (only if supported by this cover component) tilt angle from 0.0 to 1.0. +- **position**: (only if supported by this cover component) Current cover position as a float number. POST requests on the other hand allow performing actions on the cover, the available methods being ``open``, ``close``, ``stop``, ``toggle`` and ``set``. The following parameters