Need for better documentation

[tochinet]

Hi Alexei,
I like your idea of function queues a lot, especially for 8-bit AVR architectures like Nano etc. If you want, I'd like to improve the visibility of your library by helping to make it easy for users to adopt it.
Fact is that when you look at README or the .h file, it is not immediately clear what exactly are the functions, the queues, etc.
Maybe enabling the Wiki in the repo would be a good way to open a space for discussing that.

For example, looking at the code, I see you define fQ, fQP, del_fQ, del_fQP with almost the same code. Maybe you could explain the difference in the README.md file ? Stating something like "the single file antirtos.h contains the definition of four variants of function queues, with increasing features : the fQ class is a queue of functions without parameters. fQP adds a parameter for the function, del_fQ adds the capability to delay the execution of the functions, and del_fQP provides both features."

Actually, did you consider merging the code into a single class ? On memory-constrained devices like AVR-based Arduinos, mixing any of those is likely to require several kBytes of memory for almost duplicate code...

Christophe.

[WeSpeakEnglish]

Hello Christophe,

Thank you for your interest and for submitting the pull request!

Regarding your suggestion about a Wiki, I agree that it might be a good idea, and I’ll keep it in mind for future updates.

As for the class architecture, the current design as for now ensures that classes remain fully independent of one another. This way, you can easily extract and use only the ones you need for your project. Maybe in future it will be changed.

ANTIRTOS does have a very low footprint—just a few tens of bytes depending on the architecture—it’s better to try it yourself to see how lightweight it truly is in terms of flash/ROM usage. So the normal profile will be far far below any single kB spent for the ANTIRTOS on FLASH.

Most users will likely only need one type of queue, possibly two. If they choose the simplest options, they can also save on RAM usage.

Aleksei.