mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-28 03:37:06 +00:00
Update modbus configuration to use new (#16678)
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
jan iversen
GitHub
parent
1deeb0433d
commit
18615a11b9
@ -1,87 +0,0 @@
|
||||
---
|
||||
title: "Modbus Binary Sensor"
|
||||
description: "Instructions on how to set up Modbus binary sensors within Home Assistant."
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
ha_release: 0.28
|
||||
ha_iot_class: Local Push
|
||||
ha_domain: modbus
|
||||
---
|
||||
|
||||
The `modbus` binary sensor allows you to gather data from [Modbus](http://www.modbus.org/) coils.
|
||||
|
||||
## Configuration
|
||||
|
||||
To use your Modbus binary sensors in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# 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: modbus_hub
|
||||
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](/integrations/binary_sensor/#device-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](/docs/configuration/platform_options/#scan-interval) documentation.
|
||||
|
||||
## Full example
|
||||
|
||||
Example a sensor with a 10 seconds scan interval:
|
||||
|
||||
```yaml
|
||||
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
|
||||
```
|
||||
@ -1,125 +0,0 @@
|
||||
---
|
||||
title: "Modbus Climate"
|
||||
description: "Instructions how to integrate a Modbus thermostat within Home Assistant."
|
||||
ha_category:
|
||||
- Climate
|
||||
ha_release: 0.68
|
||||
ha_iot_class: Local Polling
|
||||
ha_domain: modbus
|
||||
---
|
||||
|
||||
|
||||
The `modbus` thermostat allows you to use a sensor value (current temperature) and target value (target temperature) from [Modbus](http://www.modbus.org/) registers.
|
||||
|
||||
## Configuration
|
||||
|
||||
To use your Modbus thermostat in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
modbus:
|
||||
- name: hub1
|
||||
type: tcp
|
||||
host: IP_ADDRESS
|
||||
port: 502
|
||||
|
||||
climates:
|
||||
- name: Watlow F4T
|
||||
slave: 1
|
||||
data_type: uint
|
||||
data_count: 1
|
||||
scale: 0.1
|
||||
offset: 0
|
||||
precision: 1
|
||||
max_temp: 30
|
||||
min_temp: 15
|
||||
temp_step: 1
|
||||
target_temp_register: 2782
|
||||
current_temp_register: 27586
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
name:
|
||||
description: Name of the device
|
||||
required: true
|
||||
type: string
|
||||
slave:
|
||||
description: The number of the slave (Optional for tcp and upd Modbus, use 1).
|
||||
required: true
|
||||
type: integer
|
||||
target_temp_register:
|
||||
description: Register number for target temperature (Setpoint).
|
||||
required: true
|
||||
type: integer
|
||||
current_temp_register:
|
||||
description: Register number for current temperature (Process value).
|
||||
required: true
|
||||
type: integer
|
||||
current_temp_register_type:
|
||||
description: Modbus register type (holding, input) for current temperature, default holding.
|
||||
required: false
|
||||
type: string
|
||||
default: holding
|
||||
data_type:
|
||||
description: Response representation (int, uint, float, custom). If float selected, value will converted to IEEE 754 floating point format.
|
||||
required: false
|
||||
type: string
|
||||
default: float
|
||||
structure:
|
||||
description: "If `data_type` is custom specified a double-quoted Python struct is expected here, to format the string to unpack the value. See Python documentation for details. Example: `>i`."
|
||||
required: false
|
||||
type: string
|
||||
default: ">f"
|
||||
data_count:
|
||||
description: Number of registers to read.
|
||||
required: false
|
||||
type: integer
|
||||
default: 2
|
||||
precision:
|
||||
description: Number of valid decimals.
|
||||
required: false
|
||||
type: integer
|
||||
default: 1
|
||||
scale:
|
||||
description: Scale factor (output = scale * value + offset).
|
||||
required: false
|
||||
type: float
|
||||
default: 1
|
||||
offset:
|
||||
description: Final offset (output = scale * value + offset).
|
||||
required: false
|
||||
type: float
|
||||
default: 0
|
||||
max_temp:
|
||||
description: Maximum setpoint temperature.
|
||||
required: false
|
||||
type: integer
|
||||
default: 35
|
||||
min_temp:
|
||||
description: Maximum setpoint temperature.
|
||||
required: false
|
||||
type: integer
|
||||
default: 5
|
||||
temp_step:
|
||||
description: The supported step size a target temperature can be increased/decreased.
|
||||
required: false
|
||||
type: float
|
||||
default: 0.5
|
||||
temperature_unit:
|
||||
description: Temperature unit reported by the current_temp_register. C or F
|
||||
required: false
|
||||
type: string
|
||||
default: C
|
||||
scan_interval:
|
||||
description: Defines the update interval of the sensor in seconds.
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
### Services
|
||||
|
||||
| Service | Description |
|
||||
| ------- | ----------- |
|
||||
| set_temperature | Set Temperature. Requires `value` to be passed in, which is the desired target temperature. `value` should be in the same type as `data_type` |
|
||||
@ -1,210 +0,0 @@
|
||||
---
|
||||
title: "Modbus Cover"
|
||||
description: "Instructions on how to integrate Modbus covers into Home Assistant."
|
||||
ha_category:
|
||||
- Cover
|
||||
ha_release: 0.116
|
||||
ha_iot_class: Local Polling
|
||||
ha_domain: modbus
|
||||
---
|
||||
|
||||
The `modbus` cover platform allows you to control [Modbus](http://www.modbus.org/) covers (such as blinds, a roller shutter, or a garage door).
|
||||
|
||||
## Configuration
|
||||
|
||||
At the moment, we support the opening and closing of a cover. You can control your covers either using coils or holding registers.
|
||||
|
||||
Cover that uses the `coil` attribute is not able to determine intermediary states such as opening and closing. Coil stores only two states — "0" means cover closed, and "1" implies cover open. To allow detecting intermediary states, we added an optional `status_register` attribute. It will enable you to write your command (e.g., to open a cover) into a coil, and read current cover status back through the register. Additionally, you can specify values for `state_open`, `state_opening`, `state_closed`, and `state_closing` attributes. These will be matched with the value read from the `status_register`.
|
||||
|
||||
If your cover uses holding register to send commands (defined by the `register` attribute), it can also read the intermediary states. To adjust which value represents what state, you can fine-tune the optional state attributes, like `state_open`. These optional state values are also used for specifying values written into the register. If you specify an optional status_register attribute, cover states will be read from status_register instead of the register used for sending commands.
|
||||
|
||||
To use Modbus covers in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
modbus:
|
||||
- name: hub1
|
||||
type: tcp
|
||||
host: IP_ADDRESS
|
||||
port: 502
|
||||
|
||||
covers:
|
||||
- name: Door1
|
||||
device_class: door
|
||||
scan_interval: 1
|
||||
coil: 0
|
||||
- name: Door2
|
||||
device_class: door
|
||||
scan_interval: 1
|
||||
coil: 1
|
||||
status_register: 1
|
||||
- name: Door3
|
||||
slave: 2
|
||||
device_class: door
|
||||
scan_interval: 1
|
||||
register: 0
|
||||
state_open: 1
|
||||
state_closed: 0
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
covers:
|
||||
description: The array contains a list of all your Modbus covers.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
slave:
|
||||
description: The number of the slave (can be omitted for tcp and udp Modbus).
|
||||
required: false
|
||||
default: 1
|
||||
type: integer
|
||||
name:
|
||||
description: Name of the switch.
|
||||
required: true
|
||||
type: string
|
||||
coil:
|
||||
description: Coil address; can be omitted if a register attribute is specified. Coil and register attributes are mutually exclusive, and you need to always specify one of them.
|
||||
required: true
|
||||
type: integer
|
||||
register:
|
||||
description: Holding register address; can be omitted if a coil attribute is specified. Coil and register attributes are mutually exclusive, and you need to always specify one of them.
|
||||
required: true
|
||||
type: integer
|
||||
status_register:
|
||||
description: An address of an register, from which all the cover states will be read. If you specified `register` attribute, and not `status_register` attribute, your main register will also be used as a status register.
|
||||
required: false
|
||||
type: integer
|
||||
status_register_type:
|
||||
description: Modbus register type (holding, input), default holding.
|
||||
required: false
|
||||
type: string
|
||||
state_open:
|
||||
description: A value in `status_register` or `register` representing an open cover. If your configuration uses an `register` attribute, this value will be also written into a holding register to open the cover.
|
||||
required: false
|
||||
default: 1
|
||||
type: integer
|
||||
state_closed:
|
||||
description: A value in `status_register` or `register` representing a closed cover. If your configuration uses an `register` attribute, this value will be also written into a holding register to close the cover.
|
||||
required: false
|
||||
default: 0
|
||||
type: integer
|
||||
state_opening:
|
||||
description: A value in `status_register` or `register` telling us that the cover is opening at the moment. Note that this state should be also supported on your connected Modbus cover. If it won't write this intermediary state into the register, this state won't be detected.
|
||||
required: false
|
||||
default: 2
|
||||
type: integer
|
||||
state_closing:
|
||||
description: A value in `status_register` or `register` telling us that the cover is closing at the moment. Note that this state should be also supported on your connected Modbus cover. If it won't write this intermediary state into the register, this state won't be detected.
|
||||
required: false
|
||||
default: 2
|
||||
type: integer
|
||||
device_class:
|
||||
description: The [type/class](/integrations/cover/#device-class) of the cover to set the icon in the frontend.
|
||||
required: false
|
||||
type: device_class
|
||||
default: None
|
||||
scan_interval:
|
||||
description: Defines the update interval of the sensor in seconds.
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
{% endconfiguration %}
|
||||
|
||||
## Examples
|
||||
|
||||
In this section, you find some real-life examples of how to use this light.
|
||||
|
||||
### Modbus cover controlled by a coil
|
||||
|
||||
This example shows a configuration for a Modbus cover controlled using a coil. Intermediary states like opening/closing are not supported. The cover state is polled from Modbus every 10 seconds.
|
||||
|
||||
```yaml
|
||||
modbus:
|
||||
- name: hub1
|
||||
type: tcp
|
||||
host: IP_ADDRESS
|
||||
port: 502
|
||||
|
||||
covers:
|
||||
- name: Door1
|
||||
slave: 1
|
||||
coil: 1
|
||||
device_class: door
|
||||
scan_interval: 10
|
||||
- name: Door2
|
||||
slave: 2
|
||||
coil: 2
|
||||
device_class: door
|
||||
scan_interval: 10
|
||||
```
|
||||
|
||||
### Modbus cover controlled by a coil, it's state is read from the register
|
||||
|
||||
This example shows a configuration for a Modbus cover controlled using a coil. Actual cover state is read from the `status_register`. We've also specified register values to match with the states open/opening/closed/closing. The cover state is polled from Modbus every 10 seconds.
|
||||
|
||||
```yaml
|
||||
modbus:
|
||||
- name: hub1
|
||||
type: tcp
|
||||
host: IP_ADDRESS
|
||||
port: 502
|
||||
|
||||
covers:
|
||||
- name: Door1
|
||||
slave: 1
|
||||
device_class: door
|
||||
scan_interval: 10
|
||||
coil: 1
|
||||
status_register: 1
|
||||
status_register_type: input
|
||||
state_opening: 1
|
||||
state_open: 2
|
||||
state_closing: 3
|
||||
state_closed: 4
|
||||
```
|
||||
|
||||
### Modbus cover controlled by a holding register
|
||||
|
||||
This example shows a configuration for a Modbus cover controlled using a holding register, from which we also read current cover state. We've also specified register values to match with the states open/opening/closed/closing. The cover state is polled from Modbus every 10 seconds.
|
||||
|
||||
```yaml
|
||||
modbus:
|
||||
- name: hub1
|
||||
type: tcp
|
||||
host: IP_ADDRESS
|
||||
port: 502
|
||||
|
||||
covers:
|
||||
- name: Door1
|
||||
slave: 1
|
||||
device_class: door
|
||||
scan_interval: 10
|
||||
register: 1
|
||||
state_opening: 1
|
||||
state_open: 2
|
||||
state_closing: 3
|
||||
state_closed: 4
|
||||
```
|
||||
|
||||
### Modbus cover controlled by a holding register, it's state is read from the status register
|
||||
|
||||
This example shows a configuration for a Modbus cover controlled using a holding register. However, cover state is read from a `status_register`. In this case, we've specified only values for `state_open` and `state_closed`, for the rest, default values are used. The cover state is polled from Modbus every 10 seconds.
|
||||
|
||||
```yaml
|
||||
modbus:
|
||||
- name: hub1
|
||||
type: tcp
|
||||
host: IP_ADDRESS
|
||||
port: 502
|
||||
|
||||
covers:
|
||||
- name: Door1
|
||||
slave: 1
|
||||
device_class: door
|
||||
scan_interval: 10
|
||||
register: 1
|
||||
status_register: 2
|
||||
register_type: holding
|
||||
state_open: 1
|
||||
state_closed: 0
|
||||
```
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Modbus
|
||||
description: Instructions on how to integrate Modbus within Home Assistant.
|
||||
description: Instructions on how to integrate Modbus and platforms.
|
||||
ha_category:
|
||||
- Hub
|
||||
ha_release: pre 0.7
|
||||
@ -23,7 +23,16 @@ It supports various types of devices which can be controlled over serial, TCP, a
|
||||
|
||||
## Configuration
|
||||
|
||||
The configuration for adding modbus to your installation depends on the connection type, either a network or serial connection.
|
||||
How to add modbus to your installation depends on the connection type, either a network or serial connection.
|
||||
|
||||
Platforms:
|
||||
- binary_sensor
|
||||
- climate
|
||||
- cover
|
||||
- sensor
|
||||
- switch
|
||||
|
||||
are all defined as part of the modbus configuration. The old configuration style, (having each outside the modbus configuration is still supported, but will cause a warning, and will be removed in a later release).
|
||||
|
||||
### Network connection
|
||||
|
||||
@ -32,40 +41,40 @@ For a network connection, add the following to your `configuration.yaml` file:
|
||||
```yaml
|
||||
# Example configuration.yaml entry for a TCP connection
|
||||
modbus:
|
||||
name: hub1
|
||||
type: tcp
|
||||
host: IP_ADDRESS
|
||||
port: 2020
|
||||
- name: hub1
|
||||
type: tcp
|
||||
host: IP_ADDRESS
|
||||
port: 502
|
||||
```
|
||||
|
||||
{% 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 network port for the communication.
|
||||
required: true
|
||||
type: integer
|
||||
name:
|
||||
description: Name for this hub. Must be unique, so it is required when setting up multiple instances.
|
||||
required: false
|
||||
default: modbus_hub
|
||||
type: string
|
||||
timeout:
|
||||
description: Timeout for slave response in seconds.
|
||||
required: false
|
||||
default: 3
|
||||
type: integer
|
||||
delay:
|
||||
description: Time to sleep in seconds after connecting and before sending messages. Some modbus-tcp servers need a short delay typically 1-2 seconds in order to prepare the communication. If a server accepts connecting, but there is no response to the requests send, this parameter might help.
|
||||
required: false
|
||||
default: 0
|
||||
type: integer
|
||||
host:
|
||||
description: The IP address of your Modbus device, e.g., 192.168.1.1.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: Name for this hub. Must be unique, so it is required when setting up multiple instances.
|
||||
required: false
|
||||
default: modbus_hub
|
||||
type: string
|
||||
port:
|
||||
description: The network port for the communication.
|
||||
required: true
|
||||
type: integer
|
||||
timeout:
|
||||
description: Timeout for slave response in seconds.
|
||||
required: false
|
||||
default: 3
|
||||
type: integer
|
||||
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
|
||||
{% endconfiguration %}
|
||||
|
||||
### Serial connection
|
||||
@ -75,58 +84,661 @@ For a serial connection, add the following to your `configuration.yaml` file:
|
||||
```yaml
|
||||
# Example configuration.yaml entry for a serial connection
|
||||
modbus:
|
||||
name: hub1
|
||||
type: serial
|
||||
method: rtu
|
||||
port: /dev/ttyUSB0
|
||||
baudrate: 9600
|
||||
stopbits: 1
|
||||
bytesize: 8
|
||||
parity: N
|
||||
- name: hub1
|
||||
type: serial
|
||||
method: rtu
|
||||
port: /dev/ttyUSB0
|
||||
baudrate: 9600
|
||||
stopbits: 1
|
||||
bytesize: 8
|
||||
parity: N
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
description: "Type of the connection to Modbus, needs to be `serial` for this setup."
|
||||
required: true
|
||||
type: string
|
||||
method:
|
||||
description: "Method of the connection to Modbus, either `rtu` or `ascii`."
|
||||
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, either `1` or `2`."
|
||||
required: true
|
||||
type: integer
|
||||
bytesize:
|
||||
description: "The bytesize for the serial connection; can be `5`, `6`, `7` or `8`."
|
||||
required: true
|
||||
type: integer
|
||||
parity:
|
||||
description: "The parity for the serial connection; can be `E`, `O` or `N`."
|
||||
delay:
|
||||
description: Time to sleep in seconds after connecting and before sending messages. Some modbus servers need a short delay typically 1-2 seconds in order to prepare the communication. If a server accepts connecting, but there is no response to the requests send, this parameter might help.
|
||||
required: false
|
||||
default: 0
|
||||
type: integer
|
||||
method:
|
||||
description: "Method of the connection to Modbus, either `rtu` or `ascii`."
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: Name for this hub. Must be unique, so it is required when setting up multiple instances.
|
||||
required: false
|
||||
default: default
|
||||
default: modbus_hub
|
||||
type: string
|
||||
parity:
|
||||
description: "The parity for the serial connection; can be `E`, `O` or `N`."
|
||||
required: true
|
||||
type: string
|
||||
port:
|
||||
description: The port where your Modbus device is connected to your Home Assistant host.
|
||||
required: true
|
||||
type: string
|
||||
stopbits:
|
||||
description: "The stopbits for the serial connection, either `1` or `2`."
|
||||
required: true
|
||||
type: integer
|
||||
timeout:
|
||||
description: Timeout for slave response in seconds.
|
||||
required: false
|
||||
default: 3
|
||||
type: integer
|
||||
type:
|
||||
description: "Type of the connection to Modbus, needs to be `serial` for this setup."
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
### Multiple connections
|
||||
### Configuring platform binary sensor
|
||||
|
||||
The `modbus` binary sensor allows you to gather data from [Modbus](http://www.modbus.org/) coils with state ON/OFF.
|
||||
|
||||
To use your Modbus binary sensors in your installation, add the following to your `configuration.yaml` file:
|
||||
```yaml
|
||||
# Example configuration.yaml entry for binary_sensor configuration
|
||||
modbus:
|
||||
- name: hub1
|
||||
type: tcp
|
||||
host: IP_ADDRESS
|
||||
port: 502
|
||||
binary_sensors:
|
||||
- name: Sensor1
|
||||
slave: 1
|
||||
address: 100
|
||||
- name: Sensor2
|
||||
address: 110
|
||||
input_type: discrete_input
|
||||
```
|
||||
{% configuration %}
|
||||
binary_sensors:
|
||||
description: A list of all binary_sensors available in this modbus instance.
|
||||
required: false
|
||||
type: [map]
|
||||
keys:
|
||||
device_class:
|
||||
description: Device class to be used for the UI (e.g. "door").
|
||||
required: false
|
||||
type: string
|
||||
input_type:
|
||||
description: type of adddress (holding/discrete/coil)
|
||||
required: false
|
||||
default: holding
|
||||
type: integer
|
||||
name:
|
||||
description: Name for this binary_sensor. Must be unique.
|
||||
required: true
|
||||
type: string
|
||||
scan_interval:
|
||||
description: Defines the update interval of the sensor in seconds.
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
slave:
|
||||
description: The number of the slave.
|
||||
required: false
|
||||
type: integer
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
### Configuring platform climate
|
||||
|
||||
To use your Modbus thermostat in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
modbus:
|
||||
- name: hub1
|
||||
type: tcp
|
||||
host: IP_ADDRESS
|
||||
port: 502
|
||||
climates:
|
||||
- name: Watlow F4T
|
||||
slave: 1
|
||||
data_type: uint
|
||||
data_count: 1
|
||||
scale: 0.1
|
||||
offset: 0
|
||||
precision: 1
|
||||
max_temp: 30
|
||||
min_temp: 15
|
||||
temp_step: 1
|
||||
target_temp_register: 2782
|
||||
current_temp_register: 27586
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
climates:
|
||||
description: A list of all climates available in this modbus instance.
|
||||
required: false
|
||||
type: [map]
|
||||
keys:
|
||||
current_temp_register:
|
||||
description: Register number for current temperature (Process value).
|
||||
required: true
|
||||
type: integer
|
||||
current_temp_register_type:
|
||||
description: Modbus register type (holding, input) for current temperature, default holding.
|
||||
required: false
|
||||
type: string
|
||||
default: holding
|
||||
data_count:
|
||||
description: Number of registers to read.
|
||||
required: false
|
||||
type: integer
|
||||
default: 2
|
||||
data_type:
|
||||
description: Response representation (int, uint, float, custom). If float selected, value will converted to IEEE 754 floating point format.
|
||||
required: false
|
||||
type: string
|
||||
default: float
|
||||
min_temp:
|
||||
description: Maximum setpoint temperature.
|
||||
required: false
|
||||
type: integer
|
||||
default: 5
|
||||
name:
|
||||
description: Name of the device
|
||||
required: true
|
||||
type: string
|
||||
offset:
|
||||
description: Final offset (output = scale * value + offset).
|
||||
required: false
|
||||
type: float
|
||||
default: 0
|
||||
precision:
|
||||
description: Number of valid decimals.
|
||||
required: false
|
||||
type: integer
|
||||
default: 1
|
||||
scale:
|
||||
description: Scale factor (output = scale * value + offset).
|
||||
required: false
|
||||
type: float
|
||||
default: 1
|
||||
scan_interval:
|
||||
description: Defines the update interval of the sensor in seconds.
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
slave:
|
||||
description: The number of the slave (Optional for tcp and upd Modbus, use 1).
|
||||
required: true
|
||||
type: integer
|
||||
structure:
|
||||
description: "If `data_type` is custom specified a double-quoted Python struct is expected here, to format the string to unpack the value. See Python documentation for details. Example: `>i`."
|
||||
required: false
|
||||
type: string
|
||||
default: ">f"
|
||||
target_temp_register:
|
||||
description: Register number for target temperature (Setpoint).
|
||||
required: true
|
||||
type: integer
|
||||
temp_step:
|
||||
description: The supported step size a target temperature can be increased/decreased.
|
||||
required: false
|
||||
type: float
|
||||
default: 0.5
|
||||
temperature_unit:
|
||||
description: Temperature unit reported by the current_temp_register. C or F
|
||||
required: false
|
||||
type: string
|
||||
default: C
|
||||
{% endconfiguration %}
|
||||
|
||||
#### Services
|
||||
|
||||
| Service | Description |
|
||||
| ------- | ----------- |
|
||||
| set_temperature | Set Temperature. Requires `value` to be passed in, which is the desired target temperature. `value` should be in the same type as `data_type` |
|
||||
|
||||
### Configuring platform cover
|
||||
|
||||
The `modbus` cover platform allows you to control [Modbus](http://www.modbus.org/) covers (such as blinds, a roller shutter, or a garage door).
|
||||
|
||||
At the moment, we support the opening and closing of a cover. You can control your covers either using coils or holding registers.
|
||||
|
||||
Cover that uses the `coil` attribute is not able to determine intermediary states such as opening and closing. Coil stores only two states — "0" means cover closed, and "1" implies cover open. To allow detecting intermediary states, we added an optional `status_register` attribute. It will enable you to write your command (e.g., to open a cover) into a coil, and read current cover status back through the register. Additionally, you can specify values for `state_open`, `state_opening`, `state_closed`, and `state_closing` attributes. These will be matched with the value read from the `status_register`.
|
||||
|
||||
If your cover uses holding register to send commands (defined by the `register` attribute), it can also read the intermediary states. To adjust which value represents what state, you can fine-tune the optional state attributes, like `state_open`. These optional state values are also used for specifying values written into the register. If you specify an optional status_register attribute, cover states will be read from status_register instead of the register used for sending commands.
|
||||
|
||||
To use Modbus covers in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
modbus:
|
||||
- name: hub1
|
||||
type: tcp
|
||||
host: IP_ADDRESS
|
||||
port: 502
|
||||
covers:
|
||||
- name: Door1
|
||||
device_class: door
|
||||
scan_interval: 1
|
||||
coil: 0
|
||||
- name: Door2
|
||||
device_class: door
|
||||
scan_interval: 1
|
||||
coil: 1
|
||||
status_register: 1
|
||||
- name: Door3
|
||||
slave: 2
|
||||
device_class: door
|
||||
scan_interval: 1
|
||||
register: 0
|
||||
state_open: 1
|
||||
state_closed: 0
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
covers:
|
||||
description: The array contains a list of all your Modbus covers.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
coil:
|
||||
description: Coil address; can be omitted if a register attribute is specified. Coil and register attributes are mutually exclusive, and you need to always specify one of them.
|
||||
required: true
|
||||
type: integer
|
||||
device_class:
|
||||
description: The [type/class](/integrations/cover/#device-class) of the cover to set the icon in the frontend.
|
||||
required: false
|
||||
type: device_class
|
||||
default: None
|
||||
name:
|
||||
description: Name of the switch.
|
||||
required: true
|
||||
type: string
|
||||
register:
|
||||
description: Holding register address; can be omitted if a coil attribute is specified. Coil and register attributes are mutually exclusive, and you need to always specify one of them.
|
||||
required: true
|
||||
type: integer
|
||||
scan_interval:
|
||||
description: Defines the update interval of the sensor in seconds.
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
slave:
|
||||
description: The number of the slave (can be omitted for tcp and udp Modbus).
|
||||
required: false
|
||||
default: 1
|
||||
type: integer
|
||||
state_open:
|
||||
description: A value in `status_register` or `register` representing an open cover. If your configuration uses an `register` attribute, this value will be also written into a holding register to open the cover.
|
||||
required: false
|
||||
default: 1
|
||||
type: integer
|
||||
state_closed:
|
||||
description: A value in `status_register` or `register` representing a closed cover. If your configuration uses an `register` attribute, this value will be also written into a holding register to close the cover.
|
||||
required: false
|
||||
default: 0
|
||||
type: integer
|
||||
state_opening:
|
||||
description: A value in `status_register` or `register` telling us that the cover is opening at the moment. Note that this state should be also supported on your connected Modbus cover. If it won't write this intermediary state into the register, this state won't be detected.
|
||||
required: false
|
||||
default: 2
|
||||
type: integer
|
||||
state_closing:
|
||||
description: A value in `status_register` or `register` telling us that the cover is closing at the moment. Note that this state should be also supported on your connected Modbus cover. If it won't write this intermediary state into the register, this state won't be detected.
|
||||
required: false
|
||||
default: 2
|
||||
type: integer
|
||||
status_register:
|
||||
description: An address of an register, from which all the cover states will be read. If you specified `register` attribute, and not `status_register` attribute, your main register will also be used as a status register.
|
||||
required: false
|
||||
type: integer
|
||||
status_register_type:
|
||||
description: Modbus register type (holding, input), default holding.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
#### Example: Modbus cover controlled by a coil
|
||||
|
||||
This example shows a configuration for a Modbus cover controlled using a coil. Intermediary states like opening/closing are not supported. The cover state is polled from Modbus every 10 seconds.
|
||||
|
||||
```yaml
|
||||
modbus:
|
||||
- name: hub1
|
||||
type: tcp
|
||||
host: IP_ADDRESS
|
||||
port: 502
|
||||
covers:
|
||||
- name: Door1
|
||||
slave: 1
|
||||
coil: 1
|
||||
device_class: door
|
||||
scan_interval: 10
|
||||
- name: Door2
|
||||
slave: 2
|
||||
coil: 2
|
||||
device_class: door
|
||||
scan_interval: 10
|
||||
```
|
||||
|
||||
#### Example: Modbus cover controlled by a coil, it's state is read from the register
|
||||
|
||||
This example shows a configuration for a Modbus cover controlled using a coil. Actual cover state is read from the `status_register`. We've also specified register values to match with the states open/opening/closed/closing. The cover state is polled from Modbus every 10 seconds.
|
||||
|
||||
```yaml
|
||||
modbus:
|
||||
- name: hub1
|
||||
type: tcp
|
||||
host: IP_ADDRESS
|
||||
port: 502
|
||||
covers:
|
||||
- name: Door1
|
||||
slave: 1
|
||||
device_class: door
|
||||
scan_interval: 10
|
||||
coil: 1
|
||||
status_register: 1
|
||||
status_register_type: input
|
||||
state_opening: 1
|
||||
state_open: 2
|
||||
state_closing: 3
|
||||
state_closed: 4
|
||||
```
|
||||
|
||||
#### Example: Modbus cover controlled by a holding register
|
||||
|
||||
This example shows a configuration for a Modbus cover controlled using a holding register, from which we also read current cover state. We've also specified register values to match with the states open/opening/closed/closing. The cover state is polled from Modbus every 10 seconds.
|
||||
|
||||
```yaml
|
||||
modbus:
|
||||
- name: hub1
|
||||
type: tcp
|
||||
host: IP_ADDRESS
|
||||
port: 502
|
||||
covers:
|
||||
- name: Door1
|
||||
slave: 1
|
||||
device_class: door
|
||||
scan_interval: 10
|
||||
register: 1
|
||||
state_opening: 1
|
||||
state_open: 2
|
||||
state_closing: 3
|
||||
state_closed: 4
|
||||
```
|
||||
|
||||
#### Example: Modbus cover controlled by a holding register, it's state is read from the status register
|
||||
|
||||
This example shows a configuration for a Modbus cover controlled using a holding register. However, cover state is read from a `status_register`. In this case, we've specified only values for `state_open` and `state_closed`, for the rest, default values are used. The cover state is polled from Modbus every 10 seconds.
|
||||
|
||||
```yaml
|
||||
modbus:
|
||||
- name: hub1
|
||||
type: tcp
|
||||
host: IP_ADDRESS
|
||||
port: 502
|
||||
|
||||
covers:
|
||||
- name: Door1
|
||||
slave: 1
|
||||
device_class: door
|
||||
scan_interval: 10
|
||||
register: 1
|
||||
status_register: 2
|
||||
register_type: holding
|
||||
state_open: 1
|
||||
state_closed: 0
|
||||
```
|
||||
|
||||
### Configuring platform sensor
|
||||
|
||||
The `modbus` cover platform allows you to control [Modbus](http://www.modbus.org/) covers (such as blinds, a roller shutter, or a garage door).
|
||||
|
||||
|
||||
The `modbus` sensor allows you to gather data from [Modbus](http://www.modbus.org/) registers.
|
||||
|
||||
To use your Modbus sensors in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
modbus:
|
||||
- name: hub1
|
||||
type: tcp
|
||||
host: IP_ADDRESS
|
||||
port: 502
|
||||
sensors:
|
||||
- name: Sensor1
|
||||
unit_of_measurement: °C
|
||||
slave: 1
|
||||
address: 100
|
||||
- name: Sensor2
|
||||
unit_of_measurement: mg
|
||||
slave: 1
|
||||
register: 110
|
||||
count: 2
|
||||
- name: Sensor3
|
||||
unit_of_measurement: °C
|
||||
slave: 1
|
||||
address: 120
|
||||
input_type: input
|
||||
data_type: float
|
||||
scale: 0.01
|
||||
offset: -273.16
|
||||
precision: 2
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
sensors:
|
||||
description: The array contains a list of all your Modbus sensors.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
address:
|
||||
description: Register number.
|
||||
required: true
|
||||
type: integer
|
||||
count:
|
||||
description: Number of registers to read.
|
||||
required: false
|
||||
type: integer
|
||||
default: 1
|
||||
data_type:
|
||||
description: Response representation (int, uint, float, string, custom). If float selected, value will be converted to IEEE 754 floating point format.
|
||||
required: false
|
||||
default: int
|
||||
type: string
|
||||
device_class:
|
||||
description: The [type/class](/integrations/sensor/#device-class) of the sensor to set the icon in the frontend.
|
||||
required: false
|
||||
type: device_class
|
||||
default: None
|
||||
input_type:
|
||||
description: Modbus register type (holding, input), default holding.
|
||||
required: false
|
||||
type: string
|
||||
name:
|
||||
description: Name of the sensor.
|
||||
required: true
|
||||
type: string
|
||||
offset:
|
||||
description: Final offset (output = scale * value + offset).
|
||||
required: false
|
||||
default: 0
|
||||
type: float
|
||||
precision:
|
||||
description: Number of valid decimals.
|
||||
required: false
|
||||
default: 0
|
||||
type: integer
|
||||
reverse_order:
|
||||
description: Reverse the order of registers when count >1.
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
scale:
|
||||
description: Scale factor (output = scale * value + offset).
|
||||
required: false
|
||||
default: 1
|
||||
type: float
|
||||
scan_interval:
|
||||
description: Defines the update interval of the sensor in seconds.
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
slave:
|
||||
description: The number of the slave (Optional for tcp and upd Modbus).
|
||||
required: true
|
||||
type: integer
|
||||
structure:
|
||||
description: "If `data_type` is custom specified a double-quoted Python struct is expected here, to format the string to unpack the value. See Python documentation for details. Example: `>i`."
|
||||
required: false
|
||||
type: string
|
||||
unit_of_measurement:
|
||||
description: Unit to attach to value.
|
||||
required: false
|
||||
type: integer
|
||||
{% endconfiguration %}
|
||||
|
||||
<div class='note'>
|
||||
|
||||
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.
|
||||
|
||||
</div>
|
||||
|
||||
#### Full example
|
||||
|
||||
Example a temperature sensor with a 10 seconds scan interval:
|
||||
|
||||
```yaml
|
||||
modbus:
|
||||
- name: hub1
|
||||
type: tcp
|
||||
host: IP_ADDRESS
|
||||
port: 502
|
||||
sensors:
|
||||
- name: Room_1
|
||||
slave: 10
|
||||
address: 0
|
||||
input_type: holding
|
||||
unit_of_measurement: °C
|
||||
count: 1
|
||||
scale: 0.1
|
||||
offset: 0
|
||||
precision: 1
|
||||
data_type: integer
|
||||
```
|
||||
|
||||
### Configuring platform switch
|
||||
|
||||
The `modbus` switch platform allows you to control [Modbus](http://www.modbus.org/) coils or registers.
|
||||
|
||||
To use your Modbus switches in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
modbus:
|
||||
- name: hub1
|
||||
type: tcp
|
||||
host: IP_ADDRESS
|
||||
port: 502
|
||||
switches:
|
||||
- name: Switch1
|
||||
address: 13
|
||||
input_type: coil
|
||||
- name: Switch2
|
||||
slave: 2
|
||||
address: 14
|
||||
input_type: coil
|
||||
- name: Register1
|
||||
address: 11
|
||||
command_on: 1
|
||||
command_off: 0
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
switches:
|
||||
description: The array contains a list of all your Modbus switches.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
address:
|
||||
description: Coil number or register
|
||||
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
|
||||
input_type:
|
||||
description: type of adddress (holding/discrete/coil)
|
||||
required: false
|
||||
default: holding
|
||||
type: integer
|
||||
name:
|
||||
description: Name of the switch.
|
||||
required: true
|
||||
type: string
|
||||
scan_interval:
|
||||
description: Defines the update interval of the sensor in seconds.
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
slave:
|
||||
description: The number of the slave (can be omitted for tcp and udp Modbus).
|
||||
required: true
|
||||
type: integer
|
||||
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
|
||||
verify_register:
|
||||
description: Register to readback.
|
||||
required: false
|
||||
default: same as register
|
||||
type: string
|
||||
verify_state:
|
||||
description: Define if is possible to readback the status of the switch.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
{% endconfiguration %}
|
||||
|
||||
#### Full example
|
||||
|
||||
Example switches, for which the state is polled from Modbus every 10 seconds.
|
||||
|
||||
```yaml
|
||||
modbus:
|
||||
- name: hub1
|
||||
type: tcp
|
||||
host: IP_ADDRESS
|
||||
port: 502
|
||||
switches:
|
||||
- name: Switch1
|
||||
slave: 1
|
||||
address: 13
|
||||
input_type: coil
|
||||
- name: Switch2
|
||||
slave: 2
|
||||
address: 14
|
||||
```
|
||||
|
||||
#### Multiple connections
|
||||
|
||||
Multiple connections are possible, add something like the following to your `configuration.yaml` file:
|
||||
|
||||
|
||||
@ -1,145 +0,0 @@
|
||||
---
|
||||
title: Modbus Sensor
|
||||
description: "Instructions on how to integrate Modbus sensors into Home Assistant."
|
||||
ha_category:
|
||||
- Sensor
|
||||
ha_release: pre 0.7
|
||||
ha_iot_class: Local Push
|
||||
ha_domain: modbus
|
||||
---
|
||||
|
||||
The `modbus` sensor allows you to gather data from [Modbus](http://www.modbus.org/) registers.
|
||||
|
||||
## Configuration
|
||||
|
||||
To use your Modbus sensors in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# 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 %}
|
||||
registers:
|
||||
description: The array contains a list of relevant registers to read from.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
name:
|
||||
description: Name of the sensor.
|
||||
required: true
|
||||
type: string
|
||||
hub:
|
||||
description: The name of the hub.
|
||||
required: false
|
||||
default: modbus_hub
|
||||
type: string
|
||||
slave:
|
||||
description: The number of the slave (Optional for tcp and upd Modbus).
|
||||
required: true
|
||||
type: integer
|
||||
register:
|
||||
description: Register number.
|
||||
required: true
|
||||
type: integer
|
||||
register_type:
|
||||
description: Modbus register type (holding, input), default holding.
|
||||
required: false
|
||||
type: string
|
||||
unit_of_measurement:
|
||||
description: Unit to attach to value.
|
||||
required: false
|
||||
type: integer
|
||||
device_class:
|
||||
description: The [type/class](/integrations/sensor/#device-class) of the sensor to set the icon in the frontend.
|
||||
required: false
|
||||
type: device_class
|
||||
default: None
|
||||
count:
|
||||
description: Number of registers to read.
|
||||
required: false
|
||||
type: integer
|
||||
default: 1
|
||||
reverse_order:
|
||||
description: Reverse the order of registers when count >1.
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
scale:
|
||||
description: Scale factor (output = scale * value + offset).
|
||||
required: false
|
||||
default: 1
|
||||
type: float
|
||||
offset:
|
||||
description: Final offset (output = scale * value + offset).
|
||||
required: false
|
||||
default: 0
|
||||
type: float
|
||||
precision:
|
||||
description: Number of valid decimals.
|
||||
required: false
|
||||
default: 0
|
||||
type: integer
|
||||
data_type:
|
||||
description: Response representation (int, uint, float, string, custom). If float selected, value will be converted to IEEE 754 floating point format.
|
||||
required: false
|
||||
default: int
|
||||
type: string
|
||||
structure:
|
||||
description: "If `data_type` is custom specified a double-quoted Python struct is expected here, to format the string to unpack the value. See Python documentation for details. Example: `>i`."
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
It's possible to change the default 30 seconds scan interval for the sensor updates as shown in the [Platform options](/docs/configuration/platform_options/#scan-interval) documentation.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
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.
|
||||
|
||||
</div>
|
||||
|
||||
### Full example
|
||||
|
||||
Example a temperature sensor with a 10 seconds scan interval:
|
||||
|
||||
```yaml
|
||||
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
|
||||
```
|
||||
@ -1,137 +0,0 @@
|
||||
---
|
||||
title: "Modbus Switch"
|
||||
description: "Instructions on how to integrate Modbus switches into Home Assistant."
|
||||
ha_category:
|
||||
- Switch
|
||||
ha_release: pre 0.7
|
||||
ha_iot_class: Local Push
|
||||
ha_domain: modbus
|
||||
---
|
||||
|
||||
The `modbus` switch platform allows you to control [Modbus](http://www.modbus.org/) coils or registers.
|
||||
|
||||
## Configuration
|
||||
|
||||
To use your Modbus switches in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
platform: modbus
|
||||
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
|
||||
registers:
|
||||
description: A list of relevant registers to read from/write to.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
hub:
|
||||
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 %}
|
||||
|
||||
It's possible to change the default 30 seconds scan interval for the switch state updates as shown in the [Platform options](/docs/configuration/platform_options/#scan-interval) documentation.
|
||||
|
||||
### Full example
|
||||
|
||||
Example switches, for which the state is polled from Modbus every 10 seconds.
|
||||
|
||||
```yaml
|
||||
switch:
|
||||
platform: modbus
|
||||
scan_interval: 10
|
||||
coils:
|
||||
- name: Switch1
|
||||
hub: hub1
|
||||
slave: 1
|
||||
coil: 13
|
||||
- name: Switch2
|
||||
hub: hub1
|
||||
slave: 2
|
||||
coil: 14
|
||||
```
|
||||
@ -1073,14 +1073,19 @@
|
||||
/components/xiaomi /integrations/xiaomi_aqara
|
||||
/integrations/air_quality.xiaomi_miio /integrations/xiaomi_miio
|
||||
/integrations/alarm_control_panel.xiaomi_miio /integrations/xiaomi_miio
|
||||
/integrations/binary_sensor.modbus /integrations/modbus
|
||||
/integrations/climate.modbus /integrations/modbus
|
||||
/integrations/cover.modbus /integrations/modbus
|
||||
/integrations/fan.xiaomi_miio /integrations/xiaomi_miio
|
||||
/integrations/light.xiaomi_miio /integrations/xiaomi_miio
|
||||
/integrations/lovelace /lovelace
|
||||
/integrations/remote.xiaomi_miio /integrations/xiaomi_miio
|
||||
/integrations/sensor.websocket_api /integrations/websocket_api
|
||||
/integrations/sensor.modbus /integrations/modbus
|
||||
/integrations/sensor.xiaomi_miio /integrations/xiaomi_miio
|
||||
/integrations/switch.modbus /integrations/modbus
|
||||
/integrations/switch.xiaomi_miio /integrations/xiaomi_miio
|
||||
/integrations/vacuum.xiaomi_miio /integrations/xiaomi_miio
|
||||
/integrations/lovelace /lovelace
|
||||
|
||||
# Renaming components to integrations
|
||||
/components /integrations
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user