From 8ba724e68218cf31bfb55ab2c29ec16d9d7f828f Mon Sep 17 00:00:00 2001 From: Fabian Schlenz Date: Fri, 2 Aug 2019 23:48:36 +0200 Subject: [PATCH] Initial commit. --- .gitignore | 3 ++ .travis.yml | 67 ++++++++++++++++++++++++++++++++++++++++++++ include/README | 39 ++++++++++++++++++++++++++ include/buttons.h | 14 +++++++++ include/controller.h | 15 ++++++++++ include/player.h | 9 ++++++ lib/README | 46 ++++++++++++++++++++++++++++++ platformio.ini | 14 +++++++++ src/buttons.cpp | 46 ++++++++++++++++++++++++++++++ src/controller.cpp | 17 +++++++++++ src/main.cpp | 19 +++++++++++++ test/README | 11 ++++++++ 12 files changed, 300 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 include/README create mode 100644 include/buttons.h create mode 100644 include/controller.h create mode 100644 include/player.h create mode 100644 lib/README create mode 100644 platformio.ini create mode 100644 src/buttons.cpp create mode 100644 src/controller.cpp create mode 100644 src/main.cpp create mode 100644 test/README diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..58e33b9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.pio +.pioenvs +.piolibdeps 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/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/include/buttons.h b/include/buttons.h new file mode 100644 index 0000000..2152ab9 --- /dev/null +++ b/include/buttons.h @@ -0,0 +1,14 @@ +#pragma once + +#include "controller.h" + +class Buttons { +private: + unsigned long _debounce_until = 0; + Controller* _controller; + void _debounce(); +public: + Buttons(Controller* c) : _controller(c) {} + void setup(); + void loop(); +}; diff --git a/include/controller.h b/include/controller.h new file mode 100644 index 0000000..0b908bb --- /dev/null +++ b/include/controller.h @@ -0,0 +1,15 @@ +#pragma once + +#include "player.h" + +class Controller { +private: + Player* _player; + +public: + Controller(Player* p) : _player(p) {} + void vol_up(); + void vol_down(); + void track_next(); + void track_prev(); +}; diff --git a/include/player.h b/include/player.h new file mode 100644 index 0000000..7868fc8 --- /dev/null +++ b/include/player.h @@ -0,0 +1,9 @@ +#pragma once + +class Player { +public: + void vol_up(); + void vol_down(); + void track_next(); + void track_prev(); +}; 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..2c7f0eb --- /dev/null +++ b/platformio.ini @@ -0,0 +1,14 @@ +; 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:esp12e] +platform = espressif8266 +board = esp12e +framework = arduino diff --git a/src/buttons.cpp b/src/buttons.cpp new file mode 100644 index 0000000..919beeb --- /dev/null +++ b/src/buttons.cpp @@ -0,0 +1,46 @@ +#include +#include "buttons.h" +#include "config.h" + +void Buttons::setup() { + pinMode(PIN_BTN_VOL_UP, INPUT); + pinMode(PIN_BTN_VOL_DOWN, INPUT); + pinMode(PIN_BTN_TRACK_NEXT, INPUT); + pinMode(PIN_BTN_TRACK_PREV, INPUT); +} + +void Buttons::_debounce() { + unsigned long now = millis(); + _debounce_until = now + DEBOUNCE_MILLIS; + if (_debounce_until < now) _debounce_until = now; +} + +void Buttons::loop() { + bool vol_up = digitalRead(PIN_BTN_VOL_UP); + bool vol_down = digitalRead(PIN_BTN_VOL_DOWN); + bool track_next = digitalRead(PIN_BTN_TRACK_NEXT); + bool track_prev = digitalRead(PIN_BTN_TRACK_PREV); + + if (_debounce_until > millis()) { + if (vol_up || vol_down || track_next || track_prev) { + _debounce(); + } + return; + } + + if (vol_up) { + _controller->vol_up(); + } else if (vol_down) { + _controller->vol_down(); + } else if (track_next) { + _controller->track_next(); + } else if (track_prev) { + _controller->track_prev(); + } else { + // If we reach this, no button was pressed and we are not debouncing -> do nothing. + return; + } + + // If we reach this, some button was pressed. So enable debouncing. + _debounce(); +} diff --git a/src/controller.cpp b/src/controller.cpp new file mode 100644 index 0000000..4998ad2 --- /dev/null +++ b/src/controller.cpp @@ -0,0 +1,17 @@ +#include "controller.h" + +void Controller::vol_up() { + _player->vol_up(); +} + +void Controller::vol_down() { + _player->vol_down(); +} + +void Controller::track_next() { + _player->track_next(); +} + +void Controller::track_prev() { + _player->track_prev(); +} diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..ae9d530 --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,19 @@ +#include +#include "config.h" +#include "buttons.h" +#include "controller.h" +#include "player.h" + +Buttons* buttons; +Controller* controller; +Player* player; + +void setup() { + player = new Player(); + controller = new Controller(player); + buttons = new Buttons(controller); +} + +void loop() { + +} 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