Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2025-04-02 18:06:51 +02:00
Code Issues Projects Releases Wiki Activity

A few format consistency issues (#1340)

Browse Source 
* fix nextion missing properties

* teleinfo is now component

* tuya props formatting

* havells name component mismatch

* light.addressable_set do not have color_brightness

* Revert "light.addressable_set do not have color_brightness"

This reverts commit a0abf7e44139b86f7d65b2ba2f2c40151ad6a257.
This commit is contained in:
Guillermo Ruffino 2021-08-04 09:35:19 -03:00 committed by GitHub
parent d0f311a18f
commit 5b0a0aa74d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
components/binary_sensor/nextion.rst
View File

@ -47,9 +47,7 @@ Configuration variables:
- **component_id** (*Optional*, string): The ID (the number, not name!) of the component to track.
- **update_interval** (*Optional*, :ref:`config-time`): The duration to update the sensor. If using a :ref:`nextion_custom_binary_sensor_protocol` this should not be used
- **background_color** (*Optional*, :ref:`config-color`): The background color
- **background_pressed_color** (*Optional*, :ref:`config-color`): The background color when pressed
- **foreground_color** (*Optional*, :ref:`config-color`): The foreground color
- **foreground_pressed_color** (*Optional*, :ref:`config-color`): The foreground color when pressed
- **visible** (*Optional*, boolean ): Visible or not
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.

6
components/light/tuya.rst
View File

@ -86,10 +86,10 @@ Configuration variables:
- **max_value** (*Optional*, int, default 255): The highest dimmer value allowed. Most dimmers have a
maximum of 255, but dimmers with a maximum of 1000 can also be found. Try what works best.
- **color_temperature_max_value** (*Optional*, int, default 255): The highest color temperature
value allowed. Some ceiling fans have a value of 100 (also for `max_value`).
- **cold_white_color_temperature** (**Optional**, float): The color temperate (in `mireds
value allowed. Some ceiling fans have a value of 100 (also for ``max_value``).
- **cold_white_color_temperature** (*Optional*, float): The color temperate (in `mireds
<https://en.wikipedia.org/wiki/Mired>`__ or Kelvin) of the cold white channel.
- **warm_white_color_temperature** (**Optional**, float): The color temperate (in `mireds
- **warm_white_color_temperature** (*Optional*, float): The color temperate (in `mireds
<https://en.wikipedia.org/wiki/Mired>`__ or Kelvin) of the warm white channel.
- All other options from :ref:`Light <config-light>`.
- At least one of *dimmer_datapoint* or *switch_datapoint* must be provided.

22
components/sensor/havells_inverter.rst → components/sensor/havells_solar.rst
View File

@ -1,5 +1,5 @@
Havells Inverter
================
Havells Solar
=============
.. seo::
:description: Instructions for setting up Havells inverter reading on modbus.
@ -28,12 +28,12 @@ to some pins on your board and the baud rate set to 9600.
baud_rate: 9600
tx_pin: GPIO1
rx_pin: GPIO3
modbus:
uart_id: uart1
flow_control_pin: GPIO4
sensor:
- platform: havells_solar
update_interval: 60s
@ -79,7 +79,7 @@ to some pins on your board and the baud rate set to 9600.
reactive_power:
name: "HAVELLS Reactive Power"
frequency:
name: "HAVELLS Frequency"
name: "HAVELLS Frequency"
energy_production_day:
name: "HAVELLS Today's Generation"
total_energy_production:
@ -104,9 +104,9 @@ to some pins on your board and the baud rate set to 9600.
name: "HAVELLS DCI Of S"
dci_of_t:
name: "HAVELLS DCI Of T"
Configuration variables:
------------------------
@ -145,7 +145,7 @@ Configuration variables:
- **active_power** (*Optional*): Use the (active) power value of the sensor in watts. All options
from :ref:`Sensor <config-sensor>`.
- **reactive_power** (*Optional*): Use the reactive power value of the sensor in VAR. All
options from :ref:`Sensor <config-sensor>`.
options from :ref:`Sensor <config-sensor>`.
- **frequency** (*Optional*): Use the frequency value of the sensor in hertz.
All options from :ref:`Sensor <config-sensor>`.
- **energy_production_day** (*Optional*): Use the export active energy value for same day of the
@ -162,7 +162,7 @@ Configuration variables:
degree celsius. All options from :ref:`Sensor <config-sensor>`.
- **inverter_bus_voltage** (*Optional*): Use the inverter bus voltage value of the sensor in volts.
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
-ve terminal to ground value of the sensor in kilo ohms. All options from :ref:`Sensor <config-sensor>`.
- **gfci_value** (*Optional*): Use the GFCI value of the sensor.
All options from :ref:`Sensor <config-sensor>`.

2
components/sensor/nextion.rst
View File

@ -60,7 +60,7 @@ Configuration variables:
- **component_name** (*Optional*, string): Manually specify the name of the Nextion component.
- **variable_name** (*Optional*, string): Manually specify the name of the Nextion variable.
- **update_interval** (*Optional*, :ref:`config-time`): The duration to update the sensor
- **nextion_precision** (*Optional*, uint8_t): This is for Nextion float components. This sets
- **precision** (*Optional*, uint8_t): This is for Nextion float components. This sets
the precision that the component is set to. This typically is the ``vvs1`` setting of the component.
- **background_color** (*Optional*, :ref:`config-color`): The background color
- **foreground_color** (*Optional*, :ref:`config-color`): The foreground color

5
components/sensor/teleinfo.rst
View File

@ -6,7 +6,10 @@ Teleinformation from Linky electrical counter.
:image: teleinfo.jpg
:keywords: teleinfo
The ``teleinfo`` component allows you to retrieve data from a
Component/Hub
-------------
The ``teleinfo`` component allows you to retrieve data from a
French electrical counter using Teleinformation (`datasheet <https://www.enedis.fr/sites/default/files/Enedis-NOI-CPT_54E.pdf>`__). It works with Linky electrical
counter but also legacy EDF electrical counter.

1
components/text_sensor/nextion.rst
View File

@ -35,7 +35,6 @@ Configuration variables:
- **name** (**Required**, string): The name of the sensor.
- **nextion_id** (*Optional*, :ref:`config-id`): The ID of the Nextion display.
- **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 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
- **background_color** (*Optional*, :ref:`config-color`): The background color
- **foreground_color** (*Optional*, :ref:`config-color`): The foreground color

2
index.rst
View File

@ -174,7 +174,7 @@ Sensor Components
Duty Cycle, components/sensor/duty_cycle, percent.svg
ESP32 Hall Sensor, components/sensor/esp32_hall, magnet.svg
EZO sensor circuits, components/sensor/ezo, ezo-ph-circuit.png
Havells Inverter, components/sensor/havells_inverter, havellsgti5000d_s.jpg
Havells Solar, components/sensor/havells_solar, havellsgti5000d_s.jpg
HDC1080, components/sensor/hdc1080, hdc1080.jpg
HLW8012, components/sensor/hlw8012, hlw8012.svg
HMC5883L, components/sensor/hmc5883l, hmc5883l.jpg