Initial commit

.gitignore

@@ -0,0 +1 @@
+.pio

.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

bin/firmware_rename.py

@@ -0,0 +1,13 @@
+Import("env")
+import re
+
+flags = env.ParseFlags(env['BUILD_FLAGS'])
+defines = {k: v for (k, v) in flags.get("CPPDEFINES")}
+
+version = re.sub("\"", "", defines.get("VERSION"))
+version_rep = re.sub("\.","_", version)
+progname = "uweather_firmware-" + version_rep
+print(progname)
+
+
+env.Replace(PROGNAME=progname)

bin/version.sh

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+
+VERSION_PREFIX=
+
+# Gits the current git tag (if any)
+TAG=$(git tag -l --points-at HEAD)
+
+RECENT_TAG=$(git describe --tags)
+
+DATE=$(TZ=UTC date +"%Y%m%d%H%M%S")
+
+COMMIT_HASH=$(git rev-parse --short HEAD)
+
+
+## If working tree is not clean, append {RECENT_TAG}+
+if [[ $(git status -u -s) ]]; then
+VERSION_STRING=${VERSION_PREFIX}${RECENT_TAG}+
+
+# If working tree is clean, but head is not tagged append a git description
+elif [[ ! ${TAG} ]]; then
+VERSION_STRING=${VERSION_PREFIX}${RECENT_TAG}
+
+# if working tree is clean and HEAD is tagged, this is an official version
+else
+VERSION_STRING=${VERSION_PREFIX}${TAG}
+fi
+
+echo "-D VERSION='\"${VERSION_STRING}\"'"
+

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,17 @@
+;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
+build_flags =
+    !bin/version.sh
+extra_scripts = pre:bin/firmware_rename.py

src/main.cpp

@@ -0,0 +1,24 @@
+#include <Arduino.h>
+#include "version.h"
+
+#ifndef SERIAL_BAUD
+#define SERIAL_BAUD 74880
+#endif
+
+void setup()
+{
+    Serial.begin(SERIAL_BAUD);
+    delay(100);
+
+    uweather_print_version_info(Serial);    
+
+    while (true) {
+      Serial.print(" . ");
+      delay(1000);
+    }
+}
+
+void loop()
+{
+
+}

src/version.cpp

@@ -0,0 +1,12 @@
+#include "version.h"
+#ifndef VERSION
+#define VERSION "0.0.0"
+#endif
+
+static const char UWEATHER_VERSION[] PROGMEM = VERSION;
+
+
+size_t uweather_print_version_info(Stream& out)
+{
+    return out.printf_P(PSTR("uWeather Firmware version %s\r\n"), UWEATHER_VERSION);
+}

src/version.h

@@ -0,0 +1,8 @@
+#ifndef _UWEATHER_VERSION_H_
+#define _UWEATHER_VERSION_H_
+
+#include <Arduino.h>
+
+size_t uweather_print_version_info(Stream&);
+
+#endif /* _UWEATHER_VERSION_H_ include guard */

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