From a3a13967ecbe720f53aa4134c94566190eddd7b4 Mon Sep 17 00:00:00 2001 From: David Cutting Date: Mon, 25 May 2020 01:43:34 -0600 Subject: [PATCH] Initial commit --- .gitattributes | 2 ++ .gitignore | 5 +++ .travis.yml | 67 +++++++++++++++++++++++++++++++++++++++++ .vscode/extensions.json | 7 +++++ include/README | 39 ++++++++++++++++++++++++ lib/README | 46 ++++++++++++++++++++++++++++ platformio.ini | 29 ++++++++++++++++++ src/main.cpp | 50 ++++++++++++++++++++++++++++++ test/README | 11 +++++++ 9 files changed, 256 insertions(+) create mode 100644 .gitattributes create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 .vscode/extensions.json create mode 100644 include/README create mode 100644 lib/README create mode 100644 platformio.ini create mode 100644 src/main.cpp create mode 100644 test/README diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..dfe0770 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# Auto detect text files and perform LF normalization +* text=auto diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..89cc49c --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..7c486f1 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,67 @@ +# Continuous Integration (CI) is the practice, in software +# engineering, of merging all developer working copies with a shared mainline +# several times a day < https://docs.platformio.org/page/ci/index.html > +# +# Documentation: +# +# * Travis CI Embedded Builds with PlatformIO +# < https://docs.travis-ci.com/user/integration/platformio/ > +# +# * PlatformIO integration with Travis CI +# < https://docs.platformio.org/page/ci/travis.html > +# +# * User Guide for `platformio ci` command +# < https://docs.platformio.org/page/userguide/cmd_ci.html > +# +# +# Please choose one of the following templates (proposed below) and uncomment +# it (remove "# " before each line) or use own configuration according to the +# Travis CI documentation (see above). +# + + +# +# Template #1: General project. Test it using existing `platformio.ini`. +# + +# language: python +# python: +# - "2.7" +# +# sudo: false +# cache: +# directories: +# - "~/.platformio" +# +# install: +# - pip install -U platformio +# - platformio update +# +# script: +# - platformio run + + +# +# Template #2: The project is intended to be used as a library with examples. +# + +# language: python +# python: +# - "2.7" +# +# sudo: false +# cache: +# directories: +# - "~/.platformio" +# +# env: +# - PLATFORMIO_CI_SRC=path/to/test/file.c +# - PLATFORMIO_CI_SRC=examples/file.ino +# - PLATFORMIO_CI_SRC=path/to/test/directory +# +# install: +# - pip install -U platformio +# - platformio update +# +# script: +# - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..e80666b --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,7 @@ +{ + // See http://go.microsoft.com/fwlink/?LinkId=827846 + // for the documentation about the extensions.json format + "recommendations": [ + "platformio.platformio-ide" + ] +} diff --git a/include/README b/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/include/README @@ -0,0 +1,39 @@ + +This directory is intended for project header files. + +A header file is a file containing C declarations and macro definitions +to be shared between several project source files. You request the use of a +header file in your project source file (C, C++, etc) located in `src` folder +by including it, with the C preprocessing directive `#include'. + +```src/main.c + +#include "header.h" + +int main (void) +{ + ... +} +``` + +Including a header file produces the same results as copying the header file +into each source file that needs it. Such copying would be time-consuming +and error-prone. With a header file, the related declarations appear +in only one place. If they need to be changed, they can be changed in one +place, and programs that include the header file will automatically use the +new version when next recompiled. The header file eliminates the labor of +finding and changing all the copies as well as the risk that a failure to +find one copy will result in inconsistencies within a program. + +In C, the usual convention is to give header files names that end with `.h'. +It is most portable to use only letters, digits, dashes, and underscores in +header file names, and at most one dot. + +Read more about using header files in official GCC documentation: + +* Include Syntax +* Include Operation +* Once-Only Headers +* Computed Includes + +https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html diff --git a/lib/README b/lib/README new file mode 100644 index 0000000..6debab1 --- /dev/null +++ b/lib/README @@ -0,0 +1,46 @@ + +This directory is intended for project specific (private) libraries. +PlatformIO will compile them to static libraries and link into executable file. + +The source code of each library should be placed in a an own separate directory +("lib/your_library_name/[here are source files]"). + +For example, see a structure of the following two libraries `Foo` and `Bar`: + +|--lib +| | +| |--Bar +| | |--docs +| | |--examples +| | |--src +| | |- Bar.c +| | |- Bar.h +| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html +| | +| |--Foo +| | |- Foo.c +| | |- Foo.h +| | +| |- README --> THIS FILE +| +|- platformio.ini +|--src + |- main.c + +and a contents of `src/main.c`: +``` +#include +#include + +int main (void) +{ + ... +} + +``` + +PlatformIO Library Dependency Finder will find automatically dependent +libraries scanning project source files. + +More information about PlatformIO Library Dependency Finder +- https://docs.platformio.org/page/librarymanager/ldf.html diff --git a/platformio.ini b/platformio.ini new file mode 100644 index 0000000..89d476a --- /dev/null +++ b/platformio.ini @@ -0,0 +1,29 @@ +; PlatformIO Project Configuration File +; +; Build options: build flags, source filter +; Upload options: custom upload port, speed and extra flags +; Library options: dependencies, extra library storages +; Advanced options: extra scripting +; +; Please visit documentation for the other options and examples +; https://docs.platformio.org/page/projectconf.html + +[env:samd21] +platform = atmelsam +board = sparkfun_samd21_dev_usb +framework = arduino +lib_deps = + https://github.com/davidcutting42/CommandStation.git#master + https://github.com/davidcutting42/ArduinoTimers.git#master + SparkFun External EEPROM Arduino Library +build_flags = -D ATSAMD21G + +[env:mega2560] +platform = atmelavr +board = megaatmega2560 +framework = arduino +lib_deps = + https://github.com/davidcutting42/CommandStation.git#master + https://github.com/davidcutting42/ArduinoTimers.git#master + SparkFun External EEPROM Arduino Library +build_flags = -D ATMEGA2560 \ No newline at end of file diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..e6b333f --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,50 @@ +#include +#include + +DCC* mainTrack = DCC::Create_WSM_SAMCommandStation_Main(50); +DCC* progTrack = DCC::Create_WSM_SAMCommandStation_Prog(2); + +void main_IrqHandler() { + mainTrack->interrupt_handler(); +} + +void prog_IrqHandler() { + progTrack->interrupt_handler(); +} + +void setup() { +#if defined (ATSAMD21G) + CommManager::registerInterface(new SerialInterface(SerialUSB)); // Register SerialUSB as an interface + + TimerTCC0.initialize(); + TimerTCC0.setPeriod(58); + TimerTCC0.attachInterrupt(main_IrqHandler); + TimerTCC0.start(); + + TimerTCC1.initialize(); + TimerTCC1.setPeriod(58); + TimerTCC1.attachInterrupt(prog_IrqHandler); + TimerTCC1.start(); +#elif defined(ATMEGA2560) + CommManager::registerInterface(new SerialInterface(Serial)); // Register Serial (USB port on mega/uno) as an interface + + Timer1.initialize(); + Timer1.setPeriod(58); + Timer1.attachInterrupt(main_IrqHandler); + Timer1.start(); + + Timer3.initialize(); + Timer3.setPeriod(58); + Timer3.attachInterrupt(prog_IrqHandler); + Timer3.start(); +#endif + + StringParser::init(mainTrack, progTrack); // Set up the string parser to accept commands from the interfaces + CommManager::showInitInfo(); +} + +void loop() { + CommManager::update(); + mainTrack->check(); + progTrack->check(); +} \ No newline at end of file diff --git a/test/README b/test/README new file mode 100644 index 0000000..df5066e --- /dev/null +++ b/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PIO Unit Testing and project tests. + +Unit Testing is a software testing method by which individual units of +source code, sets of one or more MCU program modules together with associated +control data, usage procedures, and operating procedures, are tested to +determine whether they are fit for use. Unit testing finds problems early +in the development cycle. + +More information about PIO Unit Testing: +- https://docs.platformio.org/page/plus/unit-testing.html