Skip to content

Latest commit

 

History

History
59 lines (51 loc) · 3.48 KB

README.md

File metadata and controls

59 lines (51 loc) · 3.48 KB
Raw

arduino-skeleton

Build Status Coverity Scan Build Status Release License

This is the first embarkment of my learning experience & side projects. Let's see how far I could go :) Skeleton framework for Arduino with/without RTOS, uses avr gcc/ g++ Currently works with Unix system, compatible with Arduino framework (setup/loop) using sudar's repo

  • Note:
    1. This repo now supports Arduino IDE, only need to set IDE_SUPPORT to true from skeleton.mk
    2. Even though it supports C++ project, I will try to develop drivers/low level in C
    3. When in doubt, run make help in project directory for variable config

Directory Structure

    +---test/                               - all component testers go here, test code uses no os
    +---submodules/                         - remote dependency
    |       +---ChibiOS/                    -
    |       +---Arduino-Makefile/           - 
    +---c-project/                          - skeleton for C based projects
    |       +---with-os/                    -
    |       +---without-os/                 -
    +---cpp-project/                        - skeleton for C++ based projects
    |       +---with-os/                    -
    |       +---without-os/                 -
    |       +---with-ide/                   -
    +---doc                                 - documentations about arduino and modules
    +---common/                             - includes common mkfile (skeleton.mk) for all projects
    |       +---utils/                      - common protocols such as soft serial, i2c, debugging
    |       +---makefiles/                  - specific mk files for individual project options

UnitTest framework (Software)

    This repo supports cxxtest framework, run make check will invoke testgen and run the test binary
    Put all test headers in test directory of project directory
    Name test headers as *Test.h 
    See c-project/without-os/GPS-breakout-board for example
    
    This repo also supports googletest framework. Similarly run make check
    Put all test headers in test directory of project directory
   	Name test files as *gtest.cpp
   	See test/gtest for example

Usage

    go to c*-project/with*-os/ directory and use its makefile
    go to test/ to checkout individual module test code, all code here must be in C except cxxtest headers
    note: always include common/skeleton.mk inside project makefile, then run make help to view variables

Completed projects

    +--c-project/without-os/GPS-breakout-board      - gps tracker app that shows parsed distance/angle to lcd and serial port
    +--c-project/without-os/i2c-console             - i2c console app for arduino, this tool makes i2c debug easier 
    +--c-project/without-os/serial-calculator       - simple calculator via serial port, supports +-*/() and unsigned number

Question & Bug fix?

    Please email author [email protected]
    Or file issue via github