teleinfo: update documentation since sensor/text_sensor move. (#871)

Co-authored-by: Guillermo Ruffino <glm.net@gmail.com>
This commit is contained in:
0hax 2021-06-01 03:32:33 +02:00 committed by GitHub
parent 5a88e2fda2
commit c2fd2ae435
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 44 additions and 22 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 49 KiB

View File

@ -57,35 +57,42 @@ simply press -/+ buttons on the counter and look for `Standard mode` or
parity: EVEN parity: EVEN
data_bits: 7 data_bits: 7
teleinfo:
id: myteleinfo
update_interval: 60s
historical_mode: true
sensor: sensor:
- platform: teleinfo - platform: teleinfo
tags: tag_name: "HCHC"
- name: "HCHC" name: "hchc"
sensor: unit_of_measurement: "Wh"
name: "hchc" icon: mdi:flash
unit_of_measurement: "Wh" teleinfo_id: myteleinfo
icon: mdi:flash - platform: teleinfo
- name: "HCHP" tag_name: "HCHP"
sensor: name: "hchp"
name: "hchp" unit_of_measurement: "Wh"
unit_of_measurement: "Wh" icon: mdi:flash
icon: mdi:flash teleinfo_id: myteleinfo
- name: "PAPP" - platform: teleinfo
sensor: tag_name: "PAPP"
name: "papp" name: "papp"
unit_of_measurement: "VA" unit_of_measurement: "VA"
icon: mdi:flash icon: mdi:flash
update_interval: 60s teleinfo_id: myteleinfo
historical_mode: true
text_sensor:
- platform: teleinfo
tag_name: "OPTARIF"
name: "optarif"
teleinfo_id: myteleinfo
Configuration variables: Configuration variables:
------------------------ ------------------------
- **tags** (**Required**): Specify the tag you want to retrieve from the Teleinformation and select with what name to transmit it. In teleinfo platform:
- **name** (**Required**, string): The name of the tag corresponding to what the electrical counter send.
- **sensor** (**Required**, :ref:`Sensor <config-sensor>`): Associate a sensor with the tag. See options from :ref:`Sensor <config-sensor>`.
- **historical_mode** (*Optional*): Wether to use historical mode or standard mode. - **historical_mode** (*Optional*): Wether 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
@ -97,6 +104,21 @@ Configuration variables:
- **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`UART Component <uart>` if you want - **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`UART Component <uart>` if you want
to use multiple UART buses. to use multiple UART buses.
Sensor
******
- **tag_name** (**Required**, string): Specify the tag you want to retrieve from the Teleinformation.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Sensor <config-sensor>`.
Text Sensor
***********
- **tag_name** (**Required**, string): Specify the tag you want to retrieve from the Teleinformation.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Text Sensor <config-text_sensor>`.
See Also See Also
-------- --------