You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -80,13 +80,17 @@ Within the `fields` member of a Message object, there is a list of NetField obje
80
80
-`name`, string of the message topic name, e.g. `The/Topic/Name`. Going 3 levels of slashes is usually preferred, don't put trailing slashes.
81
81
- To embed live Point values in `name`, include point indices (from 1) in the name. Ex. `"Hello/{1}/World/{2}/Status"`
82
82
-`unit`, string of the unit of the data, e.g. `mph`
83
+
-`doc`, a short string with a human readable info about the topic
84
+
-`desc` (optional), longer warnings and notes about a topic
83
85
-`values`, a list of correlated Points to be sent with the Field. **Note that Points are indexed by 1, and out-of-bounds indices will cause build failure**
84
86
85
87
86
88
#### Point
87
89
88
90
Within the `points` member of a NetField object, there is a list of Point objects. A Point object represents one set of bits in a CAN message. This separates CAN decoding logic from MQTT encoding information. Each Point has the following members:
89
91
-`size`, an integer representing the size to be read in bits
92
+
-`name` (optional), a one word name for the datapoint, used in generation
93
+
-`c_type` (optional), the c type for the datapoint, used in generation
90
94
-`parse` (optional), boolean representing whether or not this field should be parsed (if `false`, it is literally skipped). Best used for byte-alignment padding
91
95
-`signed` (optional), boolean representing whether or not the number is signed in two's complement form (`false` by default)
92
96
-`endianness` (optional), string representing the byte endianness of the bits being read, either `"big"` or `"little"` (`"big"` by default)
0 commit comments