diff --git a/source/_components/binary_sensor.modbus.markdown b/source/_components/binary_sensor.modbus.markdown new file mode 100644 index 00000000000..2c48b1f7523 --- /dev/null +++ b/source/_components/binary_sensor.modbus.markdown @@ -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. diff --git a/source/_components/modbus.markdown b/source/_components/modbus.markdown index 53b1e9d6339..3b3295bda08 100644 --- a/source/_components/modbus.markdown +++ b/source/_components/modbus.markdown @@ -20,7 +20,7 @@ To add modbus to your installation, add the following to your `configuration.yam For a network connection: ```yaml -#Modbus TCP +# Modbus TCP modbus: type: tcp host: IP_ADDRESS @@ -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/) - diff --git a/source/_components/sensor.modbus.markdown b/source/_components/sensor.modbus.markdown index a8f4acdc32e..691a755be5b 100644 --- a/source/_components/sensor.modbus.markdown +++ b/source/_components/sensor.modbus.markdown @@ -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. - -
-Each named register will create an integer sensor and each named bit will create a boolean sensor. -
- + - **name** (*Required*): Name of the sensor. + - **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 diff --git a/source/_components/switch.modbus.markdown b/source/_components/switch.modbus.markdown index c3512345703..3c9e1660016 100644 --- a/source/_components/switch.modbus.markdown +++ b/source/_components/switch.modbus.markdown @@ -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. - --Each named bit will create a switch. -
- + - **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