Upstream
/
esphome-docs
mirror of https://github.com/esphome/esphome-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Proof reading changes (#364) 

* Small changes from proofreading.

* Proofreading changes.

* Correction from travis checks

* Update guides/getting_started_command_line.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* More proofreading changes.

* More proofreading changes.

* Minor corrections
This commit is contained in:
thenameiwantedwastaken 2019-10-18 18:22:48 +11:00 committed by Otto Winter
parent 545a4c998c
commit 075d88444e
12 changed files with 94 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
components/esphome.rst
View File

@ -247,7 +247,7 @@ This option behaves differently depending on what the included file is pointing
to the src/ folder.
- If the include string is point at a header file (.h, .hpp, .tcc) - it is copied in the src/ folder
AND included in the main.cpp. This way the lambda code can access it.
- If the include str
.. _esphome-changing_node_name:

4
devices/esp32.rst
View File

@ -26,10 +26,10 @@ Some notes about the pins on the ESP32:
- ``GPIO0`` is used to determine the boot mode on startup. It should therefore not be pulled LOW
on startup to avoid booting into flash mode. You can, however, still use this as an output pin.
- ``GPIO34``-``GPIO39`` can not be used as outputs (even though GPIO stands for "general purpose input
**output**"...)
**output**"...).
- ``GPIO32``-``GPIO39``: These pins can be used with the :doc:`/components/sensor/adc` to measure
voltages.
- ``GPIO2``: This pin is connected to the blue LED on the board as seen in above picture. It also supports
- ``GPIO2``: This pin is connected to the blue LED on the board. It also supports
the :doc:`touch pad binary sensor </components/binary_sensor/esp32_touch>` like some other
pins.

4
devices/esp8266.rst
View File

@ -31,7 +31,7 @@ Some notes on the pins:
- ``GPIO6`` - ``GPIO11``, ``GPIO0``, ``GPIO2`` and ``GPIO15`` are often already used by the internal
flash interface and boot mode detection. So it's best to avoid using these pins.
- ``GPIO17`` additionally has an ADC connected to it. See the :doc:`/components/sensor/adc`
to read out voltages (in the range from 0 to 1.0V) on this pin.
to read voltages (in the range from 0 to 1.0V) on this pin.
.. code-block:: yaml
@ -139,7 +139,7 @@ in the ``boot mode:`` line tells you what mode was selected
ets Jan 8 2013,rst cause:4, boot mode:(3,6)
The first lines when viewing the UART logs might have unrecognized characters. This is
because the ESP8266 bootloader uses a baudrate of 76800, whereas the use program uses 115200.
because the ESP8266 bootloader uses a baudrate of 76800, whereas the program uses 115200.
Reset Causes
------------

10
devices/nodemcu_esp32.rst
View File

@ -28,17 +28,17 @@ you don't have to worry about other kinds of pin numberings, yay!
Pins on the NodeMCU ESP32 development board.
Note that in certain conditions you *can* use the pins marked as ``INTERNAL`` in above image.
Note that in certain conditions you *can* use the pins marked as ``INTERNAL`` in the above image.
- ``GPIO0`` is used to determine the boot mode on startup. It should therefore not be pulled LOW
on startup to avoid booting into flash mode. You can, however, still use this as an output pin.
- ``GPIO34``-``GPIO39`` can not be used as outputs (even though GPIO stands for "general purpose input
**output**"...)
**output**"...).
- ``GPIO32``-``GPIO39``: These pins can be used with the :doc:`/components/sensor/adc` to measure
voltages.
- ``GPIO2``: This pin is connected to the blue LED on the board as seen in above picture. It also supports
the :doc:`touch pad binary sensor </components/binary_sensor/esp32_touch>` like some other
pins.
- ``GPIO2``: This pin is connected to the blue LED on the board as seen in the picture above. It also supports
the :doc:`touch pad binary sensor </components/binary_sensor/esp32_touch>` as do the other
pins marked ``touch`` in the above image.
- ``5V`` is connected to the 5V rail from the USB bus and can be used to power the board. Note that
the UART chip is directly connected to this rail and you therefore **cannot** supply other voltages
into this pin.

8
devices/nodemcu_esp8266.rst
View File

@ -11,7 +11,7 @@ the ESPHome wizard asks you for your platform and |nodemcuv2|_ as the board type
.. note::
Most NodeMCU that can be purchased now are version 2 or upwards, if you're using an
Most NodeMCU that can be purchased now are version 2 or upwards. If you're using an
original v1 board, set the board type to |nodemcu|_.
.. |nodemcuv2| replace:: ``nodemcuv2``
@ -30,8 +30,8 @@ the ESPHome wizard asks you for your platform and |nodemcuv2|_ as the board type
The NodeMCU's pin numbering as seen on the board (the ``D0`` etc pins) is different from
the internal pin numbering. For example, the ``D8`` pin number maps to the internal
``GPIO0`` pin. Fortunately ESPHome knows the mapping from the on-board pin numbers
to the internal pin numbering, but you need to prefix the pin numbers with ``D`` as in below
image in order for this automatic mapping to occur.
to the internal pin numbering, but you need to prefix the pin numbers with ``D`` as in
the image below in order for this automatic mapping to occur.
In general, it is best to just use the ``D0``, ``D1``, ... pin numbering to avoid confusion
@ -52,7 +52,7 @@ Note that in certain conditions you *can* use the pins marked as ``INTERNAL`` in
- ``VIN``: This pin can be used to use an external power supply with the board. Supply a voltage from
3.3V to 12V to this pin and the linear voltage regulator on the board will power the board.
- ``ENABLE``/``RESET``: When these pins are triggered, the board resets. The difference between the pins
is how they can handle voltages above 3.3V
is how they can handle voltages above 3.3V.
.. code-block:: yaml

32
devices/sonoff_4ch.rst
View File

@ -21,7 +21,7 @@ Over-The-Air update process.
.. note::
If you've previously installed Sonoff-Tasmota on your Sonoff 4CH, you're in luck 😀
If you've previously installed Sonoff-Tasmota on your Sonoff 4CH, you're in luck 😀.
ESPHome can generate a firmware binary which you can then upload via the
Tasmota web interface. To see how to create this binary, skip to :ref:`sonoff_4ch-creating_firmware`.
@ -33,9 +33,9 @@ interface.
.. warning::
Opening up this device can be very dangerous if not done correctly. While the device is open,
you will be a single touch away from being electrocuted if the device is plugged in.
you will be a single touch away from being electrocuted if the device is plugged in or connected to a high voltage 'mains' power supply.
So, during this *entire* guide **never ever** plug the device in. Also, you should only do this
So, during this *entire* guide **never ever** plug the device in or have it connected to mains power. Also, you should only do this
if you know what you're doing. If you, at any step, feel something is wrong or are uncomfortable
with continuing, it's best to just stop for your own safety.
@ -43,12 +43,12 @@ interface.
For this guide you will need:
- Sonoff 4CH 😉
- An USB to UART Bridge for flashing the device. These can be bought on Amazon for less than 5 dollars.
- Sonoff 4CH 😉.
- A USB to UART Bridge for flashing the device. These can be bought on Amazon (or other online stores) for less than 5 dollars.
Note that the bridge *must* be 3.3V compatible. Otherwise you will destroy your Sonoff.
- Jumper wires to connect the UART bridge to the header pins.
- Computer running ESPHome or Hass.io add-on.
- Screwdriver to open up the Sonoff 4CH.
- A computer running Home Assistant with the ESPHome Hass.io add-on.
- A screwdriver to open up the Sonoff 4CH.
Have everything? Great! Then you can start.
@ -62,7 +62,7 @@ supplied with the Sonoff 4CH before doing this step.
.. warning::
Just to repeat this: Make **absolutely sure** the device is not connected to any appliance or
plugged in before doing this step.
connected to mains power before doing this step.
While the device is not plugged in, turn the device so you are viewing it from the top,
then unscrew the long screws in the four corners of the top cover.
@ -92,7 +92,7 @@ have to connect the four wires on the UART to USB bridge to the UART pins of the
Fortunately for us, exactly these pins come pre-populated with a few header pins. You can identify
these by the ``VCC33``, ``RX``, ``TX`` and ``GND`` markings on the silk-screen.
Now go ahead and connect these pins to your UART to USB bridge as seen in below image. Make sure
Now go ahead and connect these pins to your UART to USB bridge as seen in the below image. Make sure
that you connect these correctly, especially the ``VCC33`` and ``GND`` parts as you can otherwise
destroy the chip.
@ -151,10 +151,10 @@ Step 4: Uploading Firmware
--------------------------
In order to upload the firmware, you're first going to need to get the chip into a flash mode, otherwise
the device will start up without accepting any firmware flash attempts. To do this, while the device is UART
bridge is not connected to your USB port, start pressing the bottom-left push button labeled ``FW/IO0``
the device will start up without accepting any firmware flash attempts. To do this, while the UART
bridge is not connected to your USB port, press and hold the bottom-left push button labeled ``FW/IO0``
and continue to do so while plugging in the UART bridge into your computer. Keep holding the button for
another 2-4 seconds. The 4CH should now be in a flash mode and should not blink with any LED.
another 2-4 seconds. The 4CH should now be in a flash mode and should not blink any LED.
.. figure:: images/sonoff_4ch_buttons.jpg
:align: center
@ -175,12 +175,12 @@ If successful, you should see something like this:
Hooray 🎉! You've now successfully uploaded the first ESPHome firmware to your Sonoff 4CH. And in a moment,
you will be able to use all of ESPHome's great features with your Sonoff 4CH.
If above step does, however, not work, here are some steps that can help:
If above step don't work, however, here are some steps that can help:
- Sometimes the UART bridge cannot supply enough current to the chip to operate, in this
case use a 3.3V supply you have lying around. A nice hack is to use the power supply of
NodeMCU boards. Simply connect the NodeMCU's 3.3V to VCC and GND to GND. **Do not attempt
to plug the device into a socket to overcome this problem while troubleshooting.**
NodeMCU boards. Simply connect the NodeMCU's 3.3V to VCC and GND to GND. **Do not connect mains
power to the device in an attempt to overcome this problem while troubleshooting.**
- In other cases the ``TX`` and ``RX`` pin are reversed. Simple disconnect the device, swap
the two pins and put it into flash mode again.
@ -307,7 +307,7 @@ Step 6: Finishing Up
--------------------
If you're sure everything is done with the 4CH and have double checked there's nothing that could cause a short
in the case, you can put the front cover with the button on the base again and screw everything together.
in the case, you can put the front cover back on and screw everything together.
Now triple or even quadruple check the UART bridge is not connected to the 4CH, then comes the time when you can
connect it.

40
devices/sonoff_s20.rst
View File

@ -16,12 +16,12 @@ front and a blue and green LED light.
Sonoff S20 Smart Socket.
This guide will step you through setting up your Sonoff S20 and flashing the first ESPHome firmware
with the serial interface. After that, you will be able to upload all future firmwares with the remote
with the serial interface. After that, you will be able to upload all future firmware with the remote
Over-The-Air update process.
.. note::
If you've previously installed Sonoff-Tasmota on your Sonoff S20, you're in luck 😀
If you've previously installed Sonoff-Tasmota on your Sonoff S20, you're in luck 😀.
ESPHome can generate a firmware binary which you can then upload via the
Tasmota web interface. To see how to create this binary, skip to :ref:`sonoff_s20-creating-firmware`.
@ -43,12 +43,12 @@ interface.
For this guide you will need:
- Sonoff S20 😉
- An USB to UART Bridge for flashing the device. These can be bought on Amazon for less than 5 dollars.
- Sonoff S20 😉.
- A USB to UART Bridge for flashing the device. These can be bought on Amazon (or other online stores) for less than 5 dollars.
Note that the bridge *must* be 3.3V compatible. Otherwise you will destroy your S20.
- Computer running ESPHome Hass.io add-on.
- Screwdriver to open up the S20.
- Soldering iron and a few header pins to connect the UART interface.
- A computer running Home Assistant with the ESPHome Hass.io add-on.
- A screwdriver to open up the S20.
- A soldering iron and a few header pins to connect the UART interface.
Have everything? Great! Then you can start.
@ -65,7 +65,7 @@ supplied with the Sonoff S20 before doing this step.
plugged in before doing this step.
While the device is not plugged in, turn the back side so it's facing you and unscrew the three
black screws holding the back of the case together with the front.
black screws that hold the case together.
.. figure:: images/sonoff_s20_screws.jpg
:align: center
@ -83,7 +83,7 @@ Step 2: Connecting UART
-----------------------
We're interested in the main part of the S20 with the green PCB. On the bottom of the PCB, you will
find four unpopulated holes. These pins have the UART interface used to flash firmwares onto the device
find four unpopulated holes. These pins expose the UART interface used to flash firmware onto the device
and debug issues.
.. figure:: images/sonoff_s20_pcb.jpg
@ -94,8 +94,8 @@ and debug issues.
So, in order to flash our own custom firmware, we're going to need to somehow connect the UART to USB
bridge to these pins. The only way to make a good connection here is by using a soldering iron and soldering
on some pin headers. On older models of the Sonoff S20, you were able to get the whole PCB out. Newer versions,
however, glue the PCB onto the case to avoid people flashing custom firmwares. If the latter is the case,
you will need to just solder the pin headers from above - it's a bit difficult, but possible.
however, glue the PCB onto the case to avoid people flashing custom firmware. If the latter is the case,
you will just need to solder the pin headers from above - it's a bit difficult, but possible.
When you're done, it should look something like this:
@ -153,10 +153,10 @@ Step 4: Uploading Firmware
--------------------------
In order to upload the firmware, you're first going to need to get the chip into a flash mode, otherwise
the device will start up without accepting any firmware flash attempts. To do this, while the device is UART
bridge is not connected to your USB port, start pressing the small push button in the middle of the PCB.
Then plug in the UART bridge into your computer and just keep holding the button pressed for 2-4 seconds.
The S20 should now be in a flash mode and should not blink with any LED.
the device will start up without accepting any firmware flash attempts. To do this, while the UART
bridge is not connected to your USB port, press and hold the small push button in the middle of the PCB.
Then plug the UART bridge into your computer and keep holding the button for 2-4 seconds.
The S20 should now be in a flash mode and should not blink any LED.
Now you can finally run the upload command:
@ -169,12 +169,12 @@ If successful, you should see something like this:
.. figure:: images/sonoff_s20_upload.png
:align: center
Hooray 🎉! You've now successfully uploaded the first ESPHome firmware to your Sonoff S20. And in a moment,
Hooray 🎉! You've now successfully uploaded the first ESPHome firmware to your Sonoff S20. And, in a moment,
you will be able to use all of ESPHome's great features with your Sonoff S20.
If above step does, however, not work, here are some steps that can help:
If above step don't work, however, here are some steps that can help:
- Sometimes the UART bridge cannot supply enough current to the chip to operate, in this
- Sometimes the UART bridge cannot supply enough current to the chip to operate. In this
case use a 3.3V supply you have lying around. A nice hack is to use the power supply of
NodeMCU boards. Simply connect 3.3V to VCC and GND to GND on the pins. **Do not attempt
to plug the device into a socket to overcome this problem while troubleshooting.**
@ -249,7 +249,7 @@ of the basic functions.
output: s20_green_led
Above example also showcases an important concept of esphome: IDs and linking. In order
The above example also showcases an important concept of esphome: IDs and linking. In order
to make all components in ESPHome as much "plug and play" as possible, you can use IDs to define
them in one area, and simply pass that ID later on. For example, above you can see an PWM (dimmer)
output being created with the ID ``s20_green_led`` for the green LED. Later on it is then transformed
@ -294,7 +294,7 @@ Step 6: Finishing Up
--------------------
Now you're pretty much done with setting up the Sonoff S20. The only steps left are to
remove any cables within the housing and make sure everything in there is clean. If, for
remove any cables that you added within the housing and make sure everything in there is clean. If, for
example, you used wires to connect the UART console, you should definitely remove them to avoid
a short with mains.

27
guides/automations.rst
View File

@ -1,13 +1,13 @@
.. _automation:
Automations And Templates
Automations and Templates
=========================
.. seo::
:description: Getting started guide for automations in ESPHome.
:image: auto-fix.png
Automations and templates are two very powerful concepts of ESPHome. Automations
Automations and templates are two very powerful aspects of ESPHome. Automations
allow you to perform actions under certain conditions and templates are a way to easily
customize everything about your node without having to dive into the full ESPHome C++
API.
@ -130,8 +130,8 @@ cycle back to its original state. Similarly you can have a single trigger with m
- light.toggle: dehumidifier_indicator_light
As a last example, let's make our dehumidifier smart: Let's make it turn on automatically when the humidity a sensor
reports is above 65% and make it turn off again when it reaches 50%
As a last example, let's make our dehumidifier smart: Let's make it turn on automatically when the humidity reported by a sensor
is above 65%, and make it turn off again when it falls below 50%:
.. code-block:: yaml
@ -149,11 +149,11 @@ reports is above 65% and make it turn off again when it reaches 50%
temperature:
name: "Living Room Temperature"
That's a lot of indentation 😉 ``on_value_range`` is a special trigger for sensors that triggers when the value output
That's a lot of indentation 😉 ``on_value_range`` is a special trigger for sensors that trigger when the value output
of the sensor is within a certain range. In the first example, this range is defined as "any value above or including
65.0", and the second one refers to once the humidity reaches 50% or below.
Now that concludes the introduction into automations in ESPHome. They're a powerful tool to automate almost
Now that concludes the introduction to automations in ESPHome. They're a powerful tool to automate almost
everything on your device with an easy-to-use syntax. For the cases where the "pure" YAML automations don't work,
ESPHome has another extremely powerful tool to offer: Templates.
@ -183,7 +183,8 @@ first:
}
What's happening here? First, we define a binary sensor (with the id ``top_end_stop``) and then a
:doc:`template cover </components/cover/template>`. The *state* of the template cover is
:doc:`template cover </components/cover/template>`. (If you're new to Home Assistant, a 'cover' is
something like a window blind, a roller shutter, or a garage door.) The *state* of the template cover is
controlled by a template, or "lambda". In lambdas you're effectively writing C++ code and therefore the
name lambda is used instead of Home Assistant's "template" lingo to avoid confusion. But before you go
shy away from using lambdas because you just hear C++ and think oh noes, I'm not going down *that* road:
@ -540,7 +541,7 @@ Configuration options:
---------------------
This action allows your automations to wait until a condition evaluates to true. (So this is just
a shorthand way of writing a while action with empty then block)
a shorthand way of writing a ``while`` action with an empty ``then`` block.)
.. code-block:: yaml
@ -626,7 +627,7 @@ execute the script with a single call.
----------------------
This action allows you to stop a given script during execution. If the
script is not running, does nothing.
script is not running, it does nothing.
Please note this is only useful right now if your script contains a ``delay`` action.
.. code-block:: yaml
@ -650,7 +651,7 @@ Please note this is only useful right now if your script contains a ``delay`` ac
-------------------------------
This :ref:`condition <config-condition>` allows you to check if a given script is running.
Please note that multiple scripts can be running concurrently, this condition only tells
Please note that multiple scripts can be running concurrently. This condition only tells
you if at least one script of the given type is running, not how many.
.. code-block:: yaml
@ -694,10 +695,10 @@ Configuration variables:
``interval``
------------
This component allows you to run actions periodically with a fixed interval.
This component allows you to run actions at fixed time intervals.
For example if you want to toggle a switch every minute, you can use this component.
Please note that this certain cases are also possible with the :ref:`time.on_time <time-on_time>`
trigger, but this one is more light-weight and user-friendly.
Please note that it's possible to achieve the same thing with the :ref:`time.on_time <time-on_time>`
trigger, but this technique is more light-weight and user-friendly.
.. code-block:: yaml

18
guides/faq.rst
View File

@ -10,7 +10,7 @@ Tips for using ESPHome
1. ESPHome supports (most of) `Home Assistant's YAML configuration directives
<https://www.home-assistant.io/docs/configuration/splitting_configuration/>`__ like
``!include``, ``!secret``. So you can store all your secret WiFi passwords and so on
``!include`` and ``!secret``. So you can store all your secret WiFi passwords and so on
in a file called ``secrets.yaml`` within the directory where the configuration file is.
For even more configuration templating, take a look at :ref:`config-substitutions`.
@ -31,7 +31,7 @@ Tips for using ESPHome
possible to edit anything outside of the ``AUTO GENERATED CODE BEGIN/END`` lines for creating
:doc:`custom sensors </components/sensor/custom>`.
5. You can view the full command line interface options here: :doc:`/guides/cli`
5. You can view the full list of command line interface options here: :doc:`/guides/cli`
6. Use :ref:`substitutions <config-substitutions>` to reduce repetition in your configuration files.
@ -83,8 +83,8 @@ Select the firmware binary and finally press "Flash ESP".
are connected correctly if flashing using a USB to UART bridge. For some devices you need to
keep pressing the BOOT button until flashing has begun (ie. Geekcreit DOIT ESP32 DEVKIT V1).
Help! Something's not working!1!
--------------------------------
Help! Something's not working!!
-------------------------------
That's no good. Here are some steps that resolve some problems:
@ -103,7 +103,7 @@ I can using my own hardware, I don't own every single device type and mostly onl
system. When doing some changes in the core, it can quickly happen that something somewhere breaks. Issue reports are a
great way for me to track and (hopefully) fix issues, so thank you!
For me to fix the issue the quickest, there are some things that would be really helpful:
For me to fix the issue quickly, there are some things that would be really helpful:
1. **Just writing "X doesn't work" or "X gives bug" is not helpful!!!** Seriously, how do you expect
help given just that information?
@ -180,7 +180,7 @@ The latest dev docs are here: `next.esphome.io <https://next.esphome.io/>`__
Does ESPHome support [this device/feature]?
-------------------------------------------
If it's not in :doc:`the docs </index>`, it's probably sadly not
If it's not in :doc:`the docs </index>`, it's probably not
supported. However, I'm always trying to add support for new features, so feel free to create a feature
request in the `ESPHome feature request tracker <https://github.com/esphome/feature-requests>`__. Thanks!
@ -211,9 +211,9 @@ Some steps that can help with the issue:
configuration (also sometimes helps with non-hidden networks)
- Give your ESP a :ref:`static IP <wifi-manual_ip>`.
- Set the ``power_save_mode`` to ``light`` in the ``wifi:`` config (only helps in some cases,
in other it can make things works). See :ref:`wifi-power_save_mode`.
- The issue seems to be happen with cheap boards more frequently. Especially the "cheap" NodeMCU
boards from eBay sometimes have quite bad antennas.
in other it can make things worse). See :ref:`wifi-power_save_mode`.
- The issue seems to happen with cheap boards more frequently. Especially the "cheap" NodeMCU
boards from eBay which sometimes have quite bad antennas.
Docker Reference
----------------

10
guides/getting_started_command_line.rst
View File

@ -5,7 +5,7 @@ Getting Started with ESPHome
:description: Getting Started guide for installing ESPHome using the command line and creating a basic configuration.
:image: console.png
ESPHome is the perfect solution for creating custom firmwares for
ESPHome is the perfect solution for creating custom firmware for
your ESP8266/ESP32 boards. In this guide we’ll go through how to setup a
basic “node” in a few simple steps.
@ -29,7 +29,7 @@ an RPi, please install ESPHome through ``pip`` or use :doc:`the Hass.io add-on <
docker pull esphome/esphome
Creating A Project
Creating a Project
------------------
Now let’s setup a configuration file. Fortunately, ESPHome has a
@ -71,7 +71,7 @@ to translate pin numbers for you based on the board. For example in the
above configuration, if using a NodeMCU board, you could have just as
well set ``D1`` as the ``pin:`` option.
First Uploading
First uploading
---------------
Now you can go ahead and add some more components. Once you feel like
@ -97,7 +97,7 @@ to your docker command to map a local USB device.
docker run --rm -v "${PWD}":/config --device=/dev/ttyUSB0 -it esphome/esphome livingroom.yaml run
Now when you go to the Home Assistant "Integrations" screen (under "Configuration" panel), you
should see the ESPHome device show up in the discovered section (can take up to 5 minutes).
should see the ESPHome device show up in the discovered section (although this can take up to 5 minutes).
Alternatively, you can manually add the device by clicking "CONFIGURE" on the ESPHome integration
and entering "<NODE_NAME>.local" as the host.
@ -112,7 +112,7 @@ Adding A Binary Sensor
----------------------
Next, we’re going to add a very simple binary sensor that periodically
checks a GPIO pin whether it’s pulled high or low - the :doc:`GPIO Binary
checks if a particular GPIO pin is pulled high or low - the :doc:`GPIO Binary
Sensor </components/binary_sensor/gpio>`.
.. code-block:: yaml

16
guides/getting_started_hassio.rst
View File

@ -5,14 +5,14 @@ Getting Started with ESPHome through Hass.io
:description: Getting Started guide for installing ESPHome as a Hass.io Add-on and creating a basic configuration.
:image: home-assistant.png
ESPHome is the perfect solution for creating custom firmwares for
ESPHome is the perfect solution for creating custom firmware for
your ESP8266/ESP32 boards. In this guide we’ll go through how to setup a
basic "node" by use of the Hass.io add-on.
But first, here's a very quick introduction of how ESPHome works:
ESPHome is a *tool* which reads in YAML configuration files (just like Home Assistant)
and creates custom firmwares. The tool also has many helpers that simplify flashing devices
and aims to make managing your ESP boards as simple as possible. Once you have added devices
But first, here's a very quick introduction to how ESPHome works:
ESPHome is a *tool* which reads in a YAML configuration file (just like Home Assistant)
and creates a custom firmware binary. The tool also has many helpers that simplify flashing devices (uploading the new binary file)
and aim to make managing your ESP boards as simple as possible. Once you have added devices
or sensors in ESPHome's configuration, they will even automatically show up in Home
Assistant's UI.
@ -85,7 +85,7 @@ Adding some (basic) features
----------------------------
So now you should have a file called ``/config/esphome/livingroom.yaml`` (or similar).
Go open that file in and add a :doc:`simple GPIO switch </components/switch/gpio>`
Go open that file (in any text editor) and add a :doc:`simple GPIO switch </components/switch/gpio>`
to the configuration like this:
.. code-block:: yaml
@ -99,7 +99,7 @@ In above example, we're simply adding a switch that's called "Living Room Dehumi
anything really, for example lights) and is connected to the pin ``GPIO5``.
Now when you go to the Home Assistant "Integrations" screen (under "Configuration" panel), you
should see the ESPHome device show up in the discovered section (can take up to 5 minutes).
should see the ESPHome device show up in the discovered section (although this can take up to 5 minutes).
Alternatively, you can manually add the device by clicking "CONFIGURE" on the ESPHome integration
and entering "<NODE_NAME>.local" as the host.
@ -115,7 +115,7 @@ Adding A Binary Sensor
----------------------
Next, we’re going to add a very simple binary sensor that periodically
checks a GPIO pin whether it’s pulled high or low - the :doc:`GPIO Binary
checks a GPIO pin to see whether it’s pulled high or low - the :doc:`GPIO Binary
Sensor </components/binary_sensor/gpio>`.
.. code-block:: yaml

16
guides/migrate_sonoff_tasmota.rst
View File

@ -8,8 +8,8 @@ Migrating from Sonoff Tasmota
Migrating from previous Sonoff Tasmota setups is very easy. You just need to have
ESPHome create a binary for you and then upload that in the Tasmota web interface.
Getting Binary
--------------
Getting the Binary
------------------
First follow the guides for the :ref:`different supported devices <devices>` and create a configuration
file. Then, generate and download the binary:
@ -21,13 +21,13 @@ file. Then, generate and download the binary:
- **Using the command line**: run ``esphome livingroom.yaml compile`` (replacing
``livingroom.yaml`` with your configuration file of course) and navigate to the
``<NODE_NAME>/.pioenvs/<NODE_NAME>/`` folder. There you will find a ``firmware.bin`` file,
this is the binary you will upload.
``<NODE_NAME>/.pioenvs/<NODE_NAME>/`` folder. There you will find a ``firmware.bin`` file.
This is the binary that you will upload.
Uploading Binary
----------------
Uploading the Binary
--------------------
To upload the binary, navigate to the tasmota web interface and enter the
To upload the binary, navigate to the Tasmota web interface and enter the
"Firmware Upgrade" section.
.. figure:: images/tasmota_main.png
@ -41,7 +41,7 @@ In the "Upgrade by file upload" section, choose the binary you previously downlo
:width: 60.0%
If everything succeeds, you will see an "Upload Successful" message and ESPHome
will connect to the configured WiFi network 🎉
will connect to the WiFi network configured in your .yaml file. 🎉
.. figure:: images/tasmota_upload.png
:align: center