home-assistant.io/source/_components/switch.modbus.markdown
Franck Nijhof ebca3218c7
🔥Removes linkable_title everywhere (#9772)
* Automatically create linkable headers

* Visually improve position of linkable header chain icon

* Do not auto link  headers on homepage

* Remove linkable_title everywhere

* 🚑 Re-instante linkable_title plugin as NOOP
2019-07-04 19:08:27 +02:00

2.9 KiB

layout title description date sidebar comments sharing footer logo ha_category ha_release ha_iot_class
page Modbus Switch Instructions on how to integrate Modbus switches into Home Assistant. 2015-08-30 23:38 true false true true modbus.png
Switch
pre 0.7 Local Push

The modbus switch platform allows you to control Modbus coils or registers.

Configuration

To use your Modbus switches in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
switch:
  platform: modbus
  slave: 1
  coils:
    - name: Switch1
      hub: hub1
      slave: 1
      coil: 13
    - name: Switch2
      slave: 2
      coil: 14
  registers:
    - name: Register1
      hub: hub1
      slave: 1
      register: 11
      command_on: 1
      command_off: 0

{% configuration %} coils: description: A list of relevant coils to read from/write to. required: false type: map keys: hub: description: The name of the hub. required: false default: default type: string slave: description: The number of the slave (can be omitted for tcp and udp Modbus). required: true type: integer name: description: Name of the switch. required: true type: string coil: description: Coil number. required: true type: integer register: description: A list of relevant registers to read from/write to. required: false type: map keys: hub_name: description: The hub to use. required: false default: default type: string slave: description: The number of the slave (can be omitted for tcp and udp Modbus). required: true type: integer name: description: Name of the switch. required: true type: string register: description: Register number. required: true type: integer command_on: description: Value to write to turn on the switch. required: true type: integer command_off: description: Value to write to turn off the switch. required: true type: integer verify_state: description: Define if is possible to readback the status of the switch. required: false default: true type: boolean verify_register: description: Register to readback. required: false default: same as register type: string register_type: description: Modbus register types are holding or input. required: false default: holding type: string state_on: description: Register value when switch is on. required: false default: same as command_on type: integer state_off: description: Register value when switch is off. required: false default: same as command_off type: integer {% endconfiguration %}