MightyPork
/
TinyFrame
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

remove lies from readme

Browse Source
pull/14/head
Ondřej Hruška 6 years ago
parent 148b8a0fe6
commit 1e6cdf22f0
Signed by: MightyPork
GPG Key ID: 2C5FD5035250423D
1 changed files with 4 additions and 4 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 8
      README.md

8
README.md
Unescape View File

@ -42,10 +42,10 @@ length field if your payloads are 20 bytes long, using a 1-byte field (`uint8_t`
3 bytes. This may be significant if you need high throughput. 3 bytes. This may be significant if you need high throughput.
``` ```
,-----+-----+-----+------+------------+- - - -+-------------, ,-----+-----+-----+------+------------+- - - -+-------------,
| SOF | ID | LEN | TYPE | HEAD_CKSUM | DATA | DATA_CKSUM | | SOF | ID | LEN | TYPE | HEAD_CKSUM | DATA | DATA_CKSUM |
| 0-1 | 1-4 | 1-4 | 1-4 | 0-4 | ... | 0-4 | <- size (bytes) | 0-1 | 1-4 | 1-4 | 1-4 | 0-4 | ... | 0-4 | <- size (bytes)
'-----+-----+-----+------+------------+- - - -+-------------' '-----+-----+-----+------+------------+- - - -+-------------'
SOF ......... start of frame, usually 0x01 (optional, configurable) SOF ......... start of frame, usually 0x01 (optional, configurable)
ID ......... the frame ID (MSb is the peer bit) ID ......... the frame ID (MSb is the peer bit)
@ -54,7 +54,7 @@ TYPE ........ message type (used to run Type Listeners, pick any values you like
HEAD_CKSUM .. header checksum HEAD_CKSUM .. header checksum
DATA ........ LEN bytes of data (can be 0, in which case DATA_CKSUM is omitted as well) DATA ........ LEN bytes of data (can be 0, in which case DATA_CKSUM is omitted as well)
DATA_CKSUM .. checksum, implemented as XOR of all preceding bytes in the message DATA_CKSUM .. data checksum
``` ```
## Usage Hints ## Usage Hints

Write Preview
Loading…
Cancel
Save