From 1454412e6352d41506194ca57f3cd309f4de978b Mon Sep 17 00:00:00 2001 From: Kenneth Barbour Date: Wed, 18 Dec 2019 12:03:10 -0500 Subject: [PATCH] Initial commit --- .gitignore | 1 + .travis.yml | 67 +++++++++++++++++++++++++++++++++++++++++ bin/firmware_rename.py | 13 ++++++++ bin/version.sh | 29 ++++++++++++++++++ include/README | 39 ++++++++++++++++++++++++ lib/README | 46 ++++++++++++++++++++++++++++ platformio.ini | 17 +++++++++++ src/.main.cpp.swp | Bin 0 -> 12288 bytes src/.version.h.swp | Bin 0 -> 12288 bytes src/main.cpp | 24 +++++++++++++++ src/version.cpp | 12 ++++++++ src/version.h | 8 +++++ test/README | 11 +++++++ 13 files changed, 267 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 bin/firmware_rename.py create mode 100755 bin/version.sh create mode 100644 include/README create mode 100644 lib/README create mode 100644 platformio.ini create mode 100644 src/.main.cpp.swp create mode 100644 src/.version.h.swp create mode 100644 src/main.cpp create mode 100644 src/version.cpp create mode 100644 src/version.h create mode 100644 test/README diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..03f4a3c --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.pio 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/bin/firmware_rename.py b/bin/firmware_rename.py new file mode 100644 index 0000000..6341a7a --- /dev/null +++ b/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) diff --git a/bin/version.sh b/bin/version.sh new file mode 100755 index 0000000..db0bbff --- /dev/null +++ b/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}\"'" + 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..db4285b --- /dev/null +++ b/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 diff --git a/src/.main.cpp.swp b/src/.main.cpp.swp new file mode 100644 index 0000000000000000000000000000000000000000..f3ad5d13af936ef74acda804bbc9f72900c1c6ab GIT binary patch literal 12288 zcmeI2&ui2`6vto1t3Rk0Pda8VS-~XR6}r$OtmvVjAeMSiWX&cMGn!7~B-2I8>c1df zJnGGV!i)ca2SG*g4^VpY>dBXE+!k9r^j7#j_+&`ln>UlsEo8>Qowb`{;Pr^(G||Po zzwf_Vd`IVeqQ~htG~?WwI`^N5Y#5dOWv>}M9hKITvE4u6*}S2D%jAz_RF%G+$goPK z870bWPC_I7(nS7dsI(Uq#r__60s}B`2m`iCE)7mlf2kMLvpdcOab|Jj5REVe24DaN zU;qYS00v+H24LW*8mNi|dd{0a*1o{mc3k*pY;Q5Z01UtY48Q;kzyJ)u01UtY48Q;k z96VO}#YnHS6xCS)EkeP)R{&m3odalakr zC-Z~(&U|COGWA*?nGXyC24DaNU;qYS00v+H24DaNU;qXVGB73DrmbAXVtP<;wyD@H z%ksQ%yF^nG9J8wsvCP7!ZZ8Oe?n;voVqF>)W?o^Gu3SfW!f8{JRAo}Qm9erbwy7zf zA6swAM_baAD%T^WliZy(>aNu5&8p|CwH@1~#`2-k?)vrHYr`9(tHX_JoNiyPl$C9^ z-H|$033XzbC@saFVzGRAFbJrl63xlI89v>sbd=dx3a8zfmpZ!-SBECHO6OjBh5i5_ C7@^4k literal 0 HcmV?d00001 diff --git a/src/.version.h.swp b/src/.version.h.swp new file mode 100644 index 0000000000000000000000000000000000000000..bf5a73304fcd2c273d801d60a0e0dee91c8f1a2a GIT binary patch literal 12288 zcmeI&&q~8E90%~slNV7G!IMM>qJy=YJ2+5;9R}OMf18^iO6c0uMqN76#(@V#Uq~Oo ztGB7w2D>`IR@aY7=r3bR5+Q zwMugTG*>%rRNAoyy(Qg9Tiny*1rMVI?PC>Qb2pA`-RDjmaK(I~x_w7+J5sKF$5kXk zX$9kpUEJ4adTtXes( zRU52bZ8Ymge`gL^jZq=pTkUarr5)wboJ~k1?m3I;=puYi2^q8W20Rne4>y~!;!byC kYuDV{9WJm}QJxkuw1Ryz>v3O5KDL?Um8Qg(CjWc#8x-zxQvd(} literal 0 HcmV?d00001 diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..6d7c5e2 --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,24 @@ +#include +#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() +{ + +} diff --git a/src/version.cpp b/src/version.cpp new file mode 100644 index 0000000..6e9fc6c --- /dev/null +++ b/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); +} diff --git a/src/version.h b/src/version.h new file mode 100644 index 0000000..01479fe --- /dev/null +++ b/src/version.h @@ -0,0 +1,8 @@ +#ifndef _UWEATHER_VERSION_H_ +#define _UWEATHER_VERSION_H_ + +#include + +size_t uweather_print_version_info(Stream&); + +#endif /* _UWEATHER_VERSION_H_ include guard */ 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