Skip to content

Commit

Permalink
Fix typos (esphome#561)
Browse files Browse the repository at this point in the history
  • Loading branch information
mje-nz authored May 10, 2020
1 parent 684f0a4 commit 9b6170a
Show file tree
Hide file tree
Showing 91 changed files with 345 additions and 345 deletions.
2 changes: 1 addition & 1 deletion components/binary_sensor/ble_presence.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ESP32 Bluetooth Low Energy Device
:image: bluetooth.png

The ``ble_presence`` binary sensor platform lets you track the presence of a
bluetooth low energy device.
Bluetooth Low Energy device.

.. figure:: images/esp32_ble-ui.png
:align: center
Expand Down
6 changes: 3 additions & 3 deletions components/binary_sensor/homeassistant.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Homeassistant Binary Sensor
===========================
Home Assistant Binary Sensor
============================

.. seo::
:description: Instructions for setting up homeassistant binary sensors with ESPHome that import states from your homeassistant instance.
:description: Instructions for setting up Home Assistant binary sensors with ESPHome that import states from your Home Assistant instance.
:image: home-assistant.png

The ``homeassistant`` binary sensor platform allows you to create binary sensors that **import**
Expand Down
6 changes: 3 additions & 3 deletions components/binary_sensor/mpr121.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ MPR121 Capacitive Touch Sensor

The ``mpr121`` sensor platform allows you to use your MPR121
(`datasheet <https://cdn-learn.adafruit.com/downloads/pdf/adafruit-mpr121-12-key-capacitive-touch-sensor-breakout-tutorial.pdf>`__,
`Adafruit`_) Capacitive Touch Sensor with esphomelib. The :ref:`I²C <i2c>` is
`Adafruit`_) Capacitive Touch Sensor with ESPHome. The :ref:`I²C <i2c>` is
required to be set up in your configuration for this sensor to work.

.. figure:: images/mpr121-full.jpg
Expand Down Expand Up @@ -45,7 +45,7 @@ The configuration is made up of two parts: The central component, and individual

Base Configuration:

- **address** (*Optional*, integer): The i2c address of the sensor. Defaults to ``0x5A``.
- **address** (*Optional*, integer): The I^2C address of the sensor. Defaults to ``0x5A``.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor.
- **touch_debounce** (*Optional*, integer): The minimum length before a touch is recognized. Range is from 0 to 7.
Defaults to 0.
Expand All @@ -59,7 +59,7 @@ Binary Sensor Configuration:

- **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>`.
Expand Down
6 changes: 3 additions & 3 deletions components/binary_sensor/pn532.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Component/Hub
-------------

The ``pn532`` component allows you to use PN532 NFC/RFID controllers
(`datasheet <https://cdn-shop.adafruit.com/datasheets/pn532ds.pdf>`__, `adafruit <https://www.adafruit.com/product/364>`__)
(`datasheet <https://cdn-shop.adafruit.com/datasheets/pn532ds.pdf>`__, `Adafruit <https://www.adafruit.com/product/364>`__)
with ESPHome. This component is a global hub that establishes the connection to the PN532 via :ref:`SPI <spi>` and
outputs its data. Using the :ref:`PN532 binary sensors <pn532-tag>` you can then
create individual binary sensors that track if an NFC/RFID tag is currently detected by the PN532.
Expand All @@ -25,7 +25,7 @@ See :ref:`pn532-setting_up_tags` for information on how to setup individual bina

As the communication with the PN532 is done using SPI for this integration, you need to set the two switches on
the board to the SPI mode (usually by setting the first one to OFF and the second one to ON). Additionally, you need
to have an :ref:`spi bus <spi>` in your configuration with both the **miso_pin** and **mosi_pin** set.
to have an :ref:`SPI bus <spi>` in your configuration with both the **miso_pin** and **mosi_pin** set.

.. code-block:: yaml
Expand Down Expand Up @@ -126,7 +126,7 @@ Setting Up Tags
---------------

To set up binary sensors for specific NFC tags you first have to know their unique IDs. To obtain this
id, first set up a simple pn532 configuration without any binary sensors like above.
id, first set up a simple PN532 configuration without any binary sensors like above.

When your code is running and you approach the PN532 with an NFC Tag, you should see a message like this:

Expand Down
4 changes: 2 additions & 2 deletions components/binary_sensor/ttp229.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Base Configuration:
Binary Sensor Configuration:

- **name** (**Required**, string): The name of the binary sensor.
- **channel** (**Required**, integer): The channel number at the ttp229 the touchkey is connected to.
- **channel** (**Required**, integer): The channel number at the TTP229 the touchkey is connected to.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.

Expand Down Expand Up @@ -82,7 +82,7 @@ Base Configuration:
Binary Sensor Configuration:

- **name** (**Required**, string): The name of the binary sensor.
- **channel** (**Required**, integer): The channel number at the ttp229 the touchkey is connected to.
- **channel** (**Required**, integer): The channel number at the TTP229 the touchkey is connected to.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.

Expand Down
2 changes: 1 addition & 1 deletion components/captive_portal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Captive Portal
The captive portal component in ESPHome is a fallback mechanism for when connecting to the
configured :doc:`WiFi <wifi>` fails.

After 1 minute of unsuccesful wifi connection attempts, the ESP will start a WiFi hotspot
After 1 minute of unsuccessful WiFi connection attempts, the ESP will start a WiFi hotspot
(with the credentials from your configuration)

.. figure:: images/captive_portal-ui.png
Expand Down
6 changes: 3 additions & 3 deletions components/climate/tcl112.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Tcl112 Remote Climate
TCL112 Remote Climate
=====================

.. seo::
:description: Controls a Tcl112 compatible Climate via IR
:description: Controls a TCL112-compatible Climate via IR
:image: air-conditioner.png

The ``tcl112`` climate platform allows you to control a TCL112 compatible AC unit by sending IR signals
The ``tcl112`` climate platform allows you to control a TCL112-compatible AC unit by sending IR signals
as your remote unit would do.

This component requires that you have setup a :doc:`/components/remote_transmitter`.
Expand Down
2 changes: 1 addition & 1 deletion components/cover/time_based.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Configuration variables:
be performed to stop the cover when the remote requests the cover to be stopped or
when the cover has been opening/closing for the given durations.
- **has_built_in_endstop** (*Optional*, boolean): Indicates that the cover has built in end stop
detectors. In this configuration the ``stop_action`` is not perfomed when the open or close
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``.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
Expand Down
8 changes: 4 additions & 4 deletions components/display/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,8 @@ Drawing Static Text
*******************

The rendering engine also has a powerful font drawer which integrates seamlessly into ESPHome.
Whereas in most arduino display projects you have to use one of a few pre-defined fonts in very
specific sizes, with ESPHome you have the option to use **any** truetype (``.ttf``) font file
Whereas in most Arduino display projects you have to use one of a few pre-defined fonts in very
specific sizes, with ESPHome you have the option to use **any** TrueType (``.ttf``) font file
at **any** size! Granted the reason for it is actually not having to worry about the licensing of font files :)

To use fonts you first have to define a font object in your ESPHome configuration file. Just grab
Expand All @@ -149,7 +149,7 @@ a ``.ttf`` file from somewhere on the Internet and create a ``font:`` section in
Configuration variables:

- **file** (**Required**, string): The path (relative to where the .yaml file is) of the truetype font
- **file** (**Required**, string): The path (relative to where the .yaml file is) of the TrueType font
file.
- **id** (**Required**, :ref:`config-id`): The ID with which you will be able to reference the font later
in your display code.
Expand All @@ -165,7 +165,7 @@ Configuration variables:
.. note::

To use fonts you will need to have the python ``pillow`` package installed, as ESPHome uses that package
to translate the truetype files into an internal format. If you're running this as a Hass.io add-on or with
to translate the TrueType files into an internal format. If you're running this as a Hass.io add-on or with
the official ESPHome docker image, it should already be installed. Otherwise you need to install it using
``pip install pillow``.

Expand Down
4 changes: 2 additions & 2 deletions components/display/lcd_display.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,8 @@ The backlight can draw more power than the microcontroller output pins can suppl
a transistor as a switch to control the power for the backlight pins.

With the ``lcd_pcf8574`` the backlight can be turned on by ``it.backlight()`` and off by ``it.no_backlight()`` in the
display lamdba definition. The jumper on the PCF8574 board needs to be closed for the backlight control to work.
Keep in mind that the display lamda runs for every ``update_interval``, so if the backlight is turned on/off there,
display lambda definition. The jumper on the PCF8574 board needs to be closed for the backlight control to work.
Keep in mind that the display lambda runs for every ``update_interval``, so if the backlight is turned on/off there,
it cannot be overridden from other parts.

Here is one solution for a typical use-case where the backlight is turned on after a motion sensor activates and
Expand Down
4 changes: 2 additions & 2 deletions components/display/ssd1306.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Configuration variables:
- **address** (*Optional*, int): Manually specify the :ref:`I²C <i2c>` address of the display. Defaults to 0x3C.
- **rotation** (*Optional*): Set the rotation of the display. Everything you draw in ``lambda:`` will be rotated
by this option. One of ```` (default), ``90°``, ``180°``, ``270°``.
- **brigthness** (*Optional*): Set the screen brightness in percents 0.0-1.0. Defaults to `1.0` that coresponds to 100%.
- **brightness** (*Optional*): Set the screen brightness in percents 0.0-1.0. Defaults to `1.0` that corresponds to 100%.
- **external_vcc** (*Optional*, boolean): Set this to true if you have the VCC pin connected to an external power supply.
Defaults to ``false``.
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`): The lambda to use for rendering the content on the display.
Expand All @@ -73,7 +73,7 @@ Configuration variables:

.. note::

To speed up the display update process you can select higher i2c frequencies.
To speed up the display update process you can select higher I²C frequencies.

.. _ssd1306-spi:

Expand Down
2 changes: 1 addition & 1 deletion components/esp32_ble_beacon.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ change the UUID to something unique. For example, you can copy this randomly gen
Then, just compile and flash the ESP32.

When everything is set up correctly, you should see a show up using your iBeacon scanner of choice. On iPhones,
this should already work from the bluetooth screen (not tested), on Android, you will need to use an app like
this should already work from the Bluetooth screen (not tested), on Android, you will need to use an app like
`"Beacon Scanner" <https://play.google.com/store/apps/details?id=com.bridou_n.beaconscanner>`__ by Nicolas Bridoux.

For using these beacons to track the location of your phone, you will need to use another app. For example, I used
Expand Down
8 changes: 4 additions & 4 deletions components/esp32_camera.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Configuration variables:
Connection Options:

- **data_pins** (**Required**, list of pins): The data lanes of the camera, this must be a list
of 8 gpio pins.
of 8 GPIO pins.
- **vsync_pin** (**Required**, pin): The pin the VSYNC line of the camera is connected to.
- **href_pin** (**Required**, pin): The pin the HREF line of the camera is connected to.
- **pixel_clock_pin** (**Required**, pin): The pin the pixel clock line of the camera is connected to.
Expand All @@ -45,10 +45,10 @@ Connection Options:
- **frequency** (*Optional*, float): The frequency of the external clock, must be either 20MHz
or 10MHz. Defaults to ``20MHz``.

- **i2c_pins** (**Required**): The i2c control pins of the camera.
- **i2c_pins** (**Required**): The I^2C control pins of the camera.

- **sda** (**Required**, pin): The SDA pin of the i2c interface. Also called ``SIOD``.
- **scl** (**Required**, pin): The SCL pin of the i2c interface. Also called ``SIOC``.
- **sda** (**Required**, pin): The SDA pin of the I^2C interface. Also called ``SIOD``.
- **scl** (**Required**, pin): The SCL pin of the I^2C interface. Also called ``SIOC``.

- **reset_pin** (*Optional*, pin): The ESP pin the reset pin of the camera is connected to.
If set, this will reset the camera before the ESP boots.
Expand Down
34 changes: 17 additions & 17 deletions components/esphome.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,25 +23,25 @@ Configuration variables:
------------------------

- **name** (**Required**, string): This is the name of the node. It
should always be unique in your esphome network. May only contain lowercase
should always be unique in your ESPhome network. May only contain lowercase
characters, digits and underscores. See :ref:`esphome-changing_node_name`.
- **platform** (**Required**, string): The platform your board is on,
either ``ESP32`` or ``ESP8266``. See :ref:`esphome-arduino_version`.
- **board** (**Required**, string): The board ESPHome should
specify for platformio. For the ESP32, choose the appropriate one
specify for PlatformIO. For the ESP32, choose the appropriate one
from `this list <http://docs.platformio.org/en/latest/platforms/espressif32.html#boards>`__
and use `this list <http://docs.platformio.org/en/latest/platforms/espressif8266.html#boards>`__
for ESP8266-based boards. *This only affects pin aliases and some internal settings*, if unsure
choose the generic board option!

Advanced options:

- **arduino_version** (*Optional*): The version of the arduino framework to link the project against.
- **arduino_version** (*Optional*): The version of the Arduino framework to link the project against.
See :ref:`esphome-arduino_version`.
- **build_path** (*Optional*, string): Customize where ESPHome will store the build files
for your node. By default, ESPHome puts all platformio project files under a folder ``<NODE_NAME>/``,
for your node. By default, ESPHome puts all PlatformIO project files under a folder ``<NODE_NAME>/``,
but you can customize this behavior using this option.
- **platformio_options** (*Optional*, mapping): Additional options to pass over to platformio in the
- **platformio_options** (*Optional*, mapping): Additional options to pass over to PlatformIO in the
platformio.ini file. See :ref:`esphome-platformio_options`.
- **use_custom_code** (*Optional*, boolean): Whether to configure the project for writing custom components.
This sets up some flags so that custom code should compile correctly
Expand Down Expand Up @@ -71,10 +71,10 @@ Automations:
``arduino_version``
-------------------

ESPHome uses the arduino framework internally to handle all low-level interactions like
initializing the WiFi driver and so on. Unfortunately, every arduino framework version often
ESPHome uses the Arduino framework internally to handle all low-level interactions like
initializing the WiFi driver and so on. Unfortunately, every Arduino framework version often
has its own quirks and bugs, especially concerning WiFi performance. With the ``arduino_version``
option you can tell ESPHome which arduino framework to use for compiling.
option you can tell ESPHome which Arduino framework to use for compiling.

.. code-block:: yaml
Expand All @@ -94,8 +94,8 @@ option you can tell ESPHome which arduino framework to use for compiling.
# Use a specific version
arduino_version: 2.3.0
For the ESP8266, you currently can manually pin the arduino version to these values (see the full
list of arduino frameworks `here <https://github.com/esp8266/Arduino/releases>`__):
For the ESP8266, you currently can manually pin the Arduino version to these values (see the full
list of Arduino frameworks `here <https://github.com/esp8266/Arduino/releases>`__):

* `2.5.2 <https://github.com/esp8266/Arduino/releases/tag/2.5.2>`__
* `2.5.1 <https://github.com/esp8266/Arduino/releases/tag/2.5.1>`__
Expand All @@ -105,7 +105,7 @@ list of arduino frameworks `here <https://github.com/esp8266/Arduino/releases>`_
* `2.4.0 <https://github.com/esp8266/Arduino/releases/tag/2.4.0>`__
* `2.3.0 <https://github.com/esp8266/Arduino/releases/tag/2.3.0>`__ (used by Tasmota etc)

For the ESP32, there are these arduino `framework versions <https://github.com/espressif/arduino-esp32/releases>`__:
For the ESP32, there are these Arduino `framework versions <https://github.com/espressif/arduino-esp32/releases>`__:

- `1.0.2 <https://github.com/espressif/arduino-esp32/releases/tag/1.0.2>`__
- `1.0.1 <https://github.com/espressif/arduino-esp32/releases/tag/1.0.1>`__ (default)
Expand Down Expand Up @@ -153,7 +153,7 @@ is already set up. You can however change this using the ``priority`` parameter.
Configuration variables:

- **priority** (*Optional*, float): The priority to execute your custom initialization code. A higher value
means a high priority and thus also your code being executed earlier. Please note this is an esphome-internal
means a high priority and thus also your code being executed earlier. Please note this is an ESPhome-internal
value and any change will not be marked as a breaking change. Defaults to ``-10``. Priorities (you can use any value between them too):

- ``800.0``: This is where all hardware initialization of vital components is executed. For example setting switches
Expand Down Expand Up @@ -208,11 +208,11 @@ This automation will be triggered on every ``loop()`` iteration (usually around
``platformio_options``
----------------------

Platformio supports a number of options in its ``platformio.ini`` file. With the ``platformio_options``
parameter you can tell ESPHome what options to pass into the ``env`` section of the platformio file
PlatformIO supports a number of options in its ``platformio.ini`` file. With the ``platformio_options``
parameter you can tell ESPHome what options to pass into the ``env`` section of the PlatformIO file
(Note you can also do this by editing the ``platformio.ini`` file manually).

You can view a full list of platformio options here: https://docs.platformio.org/en/latest/projectconf/section_env.html
You can view a full list of PlatformIO options here: https://docs.platformio.org/en/latest/projectconf/section_env.html

.. code-block:: yaml
Expand All @@ -228,10 +228,10 @@ You can view a full list of platformio options here: https://docs.platformio.org
``includes``
------------

With ``includes`` you can include source files in the generated platformio project.
With ``includes`` you can include source files in the generated PlatformIO project.
All files declared with this option are copied to the project each time it is compiled.

You can always look at the generated platformio project (``<CONFIG_DIR>/<NODENAME>``) to see what
You can always look at the generated PlatformIO project (``<CONFIG_DIR>/<NODENAME>``) to see what
is happening - and if you want you can even copy the include files directly into the ``src/`` folder.
The ``includes`` option is only a helper option that does that for you.

Expand Down
2 changes: 1 addition & 1 deletion components/light/tuya.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ the config and it will list the possible devices for you in the config log.
.. code-block:: yaml
# Example configuration entry
# Make sure your wifi will connect
# Make sure your WiFi will connect
wifi:
ssid: "ssid"
password: "password"
Expand Down
2 changes: 1 addition & 1 deletion components/logger.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Possible log levels are (sorted by severity):
- ``VERY_VERBOSE``

- All internal messages are logged. Including all the data flowing through data buses like
i2c, spi or uart. Warning: May cause the device to slow down and have trouble staying
I2C, SPI or UART. Warning: May cause the device to slow down and have trouble staying
connecting due to amount of generated messages. Color: white

.. _logger-manual_tag_specific_levels:
Expand Down
Loading

0 comments on commit 9b6170a

Please sign in to comment.