Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2025-01-12 20:10:50 +01:00
Code Issues Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Jesse Hills 2024-07-03 15:45:21 +12:00
commit f3c28eaf45
No known key found for this signature in database
GPG Key ID: BEAAE804EFD8E83A
11 changed files with 23 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
changelog/v1.9.0.rst
View File

@ -137,7 +137,7 @@ New Features
- You can now upload OTA firmware files with the :doc:`web server component </components/web_server>`
- Added the ability to define global variables in esphomeyaml: :ref:`config-globals`.
- Added the ability to define global variables in esphomeyaml: :doc:`/components/globals`.
- Added a ``frequency`` option to the :doc:`/components/output/esp8266_pwm`.

4
components/globals.rst
View File

@ -1,5 +1,3 @@
.. _config-globals:
Global Variables
----------------
@ -54,7 +52,7 @@ Configuration variables:
``globals.set`` Action
----------------------
This :ref:`Action <config-action>` allows you to change the value of a :ref:`global <config-globals>`
This :ref:`Action <config-action>` allows you to change the value of a ``global``
variable without having to use the lambda syntax.
.. code-block:: yaml

6
components/interval.rst
View File

@ -1,7 +1,5 @@
.. _interval:
``interval`` Component
----------------------
Interval Component
------------------
This component allows you to run actions at fixed time intervals. For example, if you want to toggle a switch every
minute, you can use this component. Please note that it's possible to achieve the same thing with the

1
components/ota/esphome.rst
View File

@ -22,7 +22,6 @@ expected. This is automatically enabled by this component, but it may be disable
# Example configuration entry
ota:
- platform: esphome
safe_mode: true
password: !secret ota_password
Configuration variables:

6
components/script.rst
View File

@ -1,7 +1,5 @@
.. _scripts:
``script`` Component
--------------------
Script Component
----------------
ESPHome's ``script`` component allows you to define a list of steps (actions) in a central place. You can then execute
the script from nearly anywhere in your device's configuration with a single call.

2
components/sensor/bmp280.rst
View File

@ -48,7 +48,7 @@ Configuration variables:
- **pressure** (*Optional*): The information for the pressure sensor.
- **name** (**Required**, string): The name for the pressure sensor.
- **oversampling** (*Optional*): The oversampling parameter for the temperature sensor.
- **oversampling** (*Optional*): The oversampling parameter for the pressure sensor.
See :ref:`Oversampling Options <bmp280-oversampling>`.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 3.0 KiB

After

Width:  |  Height:  |  Size: 3.0 KiB

1
components/sensor/dallas_temp.rst
View File

@ -19,6 +19,7 @@ required to be set up in your configuration for this sensor to work.
- platform: dallas_temp
address: 0x1234567812345628
name: temperature
update_interval: 120s
Configuration variables:
************************

6
components/sensor/duty_time.rst
View File

@ -2,13 +2,13 @@ Duty Time
=========
.. seo::
:description: Instructions for setting up a sensor that tracks the duty time of the some object.
:description: Instructions for setting up a sensor that tracks the duty time of some object.
:image: timer-play-outline.svg
The ``duty_time`` sensor allows you to track the total duty time of the some object, for example, a light bulb, in seconds.
The ``duty_time`` sensor allows you to track the total duty time of some object, for example, a light bulb, in seconds.
Able to calculate the last turn-on time when an optional sensor ``last_time`` is included in the configuration.
Supports boolean signal sources: ``binary_sensor`` or ``lambda`` that returns a boolean state of tracked object.
Supports boolean signal sources: ``binary_sensor`` or ``lambda`` that returns a boolean state of the tracked object.
As an alternative to controlling a component in automations, may be used the ``sensor.duty_time.start`` and ``sensor.duty_time.stop`` actions.

17
components/sensor/tx20.rst
View File

@ -7,8 +7,6 @@ TX20/TX23 Wind Speed/Direction Sensor
:keywords: TX20
The ``tx20`` sensor platform allows you to use your TX20/TX23
(`Amazon`_,
`lacrosse_tx23`_)
wind direction and speed sensors with ESPHome.
The only required pin is the black or brown cable (which is used to transmit data.)
The red cable should be connected to VCC (3.3V), green initiates the data transfer when connected to GND
@ -23,9 +21,6 @@ connected to GND in the TX20.
TX20 / TX23 Wind Speed / Direction.
.. _Amazon: https://www.amazon.de/Technoline-Tx-20/dp/B01HXZ3KLA
.. _lacrosse_tx23: https://www.lacrossetechnology.com/tx23-wind-sensor
.. code-block:: yaml
# Example configuration entry
@ -66,14 +61,20 @@ Configuration variables:
return {id(tx20_id).get_wind_cardinal_direction()};
update_interval: 2s
.. note::
It appears that the manufacturer discontinued production of this sensor, as it doesn't seem to be available anymore for purchase.
There are various alternatives though, and since ESPHome has a :doc:`/components/modbus`, any model supporting RS485 connection
can be easily integrated.
Check out in the ESPHome Devices database example configurations for
`RS-FSJT-N01 Wind Speed <https://devices.esphome.io/devices/Renke-RS-FSJT-N01-Wind-Speed>`__ and
`RS-FXJT-N01 Wind Direction <https://devices.esphome.io/devices/Renke-RS-FXJT-N01-Wind-Direction>`__ sensors.
See Also
--------
- :ref:`sensor-filters`
- :apiref:`tx20/tx20.h`
- `Amazon Tx20 <https://www.amazon.de/Technoline-Tx-20/dp/B01HXZ3KLA>`__
- `La Crosse Tx23 <https://www.lacrossetechnology.com/tx23-wind-sensor>`__
- `Datagram Tx20 <http://www.sdpro.eu/jm/images/allegati/TX20_Documentazione.pdf>`__
- `Datagram Tx23 <https://www.lacrossetechnology.com/tx23-wind-sensor>`__-
- :ghedit:`Edit`

4
cookbook/http_request_sensor.rst
View File

@ -35,7 +35,7 @@ On the client nodes we need an :doc:`/components/http_request` with an ``id`` se
Pulling the data
****************
To automate the request for data, we use an :ref:`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.
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:
@ -118,6 +118,6 @@ See Also
- :doc:`/components/web_server`
- :doc:`/components/http_request`
- :doc:`/components/sensor/template`
- :ref:`interval`
- :doc:`/components/interval`
- :ref:`api-rest`
- :ghedit:`Edit`

2
index.rst
View File

@ -172,7 +172,7 @@ ESPHome-specific components or components supporting ESPHome device provisioning
Improv via BLE, components/esp32_improv, improv.svg, dark-invert
Improv via Serial, components/improv_serial, improv.svg, dark-invert
Interval, components/interval, description.svg, dark-invert
Scripts, components/scripts, description.svg, dark-invert
Script, components/script, description.svg, dark-invert
Network Hardware
----------------