Skip to content

Commit 8ac4a56

Browse files
authored
add protocol override feat
1 parent 56b8c6b commit 8ac4a56

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

documentation/usage/protocols.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
## Overriding protocols
2+
Protocols CSVs can be overriden, so that specific entries can be modified.
3+
Protocols CSV overrides can be created naming them with name.override.csv
4+
5+
For example, creating a file called: v0.14.input_registry_map.override.csv
6+
will allow the v0.14 protocol to be modified while preseving the main csv.
7+
8+
"documented name" is used as the primary key. the "register" is a secondary key.
9+
10+
only non-empty values will overwrite; not all columns need to be specified.
11+
12+
| documented name | data type |
13+
| ------------- | ------------- |
14+
| product id | ASCII |
15+
16+
if both the "documented name" and "register" are unqiue, the row will be treated as a new entry.
17+
118
## Custom / Editing Protocols
219
Custom protocols can be created by naming them with name.custom. this will ensure that they do not get overwritten when updating.
320

@@ -45,4 +62,4 @@ protocol_version = sigineer_v0.11
4562
```
4663
protocol_version = pace_bms_v1.3
4764
```
48-
[Devices\SOK to MQTT](https://github.com/HotNoob/PythonProtocolGateway/wiki/Devices%5CSOK-to-MQTT)
65+
[Devices\SOK to MQTT](https://github.com/HotNoob/PythonProtocolGateway/wiki/Devices%5CSOK-to-MQTT)

0 commit comments

Comments
 (0)