home-assistant.io/source/_integrations/binary_sensor.modbus.markdown
Tom Brien a531c6a520
Update full example for modbus binary_sensor (#13717)
Someone did a bit of a drive by on the doc discord yesterday pointing out that the _full_ example with `scan_interval` hadn't been updated to reflect changes from home-assistant/core#30004. The first example was updated but not this one. I've also tweaked it to more closely match the top example

The user haven't been back since to see they could of made the change, so here it is.
2020-06-11 11:58:10 +02:00

2.2 KiB

title description ha_category ha_release ha_iot_class ha_domain
Modbus Binary Sensor Instructions on how to set up Modbus binary sensors within Home Assistant.
Binary Sensor
0.28 Local Push modbus

The modbus binary sensor allows you to gather data from Modbus coils.

Configuration

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

# Example configuration.yaml entry
binary_sensor:
  - platform: modbus
    inputs:
      - name: Sensor1
        hub: hub1
        slave: 1
        address: 100
      - name: Sensor2
        hub: hub1
        slave: 1
        address: 110
        input_type: discrete_input

{% configuration %} inputs: description: The array contains a list of coils and discrete inputs to read from. required: true type: [map, list] keys: name: description: Name of the sensor. required: true type: string hub: description: The name of the hub. required: false default: default type: string slave: description: The number of the slave (Optional for TCP and UDP Modbus). required: true type: integer address: description: Coil or discrete input Modbus address. required: true type: integer input_type: description: Modbus input type (coil, discrete_input), default coil. required: false type: string device_class: description: The type/class of the binary sensor to set the icon in the frontend. required: false type: device_class default: None {% endconfiguration %}

It's possible to change the default 30 seconds scan interval for the sensor updates as shown in the Platform options documentation.

Full example

Example a sensor with a 10 seconds scan interval:

binary_sensor:
  - platform: modbus
    scan_interval: 10
    inputs:
      - name: Sensor1
        hub: hub1
        slave: 1
        address: 100
      - name: Sensor2
        hub: hub1
        slave: 1
        address: 110
        input_type: discrete_input