modbus refactoring (#933)

This commit is contained in:
Per Sandström 2016-09-19 14:50:02 +02:00 committed by Fabian Affolter
parent eb2cc6228b
commit 95ce88ec33
4 changed files with 75 additions and 52 deletions

View File

@ -0,0 +1,37 @@
---
layout: page
title: "Modbus Binary Sensor"
description: "Instructions on how to set up Modbus binary sensors within Home Assistant."
date: 2016-09-13 12:02
sidebar: true
comments: false
sharing: true
footer: true
logo: modbus.png
ha_category: Binary Sensor
ha_release: 0.28
---
The `modbus` binary sensor allows you to gather data from [Modbus](http://www.modbus.org/) coils.
To use your Modbus binary sensors in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yml entry
binary_sensor:
platform: modbus
coils:
- name: Sensor1
slave: 1
coil: 100
- name: Sensor2
slave: 1
coil: 110
```
Configuration variables:
- **coils** array (*Required*): The array contains a list of coils to read from.
- **name** (*Required*): Name of the sensor.
- **slave** (*Required*): The number of the slave (Optional for tcp and upd Modbus).
- **coil** (*Required*): Coil number.

View File

@ -67,6 +67,6 @@ Configuration variables:
## {% linkable_title Building on top of Modbus %}
- [Modbus Binary Sensor](/components/binary_sensor.modbus/)
- [Modbus Sensor](/components/sensor.modbus/)
- [Modbus Switch](/components/switch.modbus/)

View File

@ -1,6 +1,6 @@
---
layout: page
title: "Modbus Sensor"
title: Modbus Sensor
description: "Instructions how to integrate Modbus sensors into Home Assistant."
date: 2015-08-30 23:38
sidebar: true
@ -13,7 +13,7 @@ ha_release: pre 0.7
---
The `modbus` sensor platform allows you to gather data from your [Modbus](http://www.modbus.org/) sensors.
The `modbus` sensor allows you to gather data from [Modbus](http://www.modbus.org/) registers.
To use your Modbus sensors in your installation, add the following to your `configuration.yaml` file:
@ -21,35 +21,33 @@ To use your Modbus sensors in your installation, add the following to your `conf
# Example configuration.yml entry
sensor:
platform: modbus
slave: 1
registers:
16:
name: My integer sensor
unit: C
24:
bits:
0:
name: My boolean sensor
2:
name: My other boolean sensor
coils:
0:
name: My coil switch
- name: Sensor1
unit_of_measurement: °C
slave: 1
register: 100
- name: Sensor2
unit_of_measurement: mg
slave: 1
register: 110
count: 2
- name: Sensor3
unit_of_measurement: °C
slave: 1
register: 120
scale: 0.01
offset: -273.16
precision: 2
```
Configuration variables:
- **slave** (*Required*): The number of the slave (ignored and can be omitted if not serial Modbus).
- **registers** array (*Required*): The array contains a list of relevant registers to read from.
- **number of register** (*Required*): Listing relevant bits. It must contain a `bits` section.
- **bits** array (*Required*): Listing relevant bits. It must contain a `bits` section.
- **name** (*Required*): Name of the sensor.
- **unit** (*Required*): Unit to attach to value (optional, ignored for boolean sensors).
- **coils** (*Optional*): A list of relevant coils to read from/write to
- **number of coil** array (*Required*):
- **name** (*Required*): Name of the coil.
<p class='note warning'>
Each named register will create an integer sensor and each named bit will create a boolean sensor.
</p>
- **slave** (*Required*): The number of the slave (Optional for tcp and upd Modbus).
- **register** (*Required*): Register number.
- **unit_of_measurement** (*Optional*): Unit to attach to value.
- **count** (*Optional*): Number of registers to read.
- **scale** (*Optional*): Scale factor (output = scale * value + offset), default 1
- **offset** (*Optional*): Final offset (output = scale * value + offset), default 0
- **precision** (*Optional*): Number of valid decimals, default 0

View File

@ -13,7 +13,7 @@ ha_release: pre 0.7
---
The `modbus` switch platform allows you to control [Modbus](http://www.modbus.org/) switches.
The `modbus` switch platform allows you to control [Modbus](http://www.modbus.org/) coils.
To use your Modbus switches in your installation, add the following to your `configuration.yaml` file:
@ -22,30 +22,18 @@ To use your Modbus switches in your installation, add the following to your `con
switch:
platform: modbus
slave: 1
registers:
24:
bits:
0:
name: My switch
2:
name: My other switch
coils:
0:
name: My coil switch
- name: Switch1
slave: 1
coil: 13
- name: Switch2
slave: 2
coil: 14
```
Configuration variables:
- **slave** (*Required*): The number of the slave (ignored and can be omitted if not serial Modbus).
- **registers** array (*Required*): The array contains a list of relevant registers to read from.
- **number of register** (*Required*): Listing relevant bits. It must contain a `bits` section.
- **bits** array (*Required*): Listing relevant bits. It must contain a `bits` section.
- **name** (*Required*): Name of the switch.
- **coils** (*Optional*): A list of relevant coils to read from/write to
- **number of coil** array (*Required*):
- **name** (*Required*): Name of the coil.
<p class='note warning'>
Each named bit will create a switch.
</p>
- **slave** (*Required*): The number of the slave (can be omitted for tcp and udp Modbus).
- **name** (*Required*): Name of the sensor
- **coil** (*Required*): Coil number