@@ -12,7 +12,7 @@ Please read the [master README.md](https://git.soton.ac.uk/SUFST/susft-firmware/
...
@@ -12,7 +12,7 @@ Please read the [master README.md](https://git.soton.ac.uk/SUFST/susft-firmware/
***/README.md** - This file.
***/README.md** - This file.
## Documentation
## Documentation
Common consists of the following utilities:
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.
***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.
***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.
***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.
