From 6d8f24d2693b3236d7d289e5dc6d827e8c593534 Mon Sep 17 00:00:00 2001 From: Oxan van Leeuwen Date: Wed, 25 Aug 2021 03:37:12 +0200 Subject: [PATCH] Update devices documentation (#1412) --- components/esphome.rst | 18 ++++++++++-------- devices/esp32.rst | 9 +++++++-- devices/esp8266.rst | 2 +- devices/nodemcu_esp8266.rst | 3 ++- devices/sonoff.rst | 4 ---- devices/sonoff_basic.rst | 1 - 6 files changed, 20 insertions(+), 17 deletions(-) diff --git a/components/esphome.rst b/components/esphome.rst index 7f96ef3d2..709a93ceb 100644 --- a/components/esphome.rst +++ b/components/esphome.rst @@ -27,14 +27,14 @@ 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 characters, digits and hyphens. 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 - from `this list `__ - and use `this list `__ - for ESP8266-based boards. *This only affects pin aliases and some internal settings*, if unsure - choose the generic board option! +- **platform** (**Required**, string): The platform your board is using, + either ``ESP32`` or ``ESP8266``. +- **board** (**Required**, string): The PlatformIO board ID that should + be used. Choose the appropriate board from + `this list ` for the ESP8266, and + `this list for the ESP32 (the icon + next to the name can be used to copy the board ID). *This only affects pin aliases and some internal settings*, + if unsure choose a generic board from Espressif. Advanced options: @@ -105,6 +105,8 @@ option you can tell ESPHome which Arduino framework to use for compiling. For the ESP8266, you currently can manually pin the Arduino version to these values (see the full list of Arduino frameworks `here `__): +* `3.0.1 `__ (not recommended yet) +* `3.0.0 `__ (not recommended yet) * `2.7.4 `__ (default) * `2.7.3 `__ * `2.7.2 `__ diff --git a/devices/esp32.rst b/devices/esp32.rst index e530bc01e..0ecaafb1e 100644 --- a/devices/esp32.rst +++ b/devices/esp32.rst @@ -4,10 +4,11 @@ Generic ESP32 .. seo:: :description: Information about how to use generic ESP32 boards in ESPHome. :image: esp32.png + :keywords: ESP32 -All ESP32-based devices are supported by ESPHome. Simply select ``ESP32`` when +All devices based on the original ESP32 are supported by ESPHome. Simply select ``ESP32`` when the ESPHome wizard asks you for your platform and choose a board type -from `this link `__ when the wizard +from `this link `__ when the wizard asks you for the board type. .. code-block:: yaml @@ -18,6 +19,10 @@ asks you for the board type. platform: ESP32 board: +.. note:: + + Support for the ESP32-S2 and ESP32-C3 is currently in development. + The ESP32 boards often use the internal GPIO pin numbering on the board, this means that you don't have to worry about other kinds of pin numberings, yay! diff --git a/devices/esp8266.rst b/devices/esp8266.rst index 69183b39f..a2cf4c7d2 100644 --- a/devices/esp8266.rst +++ b/devices/esp8266.rst @@ -8,7 +8,7 @@ Generic ESP8266 All ESP8266-based devices are supported by ESPHome. Simply select ``ESP8266`` when the ESPHome wizard asks you for your platform and choose a board type -from `this link `__ when the wizard +from `this link `__ when the wizard asks you for the board type. diff --git a/devices/nodemcu_esp8266.rst b/devices/nodemcu_esp8266.rst index 4e0bbda36..777328a86 100644 --- a/devices/nodemcu_esp8266.rst +++ b/devices/nodemcu_esp8266.rst @@ -43,10 +43,11 @@ In general, it is best to just use the ``D0``, ``D1``, ... pin numbering to avoi Note that in certain conditions you *can* use the pins marked as ``INTERNAL`` in above image. - ``D0`` also can be used to wake the device up from :doc:`deep sleep ` if - the pin is connected to the ``RESET`` pin. ``D0`` is additionally connected to the LED + the pin is connected to the ``RESET`` pin. On some boards ``D0`` is additionally connected to the LED next to the UART chip, but in an inverted mode. - ``D3``, ``D4`` and ``D8`` are used on startup to determine the boot mode, therefore these pins should not be pulled low on startup. You can, however, still use them as output pins. +- ``D4`` additionally is connected to the blue LED next to the antenna, but in an inverted mode. - ``A0``: This pin can be used as a normal GPIO pin (like ``D1`` etc) but additionally can measure voltages from 0 to 1.0V using the :doc:`/components/sensor/adc`. - ``VIN``: This board can be powered by an external power supply by using this pin. Supply a voltage depends on the board you use. Some boards support up to 12V, some up to 5V. diff --git a/devices/sonoff.rst b/devices/sonoff.rst index 480bec526..0c4004c49 100644 --- a/devices/sonoff.rst +++ b/devices/sonoff.rst @@ -15,10 +15,6 @@ and shipping from China takes a long time, I've only set up dedicated guides for name: platform: ESP8266 board: esp8285 - arduino_version: 2.4.2 - -The selected board and arduino_version are required in v1.14.3 (and probably later), see -https://github.com/esphome/issues/issues/931 for details. After that use the following list of pin to function mappings to set up your Sonoff device. This list has been compiled from the Sonoff Tasmota pin source file which can be found here: diff --git a/devices/sonoff_basic.rst b/devices/sonoff_basic.rst index 1b64d5305..a0d330536 100644 --- a/devices/sonoff_basic.rst +++ b/devices/sonoff_basic.rst @@ -55,7 +55,6 @@ exposes all of the basic functions. name: platform: ESP8266 board: esp8285 - arduino_version: 2.4.2 wifi: ssid: