Off-by-one in header structure description in readme

brannondorsey / chattervox

📡 An AX.25 packet radio chat protocol with support for digital signatures and binary compression. Like IRC over radio waves.

Other

748 stars 36 forks source link

Off-by-one in header structure description in readme #8

Closed petiepooo closed 5 years ago

petiepooo commented 5 years ago

Currently, you show the 2-byte magic number at header offset 0x0000 (zero-based, obviously), but the version byte at offset 0x0003, and the flags bitfield at offset 0x0004. What is at offset 0x0002 is not stated. Reviewing the code seems to indicate that everything other than the magic number should be reduced by one. Perhaps you started using 1-based counting, changed to 0-based to match the code, but didn't finish your updates?

brannondorsey commented 5 years ago

You are exactly right! Thanks for the catch and opening the issue.