Skip to content

Commit 39603bd

Browse files
authored
Fix some formatting (#4894)
1 parent be2f1ba commit 39603bd

28 files changed

+95
-95
lines changed

changelog/2021.11.0.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ State of the Open Smart Home
2020
----------------------------
2121

2222
Mark your calendar for the `State of the Open Smart Home <https://www.home-assistant.io/state-of-the-open-home/>`__ hosted by Nabu Casa, Home Assistant & ESPHome
23-
and well be joined by our friends from WLED and Z-Wave JS to talk about our work on making this vision a reality.
23+
and we'll be joined by our friends from WLED and Z-Wave JS to talk about our work on making this vision a reality.
2424

2525
Where: YouTube
2626

changelog/2021.12.0.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ State of the Open Smart Home
2222
----------------------------
2323

2424
Today is the `State of the Open Smart Home <https://www.home-assistant.io/state-of-the-open-home/>`__ hosted by Nabu Casa, Home Assistant & ESPHome
25-
and well be joined by our friends from WLED, Z-Wave JS, Stanfords OVAL lab and Northeastern University to talk about our work on making this vision a reality.
25+
and we'll be joined by our friends from WLED, Z-Wave JS, Stanford's OVAL lab and Northeastern University to talk about our work on making this vision a reality.
2626

2727
Where: YouTube
2828

changelog/v1.8.0.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ awesome projects ☀️
6969

7070
Special thanks to all the contributors for this release:
7171

72-
- esphomeyaml: Add only-generate parameter to generate command to only generate the C++ code
72+
- esphomeyaml: Add ``only-generate`` parameter to generate command to only generate the C++ code
7373
`#84 <https://github.com/OttoWinter/esphomeyaml/pull/84>`__ by `@apeeters <https://github.com/apeeters>`__
7474
- esphomeyaml: Fix esphomeyaml logs for tls enabled mqtt brokers
7575
`#118 <https://github.com/OttoWinter/esphomeyaml/pull/118>`__ by `@johnerikhalse <https://github.com/johnerikhalse>`__

components/binary_sensor/status.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Status Binary Sensor
55
:description: Instructions for setting up MQTT status binary sensors.
66
:image: server-network.svg
77

8-
The Status Binary Sensor exposes the node state (if its connected to via MQTT/native API)
8+
The Status Binary Sensor exposes the node state (if it's connected to via MQTT/native API)
99
for Home Assistant.
1010

1111
.. figure:: images/status-ui.png

components/canbus/index.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ single or dual-wire data bus at speeds up to 1Mbps.
1313
CAN is an International Standardization Organization (ISO) defined serial communications bus originally
1414
developed for the automotive industry to replace the complex wiring harness with a two-wire bus. The
1515
specification calls for high immunity to electrical interference and the ability to self-diagnose and repair
16-
data errors. These features have led to CANs popularity in a variety of industries including building
16+
data errors. These features have led to CAN's popularity in a variety of industries including building
1717
automation, medical, and manufacturing.
1818

1919
The current ESPHome implementation supports single frame data transfer. In this way you may send and
@@ -59,7 +59,7 @@ Each ``canbus`` platform extends the following configuration schema:
5959
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
6060
- **can_id** (**Required**, int): default *CAN ID* used for transmitting frames.
6161
- **use_extended_id** (*Optional*, boolean): Identifies the type of ``can_id``:
62-
62+
6363
- ``false``: Standard 11-bit IDs *(default)*
6464
- ``true``: Extended 29-bit IDs
6565

@@ -190,7 +190,7 @@ The CAN bus can transmit frames by means of the ``canbus.send`` action. There ar
190190
CAN bus platforms defined in your configuration.
191191
- **can_id** (*Optional*, int): Allows overriding the ``can_id`` configured for the CAN bus device.
192192
- **use_extended_id** (*Optional*, boolean): Identifies the type of ``can_id``:
193-
193+
194194
- ``false``: Standard 11-bit IDs *(default)*
195195
- ``true``: Extended 29-bit IDs
196196

components/climate/haier.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This is an implementation of the ESPHome component to control HVAC on the base o
99

1010
There are two versions of the Haier protocol: the older version uses an application called SmartAir2 while the newer version uses an application called hOn. Both protocols are compatible on the transport level but utilize different commands to control appliances.
1111

12-
Older Haier models controlled by the SmartAir2 application are using the KZW-W002 module. This module cant be reused, and you need to replace it with an ESP or RPI Pico W module. The USB connector on the board doesnt support the USB protocol. It is a UART port that just uses a USB connector. To connect the ESP board to your AC you can cut a USB type A cable and connect wires to the climate connector.
12+
Older Haier models controlled by the SmartAir2 application are using the KZW-W002 module. This module can't be reused, and you need to replace it with an ESP or RPI Pico W module. The USB connector on the board doesn't support the USB protocol. It is a UART port that just uses a USB connector. To connect the ESP board to your AC you can cut a USB type A cable and connect wires to the climate connector.
1313

1414
.. list-table:: Haier UART pinout
1515
:header-rows: 1
@@ -41,7 +41,7 @@ Older Haier models controlled by the SmartAir2 application are using the KZW-W00
4141

4242
KZW-W002 module pinout
4343

44-
Newer Haier models using a module called ESP32-for-Haier. It is an ESP32 single-core board with an ESP32-S0WD chip. In some cases, you can reuse this module and flash it with ESPHome, but some new modules dont support this. They look the same but have encryption enabled.
44+
Newer Haier models using a module called ESP32-for-Haier. It is an ESP32 single-core board with an ESP32-S0WD chip. In some cases, you can reuse this module and flash it with ESPHome, but some new modules don't support this. They look the same but have encryption enabled.
4545

4646
**Warning!** The new generation of ESP32-Haier devices has encryption enabled, so they can only be flashed with firmware that is signed with a private key. There is no way to make them work with ESPHome, so if you try to do it, the board will get into a boot loop with the error ``rst:0x10 (RTCWDT_RTC_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT)`` The only way to recover this board is to flash it with the original image. So before starting your experiments make a backup image.
4747

components/logger.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Configuration variables:
3838
Advanced settings:
3939

4040
- **tx_buffer_size** (*Optional*, int): The size of the buffer used
41-
for log messages. Decrease this if youre having memory problems.
41+
for log messages. Decrease this if you're having memory problems.
4242
Defaults to ``512``.
4343
- **hardware_uart** (*Optional*, string): The Hardware UART to use for logging. The default varies depending on
4444
the specific processor/chip and framework you are using. See the :ref:`table below <logger-default_hardware_interfaces>`.
@@ -75,7 +75,7 @@ Default UART GPIO Pins
7575
.. list-table::
7676
:header-rows: 1
7777

78-
* -
78+
* -
7979
- ``UART0``
8080
- ``UART0_SWAP``
8181
- ``UART1``
@@ -140,7 +140,7 @@ the original ESP32 or ESP8266) continue to use USB-to-serial bridge ICs for comm
140140
.. list-table::
141141
:header-rows: 1
142142

143-
* -
143+
* -
144144
- Arduino
145145
- ESP-IDF
146146
* - ESP8266
@@ -215,7 +215,7 @@ log level for it, first identify the tag of the log messages in question
215215
and then disable them in your configuration.
216216

217217
Suppose we want to have verbose log messages globally, but the MQTT
218-
client spams too much. In the following example, wed first see that the
218+
client spams too much. In the following example, we'd first see that the
219219
tag of the MQTT client is ``mqtt.client`` (before the first colon) and
220220
the tag for MQTT components is ``mqtt.component``.
221221

components/lvgl/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ It can arrange items into rows or columns (tracks), handle wrapping, adjust spac
533533
- ``END``: means right horizontally and bottom vertically.
534534
- ``CENTER``: simply center.
535535
- ``SPACE_EVENLY``: items are distributed so that the spacing between any two items (and the space to the edges) is equal. Does not apply to ``flex_align_track``.
536-
- ``SPACE_AROUND``: items are evenly distributed in the track with equal space around them. Note that visually the spaces arent equal, since all the items have equal space on both sides. The first item will have one unit of space against the container edge, but two units of space between the next item because that next item has its own spacing that applies. Does not apply to ``flex_align_track``.
536+
- ``SPACE_AROUND``: items are evenly distributed in the track with equal space around them. Note that visually the spaces aren't equal, since all the items have equal space on both sides. The first item will have one unit of space against the container edge, but two units of space between the next item because that next item has its own spacing that applies. Does not apply to ``flex_align_track``.
537537
- ``SPACE_BETWEEN``: items are evenly distributed in the track: first item is on the start line, last item on the end line. Does not apply to ``flex_align_track``.
538538

539539
- **pad_row** (*Optional*, int16): Set the padding between the rows, in pixels.
@@ -597,7 +597,7 @@ Values for use with ``grid_column_align``, ``grid_row_align``, ``grid_cell_x_ali
597597
- ``CENTER``: simply center.
598598
- ``STRETCH``: stretch the widget to the cell in the respective direction. Does not apply to ``grid_column_align``, ``grid_row_align``.
599599
- ``SPACE_EVENLY``: items are distributed so that the spacing between any two items (and the space to the edges) is equal.
600-
- ``SPACE_AROUND``: items are evenly distributed in the track with equal space around them. Note that visually the spaces arent equal, since all the items have equal space on both sides. The first item will have one unit of space against the container edge, but two units of space between the next item because that next item has its own spacing that applies.
600+
- ``SPACE_AROUND``: items are evenly distributed in the track with equal space around them. Note that visually the spaces aren't equal, since all the items have equal space on both sides. The first item will have one unit of space against the container edge, but two units of space between the next item because that next item has its own spacing that applies.
601601
- ``SPACE_BETWEEN``: items are evenly distributed in the track: first item is on the start line, last item on the end line.
602602

603603
.. code-block:: yaml

components/modbus_controller.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -398,8 +398,8 @@ An example is an SDM meter, with interesting data in register addresses 0, 2, 4
398398
399399
The configuration above will generate *one* modbus command *read multiple registers from 0 to 6*.
400400

401-
Maybe you dont care about the data in register addresses 2 and 4, which are voltage values for Phase 2 and Phase 3 (or you have a SDM-120).
402-
Of course, you can delete the sensors your dont care about, but then you'd have a gap in the addresses. If you remove the registers at address 2 and 4, *two* commands will be generated -- *read register 0* and *read register 6*. To avoid generating multiple commands and thus reduce activity on the bus, ``register_count`` can be used to fill the gaps:
401+
Maybe you don't care about the data in register addresses 2 and 4, which are voltage values for Phase 2 and Phase 3 (or you have a SDM-120).
402+
Of course, you can delete the sensors your don't care about, but then you'd have a gap in the addresses. If you remove the registers at address 2 and 4, *two* commands will be generated -- *read register 0* and *read register 6*. To avoid generating multiple commands and thus reduce activity on the bus, ``register_count`` can be used to fill the gaps:
403403

404404
.. code-block:: yaml
405405

components/mqtt.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Configuration variables:
5252
discovery messages so that entities are added automatically on Home
5353
Assistant restart. Defaults to ``true``.
5454
- **discovery_prefix** (*Optional*, string): The prefix to use for Home
55-
Assistants MQTT discovery. Should not contain trailing slash.
55+
Assistant's MQTT discovery. Should not contain trailing slash.
5656
Defaults to ``homeassistant``.
5757
- **discovery_unique_id_generator** (*Optional*, string): The unique_id generator
5858
to use. Can be one of ``legacy`` or ``mac``. Defaults to ``legacy``, which
@@ -65,7 +65,7 @@ Configuration variables:
6565
`Abbreviations <https://www.home-assistant.io/docs/mqtt/discovery/>`__
6666
in discovery messages. Defaults to ``true``.
6767
- **topic_prefix** (*Optional*, string): The prefix used for all MQTT
68-
messages. Should not contain trailing slash. Defaults to ``<APP_NAME>``.
68+
messages. Should not contain trailing slash. Defaults to ``<APP_NAME>``.
6969
Use ``null`` to disable publishing or subscribing of any MQTT topic unless
7070
it is explicitly configured.
7171
- **log_topic** (*Optional*, :ref:`mqtt-message`): The topic to send MQTT log
@@ -246,10 +246,10 @@ And that should already be it 🎉 All devices defined through ESPHome should sh
246246
in the entities section of Home Assistant.
247247

248248
When adding new entities, you might run into trouble with old entities
249-
still appearing in Home Assistants front-end. This is because in order
249+
still appearing in Home Assistant's front-end. This is because in order
250250
to have Home Assistant “discover” your devices on restart, all discovery
251251
MQTT messages need to be retained. Therefore the old entities will also
252-
re-appear on every Home Assistant restart even though theyre in
252+
re-appear on every Home Assistant restart even though they're in
253253
ESPHome anymore.
254254

255255
To fix this, ESPHome has a simple helper script that purges stale
@@ -288,7 +288,7 @@ By default, ESPHome will prefix all messages with your node name or
288288
``topic_prefix`` if you have specified it manually. The client id will
289289
automatically be generated by using your node name and adding the MAC
290290
address of your device to it. Next, discovery is enabled by default with
291-
Home Assistants default prefix ``homeassistant``.
291+
Home Assistant's default prefix ``homeassistant``.
292292

293293
If you want to prefix all MQTT messages with a different prefix, like
294294
``home/living_room``, you can specify a custom ``topic_prefix`` in the

components/output/ledc.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Configuration variables:
1919
- **pin** (**Required**, :ref:`config-pin`): The pin to use LEDC on. Can only be GPIO0-GPIO33.
2020
- **id** (**Required**, :ref:`config-id`): The id to use for this output component.
2121
- **frequency** (*Optional*, float): At which frequency to run the LEDC
22-
channels timer. Defaults to 1000Hz.
22+
channel's timer. Defaults to 1000Hz.
2323
- All other options from :ref:`Output <config-output>`.
2424

2525
Advanced options:

components/power_supply.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Power Supply Component
77
:keywords: power, ATX
88

99
The ``power_supply`` component allows you to have a high power mode for
10-
certain outputs. For example, if youre using an `ATX power
10+
certain outputs. For example, if you're using an `ATX power
1111
supply <https://en.wikipedia.org/wiki/ATX>`__ to power your LED strips,
12-
you usually dont want to have the power supply on all the time while
12+
you usually don't want to have the power supply on all the time while
1313
the output is not on. The power supply component can be attached to any
1414
:ref:`Output Component <output>` and
1515
will automatically switch on if any of the outputs are on. Furthermore,
@@ -66,7 +66,7 @@ to be inverted.
6666
inverted: true
6767
6868
Then simply connect the green control wire from the ATX power supply to
69-
your specified pin. Its recommended to put a small resistor (about 1kΩ)
69+
your specified pin. It's recommended to put a small resistor (about 1kΩ)
7070
in between to protect the ESP board.
7171

7272
See Also

components/sensor/dsmr.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Component/Hub
99
-------------
1010

1111
The DSMR component connects to Dutch Smart Meters which comply to DSMR (Dutch Smart Meter
12-
Requirements), also known as Slimme meter or P1 port.
12+
Requirements), also known as 'Slimme meter' or 'P1 port'.
1313

1414
This component supports plain non encrypted telegrams and also encrypted as used in Luxembourg.
1515
In case your equipment has encryption you must get a 32 character long encryption key from your energy company.
@@ -256,8 +256,8 @@ Configuration variables:
256256

257257
- All options from :ref:`Text Sensor <config-text_sensor>`.
258258

259-
- **telegram** (*Optional*): The (decrypted) unparsed telegram, marked as internal sensor.
260-
Can also be used to trigger an action based on the last values.
259+
- **telegram** (*Optional*): The (decrypted) unparsed telegram, marked as internal sensor.
260+
Can also be used to trigger an action based on the last values.
261261

262262
- All other options from :ref:`Text Sensor <config-text_sensor>`.
263263

@@ -414,7 +414,7 @@ You can use another uart to supply another P1 receiver with the same telegram. S
414414
uart_id: p1_uart
415415
max_telegram_length: 1700
416416
417-
# log the telegram and pass telegram to p1_bridge_uart
417+
# log the telegram and pass telegram to p1_bridge_uart
418418
text_sensor:
419419
- platform: dsmr
420420
telegram:

components/sensor/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -206,10 +206,10 @@ Filters are applied in the order they are defined in your configuration.
206206
Example: Converting Celsius to Fahrenheit
207207
-----------------------------------------
208208

209-
While I personally dont like the Fahrenheit temperature scale, I do
209+
While I personally don't like the Fahrenheit temperature scale, I do
210210
understand that having temperature values appear in the Fahrenheit unit
211211
is quite useful to some users. ESPHome uses the Celsius temperature
212-
unit internally, and Im not planning on making converting between the
212+
unit internally, and I'm not planning on making converting between the
213213
two simple (😉), but you can use this filter to convert Celsius values to
214214
Fahrenheit.
215215

components/sensor/ld2420.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ Configuration variables:
230230
``max_gate_distance`` - 1. Each increment equals 70 cm. Defaults to 1. **Required** when ``presence_timeout`` and
231231
``max_gate_distance`` is specified. May contain any options from :ref:`Number <config-number>`.
232232
- **max_gate_distance** (*Optional*): Maximum gate for movement detection. Value from 1 to 15. Each gate detects
233-
movement and still energy at 70 cm increments. At the maximum value, the sensors range equates to 16 * 70 cm
233+
movement and still energy at 70 cm increments. At the maximum value, the sensor's range equates to 16 * 70 cm
234234
resulting in an approximately 12-meter range; however, accuracy at this range may be diminished. The recommended
235235
maximum value is 12 * 70 cm which results in approximately 9 meters. **Required** when ``presence_timeout`` and
236236
``min_gate_distance`` is specified. May contain any options from :ref:`Number <config-number>`.

0 commit comments

Comments
 (0)