jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix/Adjust WLED documentation (#34204)

Browse Source
This commit is contained in:
Franck Nijhof 2024-08-08 14:11:43 +02:00 committed by GitHub
parent 352a4c66fb
commit 0ed5a9ba89
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 40 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
source/_integrations/wled.markdown
View File

@ -27,11 +27,19 @@ ha_integration_type: device
---
[WLED](https://kno.wled.ge) is a fast and feature-rich
implementation of an ESP8266/ESP32 webserver to control
NeoPixel (WS2812B, WS2811, SK6812, APA102, and similar) LED's.
implementation of an ESP8266/ESP32 webserver to control NeoPixel LEDs
(like WS2812B, WS2811, SK6812, and similar) and SPI based chipsets
(like WS2801 and APA102).
While Home Assistant supports WLED 0.8.4 and higher, the use of WLED 0.10 and
newer is recommended to get the optimal experience.
## Prerequisites
{% important %}
This integration requires a WLED device running WLED 0.14.0 or newer.
{% endimportant %}
You can install the latest version of WLED on your device by going to
the [WLED web installer](https://install.wled.me/) or by downloading the
latest release from the [WLED GitHub releases page](https://github.com/Aircoookie/WLED/releases).
{% include integrations/config_flow.md %}
@ -46,10 +54,8 @@ Only native supported features of a light in Home Assistant are supported
### Using WLED segments
WLED can split a single LED strip into multiple segments.
These segments can be controlled separately in WLED and in Home Assistant as
well. The fully-featured segment control has been introduced in WLED 0.10
but has been partly around via APIs since WLED 0.8.6.
WLED can split a single LED strip into multiple segments. These segments can be
controlled separately in WLED and in Home Assistant as well.
If WLED has 1 segment defined (the default), that one segment controls the whole
LED strip. Home Assistant creates a single light {% term entity %} to control the
@ -63,7 +69,8 @@ Additionally, select and number entities described below will be created for eac
## Select entities
This {% term integration %} provides selects for the following information from WLED:
This {% term integration %} provides [select entities](/integrations/select)
for the following information from WLED:
- Playlist
- Preset
@ -71,52 +78,57 @@ This {% term integration %} provides selects for the following information from
## Number entities
This {% term integration %} provides `number` entities to control the following, segment-specific settings:
This {% term integration %} provides [number entities](/integrations/number)
to control the following, segment-specific settings:
- Intensity
- Speed
## Sensor entities
This {% term integration %} provides sensors for the following information from WLED:
This {% term integration %} provides [sensor entities](/integrations/sensor)
for the following information from WLED:
- Estimated current (in mA).
- Estimated current (in mA)
- Uptime (disabled by default)
- Free memory (in bytes, disabled by default).
- Wi-Fi Signal Strength (in %, disabled by default).
- Wi-Fi Signal Strength (RSSI in dBm, disabled by default).
- Wi-Fi Channel (disabled by default).
- Wi-Fi BSSID (disabled by default).
- IP.
- Free memory (in bytes, disabled by default)
- Wi-Fi Signal Strength (in %, disabled by default)
- Wi-Fi Signal Strength (RSSI in dBm, disabled by default)
- Wi-Fi Channel (disabled by default)
- Wi-Fi BSSID (disabled by default)
- IP Address
## Switches
The {% term integration %} will create a number of switches:
The {% term integration %} will also create a number of
[switch entities](/integrations/switch).
### Nightlight
Toggles the WLED Timer.
Can be configured on the WLED itself under settings > LED Preferences > Timed light.
Can be configured on the WLED itself under
**Settings** > **LED Preferences** > **Timed light**.
### Sync receive and sync send
Toggles the synchronization between multiple WLED devices.
Can be configured on the WLED itself under settings > Sync Interfaces > WLED Broadcast.
Can be configured on the WLED itself under
**Ssettings** > **Sync Interfaces** > **WLED Broadcast**.
[WLED Sync documentation](https://kno.wled.ge/interfaces/udp-realtime/)
## Firmware updates
The {% term integration %} has an [update entity](/integrations/update/) that provides
information on the latest available version of WLED and indicates if a
firmware update is available for installation.
The {% term integration %} has an [update entity](/integrations/update/)
that provides information on the latest available version of WLED
and indicates if a firmware update is available for installation.
The firmware update can be triggered and installed onto your WLED device
directly from Home Assistant.
The update {% term entity %} will only provide updates to stable versions, unless you are
using a beta version of WLED. In that case, the update {% term entity %} will also provide
updates to newer beta versions.
The update {% term entity %} will only provide updates to stable versions,
unless you are using a beta version of WLED. In that case, the update
{% term entity %} will also provide updates to newer beta versions.
{% include integrations/option_flow.md %}
@ -182,7 +194,7 @@ to a preset called My Preset:
An automation to turn on a WLED light and select a specific palette and
set intensity, and speed can be created by first calling the `light.turn_on`
service, then calling the `select.select_option` action to select the
action, then calling the `select.select_option` action to select the
palette, then call the `number.set_value` action to set the intensity
and again to set the speed.