diff --git a/source/components/switch.modbus.markdown b/source/components/switch.modbus.markdown new file mode 100644 index 00000000000..9e63eddf9d4 --- /dev/null +++ b/source/components/switch.modbus.markdown @@ -0,0 +1,48 @@ +--- +layout: page +title: "Modbus switch support" +description: "Instructions how to integrate Modbus switches into Home Assistant." +date: 2015-08-30 23:38 +sidebar: false +comments: false +sharing: true +footer: true +--- + + +The modbus switch platform allows you to control [Modbus](http://www.modbus.org/) switches. + +To use your Modbus switches in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yml entry +switch: + platform: modbus + slave: 1 + registers: + 24: + bits: + 0: + name: My switch + 2: + name: My other switch + coils: + 0: + name: My coil switch +``` + +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. +

+