Arduino IDE -> PlatformIO

.gitignore

@@ -1,2 +1,5 @@
-config.h
+.pio
-tools/*.gif
+.clang_complete
+.gcc-flags.json
+src/config.h
+src/tools/*.gif

.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

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

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 <Foo.h>
+#include <Bar.h>
+
+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

platformio.ini

@@ -0,0 +1,16 @@
+;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:esp07]
+platform = espressif8266
+board = esp07
+framework = arduino
+upload_port = 10.10.2.78
+upload_protocol = espota

src/.gitignore

@@ -0,0 +1,2 @@
+config.h
+tools/*.gif

src/mqtt.h

@@ -6,7 +6,7 @@ void mqtt_callback(char* complete_topic, byte* pl, unsigned int length) {
   pl[length] = '\0';
   char* payload = (char*)pl;
   char* topic = complete_topic + strlen(MQTT_TOPIC); // Strip MQTT_TOPIC from the beginning
-  
+
   // Here, payload is a char* (but has to be casted).
   if(strcmp(topic, "mode")==0) {
     for (int i=0; i<NUM_EFFECTS; i++) {
@@ -21,9 +21,9 @@ void mqtt_callback(char* complete_topic, byte* pl, unsigned int length) {
   } else if (strcmp(topic, "reboot")==0) {
     ESP.restart();
   }
-  
+
   long value = atol(payload);
-  
+
   if (strcmp(topic, "brightness")==0 && value > 0 && value <= 255) {
     config_brightness = value;
     FastLED.setBrightness(config_brightness);

src/pitrix.ino

@@ -1,3 +1,4 @@
+#include <Arduino.h>
 #include <ESP8266WiFi.h>
 #include <ESP8266mDNS.h>
 #include <WiFiUdp.h>
@@ -57,7 +58,7 @@ SimpleList<Effect*>* cycle_effects;
 //EffectEntry effects[NUM_EFFECTS];
 Sinematrix3 sinematrix3;
 BigClock big_clock;
-Clock clock;
+Clock effect_clock;
 Bell bell;
 Static off(CRGB(0x000000));
 Animation anim_koopa(&animation_koopa, CRGB(0x000000), 0, 0);
@@ -71,7 +72,7 @@ TwirlEffect effect_twirl;
 EffectEntry effects[NUM_EFFECTS] = {
   {"sinematrix3", (Effect *)&sinematrix3},
   {"big_clock", (Effect *)&big_clock},
-  {"clock", (Effect *)&clock},
+  {"clock", (Effect *)&effect_clock},
   {"bell", (Effect *)&bell},
   {"off", (Effect *)&off},
   {"koopa", (Effect *)&anim_koopa},
@@ -83,6 +84,13 @@ EffectEntry effects[NUM_EFFECTS] = {
   {"twirl", (Effect *)&effect_twirl},
 };
 
+Effect* current_effect = &effect_clock;
+
+#ifdef MQTT_ENABLE
+	#include <PubSubClient.h>
+	#include "mqtt.h"
+#endif
+
 void setup_cycle_effects() {
   LOGln("Core * Setting up cycle_effects");
   cycle_effects = new SimpleList<Effect*>();
@@ -107,13 +115,6 @@ void setup() {
   Serial.println("Core * Setup complete");
 }
 
-Effect* current_effect = &clock;
-
-#ifdef MQTT_ENABLE
-	#include <PubSubClient.h>
-	#include "mqtt.h"
-#endif
-
 uint8_t starting_up = OTA_STARTUP_DELAY;
 int loop_timeouts = 0;
 long loop_started_at = 0;
@@ -134,20 +135,20 @@ void loop() {
     }
     return;
   }
-  
+
   ntpClient.update();
   #ifdef MQTT_ENABLE
     mqtt_loop();
   #endif
-  
+
   EVERY_N_MILLISECONDS(1000 / FPS) {
     Serial.println("Core * loop running");
     current_effect->loop();
 
     if (current_effect->can_be_shown_with_clock()) {
-      clock.loop(current_effect->clock_as_mask(), CRGB(0xFFFFFF), CRGB(0x000000));
+      effect_clock.loop(current_effect->clock_as_mask(), CRGB(0xFFFFFF), CRGB(0x000000));
     }
-    
+
     FastLED.show();
   }
 

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