Skip to content

Commit 0c39239

Browse files
authored
struggling with formatting ...
1 parent ad2cce6 commit 0c39239

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

docs/developer_guide.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,10 @@ The meaning of the parameters of a button autorepeat value_function is:
107107
- descr: the entity description object of the button
108108
- datadict: the dictionary with all the known entity values
109109

110-
In its current form, the function should return a dictionary containing following items:
110+
In its current form, the function should return a dictionary with following structure:
111+
`{'action': ... , 'register': ..., 'data': ...}` where
112+
113+
111114
- `action`: the modbus type of write to be executed: currently only MODBUS_WRITE_MULTI is suppored, but the other writes can be easily added later.
112115
- `register` (optional): if not specified, the register address for the autorepeat button will be used
113116
- `data`: a list of tuples `[ (entity_key, value,), ....]` that represents the payload of a write_multiple command that starts at the modbus register addres. Instead of the entity_key_name, a register type can also be specified like `REGISTER_U16`. The payload should not contain the button's entity itself, just the data that needs to be added in the write_multiple scenario. In the future, the `data` structure may be modified to allow other types of writes.

0 commit comments

Comments
 (0)