mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-10-01 04:48:05 +02:00
Jesse Hills
GitHub
commit
501cec78c8
2
Doxygen
2
Doxygen
@ -38,7 +38,7 @@ PROJECT_NAME = "ESPHome"
|
||||
# could be handy for archiving the generated documentation or if some version
|
||||
# control system is used.
|
||||
|
||||
PROJECT_NUMBER = 2021.11.0b3
|
||||
PROJECT_NUMBER = 2021.11.0b4
|
||||
|
||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
||||
# for a project that appears at the top of each page and should give viewer a
|
||||
|
||||
2
Makefile
2
Makefile
@ -1,5 +1,5 @@
|
||||
ESPHOME_PATH = ../esphome
|
||||
ESPHOME_REF = 2021.11.0b3
|
||||
ESPHOME_REF = 2021.11.0b4
|
||||
|
||||
.PHONY: html html-strict cleanhtml deploy help webserver Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify
|
||||
|
||||
|
||||
@ -1 +1 @@
|
||||
2021.11.0b3
|
||||
2021.11.0b4
|
||||
@ -19,7 +19,20 @@ ESPHome 2021.11.0 - 17th November 2021
|
||||
State of the Open Smart Home
|
||||
----------------------------
|
||||
|
||||
Write something here...
|
||||
Mark your calendar for the `State of the Open Smart Home <https://www.home-assistant.io/state-of-the-open-home/>`__ hosted by Nabu Casa, Home Assistant & ESPHome
|
||||
and we’ll be joined by our friends from WLED and Z-Wave JS to talk about our work on making this vision a reality.
|
||||
|
||||
Where: YouTube
|
||||
|
||||
When: Saturday, December 11, at 11am PST / 8pm CET
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/6ZMXE5PXPqU"
|
||||
title="YouTube video player" frameborder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowfullscreen>
|
||||
</iframe>
|
||||
|
||||
|
||||
Improv via Serial
|
||||
@ -103,6 +116,12 @@ Beta fixes
|
||||
- Remove my.ha links from improv :esphomepr:`2695` by :ghuser:`jesserockz`
|
||||
- Only allow prometheus when using arduino :esphomepr:`2697` by :ghuser:`jesserockz`
|
||||
- Update device classes for binary sensors :esphomepr:`2703` by :ghuser:`lcavalli` (breaking-change)
|
||||
- Bump ESPAsyncWebServer to 2.1.0 :esphomepr:`2686` by :ghuser:`jesserockz`
|
||||
- Allow setting custom command_topic for Select and Number components :esphomepr:`2714` by :ghuser:`kbialek`
|
||||
- Restore InterruptLock on wifi-less ESP8266 :esphomepr:`2712` by :ghuser:`oxan`
|
||||
- Feed WDT between doing ESP32 touchpad measurements :esphomepr:`2720` by :ghuser:`oxan`
|
||||
- RemoteTransmitter fix. Bug from version 2021.10. Some changes. :esphomepr:`2706` by :ghuser:`dudanov`
|
||||
- Fix indentation of write_lambda for modbus_controller number :esphomepr:`2722` by :ghuser:`jesserockz`
|
||||
|
||||
All changes
|
||||
^^^^^^^^^^^
|
||||
@ -198,6 +217,12 @@ All changes
|
||||
- Remove my.ha links from improv :esphomepr:`2695` by :ghuser:`jesserockz`
|
||||
- Only allow prometheus when using arduino :esphomepr:`2697` by :ghuser:`jesserockz`
|
||||
- Update device classes for binary sensors :esphomepr:`2703` by :ghuser:`lcavalli` (breaking-change)
|
||||
- Bump ESPAsyncWebServer to 2.1.0 :esphomepr:`2686` by :ghuser:`jesserockz`
|
||||
- Allow setting custom command_topic for Select and Number components :esphomepr:`2714` by :ghuser:`kbialek`
|
||||
- Restore InterruptLock on wifi-less ESP8266 :esphomepr:`2712` by :ghuser:`oxan`
|
||||
- Feed WDT between doing ESP32 touchpad measurements :esphomepr:`2720` by :ghuser:`oxan`
|
||||
- RemoteTransmitter fix. Bug from version 2021.10. Some changes. :esphomepr:`2706` by :ghuser:`dudanov`
|
||||
- Fix indentation of write_lambda for modbus_controller number :esphomepr:`2722` by :ghuser:`jesserockz`
|
||||
|
||||
Past Changelogs
|
||||
---------------
|
||||
|
||||
@ -26,8 +26,7 @@ The example below is an example of a custom light output.
|
||||
LightTraits get_traits() override {
|
||||
// return the traits this light supports
|
||||
auto traits = LightTraits();
|
||||
traits.set_supports_brightness(true);
|
||||
traits.set_supports_color_modes({ColorMode::RGB});
|
||||
traits.set_supported_color_modes({ColorMode::RGB, ColorMode::BRIGHTNESS});
|
||||
return traits;
|
||||
}
|
||||
|
||||
|
||||
@ -20,8 +20,9 @@ and similar 1-Wire temperature sensors.
|
||||
To use your :ref:`dallas sensor <dallas-sensor>`, first define a dallas “hub” with a pin and
|
||||
id, which you will later use to create the sensors. The 1-Wire bus the
|
||||
sensors are connected to should have an external pullup resistor of
|
||||
about 4.7KΩ. For this, connect a resistor of *about* 4.7KΩ (values around that like 1KΩ will, if you don't have
|
||||
massively long wires, work fine in most cases) between ``3.3V`` and the data pin.
|
||||
about 4.7KΩ. For this, connect a resistor of *about* 4.7KΩ between ``3.3V``
|
||||
and the data pin. Values ± 1KΩ will, in most cases, work fine as well,
|
||||
if you don't have massively long wires.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
@ -38,7 +39,7 @@ massively long wires, work fine in most cases) between ``3.3V`` and the data pin
|
||||
Configuration variables:
|
||||
************************
|
||||
|
||||
- **pin** (**Required**, number): The pin the sensor bus is connected to.
|
||||
- **pin** (**Required**, number): The pin the sensor bus is connected to. Please note that 1-wire is a bi-directional bus so it requires both input and output from the pin.
|
||||
- **update_interval** (*Optional*, :ref:`config-time`): The interval that the sensors should be checked.
|
||||
Defaults to 60 seconds.
|
||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
||||
|
||||
2
conf.py
2
conf.py
@ -69,7 +69,7 @@ author = "Otto Winter"
|
||||
# The short X.Y version.
|
||||
version = "2021.11"
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = "2021.11.0b3"
|
||||
release = "2021.11.0b4"
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
||||
@ -351,6 +351,16 @@ The top level ``name:`` field in your .yaml file defines the node name(/hostname
|
||||
|
||||
Important: follow these `instructions </components/esphome.html#changing-esphome-node-name>`_ to use the ``use_address`` parameter when renaming a live device, as the connection to an existing device will only work with the old name until the name change is complete.
|
||||
|
||||
|
||||
Why am I getting a warning about strapping pins?
|
||||
--------------------------------------------------
|
||||
|
||||
The ESP chips have special "strapping pins" that are read during the bootup procedure and determine how it boots up. They define whether the ESP boots into a special "flashing mode" or normal boot and a couple of other internal settings.
|
||||
If an external pullup/down changes the configured voltage levels boot failures or hard to diagnose issues can happen.
|
||||
While the use of them in software is not a problem, if there's something attached to the pins (particularly if they're not floating during the bootup) you may run into problems.
|
||||
It's recommended to avoid them unless you have a pressing need to use them and you have reviewed the expected boot voltage levels of these pins from the ESP datasheet.
|
||||
|
||||
Note that some boards connect pins such as GPIO0 to a builtin tactile switch. In these cases using the strapping pins is not a problem.
|
||||
See Also
|
||||
--------
|
||||
|
||||
|
||||
@ -108,6 +108,7 @@ Contributors
|
||||
- `Brian Hanifin (@brianhanifin) <https://github.com/brianhanifin>`__
|
||||
- `brianrjones69 (@brianrjones69) <https://github.com/brianrjones69>`__
|
||||
- `buddydvd (@buddydvd) <https://github.com/buddydvd>`__
|
||||
- `bulburDE (@bulburDE) <https://github.com/bulburDE>`__
|
||||
- `buxtronix (@buxtronix) <https://github.com/buxtronix>`__
|
||||
- `bvansambeek (@bvansambeek) <https://github.com/bvansambeek>`__
|
||||
- `bwente (@bwente) <https://github.com/bwente>`__
|
||||
@ -125,6 +126,7 @@ Contributors
|
||||
- `John (@CircuitSetup) <https://github.com/CircuitSetup>`__
|
||||
- `Colby Rome (@cisasteelersfan) <https://github.com/cisasteelersfan>`__
|
||||
- `Chris Debenham (@cjd) <https://github.com/cjd>`__
|
||||
- `Clifford Roche (@cmroche) <https://github.com/cmroche>`__
|
||||
- `CODeRUS (@CODeRUS) <https://github.com/CODeRUS>`__
|
||||
- `Cody James (@codyjamestechnical) <https://github.com/codyjamestechnical>`__
|
||||
- `John Coggeshall (@coogle) <https://github.com/coogle>`__
|
||||
@ -249,6 +251,7 @@ Contributors
|
||||
- `frippe75 (@frippe75) <https://github.com/frippe75>`__
|
||||
- `Fritz Mueller (@fritzm) <https://github.com/fritzm>`__
|
||||
- `Marc Egli (@frog32) <https://github.com/frog32>`__
|
||||
- `frspp (@frspp) <https://github.com/frspp>`__
|
||||
- `mr G1K (@G1K) <https://github.com/G1K>`__
|
||||
- `Aljaž Srebrnič (@g5pw) <https://github.com/g5pw>`__
|
||||
- `Gabe Cook (@gabe565) <https://github.com/gabe565>`__
|
||||
@ -294,6 +297,7 @@ Contributors
|
||||
- `MoA (@honomoa) <https://github.com/honomoa>`__
|
||||
- `Hopperpop (@Hopperpop) <https://github.com/Hopperpop>`__
|
||||
- `Yang Hau (@HowJMay) <https://github.com/HowJMay>`__
|
||||
- `Antonio Vanegas (@hpsaturn) <https://github.com/hpsaturn>`__
|
||||
- `hreintke (@hreintke) <https://github.com/hreintke>`__
|
||||
- `Huub Eikens (@huubeikens) <https://github.com/huubeikens>`__
|
||||
- `Petr Urbánek (@HyperReap) <https://github.com/HyperReap>`__
|
||||
@ -358,6 +362,7 @@ Contributors
|
||||
- `kalebzettl (@kalebzettl) <https://github.com/kalebzettl>`__
|
||||
- `Karol Zlot (@karolzlot) <https://github.com/karolzlot>`__
|
||||
- `Krasimir Nedelchev (@kaykayehnn) <https://github.com/kaykayehnn>`__
|
||||
- `Krzysztof Białek (@kbialek) <https://github.com/kbialek>`__
|
||||
- `kbouchard111 (@kbouchard111) <https://github.com/kbouchard111>`__
|
||||
- `Keith Burzinski (@kbx81) <https://github.com/kbx81>`__
|
||||
- `Robert Kiss (@kepten) <https://github.com/kepten>`__
|
||||
@ -489,6 +494,7 @@ Contributors
|
||||
- `NMC (@ncareau) <https://github.com/ncareau>`__
|
||||
- `Nebula (@nebula-it) <https://github.com/nebula-it>`__
|
||||
- `needspeed (@needspeed) <https://github.com/needspeed>`__
|
||||
- `NeoAcheron (@NeoAcheron) <https://github.com/NeoAcheron>`__
|
||||
- `nepozs (@nepozs) <https://github.com/nepozs>`__
|
||||
- `Mike Meessen (@netmikey) <https://github.com/netmikey>`__
|
||||
- `nickrout (@nickrout) <https://github.com/nickrout>`__
|
||||
@ -611,7 +617,6 @@ Contributors
|
||||
- `Ryan Nazaretian (@ryannazaretian) <https://github.com/ryannazaretian>`__
|
||||
- `Silvio (@s1lvi0) <https://github.com/s1lvi0>`__
|
||||
- `Jan Čermák (@sairon) <https://github.com/sairon>`__
|
||||
- `samnewman86 (@samnewman86) <https://github.com/samnewman86>`__
|
||||
- `sascha lammers (@sascha432) <https://github.com/sascha432>`__
|
||||
- `Sascha (@Scarbous) <https://github.com/Scarbous>`__
|
||||
- `Nils Schulte (@Schnilz) <https://github.com/Schnilz>`__
|
||||
@ -624,7 +629,6 @@ Contributors
|
||||
- `sethcohn (@sethcohn) <https://github.com/sethcohn>`__
|
||||
- `Emanuele Tessore (@setola) <https://github.com/setola>`__
|
||||
- `Abdelkader Boudih (@seuros) <https://github.com/seuros>`__
|
||||
- `shaeed (@shaeed) <https://github.com/shaeed>`__
|
||||
- `SharkSharp (@SharkSharp) <https://github.com/SharkSharp>`__
|
||||
- `shbatm (@shbatm) <https://github.com/shbatm>`__
|
||||
- `sherbang (@sherbang) <https://github.com/sherbang>`__
|
||||
@ -747,4 +751,4 @@ Contributors
|
||||
- `ZTX18 (@ZTX18) <https://github.com/ZTX18>`__
|
||||
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
|
||||
|
||||
*This page was last updated November 12, 2021.*
|
||||
*This page was last updated November 15, 2021.*
|
||||
|
||||
Loading…
Reference in New Issue
Block a user