cmcqueen / cobs-c Goto Github PK

Originally reported by: Craig McQueen (Bitbucket: cmcqueen1975, GitHub: Unknown)

Provide example source code that demonstrates basic usage of the encode and decode functions.

C unit tests would also demonstrate usage, however a separate example would be more accessible.

• Bitbucket: https://bitbucket.org/cmcqueen1975/cobs-c/issue/4

There seems to be an error in the encoder or decoder for C implementation of the COBSR algorithm.
I modified the test code in tests-c/main.c to check whether the decoded data resulted in the same as the original data. Sometimes it seems the decoded result is one byte longer. In the other cases the last byte is one higher than the original last byte.
Take the example data: 00 00, which when encoded and decoded results in 00 00 02. And 31 32 33 34 35 results in 31 32 33 34 36

Originally reported by: Yaroslav Boris (Bitbucket: Boris_Yaroslav, GitHub: Unknown)

How about to realize the version without using buffers?
This will be useful for the controllers, who do not have a lot of memory.

For example: I received byte - passed to the function, the function may call another function, which sends the decoded byte.

• Bitbucket: https://bitbucket.org/cmcqueen1975/cobs-c/issue/5

Hi. I have used this cobs file in C programming. But I faced conversion errors.

Please let me know how to fix this. Thank you.

Originally reported by: Craig McQueen (Bitbucket: cmcqueen1975, GitHub: Unknown)

Add wiki documentation of the COBS encoding and decoding functions.

• Bitbucket: https://bitbucket.org/cmcqueen1975/cobs-c/issue/3

For all the COBS and COBS/R encode and decode functions, change input and output buffer pointers to be void * instead of uint8_t *.

This would be similar to functions such as memcpy() which deal with void *.

Whoops, disregard this, it's late, I missed something in the paper.

Originally reported by: Craig McQueen (Bitbucket: cmcqueen1975, GitHub: Unknown)

There are unit tests, but written in Python. This is good, but doesn't allow for unit tests to be run on a platform that doesn't support Python--e.g. a small embedded platform.

It would be good to provide some unit tests in C with reasonably good coverage.

• Bitbucket: https://bitbucket.org/cmcqueen1975/cobs-c/issue/1

Originally reported by: Craig McQueen (Bitbucket: cmcqueen1975, GitHub: @cmcqueen)

Examine whether the code supports in-place encoding and/or decoding. That is, output is written to the input buffer, overwriting the original input. It could be useful to save RAM in small embedded systems.

• My guess is that in-place decoding should work as-is
• In-place encoding should work I think, however the input would have to be offset from the start of the output buffer by a certain number of bytes. In the code, see COBS_ENCODE_SRC_OFFSET() and COBSR_ENCODE_SRC_OFFSET() which calculate the required offset, for a given data size.

Once this has been checked:

• Add some unit tests to check this.
• Add documentation to say whether/how it works.

• Bitbucket: https://bitbucket.org/cmcqueen1975/cobs-c/issue/2