Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/content/docs/components/cover/current_based.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,11 @@ cover:
- **open_moving_current_threshold** (**Required**, float): The amount of current in Amps the motor
should drain to consider the cover is opening.

- **open_obstacle_current_threshold** (**Required**, float): The amount of current in Amps the motor
- **open_obstacle_current_threshold** (*Optional*, float): The amount of current in Amps the motor
should drain to consider the cover is blocked during opening.

- **close_sensor** (**Required**, [ID](/guides/configuration-types#id)): The close current sensor.
- **close_action** (*Optional*, [Action](/automations/actions#all-actions)): The action that should
- **close_action** (**Required**, [Action](/automations/actions#all-actions)): The action that should
be performed when the remote requests the cover to be closed.

- **close_duration** (**Required**, [Time](/guides/configuration-types#time)): The amount of time it takes the cover
Expand All @@ -82,7 +82,7 @@ cover:
- **close_moving_current_threshold** (**Required**, float): The amount of current in Amps the motor
should drain to consider the cover is closing.

- **close_obstacle_current_threshold** (**Required**, float): The amount of current in Amps the motor
- **close_obstacle_current_threshold** (*Optional*, float): The amount of current in Amps the motor
should drain to consider the cover is blocked during closing.

- **stop_action** (**Required**, [Action](/automations/actions#all-actions)): The action that should
Expand Down
8 changes: 4 additions & 4 deletions src/content/docs/components/cover/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -181,14 +181,14 @@ on_...:
Configuration variables:

- **id** (**Required**, [ID](/guides/configuration-types#id)): The cover to control.
- **stop** (*Optional*, boolean): Whether to stop the cover.
- **state** (*Optional*, string): The state to set the cover to - one of `OPEN` or `CLOSE`.
- **position** (*Optional*, float): The cover position to set.
- **stop** (*Optional*, boolean, [templatable](/automations/templates)): Whether to stop the cover.
- **state** (*Optional*, string, [templatable](/automations/templates)): The state to set the cover to - one of `OPEN` or `CLOSE`.
- **position** (*Optional*, float, [templatable](/automations/templates)): The cover position to set.

- `0.0` = `0%` = `CLOSED`
- `1.0` = `100%` = `OPEN`

- **tilt** (*Optional*, float): The tilt position to set. In range 0% - 100%.
- **tilt** (*Optional*, float, [templatable](/automations/templates)): The tilt position to set. In range 0% - 100%.

> [!NOTE]
> This action can also be expressed in [lambdas](/automations/templates#config-lambda):
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/components/cover/time_based.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ cover:
- **open_duration** (**Required**, [Time](/guides/configuration-types#time)): The amount of time it takes the cover
to open up from the fully-closed state.

- **close_action** (*Optional*, [Action](/automations/actions#all-actions)): The action that should
- **close_action** (**Required**, [Action](/automations/actions#all-actions)): The action that should
be performed when the remote requests the cover to be closed.

- **close_duration** (**Required**, [Time](/guides/configuration-types#time)): The amount of time it takes the cover
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/components/event/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ This action allows for the triggering of an event from within an automation.
Configuration variables:

- **id** (**Required**, [ID](/guides/configuration-types#id)): The ID of the event.
- **event_type** (**Required**, string): The type of event to trigger.
- **event_type** (**Required**, string, [templatable](/automations/templates)): The type of event to trigger.

<span id="event-lambda_calls"></span>

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/components/light/esp32_rmt_led_strip.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ light:

- **pin** (**Required**, [Pin Schema](/guides/configuration-types#pin-schema)): The pin for the data line of the light.
- **num_leds** (**Required**, int): The number of LEDs in the strip.
- **chipset** (**Required**, enum): The name of the chipset used; determines signal timing. Not required if
- **chipset** (*Optional*, enum): The name of the chipset used; determines signal timing. Not required if
[specifying the timings manually](#esp32-rmt-led-strip-manual_timings).

- `WS2811`
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/components/light/neopixelbus.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ light:
Some chipsets have two data pins to connect, others only have one.
If you have one line, only specify `pin`, otherwise specify both `clock_pin` and `data_pin`.

- **pin** (**Required**, [Pin](/guides/configuration-types#pin)): The pin for the data line of the light.
- **clock_pin** (**Required**, [Pin](/guides/configuration-types#pin)): The pin for the clock line of the light, for two-wire lights.
- **data_pin** (**Required**, [Pin](/guides/configuration-types#pin)): The pin for the data line of the light, for two-wire lights.
- **pin** (*Optional*, [Pin](/guides/configuration-types#pin)): The pin for the data line of the light.
- **clock_pin** (*Optional*, [Pin](/guides/configuration-types#pin)): The pin for the clock line of the light, for two-wire lights.
- **data_pin** (*Optional*, [Pin](/guides/configuration-types#pin)): The pin for the data line of the light, for two-wire lights.

- All other options from [Light](/components/light#config-light).

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/components/light/rp2040_pio_led_strip.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ light:
- **num_leds** (**Required**, int): The number of LEDs in the strip.
- **pio** (**Required**, int): The PIO peripheral to use. If using multiple strips, you can use up to 4 strips per PIO. Must be one of `0` or `1`.

- **chipset** (**Required**, enum): The chipset to apply known timings from.
- **chipset** (*Optional*, enum): The chipset to apply known timings from.
- `WS2812`
- `WS2812B`
- `SK6812`
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/components/media_player/speaker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,8 @@ on_...:
Configuration variables:

- **media_file** (**Required**, [ID](/guides/configuration-types#id)): The ID of the media file.
- **announcement** (*Optional*, boolean): Whether to play back the file as an announcement or media stream. Defaults to `false`.
- **enqueue** (*Optional*, boolean): Whether to add the media file to the end of the pipeline's internal playlist. Defaults to `false`.
- **announcement** (*Optional*, boolean, [templatable](/automations/templates)): Whether to play back the file as an announcement or media stream. Defaults to `false`.
- **enqueue** (*Optional*, boolean, [templatable](/automations/templates)): Whether to add the media file to the end of the pipeline's internal playlist. Defaults to `false`.

<span id="media_player-speaker-performance"></span>

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/components/speaker/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ on_...:
Configuration variables:

- **id** (*Optional*, [ID](/guides/configuration-types#id)): The speaker to control. Defaults to the only one in YAML.
- **data** (**Required**, list of bytes): The raw audio data to play.
- **data** (**Required**, list of bytes, [templatable](/automations/templates)): The raw audio data to play.

<span id="speaker-stop"></span>

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/components/speaker/mixer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ on_...:

Configuration variables:

- **decibel_reduction** (**Required**, int, templatable): The reduction of the media stream in decibels. Must be between 0 and 50.
- **duration** (*Optional*, [Time](/guides/configuration-types#time), templatable): The length of time to transition between the current reduction level and the new reduction level. Defaults to `0s`.
- **decibel_reduction** (**Required**, int, [templatable](/automations/templates)): The reduction of the media stream in decibels. Must be between 0 and 50.
- **duration** (*Optional*, [Time](/guides/configuration-types#time), [templatable](/automations/templates)): The length of time to transition between the current reduction level and the new reduction level. Defaults to `0s`.

## See Also

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/components/update/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ This action allows you to trigger the update entity to start the update process.
Configuration variables:

- **id** (**Required**, [ID](/guides/configuration-types#id)): The ID of the update entity.
- **force_update** (*Optional*, boolean): Perform the update even if the device is already running the same version.
- **force_update** (*Optional*, boolean, [templatable](/automations/templates)): Perform the update even if the device is already running the same version.
Defaults to `false`.

### `update.check` Action
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/components/valve/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -166,9 +166,9 @@ on_...:
Configuration variables:

- **id** (**Required**, [ID](/guides/configuration-types#id)): The valve to control.
- **stop** (*Optional*, boolean): Whether to stop the valve.
- **state** (*Optional*, string): The state to set the valve to - one of `OPEN` or `CLOSE`.
- **position** (*Optional*, float): The valve position to set.
- **stop** (*Optional*, boolean, [templatable](/automations/templates)): Whether to stop the valve.
- **state** (*Optional*, string, [templatable](/automations/templates)): The state to set the valve to - one of `OPEN` or `CLOSE`.
- **position** (*Optional*, float, [templatable](/automations/templates)): The valve position to set.

- `0.0` = `0%` = `CLOSED`
- `1.0` = `100%` = `OPEN`
Expand Down