https://github.com/shonfeder/ocobs

COBS (Consistent Overhead Byte Stuffing) in OCaml
https://github.com/shonfeder/ocobs

Last synced: about 1 month ago
JSON representation

COBS (Consistent Overhead Byte Stuffing) in OCaml

• Host: GitHub
• URL: https://github.com/shonfeder/ocobs
• Owner: shonfeder
• License: mit
• Created: 2018-10-23T21:17:26.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-06-02T02:57:42.000Z (7 months ago)
• Last Synced: 2024-06-02T03:52:26.177Z (7 months ago)
• Language: OCaml
• Size: 15.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# OCobs

Consistent Overhead Byte Stuffing for OCaml

> Consistent Overhead Byte Stuffing (COBS) is a framing method for binary

> streams and is useful any time you need to send binary datagrams over a

> stream interface (TCP socket / Serial Port / Etc). In a nutshell, COBS works

> by stripping all `delimiter` bytes (usually `0x00`) out of a binary packet

> and places a single `delimiter` at the end, allowing recipients to simply

> read from the stream until a `delimiter` is encountered (effectively

> allowing a 'readline' like interface for binary data). The encoding/decoding

> are very fast and encoding is guaranteed to only add 1 + max(1, (len/255))

> overhead bytes (making decoding extremely deterministic). For an in-depth

> breakdown of the algorithm, please see

> https://en.wikipedia.org/wiki/Consistent_Overhead_Byte_Stuffing

This project was inspired by [nim_cobs](https://github.com/keyme/nim_cobs),

whence the above description is copied.