Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-12-27 17:37:45 +01:00
Code Issues Projects Releases Wiki Activity

Switch modbus controller register_type (#1883)

Browse Source 
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
This commit is contained in:
Joeri Colman 2022-02-10 23:09:03 +01:00 committed by GitHub
parent 171393e125
commit dad1275c8a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
components/switch/modbus_controller.rst
View File

@ -13,7 +13,7 @@ Configuration variables:
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **name** (**Required**, string): The name of the sensor. - **name** (**Required**, string): The name of the sensor.
- **modbus_functioncode** (**Required**): type of the modbus register. - **register_type** (**Required**): type of the modbus register.
- **address**: (**Required**, int): start address of the first register in a range - **address**: (**Required**, int): start address of the first register in a range
- **offset**: (*Optional*, int): not required in most cases - **offset**: (*Optional*, int): not required in most cases
offset from start address in bytes. If more than one register is read a modbus read registers command this value is used to find the start of this datapoint relative to start address. The component calculates the size of the range based on offset and size of the value type offset from start address in bytes. If more than one register is read a modbus read registers command this value is used to find the start of this datapoint relative to start address. The component calculates the size of the range based on offset and size of the value type
@ -41,7 +41,8 @@ Configuration variables:
Possible return values for the lambda: Possible return values for the lambda:
- ``return <true / false>;`` the new value for the sensor. - ``return <true / false>;`` the new value for the sensor.
- ``return <anything>; and fill payload with data`` if the payload is added from the lambda then these bytes will be sent - ``return <anything>; and fill payload with data`` if the payload is added from the lambda then these bytes will be sent.
- ``return {};`` in the case the lambda handles the sending of the value itself.
**Example** **Example**
@ -63,6 +64,7 @@ Possible return values for the lambda:
payload.push_back(0x6); // low byte address of the coil payload.push_back(0x6); // low byte address of the coil
payload.push_back(0xFF); // ON = 0xFF00 OFF=0000 payload.push_back(0xFF); // ON = 0xFF00 OFF=0000
payload.push_back(0x00); payload.push_back(0x00);
return true;