Skip to content

Commit

Permalink
Use lowercase true/false values (esphome#1327)
Browse files Browse the repository at this point in the history
Co-authored-by: Jesse Hills <[email protected]>
  • Loading branch information
oxan and jesserockz authored Jul 28, 2021
1 parent 666610b commit 5e3102a
Show file tree
Hide file tree
Showing 59 changed files with 172 additions and 172 deletions.
6 changes: 3 additions & 3 deletions components/binary_sensor/esp32_touch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ the eight touch pads of the ESP32 as :ref:`binary sensors <esp32-touch-binary-se
# Example configuration entry
esp32_touch:
setup_mode: False
setup_mode: false
binary_sensor:
- platform: esp32_touch
Expand Down Expand Up @@ -131,7 +131,7 @@ to make the validator happy, we are going to find good thresholds in a moment an
# Example configuration entry for finding threshold values
esp32_touch:
setup_mode: True
setup_mode: true
binary_sensor:
- platform: esp32_touch
Expand All @@ -148,7 +148,7 @@ touch/non-touch events.
:align: center

Finally, put your threshold parameter in the configuration. Do not forget to disable the ``setup_mode``
option again by setting it to ``False``. Otherwise you will end up spamming the logs and slowing the device
option again by setting it to ``false``. Otherwise you will end up spamming the logs and slowing the device
down.

See Also
Expand Down
2 changes: 1 addition & 1 deletion components/binary_sensor/gpio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ sensor:
- platform: gpio
pin:
number: D2
inverted: True
inverted: true
name: ...
Debouncing Values
Expand Down
2 changes: 1 addition & 1 deletion components/binary_sensor/nextion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Nextion Binary Sensor Component
:description: Instructions for setting up Nextion binary sensor.
:image: nextion.jpg

The ``nextion`` binary sensor platform supports the many switched components in the Nextion as well as integer variables (>0 == True). It can be a component or variable in the Nextion display.
The ``nextion`` binary sensor platform supports the many switched components in the Nextion as well as integer variables (>0 == true). It can be a component or variable in the Nextion display.
It is best to set the components vscope to global in the Nextion Editor. This way the component will be available if the page is shown or not.

See :doc:`/components/display/nextion` for setting up the display
Expand Down
4 changes: 2 additions & 2 deletions components/binary_sensor/xpt2046.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The :ref:`SPI <spi>` is required to be set up in your configuration for this sen
calibration_x_max: 280
calibration_y_min: 340
calibration_y_max: 3860
swap_x_y: False
swap_x_y: false
binary_sensor:
- platform: xpt2046
Expand Down Expand Up @@ -220,7 +220,7 @@ That means that the minimum raw x is 281, maximum 3848, minimum y 347 and maximu
Identify which raw value is the display's x direction and what the y one. In our case
moving right decreases the x raw value and going down increases the y one so the axes
match and we *don't* need to use ``swap_x_y``. If the raw x is the display's y,
use ``swap_x_y = True``.
use ``swap_x_y = true``.

If one of the coordinates goes in the "wrong" direction it needs to be inverted.
The inversion is performed by swapping the minimum and maximum values. In our
Expand Down
16 changes: 8 additions & 8 deletions components/canbus.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Each canbus platform extends this configuration schema.
can_id: 4
on_frame:
- can_id: 500
use_extended_id: False
use_extended_id: false
then:
- lambda: |-
std::string b(x.begin(), x.end());
Expand All @@ -56,8 +56,8 @@ Configuration variables:

- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **can_id** (**Required**, integer): default *can id* used for transmitting frames.
- **use_extended_id** (*Optional*, boolean): default *False* identifies the type of *can_id*:
*False*: Standard 11 bits IDs, *True*: Extended 29 bits ID
- **use_extended_id** (*Optional*, boolean): default *false* identifies the type of *can_id*:
*false*: Standard 11 bits IDs, *true*: Extended 29 bits ID
- **bit_rate** (*Optional*, enum): One of the supported bitrates. Defaults to ``125KBPS``.

- 5KBPS
Expand Down Expand Up @@ -138,8 +138,8 @@ Configuration variables:
the frame. Not needed if you are using only 1 can bus.
- **can_id** (*Optional*, int): Allows to override the can id configured in
the can bus device.
- **use_extended_id** (*Optional*, boolean): default *False* identifies the type of *can_id*:
*False*: Standard 11 Bit IDs, *True*: Extended 29Bit ID
- **use_extended_id** (*Optional*, boolean): default *false* identifies the type of *can_id*:
*false*: Standard 11 Bit IDs, *true*: Extended 29Bit ID

MCP2515 Component
-----------------
Expand Down Expand Up @@ -221,7 +221,7 @@ Standard IDs and Extended IDs can coexist on the same segment.
then:
- canbus.send:
# Extended ID explicit
use_extended_id: True
use_extended_id: true
can_id: 0x100
data: [0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08]
- canbus.send:
Expand All @@ -235,11 +235,11 @@ Standard IDs and Extended IDs can coexist on the same segment.
spi_id: McpSpi
cs_pin: GPIO14
can_id: 0x1fff
use_extended_id: True
use_extended_id: true
bit_rate: 125kbps
on_frame:
- can_id: 0x123
use_extended_id: True
use_extended_id: true
then:
- lambda: |-
std::string b(x.begin(), x.end());
Expand Down
6 changes: 3 additions & 3 deletions components/climate/ir_climate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ Configuration variables:
- **name** (**Required**, string): The name for the climate device.
- **sensor** (*Optional*, :ref:`config-id`): The sensor that is used to measure the ambient
temperature. This is only for reporting the current temperature in the frontend.
- **supports_cool** (*Optional*, boolean): Enables setting cooling mode for this climate device. Defaults to ``True``.
- **supports_heat** (*Optional*, boolean): Enables setting heating mode for this climate device. Defaults to ``True``.
- **supports_cool** (*Optional*, boolean): Enables setting cooling mode for this climate device. Defaults to ``true``.
- **supports_heat** (*Optional*, boolean): Enables setting heating mode for this climate device. Defaults to ``true``.
- **receiver_id** (*Optional*, :ref:`config-id`): The id of the remote_receiver if this platform supports
receiver. see: :ref:`ir-receiver_id`.
- All other options from :ref:`Climate <config-climate>`.
Expand Down Expand Up @@ -102,7 +102,7 @@ IR receiver.
id: rcvr
pin:
number: GPIO14
inverted: True
inverted: true
mode: INPUT_PULLUP
# high 55% tolerance is recommended for some remote control units
tolerance: 55%
Expand Down
14 changes: 7 additions & 7 deletions components/climate/midea_ac.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,14 +91,14 @@ Configuration variables:
- **name** (**Required**, string): The name of the sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **beeper** (*Optional*, boolean): Beeper feedback on command. Defaults to ``False``.
- **beeper** (*Optional*, boolean): Beeper feedback on command. Defaults to ``false``.
- **custom_fan_modes** (*Optional*, list): List of supported custom fan modes. Possible values are: SILENT, TURBO.
- **preset_eco** (*Optional*, boolean): ECO preset support. Defaults to ``False``.
- **preset_sleep** (*Optional*, boolean): SLEEP preset support. Defaults to ``False``.
- **preset_boost** (*Optional*, boolean): BOOST preset support. Defaults to ``False``.
- **preset_eco** (*Optional*, boolean): ECO preset support. Defaults to ``false``.
- **preset_sleep** (*Optional*, boolean): SLEEP preset support. Defaults to ``false``.
- **preset_boost** (*Optional*, boolean): BOOST preset support. Defaults to ``false``.
- **custom_presets** (*Optional*, list): List of supported custom presets. Possible values are: FREEZE_PROTECTION.
- **swing_horizontal** (*Optional*, boolean): Enable **swing horizontal** option. Defaults to ``False``.
- **swing_both** (*Optional*, boolean): Enable **swing both** option. Defaults to ``False``.
- **swing_horizontal** (*Optional*, boolean): Enable **swing horizontal** option. Defaults to ``false``.
- **swing_both** (*Optional*, boolean): Enable **swing both** option. Defaults to ``false``.
- All other options from :ref:`Climate <config-climate>`.

Configuration variables of midea-dongle component:
Expand All @@ -108,7 +108,7 @@ Configuration variables of midea-dongle component:
- **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :doc:`../uart` if you want
to use multiple UART buses.
- **strength_icon** (*Optional*, boolean): Set if your device have signal strength icon
and you want to use this feature. By default, on connected state, icon show maximum signal quality. Defaults to ``False``.
and you want to use this feature. By default, on connected state, icon show maximum signal quality. Defaults to ``false``.


Acknowledgments:
Expand Down
4 changes: 2 additions & 2 deletions components/climate/tuya.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ Configuration variables:

- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **name** (**Required**, string): The name of the climate device.
- **supports_heat** (*Optional*, boolean): Specifies if the device has a heating mode. Defaults to ``True``.
- **supports_cool** (*Optional*, boolean): Specifies if the device has a cooling mode. Defaults to ``False``.
- **supports_heat** (*Optional*, boolean): Specifies if the device has a heating mode. Defaults to ``true``.
- **supports_cool** (*Optional*, boolean): Specifies if the device has a cooling mode. Defaults to ``false``.
- **switch_datapoint** (**Required**, int): The datapoint id number of the climate switch.
- **active_state_datapoint** (*Optional*, int): The datapoint id number of the active state.
- **active_state_heating_value** (*Optional*, int): The active state datapoint value the device reports when heating. Defaults to ``1``.
Expand Down
4 changes: 2 additions & 2 deletions components/cover/time_based.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@ Configuration variables:
- **has_built_in_endstop** (*Optional*, boolean): Indicates that the cover has built in end stop
detectors. In this configuration the ``stop_action`` is not performed when the open or close
time is completed and if the cover is commanded to open or close the corresponding actions
will be performed without checking current state. Defaults to ``False``.
will be performed without checking current state. Defaults to ``false``.
- **assumed_state** (*Optional*, boolean): Whether the true state of the cover is not known.
This will make the Home Assistant frontend show buttons for both OPEN and CLOSE actions, instead
of hiding or disabling one of them. Defaults to ``True``.
of hiding or disabling one of them. Defaults to ``true``.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Cover <config-cover>`.

Expand Down
6 changes: 3 additions & 3 deletions components/dfplayer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Configuration options:
- **file** (*Optional*, int, :ref:`templatable <config-templatable>`): The global track
number (from all tracks in the device). If not specified plays the first track.
- **loop** (*Optional*, bool, :ref:`templatable <config-templatable>`): Repeats playing
the same track. Defaults to ``False``.
the same track. Defaults to ``false``.

``dfplayer.play_folder`` Action
-------------------------------
Expand Down Expand Up @@ -147,7 +147,7 @@ Configuration options:
- **file** (*Optional*, int, :ref:`templatable <config-templatable>`): The file number
inside the folder to play. Optional only if ``loop`` is not set.
- **loop** (*Optional*, bool, :ref:`templatable <config-templatable>`): Repeats playing
all files in the folder. Causes ``file`` to be ignored. Defaults to ``False``.
all files in the folder. Causes ``file`` to be ignored. Defaults to ``false``.


``dfplayer.set_device`` Action
Expand Down Expand Up @@ -369,7 +369,7 @@ Sample code
then:
- dfplayer.play_folder:
folder: !lambda 'return folder;'
loop: True
loop: true
- service: dfplayer_set_device_tf
then:
Expand Down
4 changes: 2 additions & 2 deletions components/display/inkplate6.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,8 @@ Configuration variables:
************************

- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **greyscale** (*Optional*, boolean): Makes the screen display 3 bit colors. Defaults to ``False``
- **partial_updating** (*Optional*, boolean): Makes the screen update partially, which is faster, but leaves burnin. Defaults to ``False``
- **greyscale** (*Optional*, boolean): Makes the screen display 3 bit colors. Defaults to ``false``
- **partial_updating** (*Optional*, boolean): Makes the screen update partially, which is faster, but leaves burnin. Defaults to ``false``
- **full_update_every** (*Optional*, int): When partial updating is enabled, forces a full screen update after chosen number of updates. Defaults to ``10``
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`): The lambda to use for rendering the content on the display.
See :ref:`display-engine` for more information.
Expand Down
2 changes: 1 addition & 1 deletion components/display/max7219.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Configuration variables:
- **spi_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`SPI Component <spi>` if you want
to use multiple SPI buses.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **reverse_enable** (*Optional*, boolean): For some displays the order of the chips is reversed so you'll see "56781234" instead of "12345678". This option will adjust the output to compensate. Defaults to ``False``.
- **reverse_enable** (*Optional*, boolean): For some displays the order of the chips is reversed so you'll see "56781234" instead of "12345678". This option will adjust the output to compensate. Defaults to ``false``.


.. _display-max7219_lambda:
Expand Down
4 changes: 2 additions & 2 deletions components/display/max7219digit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Configuration variables:
``4``.
- **rotate_chip** (*Optional*): Rotates every 8x8 chip. Valid values are ``0``, ``90``, ``180`` and ``270``.
Defaults to ``0``.
- **scroll_enable** (*Optional*, boolean): Turn scroll mode on when content does not fit. Defaults to ``True``.
- **scroll_enable** (*Optional*, boolean): Turn scroll mode on when content does not fit. Defaults to ``true``.
- **scroll_mode** (*Optional*): Set the scroll mode. One of ``CONTINUOUS`` or ``STOP``. Defaults to ``CONTINUOUS``

- ``CONTINUOUS``: Always scrolls and the text repeats continuously, you might need to add some
Expand All @@ -57,7 +57,7 @@ Configuration variables:
- **scroll_delay** (*Optional*, :ref:`config-time`): Set delay time before scroll starts. Defaults to ``1s``.
- **scroll_dwell** (*Optional*, :ref:`config-time`): Sets the wait time at the end of the scroll before starting
over. This is only used in mode ``STOP``. Defaults to ``1s``.
- **reverse_enable** (*Optional*, boolean): For some displays the order of the displays is reversed ("DCBA"). This option will reverse the display to ("ABCD") again. Defaults to ``False``.
- **reverse_enable** (*Optional*, boolean): For some displays the order of the displays is reversed ("DCBA"). This option will reverse the display to ("ABCD") again. Defaults to ``false``.
- **intensity** (*Optional*, integer): The intensity with which the MAX7219 should drive the outputs. Range is
from ``0``, least intense to ``15`` the brightest. Defaults to ``15``.
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`): The lambda to use for rendering the content on the
Expand Down
6 changes: 3 additions & 3 deletions components/display/st7735.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ Configuration variables:
- **device_height** (**Required**, int): The device height. 160 is default
- **col_start** (**Required**, int): The device height. 160 is default
- **row_start** (**Required**, int): The device height. 160 is default
- **eight_bit_color** (*Optional*, "True/False" ): 8bit mode. Default is False. This saves 50% of the buffer required for the display.
- **eight_bit_color** (*Optional*, "true/false" ): 8bit mode. Default is false. This saves 50% of the buffer required for the display.
- **reset_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The RESET pin.

Memory notes:
*************

- 8Bit color saves 50% of the buffer required.
- eightbitcolor: True 160x128 = 20480 *Important for memory constrained devices*
- eightbitcolor: False 160x128x2 = 40960
- ``eight_bit_color: true`` 160x128 = 20480 *Important for memory constrained devices*
- ``eight_bit_color: false`` 160x128x2 = 40960


Models:
Expand Down
2 changes: 1 addition & 1 deletion components/esphome.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Advanced options:
to include in the project. See `platformio lib install <https://docs.platformio.org/en/latest/userguide/lib/cmd_install.html>`__.
- **comment** (*Optional*, string): Additional text information about this node. Only for display in UI.
- **name_add_mac_suffix** (*Optional*, boolean): Appends the last 6 bytes of the mac address of the device to
the name in the form ``<name>-aabbcc``. Defaults to ``False``.
the name in the form ``<name>-aabbcc``. Defaults to ``false``.
See :ref:`esphome-mac_suffix`.

- **project** (*Optional*): ESPHome Creator's Project information. See :ref:`esphome-creators_project`.
Expand Down
8 changes: 4 additions & 4 deletions components/i2c.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ connecting the wires from each device back to the two I²C pins on the ESP.
i2c:
sda: 21
scl: 22
scan: True
scan: true
id: bus_a
Configuration variables:
Expand All @@ -34,7 +34,7 @@ Configuration variables:
Defaults to the default of your board (usually GPIO22 for ESP32 and
GPIO5 for ESP8266).
- **scan** (*Optional*, boolean): If ESPHome should do a search of the I²C address space on startup.
Defaults to ``True``.
Defaults to ``true``.
- **frequency** (*Optional*, float): Set the frequency the I²C bus should operate on.
Defaults to ``50kHz``. Values are ``50kHz``, ``100kHz``, ``200kHz``, ... ``800kHz``
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID for this I²C bus if you need multiple I²C buses.
Expand All @@ -50,11 +50,11 @@ Configuration variables:
- id: bus_a
sda: 13
scl: 16
scan: True
scan: true
- id: bus_b
sda: 14
scl: 15
scan: True
scan: true
# Sensors should be specified as follows
- platform: bme680
i2c_id: bus_b
Expand Down
Loading

0 comments on commit 5e3102a

Please sign in to comment.