mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-09-27 04:13:07 +02:00
Fix a bunch of typos (#1324)
This commit is contained in:
parent
18263710ce
commit
8495cc5936
@ -55,7 +55,7 @@ Configuration variables:
|
|||||||
|
|
||||||
**Touch Sensor:**
|
**Touch Sensor:**
|
||||||
The Nextion will send a **page_id** and **component_id** when the *Send Component ID* check box is selected for the component. To enable
|
The Nextion will send a **page_id** and **component_id** when the *Send Component ID* check box is selected for the component. To enable
|
||||||
this native event **page_id** and **component_id** are required. No :ref:`nextion_custom_binary_sensor_protocol` is required. If **page_id** and **component_id** are set then the component will only react to touch events from the Nextion. Setting **component_name** will allow setting options like forground color.
|
this native event **page_id** and **component_id** are required. No :ref:`nextion_custom_binary_sensor_protocol` is required. If **page_id** and **component_id** are set then the component will only react to touch events from the Nextion. Setting **component_name** will allow setting options like foreground color.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
@ -122,7 +122,7 @@ How things Update
|
|||||||
A Nextion component with an integer value (.val) or Nextion variable will be automatically polled if **update_interval** is set.
|
A Nextion component with an integer value (.val) or Nextion variable will be automatically polled if **update_interval** is set.
|
||||||
To have the Nextion send the data you can use the :ref:`nextion_custom_binary_sensor_protocol` for this. Add the :ref:`nextion_custom_binary_sensor_protocol` to the
|
To have the Nextion send the data you can use the :ref:`nextion_custom_binary_sensor_protocol` for this. Add the :ref:`nextion_custom_binary_sensor_protocol` to the
|
||||||
component or function you want to trigger the send. Typically this is in *Touch Press Event* but some components, like a slider, should have it
|
component or function you want to trigger the send. Typically this is in *Touch Press Event* but some components, like a slider, should have it
|
||||||
set in the *Touch Release Event* to capture all the changes. Since this is a custom protocol it can be sent from anywhere (timers/functions/componenets)
|
set in the *Touch Release Event* to capture all the changes. Since this is a custom protocol it can be sent from anywhere (timers/functions/components)
|
||||||
in the Nextion.
|
in the Nextion.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
@ -141,7 +141,7 @@ Using the above yaml example:
|
|||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
No updates will be sent to the Nextion if it is sleeping. Once it wakes the components will be updated. If a component is invisible , :code:`visible(false)` , then it wont update until it is set to be visible.
|
No updates will be sent to the Nextion if it is sleeping. Once it wakes the components will be updated. If a component is invisible , :code:`visible(false)` , then it won't update until it is set to be visible.
|
||||||
|
|
||||||
.. _nextion_custom_binary_sensor_protocol:
|
.. _nextion_custom_binary_sensor_protocol:
|
||||||
|
|
||||||
|
@ -31,7 +31,7 @@ Over SPI
|
|||||||
--------
|
--------
|
||||||
|
|
||||||
The ``rc522_spi`` component allows you to use RC522 RFID controllers with ESPHome. This component is a global hub that
|
The ``rc522_spi`` component allows you to use RC522 RFID controllers with ESPHome. This component is a global hub that
|
||||||
establishes the connection to the RC522 via :ref:`SPI <spi>` (also avilable over I²C). Using the
|
establishes the connection to the RC522 via :ref:`SPI <spi>` (also available over I²C). Using the
|
||||||
:ref:`RC522 binary sensors <rc522-tag>` you can then create individual binary sensors that track if
|
:ref:`RC522 binary sensors <rc522-tag>` you can then create individual binary sensors that track if
|
||||||
an RFID tag is currently detected by the RC522.
|
an RFID tag is currently detected by the RC522.
|
||||||
|
|
||||||
@ -67,7 +67,7 @@ Over I²C
|
|||||||
--------
|
--------
|
||||||
|
|
||||||
The ``rc522_i2c`` component allows you to use RC522 RFID controllers with ESPHome. This component is a global hub that
|
The ``rc522_i2c`` component allows you to use RC522 RFID controllers with ESPHome. This component is a global hub that
|
||||||
establishes the connection to the RC522 via :ref:`I²C <i2c>` (also avilable over SPI). Using the
|
establishes the connection to the RC522 via :ref:`I²C <i2c>` (also available over SPI). Using the
|
||||||
:ref:`RC522 binary sensors <rc522-tag>` you can then create individual binary sensors that track if
|
:ref:`RC522 binary sensors <rc522-tag>` you can then create individual binary sensors that track if
|
||||||
an RFID tag is currently detected by the RC522.
|
an RFID tag is currently detected by the RC522.
|
||||||
|
|
||||||
|
@ -25,7 +25,7 @@ transmitted data.
|
|||||||
|
|
||||||
The CAN bus itself has only two wires named Can High and Can Low or CanH and CanL. For the ESPHome
|
The CAN bus itself has only two wires named Can High and Can Low or CanH and CanL. For the ESPHome
|
||||||
CAN bus to work you need to select the device that has the physical CAN bus implemented.
|
CAN bus to work you need to select the device that has the physical CAN bus implemented.
|
||||||
At this moment only the MCP2515 driver is supported. You can configure multiple busses.
|
At this moment only the MCP2515 driver is supported. You can configure multiple buses.
|
||||||
|
|
||||||
Any can bus node can transmit data at any time, and any node can send any ``can_id`` value and any
|
Any can bus node can transmit data at any time, and any node can send any ``can_id`` value and any
|
||||||
node can receive any can_id too. Is up to you how to organize the can_id values. You can setup a can
|
node can receive any can_id too. Is up to you how to organize the can_id values. You can setup a can
|
||||||
|
@ -10,7 +10,7 @@ physical thermostat. Its operation is similar to the :doc:`bang-bang <bang_bang>
|
|||||||
(the air temperature) and the controller will try to keep this value within a range defined by the set point(s). To do this,
|
(the air temperature) and the controller will try to keep this value within a range defined by the set point(s). To do this,
|
||||||
the controller can activate devices like a heating unit and/or a cooling unit to change the value observed by the sensor.
|
the controller can activate devices like a heating unit and/or a cooling unit to change the value observed by the sensor.
|
||||||
When configured for both heating and cooling, it is essentially two :doc:`bang-bang <bang_bang>` controllers in one; it
|
When configured for both heating and cooling, it is essentially two :doc:`bang-bang <bang_bang>` controllers in one; it
|
||||||
differs, however, in that interation with the thermostat component is nearly identical to that of a real thermostat.
|
differs, however, in that interaction with the thermostat component is nearly identical to that of a real thermostat.
|
||||||
|
|
||||||
This component can operate in one of two ways:
|
This component can operate in one of two ways:
|
||||||
|
|
||||||
|
@ -194,7 +194,7 @@ The display can be switched on and off "dynamically" within the lambda code with
|
|||||||
it.turn_on_off(true);
|
it.turn_on_off(true);
|
||||||
|
|
||||||
For a quick display some additional commands are embedded in the code with a related 8 pixel font. Three methods
|
For a quick display some additional commands are embedded in the code with a related 8 pixel font. Three methods
|
||||||
(``printdigit``, ``printdigitf`` and ``strftimedigit``) can be used for diplaying characters. Each 8 X 8 grid is used to
|
(``printdigit``, ``printdigitf`` and ``strftimedigit``) can be used for displaying characters. Each 8 X 8 grid is used to
|
||||||
display a single character. So not very space efficient. The format of the command is: ``it.printdigit("1234");`` or
|
display a single character. So not very space efficient. The format of the command is: ``it.printdigit("1234");`` or
|
||||||
``it.printdigitf("%s","1234")``;
|
``it.printdigitf("%s","1234")``;
|
||||||
|
|
||||||
|
@ -54,7 +54,7 @@ Configuration variables:
|
|||||||
- **dns1** (*Optional*, IPv4 address): The main DNS server to use.
|
- **dns1** (*Optional*, IPv4 address): The main DNS server to use.
|
||||||
- **dns2** (*Optional*, IPv4 address): The backup DNS server to use.
|
- **dns2** (*Optional*, IPv4 address): The backup DNS server to use.
|
||||||
|
|
||||||
- **enable_mdns** (*Optional*, boolean): Controls if your node should advertise its presense and services using mDNS. When set to ``false`` you won't be able to access your node using its hostname which can break certain functionalities. Please see :ref:`notes on disabling mDNS <faq-notes_on_disabling_mdns>`. Defaults to ``true``.
|
- **enable_mdns** (*Optional*, boolean): Controls if your node should advertise its presence and services using mDNS. When set to ``false`` you won't be able to access your node using its hostname which can break certain functionalities. Please see :ref:`notes on disabling mDNS <faq-notes_on_disabling_mdns>`. Defaults to ``true``.
|
||||||
- **use_address** (*Optional*, string): Manually override what address to use to connect
|
- **use_address** (*Optional*, string): Manually override what address to use to connect
|
||||||
to the ESP. Defaults to auto-generated value. For example, if you have changed your
|
to the ESP. Defaults to auto-generated value. For example, if you have changed your
|
||||||
static IP and want to flash OTA to the previously configured IP address.
|
static IP and want to flash OTA to the previously configured IP address.
|
||||||
|
@ -417,7 +417,7 @@ Configuration variables:
|
|||||||
|
|
||||||
- **name** (*Optional*, string): The name of the effect. Defaults to ``Pulse``.
|
- **name** (*Optional*, string): The name of the effect. Defaults to ``Pulse``.
|
||||||
- **transition_length** (*Optional*, :ref:`config-time`): The duration of each transition. Defaults to ``1s``.
|
- **transition_length** (*Optional*, :ref:`config-time`): The duration of each transition. Defaults to ``1s``.
|
||||||
- **update_interval** (*Optional*, :ref:`config-time`): The interval when the new transistion is started. Defaults to ``1s``.
|
- **update_interval** (*Optional*, :ref:`config-time`): The interval when the new transition is started. Defaults to ``1s``.
|
||||||
|
|
||||||
|
|
||||||
Random Effect
|
Random Effect
|
||||||
@ -529,7 +529,7 @@ This effect allows you to write completely custom light effects yourself using :
|
|||||||
lambda: |-
|
lambda: |-
|
||||||
static int state = 0;
|
static int state = 0;
|
||||||
auto call = id(my_light).turn_on();
|
auto call = id(my_light).turn_on();
|
||||||
// Transtion of 1000ms = 1s
|
// Transition of 1000ms = 1s
|
||||||
call.set_transition_length(1000);
|
call.set_transition_length(1000);
|
||||||
if (state == 0) {
|
if (state == 0) {
|
||||||
call.set_rgb(1.0, 1.0, 1.0);
|
call.set_rgb(1.0, 1.0, 1.0);
|
||||||
@ -992,7 +992,7 @@ Configuration variables:
|
|||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
You can also set the ``port`` to ``19446`` for compatability with Hyperion Classic using a
|
You can also set the ``port`` to ``19446`` for compatibility with Hyperion Classic using a
|
||||||
UDP device with protocol 0.
|
UDP device with protocol 0.
|
||||||
|
|
||||||
Currently the following realtime protocols are supported:
|
Currently the following realtime protocols are supported:
|
||||||
|
@ -110,7 +110,7 @@ progress percentage (a value between 0 and 100) from the trigger with variable `
|
|||||||
``on_end``
|
``on_end``
|
||||||
**********
|
**********
|
||||||
|
|
||||||
This automation will be triggered when an OTA update has completed sucessfully,
|
This automation will be triggered when an OTA update has completed successfully,
|
||||||
right before the device is rebooted.
|
right before the device is rebooted.
|
||||||
|
|
||||||
Because the update has completed, you can safely use an automation action that
|
Because the update has completed, you can safely use an automation action that
|
||||||
|
@ -224,7 +224,7 @@ Remote code selection (exactly one of these has to be included):
|
|||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
To caputure the codes more effectively with directly connected receiver like tsop38238 you can try to use ``INPUT_PULLUP``:
|
To capture the codes more effectively with directly connected receiver like tsop38238 you can try to use ``INPUT_PULLUP``:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
@ -7,7 +7,7 @@ RF Bridge Component
|
|||||||
:keywords: RF Bridge
|
:keywords: RF Bridge
|
||||||
|
|
||||||
The ``RF Bridge`` Component provides the ability to send and receive 433MHz remote codes without hardware
|
The ``RF Bridge`` Component provides the ability to send and receive 433MHz remote codes without hardware
|
||||||
hacking the circuit board to bypass the ``efm8bb1`` MCU. This component implements the communcation protocol
|
hacking the circuit board to bypass the ``efm8bb1`` MCU. This component implements the communication protocol
|
||||||
that the original ``efm8bb1`` firmware implements. The device is connected via the
|
that the original ``efm8bb1`` firmware implements. The device is connected via the
|
||||||
:doc:`UART bus </components/uart>`. The uart bus must be configured at the same speed of the module
|
:doc:`UART bus </components/uart>`. The uart bus must be configured at the same speed of the module
|
||||||
which is 19200bps.
|
which is 19200bps.
|
||||||
|
@ -38,7 +38,7 @@ Configuration variables
|
|||||||
-----------------------
|
-----------------------
|
||||||
|
|
||||||
- **mac_address** (**Required**): The MAC address of the device.
|
- **mac_address** (**Required**): The MAC address of the device.
|
||||||
- **temperature** (*Optional*): Air temperature in Celcius.
|
- **temperature** (*Optional*): Air temperature in Celsius.
|
||||||
|
|
||||||
- **name** (**Required**): Sensor name.
|
- **name** (**Required**): Sensor name.
|
||||||
- All other options from :ref:`Sensor <config-sensor>`.
|
- All other options from :ref:`Sensor <config-sensor>`.
|
||||||
|
@ -32,7 +32,7 @@ your configuration for this sensor to work.
|
|||||||
update_interval: 60s
|
update_interval: 60s
|
||||||
|
|
||||||
By default the **measurement_duration** is set to ``69`` which will result into measurements up
|
By default the **measurement_duration** is set to ``69`` which will result into measurements up
|
||||||
to 54612.5 lx for this sensor. For low-light situtations consider to choose a higher
|
to 54612.5 lx for this sensor. For low-light situations consider to choose a higher
|
||||||
measurement_duration up to ``254`` which will result in a maximum measurement range up to 14835 lx.
|
measurement_duration up to ``254`` which will result in a maximum measurement range up to 14835 lx.
|
||||||
For sunny scenes (for example outdoors with sunlight) use lower values down to ``31`` which will
|
For sunny scenes (for example outdoors with sunlight) use lower values down to ``31`` which will
|
||||||
give you the maximum measurement range up to 121556 lx.
|
give you the maximum measurement range up to 121556 lx.
|
||||||
|
@ -92,7 +92,7 @@ Configuration variables:
|
|||||||
When using a voltage transformer this is the secondary turns to primary turns ratio. When using a
|
When using a voltage transformer this is the secondary turns to primary turns ratio. When using a
|
||||||
current transformer (such as the ZMPT101B) this is equals
|
current transformer (such as the ZMPT101B) this is equals
|
||||||
``(secondary turns * burden resistor value) / (primary turns * limiting resistor value)``, and
|
``(secondary turns * burden resistor value) / (primary turns * limiting resistor value)``, and
|
||||||
similarly for combiations of transfomers and voltage dividers. Defaults to ``0.001``. Must be
|
similarly for combinations of transfomers and voltage dividers. Defaults to ``0.001``. Must be
|
||||||
a positive number.
|
a positive number.
|
||||||
- **phase_offset** (*Optional*): This can be used to account for a phase offset between the voltage
|
- **phase_offset** (*Optional*): This can be used to account for a phase offset between the voltage
|
||||||
sensing circuit and the current sensing circuit to improve power measurement accuracy. Admits
|
sensing circuit and the current sensing circuit to improve power measurement accuracy. Admits
|
||||||
|
@ -157,9 +157,9 @@ Configuration variables:
|
|||||||
- **today_generation_time** (*Optional*): Use the day generation time value for same day of the
|
- **today_generation_time** (*Optional*): Use the day generation time value for same day of the
|
||||||
sensor in minutes. All options from :ref:`Sensor <config-sensor>`.
|
sensor in minutes. All options from :ref:`Sensor <config-sensor>`.
|
||||||
- **inverter_module_temp** (*Optional*): Use the inverter module temperature value of the sensor in
|
- **inverter_module_temp** (*Optional*): Use the inverter module temperature value of the sensor in
|
||||||
degree celcius. All options from :ref:`Sensor <config-sensor>`.
|
degree celsius. All options from :ref:`Sensor <config-sensor>`.
|
||||||
- **inverter_inner_temp** (*Optional*): Use the inverter inner temperature value of the sensor in
|
- **inverter_inner_temp** (*Optional*): Use the inverter inner temperature value of the sensor in
|
||||||
degree celcius. All options from :ref:`Sensor <config-sensor>`.
|
degree celsius. All options from :ref:`Sensor <config-sensor>`.
|
||||||
- **inverter_bus_voltage** (*Optional*): Use the inverter bus voltage value of the sensor in volts.
|
- **inverter_bus_voltage** (*Optional*): Use the inverter bus voltage value of the sensor in volts.
|
||||||
All options from :ref:`Sensor <config-sensor>`.
|
All options from :ref:`Sensor <config-sensor>`.
|
||||||
- **insulation_of_pv_n_to_ground** (*Optional*): Use the insulation of photo voltiacs's
|
- **insulation_of_pv_n_to_ground** (*Optional*): Use the insulation of photo voltiacs's
|
||||||
|
@ -28,7 +28,7 @@ Once configured, you can use any of the 8 pins as
|
|||||||
sensors for your projects.
|
sensors for your projects.
|
||||||
|
|
||||||
Each pin will respond with a voltage calculated off of the reference_voltage (default is 3.3v).
|
Each pin will respond with a voltage calculated off of the reference_voltage (default is 3.3v).
|
||||||
It calculates the voltage by multplying the reference_voltage * value on the pin (basically the percentage of VREF)
|
It calculates the voltage by multiplying the reference_voltage * value on the pin (basically the percentage of VREF)
|
||||||
|
|
||||||
Most configurations will set the reference_voltage = VREF (pin 13 on the chip)
|
Most configurations will set the reference_voltage = VREF (pin 13 on the chip)
|
||||||
|
|
||||||
|
@ -127,7 +127,7 @@ How things Update
|
|||||||
A Nextion component with an integer value (.val) or Nextion variable will be automatically polled if **update_interval** is set.
|
A Nextion component with an integer value (.val) or Nextion variable will be automatically polled if **update_interval** is set.
|
||||||
To have the Nextion send the data you can use the :ref:`nextion_custom_sensor_protocol` for this. Add the :ref:`nextion_custom_sensor_protocol` to the
|
To have the Nextion send the data you can use the :ref:`nextion_custom_sensor_protocol` for this. Add the :ref:`nextion_custom_sensor_protocol` to the
|
||||||
component or function you want to trigger the send. Typically this is in *Touch Press Event* but some components, like a slider, should have it
|
component or function you want to trigger the send. Typically this is in *Touch Press Event* but some components, like a slider, should have it
|
||||||
set in the *Touch Release Event* to capture all the changes. Since this is a custom protocol it can be sent from anywhere (timers/functions/componenets)
|
set in the *Touch Release Event* to capture all the changes. Since this is a custom protocol it can be sent from anywhere (timers/functions/components)
|
||||||
in the Nextion.
|
in the Nextion.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
@ -9,7 +9,7 @@ QMC5883L Magnetometer
|
|||||||
The ``qmc5883l`` allows you to use your QMC5883L triple-axis magnetometers
|
The ``qmc5883l`` allows you to use your QMC5883L triple-axis magnetometers
|
||||||
(`datasheet <http://wiki.sunfounder.cc/images/7/72/QMC5883L-Datasheet-1.0.pdf>`__) with
|
(`datasheet <http://wiki.sunfounder.cc/images/7/72/QMC5883L-Datasheet-1.0.pdf>`__) with
|
||||||
ESPHome. This sensor is very simular to the :ref:`HMC5883L <hmc5883l>` sensor and is oftern found
|
ESPHome. This sensor is very simular to the :ref:`HMC5883L <hmc5883l>` sensor and is oftern found
|
||||||
as a knock off replacement. The QMC5883L sensor preforms on par to the HMC5883L sensor,
|
as a knock off replacement. The QMC5883L sensor performs on par to the HMC5883L sensor,
|
||||||
though the congiuration differs. The :ref:`I²C Bus <i2c>` is required to be set up in your
|
though the congiuration differs. The :ref:`I²C Bus <i2c>` is required to be set up in your
|
||||||
configuration for this sensor to work.
|
configuration for this sensor to work.
|
||||||
|
|
||||||
|
@ -139,9 +139,9 @@ Configuration variables:
|
|||||||
- Only available if RAWv2 protocol is used.
|
- Only available if RAWv2 protocol is used.
|
||||||
|
|
||||||
- **measurement_sequence_number** (*Optional*): The information for the
|
- **measurement_sequence_number** (*Optional*): The information for the
|
||||||
measurment sequence number sensor
|
measurement sequence number sensor
|
||||||
|
|
||||||
- **name** (**Required**, string): The name for the measurment sequence
|
- **name** (**Required**, string): The name for the measurement sequence
|
||||||
number sensor.
|
number sensor.
|
||||||
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use
|
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use
|
||||||
in lambdas.
|
in lambdas.
|
||||||
|
@ -94,7 +94,7 @@ Configuration variables:
|
|||||||
|
|
||||||
In teleinfo platform:
|
In teleinfo platform:
|
||||||
|
|
||||||
- **historical_mode** (*Optional*): Wether to use historical mode or standard mode.
|
- **historical_mode** (*Optional*): Whether to use historical mode or standard mode.
|
||||||
With historical mode, baudrate of 1200 must be used whereas 9600 must be used in
|
With historical mode, baudrate of 1200 must be used whereas 9600 must be used in
|
||||||
standard mode. Defaults to ``False``.
|
standard mode. Defaults to ``False``.
|
||||||
|
|
||||||
|
@ -34,7 +34,7 @@ Configuration variables:
|
|||||||
|
|
||||||
- **name** (**Required**, string): The name for the temperature sensor.
|
- **name** (**Required**, string): The name for the temperature sensor.
|
||||||
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``.
|
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``.
|
||||||
- **address** (*Optional*, int): The I²C address of the sensor. Defauls to ``0x48``.
|
- **address** (*Optional*, int): The I²C address of the sensor. Defaults to ``0x48``.
|
||||||
See :ref:`I²C Addresses <tmp117_i2c_addresses>` for more information.
|
See :ref:`I²C Addresses <tmp117_i2c_addresses>` for more information.
|
||||||
- **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>`.
|
||||||
|
@ -37,7 +37,7 @@ Configuration variables:
|
|||||||
- **name** (**Required**, string): The name of the sensor.
|
- **name** (**Required**, string): The name of the sensor.
|
||||||
- **nextion_id** (*Optional*, :ref:`config-id`): The ID of the Nextion display.
|
- **nextion_id** (*Optional*, :ref:`config-id`): The ID of the Nextion display.
|
||||||
- **component_name** (*Optional*, string): The name of the Nextion component.
|
- **component_name** (*Optional*, string): The name of the Nextion component.
|
||||||
- **variable_name** (*Optional*, string): The name of the Nextion variable. Any value over ``0`` is considerd to be **on**
|
- **variable_name** (*Optional*, string): The name of the Nextion variable. Any value over ``0`` is considered to be **on**
|
||||||
- **update_interval** (*Optional*, :ref:`config-time`): The duration to update the sensor. If using a :ref:`nextion_custom_switch_protocol` this should not be used
|
- **update_interval** (*Optional*, :ref:`config-time`): The duration to update the sensor. If using a :ref:`nextion_custom_switch_protocol` this should not be used
|
||||||
- **background_color** (*Optional*, :ref:`config-color`): The background color
|
- **background_color** (*Optional*, :ref:`config-color`): The background color
|
||||||
- **background_pressed_color** (*Optional*, :ref:`config-color`): The background color when pressed
|
- **background_pressed_color** (*Optional*, :ref:`config-color`): The background color when pressed
|
||||||
@ -92,7 +92,7 @@ How things Update
|
|||||||
A Nextion component with an integer value (.val) or Nextion variable will be automatically polled if **update_interval** is set.
|
A Nextion component with an integer value (.val) or Nextion variable will be automatically polled if **update_interval** is set.
|
||||||
To have the Nextion send the data you can use the :ref:`nextion_custom_switch_protocol` for this. Add the :ref:`nextion_custom_switch_protocol` to the
|
To have the Nextion send the data you can use the :ref:`nextion_custom_switch_protocol` for this. Add the :ref:`nextion_custom_switch_protocol` to the
|
||||||
component or function you want to trigger the send. Typically this is in *Touch Press Event* but some components, like a slider, should have it
|
component or function you want to trigger the send. Typically this is in *Touch Press Event* but some components, like a slider, should have it
|
||||||
set in the *Touch Release Event* to capture all the changes. Since this is a custom protocol it can be sent from anywhere (timers/functions/componenets)
|
set in the *Touch Release Event* to capture all the changes. Since this is a custom protocol it can be sent from anywhere (timers/functions/components)
|
||||||
in the Nextion.
|
in the Nextion.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
@ -9,7 +9,7 @@ The TCA9548A component allows you to use TCA9548A as a I²C multiplexer
|
|||||||
(`datasheet <https://www.ti.com/lit/ds/symlink/tca9548a.pdf>`__,
|
(`datasheet <https://www.ti.com/lit/ds/symlink/tca9548a.pdf>`__,
|
||||||
`AdaFruit`_) in ESPHome. It uses :ref:`I²C Bus <i2c>` for communication.
|
`AdaFruit`_) in ESPHome. It uses :ref:`I²C Bus <i2c>` for communication.
|
||||||
|
|
||||||
Once configured, you can use any of the 8 channels (TCA9548A) as seperated channels for your projects.
|
Once configured, you can use any of the 8 channels (TCA9548A) as separated channels for your projects.
|
||||||
|
|
||||||
|
|
||||||
.. figure:: images/tca9548a.jpg
|
.. figure:: images/tca9548a.jpg
|
||||||
|
@ -35,7 +35,7 @@ Configuration variables:
|
|||||||
- **name** (**Required**, string): The name of the sensor.
|
- **name** (**Required**, string): The name of the sensor.
|
||||||
- **nextion_id** (*Optional*, :ref:`config-id`): The ID of the Nextion display.
|
- **nextion_id** (*Optional*, :ref:`config-id`): The ID of the Nextion display.
|
||||||
- **component_name** (*Optional*, string): The name of the Nextion component.
|
- **component_name** (*Optional*, string): The name of the Nextion component.
|
||||||
- **variable_name** (*Optional*, string): The name of the Nextion variable. Any value over ``0`` is considerd to be **on**
|
- **variable_name** (*Optional*, string): The name of the Nextion variable. Any value over ``0`` is considered to be **on**
|
||||||
- **update_interval** (*Optional*, :ref:`config-time`): The duration to update the sensor. If using a :ref:`nextion_custom_text_sensor_protocol` this should not be used
|
- **update_interval** (*Optional*, :ref:`config-time`): The duration to update the sensor. If using a :ref:`nextion_custom_text_sensor_protocol` this should not be used
|
||||||
- **background_color** (*Optional*, :ref:`config-color`): The background color
|
- **background_color** (*Optional*, :ref:`config-color`): The background color
|
||||||
- **foreground_color** (*Optional*, :ref:`config-color`): The foreground color
|
- **foreground_color** (*Optional*, :ref:`config-color`): The foreground color
|
||||||
@ -86,7 +86,7 @@ How things Update
|
|||||||
A Nextion component with an integer value (.val) or Nextion variable will be automatically polled if **update_interval** is set.
|
A Nextion component with an integer value (.val) or Nextion variable will be automatically polled if **update_interval** is set.
|
||||||
To have the Nextion send the data you can use the :ref:`nextion_custom_text_sensor_protocol` for this. Add the :ref:`nextion_custom_text_sensor_protocol` to the
|
To have the Nextion send the data you can use the :ref:`nextion_custom_text_sensor_protocol` for this. Add the :ref:`nextion_custom_text_sensor_protocol` to the
|
||||||
component or function you want to trigger the send. Typically this is in *Touch Press Event* but some components, like a slider, should have it
|
component or function you want to trigger the send. Typically this is in *Touch Press Event* but some components, like a slider, should have it
|
||||||
set in the *Touch Release Event* to capture all the changes. Since this is a custom protocol it can be sent from anywhere (timers/functions/componenets)
|
set in the *Touch Release Event* to capture all the changes. Since this is a custom protocol it can be sent from anywhere (timers/functions/components)
|
||||||
in the Nextion.
|
in the Nextion.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
@ -239,7 +239,7 @@ Configuration variables:
|
|||||||
|
|
||||||
Due to limitations of the SNTP implementation, this component will trigger ``on_time_sync`` only once when it detects that the
|
Due to limitations of the SNTP implementation, this component will trigger ``on_time_sync`` only once when it detects that the
|
||||||
system clock has been set, even if the update was not done by the SNTP implementation!
|
system clock has been set, even if the update was not done by the SNTP implementation!
|
||||||
This must be taken into consideration when SNTP is used together with other real time componnents, where another time source could
|
This must be taken into consideration when SNTP is used together with other real time components, where another time source could
|
||||||
update the time before SNTP synchronizes.
|
update the time before SNTP synchronizes.
|
||||||
|
|
||||||
GPS Time Source
|
GPS Time Source
|
||||||
@ -326,7 +326,7 @@ In a typical setup, you will have at least one additional time source to synchro
|
|||||||
external time source might not always be available e.g. due to a limited network connection.
|
external time source might not always be available e.g. due to a limited network connection.
|
||||||
In order to have a valid, reliable system time, the system should read the RTC once at start and then try to
|
In order to have a valid, reliable system time, the system should read the RTC once at start and then try to
|
||||||
synchronize with an external reliable time source.
|
synchronize with an external reliable time source.
|
||||||
When a synchronization to another time source was successfull, the RTC can be resynchronized.
|
When a synchronization to another time source was successful, the RTC can be resynchronized.
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
@ -62,7 +62,7 @@ Configuration variables:
|
|||||||
- **ap_timeout** (*Optional*, :ref:`time <config-time>`): The time after which to enable the
|
- **ap_timeout** (*Optional*, :ref:`time <config-time>`): The time after which to enable the
|
||||||
configured fallback hotspot. Defaults to ``1min``.
|
configured fallback hotspot. Defaults to ``1min``.
|
||||||
|
|
||||||
- **enable_mdns** (*Optional*, boolean): Controls if your node should advertise its presense and services using mDNS. When set to ``false`` you won't be able to access your node using its hostname which can break certain functionalities. Please see :ref:`notes on disabling mDNS <faq-notes_on_disabling_mdns>`. Defaults to ``true``.
|
- **enable_mdns** (*Optional*, boolean): Controls if your node should advertise its presence and services using mDNS. When set to ``false`` you won't be able to access your node using its hostname which can break certain functionalities. Please see :ref:`notes on disabling mDNS <faq-notes_on_disabling_mdns>`. Defaults to ``true``.
|
||||||
- **domain** (*Optional*, string): Set the domain of the node hostname used for uploading.
|
- **domain** (*Optional*, string): Set the domain of the node hostname used for uploading.
|
||||||
For example, if it's set to ``.local``, all uploads will be sent to ``<HOSTNAME>.local``.
|
For example, if it's set to ``.local``, all uploads will be sent to ``<HOSTNAME>.local``.
|
||||||
Defaults to ``.local``.
|
Defaults to ``.local``.
|
||||||
|
@ -71,7 +71,7 @@ Configuration example:
|
|||||||
state: OFF
|
state: OFF
|
||||||
# This entry queries the battery level. Some tags may not
|
# This entry queries the battery level. Some tags may not
|
||||||
# support this characteristic, you will see 'Unknown' in the
|
# support this characteristic, you will see 'Unknown' in the
|
||||||
# HA frontent.
|
# HA frontend.
|
||||||
- platform: ble_client
|
- platform: ble_client
|
||||||
ble_client_id: itag_black
|
ble_client_id: itag_black
|
||||||
name: "Black iTag Battery"
|
name: "Black iTag Battery"
|
||||||
|
@ -9,7 +9,7 @@ Infostripe
|
|||||||
Showing the current status of sensor states using a Neopixel (WS2812B) strip is a simple way to communicate states to the user.
|
Showing the current status of sensor states using a Neopixel (WS2812B) strip is a simple way to communicate states to the user.
|
||||||
Compared to a dashboard screen the infostrip can only communicate the information like a binary sensor.
|
Compared to a dashboard screen the infostrip can only communicate the information like a binary sensor.
|
||||||
|
|
||||||
- color (e.g., red = error/warning, orange = waring, green = ok, blue = active)
|
- color (e.g., red = error/warning, orange = warning, green = ok, blue = active)
|
||||||
- intensity (off, scaled brightness)
|
- intensity (off, scaled brightness)
|
||||||
- mode (continuous vs. flashing, flashing or strobe is not recommend)
|
- mode (continuous vs. flashing, flashing or strobe is not recommend)
|
||||||
- light position on stripe
|
- light position on stripe
|
||||||
|
@ -33,7 +33,7 @@ Syntax
|
|||||||
|
|
||||||
Here's a quick RST primer:
|
Here's a quick RST primer:
|
||||||
|
|
||||||
Title hierarchy is based on order of occurence, not on type of character used to underline it. This
|
Title hierarchy is based on order of occurrence, not on type of character used to underline it. This
|
||||||
documents establish the following character order for better consistency.
|
documents establish the following character order for better consistency.
|
||||||
|
|
||||||
- **Headers**: You can write titles like this:
|
- **Headers**: You can write titles like this:
|
||||||
|
@ -234,11 +234,11 @@ class SchemaGeneratorVisitor(nodes.NodeVisitor):
|
|||||||
self.props_level = 0
|
self.props_level = 0
|
||||||
|
|
||||||
def visit_document(self, node):
|
def visit_document(self, node):
|
||||||
# ESPHome page docs follows strict formating guidelines which allows
|
# ESPHome page docs follows strict formatting guidelines which allows
|
||||||
# for docs to be parsed directly into yaml schema
|
# for docs to be parsed directly into yaml schema
|
||||||
|
|
||||||
if self.docname in ["components/sensor/binary_sensor_map"]:
|
if self.docname in ["components/sensor/binary_sensor_map"]:
|
||||||
# temporarly not supported
|
# temporarily not supported
|
||||||
raise nodes.SkipChildren
|
raise nodes.SkipChildren
|
||||||
|
|
||||||
if len(list(node.traverse(nodes.paragraph))) == 0:
|
if len(list(node.traverse(nodes.paragraph))) == 0:
|
||||||
@ -349,7 +349,7 @@ class SchemaGeneratorVisitor(nodes.NodeVisitor):
|
|||||||
if title_text == CONFIGURATION_VARIABLES:
|
if title_text == CONFIGURATION_VARIABLES:
|
||||||
if not self.props and self.multi_component is None:
|
if not self.props and self.multi_component is None:
|
||||||
raise ValueError(
|
raise ValueError(
|
||||||
f'Found a "{CONFIGURATION_VARIABLES}": title after {self.previous_title_text}. Unkown object.'
|
f'Found a "{CONFIGURATION_VARIABLES}": title after {self.previous_title_text}. Unknown object.'
|
||||||
)
|
)
|
||||||
|
|
||||||
if title_text == "Over SPI" or title_text == "Over I²C":
|
if title_text == "Over SPI" or title_text == "Over I²C":
|
||||||
@ -645,7 +645,7 @@ class SchemaGeneratorVisitor(nodes.NodeVisitor):
|
|||||||
self.prop_stack.append(self.props)
|
self.prop_stack.append(self.props)
|
||||||
self.props = self.find_props(ref)
|
self.props = self.find_props(ref)
|
||||||
else:
|
else:
|
||||||
# TODO: if the list items are formated like:
|
# TODO: if the list items are formatted like:
|
||||||
# - ``value`` <optional description>
|
# - ``value`` <optional description>
|
||||||
# - ``other value`` <optional description>
|
# - ``other value`` <optional description>
|
||||||
# then we could ensure these are enum values (or populate enum values double check.)
|
# then we could ensure these are enum values (or populate enum values double check.)
|
||||||
@ -798,7 +798,7 @@ class SchemaGeneratorVisitor(nodes.NodeVisitor):
|
|||||||
k = str(prop_name)
|
k = str(prop_name)
|
||||||
jprop = props.get(k)
|
jprop = props.get(k)
|
||||||
if not jprop:
|
if not jprop:
|
||||||
# Create docs for common properties when descriptions are overriden
|
# Create docs for common properties when descriptions are overridden
|
||||||
# in the most specific component.
|
# in the most specific component.
|
||||||
|
|
||||||
if k in [
|
if k in [
|
||||||
@ -812,7 +812,7 @@ class SchemaGeneratorVisitor(nodes.NodeVisitor):
|
|||||||
"update_interval",
|
"update_interval",
|
||||||
# uart
|
# uart
|
||||||
"uart_id",
|
"uart_id",
|
||||||
# ligth
|
# light
|
||||||
"effects",
|
"effects",
|
||||||
"gamma_correct",
|
"gamma_correct",
|
||||||
"default_transition_length",
|
"default_transition_length",
|
||||||
|
Loading…
Reference in New Issue
Block a user