Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-12-26 17:27:47 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #2084 from esphome/bump-2022.5.0b3

Browse Source 
2022.5.0b3
This commit is contained in:
Jesse Hills 2022-05-16 13:42:26 +12:00 committed by GitHub
commit 318317f07b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 64 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Doxygen
View File

@ -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 = 2022.5.0b2
PROJECT_NUMBER = 2022.5.0b3
# 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
View File

@ -1,5 +1,5 @@
ESPHOME_PATH = ../esphome
ESPHOME_REF = 2022.5.0b2
ESPHOME_REF = 2022.5.0b3
.PHONY: html html-strict cleanhtml deploy help live-html Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify

2
_static/version
View File

@ -1 +1 @@
2022.5.0b2
2022.5.0b3

2
changelog/2022.3.0.rst
View File

@ -16,7 +16,7 @@ ESPHome 2022.3.0 - 16th March 2022
MPU6886, components/sensor/mpu6886, mpu6886.jpg
MCP4728, components/output/mcp4728, mcp4728.jpg
Honeywell ABP, components/sensor/honeywellabp, honeywellabp.jpg
Mopeka Pro Check LP, components/sensor/mopeka_ble, mopeka_pro_check.jpg
Mopeka Pro Check LP, components/sensor/mopeka_pro_check, mopeka_pro_check.jpg
Python 3.8 Minimum
------------------

9
changelog/2022.5.0.rst
View File

@ -62,6 +62,8 @@ Beta Changes
- Use heat mode for heat. Move EXT HT to custom presets. :esphomepr:`3437` by :ghuser:`jgissend10`
- Make custom_fan and custom_preset templatable as per documentation :esphomepr:`3330` by :ghuser:`MrMDavidson`
- Update captive portal canHandle function :esphomepr:`3360` by :ghuser:`bkaufx`
- Increase JSON buffer size on overflow :esphomepr:`3475` by :ghuser:`pyos`
- Mark improv_serial and ESP-IDF usb based serial on c3/s2/s3 unsupported :esphomepr:`3477` by :ghuser:`jesserockz`
All changes
^^^^^^^^^^^
@ -121,6 +123,13 @@ All changes
- Enable api transport encryption for new projects :esphomepr:`3142` by :ghuser:`OttoWinter` (notable-change)
- Implement allow_deep_sleep :esphomepr:`3282` by :ghuser:`rubdos`
- Add deep_sleep.allow YAML action :esphomepr:`3459` by :ghuser:`jesserockz`
- Restore RealTimeClock's local TZ after epoch sync :esphomepr:`3462` by :ghuser:`mmakaay`
- Shelly dimmer: Use unique_ptr to handle the lifetime of stm32_t :esphomepr:`3400` by :ghuser:`edge90`
- Use heat mode for heat. Move EXT HT to custom presets. :esphomepr:`3437` by :ghuser:`jgissend10`
- Make custom_fan and custom_preset templatable as per documentation :esphomepr:`3330` by :ghuser:`MrMDavidson`
- Update captive portal canHandle function :esphomepr:`3360` by :ghuser:`bkaufx`
- Increase JSON buffer size on overflow :esphomepr:`3475` by :ghuser:`pyos`
- Mark improv_serial and ESP-IDF usb based serial on c3/s2/s3 unsupported :esphomepr:`3477` by :ghuser:`jesserockz`
Past Changelogs
---------------

2
components/binary_sensor/analog_threshold.rst
View File

@ -9,7 +9,7 @@ The ``analog_threshold`` binary sensor platform allows you to convert analog val
(i.e. :doc:`sensor </components/sensor/index>` readings)
into boolean values, using a threshold as a reference.
When the signal is above or equal to the threshold the binary sensor is ``true``
(this behavior can be changed adding and ``invert`` filter).
(this behavior can be changed by adding an ``invert`` filter).
It provides an *hysteresis* option to reduce instability when the source signal is noisy
using different limits depending on the current state.

24
components/sensor/inkbird_ibsth1_mini.rst
View File

@ -1,22 +1,26 @@
Inkbird IBS-TH1 and IBS-TH1 Mini BLE Sensor
===========================================
Inkbird IBS-TH1, IBS-TH1 Mini, and IBS-TH2 BLE Sensor
=====================================================
.. seo::
:description: Instructions for setting up Inkbird IBS-TH1 Bluetooth-based temperature and humidity sensors in ESPHome.
:description: Instructions for setting up Inkbird IBS-TH1/TH2 Bluetooth-based temperature and humidity sensors in ESPHome.
:image: inkbird_isbth1_mini.jpg
:keywords: Inkbird, BLE, Bluetooth, IBS-TH1
:keywords: Inkbird, BLE, Bluetooth, IBS-TH1, IBS-TH2
The ``inkbird_ibsth1_mini`` sensor platform lets you track the output of Inkbird IBS-TH1 and IBS-TH1 Mini Bluetooth
The ``inkbird_ibsth1_mini`` sensor platform lets you track the output of Inkbird IBS-TH1, IBS-TH1 Mini, and IBS-TH2 Bluetooth
Low Energy devices using the :doc:`/components/esp32_ble_tracker`. This component will track the
temperature, external temperature (non mini only), humidity and the battery level of the IBS-TH1 device every time the
sensor sends out a BLE broadcast. Note that contrary to other implementations, ESPHome can track as
many IBS-TH1 devices at once as you want.
many IBS-TH1/TH2 devices at once as you want.
.. note::
If an external temperature sensor is connected to the IBS-TH1, measurement from the internal sensor is not sent.
Only one sensor will work at a time.
.. note::
The external temperature sensor is not supported on the IBS-TH1 Mini or IBS-TH2
.. figure:: images/inkbird_isbth1_mini-full.jpg
:align: center
:width: 80.0%
@ -76,7 +80,7 @@ Configuration variables:
Setting Up Devices
------------------
To set up Inkbird IBS-TH1 devices you first need to find their MAC Address so that ESPHome can
To set up Inkbird IBS-TH1/TH2 devices you first need to find their MAC Address so that ESPHome can
identify them. So first, create a simple configuration without any ``inkbird_ibsth1_mini`` entries
like so:
@ -84,7 +88,7 @@ like so:
esp32_ble_tracker:
After uploading the ESP32 will immediately try to scan for BLE devices such as the Inkbird IBS-TH1.
After uploading the ESP32 will immediately try to scan for BLE devices such as the Inkbird IBS-TH1/TH2.
When it detects these sensors, it will automatically parse the BLE message print a
message like this one:
@ -95,7 +99,7 @@ message like this one:
[13:36:43][D][esp32_ble_tracker:567]: Name: 'sps'
Note that it can sometimes take some time for the first BLE broadcast to be received. Please note that address type
should say 'PUBLIC' and the device name should be 'sps', this is how you find the Inkbird IBS-TH1 among all the
should say 'PUBLIC' and the device name should be 'sps', this is how you find the Inkbird IBS-TH1/TH2 among all the
other devices.
Then just copy the address (``38:81:D7:0A:9C:11``) into a new ``sensor.inkbird_ibsth1_mini`` platform
@ -103,7 +107,7 @@ entry like in the configuration example at the top.
.. note::
The ESPHome Inkbird IBS-TH1 integration listens passively to packets the device sends by itself.
The ESPHome Inkbird IBS-TH1/TH2 integration listens passively to packets the device sends by itself.
ESPHome therefore has no impact on the battery life of the device.
See Also

26
components/tuya.rst
View File

@ -40,12 +40,38 @@ Here is an example output for a Tuya fan controller:
[12:39:45][C][tuya:032]: Datapoint 9: switch (value: OFF)
[12:39:45][C][tuya:046]: Product: '{"p":"hqq73kftvzh8c92u","v":"1.0.0","m":0}'
Here is another example output for a Tuya ME-81H thermostat:
.. code-block:: text
[08:51:09][C][tuya:032]: Tuya:
[08:51:09][C][tuya:043]: Datapoint 1: switch (value: ON)
[08:51:09][C][tuya:045]: Datapoint 24: int value (value: 220)
[08:51:09][C][tuya:045]: Datapoint 16: int value (value: 22)
[08:51:09][C][tuya:049]: Datapoint 2: enum (value: 1)
[08:51:09][C][tuya:045]: Datapoint 19: int value (value: 40)
[08:51:09][C][tuya:045]: Datapoint 101: int value (value: 1)
[08:51:09][C][tuya:045]: Datapoint 27: int value (value: -2)
[08:51:09][C][tuya:049]: Datapoint 43: enum (value: 1)
[08:51:09][C][tuya:049]: Datapoint 102: enum (value: 1)
[08:51:09][C][tuya:051]: Datapoint 45: bitmask (value: 0)
[08:51:09][C][tuya:043]: Datapoint 10: switch (value: ON)
[08:51:09][C][tuya:041]: Datapoint 38: raw (value: 06.00.14.08.00.0F.0B.1E.0F.0C.1E.0F.11.00.16.16.00.0F.08.00.16.17.00.0F (24))
[08:51:09][C][tuya:049]: Datapoint 36: enum (value: 1)
[08:51:09][C][tuya:057]: GPIO Configuration: status: pin 14, reset: pin 0 (not supported)
[08:51:09][C][tuya:061]: Status Pin: GPIO14
[08:51:09][C][tuya:063]: Product: '{"p":"gogb05wrtredz3bs","v":"1.0.0","m":0}'
Configuration variables:
------------------------
- **time_id** (*Optional*, :ref:`config-id`): Some Tuya devices support obtaining local time from ESPHome.
Specify the ID of the :ref:`Time Component <time>` which will be used.
- **status_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): Some Tuya devices support WiFi status reporting ONLY through gpio pin.
Specify the pin reported in the config dump or leave empty otherwise.
More about this `here <https://developer.tuya.com/en/docs/iot/tuya-cloud-universal-serial-port-access-protocol?id=K9hhi0xxtn9cb#title-6-Query%20working%20mode>`__.
- **ignore_mcu_update_on_datapoints** (*Optional*, list): A list of datapoints to ignore MCU updates for. Useful for certain broken/erratic hardware and debugging.
Automations:

2
conf.py
View File

@ -68,7 +68,7 @@ author = "ESPHome"
# The short X.Y version.
version = "2022.5"
# The full version, including alpha/beta/rc tags.
release = "2022.5.0b2"
release = "2022.5.0b3"
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

11
guides/supporters.rst
View File

@ -94,6 +94,7 @@ Contributors
- `bazuchan (@bazuchan) <https://github.com/bazuchan>`__
- `Viktr (@BbIKTOP) <https://github.com/BbIKTOP>`__
- `J. Nick Koston (@bdraco) <https://github.com/bdraco>`__
- `Maxim Ocheretianko (@bearpawmaxim) <https://github.com/bearpawmaxim>`__
- `Benno Pütz (@bennop) <https://github.com/bennop>`__
- `Ben Suffolk (@bensuffolk) <https://github.com/bensuffolk>`__
- `Arturo Casal (@berfenger) <https://github.com/berfenger>`__
@ -122,6 +123,7 @@ Contributors
- `buxtronix (@buxtronix) <https://github.com/buxtronix>`__
- `bvansambeek (@bvansambeek) <https://github.com/bvansambeek>`__
- `calco88 (@calco88) <https://github.com/calco88>`__
- `Cal Howard (@calhoward) <https://github.com/calhoward>`__
- `Carlos Gustavo Sarmiento (@carlos-sarmiento) <https://github.com/carlos-sarmiento>`__
- `Carlos Garcia Saura (@CarlosGS) <https://github.com/CarlosGS>`__
- `Carlos Ruiz (@CarlosRDomin) <https://github.com/CarlosRDomin>`__
@ -134,6 +136,7 @@ Contributors
- `chris-jennings (@chris-jennings) <https://github.com/chris-jennings>`__
- `Christian Taedcke (@chrta) <https://github.com/chrta>`__
- `Pavel Skuratovich (@Chupaka) <https://github.com/Chupaka>`__
- `Chris Johnson (@ciband) <https://github.com/ciband>`__
- `John (@CircuitSetup) <https://github.com/CircuitSetup>`__
- `Colby Rome (@cisasteelersfan) <https://github.com/cisasteelersfan>`__
- `Chris Debenham (@cjd) <https://github.com/cjd>`__
@ -366,6 +369,7 @@ Contributors
- `Jonathan Burns (@jburns20) <https://github.com/jburns20>`__
- `James Callaghan (@jcallaghan) <https://github.com/jcallaghan>`__
- `Josh Willox (@jcwillox) <https://github.com/jcwillox>`__
- `jddonovan (@jddonovan) <https://github.com/jddonovan>`__
- `JeeCee1 (@JeeCee1) <https://github.com/JeeCee1>`__
- `jeff-h (@jeff-h) <https://github.com/jeff-h>`__
- `Jeffrey Borg (@jeffborg) <https://github.com/jeffborg>`__
@ -397,6 +401,7 @@ Contributors
- `Joshua Spence (@joshuaspence) <https://github.com/joshuaspence>`__
- `Joscha Wagner (@jowgn) <https://github.com/jowgn>`__
- `jsuanet (@jsuanet) <https://github.com/jsuanet>`__
- `junnikokuki (@junnikokuki) <https://github.com/junnikokuki>`__
- `Justahobby01 (@Justahobby01) <https://github.com/Justahobby01>`__
- `Mike Ryan (@justfalter) <https://github.com/justfalter>`__
- `Justin Gerhardt (@justin-gerhardt) <https://github.com/justin-gerhardt>`__
@ -628,6 +633,7 @@ Contributors
- `Patrick Toal (@ptoal) <https://github.com/ptoal>`__
- `Leandro Puerari (@puerari) <https://github.com/puerari>`__
- `puuu (@puuu) <https://github.com/puuu>`__
- `[pʲɵs] (@pyos) <https://github.com/pyos>`__
- `QbaF (@QbaF) <https://github.com/QbaF>`__
- `Qc (@qc24) <https://github.com/qc24>`__
- `Karol Zlot (@qqgg231) <https://github.com/qqgg231>`__
@ -724,7 +730,6 @@ Contributors
- `sredfern (@sredfern) <https://github.com/sredfern>`__
- `Samuel Sieb (@ssieb) <https://github.com/ssieb>`__
- `St4n (@St4n) <https://github.com/St4n>`__
- `Stefan (@stefanroelofs) <https://github.com/stefanroelofs>`__
- `stegm (@stegm) <https://github.com/stegm>`__
- `Steve Baxter (@stevebaxter) <https://github.com/stevebaxter>`__
- `Stewart (@stewiem2000) <https://github.com/stewiem2000>`__
@ -749,7 +754,6 @@ Contributors
- `Nejc (@thedexboy) <https://github.com/thedexboy>`__
- `Thomas Eckerstorfer (@TheEggi) <https://github.com/TheEggi>`__
- `TheGroundZero (@TheGroundZero) <https://github.com/TheGroundZero>`__
- `Spencer Hachmeister (@TheHackmeister) <https://github.com/TheHackmeister>`__
- `thejonesyboy (@thejonesyboy) <https://github.com/thejonesyboy>`__
- `TheJulianJES (@TheJulianJES) <https://github.com/TheJulianJES>`__
- `Mateusz Soszyński (@TheLastGimbus) <https://github.com/TheLastGimbus>`__
@ -808,7 +812,6 @@ Contributors
- `John "Warthog9" Hawley (@warthog9) <https://github.com/warthog9>`__
- `Wauter (@Wauter) <https://github.com/Wauter>`__
- `WeekendWarrior1 (@WeekendWarrior1) <https://github.com/WeekendWarrior1>`__
- `Spenser Bushey (@Weldawadyathink) <https://github.com/Weldawadyathink>`__
- `Ian Wells (@wellsi) <https://github.com/wellsi>`__
- `wifwucite (@wifwucite) <https://github.com/wifwucite>`__
- `wilberforce (@wilberforce) <https://github.com/wilberforce>`__
@ -839,4 +842,4 @@ Contributors
- `Michael Labuschke (@zigman79) <https://github.com/zigman79>`__
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
*This page was last updated May 12, 2022.*
*This page was last updated May 16, 2022.*

4
index.rst
View File

@ -222,7 +222,7 @@ Bluetooth Low Energy (BLE)
BLE Client Sensor, components/sensor/ble_client, bluetooth.svg
BLE RSSI, components/sensor/ble_rssi, bluetooth.svg
Inkbird IBS-TH1 Mini, components/sensor/inkbird_ibsth1_mini, inkbird_isbth1_mini.jpg, Temperature & Humidity
Mopeka Pro Check LP, components/sensor/mopeka_ble, mopeka_pro_check.jpg, tank level
Mopeka Pro Check LP, components/sensor/mopeka_pro_check, mopeka_pro_check.jpg, tank level
RuuviTag, components/sensor/ruuvitag, ruuvitag.jpg, Temperature & Humidity & Accelerometer
Xiaomi BLE, components/sensor/xiaomi_ble, xiaomi_mijia_logo.jpg, Various
@ -468,7 +468,7 @@ Light Components
Light Partition, components/light/partition, color_lens.svg
Tuya Dimmer, components/light/tuya, tuya.png
Shelly Dimmer, components/light/shelly_dimmer, shellydimmer2.jpg
Shelly Dimmer, components/light/shelly_dimmer, shellydimmer2.jpg
Custom Light, components/light/custom, language-cpp.svg
H-bridge Light, components/light/hbridge, brightness-medium.svg