search

MightyPork / TinyFrame

A simple library for building and parsing data frames for serial interfaces (like UART / RS232)
MIT License
344 stars 111 forks source link

Initial impl of escaped SOF #19

Open mon opened 5 years ago

mon commented 5 years ago

Related to #16

I'm not entirely happy with this impl - while it's simple enough, it completely removes buffering on TF_WriteImpl. I could improve this to fill the buffer with escaped bytes, or split buffer writes on each escaped char, but it's a bit more code refactoring.

I've tested this internally and it works, and when disabled does not affect old code. Thoughts on the 1-byte-at-a-time aspect? Not sure if it's mergeable.

I also have an impl of this for PonyFrame, if you like. It's much simpler, at least.

MightyPork commented 5 years ago

Need to read it more closely, but at first glance it looks good. I'll try to write some actual unit tests so it can be properly tested.

The one-byte-at-a-time is not great, could you try rewriting it so it sends contiguous chunks in one call to TF_WriteImpl? Keep track of the last plain character and then send the "buffered" plain portion before escaping the offending char.. and don't forget to send the leftover at the end of the loop.

iceberg1369 commented 4 years ago

This is a good idea to have an escape char . I have seen tf lost the sync with the stream becsuse of sof byte in the middle. So this is a must have.