This repository contains the following resources that are referenced in the The Embedded Project Cookbook: A Step-By-Step Guide for Microcontroller Projects:
- Source code for the GM6000 example application
- Source code for automated tests
- Installation and configuration instructions for framework components and tools
- Requirements tracing spreadsheets
- Githup Projects example for use as lighweight planning and tracking tool
- NQBP2 build tool
- 3rd party tools
- Sample Doxygen Output
You can freely use any of the material in this Repository under the terms of the BSD-3 license.
The best and most thorough documentation for the source code and tools in this repository is the book The Embedded Project Cookbook. However, to limit the length of the book, most of the project and tool configuration documentation was move to the Wiki page for this project. That is where you will find the detailed instructions on how to build the framework and software described in the book.
The following changes have be made to the repository since the book was original published. You can use the DEVELOP-1000092 tag to access the snapshot of when the book was published.
- Migrated the Catch2 framework from v2.x to v3.x. The change impacted how the unit test projects are build since Catch2 v3.x is static library based (vs v2.x which was a single header file).
- Maintenance updates to the CPL C++ framework (aka newer version of the colony.core repo)
- The update includes support for the littlefs file system
The directories in this repository are laid out as follows:
| Directory | Description |
|---|---|
| arduino/ | External colony.aruduino repo (using Outcast) |
| docs/GM6000 Example Docs/ | Contains example docments for • requirements, architecture, and design documents • sample spreadsheets for requirements tracing • tools for generating unique identifiers |
| docs/ | Contains the Doxygen output for GM6000 |
| pkg.info/ | Stores the Outcast 'mapping' information |
| pkgs.overlaid/ | Additional Outcast information (for 'overlay' repos) |
| projects/ | Application build directory tree |
| scripts/ | Collection of utility scripts (e.g. common RATT scripts) |
| src/ | The principal source code tree |
| tests/ | Unit test build directory tree |
| top/ | Contains scripts related to the build/CI environments |
| xsrc/ | External code/repos (using Outcast) |
