mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-12-25 17:17:54 +01:00
commit
d34424632a
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 = 2023.11.0b1
|
||||
PROJECT_NUMBER = 2023.11.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 = 2023.11.0b1
|
||||
ESPHOME_REF = 2023.11.0b2
|
||||
|
||||
.PHONY: html html-strict cleanhtml deploy help live-html Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify
|
||||
|
||||
|
@ -1 +1 @@
|
||||
2023.11.0b1
|
||||
2023.11.0b2
|
@ -92,6 +92,16 @@ Breaking Changes
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
- Hydreon updates :esphomepr:`5424` by :ghuser:`jj-uk` (breaking-change)
|
||||
- Fix esp32_rmt_led_strip custom timing units :esphomepr:`5696` by :ghuser:`jesserockz` (breaking-change)
|
||||
|
||||
Beta Changes
|
||||
^^^^^^^^^^^^
|
||||
|
||||
- Handle nanoseconds in config :esphomepr:`5695` by :ghuser:`jesserockz`
|
||||
- Fix esp32_rmt_led_strip custom timing units :esphomepr:`5696` by :ghuser:`jesserockz` (breaking-change)
|
||||
- Fix static assets cache logic :esphomepr:`5700` by :ghuser:`bdraco`
|
||||
- Use piwheels for armv7 docker image builds :esphomepr:`5703` by :ghuser:`bdraco`
|
||||
- fix: Fix broken bluetooth_proxy and ble_clients after BLE enable/disable :esphomepr:`5704` by :ghuser:`Rapsssito`
|
||||
|
||||
All changes
|
||||
^^^^^^^^^^^
|
||||
@ -191,10 +201,16 @@ All changes
|
||||
- support spi for sn74hc595 :esphomepr:`5491` by :ghuser:`angelnu`
|
||||
- Handle on_disconnect when Wi-Fi is disabled :esphomepr:`5691` by :ghuser:`kbx81`
|
||||
- Bump aioesphomeapi from 18.2.1 to 18.2.4 :esphomepr:`5692` by :ghuser:`dependabot[bot]`
|
||||
- Handle nanoseconds in config :esphomepr:`5695` by :ghuser:`jesserockz`
|
||||
- Fix esp32_rmt_led_strip custom timing units :esphomepr:`5696` by :ghuser:`jesserockz` (breaking-change)
|
||||
- Fix static assets cache logic :esphomepr:`5700` by :ghuser:`bdraco`
|
||||
- Use piwheels for armv7 docker image builds :esphomepr:`5703` by :ghuser:`bdraco`
|
||||
- fix: Fix broken bluetooth_proxy and ble_clients after BLE enable/disable :esphomepr:`5704` by :ghuser:`Rapsssito`
|
||||
|
||||
Past Changelogs
|
||||
---------------
|
||||
|
||||
- :doc:`2023.10.0`
|
||||
- :doc:`2023.9.0`
|
||||
- :doc:`2023.8.0`
|
||||
- :doc:`2023.7.0`
|
||||
|
@ -27,8 +27,8 @@ Select, number and button components provide configuration value inputs and cont
|
||||
|
||||
HLK-LD2420 Low power motion and presence sensor.
|
||||
|
||||
Pinouts
|
||||
-------
|
||||
Module Pinouts
|
||||
--------------
|
||||
|
||||
.. list-table:: Firmware 1.5.2 and older
|
||||
:widths: 25 25 25
|
||||
@ -79,16 +79,6 @@ Pinouts
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
uart:
|
||||
id: ld2420_uart
|
||||
tx_pin: REPLACEME
|
||||
rx_pin: REPLACEME
|
||||
baud_rate: 115200
|
||||
parity: NONE
|
||||
stop_bits: 1
|
||||
|
||||
# The LD2420 has 16 time gate intervals (0-15) with a gate
|
||||
# resolution of 0.70 meters
|
||||
ld2420:
|
||||
|
||||
text_sensor:
|
||||
@ -119,6 +109,7 @@ Pinouts
|
||||
name: Detection Gate Minimum
|
||||
max_gate_distance:
|
||||
name: Detection Gate Maximum
|
||||
# See "Number" section below for detail
|
||||
gate_select:
|
||||
name: Select Gate to Set
|
||||
still_threshold:
|
||||
@ -189,6 +180,7 @@ Configuration variables:
|
||||
************************
|
||||
|
||||
- **operating_mode** (*Required*): Provisions the operating mode select component.
|
||||
May contain any options from :ref:`Select <config-select>`.
|
||||
|
||||
Number
|
||||
------
|
||||
@ -232,39 +224,41 @@ Configuration variables:
|
||||
|
||||
- **presence_timeout** (*Optional*): The time in seconds during which the occupied state (presence) will persist after
|
||||
presence is no longer detected. Any energy detection within the time window restarts the countdown from this value.
|
||||
Defaults to 120s. **Required** when ``min_gate_distance`` and ``max_gate_distance`` is specified.
|
||||
Defaults to 120s. **Required** when ``min_gate_distance`` and ``max_gate_distance`` is specified. May contain any
|
||||
options from :ref:`Number <config-number>`.
|
||||
- **min_gate_distance** (*Optional*): Minimum distance for move or still energy detection. Value between 0 and
|
||||
``max_gate_distance`` - 1. Each increment equals 70 cm. Defaults to 1. **Required** when ``presence_timeout`` and
|
||||
``max_gate_distance`` is specified.
|
||||
``max_gate_distance`` is specified. May contain any options from :ref:`Number <config-number>`.
|
||||
- **max_gate_distance** (*Optional*): Maximum gate for movement detection. Value from 1 to 15. Each gate detects
|
||||
movement and still energy at 70 cm increments. At the maximum value, the sensor’s range equates to 16 * 70 cm
|
||||
resulting in an approximately 12-meter range; however, accuracy at this range may be diminished. The recommended
|
||||
maximum value is 12 * 70 cm which results in approximately 9 meters. **Required** when ``presence_timeout`` and
|
||||
``min_gate_distance`` is specified.
|
||||
``min_gate_distance`` is specified. May contain any options from :ref:`Number <config-number>`.
|
||||
- **gate_still_sensitivity** (*Optional*): Gate still threshold calibration sensitivity factor. Defaults to 0.5 with a
|
||||
range of 0-1, 0 = high and 1 = low.
|
||||
range of 0-1, 0 = high and 1 = low. May contain any options from :ref:`Number <config-number>`.
|
||||
- **gate_move_sensitivity** (*Optional*): Gate move threshold calibration sensitivity factor. Defaults to 0.5 with a
|
||||
range of 0-1, 0 = high and 1 = low.
|
||||
|
||||
range of 0-1, 0 = high and 1 = low. May contain any options from :ref:`Number <config-number>`.
|
||||
- **gate_select** (*Optional*): Selection of gate value to edit (gate # from 0 to 15). Gate thresholds
|
||||
are edited by selecting the gate number and then adjusting the move and still thresholds. **Note that when this
|
||||
variable is defined, the component will run in compact UI mode and the following two configuration variables are then
|
||||
required:**
|
||||
required:** May contain any options from :ref:`Number <config-number>`.
|
||||
|
||||
- **still_threshold** (*Optional*): Gate still value threshold level for motion energy detection on a currently
|
||||
selected gate number. A value greater than that specified for the gate (distance) will trigger movement detection.
|
||||
May contain any options from :ref:`Number <config-number>`.
|
||||
- **move_threshold** (*Optional*): Gate move value threshold level for still energy detection on a currently selected
|
||||
gate number. A value less than that specified for the gate (distance) will trigger still detection.
|
||||
gate number. A value less than that specified for the gate (distance) will trigger still detection. May contain any
|
||||
options from :ref:`Number <config-number>`.
|
||||
|
||||
- **gate_n** (*Optional*): Provides individual gate threshold number inputs. Range is ``gate_0`` to ``gate_15``.
|
||||
**May not be used with** ``gate_select`` (above). Each gate entry requires a ``still_threshold`` and ``move_threshold``:
|
||||
|
||||
- **still_threshold** (*Required for each gate_n entry*): Gate still value threshold level for motion energy
|
||||
detection on currently selected gate number. A value greater than that specified for the gate (distance) will
|
||||
trigger movement detection.
|
||||
trigger movement detection. May contain any options from :ref:`Number <config-number>`.
|
||||
- **move_threshold** (*Required for each gate_n entry*): Gate move value threshold level for still energy
|
||||
detection on currently selected gate number. A value less than that specified for the gate (distance) will
|
||||
trigger still detection.
|
||||
trigger still detection. May contain any options from :ref:`Number <config-number>`.
|
||||
|
||||
Button
|
||||
------
|
||||
@ -287,13 +281,13 @@ Four button components are available enabling configuration controls for editing
|
||||
Configuration variables:
|
||||
************************
|
||||
|
||||
- **apply_config** (*Optional*): Saves both manual config tuning or the auto calibrate still and move threshold config settings.
|
||||
|
||||
- **restart_module** (*Optional*): Reboots the LD2420 modules.
|
||||
|
||||
- **apply_config** (*Optional*): Saves both manual config tuning or the auto calibrate still and move threshold config
|
||||
settings. May contain any options from :ref:`Button <config-button>`.
|
||||
- **restart_module** (*Optional*): Reboots the LD2420 modules. May contain any options from :ref:`Button <config-button>`.
|
||||
- **revert_config** (*Optional*): Undoes in-progress edits prior to their application via the ``apply_config`` button.
|
||||
|
||||
- **factory_reset** (*Optional*): Restores a base set of LD2420 configuration values.
|
||||
May contain any options from :ref:`Button <config-button>`.
|
||||
- **factory_reset** (*Optional*): Restores a base set of LD2420 configuration values. May contain any options from
|
||||
:ref:`Button <config-button>`.
|
||||
|
||||
Factory Reset Values:
|
||||
*********************
|
||||
@ -387,8 +381,8 @@ between the sensor and an object moving within its field of detection.
|
||||
Configuration variables:
|
||||
************************
|
||||
|
||||
- **moving_distance** (*Optional*): Distance between the sensor and the detected moving target.
|
||||
All options from :ref:`Sensor <config-sensor>`.
|
||||
- **moving_distance** (*Optional*): Distance between the sensor and the detected moving target. May contain any options
|
||||
from :ref:`Sensor <config-sensor>`.
|
||||
|
||||
Binary Sensor
|
||||
-------------
|
||||
@ -406,7 +400,8 @@ Configuration variables:
|
||||
************************
|
||||
|
||||
- **has_target** (*Optional*): If a target is detected with either still or in movement **has_target** will be set true
|
||||
for the duration of the **presence_time_window** setting.
|
||||
for the duration of the **presence_time_window** setting. May contain any options from
|
||||
:ref:`Binary Sensor <config-binary_sensor>`.
|
||||
|
||||
Text Sensor
|
||||
-----------
|
||||
@ -423,11 +418,12 @@ The ``ld2420`` text sensor provides version information for the :doc:`ld2420`.
|
||||
Configuration variables:
|
||||
************************
|
||||
|
||||
- **fw_version** (*Optional*): Allows you to retrieve the :doc:`ld2420` firmware version.
|
||||
- **fw_version** (*Optional*): Allows you to retrieve the :doc:`ld2420` firmware version. May contain any options from
|
||||
:ref:`Text Sensor <config-text_sensor>`.
|
||||
|
||||
|
||||
Important Information:
|
||||
**********************
|
||||
Important Information
|
||||
---------------------
|
||||
|
||||
Solid objects and noise outside the ``detection_gate_max`` and ``detection_gate_min`` may cause false
|
||||
detections or result in abnormal gate thresholds. For example, a wall within the gate max range can result
|
||||
|
2
conf.py
2
conf.py
@ -69,7 +69,7 @@ author = "ESPHome"
|
||||
# The short X.Y version.
|
||||
version = "2023.11"
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = "2023.11.0b1"
|
||||
release = "2023.11.0b2"
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
@ -707,7 +707,6 @@ Contributors
|
||||
- `AngeloGioacchino Del Regno (@kholk) <https://github.com/kholk>`__
|
||||
- `Kilowatt (@Kilowatt-W) <https://github.com/Kilowatt-W>`__
|
||||
- `Ed (@kixtarter) <https://github.com/kixtarter>`__
|
||||
- `Kurt Kellner (@kkellner) <https://github.com/kkellner>`__
|
||||
- `Klaas Schoute (@klaasnicolaas) <https://github.com/klaasnicolaas>`__
|
||||
- `Klarstein (@Klarstein) <https://github.com/Klarstein>`__
|
||||
- `Marcus Klein (@kleini) <https://github.com/kleini>`__
|
||||
@ -985,6 +984,7 @@ Contributors
|
||||
- `Florian Ragwitz (@rafl) <https://github.com/rafl>`__
|
||||
- `Ben V. Brown (@Ralim) <https://github.com/Ralim>`__
|
||||
- `randomllama (@randomllama) <https://github.com/randomllama>`__
|
||||
- `Rodrigo Martín (@Rapsssito) <https://github.com/Rapsssito>`__
|
||||
- `Marc Seeger (@rb2k) <https://github.com/rb2k>`__
|
||||
- `rbaron (@rbaron) <https://github.com/rbaron>`__
|
||||
- `Robert Cambridge (@rcambrj) <https://github.com/rcambrj>`__
|
||||
@ -1253,4 +1253,4 @@ Contributors
|
||||
- `Zsolt Zsiros (@ZsZs73) <https://github.com/ZsZs73>`__
|
||||
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
|
||||
|
||||
*This page was last updated November 8, 2023.*
|
||||
*This page was last updated November 9, 2023.*
|
||||
|
@ -1 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24"><path d="M21.8 13H20v8h-7v-3.33l2.79-2.79.71.12a2.1 2.1 0 1 0 0-4.2 2.1 2.1 0 0 0-2.1 2.1l.1.71-1.5 1.52V9.65c.66-.36 1.1-1.05 1.1-1.85A2.1 2.1 0 0 0 12 5.7a2.1 2.1 0 0 0-2.1 2.1c0 .8.44 1.49 1.1 1.85v5.48l-1.5-1.52.1-.71a2.1 2.1 0 0 0-2.1-2.1 2.1 2.1 0 0 0-2.1 2.1A2.1 2.1 0 0 0 7.5 15l.71-.12L11 17.67V21H4v-8H2.25c-.42 0-.83 0-.83-.21.01-.22.43-.64.86-1.07L11 3c.33-.33.67-.67 1-.67.33 0 .67.34 1 .67l4 4V6h2v3l2.78 2.78c.4.4.81.81.82 1.02 0 .2-.4.2-.8.2M7.5 12a.9.9 0 0 1 .9.9.9.9 0 0 1-.9.9.9.9 0 0 1-.9-.9.9.9 0 0 1 .9-.9m9 0c.5 0 .9.4.9.9s-.4.9-.9.9a.9.9 0 0 1-.9-.9.9.9 0 0 1 .9-.9M12 6.9c.5 0 .9.4.9.9s-.4.9-.9.9-.9-.4-.9-.9.4-.9.9-.9z"/></svg>
|
||||
<svg width="240" height="240" viewBox="0 0 240 240" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M229.39 109.153L130.61 10.3725C124.78 4.5425 115.23 4.5425 109.4 10.3725L10.61 109.153C4.78 114.983 0 126.512 0 134.762V224.762C0 233.012 6.75 239.762 15 239.762H107.27L66.64 199.132C64.55 199.852 62.32 200.262 60 200.262C48.7 200.262 39.5 191.062 39.5 179.762C39.5 168.462 48.7 159.262 60 159.262C71.3 159.262 80.5 168.462 80.5 179.762C80.5 182.092 80.09 184.322 79.37 186.412L111 218.042V102.162C104.2 98.8225 99.5 91.8425 99.5 83.7725C99.5 72.4725 108.7 63.2725 120 63.2725C131.3 63.2725 140.5 72.4725 140.5 83.7725C140.5 91.8425 135.8 98.8225 129 102.162V183.432L160.46 151.972C159.84 150.012 159.5 147.932 159.5 145.772C159.5 134.472 168.7 125.272 180 125.272C191.3 125.272 200.5 134.472 200.5 145.772C200.5 157.072 191.3 166.272 180 166.272C177.5 166.272 175.12 165.802 172.91 164.982L129 208.892V239.772H225C233.25 239.772 240 233.022 240 224.772V134.772C240 126.522 235.23 115.002 229.39 109.162V109.153Z" fill="#1D2126"/></svg>
|
||||
|
Before Width: | Height: | Size: 716 B After Width: | Height: | Size: 1.0 KiB |
Loading…
Reference in New Issue
Block a user