Fix format consistency (#989)

This commit is contained in:
Guillermo Ruffino 2021-02-07 13:35:39 -03:00 committed by GitHub
parent 5bfeb3e7fc
commit 9420c45a01
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 44 additions and 44 deletions

View File

@ -57,9 +57,9 @@ Base Configuration:
Binary Sensor Configuration:
- **name** (**Optional**, string): The name for the binary sensor.
- **name** (*Optional*, string): The name for the binary sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **channel** (*Required*, integer): The channel number at the MPR121 the touchkey is connected to.
- **channel** (**Required**, integer): The channel number at the MPR121 the touchkey is connected to.
- **touch_threshold** (*Optional*, integer): A per-channel override of the global touch_threshold value. If not specified, uses the global value.
- **release_threshold** (*Optional*, integer): A per-channel override of the global release_threshold value. If not specified, uses the global value.
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.

View File

@ -132,7 +132,7 @@ There are several forms to use it:
Configuration variables:
- **data** (*Required*, binary data): Data to transmit, up to 8 bytes or
- **data** (**Required**, binary data): Data to transmit, up to 8 bytes or
characters are supported by can bus per frame.
- **canbus_id** (*Optional*): Optionally set the can bus id to use for transmitting
the frame. Not needed if you are using only 1 can bus.

View File

@ -48,11 +48,11 @@ Configuration variables:
- **switch_datapoint** (**Required**, int): The datapoint id number of the climate switch.
- **target_temperature_datapoint** (**Required**, int): The datapoint id number of the target temperature.
- **current_temperature_datapoint** (**Required**, int): The datapoint id number of the current temperature.
- **temperature_multiplier** (**Optional**, float): A multiplier to modify the incoming and outgoing temperature values - :ref:`see below <temperature-multiplier>`.
- **temperature_multiplier** (*Optional*, float): A multiplier to modify the incoming and outgoing temperature values - :ref:`see below <temperature-multiplier>`.
If the device has different multipliers for current and target temperatures, **temperature_multiplier** can be replaced with both of:
- **current_temperature_multiplier** (**Optional**, float): A multiplier to modify the current temperature value.
- **target_temperature_multiplier** (**Optional**, float): A multiplier to modify the target temperature value.
- **current_temperature_multiplier** (*Optional*, float): A multiplier to modify the current temperature value.
- **target_temperature_multiplier** (*Optional*, float): A multiplier to modify the target temperature value.
- All other options from :ref:`Climate <config-climate>`.
.. _temperature-multiplier:

View File

@ -48,9 +48,9 @@ Configuration variables:
- **manual_ip** (*Optional*): Manually configure the static IP of the node.
- **static_ip** (*Required*, IPv4 address): The static IP of your node.
- **gateway** (*Required*, IPv4 address): The gateway of the local network.
- **subnet** (*Required*, IPv4 address): The subnet of the local network.
- **static_ip** (**Required**, IPv4 address): The static IP of your node.
- **gateway** (**Required**, IPv4 address): The gateway of the local network.
- **subnet** (**Required**, IPv4 address): The subnet of the local network.
- **dns1** (*Optional*, IPv4 address): The main DNS server to use.
- **dns2** (*Optional*, IPv4 address): The backup DNS server to use.

View File

@ -32,11 +32,11 @@ Configuration variables:
:ref:`output <output>` to use for the direction state of the fan. Default is empty.
- **speed** (*Optional*): Set the float values for each speed setting:
- **low** (*Required*, float): Set the value for the low speed
- **low** (**Required**, float): Set the value for the low speed
setting. Must be in range 0 to 1. Defaults to 0.33.
- **medium** (*Required*, float): Set the value for the medium speed
- **medium** (**Required**, float): Set the value for the medium speed
setting. Must be in range 0 to 1. Defaults to 0.66.
- **high** (*Required*, float): Set the value for the high speed
- **high** (**Required**, float): Set the value for the high speed
setting. Must be in range 0 to 1. Defaults to 1.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.

View File

@ -53,7 +53,7 @@ Configuration variables:
- **name** (**Required**, string): The name of the fan.
- **speed_datapoint** (**Required**, int): The datapoint id number of the fan speed.
- **switch_datapoint** (**Required**, int): The datapoint id number of the fan switch.
- **oscillation_datapoint** (**Optional**, int): The datapoint id number of the oscillation
- **oscillation_datapoint** (*Optional*, int): The datapoint id number of the oscillation
switch. Probably not supported on any Tuya controllers currently, but it's there if need be.
- All other options from :ref:`Fan <config-fan>`.

View File

@ -841,7 +841,7 @@ JINX_ can be used to control E1.31_ enabled ESPHome.
Configuration variables:
- **method** (*Optional*): Listening method, one of ``multicast`` or ``unicast``. Defaults to ``multicast``.
- **universe** (*Required*, integer): The value of universe, between 1 to 512.
- **universe** (**Required**, integer): The value of universe, between 1 to 512.
- **channels** (*Optional*): The type of data. This is used to specify if it is a ``MONO``,
``RGB`` or ``RGBW`` light and in which order the colors are. Defaults to ``RGB``.

View File

@ -57,7 +57,7 @@ Configuration variables:
~~~~~~~~~~~~~~~~~~~~~~~~
- **id** (**Required**, :ref:`config-id`): The id to use for this MCP23S08 component.
- **cs_pin** (*Required*, int): The SPI chip select pin to use
- **cs_pin** (**Required**, int): The SPI chip select pin to use
- **deviceaddress** (*Optional*, int): The address of the chip.
Defaults to ``0``.
@ -112,7 +112,7 @@ Configuration variables:
~~~~~~~~~~~~~~~~~~~~~~~~
- **id** (**Required**, :ref:`config-id`): The id to use for this MCP23S17 component.
- **cs_pin** (*Required*, int): The SPI chip select pin to use.
- **cs_pin** (**Required**, int): The SPI chip select pin to use.
- **deviceaddress** (*Optional*, int): The address of the chip.
Defaults to ``0``.

View File

@ -440,9 +440,9 @@ Publish an MQTT message on a topic using this action in automations.
Configuration options:
- **topic** (*Required*, string, :ref:`templatable <config-templatable>`):
- **topic** (**Required**, string, :ref:`templatable <config-templatable>`):
The MQTT topic to publish the message.
- **payload** (*Required*, string, :ref:`templatable <config-templatable>`): The message content.
- **payload** (**Required**, string, :ref:`templatable <config-templatable>`): The message content.
- **qos** (*Optional*, int, :ref:`templatable <config-templatable>`): The `Quality of
Service <https://www.hivemq.com/blog/mqtt-essentials-part-6-mqtt-quality-of-service-levels>`__
level of the topic. Defaults to 0.
@ -491,9 +491,9 @@ as seen below.
Configuration options:
- **topic** (*Required*, string, :ref:`templatable <config-templatable>`):
- **topic** (**Required**, string, :ref:`templatable <config-templatable>`):
The MQTT topic to publish the message.
- **payload** (*Required*, :ref:`lambda <config-lambda>`): The message content.
- **payload** (**Required**, :ref:`lambda <config-lambda>`): The message content.
- **qos** (*Optional*, int): The `Quality of
Service <https://www.hivemq.com/blog/mqtt-essentials-part-6-mqtt-quality-of-service-levels>`__
level of the topic. Defaults to 0.

View File

@ -38,7 +38,7 @@ Configuration variables:
- **id** (**Required**, :ref:`config-id`): The id to use for this output component.
- **type** (**Required**, string): The type of output. One of ``binary`` and ``float``.
- **on_write_action** (*Required*, :ref:`Action <config-action>`): The action that should
- **on_write_action** (**Required**, :ref:`Action <config-action>`): The action that should
be performed when the state of the output is updated.
- All other options from :ref:`Output <config-output>`.

View File

@ -244,7 +244,7 @@ This :ref:`action <config-action>` sends a Pioneer infrared remote code to a rem
Configuration variables:
- **rc_code_1** (**Required**, int): The remote control code to send, see dumper output for more details.
- **rc_code_2** (**Optional**, int): The secondary remote control code to send; some codes are sent in
- **rc_code_2** (*Optional*, int): The secondary remote control code to send; some codes are sent in
two parts.
- Note that ``repeat`` is still optional, however **Pioneer devices may require that a given code is
received multiple times before they will act on it.** Add this if your device does not respond to

View File

@ -161,7 +161,7 @@ Use this if you want to use your AS3935 in SPI mode.
- platform: as3935
name: "Storm Alert"
- **cs_pin** (*Required*, :ref:`Pin Schema <config-pin_schema>`): The chip select pin.
- **cs_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The chip select pin.
See Also
--------

View File

@ -53,9 +53,9 @@ up to 8x8 matrix (i.e. 64 keys).
- **keypad** (*Optional*): Add this to enable the keypad.
- **key_row** (*Required*, int): The number of keypad rows to use. This enables any number of the first 7 pins.
- **key_row** (**Required**, int): The number of keypad rows to use. This enables any number of the first 7 pins.
So a value of 3 enables pins 0,1,2 to be used as the rows for the keypad matrix. This value must be between 1 and 8.
- **key_columns** (*Required*, int): The number of keypad columns to use. This enables any number of the last 7 pins.
- **key_columns** (**Required**, int): The number of keypad columns to use. This enables any number of the last 7 pins.
So a value of 4 enables pins 8,9,10,11 to be used as the columns for the keypad matrix. This value must be between 1 and 8.
- **sleep_time** (*Optional*, int): No key press within this time will set keypad engine to sleep.
- **scan_time** (*Optional*, int): Scan time per row (must be set above debounce time).

View File

@ -38,9 +38,9 @@ Configuration variables:
that is reachable will be connected to. See :ref:`wifi-networks`.
- **manual_ip** (*Optional*): Manually configure the static IP of the node.
- **static_ip** (*Required*, IPv4 address): The static IP of your node.
- **gateway** (*Required*, IPv4 address): The gateway of the local network.
- **subnet** (*Required*, IPv4 address): The subnet of the local network.
- **static_ip** (**Required***, IPv4 address): The static IP of your node.
- **gateway** (**Required**, IPv4 address): The gateway of the local network.
- **subnet** (**Required**, IPv4 address): The subnet of the local network.
- **dns1** (*Optional*, IPv4 address): The main DNS server to use.
- **dns2** (*Optional*, IPv4 address): The backup DNS server to use.
@ -49,8 +49,8 @@ Configuration variables:
- **ap** (*Optional*): Enable an access point mode on the node.
- **ssid** (*Required*, string): The name of the access point to create.
- **password** (*Optional* string): The password for the access point. Leave empty for
- **ssid** (**Required**, string): The name of the access point to create.
- **password** (*Optional*, string): The password for the access point. Leave empty for
no password.
- **channel** (*Optional*, int): The channel the AP should operate on from 1 to 14.
Defaults to 1.