Skip to content

Commit

Permalink
lint corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
j0ta29 committed Apr 1, 2023
1 parent 989ece6 commit 22d23d7
Showing 1 changed file with 60 additions and 59 deletions.
119 changes: 60 additions & 59 deletions components/optolink.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ Using an adapter cable you can read parameters of the heating component and also
Once configured, you can add further :doc:`Sensors</components/sensor/index>`, :doc:`Binary Sensors</components/binary_sensor/index>` and :doc:`Text Sensors</components/text_sensor/index>` to monitor parameters of the heating component. Moreover, you can add :doc:`Switches</components/switch/index>`, :doc:`Numbers</components/number/index>` and :doc:`Selects</components/select/index>` to control the heating component.

.. note::
The ``optolink`` platform is based on the great work of many people in the `OpenV project <https://github.com/openv/openv/wiki>`__ and the fantastic Arduino Library `VitoWiFi <https://github.com/bertmelis/VitoWiFi>`__ of Bert Melis.

The ``optolink`` platform is based on the great work of many people in the `OpenV project <https://github.com/openv/openv/wiki>`__ and the fantastic Arduino Library `VitoWiFi <https://github.com/bertmelis/VitoWiFi>`__ of Bert Melis.

Overview
--------
Expand All @@ -32,11 +33,11 @@ Platform configuration
***********************
.. code-block:: yaml
# Example configuration entry
optolink:
protocol: P300
device_info: Device Info
state: Component state
# Example configuration entry
optolink:
protocol: P300
device_info: Device Info
state: Component state
Configuration variables:
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -51,15 +52,15 @@ Sensors
*******
.. code-block:: yaml
# Example configuration entry
sensor:
- platform: optolink
name: Boiler Temperature
address: 0xA309
bytes: 2
div_ratio: 100
unit_of_measurement: °C
device_class: temperature
# Example configuration entry
sensor:
- platform: optolink
name: Boiler Temperature
address: 0xA309
bytes: 2
div_ratio: 100
unit_of_measurement: °C
device_class: temperature
Configuration variables:
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -72,11 +73,11 @@ Binary Sensors
**************
.. code-block:: yaml
# Example configuration entry
binary_sensor:
- platform: optolink
name: Disturbance
address: 0x0A82
# Example configuration entry
binary_sensor:
- platform: optolink
name: Disturbance
address: 0x0A82
Configuration variables:
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -87,13 +88,13 @@ Text Sensors
************
.. code-block:: yaml
# Example configuration entry
text_sensor:
- platform: optolink
name: Error history 1
address: 0x7590
bytes: 9
raw: true
# Example configuration entry
text_sensor:
- platform: optolink
name: Error history 1
address: 0x7590
bytes: 9
raw: true
Configuration variables:
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -105,20 +106,20 @@ Configuration variables:
Numbers
*******
.. code-block:: yaml
# Example configuration entry
number:
- platform: optolink
name: Room Temperature Setpoint
unit_of_measurement: °C
address: 0x2306
bytes: 1
min_value: 3
max_value: 37
step: 1
mode: box
icon: "mdi:home-thermometer"
device_class: temperature
# Example configuration entry
number:
- platform: optolink
name: Room Temperature Setpoint
unit_of_measurement: °C
address: 0x2306
bytes: 1
min_value: 3
max_value: 37
step: 1
mode: box
icon: "mdi:home-thermometer"
device_class: temperature
Configuration variables:
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -133,13 +134,13 @@ Configuration variables:
Switches
********
.. code-block:: yaml
# Example configuration entry
switch:
- platform: optolink
name: Economy mode
address: 0x2302
icon: mdi:sprout-outline
# Example configuration entry
switch:
- platform: optolink
name: Economy mode
address: 0x2302
icon: mdi:sprout-outline
Configuration variables:
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -149,17 +150,17 @@ Configuration variables:
Selects
*******
.. code-block:: yaml
# Example configuration entry
select:
- platform: optolink
name: Operation mode
address: 0x2323
bytes: 1
map:
- "0 -> Off"
- "1 -> Only hot water"
- "2 -> Heating and hot water"
# Example configuration entry
select:
- platform: optolink
name: Operation mode
address: 0x2323
bytes: 1
map:
- "0 -> Off"
- "1 -> Only hot water"
- "2 -> Heating and hot water"
Configuration variables:
~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 22d23d7

Please sign in to comment.