Project Structure: Firmware Source Code

[amberstarlight]

Currently we have a loose structure in our firmware files, including header files for drivers inside of src/drivers. Is this a good way to structure the project?

As part of this card, we should come up with a solid project structure that gives us room to grow and add more drivers and features to the project without confusion. We should consider the following hypotheticals, as well as everything already supported including matrix scanning, USB communication:

• we want to support multiple MCU architectures such as STM32, AVR32, SAMD21, NRF52, etc.
• we want to support RGB LEDs, for example WS2812 (or compatibles).
• we want to support an OLED screen (using, for example, an SSD1306 IC).
• we want to support multiple IO expanders.
• we want to support Bluetooth as a communication protocol.

Outcomes:

• a new folder structure for header files and source files
• a summary of choices made and how this supports the requirements, and explanations of compromises or changes

Blocked by #7