Modbus Sensor


The modbus sensor allows you to gather data from Modbus registers.

Configuration

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

# Example configuration.yaml entry
sensor:
  platform: modbus
  registers:
    - name: Sensor1
      hub: hub1
      unit_of_measurement: °C
      slave: 1
      register: 100
    - name: Sensor2
      hub: hub1
      unit_of_measurement: mg
      slave: 1
      register: 110
      count: 2
    - name: Sensor3
      hub: hub1
      unit_of_measurement: °C
      slave: 1
      register: 120
      register_type: input
      data_type: float
      scale: 0.01
      offset: -273.16
      precision: 2

Configuration Variables

registersmapRequired

The array contains a list of relevant registers to read from.

namestringRequired

Name of the sensor.

hubstring(Optional, default: default)

The name of the hub.

slaveintegerRequired

The number of the slave (Optional for tcp and upd Modbus).

registerintegerRequired

Register number.

register_typestring(Optional)

Modbus register type (holding, input), default holding.

unit_of_measurementinteger(Optional)

Unit to attach to value.

device_classdevice_class(Optional, default: None)

The type/class of the sensor to set the icon in the frontend.

countinteger(Optional, default: 1)

Number of registers to read.

reverse_orderboolean(Optional, default: false)

Reverse the order of registers when count >1.

scalefloat(Optional, default: 1)

Scale factor (output = scale * value + offset).

offsetfloat(Optional, default: 0)

Final offset (output = scale * value + offset).

precisioninteger(Optional, default: 0)

Number of valid decimals.

data_typestring(Optional, default: int)

Response representation (int, uint, float, string, custom). If float selected, value will be converted to IEEE 754 floating point format.

structurestring(Optional)

If data_type is custom specify here a double quoted Python struct format string to unpack the value. See Python documentation for details. Ex: >i.

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

If you specify scale or offset as floating point values, double precision floating point arithmetic will be used to calculate final value. This can cause loss of precision for values that are larger than 2^53.

Full example

Example a temperature sensor with a 10 seconds scan interval:

sensor:
- platform: modbus
  scan_interval: 10
  registers:
    - name: Room_1
      hub: hub1
      slave: 10
      register: 0
      register_type: holding
      unit_of_measurement: °C
      count: 1
      scale: 0.1
      offset: 0
      precision: 1
      data_type: integer