Skip to content

Commit be2c3ea

Browse files
committed
document _LE _BE data type suffixes
1 parent 8d3e784 commit be2c3ea

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

documentation/usage/creating_and_editing_protocols.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,21 @@ Defines the expected data type for the register / map entry
3535
| 32BIT_FLAGS | four bytes split into 32 bit flags. see 16BIT_FLAGS
3636
| #bit | A unsigned number comprised of # of bits. for example, 3bit is a 3 bit positive number (0 to 7).
3737
| ASCII | ascii text representation of data.
38-
| ASCII.# | for protocols with an undefined "registry" size, the length can be specified. ie: ASCII.7 will return a 7 character long string.
38+
| ASCII.# | for protocols with an undefined "registry" size, the length can be specified. ie: ASCII.7 will return a 7 character long string.
39+
| HEX | hex text representation of data.
40+
41+
### data type byte order
42+
in the case of protocols with inconsistent byte order implementations.
43+
44+
#### big endian
45+
a suffix of "_BE" can be added to a data type to ensure the entry is read with a big endian byte order
46+
ie: ASCII_BE
47+
48+
#### little endian
49+
a suffix of "_LE" can be added to a data type to ensure the entry is read with a little endian byte order
50+
ie: ASCII_LE
51+
52+
3953

4054
### register
4155
Register defines the location or for other protocols the main command / id.

0 commit comments

Comments
 (0)