Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-06-27 10:44:57 +02:00
Code Issues Projects Releases Wiki Activity

web_server: Update documentation for changes in PR #6269 (#3626)

Browse Source 
* 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 <robreg@zsurob.hu>
This commit is contained in:
Daniel Baulig 2024-05-03 22:55:06 -07:00 committed by GitHub
parent bf72d1bba0
commit 5d69b7c7df
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
web-api/index.rst
View File

@ -182,7 +182,7 @@ creating a POST request at ``/light/<id>/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