diff --git a/src/content/docs/components/cover/current_based.mdx b/src/content/docs/components/cover/current_based.mdx index e0d4b88ff5..d84d56d706 100644 --- a/src/content/docs/components/cover/current_based.mdx +++ b/src/content/docs/components/cover/current_based.mdx @@ -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 @@ -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 diff --git a/src/content/docs/components/cover/index.mdx b/src/content/docs/components/cover/index.mdx index e961b3cbda..3042fa18ab 100644 --- a/src/content/docs/components/cover/index.mdx +++ b/src/content/docs/components/cover/index.mdx @@ -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): diff --git a/src/content/docs/components/cover/time_based.mdx b/src/content/docs/components/cover/time_based.mdx index bf4ebf21fe..8fb5b118e4 100644 --- a/src/content/docs/components/cover/time_based.mdx +++ b/src/content/docs/components/cover/time_based.mdx @@ -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 diff --git a/src/content/docs/components/event/index.mdx b/src/content/docs/components/event/index.mdx index e8fcc61575..7bc65cf806 100644 --- a/src/content/docs/components/event/index.mdx +++ b/src/content/docs/components/event/index.mdx @@ -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. diff --git a/src/content/docs/components/light/esp32_rmt_led_strip.mdx b/src/content/docs/components/light/esp32_rmt_led_strip.mdx index 8901866d65..3597eeded0 100644 --- a/src/content/docs/components/light/esp32_rmt_led_strip.mdx +++ b/src/content/docs/components/light/esp32_rmt_led_strip.mdx @@ -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` diff --git a/src/content/docs/components/light/neopixelbus.mdx b/src/content/docs/components/light/neopixelbus.mdx index 41305066ea..978dd18a03 100644 --- a/src/content/docs/components/light/neopixelbus.mdx +++ b/src/content/docs/components/light/neopixelbus.mdx @@ -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). diff --git a/src/content/docs/components/light/rp2040_pio_led_strip.mdx b/src/content/docs/components/light/rp2040_pio_led_strip.mdx index 10a32925b8..d765be1178 100644 --- a/src/content/docs/components/light/rp2040_pio_led_strip.mdx +++ b/src/content/docs/components/light/rp2040_pio_led_strip.mdx @@ -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` diff --git a/src/content/docs/components/media_player/speaker.mdx b/src/content/docs/components/media_player/speaker.mdx index 721c9ea85b..1e20fe4f0f 100644 --- a/src/content/docs/components/media_player/speaker.mdx +++ b/src/content/docs/components/media_player/speaker.mdx @@ -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`. diff --git a/src/content/docs/components/speaker/index.mdx b/src/content/docs/components/speaker/index.mdx index 960df08e83..d2a0816b69 100644 --- a/src/content/docs/components/speaker/index.mdx +++ b/src/content/docs/components/speaker/index.mdx @@ -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. diff --git a/src/content/docs/components/speaker/mixer.mdx b/src/content/docs/components/speaker/mixer.mdx index 1442d3b7a4..d0c2e98bfc 100644 --- a/src/content/docs/components/speaker/mixer.mdx +++ b/src/content/docs/components/speaker/mixer.mdx @@ -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 diff --git a/src/content/docs/components/update/index.mdx b/src/content/docs/components/update/index.mdx index 4ebf5594e0..6a94d74671 100644 --- a/src/content/docs/components/update/index.mdx +++ b/src/content/docs/components/update/index.mdx @@ -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 diff --git a/src/content/docs/components/valve/index.mdx b/src/content/docs/components/valve/index.mdx index dd8460e9cd..defc9d1a51 100644 --- a/src/content/docs/components/valve/index.mdx +++ b/src/content/docs/components/valve/index.mdx @@ -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`