General Software Requirements - jrsteensen/OpenHornet GitHub Wiki

General

  • The programming language for single PCB sketches shall be Arduino C.
  • The single sketch software shall be integrated into the rest of the OH Software ecosystem.
  • The sketches shall be named according to OH nomenclature.
  • The sketch shall send and receive commands via DCS-bios.
  • The sketch shall be able to communicate with other PCB’s via RS487 interface.
  • The sketch shall follow the following our own style guidelines https://github.com/jrsteensen/OpenHornet/blob/master/STYLEGUIDE.md

Structure

  • There shall be one single sketch for each PCB.
  • The sketch shall be structured, using functions.
  • All recurring functions who are used in more than one sketch shall be put into one single OH library.

Deployment & Documentation

  • The sketch shall be version controlled via the OH github repository.
  • The sketch shall be deployed by travis-ci.
  • The sketch shall have an automatically generated API documentation who is created using Doxigen.
  • The sketch shall undergo rigorous testing before release.
  • Please test the functionality of your sketch and the functionality of the doxygen documentation locally BEFORE you upload the sketch to git.
  • You can find a good introduction to the process here: https://learn.adafruit.com/the-well-automated-arduino-library