mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-12-25 17:17:54 +01:00
Merge branch 'current' into next
This commit is contained in:
commit
3130234dc6
@ -26,9 +26,10 @@ Configuration variables:
|
|||||||
|
|
||||||
- **codes** (*Optional*, list of string): A list of codes for disarming the alarm, if *requires_code_to_arm* set to true then for arming the alarm too.
|
- **codes** (*Optional*, list of string): A list of codes for disarming the alarm, if *requires_code_to_arm* set to true then for arming the alarm too.
|
||||||
- **requires_code_to_arm** (*Optional*, boolean): Code required for arming the alarm, *codes* must be provided.
|
- **requires_code_to_arm** (*Optional*, boolean): Code required for arming the alarm, *codes* must be provided.
|
||||||
- **arming_time** (*Optional*, :ref:`config-time`): The exit delay before the alarm is armed.
|
- **arming_away_time** (*Optional*, :ref:`config-time`): The exit delay before the alarm is armed to away mode. Defaults to ``0s``.
|
||||||
- **pending_time** (*Optional*, :ref:`config-time`): The entry delay before the alarm is triggered.
|
- **arming_home_time** (*Optional*, :ref:`config-time`): The exit delay before the alarm is armed to home mode.
|
||||||
- **trigger_time** (*Optional*, :ref:`config-time`): The time after a triggered alarm before resetting to previous state if the sensors are cleared/off.
|
- **pending_time** (*Optional*, :ref:`config-time`): The entry delay before the alarm is triggered. Defaults to ``0s``.
|
||||||
|
- **trigger_time** (*Optional*, :ref:`config-time`): The time after a triggered alarm before resetting to previous state if the sensors are cleared/off. Defaults to ``0s``.
|
||||||
- **binary_sensors** (*Optional*, *list*): A list of binary sensors the panel should use. Each consists of:
|
- **binary_sensors** (*Optional*, *list*): A list of binary sensors the panel should use. Each consists of:
|
||||||
|
|
||||||
- **input** (**Required**, string): The id of the binary sensor component
|
- **input** (**Required**, string): The id of the binary sensor component
|
||||||
|
@ -672,7 +672,9 @@ Configuration variables:
|
|||||||
- **file** (**Required**, string):
|
- **file** (**Required**, string):
|
||||||
|
|
||||||
- **Local files**: The path (relative to where the .yaml file is) of the image file.
|
- **Local files**: The path (relative to where the .yaml file is) of the image file.
|
||||||
- **Material Design Icons**: Specify the `Material Design Icon <https://pictogrammers.com/library/mdi/>`_ id in the format ``mdi:icon-name``, and that icon will automatically be downloaded and added to the configuration.
|
- **Material Design Icons**: Specify the `Material Design Icon <https://pictogrammers.com/library/mdi/>`_
|
||||||
|
id in the format ``mdi:icon-name``, and that icon will automatically be downloaded and added to the configuration.
|
||||||
|
|
||||||
- **id** (**Required**, :ref:`config-id`): The ID with which you will be able to reference the image later
|
- **id** (**Required**, :ref:`config-id`): The ID with which you will be able to reference the image later
|
||||||
in your display code.
|
in your display code.
|
||||||
- **resize** (*Optional*, string): If set, this will resize the image to fit inside the given dimensions ``WIDTHxHEIGHT``
|
- **resize** (*Optional*, string): If set, this will resize the image to fit inside the given dimensions ``WIDTHxHEIGHT``
|
||||||
|
@ -47,12 +47,13 @@ Configuration variables:
|
|||||||
Defaults to ``false``
|
Defaults to ``false``
|
||||||
- **brightness_global** (*Optional*): Set the value of the current to be sink by all pins configured as led driver.
|
- **brightness_global** (*Optional*): Set the value of the current to be sink by all pins configured as led driver.
|
||||||
Defaults to ``0``
|
Defaults to ``0``
|
||||||
- **brightness_mode** (*Optional*): Define if the current to be sink will be confgured globaly or per pin configured as led driver.
|
- **brightness_mode** (*Optional*): Define if the current to be sink will be confgured globaly or per pin configured as led driver.
|
||||||
Defaults to ``global``
|
Defaults to ``global``
|
||||||
|
|
||||||
|
|
||||||
Binary Sensor
|
Binary Sensor Example
|
||||||
-------------
|
---------------------
|
||||||
|
|
||||||
``max6956`` pins can be use as binary sensor. Individual pullup are supported.
|
``max6956`` pins can be use as binary sensor. Individual pullup are supported.
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
@ -83,8 +84,9 @@ Binary Sensor
|
|||||||
inverted: False
|
inverted: False
|
||||||
|
|
||||||
|
|
||||||
Switch
|
Switch Example
|
||||||
-------------
|
--------------
|
||||||
|
|
||||||
``max6956`` pins can be use as switch.
|
``max6956`` pins can be use as switch.
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
@ -113,8 +115,9 @@ Switch
|
|||||||
inverted: False
|
inverted: False
|
||||||
|
|
||||||
|
|
||||||
Led driver
|
Led driver Example
|
||||||
-------------
|
------------------
|
||||||
|
|
||||||
``max6956`` can control a constant-current sink to drive leds, with 16 equal steps from 1.5mA to 24mA.
|
``max6956`` can control a constant-current sink to drive leds, with 16 equal steps from 1.5mA to 24mA.
|
||||||
|
|
||||||
|
|
||||||
|
@ -57,6 +57,7 @@ Configuration variables:
|
|||||||
checks the sensor. Possible values are ``27.5ms``, ``55ms``, ``110ms``, and
|
checks the sensor. Possible values are ``27.5ms``, ``55ms``, ``110ms``, and
|
||||||
``220ms``. Defaults to ``27.5ms``.
|
``220ms``. Defaults to ``27.5ms``.
|
||||||
- **alert** (*Optional*): Configure the alert pin behaviour.
|
- **alert** (*Optional*): Configure the alert pin behaviour.
|
||||||
|
|
||||||
- **function** (*Optional*, enum): Function of the alert pin, either ``comparator`` or ``interrupt``. Defaults to ``comparator``.
|
- **function** (*Optional*, enum): Function of the alert pin, either ``comparator`` or ``interrupt``. Defaults to ``comparator``.
|
||||||
- **polarity** (*Optional*, enum): Polarity of the alert pin, either ``active_high`` or ``active_low``. Defaults to ``active_high``.
|
- **polarity** (*Optional*, enum): Polarity of the alert pin, either ``active_high`` or ``active_low``. Defaults to ``active_high``.
|
||||||
- **limit_low** (*Optional*, int): Lower temperature limit, in °C. Defaults to ``-128`` (the lowest possible limit value).
|
- **limit_low** (*Optional*, int): Lower temperature limit, in °C. Defaults to ``-128`` (the lowest possible limit value).
|
||||||
|
@ -51,8 +51,8 @@ This action will start playing raw audio data from the speaker.
|
|||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
|
||||||
**id** (*Optional*, :ref:`config-id`): The speaker to control. Defaults to the only one in YAML.
|
- **id** (*Optional*, :ref:`config-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): The raw audio data to play.
|
||||||
|
|
||||||
.. _speaker-stop:
|
.. _speaker-stop:
|
||||||
|
|
||||||
@ -71,7 +71,7 @@ your configuration YAML.
|
|||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
|
||||||
**id** (*Optional*, :ref:`config-id`): The speaker to check. Defaults to the only one in YAML.
|
- **id** (*Optional*, :ref:`config-id`): The speaker to check. Defaults to the only one in YAML.
|
||||||
|
|
||||||
.. _speaker-is_playing:
|
.. _speaker-is_playing:
|
||||||
|
|
||||||
|
@ -83,6 +83,8 @@ PLATFORMS_TITLES = {
|
|||||||
"I²C": "i2c",
|
"I²C": "i2c",
|
||||||
"Media Player": "media_player",
|
"Media Player": "media_player",
|
||||||
"Microphone": "microphone",
|
"Microphone": "microphone",
|
||||||
|
"Speaker": "speaker",
|
||||||
|
"Alarm Control Panel": "alarm_control_panel",
|
||||||
}
|
}
|
||||||
|
|
||||||
CUSTOM_DOCS = {
|
CUSTOM_DOCS = {
|
||||||
@ -196,6 +198,9 @@ CUSTOM_DOCS = {
|
|||||||
"components/display_menu/lcd_menu": {
|
"components/display_menu/lcd_menu": {
|
||||||
"LCD Menu": "lcd_menu.schemas.CONFIG_SCHEMA",
|
"LCD Menu": "lcd_menu.schemas.CONFIG_SCHEMA",
|
||||||
},
|
},
|
||||||
|
"components/alarm_control_panel/index": {
|
||||||
|
"Base Alarm Control Panel Configuration": "template.alarm_control_panel.schemas.CONFIG_SCHEMA",
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
REQUIRED_OPTIONAL_TYPE_REGEX = r"(\(((\*\*Required\*\*)|(\*Optional\*))(,\s(.*))*)\):\s"
|
REQUIRED_OPTIONAL_TYPE_REGEX = r"(\(((\*\*Required\*\*)|(\*Optional\*))(,\s(.*))*)\):\s"
|
||||||
@ -623,6 +628,10 @@ class SchemaGeneratorVisitor(nodes.NodeVisitor):
|
|||||||
): # props are right for typed components so far
|
): # props are right for typed components so far
|
||||||
c = self.json_component
|
c = self.json_component
|
||||||
if c:
|
if c:
|
||||||
|
if self.component in c:
|
||||||
|
c = c[self.component]["schemas"][
|
||||||
|
self.component.upper() + "_SCHEMA"
|
||||||
|
]
|
||||||
trigger_schema = self.find_props(c).get(key)
|
trigger_schema = self.find_props(c).get(key)
|
||||||
if trigger_schema is not None:
|
if trigger_schema is not None:
|
||||||
self.props = self.find_props(trigger_schema)
|
self.props = self.find_props(trigger_schema)
|
||||||
|
Loading…
Reference in New Issue
Block a user