esphome-docs/guides/faq.rst

350 lines
15 KiB
ReStructuredText
Raw Normal View History

2018-05-14 21:52:16 +02:00
Frequently Asked Questions
==========================
2018-11-14 22:12:27 +01:00
.. seo::
2019-02-16 23:25:23 +01:00
:description: Frequently asked questions in ESPHome.
:image: question_answer.png
2018-11-14 22:12:27 +01:00
2019-02-16 23:25:23 +01:00
Tips for using ESPHome
----------------------
2018-06-02 21:54:39 +02:00
2019-02-27 18:32:47 +01:00
1. ESPHome supports (most of) `Home Assistant's YAML configuration directives
2019-02-27 18:35:30 +01:00
<https://www.home-assistant.io/docs/configuration/splitting_configuration/>`__ like
``!include`` and ``!secret``. So you can store all your secret WiFi passwords and so on
2018-06-02 21:54:39 +02:00
in a file called ``secrets.yaml`` within the directory where the configuration file is.
2018-12-05 10:19:48 +01:00
For even more configuration templating, take a look at :ref:`config-substitutions`.
2019-02-16 23:25:23 +01:00
2. If you want to see how ESPHome interprets your configuration, run
2018-06-02 21:54:39 +02:00
.. code-block:: bash
2018-06-02 21:54:39 +02:00
2019-02-16 23:25:23 +01:00
esphome livingroom.yaml config
2018-06-02 21:54:39 +02:00
3. To view the logs from your node without uploading, run
.. code-block:: bash
2018-06-02 21:54:39 +02:00
2019-02-16 23:25:23 +01:00
esphome livingroom.yaml logs
2018-06-02 21:54:39 +02:00
2019-10-22 22:59:42 +02:00
4. You can always find the source ESPHome generates under ``<NODE_NAME>/src/``.
2018-06-02 21:54:39 +02:00
5. You can view the full list of command line interface options here: :doc:`/guides/cli`
2018-06-02 21:54:39 +02:00
2019-02-16 23:25:23 +01:00
6. Use :ref:`substitutions <config-substitutions>` to reduce repetition in your configuration files.
2019-01-06 18:56:14 +01:00
2018-06-02 21:54:39 +02:00
.. |secret| replace:: ``!secret``
.. _secret: https://www.home-assistant.io/docs/configuration/secrets/
.. |include| replace:: ``!include``
.. _include: https://www.home-assistant.io/docs/configuration/splitting_configuration/
2019-02-16 23:25:23 +01:00
.. _esphome-flasher:
2018-11-10 15:29:50 +01:00
2018-11-09 20:06:40 +01:00
I can't get flashing over USB to work.
--------------------------------------
2019-02-16 23:25:23 +01:00
ESPHome depends on the operating system the tool is running on to recognize
the ESP. This can sometimes fail. Common causes are that you did not install
the drivers (see note below) or you are trying to upload from a Docker container
and did not mount the ESP device into your container using ``--device=/dev/ttyUSB0``.
2019-02-16 23:25:23 +01:00
Starting with ESPHome 1.9.0, the ESPHome suite provides
`esphome-flasher <https://github.com/esphome/esphome-flasher>`__, a tool to flash ESPs over USB.
2018-11-09 20:06:40 +01:00
2018-11-26 16:50:50 +01:00
First, you need to get the firmware file to flash. For Hass.io add-on based installs you can
2018-12-01 09:46:37 +01:00
use the ``COMPILE`` button (click the overflow icon with the three dots) and then press
``Download Binary``. For command line based installs you can access the file under
``<CONFIG_DIR>/<NODE_NAME>/.pioenvs/<NODE_NAME>/firmware.bin``.
2018-11-09 20:06:40 +01:00
2019-02-16 23:25:23 +01:00
Then, install esphome-flasher by going to the `releases page <https://github.com/esphome/esphome-flasher/releases>`__
2018-11-09 20:06:40 +01:00
and downloading one of the pre-compiled binaries. Open up the application and select the serial port
you want to flash to (on windows you can use the "device manager" to check if it's the right one).
.. figure:: images/esphomeflasher-ui.png
:align: center
:width: 80%
Select the firmware binary and finally press "Flash ESP".
.. note::
If the serial port is not showing up, you might not have the required drivers installed.
ESPs usually ship with one of these two UART chips:
* CP2102 (square chip): `driver <https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers>`__
* CH341: `driver <https://github.com/nodemcu/nodemcu-devkit/tree/master/Drivers>`__
.. note::
If you're just seeing ``Connecting....____....`` on the screen and the flashing fails, that might
be a sign that the ESP is defect or cannot be programmed. Please double check the UART wires
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).
2018-11-09 20:06:40 +01:00
Help! Something's not working!!
-------------------------------
2018-05-14 21:52:16 +02:00
That's no good. Here are some steps that resolve some problems:
2018-10-20 15:42:35 +02:00
- **If you're having WiFi problems**: See :ref:`wifi-problems`.
2019-02-16 23:25:23 +01:00
- Enable verbose logs in the logger: section.
2019-05-15 13:19:12 +02:00
- **Still an error?** Please file a bug report over in the `ESPHome issue tracker <https://github.com/esphome/issues>`__.
We will take a look at it as soon as we can. Thanks!
2018-05-14 21:52:16 +02:00
2018-11-15 11:43:36 +01:00
.. _faq-bug_report:
2018-05-16 19:46:31 +02:00
How to submit an issue report
2018-09-26 18:23:24 +02:00
-----------------------------
2018-05-16 19:46:31 +02:00
First of all, thank you very much to everybody submitting issue reports! While we try to test ESPHome/YAML as much as
we can using our available hardware, we don't own every single device type and rely on testing done by the community
and the contributors. When doing some changes in the core, it can quickly happen that something somewhere breaks.
Issue reports are a great way for us to track and (hopefully) fix issues, so thank you!
2018-05-16 19:46:31 +02:00
For us to fix the issue quickly, there are some things that would be really helpful:
2018-05-16 19:46:31 +02:00
1. **Just writing "X doesn't work" or "X gives bug" is not helpful!!!** Seriously, how do you expect
help given just that information?
2. A snippet of the code/configuration file used is always great to reproduce this issue.
Please read `How to create a Minimal, Complete, and Verifiable example <https://stackoverflow.com/help/mcve>`__.
3. If it's an I²C or hardware communication issue please also try setting the
2018-06-01 18:10:00 +02:00
:ref:`log level <logger-log_levels>` to ``VERY_VERBOSE`` as it provides helpful information
2018-05-16 19:46:31 +02:00
about what is going on.
4. Please also include what you've already tried and didn't work as that can help us track down the issue.
2018-05-16 19:46:31 +02:00
2019-02-16 23:25:23 +01:00
You can find the issue tracker here https://github.com/esphome/issues
2018-05-16 19:46:31 +02:00
2018-05-14 21:52:16 +02:00
How do I update to the latest version?
2018-09-26 18:23:24 +02:00
--------------------------------------
2018-05-14 21:52:16 +02:00
2018-06-01 18:10:00 +02:00
It's simple. Run:
2018-05-14 21:52:16 +02:00
.. code-block:: bash
2018-05-14 21:52:16 +02:00
2021-05-10 12:43:19 +02:00
pip3 install -U esphome
2018-06-05 23:17:40 +02:00
# From docker:
2019-02-16 23:25:23 +01:00
docker pull esphome/esphome:latest
2018-05-14 21:52:16 +02:00
2018-11-26 16:50:50 +01:00
And in Hass.io, there's a simple UPDATE button when there's an update available as with all add-ons
2018-06-05 23:17:40 +02:00
2018-11-03 16:21:10 +01:00
.. _faq-beta:
How do I update to the latest beta release?
-------------------------------------------
2019-02-16 23:25:23 +01:00
ESPHome has a beta release cycle so that new releases can easily be tested before
2020-05-10 21:27:59 +02:00
the changes are deployed to the stable channel. You can help test ESPHome (and use new features)
by installing the tested beta:
2018-11-03 16:21:10 +01:00
.. code-block:: bash
2018-11-03 16:21:10 +01:00
# For pip-based installs
2021-05-10 12:43:19 +02:00
pip3 install --pre -U esphome
2018-11-03 16:21:10 +01:00
2019-02-16 23:25:23 +01:00
# For docker-based installs
docker run [...] -it esphome/esphome:beta livingroom.yaml run
2018-11-03 16:21:10 +01:00
For Home Assistant supervised installs add the community addons beta repository by
adding
`https://github.com/hassio-addons/repository-beta <https://github.com/hassio-addons/repository-beta>`__
in Add-on store -> Repositories.
2018-11-03 16:21:10 +01:00
The beta docs are available at `beta.esphome.io <https://beta.esphome.io>`__
2018-11-03 16:21:10 +01:00
2018-06-05 23:17:40 +02:00
How do I use the latest bleeding edge version?
2018-09-26 18:23:24 +02:00
----------------------------------------------
2018-06-05 23:17:40 +02:00
First, a fair warning that the latest bleeding edge version is not always stable and might have issues.
If you find some, please do however report them.
2018-06-05 23:17:40 +02:00
2019-02-16 23:25:23 +01:00
To install the dev version of ESPHome:
2018-06-05 23:17:40 +02:00
- In Hass.io: Add the ESPHome repository `https://github.com/esphome/hassio <https://github.com/esphome/hassio>`
in Add-on store -> Repositories. Then install the add-on ``ESPHome Dev``
2021-05-10 12:43:19 +02:00
- From ``pip``: Run ``pip3 install https://github.com/esphome/esphome/archive/dev.zip``
- From docker, use the `esphome/esphome:dev <https://hub.docker.com/r/esphome/esphome/tags?page=1&name=dev>`__ image
2019-03-11 11:14:22 +01:00
.. code-block:: bash
docker run [...] -it esphome:dev livingroom.yaml compile
2018-06-05 23:17:40 +02:00
2019-02-17 10:27:09 +01:00
The latest dev docs are here: `next.esphome.io <https://next.esphome.io/>`__
How do I use my Home Assistant secrets.yaml?
--------------------------------------------
If you want to keep all your secrets in one place, make a ``secrets.yaml`` file in the
esphome directory with these contents (so it pulls in the contents of your main Home Assistant
``secrets.yaml`` file from one directory higher):
.. code-block:: yaml
<<: !include ../secrets.yaml
2019-02-16 23:25:23 +01:00
Does ESPHome support [this device/feature]?
-------------------------------------------
2018-05-14 21:52:16 +02:00
If it's not in :doc:`the docs </index>`, it's probably not
supported. However, we are always trying to add support for new features, so feel free to create a feature
2019-02-16 23:25:23 +01:00
request in the `ESPHome feature request tracker <https://github.com/esphome/feature-requests>`__. Thanks!
2018-05-14 21:52:16 +02:00
I have a question... How can I contact you?
2018-09-26 18:23:24 +02:00
-------------------------------------------
2018-05-14 21:52:16 +02:00
Sure! We are happy to help :) You can contact us here:
2018-05-14 21:52:16 +02:00
- `Discord <https://discord.gg/KhAMKrd>`__
2019-05-15 13:19:12 +02:00
- `Home Assistant Community Forums <https://community.home-assistant.io/c/third-party/esphome>`__
2019-02-16 23:25:23 +01:00
- ESPHome `issue <https://github.com/esphome/issues>`__ and
`feature request <https://github.com/esphome/feature-requests>`__ issue trackers. Preferably only for issues and
2018-05-14 21:52:16 +02:00
feature requests.
2019-03-11 11:14:22 +01:00
- Alternatively, also under contact (at) esphome.io (NO SUPPORT!)
2018-05-14 21:52:16 +02:00
2018-10-20 15:42:35 +02:00
.. _wifi-problems:
2018-05-14 21:52:16 +02:00
My node keeps reconnecting randomly
2018-09-26 18:23:24 +02:00
-----------------------------------
2018-05-14 21:52:16 +02:00
Jep, that's a known issue. However, it seems to be very low-level and we don't really know
how to solve it. We are working on possible workarounds for the issue, but currently we do
2018-05-14 21:52:16 +02:00
not have a real solution.
2018-06-01 18:10:00 +02:00
Some steps that can help with the issue:
2019-02-16 23:25:23 +01:00
- If you're using a hidden WiFi network, make sure to enable ``fast_connect`` mode in the WiFi
configuration (also sometimes helps with non-hidden networks)
- Give your ESP a :ref:`static IP <wifi-manual_ip>`.
2019-02-22 21:28:26 +01:00
- Set the ``power_save_mode`` to ``light`` in the ``wifi:`` config (only helps in some cases,
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.
2020-05-10 21:27:59 +02:00
- ESPHome reboots on purpose when something is not going right, e.g.
:doc:`wifi connection cannot be made </components/wifi>` or
:doc:`api connection is lost </components/api>` or
:doc:`mqtt connection is lost </components/mqtt>`. So if you are facing this problem you'll need
2020-05-10 21:27:59 +02:00
to explicitly set the ``reboot_timeout`` option to ``0s`` on the components being used.
- If you see ``Error: Disconnecting <NODE_NAME>`` in your logs, ESPHome is actively closing
the native API client connection. Connect a serial console to inspect the reason, which is only
logged via serial. If you see ``ack timeout 4`` right before a disconnect, this might be because
of a bug in the AsyncTCP library, for which a fix was included in ESPHome version 1.18.0.
If you are running an ESPHome version, prior to 1.18.0, then upgrade ESPHome and build fresh
firmware for your devices.
- We have seen an increase in disconnects while the log level was set to ``VERY_VERBOSE``,
especially on single-core devices, where the logging code might be interfering with the operation
of the networking code. For this reason, we advise using a lower log level for production
purposes.
- Related to this, seems to be the number of clients that are simultaneously connected to the native
API server on the device. These might for example be Home Assistant (via the ESPHome integration) and
the log viewer on the web dashboard. In production, you will likely only have a single connection from
Home Assistant, making this less of an issue. But beware that attaching a log viewer might
have impact.
2019-02-22 21:17:31 +01:00
Docker Reference
----------------
Install versions:
.. code-block:: bash
# Stable Release
docker pull esphome/esphome
# Beta
docker pull esphome/esphome:beta
# Dev version
docker pull esphome/esphome:dev
Command reference:
.. code-block:: bash
# Start a new file wizard for file livingroom.yaml
docker run --rm -v "${PWD}":/config -it esphome/esphome livingroom.yaml wizard
# Compile and upload livingroom.yaml
docker run --rm -v "${PWD}":/config -it esphome/esphome livingroom.yaml run
# View logs
docker run --rm -v "${PWD}":/config -it esphome/esphome livingroom.yaml logs
# Map /dev/ttyUSB0 into container
docker run --rm -v "${PWD}":/config --device=/dev/ttyUSB0 -it esphome/esphome ...
# Start dashboard on port 6052 (general command)
# Warning: this command is currently not working with Docker on MacOS. (see note below)
2019-02-22 21:17:31 +01:00
docker run --rm -v "${PWD}":/config --net=host -it esphome/esphome
2021-01-23 21:20:18 +01:00
# Start dashboard on port 6052 (MacOS specific command)
docker run --rm -p 6052:6052 -e ESPHOME_DASHBOARD_USE_PING=true -v "${PWD}":/config -it esphome/esphome
2019-07-03 17:35:21 +02:00
# Setup a bash alias:
alias esphome='docker run --rm -v "${PWD}":/config --net=host -it esphome/esphome'
2019-02-22 21:17:31 +01:00
And a docker compose file looks like this:
.. code-block:: yaml
version: '3'
services:
esphome:
image: esphome/esphome
volumes:
- ./:/config:rw
# Use local time for logging timestamps
- /etc/localtime:/etc/localtime:ro
2019-02-22 21:17:31 +01:00
network_mode: host
restart: always
.. _docker-reference-notes:
2019-02-22 21:17:31 +01:00
.. note::
By default ESPHome uses mDNS to show online/offline state in the dashboard view. So for that feature
2019-02-22 21:17:31 +01:00
to work you need to enable host networking mode
2019-02-27 18:32:47 +01:00
On MacOS the networking mode ("-net=host" option) doesn't work as expected. You have to use
another way to launch the dashboard with a port mapping option and use alternative to mDNS
to have the online/offline stat (see below)
2019-02-27 18:32:47 +01:00
mDNS might not work if your Home Assistant server and your ESPHome nodes are on different subnets.
If your router supports Avahi, you are able to get mDNS working over different subnets.
Just follow the next steps:
2019-02-27 18:32:47 +01:00
1. Enable Avahi on both subnets.
2. Enable UDP traffic from ESPHome node's subnet to 224.0.0.251/32 on port 5353.
2019-02-22 21:17:31 +01:00
Alternatively, you can make esphome use ICMP pings to check the status of the device
with the Hass.io Addon ``"status_use_ping": true,`` option or with docker ``-e ESPHOME_DASHBOARD_USE_PING=true``
See also https://github.com/esphome/issues/issues/641#issuecomment-534156628.
.. _faq-notes_on_disabling_mdns:
Notes on disabling mDNS
------------------------------------------------------------------------------
Some of ESPHome's functionalities rely on mDNS, so naturally :ref:`disabling <wifi-configuration_variables>` it will cause these features to stop working.
Generally speaking, disabling mDNS without setting a :ref:`static IP address <wifi-manual_ip>` (or a static DHCP lease) is bound to cause problems. This is due to the fact that mDNS is used to find the IP address of each ESPHome nodes.
- You will not be able to use the node's hostname to ping, find it's IP address or connect to it.
- Automatic discovery in Home Assistant when using :doc:`native API </components/api>` relies on mDNS broadcast messages to detect presence of new ESPHome nodes. If you need to use the native API with mDNS disabled, then you will have to use a static IP address and manually add the ESPHome integration with the fixed IP address.
- Online status detection in ESPHome's dashboard by default uses mDNS, so disabling mDNS will cause the ESPHome dashboard to show the status of the nodes created without mDNS support to be always offline. Currently, this does not affect any functionality, however if you want to see the online/offline status you could configure ESPHome to ping each node instead. See the :ref:`notes in the Docker Reference section <docker-reference-notes>` for more information.
2019-07-03 17:35:21 +02:00
Can Configuration Files Be Recovered From The Device?
-----------------------------------------------------
If you lost your ESPHome YAML configuration files, there's no way to recover them.
The configuration is *not* stored on the device directly - only the generated firmware is on
the device itself (technically, the configuration can be reverse-engineered from that, but only
with a lot of work).
Always back up all your files!
2018-06-01 18:10:00 +02:00
See Also
2018-09-26 18:23:24 +02:00
--------
2018-06-01 18:10:00 +02:00
- :doc:`ESPHome index </index>`
2018-06-01 18:10:00 +02:00
- :doc:`contributing`
- :ghedit:`Edit`