7b4305c7ee
* Update Modbus component configuration variable Update style of Modbus component (all the 4 files) documentation to follow new configuration variables description. * Update modbus.markdown * Update binary_sensor.modbus.markdown * Tweak fix * Tweak round 2 😛 * ✏️ Tweak round 3
3.0 KiB
layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release, ha_iot_class
| layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_release | ha_iot_class |
|---|---|---|---|---|---|---|---|---|---|---|---|
| page | Modbus | Instructions on how to integrate Modbus within Home Assistant. | 2015-04-25 9:16 | true | false | true | true | modbus.png | Hub | pre 0.7 | Local Push |
Modbus is a serial communication protocol to control PLCs (Programmable logic controller). It currently supports sensors and switches which can be controlled over serial, TCP, and UDP connections.
{% linkable_title Configuration %}
To add modbus to your installation, add the following to your configuration.yaml file:
For a network connection:
# Example configuration.yaml entry for a TCP connection
modbus:
type: tcp
host: IP_ADDRESS
port: 2020
{% configuration %}
type:
description: Type of the connection to Modbus. Possible values are tcp (Modbus TCP protocol according to "MODBUS Messaging Implementation Guide version 1.0b" provided by Schneider Automation.), udp(Modbus TCP form, but using UDP for transport. It removes the overheads required for TCP.) and rtuovertcp (Modbus RTU message transmitted with a TCP/IP wrapper and sent over a network instead of serial lines.).
required: true
type: string
host:
description: The IP address of your Modbus device, e.g., 192.168.1.1.
required: true
type: string
port:
description: The port for the communication.
required: true
type: integer
timeout:
description: Timeout for slave response in seconds.
required: false
default: 3
type: integer
{% endconfiguration %}
For a serial connection:
# Example configuration.yaml entry for a serial connection
modbus:
type: serial
method: rtu
port: /dev/ttyUSB0
baudrate: 9600
stopbits: 1
bytesize: 8
parity: N
{% configuration %} type: description: Type of the connection to Modbus. required: true type: string method: description: Method of the connection to Modbus. required: true type: string port: description: The port where your Modbus device is connected to your Home Assistant host. required: true type: string baudrate: description: The speed for the serial connection. required: true type: integer stopbits: description: The stopbits for the serial connection. required: true type: integer bytesize: description: The bytesize for the serial connection. required: true type: integer parity: description: The parity for the serial connection. required: true type: string timeout: description: Timeout for slave response in seconds. required: false default: 3 type: integer {% endconfiguration %}
{% linkable_title Services %}
| Service | Description |
|---|---|
| write_register | Write register. Requires unit, address and value fields. value can be either single value or an array |