mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Update changes in light entity and remove priority light documentation (#24604)
This commit is contained in:
parent
0691b87d5e
commit
03255f56a7
@ -34,24 +34,32 @@ All configuration options are offered from the frontend. Choose `Options` under
|
||||
relevant entry on the `Integrations` page.
|
||||
|
||||
Options supported:
|
||||
- **Priority**: The priority for color and effects, make sure this is lower then the streaming sources priority in hyperion itself (typically lower than 200 is appropriate).
|
||||
- **Priority**: The priority for color and effects. Hyperion will choose the source
|
||||
with the lowest priority number as active input. If you have other sources (not
|
||||
originating from Home Assistant) configured, make sure this option is lower than
|
||||
those sources priority in Hyperion itself (typically lower than 200 is appropriate).
|
||||
- **Effects to hide**: An optional selection of effects to hide from the light effects
|
||||
list. New effects added to the Hyperion server will be shown by default.
|
||||
|
||||
## Hyperion Instances
|
||||
|
||||
This integration supports multiple Hyperion instances running on a single Hyperion
|
||||
server. As instances are added/removed on the Hyperion UI, they will automatically be
|
||||
added/removed from Home Assistant.
|
||||
|
||||
## Light Entity
|
||||
|
||||
The default light entity will send data to Hyperion on the priority you have configured
|
||||
during integration setup. When turned off, it will clear the configured priority again.
|
||||
Other light sources independent of Home Assistant configured in Hyperion might still be
|
||||
active and cause light to be emitted. In order to turn the light output off entirely
|
||||
regardless of active light sources, you can enable the LED device entity that acts as
|
||||
a global switch (see Advanced Entities).
|
||||
|
||||
## Effects
|
||||
|
||||
The effect list is dynamically pulled from the Hyperion server. The following
|
||||
extra effects will be available:
|
||||
|
||||
- 'Boblight Server': Use a 'Boblight Server' configured in Hyperion.
|
||||
- 'Platform Capture': Use a 'Platform Capture' grabber that is configured in Hyperion.
|
||||
- 'USB Capture': Use a 'USB Capture' device that is configured in Hyperion.
|
||||
- 'Solid': Use a solid color only.
|
||||
The effect list is dynamically pulled from the Hyperion server. Additionally, there
|
||||
will be a 'Solid' effect to switch (back) to showing a solid color only.
|
||||
|
||||
## Hyperion Camera
|
||||
|
||||
@ -70,20 +78,28 @@ advanced usecases. These entities expose 'raw' underlying Hyperion API component
|
||||
improved extensibility and interoperability which are particularly useful in cases where
|
||||
there are multiple Hyperion server clients (of which Home Assistant is one).
|
||||
|
||||
Provided advanced entities:
|
||||
|
||||
- `light.[instance]_priority`: A "priority" light that acts exclusively on a given
|
||||
Hyperion priority. Only color/effects (and not components) are available in this light.
|
||||
Turning this light off will set a black color at this given priority rather than
|
||||
turning the light off in absolute terms.
|
||||
- `switch.[instance]_component_[component]`: A switch to turn on/off the relevant
|
||||
underlying Hyperion component as shown on the Hyperion server `Remote Control` page
|
||||
under `Component Control`. This allows fine grained control over sources (e.g. `USB Capture`) and
|
||||
Hyperion functionality (e.g. `Blackbar Detection`).
|
||||
|
||||
These entities may be enabled by visiting the `Integrations` page, choosing the relevant
|
||||
entity and toggling `Enable entity`, followed by `Update`.
|
||||
|
||||
### Control over external sources: Screen capture and USB capture
|
||||
|
||||
Provided entities for controlling external sources:
|
||||
|
||||
- `switch.[instance]_component_platform_capture`: Toggles the `Screen Capture` source
|
||||
- `switch.[instance]_component_usb_capture`: Toggles the `USB Capture` source
|
||||
|
||||
### Control over Hyperion functionality
|
||||
|
||||
Further advanced entities to control Hyperion functionality:
|
||||
|
||||
- There will be additional `switch.[instance]_component_[component]` entities that can
|
||||
be used to toggle the relevant underlying Hyperion component as shown on the Hyperion
|
||||
server `Remote Control` page under `Components Control`. This allows fine grained
|
||||
control over Hyperion functionality (e.g. `Blackbar Detection`) or device
|
||||
state (`LED Device`).
|
||||
- `switch.[instance]_component_all`: refers to the entire Hyperion instance state that
|
||||
controls the toggle on the Hyperion server `Dashboard` page.
|
||||
|
||||
## Examples
|
||||
|
||||
To start Hyperion with an effect, use the following automation:
|
||||
@ -135,9 +151,27 @@ To capture the screen on a USB capture device, when playing something on a media
|
||||
entity_id: media_player.plex
|
||||
to: "playing"
|
||||
action:
|
||||
- service: light.turn_on
|
||||
- service: switch.turn_on
|
||||
target:
|
||||
entity_id: light.hyperion
|
||||
data:
|
||||
effect: "USB Capture"
|
||||
entity_id: switch.[instance]_component_usb_capture
|
||||
```
|
||||
|
||||
To toggle the LED device together with the light entity in order to turn light output on or off for all sources. In this example both entities are turned on together, create another automation with the values reversed for turning both off:
|
||||
|
||||
```yaml
|
||||
- alias: "Turn LED device on when Hyperion light is activated"
|
||||
trigger:
|
||||
- platform: state
|
||||
entity_id:
|
||||
- light.hyperion
|
||||
from: "off"
|
||||
to: "on"
|
||||
condition:
|
||||
- condition: state
|
||||
entity_id: switch.[instance]_component_led_device
|
||||
state: "off"
|
||||
action:
|
||||
- service: switch.turn_on
|
||||
target:
|
||||
entity_id: switch.[instance]_component_led_device
|
||||
```
|
||||
|
Loading…
x
Reference in New Issue
Block a user