format clean up 2022-05 (#2091)

This commit is contained in:
Guillermo Ruffino 2022-06-06 20:31:19 -03:00 committed by GitHub
parent 00419a4e47
commit 3ab83fc736
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 39 additions and 39 deletions

View File

@ -184,7 +184,7 @@ step size (default: 1).
Configuration variables:
- **id** (**Required**, :ref:`config-id`): The ID of the number component to update.
- **cycle** (**Optional**, boolean): Whether or not to set the number to its minimum
- **cycle** (*Optional*, boolean): Whether or not to set the number to its minimum
value when the increment pushes the value beyond its maximum value. This will only
work when the number component uses a minimum and maximum value.
Defaults to ``true``.
@ -209,7 +209,7 @@ step size (default: 1).
Configuration variables:
- **id** (**Required**, :ref:`config-id`): The ID of the number component to update.
- **cycle** (**Optional**, boolean): Whether or not to set the number to its maximum
- **cycle** (*Optional*, boolean): Whether or not to set the number to its maximum
value when the decrement pushes the value below its minimum value. This will only
work when the number component uses a minimum and maximum value.
Defaults to ``true``.
@ -286,7 +286,7 @@ Configuration variables:
lambda for this field, then return one of the following enum values:
``NUMBER_OP_TO_MIN``, ``NUMBER_OP_TO_MAX``, ``NUMBER_OP_DECREMENT`` or
``NUMBER_OP_INCREMENT``.
- **cycle** (**Optional**, bool, :ref:`templatable <config-templatable>`):
- **cycle** (*Optional*, bool, :ref:`templatable <config-templatable>`):
Can be used with ``DECREMENT`` or ``INCREMENT`` to specify whether or not to
wrap around the value when respectively the minimum or maximum value of the
number is exceeded.

View File

@ -143,7 +143,7 @@ This is an :ref:`Action <config-action>` for selecting the next option in a sele
Configuration variables:
- **id** (**Required**, :ref:`config-id`): The ID of the select to set.
- **cycle** (**Optional**, boolean): Whether or not to jump back to the first option
- **cycle** (*Optional*, boolean): Whether or not to jump back to the first option
of the select when the last option is currently selected. Defaults to ``true``.
.. _select-previous_action:
@ -166,7 +166,7 @@ a select component.
Configuration variables:
- **id** (**Required**, :ref:`config-id`): The ID of the select to set.
- **cycle** (**Optional**, boolean): Whether or not to jump to the last option
- **cycle** (*Optional*, boolean): Whether or not to jump to the last option
of the select when the first option is currently selected. Defaults to ``true``.
.. _select-first_action:
@ -240,7 +240,7 @@ Configuration variables:
``NEXT`` (case insensitive). When writing a lambda for this field, then return
one of the following enum values: ``SELECT_OP_FIRST``, ``SELECT_OP_LAST``,
``SELECT_OP_PREVIOUS`` or ``SELECT_OP_NEXT``.
- **cycle** (**Optional**, bool, :ref:`templatable <config-templatable>`):
- **cycle** (*Optional*, bool, :ref:`templatable <config-templatable>`):
Can be used for options ``NEXT`` and ``PREVIOUS`` to specify whether or not to
wrap around the options list when respectively the last or first option in
the select is currently active.

View File

@ -68,12 +68,12 @@ Configuration variables:
- **measurement_mode** (*Optional*): Set measurement mode for scd4x.
- **periodic** : The sensor takes a new measurement every 5 seconds. This is the default mode.
- **low_power_periodic**: The sensor takes a new measurement every 30 seconds. Make sure ``update_interval`` is at least 30 seconds.
- **single_shot**: A measurement is started in every update interval. A measurement takes 5 seconds. This mode is only available on scd41 and useful if low power consumption is required.
- ``periodic``: The sensor takes a new measurement every 5 seconds. This is the default mode.
- ``low_power_periodic``: The sensor takes a new measurement every 30 seconds. Make sure ``update_interval`` is at least 30 seconds.
- ``single_shot``: A measurement is started in every update interval. A measurement takes 5 seconds. This mode is only available on scd41 and useful if low power consumption is required.
The automatic self-calibration is optimized for single shot measurements performed every 5 minutes.
To reduce noise levels, you can can perform several single shot measurements in a row and average the output values using a :ref:`sensor-filters`.
- **single_shot_rht_only**: A measurement is started in every update interval. A measurement takes 50 ms. Only humidity and temperature is measured. CO2 is reported as 0 ppm. This mode is only available on scd41 and useful if low power consumption is required.
- ``single_shot_rht_only``: A measurement is started in every update interval. A measurement takes 50 ms. Only humidity and temperature is measured. CO2 is reported as 0 ppm. This mode is only available on scd41 and useful if low power consumption is required.
- **ambient_pressure_compensation_source** (*Optional*, :ref:`config-id`): Set an external pressure sensor ID used for ambient pressure compensation.

View File

@ -88,7 +88,7 @@ Configuration variables:
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in automation and lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **auto_cleaning_interval** (Optional): Reads/Writes the interval in seconds of the periodic fan-cleaning.
- **auto_cleaning_interval** (*Optional*): Reads/Writes the interval in seconds of the periodic fan-cleaning.
- **temperature** (*Optional*): Temperature.Note only available with Sen54 or Sen55. The sensor will be ignored on unsupported models.
@ -110,7 +110,7 @@ Configuration variables:
- **learning_time_gain_hours** (*Optional*): Time constant to estimate the VOC algorithm gain from the history in hours. Past events will be forgotten after about twice the learning time. Allowed values are in range 1..1000. The default value is 12 hours.
- **gating_max_duration_minutes** (*Optional*): Maximum duration of gating in minutes (freeze of estimator during high VOC index signal). Zero disables the gating. Allowed values are in range 0..3000. The default value is 180 minutes
- **std_initial** (*Optional*): Initial estimate for standard deviation. Lower value boosts events during initial learning period, but may result in larger device-todevice variations. Allowed values are in range 10..5000. The default value is 50.
- **gain_factor:** (*Optional*): Gain factor to amplify or to attenuate the VOC index output. Allowed values are in range 1..1000. The default value is 230.
- **gain_factor** (*Optional*): Gain factor to amplify or to attenuate the VOC index output. Allowed values are in range 1..1000. The default value is 230.
- All other options from :ref:`Sensor <config-sensor>`.
@ -126,7 +126,7 @@ Configuration variables:
- **learning_time_gain_hours** (*Optional*): Time constant to estimate the NOx algorithm gain from the history in hours. Past events will be forgotten after about twice the learning time. Allowed values are in range 1..1000. The default value is 12 hours.
- **gating_max_duration_minutes** (*Optional*): Maximum duration of gating in minutes (freeze of estimator during high NOx index signal). Zero disables the gating. Allowed values are in range 0..3000. The default value is 180 minutes
- **std_initial** (*Optional*): The initial estimate for standard deviation parameter has no impact for NOx. This parameter is still in place for consistency reasons with the VOC tuning parameters command. This parameter must always be set to 50.
- **gain_factor:** (*Optional*)
- **gain_factor** (*Optional*): Gain factor to amplify or to attenuate the VOC index output. Allowed values are in range 1..1000. The default value is 230.
- All other options from :ref:`Sensor <config-sensor>`.

View File

@ -117,7 +117,7 @@ Configuration variables:
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in automation and lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **auto_cleaning_interval** (Optional): The interval in seconds of the periodic fan-cleaning.
- **auto_cleaning_interval** (*Optional*): The interval in seconds of the periodic fan-cleaning.
- **address** (*Optional*, int): Manually specify the I²C address of the sensor.
Defaults to ``0x69``.