greghaynes / afproto Goto Github PK

Hi greghaynes,

Convention in ESCAPE and DELIMITER characters are not consistent in READMD and source code.

READMD.md
ESCAPE: 0x7D
DELIMITER: 0x7E

Source Code
ESCAPE: 0x7E
DELIMITER: 0x7D

This may confuse new readers.

Thanks,
Zihan

Hi greg,

Just bringing to your attention that the Wiki home page seems to contain outdated and contradictory information.

On the README.md (last edited three years ago):

A depiction of a frame:

| Start Byte | Escaped Data | Escaped CRC16 | End Byte |

(I read through the source code and can confirm this is correct)

Whereas on the wiki (last edited 2011):

Each packet is in the following format

| Header Byte | Length (1 byte) | CRC (1 byte) | Escaped Message (N bytes) | End Byte |

For large messages there is a special case where length is set to 0x00.

| Header Byte | 0x00 (1 byte) | Length (2 byte) | CRC (1 byte) | Escaped Message (N bytes) | End Byte |

Which seems to not currently be correct

Thanks!

Eli