mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-12-25 17:17:54 +01:00
Merge branch 'current' into next
This commit is contained in:
commit
96308aeb57
2
.github/workflows/docker.yml
vendored
2
.github/workflows/docker.yml
vendored
@ -20,7 +20,7 @@ jobs:
|
||||
steps:
|
||||
-
|
||||
name: Checkout source code
|
||||
uses: actions/checkout@v3.1.0
|
||||
uses: actions/checkout@v3.3.0
|
||||
-
|
||||
name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v2
|
||||
|
2
.github/workflows/lint.yml
vendored
2
.github/workflows/lint.yml
vendored
@ -19,7 +19,7 @@ jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3.1.0
|
||||
- uses: actions/checkout@v3.3.0
|
||||
- name: Set up Python 3.8
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
|
2
.github/workflows/lock.yml
vendored
2
.github/workflows/lock.yml
vendored
@ -16,7 +16,7 @@ jobs:
|
||||
lock:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: dessant/lock-threads@v3
|
||||
- uses: dessant/lock-threads@v4
|
||||
with:
|
||||
pr-inactive-days: "1"
|
||||
pr-lock-reason: ""
|
||||
|
4
.github/workflows/stale.yml
vendored
4
.github/workflows/stale.yml
vendored
@ -16,7 +16,7 @@ jobs:
|
||||
stale:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/stale@v6
|
||||
- uses: actions/stale@v7
|
||||
with:
|
||||
days-before-pr-stale: 60
|
||||
days-before-pr-close: 7
|
||||
@ -35,7 +35,7 @@ jobs:
|
||||
close-issues:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/stale@v6
|
||||
- uses: actions/stale@v7
|
||||
with:
|
||||
days-before-pr-stale: -1
|
||||
days-before-pr-close: -1
|
||||
|
@ -31,8 +31,6 @@ Configuration variables:
|
||||
|
||||
Support for the ESP32-S2 and ESP32-C3 is still in development and there could be issues.
|
||||
|
||||
.. _esp32-arduino_framework:
|
||||
|
||||
GPIO Pin Numbering
|
||||
------------------
|
||||
|
||||
@ -59,6 +57,8 @@ Some notes about the pins on the ESP32:
|
||||
name: "Pin GPIO23"
|
||||
pin: GPIO23
|
||||
|
||||
.. _esp32-arduino_framework:
|
||||
|
||||
Arduino framework
|
||||
-----------------
|
||||
|
||||
|
@ -43,5 +43,5 @@ Integrating the mjpeg web service into an NVR:
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :apiref:`esp32_camera_web_server/esp32_camera_web_server.h`
|
||||
- :apiref:`esp32_camera_web_server/camera_web_server.h`
|
||||
- :ghedit:`Edit`
|
||||
|
@ -275,8 +275,6 @@ then run the ``mqtt-fingerprint`` script of ESPHome to get the certificate:
|
||||
ssl_fingerprints:
|
||||
- a502ff13999f8b398ef1834f1123650b3236fc07
|
||||
|
||||
.. _config-mqtt-component:
|
||||
|
||||
|
||||
.. _mqtt-tls-idf:
|
||||
|
||||
@ -300,7 +298,7 @@ Also make sure to change the ``port`` of the mqtt broker. Most brokers use port
|
||||
- mqtt.example.com -> Success
|
||||
|
||||
If a secure connection is necessary for your device, you really want to set:
|
||||
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
skip_cert_cn_check: false
|
||||
@ -342,6 +340,7 @@ Also make sure to change the ``port`` of the mqtt broker. Most brokers use port
|
||||
m/XriWr/Cq4h/JfB7NTsezVslgkBaoU=
|
||||
-----END CERTIFICATE-----
|
||||
|
||||
.. _config-mqtt-component:
|
||||
|
||||
MQTT Component Base Configuration
|
||||
---------------------------------
|
||||
|
@ -18,6 +18,19 @@ This component contains platform-specific options for the RP2040 platform.
|
||||
rp2040:
|
||||
board: rpipicow
|
||||
|
||||
.. note::
|
||||
|
||||
For now, you need the following added to the config or you will get compile errors and board not found:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
rp2040:
|
||||
board: rpipicow
|
||||
framework:
|
||||
platform_version: https://github.com/maxgerhardt/platform-raspberrypi.git
|
||||
|
||||
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
||||
|
@ -45,6 +45,10 @@ Configuration variables:
|
||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
||||
- All other options from :ref:`Select <config-select>`.
|
||||
|
||||
.. note::
|
||||
|
||||
If you don't set a ``lambda`` and ``optimistic`` is ``false`` (default), updates to the select component state will need to be taken care of as part of your ``set_action`` using ``id(my_select).publish_state(x);`` (in a lambda). Do not use :ref:`select-set_action` here, as this would generate a loop. Also, don't use ``id(my_select).state = x`` as this won't have the desired effect (e.g. HA won't update with the change).
|
||||
|
||||
``select.set`` Action
|
||||
---------------------
|
||||
|
||||
|
@ -50,6 +50,7 @@ The :ref:`I²C <i2c>` is required to be set up in your configuration for this se
|
||||
name: "BME680 Humidity"
|
||||
iaq:
|
||||
name: "BME680 IAQ"
|
||||
id: iaq
|
||||
co2_equivalent:
|
||||
name: "BME680 CO2 Equivalent"
|
||||
breath_voc_equivalent:
|
||||
@ -59,6 +60,35 @@ The :ref:`I²C <i2c>` is required to be set up in your configuration for this se
|
||||
- platform: bme680_bsec
|
||||
iaq_accuracy:
|
||||
name: "BME680 IAQ Accuracy"
|
||||
|
||||
- platform: template
|
||||
name: "BME680 IAQ Classification"
|
||||
icon: "mdi:checkbox-marked-circle-outline"
|
||||
lambda: |-
|
||||
if ( int(id(iaq).state) <= 50) {
|
||||
return {"Excellent"};
|
||||
}
|
||||
else if (int(id(iaq).state) >= 51 && int(id(iaq).state) <= 100) {
|
||||
return {"Good"};
|
||||
}
|
||||
else if (int(id(iaq).state) >= 101 && int(id(iaq).state) <= 150) {
|
||||
return {"Lightly polluted"};
|
||||
}
|
||||
else if (int(id(iaq).state) >= 151 && int(id(iaq).state) <= 200) {
|
||||
return {"Moderately polluted"};
|
||||
}
|
||||
else if (int(id(iaq).state) >= 201 && int(id(iaq).state) <= 250) {
|
||||
return {"Heavily polluted"};
|
||||
}
|
||||
else if (int(id(iaq).state) >= 251 && int(id(iaq).state) <= 350) {
|
||||
return {"Severely polluted"};
|
||||
}
|
||||
else if (int(id(iaq).state) >= 351) {
|
||||
return {"Extremely polluted"};
|
||||
}
|
||||
else {
|
||||
return {"error"};
|
||||
}
|
||||
|
||||
Configuration variables:
|
||||
|
||||
@ -280,6 +310,7 @@ See Also
|
||||
- :ref:`sensor-filters`
|
||||
- :doc:`bme680`
|
||||
- :apiref:`bme680_bsec/bme680_bsec.h`
|
||||
- `BME680 VOC classification <https://community.bosch-sensortec.com/t5/MEMS-sensors-forum/BME680-VOC-classification/td-p/26154>`__
|
||||
- `BSEC Arduino Library <https://github.com/BoschSensortec/BSEC-Arduino-library>`__ by `Bosch Sensortec <https://www.bosch-sensortec.com/>`__
|
||||
- `Bosch Sensortec Community <https://community.bosch-sensortec.com/>`__
|
||||
- :ghedit:`Edit`
|
||||
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 12 KiB |
@ -633,7 +633,7 @@ From :ref:`lambdas <config-lambda>`, you can call several methods on all sensors
|
||||
advanced stuff (see the full API Reference for more info).
|
||||
|
||||
- ``publish_state()``: Manually cause the sensor to push out a value. It will then
|
||||
be processed by the sensor filters, and once done be published to MQTT.
|
||||
be processed by the sensor filters, and once filtered will propagate though ESPHome and though the API to Home Assistant or out via MQTT if configured.
|
||||
|
||||
.. code-block:: cpp
|
||||
|
||||
|
@ -17,7 +17,7 @@ This platform supports three sensor types, which you need to specify using the `
|
||||
value:
|
||||
|
||||
- ``PMSX003`` for generic PMS5003, PMS7003, ...; these sensors support ``pm_1_0``, ``pm_2_5`` and ``pm_10_0`` output.
|
||||
- ``PMS5003S`` for PMS5003ST. These support ``pm_1_0``, ``pm_2_5`` and ``pm_10_0`` and ``formaldehyde``.
|
||||
- ``PMS5003S`` for PMS5003S. These support ``pm_1_0``, ``pm_2_5`` and ``pm_10_0`` and ``formaldehyde``.
|
||||
- ``PMS5003T`` for PMS5003T. These support ``pm_2_5``, ``temperature`` and ``humidity``.
|
||||
- ``PMS5003ST`` for PMS5003ST. These support ``pm_2_5``, ``temperature``, ``humidity`` and ``formaldehyde``.
|
||||
|
||||
@ -67,11 +67,11 @@ Configuration variables:
|
||||
All options from :ref:`Sensor <config-sensor>`.
|
||||
- **pm_10_0um** (*Optional*): Use the number of particles with diameter beyond 10.0um in 0.1L of air
|
||||
All options from :ref:`Sensor <config-sensor>`.
|
||||
- **temperature** (*Optional*): Use the temperature value in °C for the ``PMS5003T`` and ``PMS5003ST``.
|
||||
- **temperature** (*Optional*): Use the temperature value in °C for the ``PMS5003T`` and ``PMS5003ST`` type sensors.
|
||||
All options from :ref:`Sensor <config-sensor>`.
|
||||
- **humidity** (*Optional*): Use the humidity value in % for the ``PMS5003T`` and ``PMS5003ST``.
|
||||
- **humidity** (*Optional*): Use the humidity value in % for the ``PMS5003T`` and ``PMS5003ST`` type sensors.
|
||||
All options from :ref:`Sensor <config-sensor>`.
|
||||
- **formaldehyde** (*Optional*): Use the formaldehyde (HCHO) concentration in µg per cubic meter for the ``PMS5003S`` and ``PMS5003ST``.
|
||||
- **formaldehyde** (*Optional*): Use the formaldehyde (HCHO) concentration in µg per cubic meter for the ``PMS5003S`` and ``PMS5003ST`` type sensors.
|
||||
All options from :ref:`Sensor <config-sensor>`.
|
||||
- **update_interval** (*Optional*): Amount of time to wait between generating measurements. If this is longer than 30
|
||||
seconds, and if ``tx_pin`` is set in the UART configuration, the fan will be spun down between measurements. Default to ``0s`` (forward data as it's coming in from the sensor).
|
||||
|
@ -112,7 +112,7 @@ to the newly set internal value.
|
||||
value: 10
|
||||
|
||||
# Templated
|
||||
- sensor.my_rotary_encoder.publish:
|
||||
- sensor.rotary_encoder.set_value:
|
||||
id: my_rotary_encoder
|
||||
value: !lambda 'return -1;'
|
||||
|
||||
|
@ -89,7 +89,7 @@ Configuration options:
|
||||
|
||||
.. note::
|
||||
|
||||
This action can also be written in lambdas, the parameter of the `public_state` method denotes if
|
||||
This action can also be written in lambdas, the parameter of the `publish_state` method denotes if
|
||||
the switch is currently on or off:
|
||||
|
||||
.. code-block:: cpp
|
||||
|
@ -38,7 +38,7 @@ Disabling the compilation timestamp:
|
||||
name: "ESPHome Version"
|
||||
hide_timestamp: true
|
||||
|
||||
This will, for example, change the output of the senser from:
|
||||
This will, for example, change the output of the sensor from:
|
||||
|
||||
``1.15.0-dev (Jun 8 2020, 18:53:16)`` to ``1.15.0-dev``
|
||||
|
||||
|
@ -861,7 +861,7 @@ or as lambda
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
lambda: -|
|
||||
lambda: |-
|
||||
if (id(my_script).is_running()) {
|
||||
ESP_LOGI("main", "Script is running!");
|
||||
}
|
||||
|
@ -31,6 +31,12 @@ names <https://venus.cs.qc.cuny.edu/~krishna/cs111/lectures/D3_C++_Variables.pdf
|
||||
- … can not have special characters except the underscore (“_“).
|
||||
- … must not be a keyword.
|
||||
|
||||
|
||||
.. note::
|
||||
|
||||
These IDs are used only within ESPHome and are not translated to Home Assistant's Entity ID.
|
||||
|
||||
|
||||
.. _config-pin:
|
||||
|
||||
Pin
|
||||
|
Loading…
Reference in New Issue
Block a user