Skip to content

Commit 5f787b2

Browse files
committed
make changes
1 parent a2a157a commit 5f787b2

File tree

9 files changed

+871
-1910
lines changed

9 files changed

+871
-1910
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,17 @@ Within the `fields` member of a Message object, there is a list of NetField obje
8080
- `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.
8181
- To embed live Point values in `name`, include point indices (from 1) in the name. Ex. `"Hello/{1}/World/{2}/Status"`
8282
- `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
8385
- `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**
8486

8587

8688
#### Point
8789

8890
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:
8991
- `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
9094
- `parse` (optional), boolean representing whether or not this field should be parsed (if `false`, it is literally skipped). Best used for byte-alignment padding
9195
- `signed` (optional), boolean representing whether or not the number is signed in two's complement form (`false` by default)
9296
- `endianness` (optional), string representing the byte endianness of the bits being read, either `"big"` or `"little"` (`"big"` by default)

0 commit comments

Comments
 (0)