Common
This folder holds common code utilities that are used throughout the firmwares. This file should be updated with information detailing the latest version of the Common utilities.
Please read the master README.md first.
Folder Contents
- /include - Common header files.
- /src - Common source files.
- /CHANGELOG.md - Details of versions changes.
- /README.md - This file.
Documentation
Common consists of the following utilities:
- Buffer - A circular buffer which allows for standardized buffering of data with functionalities such as pop and push, which appends and removes a set amount of bytes from the buffers memory.
- CanManager - A top-level CAN interface that interacts with the CAN-BUS Shield Arduino library and interrupt lines.
- EventManager - A utility that allows for easy setup of events such as hardware timers and external interrupts, along with interacting with these events in an event-based system to ensure the programs main flow handles interrupts and not ISRs.
- Utils - Currently only overrides the default assert() failure functionality to write failing asserts over Serial for easier debugging.
See the header files for the corresponding utility within /include for function calls and further information.
Contributions
- Nathan - nrs1g15@soton.ac.uk
Version History
Please see the Common CHANGELOG for further details on changes.
- v1.0 - Initial release.