Merge pull request #2421 from esphome/bump-2022.11.0b2

2022.11.0b2
This commit is contained in:
Jesse Hills 2022-11-10 13:33:34 +13:00 committed by GitHub
commit 3d01d614d2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 236 additions and 17 deletions

View File

@ -38,7 +38,7 @@ PROJECT_NAME = "ESPHome"
# could be handy for archiving the generated documentation or if some version # could be handy for archiving the generated documentation or if some version
# control system is used. # control system is used.
PROJECT_NUMBER = 2022.11.0b1 PROJECT_NUMBER = 2022.11.0b2
# Using the PROJECT_BRIEF tag one can provide an optional one line description # 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 # for a project that appears at the top of each page and should give viewer a

View File

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

View File

@ -1 +1 @@
2022.11.0b1 2022.11.0b2

View File

@ -3,27 +3,74 @@ ESPHome 2022.11.0 - 16th November 2022
.. seo:: .. seo::
:description: Changelog for ESPHome 2022.11.0. :description: Changelog for ESPHome 2022.11.0.
:image: /_static/changelog-2022.10.0.png :image: /_static/changelog-2022.11.0.png
:author: Jesse Hills :author: Jesse Hills
:author_twitter: @jesserockz :author_twitter: @jesserockz
.. imgtable:: .. imgtable::
:columns: 2 :columns: 4
RP2040, components/rp2040, rp2040.svg
WL-134 Pet Tag Sensor , components/text_sensor/wl_134, fingerprint.svg
Ethernet Info, components/text_sensor/ethernet_info, ethernet.svg
Atlas Scientific Peristaltic Pump, components/ezo_pmp, ezo-pmp.jpg
ADC128S102, components/sensor/adc128s102, adc128s102.png
Daikin BRC, components/climate/climate_ir, air-conditioner-ir.svg
Display Menu Core, components/display_menu/index, folder-open.svg
LCD Menu, components/display_menu/lcd_menu, lcd_menu.png
Raspberry Pi Pico-W Raspberry Pi Pico-W
------------------- -------------------
To be written... What can I say... I (Jesse) started working on making ESPHome run on the original Raspberry Pi
Pico one random weekend just for fun with no real intention of taking it further myself.
Little did I know there would be a Raspberry Pi Pico-W released earlier this year which sparked
up interest in continuing that PR and almost fully implementing RP2040 and the Pico-W as
a supported platform in ESPHome.
There are things that have not been tested, and most likely things that will not work, so
please `create or search for an issue <https://github.com/esphome/issues/issues>`__ if this is the case.
Looking forward to seeing peoples projects built on these boards running ESPHome.
Script Parameters Script Parameters
----------------- -----------------
To be written... Thanks :ghuser:`jimtng` for taking the time to implement a feature requested by many people over time.
Parameters on scripts are now a thing.
.. code-block:: yaml
script:
- id: push_button
parameters:
button: int
then:
- logger.log:
format: "Button %d pressed"
args: [ button ]
on_...:
- script.execute:
id: push_button
button: 1
on_...:
- script.execute:
id: push_button
button: 2
LCD Menu LCD Menu
-------- --------
Another great feature added this release is the LCD Menu. This allows a user to build a simple (or complex)
menu system on an lcd display within ESPHome YAML, with support for switches, numbers, selects etc.
Thanks :ghuser:`numo68`.
Preserving User WiFi Credentials
--------------------------------
To be written... To be written...
@ -51,6 +98,14 @@ Breaking Changes
- Don't Use Base Network Manual IP for WiFi AP :esphomepr:`3902` by :ghuser:`bkaufx` (breaking-change) - Don't Use Base Network Manual IP for WiFi AP :esphomepr:`3902` by :ghuser:`bkaufx` (breaking-change)
Beta Changes
^^^^^^^^^^^^
- Update set-output to use new GITHUB_OUTPUT :esphomepr:`4008` by :ghuser:`jesserockz`
- Add cover toggle support to current based cover :esphomepr:`3950` by :ghuser:`maringeph`
- Add option for dashboard command to only generate the project and supporting files :esphomepr:`3981` by :ghuser:`jesserockz`
- Fix local webserver based on esphome/esphome-webserver#17 :esphomepr:`3958` by :ghuser:`RoboMagus`
All changes All changes
^^^^^^^^^^^ ^^^^^^^^^^^
@ -114,3 +169,39 @@ All changes
- Enable calibration, callbacks and custom commands for EZO sensors :esphomepr:`3910` by :ghuser:`gvdhoven` - Enable calibration, callbacks and custom commands for EZO sensors :esphomepr:`3910` by :ghuser:`gvdhoven`
- Bump esphome-dashboard to 20221109.0 :esphomepr:`4006` by :ghuser:`jesserockz` - Bump esphome-dashboard to 20221109.0 :esphomepr:`4006` by :ghuser:`jesserockz`
- Add support for parameters in scripts :esphomepr:`3538` by :ghuser:`jimtng` - Add support for parameters in scripts :esphomepr:`3538` by :ghuser:`jimtng`
- Update set-output to use new GITHUB_OUTPUT :esphomepr:`4008` by :ghuser:`jesserockz`
- Add cover toggle support to current based cover :esphomepr:`3950` by :ghuser:`maringeph`
- Add option for dashboard command to only generate the project and supporting files :esphomepr:`3981` by :ghuser:`jesserockz`
- Fix local webserver based on esphome/esphome-webserver#17 :esphomepr:`3958` by :ghuser:`RoboMagus`
Past Changelogs
---------------
- :doc:`2022.10.0`
- :doc:`2022.9.0`
- :doc:`2022.8.0`
- :doc:`2022.6.0`
- :doc:`2022.5.0`
- :doc:`2022.4.0`
- :doc:`2022.3.0`
- :doc:`2022.2.0`
- :doc:`2022.1.0`
- :doc:`2021.12.0`
- :doc:`2021.11.0`
- :doc:`2021.10.0`
- :doc:`2021.9.0`
- :doc:`2021.8.0`
- :doc:`v1.20.0`
- :doc:`v1.19.0`
- :doc:`v1.18.0`
- :doc:`v1.17.0`
- :doc:`v1.16.0`
- :doc:`v1.15.0`
- :doc:`v1.14.0`
- :doc:`v1.13.0`
- :doc:`v1.12.0`
- :doc:`v1.11.0`
- :doc:`v1.10.0`
- :doc:`v1.9.0`
- :doc:`v1.8.0`
- :doc:`v1.7.0`

View File

@ -9,6 +9,8 @@ EZO sensor circuits
The ``ezo`` sensor platform allows you to use your EZO sensor circuits with The ``ezo`` sensor platform allows you to use your EZO sensor circuits with
ESPHome. The :ref:`I²C Bus <i2c>` is ESPHome. The :ref:`I²C Bus <i2c>` is
required to be set up in your configuration for this sensor to work. required to be set up in your configuration for this sensor to work.
All embedded solutions from EZO can be found `here <https://atlas-scientific.com/embedded-solutions/>`__.
If a certain command is not supported directly, it can be executed with the ``send_custom()`` method call.
.. figure:: images/ezo-ph-circuit.png .. figure:: images/ezo-ph-circuit.png
:align: center :align: center
@ -43,20 +45,145 @@ Configuration variables:
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`. - All other options from :ref:`Sensor <config-sensor>`.
.. _evo_callbacks:
Callbacks
---------
- **on_led:** : Triggered when the result of ``get_led_state()`` is ready. The LED state is provided as a boolean variable named ``x``.
- **on_device_information:** : Triggered when the result of ``get_device_information()`` is ready. The result is provided as a ``std::string`` variable named ``x``.
- **on_slope:** : Triggered when the result of ``get_slope()`` is ready. The result is provided as a ``std::string`` variable named ``x``.
- **on_calibration:** : Triggered when the result of ``get_calibration()`` is ready. The result is provided as a ``std::string`` variable named ``x``.
- **on_t:** : Triggered when the result of ``get_t()`` is ready. The result is provided as a ``std::string`` variable named ``x``.
- **on_custom:** : Triggered when the result of ``get_custom()`` is ready. The result is provided as a ``std::string`` variable named ``x``.
.. _evo_lambda_calls:
lambda calls lambda calls
------------ ------------
From :ref:`lambdas <config-lambda>`, you can set the temperature compensation for the From :ref:`lambdas <config-lambda>`, you can interact with the sensor in various ways. For any ``get`` command a trigger will be called with the information retrieved from the sensor. See :ref:`evo_callbacks`. For more information on the command specifics, refer to the datasheet.
sensors that support that option.
- ``set_tempcomp_value()``: Send the given temperature to the sensor. - ``set_i2c(uint8_t address)``: Set I2C address of the device, must be an integer between 1 and 127
.. code-block:: cpp
id(ph_ezo).set_i2c(100);
- ``get_device_information()``: Sensor retrieves calibration and triggers ``on_device_information:`` once done
.. code-block:: cpp
id(ph_ezo).get_device_information();
- ``set_sleep()``: Put the device to sleep
.. code-block:: cpp
id(ph_ezo).set_sleep();
- ``get_state()``: Performs a read on the current sensor.
.. code-block:: cpp
id(ph_ezo).get_state();
- ``get_slope()``: Sensor retrieves slope and triggers ``on_slope:`` once done
.. code-block:: cpp
id(ph_ezo).get_slope();
- ``get_t()``: Sensor retrieves temperature compensation value (in Celcius) and triggers ``on_t:`` once done
.. code-block:: cpp
id(ph_ezo).get_t();
- ``set_t(float value)``: Send the given temperature (in Celcius) to the sensor.
.. code-block:: cpp
id(ph_ezo).set_t("27.00");
- ``set_tempcomp_value(float temp)``: Send the given temperature (in Celcius) to the sensor (this is an alias of `set_t()` for backwards compatibility)
.. code-block:: cpp .. code-block:: cpp
// Within a lambda, set the temperature compensation value from the temperature sensor
id(ph_ezo).set_tempcomp_value(id(rtd_ezo).state); id(ph_ezo).set_tempcomp_value(id(rtd_ezo).state);
- ``get_calibration()``: Sensor retrieves calibration and triggers ``on_calibration:`` once done
.. code-block:: cpp
id(ph_ezo).get_calibration();
- ``set_calibration_generic(float value)``: Sets the calibration with no point.
.. code-block:: cpp
id(ph_ezo).set_calibration_generic(750.0);
- ``set_calibration_point_low(float value)``: Sets the low calibration point.
.. code-block:: cpp
id(ph_ezo).set_calibration_point_low(4.00);
- ``set_calibration_point_mid(float value)``: Sets the medium calibration point.
.. code-block:: cpp
id(ph_ezo).set_calibration_point_mid(7.00);
- ``set_calibration_point_high(float value)``: Sets the high calibration point.
.. code-block:: cpp
id(ph_ezo).set_calibration_point_low(10.00);
- ``clear_calibration()``: Clears all calibration points.
.. code-block:: cpp
id(ph_ezo).clear_calibration();
- ``get_led_state()``: Sensor LED state and triggers ``on_led:`` once done
.. code-block:: cpp
id(ph_ezo).get_led_state();
- ``set_led_state(bool on)``: Sensor LED on or off
.. code-block:: cpp
id(ph_ezo).set_led_state(true);
- ``send_custom(const std::string &payload, uint16_t delay_ms = 300, bool response_expected = false)``: Runs a custom command. This sends exactly what is in ``payload``. Optionally you can set a ``delay`` and if a response is expected that should be parsed. Defaults to ``false`` for custom commands. Triggers ``on_custom:`` if there's a response.
.. code-block:: cpp
// Run a custom command to turn on the LED
id(ph_ezo).send_custom("L,1");
See Also See Also
-------- --------

View File

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

View File

@ -17,7 +17,6 @@ Contributors
(in alphabetical order) (in alphabetical order)
- `0hax (@0hax) <https://github.com/0hax>`__ - `0hax (@0hax) <https://github.com/0hax>`__
- `Nikola (@0nikola1) <https://github.com/0nikola1>`__
- `0x0a11c0de (@0x0a11c0de) <https://github.com/0x0a11c0de>`__ - `0x0a11c0de (@0x0a11c0de) <https://github.com/0x0a11c0de>`__
- `Tercio Filho (@0x3333) <https://github.com/0x3333>`__ - `Tercio Filho (@0x3333) <https://github.com/0x3333>`__
- `2016for (@2016for) <https://github.com/2016for>`__ - `2016for (@2016for) <https://github.com/2016for>`__
@ -165,7 +164,9 @@ Contributors
- `Clifford Roche (@cmroche) <https://github.com/cmroche>`__ - `Clifford Roche (@cmroche) <https://github.com/cmroche>`__
- `code-review-doctor (@code-review-doctor) <https://github.com/code-review-doctor>`__ - `code-review-doctor (@code-review-doctor) <https://github.com/code-review-doctor>`__
- `CODeRUS (@CODeRUS) <https://github.com/CODeRUS>`__ - `CODeRUS (@CODeRUS) <https://github.com/CODeRUS>`__
- `Nick (@codewise-nicolas) <https://github.com/codewise-nicolas>`__
- `Cody James (@codyjamestechnical) <https://github.com/codyjamestechnical>`__ - `Cody James (@codyjamestechnical) <https://github.com/codyjamestechnical>`__
- `Colin Leroy-Mira (@colinleroy) <https://github.com/colinleroy>`__
- `Conclusio (@Conclusio) <https://github.com/Conclusio>`__ - `Conclusio (@Conclusio) <https://github.com/Conclusio>`__
- `John Coggeshall (@coogle) <https://github.com/coogle>`__ - `John Coggeshall (@coogle) <https://github.com/coogle>`__
- `James Crook (@cooljimy84) <https://github.com/cooljimy84>`__ - `James Crook (@cooljimy84) <https://github.com/cooljimy84>`__
@ -433,6 +434,7 @@ Contributors
- `Joe (@jhansche) <https://github.com/jhansche>`__ - `Joe (@jhansche) <https://github.com/jhansche>`__
- `Jim Bauwens (@jimbauwens) <https://github.com/jimbauwens>`__ - `Jim Bauwens (@jimbauwens) <https://github.com/jimbauwens>`__
- `jimtng (@jimtng) <https://github.com/jimtng>`__ - `jimtng (@jimtng) <https://github.com/jimtng>`__
- `Jeroen (@jjansen85) <https://github.com/jjansen85>`__
- `Jérémy JOURDIN (@JJK801) <https://github.com/JJK801>`__ - `Jérémy JOURDIN (@JJK801) <https://github.com/JJK801>`__
- `Jonathan Jefferies (@jjok) <https://github.com/jjok>`__ - `Jonathan Jefferies (@jjok) <https://github.com/jjok>`__
- `John K. Luebs (@jkl1337) <https://github.com/jkl1337>`__ - `John K. Luebs (@jkl1337) <https://github.com/jkl1337>`__
@ -615,7 +617,6 @@ Contributors
- `Martin Weinelt (@mweinelt) <https://github.com/mweinelt>`__ - `Martin Weinelt (@mweinelt) <https://github.com/mweinelt>`__
- `Igor Scheller (@MyIgel) <https://github.com/MyIgel>`__ - `Igor Scheller (@MyIgel) <https://github.com/MyIgel>`__
- `Mynasru (@Mynasru) <https://github.com/Mynasru>`__ - `Mynasru (@Mynasru) <https://github.com/Mynasru>`__
- `Niels Ulrik Andersen (@myplacedk) <https://github.com/myplacedk>`__
- `Kevin Uhlir (@n0bel) <https://github.com/n0bel>`__ - `Kevin Uhlir (@n0bel) <https://github.com/n0bel>`__
- `Erik Näsström (@Naesstrom) <https://github.com/Naesstrom>`__ - `Erik Näsström (@Naesstrom) <https://github.com/Naesstrom>`__
- `H. Árkosi Róbert (@nagyrobi) <https://github.com/nagyrobi>`__ - `H. Árkosi Róbert (@nagyrobi) <https://github.com/nagyrobi>`__
@ -638,9 +639,7 @@ Contributors
- `niklasweber (@niklasweber) <https://github.com/niklasweber>`__ - `niklasweber (@niklasweber) <https://github.com/niklasweber>`__
- `Niorix (@Niorix) <https://github.com/Niorix>`__ - `Niorix (@Niorix) <https://github.com/Niorix>`__
- `Zvonimir Haramustek (@nitko12) <https://github.com/nitko12>`__ - `Zvonimir Haramustek (@nitko12) <https://github.com/nitko12>`__
- `Nikolay Kitanov (@nkitanov) <https://github.com/nkitanov>`__
- `nldroid (@nldroid) <https://github.com/nldroid>`__ - `nldroid (@nldroid) <https://github.com/nldroid>`__
- `Nicolas Liaudat (@nliaudat) <https://github.com/nliaudat>`__
- `Niccolò Maggioni (@nmaggioni) <https://github.com/nmaggioni>`__ - `Niccolò Maggioni (@nmaggioni) <https://github.com/nmaggioni>`__
- `Jan Sandbrink (@NobodysNightmare) <https://github.com/NobodysNightmare>`__ - `Jan Sandbrink (@NobodysNightmare) <https://github.com/NobodysNightmare>`__
- `Łukasz Śliwiński (@nonameplum) <https://github.com/nonameplum>`__ - `Łukasz Śliwiński (@nonameplum) <https://github.com/nonameplum>`__
@ -658,6 +657,7 @@ Contributors
- `Oğuzhan Başer (@oguzhanbaser) <https://github.com/oguzhanbaser>`__ - `Oğuzhan Başer (@oguzhanbaser) <https://github.com/oguzhanbaser>`__
- `Omar Ghader (@omarghader) <https://github.com/omarghader>`__ - `Omar Ghader (@omarghader) <https://github.com/omarghader>`__
- `Ömer Şiar Baysal (@omersiar) <https://github.com/omersiar>`__ - `Ömer Şiar Baysal (@omersiar) <https://github.com/omersiar>`__
- `optimusprimespace (@optimusprimespace) <https://github.com/optimusprimespace>`__
- `Oscar Bolmsten (@oscar-b) <https://github.com/oscar-b>`__ - `Oscar Bolmsten (@oscar-b) <https://github.com/oscar-b>`__
- `Trammell Hudson (@osresearch) <https://github.com/osresearch>`__ - `Trammell Hudson (@osresearch) <https://github.com/osresearch>`__
- `Otamay (@Otamay) <https://github.com/Otamay>`__ - `Otamay (@Otamay) <https://github.com/Otamay>`__
@ -897,4 +897,4 @@ Contributors
- `Zack Barett (@zsarnett) <https://github.com/zsarnett>`__ - `Zack Barett (@zsarnett) <https://github.com/zsarnett>`__
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__ - `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
*This page was last updated November 9, 2022.* *This page was last updated November 10, 2022.*

View File

@ -697,6 +697,7 @@ Misc Components
PipSolar - compatible PV Inverter, components/pipsolar, pipsolar.jpg PipSolar - compatible PV Inverter, components/pipsolar, pipsolar.jpg
Grow Fingerprint Reader, components/fingerprint_grow, fingerprint.svg Grow Fingerprint Reader, components/fingerprint_grow, fingerprint.svg
SML, components/sml, sml.svg SML, components/sml, sml.svg
Atlas Scientific Peristaltic Pump, components/ezo_pmp, ezo-pmp.jpg
Demo, components/demo, description.svg Demo, components/demo, description.svg
Copy, components/copy, content-copy.svg Copy, components/copy, content-copy.svg