AMiRo-OS

AMiRo-LLD is a compilation of low-level hardware drivers, originally developed

for the Autonomous Mini Robot (AMiRo) [1]. It provides a modular design, so that

functions allow for bidirectional comunication with an operating system. On the

one hand drivers access according hardware interfaces via defined interface

functions (which need to be implemented by the operating system), on the other

*   `./`  

    The project root directory contains this file, a `license.html` file as well

    *   `./docs/`  

        UML graphs (using PlantUML; see <https://plantuml.com> for further

        information) visualize the structure of the AMiRo-LLD project. Doxygen

        (e.g. `v1/`, `v2/`, etc.). By convention, the root directory of a driver

        is named by the exact product name of the according hardware, or the

        product familiy, if the driver is compatible with all parts. Each driver

    *   `./templates/`  

        required information for an implementation.

When adding a new device to the project, the very first step is to create the

according folder in the `./drivers/` directory. For this guide, we will add the

`./drivers/DEVICE1234/` and `./drivers/DEVICE1234/v1/`. In case there already

exists a driver implementation for this device, but you want to implement

another version, the version subfolder must be named accordingly (e.g.

Some drivers, however, may feature multiple header and/or source files or even

come with additional subfolders. In any case, all those required folders,

It is highly recommended that files in the driver root directory (i.e.

`./drivers/DEVICE1234/v1/`) use the prefix `alld_` in their names. This not only

helps to achieve an easy to understand file structure, but also prevents

**Summing up, you have to**

1.  create device and version folders.

3.  add header and source files as well as subfulders, implementing the driver.