AMiRo-OS

  2  Folder structure

2 - FOLDER STRUCTURE

--------------------

At its root, the AMiRo-Apps projects has six folders to distiquish between the

most fundamental parts:

.

├── apps

│     This folder includes individual applications, which can used by

│     configigurations. Apps will usually be implemented as nodes for the

│     middleware and provide acording interfaces via some message type(s).

├── configurations

│     Each configuration combines multiple apps and distributes them among any

│     supported modules. Furthermore, configurations may modify parameters for

│     each module individually. Finally, each configuration should come with a

│     makefile, so a user can just use this to build and flash the whole setup.

│     For better understanding, have a look at this example:

│       - module A: using apps 1, 2 and 3 with parameters X and Y.

│       - module B: using apps 1 and 4 with parameter X.

│       - module C: using apps 1, 5, 6 and 7 with parameters X and Z.

│       - Makefile: set and build everything.

│     Note that each configuration needs to explicitely support a module and

│     that there can never be an implicit default configuration.

├── messagetypes

│     Apps shoud take advantage of the middleware and thus implement nodes,

│     which communicate via messages. Such messages may have payloads of

│     arbitrary types, which can be defined in this folder.

├── middleware

│     This folder contains the µRtWare submodule and interface files.

├── os

│     This folder contains the AMiRo-OS submodule and interface files.

└── tools

      Usable tools can be found in this dirctory.