mirror of
https://github.com/esphome/esphome-docs.git
synced 2025-04-02 18:06:51 +02:00
Jesse Hills
GitHub
commit
b2169a37db
2
.github/workflows/component-image.yml
vendored
2
.github/workflows/component-image.yml
vendored
@ -50,7 +50,7 @@ jobs:
|
||||
component: ${{ needs.prepare.outputs.name }}
|
||||
|
||||
- name: Upload
|
||||
uses: actions/upload-artifact@v4.3.4
|
||||
uses: actions/upload-artifact@v4.4.3
|
||||
id: upload-artifact
|
||||
with:
|
||||
name: ${{ needs.prepare.outputs.name }}
|
||||
|
||||
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 = 2024.10.0b1
|
||||
PROJECT_NUMBER = 2024.10.0b2
|
||||
|
||||
# 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 = 2024.10.0b1
|
||||
ESPHOME_REF = 2024.10.0b2
|
||||
PAGEFIND_VERSION=1.1.0
|
||||
PAGEFIND=pagefind
|
||||
NET_PAGEFIND=../pagefindbin/pagefind
|
||||
|
||||
@ -1 +1 @@
|
||||
2024.10.0b1
|
||||
2024.10.0b2
|
||||
@ -191,8 +191,8 @@ time period.
|
||||
``if`` Action
|
||||
*************
|
||||
|
||||
This action first evaluated a certain condition (``if:``) and then either
|
||||
executes the ``then:`` branch or the ``else:`` branch depending on the output of the condition.
|
||||
This action first evaluates the ``condition:`` and then either
|
||||
executes the ``then:`` branch if the condition returns true or the ``else:`` branch if the condition returns false.
|
||||
|
||||
After the chosen branch (``then`` or ``else``) is done with execution, the next action is performed.
|
||||
|
||||
|
||||
@ -47,6 +47,14 @@ Breaking Changes
|
||||
- CSE7766 needs even parity :esphomepr:`7549` by :ghuser:`ssieb` (breaking-change)
|
||||
- [web_server] v3 entity grouping :esphomepr:`6833` by :ghuser:`RFDarter` (breaking-change)
|
||||
|
||||
Beta Changes
|
||||
^^^^^^^^^^^^
|
||||
|
||||
- fix uart settings check :esphomepr:`7573` by :ghuser:`ssieb`
|
||||
- [web_server] Event component grouping :esphomepr:`7586` by :ghuser:`RFDarter`
|
||||
- [touchscreen] Fix coordinates when using rotation :esphomepr:`7591` by :ghuser:`clydebarrow`
|
||||
- Fix update sequence when update is set to false (#5225) :esphomepr:`7407` by :ghuser:`edge90`
|
||||
|
||||
All changes
|
||||
^^^^^^^^^^^
|
||||
|
||||
@ -128,6 +136,10 @@ All changes
|
||||
- Bump actions/upload-artifact from 4.4.1 to 4.4.2 :esphomepr:`7569` by :ghuser:`dependabot[bot]`
|
||||
- Bump actions/cache from 4.1.0 to 4.1.1 :esphomepr:`7570` by :ghuser:`dependabot[bot]`
|
||||
- Bump actions/cache from 4.1.0 to 4.1.1 in /.github/actions/restore-python :esphomepr:`7571` by :ghuser:`dependabot[bot]`
|
||||
- fix uart settings check :esphomepr:`7573` by :ghuser:`ssieb`
|
||||
- [web_server] Event component grouping :esphomepr:`7586` by :ghuser:`RFDarter`
|
||||
- [touchscreen] Fix coordinates when using rotation :esphomepr:`7591` by :ghuser:`clydebarrow`
|
||||
- Fix update sequence when update is set to false (#5225) :esphomepr:`7407` by :ghuser:`edge90`
|
||||
|
||||
Past Changelogs
|
||||
---------------
|
||||
|
||||
@ -22,6 +22,8 @@ The ``midea`` component creates a Midea air conditioner climate device.
|
||||
|
||||
Control is possible with a custom dongle. Example of hardware implementation is `IoT Uni Dongle <https://github.com/dudanov/iot-uni-dongle>`_ or `Midea SLWF-01pro <https://smartlight.me/smart-home-devices/wifi-devices/wifi-dongle-air-conditioners-midea-idea-electrolux-for-home-assistant>`_ (`CloudFree <https://cloudfree.shop/product/ductless-hvac-wi-fi-module/>`_, `Tindie <https://www.tindie.com/products/smartlightme/wifi-dongle-for-air-conditioners-midea-electrolux>`_).
|
||||
|
||||
The Midea air conditioner requires the UART to be configured with ``baud_rate: 9600``. The hardware requires **5V logic levels** and does not appear to work with 3.3V logic levels. Use a logic level shifter if building your own dongle.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
|
||||
@ -74,6 +74,7 @@ One of ``id`` or ``name`` is required.
|
||||
|
||||
See https://www.home-assistant.io/integrations/event/#device-class
|
||||
for a list of available options.
|
||||
- If Webserver enabled and version 3 is selected, All other options from Webserver Component.. See :ref:`Webserver Version 3 <config-webserver-version-3-options>`.
|
||||
|
||||
Automations:
|
||||
|
||||
|
||||
@ -23,8 +23,8 @@ and the other channel controls the brightness.
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
||||
- **color_temperature** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the color temperature.
|
||||
- **brightness** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the brightness.
|
||||
- **color_temperature** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the color temperature. It returns a float from 0 to 1 in the mired scale. Hereby 0 corresponds to the cold white temperature and 1 to the warm white temperature.
|
||||
- **brightness** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the brightness. It returns a float from 0 to 1.
|
||||
- **cold_white_color_temperature** (**Required**, float): The coldest color temperature supported by this light. This
|
||||
is the lowest value when expressed in `mireds <https://en.wikipedia.org/wiki/Mired>`__, or the highest value when
|
||||
expressed in Kelvin.
|
||||
|
||||
@ -7,7 +7,6 @@ MAX31856 Thermocouple Temperature Sensor
|
||||
|
||||
The ``MAX31856`` temperature sensor allows you to use your MAX31856 Thermocouple
|
||||
temperature sensor (`datasheet <https://datasheets.maximintegrated.com/en/ds/MAX31856.pdf>`__) with ESPHome.
|
||||
Although the chip supports multiple thermocouple types, this component only implements the ``K`` type.
|
||||
|
||||
.. figure:: images/max31856-full.jpg
|
||||
:align: center
|
||||
|
||||
2
conf.py
2
conf.py
@ -69,7 +69,7 @@ author = "ESPHome"
|
||||
# The short X.Y version.
|
||||
version = "2024.10"
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = "2024.10.0b1"
|
||||
release = "2024.10.0b2"
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
||||
@ -1,121 +0,0 @@
|
||||
Share data directly between ESPHome nodes
|
||||
=========================================
|
||||
|
||||
In certain special cases it might be desired to avoid placing any middleware like an MQTT or a home automation server just to transfer small bits of data from one node to another. Direct data polling is possible using HTTP, but beware that the involved components are resource hungry and may be less stable on long term. The webserver embedded in the node is not designed to constantly serve a large amount of requests.
|
||||
|
||||
The primary node holding the data we need to retrieve from will be the server, and the others polling for it will be the clients (can be multiple).
|
||||
|
||||
Server part
|
||||
-----------
|
||||
|
||||
Setting up a webserver using the :doc:`/components/web_server` on the primary node will make available the required sensor data through a :ref:`api-rest` interface.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
web_server:
|
||||
port: 80
|
||||
|
||||
Client part
|
||||
-----------
|
||||
|
||||
On the client nodes we need an :doc:`/components/http_request` with an ``id`` set, and a :doc:`/components/sensor/template` to make it accessible locally.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
http_request:
|
||||
|
||||
sensor:
|
||||
- platform: template
|
||||
name: "Template sensor on client"
|
||||
id: template_sensor_id
|
||||
|
||||
|
||||
Pulling the data
|
||||
****************
|
||||
|
||||
To automate the request for data, we use an :doc:`/components/interval` requesting the URL pointing to the sensor id for which the state is needed. See :ref:`api-rest` on how to build up the URL for your sensors.
|
||||
|
||||
In the example below we request the value of a sensor from the server node, and after parsing the resulted JSON string we publish it to the local template sensor:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
interval:
|
||||
- interval: 60s
|
||||
then:
|
||||
- http_request.get:
|
||||
url: http://ip or nodename.local/sensor/ID_of_the_sensor
|
||||
on_response:
|
||||
then:
|
||||
- lambda: |-
|
||||
json::parse_json(id(http_request_id).get_string(), [](JsonObject root) -> bool {
|
||||
id(template_sensor_id).publish_state(root["value"]);
|
||||
return true;
|
||||
});
|
||||
|
||||
|
||||
Result
|
||||
------
|
||||
|
||||
.. figure:: images/server.png
|
||||
:align: center
|
||||
:width: 95.0%
|
||||
|
||||
Server side real sensor
|
||||
|
||||
|
||||
.. figure:: images/clients.png
|
||||
:align: center
|
||||
:width: 95.0%
|
||||
|
||||
Client side template sensor
|
||||
|
||||
|
||||
Increasing security
|
||||
-------------------
|
||||
|
||||
For security reasons, it's always recommended to protect the web interface of the nodes with authentication, even if you're using them on your local network.
|
||||
|
||||
Server part
|
||||
***********
|
||||
|
||||
Add authentication to the ``web_server`` component on the primary node:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
web_server:
|
||||
port: 80
|
||||
auth:
|
||||
username: !secret admin
|
||||
password: !secret web_server_password
|
||||
|
||||
Client part
|
||||
***********
|
||||
|
||||
Add an ``Authorization`` header to your ``http_request.get`` action. The simplest way to determine a working authorization header is to visit the password-protected REST URL of the primary node using a browser while watching the network traffic in the browser's developer tools. If you look at the headers of the request sent by the browser, you'll find the ``Authorization`` header it sends to the node, and you can copy it for your own replay:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
interval:
|
||||
- interval: 60s
|
||||
then:
|
||||
- http_request.get:
|
||||
url: http://ip or nodename.local/sensor/ID_of_the_sensor
|
||||
headers:
|
||||
Authorization: 'Digest username="admin", realm="asyncesp", nonce="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", uri="/sensor/ID_of_the_sensor", response="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", opaque="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", qop=auth, nc=xxxxxxxx, cnonce="xxxxxxxxxxxxxxxx"'
|
||||
on_response:
|
||||
then:
|
||||
- lambda: |-
|
||||
json::parse_json(id(http_request_id).get_string(), [](JsonObject root) -> bool {
|
||||
id(template_sensor_id).publish_state(root["value"]);
|
||||
return true;
|
||||
});
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :doc:`/components/web_server`
|
||||
- :doc:`/components/http_request`
|
||||
- :doc:`/components/sensor/template`
|
||||
- :doc:`/components/interval`
|
||||
- :ref:`api-rest`
|
||||
- :ghedit:`Edit`
|
||||
@ -1491,6 +1491,7 @@ Contributors
|
||||
- `puuu (@puuu) <https://github.com/puuu>`__
|
||||
- `Pascal Vizeli (@pvizeli) <https://github.com/pvizeli>`__
|
||||
- `Alex (@pxe-la) <https://github.com/pxe-la>`__
|
||||
- `Pietro (@PxPert) <https://github.com/PxPert>`__
|
||||
- `[pʲɵs] (@pyos) <https://github.com/pyos>`__
|
||||
- `Peter Zich (@pzich) <https://github.com/pzich>`__
|
||||
- `QbaF (@QbaF) <https://github.com/QbaF>`__
|
||||
@ -1659,6 +1660,7 @@ Contributors
|
||||
- `sherbang (@sherbang) <https://github.com/sherbang>`__
|
||||
- `Shish (@shish) <https://github.com/shish>`__
|
||||
- `Shreyas Karnik (@shreyaskarnik) <https://github.com/shreyaskarnik>`__
|
||||
- `Sherman K (@shrmnk) <https://github.com/shrmnk>`__
|
||||
- `shuchitak (@shuchitak) <https://github.com/shuchitak>`__
|
||||
- `sibowler (@sibowler) <https://github.com/sibowler>`__
|
||||
- `signix (@signix) <https://github.com/signix>`__
|
||||
@ -1995,4 +1997,4 @@ Contributors
|
||||
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
|
||||
- `Zynth-dev (@Zynth-dev) <https://github.com/Zynth-dev>`__
|
||||
|
||||
*This page was last updated October 9, 2024.*
|
||||
*This page was last updated October 14, 2024.*
|
||||
|
||||
Loading…
Reference in New Issue
Block a user