mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Fix/Adjust WLED documentation (#34204)
This commit is contained in:
parent
352a4c66fb
commit
0ed5a9ba89
@ -27,11 +27,19 @@ ha_integration_type: device
|
|||||||
---
|
---
|
||||||
|
|
||||||
[WLED](https://kno.wled.ge) is a fast and feature-rich
|
[WLED](https://kno.wled.ge) is a fast and feature-rich
|
||||||
implementation of an ESP8266/ESP32 webserver to control
|
implementation of an ESP8266/ESP32 webserver to control NeoPixel LEDs
|
||||||
NeoPixel (WS2812B, WS2811, SK6812, APA102, and similar) LED's.
|
(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
|
## Prerequisites
|
||||||
newer is recommended to get the optimal experience.
|
|
||||||
|
{% 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 %}
|
{% include integrations/config_flow.md %}
|
||||||
|
|
||||||
@ -46,10 +54,8 @@ Only native supported features of a light in Home Assistant are supported
|
|||||||
|
|
||||||
### Using WLED segments
|
### Using WLED segments
|
||||||
|
|
||||||
WLED can split a single LED strip into multiple segments.
|
WLED can split a single LED strip into multiple segments. These segments can be
|
||||||
These segments can be controlled separately in WLED and in Home Assistant as
|
controlled separately in WLED and in Home Assistant as well.
|
||||||
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.
|
|
||||||
|
|
||||||
If WLED has 1 segment defined (the default), that one segment controls the whole
|
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
|
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
|
## 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
|
- Playlist
|
||||||
- Preset
|
- Preset
|
||||||
@ -71,52 +78,57 @@ This {% term integration %} provides selects for the following information from
|
|||||||
|
|
||||||
## Number entities
|
## 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
|
- Intensity
|
||||||
- Speed
|
- Speed
|
||||||
|
|
||||||
## Sensor entities
|
## 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)
|
- Uptime (disabled by default)
|
||||||
- Free memory (in bytes, disabled by default).
|
- Free memory (in bytes, disabled by default)
|
||||||
- Wi-Fi Signal Strength (in %, disabled by default).
|
- Wi-Fi Signal Strength (in %, disabled by default)
|
||||||
- Wi-Fi Signal Strength (RSSI in dBm, disabled by default).
|
- Wi-Fi Signal Strength (RSSI in dBm, disabled by default)
|
||||||
- Wi-Fi Channel (disabled by default).
|
- Wi-Fi Channel (disabled by default)
|
||||||
- Wi-Fi BSSID (disabled by default).
|
- Wi-Fi BSSID (disabled by default)
|
||||||
- IP.
|
- IP Address
|
||||||
|
|
||||||
## Switches
|
## Switches
|
||||||
|
|
||||||
The {% term integration %} will create a number of switches:
|
The {% term integration %} will also create a number of
|
||||||
|
[switch entities](/integrations/switch).
|
||||||
|
|
||||||
### Nightlight
|
### Nightlight
|
||||||
|
|
||||||
Toggles the WLED Timer.
|
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
|
### Sync receive and sync send
|
||||||
|
|
||||||
Toggles the synchronization between multiple WLED devices.
|
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/)
|
[WLED Sync documentation](https://kno.wled.ge/interfaces/udp-realtime/)
|
||||||
|
|
||||||
## Firmware updates
|
## Firmware updates
|
||||||
|
|
||||||
The {% term integration %} has an [update entity](/integrations/update/) that provides
|
The {% term integration %} has an [update entity](/integrations/update/)
|
||||||
information on the latest available version of WLED and indicates if a
|
that provides information on the latest available version of WLED
|
||||||
firmware update is available for installation.
|
and indicates if a firmware update is available for installation.
|
||||||
|
|
||||||
The firmware update can be triggered and installed onto your WLED device
|
The firmware update can be triggered and installed onto your WLED device
|
||||||
directly from Home Assistant.
|
directly from Home Assistant.
|
||||||
|
|
||||||
The update {% term entity %} will only provide updates to stable versions, unless you are
|
The update {% term entity %} will only provide updates to stable versions,
|
||||||
using a beta version of WLED. In that case, the update {% term entity %} will also provide
|
unless you are using a beta version of WLED. In that case, the update
|
||||||
updates to newer beta versions.
|
{% term entity %} will also provide updates to newer beta versions.
|
||||||
|
|
||||||
{% include integrations/option_flow.md %}
|
{% 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
|
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`
|
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
|
palette, then call the `number.set_value` action to set the intensity
|
||||||
and again to set the speed.
|
and again to set the speed.
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user