From 8495cc59368d1bc94ac1a2d7d9427d95855615cd Mon Sep 17 00:00:00 2001 From: Oxan van Leeuwen Date: Thu, 22 Jul 2021 23:38:38 +0200 Subject: [PATCH] Fix a bunch of typos (#1324) --- components/binary_sensor/nextion.rst | 6 +++--- components/binary_sensor/rc522.rst | 4 ++-- components/canbus.rst | 2 +- components/climate/thermostat.rst | 2 +- components/display/max7219digit.rst | 2 +- components/ethernet.rst | 2 +- components/light/index.rst | 6 +++--- components/ota.rst | 2 +- components/remote_receiver.rst | 2 +- components/rf_bridge.rst | 2 +- components/sensor/b_parasite.rst | 2 +- components/sensor/bh1750.rst | 2 +- components/sensor/cs5460a.rst | 2 +- components/sensor/havells_inverter.rst | 4 ++-- components/sensor/mcp3008.rst | 2 +- components/sensor/nextion.rst | 2 +- components/sensor/qmc5883l.rst | 2 +- components/sensor/ruuvitag.rst | 4 ++-- components/sensor/teleinfo.rst | 2 +- components/sensor/tmp102.rst | 2 +- components/switch/nextion.rst | 4 ++-- components/tca9548a.rst | 2 +- components/text_sensor/nextion.rst | 4 ++-- components/time.rst | 4 ++-- components/wifi.rst | 2 +- cookbook/ble_itag.rst | 2 +- cookbook/infostrip.rst | 2 +- guides/contributing.rst | 2 +- schema_doc.py | 12 ++++++------ 29 files changed, 44 insertions(+), 44 deletions(-) diff --git a/components/binary_sensor/nextion.rst b/components/binary_sensor/nextion.rst index b7d978b7f..ce21714e8 100644 --- a/components/binary_sensor/nextion.rst +++ b/components/binary_sensor/nextion.rst @@ -55,7 +55,7 @@ Configuration variables: **Touch Sensor:** The Nextion will send a **page_id** and **component_id** when the *Send Component ID* check box is selected for the component. To enable -this native event **page_id** and **component_id** are required. No :ref:`nextion_custom_binary_sensor_protocol` is required. If **page_id** and **component_id** are set then the component will only react to touch events from the Nextion. Setting **component_name** will allow setting options like forground color. +this native event **page_id** and **component_id** are required. No :ref:`nextion_custom_binary_sensor_protocol` is required. If **page_id** and **component_id** are set then the component will only react to touch events from the Nextion. Setting **component_name** will allow setting options like foreground color. .. note:: @@ -122,7 +122,7 @@ How things Update A Nextion component with an integer value (.val) or Nextion variable will be automatically polled if **update_interval** is set. To have the Nextion send the data you can use the :ref:`nextion_custom_binary_sensor_protocol` for this. Add the :ref:`nextion_custom_binary_sensor_protocol` to the component or function you want to trigger the send. Typically this is in *Touch Press Event* but some components, like a slider, should have it -set in the *Touch Release Event* to capture all the changes. Since this is a custom protocol it can be sent from anywhere (timers/functions/componenets) +set in the *Touch Release Event* to capture all the changes. Since this is a custom protocol it can be sent from anywhere (timers/functions/components) in the Nextion. .. note:: @@ -141,7 +141,7 @@ Using the above yaml example: .. note:: - No updates will be sent to the Nextion if it is sleeping. Once it wakes the components will be updated. If a component is invisible , :code:`visible(false)` , then it wont update until it is set to be visible. + No updates will be sent to the Nextion if it is sleeping. Once it wakes the components will be updated. If a component is invisible , :code:`visible(false)` , then it won't update until it is set to be visible. .. _nextion_custom_binary_sensor_protocol: diff --git a/components/binary_sensor/rc522.rst b/components/binary_sensor/rc522.rst index 9100c7966..0de0ef3e5 100644 --- a/components/binary_sensor/rc522.rst +++ b/components/binary_sensor/rc522.rst @@ -31,7 +31,7 @@ Over SPI -------- The ``rc522_spi`` component allows you to use RC522 RFID controllers with ESPHome. This component is a global hub that -establishes the connection to the RC522 via :ref:`SPI ` (also avilable over I²C). Using the +establishes the connection to the RC522 via :ref:`SPI ` (also available over I²C). Using the :ref:`RC522 binary sensors ` you can then create individual binary sensors that track if an RFID tag is currently detected by the RC522. @@ -67,7 +67,7 @@ Over I²C -------- The ``rc522_i2c`` component allows you to use RC522 RFID controllers with ESPHome. This component is a global hub that -establishes the connection to the RC522 via :ref:`I²C ` (also avilable over SPI). Using the +establishes the connection to the RC522 via :ref:`I²C ` (also available over SPI). Using the :ref:`RC522 binary sensors ` you can then create individual binary sensors that track if an RFID tag is currently detected by the RC522. diff --git a/components/canbus.rst b/components/canbus.rst index 440cd501b..aeb1d4bfc 100644 --- a/components/canbus.rst +++ b/components/canbus.rst @@ -25,7 +25,7 @@ transmitted data. The CAN bus itself has only two wires named Can High and Can Low or CanH and CanL. For the ESPHome CAN bus to work you need to select the device that has the physical CAN bus implemented. -At this moment only the MCP2515 driver is supported. You can configure multiple busses. +At this moment only the MCP2515 driver is supported. You can configure multiple buses. Any can bus node can transmit data at any time, and any node can send any ``can_id`` value and any node can receive any can_id too. Is up to you how to organize the can_id values. You can setup a can diff --git a/components/climate/thermostat.rst b/components/climate/thermostat.rst index 33fb18f7d..823c60ff6 100644 --- a/components/climate/thermostat.rst +++ b/components/climate/thermostat.rst @@ -10,7 +10,7 @@ physical thermostat. Its operation is similar to the :doc:`bang-bang (the air temperature) and the controller will try to keep this value within a range defined by the set point(s). To do this, the controller can activate devices like a heating unit and/or a cooling unit to change the value observed by the sensor. When configured for both heating and cooling, it is essentially two :doc:`bang-bang ` controllers in one; it -differs, however, in that interation with the thermostat component is nearly identical to that of a real thermostat. +differs, however, in that interaction with the thermostat component is nearly identical to that of a real thermostat. This component can operate in one of two ways: diff --git a/components/display/max7219digit.rst b/components/display/max7219digit.rst index 3137e138e..e69229c64 100644 --- a/components/display/max7219digit.rst +++ b/components/display/max7219digit.rst @@ -194,7 +194,7 @@ The display can be switched on and off "dynamically" within the lambda code with it.turn_on_off(true); For a quick display some additional commands are embedded in the code with a related 8 pixel font. Three methods -(``printdigit``, ``printdigitf`` and ``strftimedigit``) can be used for diplaying characters. Each 8 X 8 grid is used to +(``printdigit``, ``printdigitf`` and ``strftimedigit``) can be used for displaying characters. Each 8 X 8 grid is used to display a single character. So not very space efficient. The format of the command is: ``it.printdigit("1234");`` or ``it.printdigitf("%s","1234")``; diff --git a/components/ethernet.rst b/components/ethernet.rst index aa00cba54..74127a50f 100644 --- a/components/ethernet.rst +++ b/components/ethernet.rst @@ -54,7 +54,7 @@ Configuration variables: - **dns1** (*Optional*, IPv4 address): The main DNS server to use. - **dns2** (*Optional*, IPv4 address): The backup DNS server to use. -- **enable_mdns** (*Optional*, boolean): Controls if your node should advertise its presense and services using mDNS. When set to ``false`` you won't be able to access your node using its hostname which can break certain functionalities. Please see :ref:`notes on disabling mDNS `. Defaults to ``true``. +- **enable_mdns** (*Optional*, boolean): Controls if your node should advertise its presence and services using mDNS. When set to ``false`` you won't be able to access your node using its hostname which can break certain functionalities. Please see :ref:`notes on disabling mDNS `. Defaults to ``true``. - **use_address** (*Optional*, string): Manually override what address to use to connect to the ESP. Defaults to auto-generated value. For example, if you have changed your static IP and want to flash OTA to the previously configured IP address. diff --git a/components/light/index.rst b/components/light/index.rst index b6765cbfc..ea8d92ef0 100644 --- a/components/light/index.rst +++ b/components/light/index.rst @@ -417,7 +417,7 @@ Configuration variables: - **name** (*Optional*, string): The name of the effect. Defaults to ``Pulse``. - **transition_length** (*Optional*, :ref:`config-time`): The duration of each transition. Defaults to ``1s``. -- **update_interval** (*Optional*, :ref:`config-time`): The interval when the new transistion is started. Defaults to ``1s``. +- **update_interval** (*Optional*, :ref:`config-time`): The interval when the new transition is started. Defaults to ``1s``. Random Effect @@ -529,7 +529,7 @@ This effect allows you to write completely custom light effects yourself using : lambda: |- static int state = 0; auto call = id(my_light).turn_on(); - // Transtion of 1000ms = 1s + // Transition of 1000ms = 1s call.set_transition_length(1000); if (state == 0) { call.set_rgb(1.0, 1.0, 1.0); @@ -992,7 +992,7 @@ Configuration variables: .. note:: - You can also set the ``port`` to ``19446`` for compatability with Hyperion Classic using a + You can also set the ``port`` to ``19446`` for compatibility with Hyperion Classic using a UDP device with protocol 0. Currently the following realtime protocols are supported: diff --git a/components/ota.rst b/components/ota.rst index 24a11f961..09ae288bc 100644 --- a/components/ota.rst +++ b/components/ota.rst @@ -110,7 +110,7 @@ progress percentage (a value between 0 and 100) from the trigger with variable ` ``on_end`` ********** -This automation will be triggered when an OTA update has completed sucessfully, +This automation will be triggered when an OTA update has completed successfully, right before the device is rebooted. Because the update has completed, you can safely use an automation action that diff --git a/components/remote_receiver.rst b/components/remote_receiver.rst index 2a767b3e4..57a85ec60 100644 --- a/components/remote_receiver.rst +++ b/components/remote_receiver.rst @@ -224,7 +224,7 @@ Remote code selection (exactly one of these has to be included): .. note:: - To caputure the codes more effectively with directly connected receiver like tsop38238 you can try to use ``INPUT_PULLUP``: + To capture the codes more effectively with directly connected receiver like tsop38238 you can try to use ``INPUT_PULLUP``: .. code-block:: yaml diff --git a/components/rf_bridge.rst b/components/rf_bridge.rst index d3b0e7831..87fea1247 100644 --- a/components/rf_bridge.rst +++ b/components/rf_bridge.rst @@ -7,7 +7,7 @@ RF Bridge Component :keywords: RF Bridge The ``RF Bridge`` Component provides the ability to send and receive 433MHz remote codes without hardware -hacking the circuit board to bypass the ``efm8bb1`` MCU. This component implements the communcation protocol +hacking the circuit board to bypass the ``efm8bb1`` MCU. This component implements the communication protocol that the original ``efm8bb1`` firmware implements. The device is connected via the :doc:`UART bus `. The uart bus must be configured at the same speed of the module which is 19200bps. diff --git a/components/sensor/b_parasite.rst b/components/sensor/b_parasite.rst index a1d340762..850b7bdb1 100644 --- a/components/sensor/b_parasite.rst +++ b/components/sensor/b_parasite.rst @@ -38,7 +38,7 @@ Configuration variables ----------------------- - **mac_address** (**Required**): The MAC address of the device. -- **temperature** (*Optional*): Air temperature in Celcius. +- **temperature** (*Optional*): Air temperature in Celsius. - **name** (**Required**): Sensor name. - All other options from :ref:`Sensor `. diff --git a/components/sensor/bh1750.rst b/components/sensor/bh1750.rst index b8f5e049f..173eb6f79 100644 --- a/components/sensor/bh1750.rst +++ b/components/sensor/bh1750.rst @@ -32,7 +32,7 @@ your configuration for this sensor to work. update_interval: 60s By default the **measurement_duration** is set to ``69`` which will result into measurements up -to 54612.5 lx for this sensor. For low-light situtations consider to choose a higher +to 54612.5 lx for this sensor. For low-light situations consider to choose a higher measurement_duration up to ``254`` which will result in a maximum measurement range up to 14835 lx. For sunny scenes (for example outdoors with sunlight) use lower values down to ``31`` which will give you the maximum measurement range up to 121556 lx. diff --git a/components/sensor/cs5460a.rst b/components/sensor/cs5460a.rst index 07fcddca8..0caa5b7ad 100644 --- a/components/sensor/cs5460a.rst +++ b/components/sensor/cs5460a.rst @@ -92,7 +92,7 @@ Configuration variables: When using a voltage transformer this is the secondary turns to primary turns ratio. When using a current transformer (such as the ZMPT101B) this is equals ``(secondary turns * burden resistor value) / (primary turns * limiting resistor value)``, and - similarly for combiations of transfomers and voltage dividers. Defaults to ``0.001``. Must be + similarly for combinations of transfomers and voltage dividers. Defaults to ``0.001``. Must be a positive number. - **phase_offset** (*Optional*): This can be used to account for a phase offset between the voltage sensing circuit and the current sensing circuit to improve power measurement accuracy. Admits diff --git a/components/sensor/havells_inverter.rst b/components/sensor/havells_inverter.rst index 5c865107a..965366113 100644 --- a/components/sensor/havells_inverter.rst +++ b/components/sensor/havells_inverter.rst @@ -157,9 +157,9 @@ Configuration variables: - **today_generation_time** (*Optional*): Use the day generation time value for same day of the sensor in minutes. All options from :ref:`Sensor `. - **inverter_module_temp** (*Optional*): Use the inverter module temperature value of the sensor in - degree celcius. All options from :ref:`Sensor `. + degree celsius. All options from :ref:`Sensor `. - **inverter_inner_temp** (*Optional*): Use the inverter inner temperature value of the sensor in - degree celcius. All options from :ref:`Sensor `. + degree celsius. All options from :ref:`Sensor `. - **inverter_bus_voltage** (*Optional*): Use the inverter bus voltage value of the sensor in volts. All options from :ref:`Sensor `. - **insulation_of_pv_n_to_ground** (*Optional*): Use the insulation of photo voltiacs's diff --git a/components/sensor/mcp3008.rst b/components/sensor/mcp3008.rst index 871944550..ccb8f0976 100644 --- a/components/sensor/mcp3008.rst +++ b/components/sensor/mcp3008.rst @@ -28,7 +28,7 @@ Once configured, you can use any of the 8 pins as sensors for your projects. Each pin will respond with a voltage calculated off of the reference_voltage (default is 3.3v). -It calculates the voltage by multplying the reference_voltage * value on the pin (basically the percentage of VREF) +It calculates the voltage by multiplying the reference_voltage * value on the pin (basically the percentage of VREF) Most configurations will set the reference_voltage = VREF (pin 13 on the chip) diff --git a/components/sensor/nextion.rst b/components/sensor/nextion.rst index e936f9541..465c2fd36 100644 --- a/components/sensor/nextion.rst +++ b/components/sensor/nextion.rst @@ -127,7 +127,7 @@ How things Update A Nextion component with an integer value (.val) or Nextion variable will be automatically polled if **update_interval** is set. To have the Nextion send the data you can use the :ref:`nextion_custom_sensor_protocol` for this. Add the :ref:`nextion_custom_sensor_protocol` to the component or function you want to trigger the send. Typically this is in *Touch Press Event* but some components, like a slider, should have it -set in the *Touch Release Event* to capture all the changes. Since this is a custom protocol it can be sent from anywhere (timers/functions/componenets) +set in the *Touch Release Event* to capture all the changes. Since this is a custom protocol it can be sent from anywhere (timers/functions/components) in the Nextion. .. note:: diff --git a/components/sensor/qmc5883l.rst b/components/sensor/qmc5883l.rst index 75d1bd447..25dadb92a 100644 --- a/components/sensor/qmc5883l.rst +++ b/components/sensor/qmc5883l.rst @@ -9,7 +9,7 @@ QMC5883L Magnetometer The ``qmc5883l`` allows you to use your QMC5883L triple-axis magnetometers (`datasheet `__) with ESPHome. This sensor is very simular to the :ref:`HMC5883L ` sensor and is oftern found -as a knock off replacement. The QMC5883L sensor preforms on par to the HMC5883L sensor, +as a knock off replacement. The QMC5883L sensor performs on par to the HMC5883L sensor, though the congiuration differs. The :ref:`I²C Bus ` is required to be set up in your configuration for this sensor to work. diff --git a/components/sensor/ruuvitag.rst b/components/sensor/ruuvitag.rst index 9b98a9462..999262ec0 100644 --- a/components/sensor/ruuvitag.rst +++ b/components/sensor/ruuvitag.rst @@ -139,9 +139,9 @@ Configuration variables: - Only available if RAWv2 protocol is used. - **measurement_sequence_number** (*Optional*): The information for the - measurment sequence number sensor + measurement sequence number sensor - - **name** (**Required**, string): The name for the measurment sequence + - **name** (**Required**, string): The name for the measurement sequence number sensor. - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. diff --git a/components/sensor/teleinfo.rst b/components/sensor/teleinfo.rst index d39c4c65e..8bedb8fb0 100644 --- a/components/sensor/teleinfo.rst +++ b/components/sensor/teleinfo.rst @@ -94,7 +94,7 @@ Configuration variables: In teleinfo platform: -- **historical_mode** (*Optional*): Wether to use historical mode or standard mode. +- **historical_mode** (*Optional*): Whether to use historical mode or standard mode. With historical mode, baudrate of 1200 must be used whereas 9600 must be used in standard mode. Defaults to ``False``. diff --git a/components/sensor/tmp102.rst b/components/sensor/tmp102.rst index 0f61b657d..96f0e1ac5 100644 --- a/components/sensor/tmp102.rst +++ b/components/sensor/tmp102.rst @@ -34,7 +34,7 @@ Configuration variables: - **name** (**Required**, string): The name for the temperature sensor. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. -- **address** (*Optional*, int): The I²C address of the sensor. Defauls to ``0x48``. +- **address** (*Optional*, int): The I²C address of the sensor. Defaults to ``0x48``. See :ref:`I²C Addresses ` for more information. - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor `. diff --git a/components/switch/nextion.rst b/components/switch/nextion.rst index 9801946e4..6a4c3ff73 100644 --- a/components/switch/nextion.rst +++ b/components/switch/nextion.rst @@ -37,7 +37,7 @@ Configuration variables: - **name** (**Required**, string): The name of the sensor. - **nextion_id** (*Optional*, :ref:`config-id`): The ID of the Nextion display. - **component_name** (*Optional*, string): The name of the Nextion component. -- **variable_name** (*Optional*, string): The name of the Nextion variable. Any value over ``0`` is considerd to be **on** +- **variable_name** (*Optional*, string): The name of the Nextion variable. Any value over ``0`` is considered to be **on** - **update_interval** (*Optional*, :ref:`config-time`): The duration to update the sensor. If using a :ref:`nextion_custom_switch_protocol` this should not be used - **background_color** (*Optional*, :ref:`config-color`): The background color - **background_pressed_color** (*Optional*, :ref:`config-color`): The background color when pressed @@ -92,7 +92,7 @@ How things Update A Nextion component with an integer value (.val) or Nextion variable will be automatically polled if **update_interval** is set. To have the Nextion send the data you can use the :ref:`nextion_custom_switch_protocol` for this. Add the :ref:`nextion_custom_switch_protocol` to the component or function you want to trigger the send. Typically this is in *Touch Press Event* but some components, like a slider, should have it -set in the *Touch Release Event* to capture all the changes. Since this is a custom protocol it can be sent from anywhere (timers/functions/componenets) +set in the *Touch Release Event* to capture all the changes. Since this is a custom protocol it can be sent from anywhere (timers/functions/components) in the Nextion. .. note:: diff --git a/components/tca9548a.rst b/components/tca9548a.rst index 502c08d54..89db0f7bf 100644 --- a/components/tca9548a.rst +++ b/components/tca9548a.rst @@ -9,7 +9,7 @@ The TCA9548A component allows you to use TCA9548A as a I²C multiplexer (`datasheet `__, `AdaFruit`_) in ESPHome. It uses :ref:`I²C Bus ` for communication. -Once configured, you can use any of the 8 channels (TCA9548A) as seperated channels for your projects. +Once configured, you can use any of the 8 channels (TCA9548A) as separated channels for your projects. .. figure:: images/tca9548a.jpg diff --git a/components/text_sensor/nextion.rst b/components/text_sensor/nextion.rst index d4891d7e2..ead7724c9 100644 --- a/components/text_sensor/nextion.rst +++ b/components/text_sensor/nextion.rst @@ -35,7 +35,7 @@ Configuration variables: - **name** (**Required**, string): The name of the sensor. - **nextion_id** (*Optional*, :ref:`config-id`): The ID of the Nextion display. - **component_name** (*Optional*, string): The name of the Nextion component. -- **variable_name** (*Optional*, string): The name of the Nextion variable. Any value over ``0`` is considerd to be **on** +- **variable_name** (*Optional*, string): The name of the Nextion variable. Any value over ``0`` is considered to be **on** - **update_interval** (*Optional*, :ref:`config-time`): The duration to update the sensor. If using a :ref:`nextion_custom_text_sensor_protocol` this should not be used - **background_color** (*Optional*, :ref:`config-color`): The background color - **foreground_color** (*Optional*, :ref:`config-color`): The foreground color @@ -86,7 +86,7 @@ How things Update A Nextion component with an integer value (.val) or Nextion variable will be automatically polled if **update_interval** is set. To have the Nextion send the data you can use the :ref:`nextion_custom_text_sensor_protocol` for this. Add the :ref:`nextion_custom_text_sensor_protocol` to the component or function you want to trigger the send. Typically this is in *Touch Press Event* but some components, like a slider, should have it -set in the *Touch Release Event* to capture all the changes. Since this is a custom protocol it can be sent from anywhere (timers/functions/componenets) +set in the *Touch Release Event* to capture all the changes. Since this is a custom protocol it can be sent from anywhere (timers/functions/components) in the Nextion. .. note:: diff --git a/components/time.rst b/components/time.rst index 9d61eb48a..36be7588f 100644 --- a/components/time.rst +++ b/components/time.rst @@ -239,7 +239,7 @@ Configuration variables: Due to limitations of the SNTP implementation, this component will trigger ``on_time_sync`` only once when it detects that the system clock has been set, even if the update was not done by the SNTP implementation! - This must be taken into consideration when SNTP is used together with other real time componnents, where another time source could + This must be taken into consideration when SNTP is used together with other real time components, where another time source could update the time before SNTP synchronizes. GPS Time Source @@ -326,7 +326,7 @@ In a typical setup, you will have at least one additional time source to synchro external time source might not always be available e.g. due to a limited network connection. In order to have a valid, reliable system time, the system should read the RTC once at start and then try to synchronize with an external reliable time source. -When a synchronization to another time source was successfull, the RTC can be resynchronized. +When a synchronization to another time source was successful, the RTC can be resynchronized. .. code-block:: yaml diff --git a/components/wifi.rst b/components/wifi.rst index 366a7c97e..fb2570a0b 100644 --- a/components/wifi.rst +++ b/components/wifi.rst @@ -62,7 +62,7 @@ Configuration variables: - **ap_timeout** (*Optional*, :ref:`time `): The time after which to enable the configured fallback hotspot. Defaults to ``1min``. -- **enable_mdns** (*Optional*, boolean): Controls if your node should advertise its presense and services using mDNS. When set to ``false`` you won't be able to access your node using its hostname which can break certain functionalities. Please see :ref:`notes on disabling mDNS `. Defaults to ``true``. +- **enable_mdns** (*Optional*, boolean): Controls if your node should advertise its presence and services using mDNS. When set to ``false`` you won't be able to access your node using its hostname which can break certain functionalities. Please see :ref:`notes on disabling mDNS `. Defaults to ``true``. - **domain** (*Optional*, string): Set the domain of the node hostname used for uploading. For example, if it's set to ``.local``, all uploads will be sent to ``.local``. Defaults to ``.local``. diff --git a/cookbook/ble_itag.rst b/cookbook/ble_itag.rst index f00270659..cbffa953c 100644 --- a/cookbook/ble_itag.rst +++ b/cookbook/ble_itag.rst @@ -71,7 +71,7 @@ Configuration example: state: OFF # This entry queries the battery level. Some tags may not # support this characteristic, you will see 'Unknown' in the - # HA frontent. + # HA frontend. - platform: ble_client ble_client_id: itag_black name: "Black iTag Battery" diff --git a/cookbook/infostrip.rst b/cookbook/infostrip.rst index 8cb5163e6..ec6c1d9a3 100644 --- a/cookbook/infostrip.rst +++ b/cookbook/infostrip.rst @@ -9,7 +9,7 @@ Infostripe Showing the current status of sensor states using a Neopixel (WS2812B) strip is a simple way to communicate states to the user. Compared to a dashboard screen the infostrip can only communicate the information like a binary sensor. -- color (e.g., red = error/warning, orange = waring, green = ok, blue = active) +- color (e.g., red = error/warning, orange = warning, green = ok, blue = active) - intensity (off, scaled brightness) - mode (continuous vs. flashing, flashing or strobe is not recommend) - light position on stripe diff --git a/guides/contributing.rst b/guides/contributing.rst index c1db3d796..48b0cdbe5 100644 --- a/guides/contributing.rst +++ b/guides/contributing.rst @@ -33,7 +33,7 @@ Syntax Here's a quick RST primer: -Title hierarchy is based on order of occurence, not on type of character used to underline it. This +Title hierarchy is based on order of occurrence, not on type of character used to underline it. This documents establish the following character order for better consistency. - **Headers**: You can write titles like this: diff --git a/schema_doc.py b/schema_doc.py index 44af1e909..cc07f587f 100644 --- a/schema_doc.py +++ b/schema_doc.py @@ -234,11 +234,11 @@ class SchemaGeneratorVisitor(nodes.NodeVisitor): self.props_level = 0 def visit_document(self, node): - # ESPHome page docs follows strict formating guidelines which allows + # ESPHome page docs follows strict formatting guidelines which allows # for docs to be parsed directly into yaml schema if self.docname in ["components/sensor/binary_sensor_map"]: - # temporarly not supported + # temporarily not supported raise nodes.SkipChildren if len(list(node.traverse(nodes.paragraph))) == 0: @@ -349,7 +349,7 @@ class SchemaGeneratorVisitor(nodes.NodeVisitor): if title_text == CONFIGURATION_VARIABLES: if not self.props and self.multi_component is None: raise ValueError( - f'Found a "{CONFIGURATION_VARIABLES}": title after {self.previous_title_text}. Unkown object.' + f'Found a "{CONFIGURATION_VARIABLES}": title after {self.previous_title_text}. Unknown object.' ) if title_text == "Over SPI" or title_text == "Over I²C": @@ -645,7 +645,7 @@ class SchemaGeneratorVisitor(nodes.NodeVisitor): self.prop_stack.append(self.props) self.props = self.find_props(ref) else: - # TODO: if the list items are formated like: + # TODO: if the list items are formatted like: # - ``value`` # - ``other value`` # then we could ensure these are enum values (or populate enum values double check.) @@ -798,7 +798,7 @@ class SchemaGeneratorVisitor(nodes.NodeVisitor): k = str(prop_name) jprop = props.get(k) if not jprop: - # Create docs for common properties when descriptions are overriden + # Create docs for common properties when descriptions are overridden # in the most specific component. if k in [ @@ -812,7 +812,7 @@ class SchemaGeneratorVisitor(nodes.NodeVisitor): "update_interval", # uart "uart_id", - # ligth + # light "effects", "gamma_correct", "default_transition_length",