From 5f75a593fa786af5bacb5c0cbac78cbed3d9ba5e Mon Sep 17 00:00:00 2001 From: James Wood Date: Tue, 14 Jul 2020 16:52:25 +1000 Subject: [PATCH] First Comet --- .gitignore | 6 +++ .travis.yml | 67 +++++++++++++++++++++++++++++++ .vscode/extensions.json | 7 ++++ include/README | 39 ++++++++++++++++++ include/secrets.h SAMPLE | 4 ++ lib/README | 46 +++++++++++++++++++++ platformio.ini | 19 +++++++++ src/Esp_Temperature_V2.ino | 82 ++++++++++++++++++++++++++++++++++++++ test/README | 11 +++++ 9 files changed, 281 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 .vscode/extensions.json create mode 100644 include/README create mode 100644 include/secrets.h SAMPLE create mode 100644 lib/README create mode 100644 platformio.ini create mode 100755 src/Esp_Temperature_V2.ino create mode 100644 test/README diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..46fe6f7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch +secrets.h \ No newline at end of file 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..0f0d740 --- /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/include/secrets.h SAMPLE b/include/secrets.h SAMPLE new file mode 100644 index 0000000..7b7339f --- /dev/null +++ b/include/secrets.h SAMPLE @@ -0,0 +1,4 @@ +const char* wifi_ssid = "WIFI NETWORK HERE"; +const char* wifi_password = "WIFI PASSWORD HERE"; +const char* mqttServer = "192.168.1.1"; +const int mqttPort = 1883; \ No newline at end of file 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..9d81aa3 --- /dev/null +++ b/platformio.ini @@ -0,0 +1,19 @@ +; 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:esp01_1m] +platform = espressif8266 +board = esp01_1m +framework = arduino +monitor_speed = 115200 + +lib_deps = + PubSubClient + DHT sensor library \ No newline at end of file diff --git a/src/Esp_Temperature_V2.ino b/src/Esp_Temperature_V2.ino new file mode 100755 index 0000000..29c2b4d --- /dev/null +++ b/src/Esp_Temperature_V2.ino @@ -0,0 +1,82 @@ +#include +#include +#include "DHT.h" +#include "math.h" +#include "secrets.h" // modify 'include/secrets.h SAMPLE' with your details and save as 'include/secrets.h' + +#define DHTPIN 2 +#define DHTTYPE DHT11 + +const char* hostName = "Humidobot-2"; +const char* humidityTopic = "sensors/dht2/humidity"; +const char* temperatureTopic = "sensors/dht2/temperature"; + +unsigned long lastMeasureAttempt = 0; + +// DHT dht; +DHT dht(DHTPIN, DHTTYPE); +WiFiClient espClient; +PubSubClient client(espClient); + +const long measurementInterval = 5000; //dht.getMinimumSamplingPeriod(); + +void setup() { + Serial.begin(115200); + Serial.println(); + setup_wifi(); + client.setServer(mqttServer, mqttPort); + dht.begin(); +} + +void setup_wifi() { + Serial.print("Connecting to " + String(wifi_ssid)); + WiFi.begin(wifi_ssid, wifi_password); + while (WiFi.status() != WL_CONNECTED) { + yield(500); + Serial.print("."); + } + Serial.print("WiFi connected. IP: "); + Serial.println(WiFi.localIP()); +} + +void reconnect() { + while (!client.connected()) { + Serial.print("Attempting MQTT connection..."); + if (client.connect(hostName)) { + Serial.println("connected"); + } else { + Serial.print(" failed. MQTT connection error: "); + Serial.println(client.state()); + Serial.println(" try again in 5 seconds"); + yield(5000); + } + } +} + +void loop() { + if (WiFi.status() != WL_CONNECTED) setup_wifi(); + if (!client.connected()) reconnect(); + client.loop(); + if ((millis() - lastMeasureAttempt) > measurementInterval) { + reportResults(dht.readTemperature(), dht.readHumidity()); + lastMeasureAttempt = millis(); + } +} + +void reportResults(float temp, float humid) { + if (!isnan(temp) || !isnan(humid)) { + Serial.println("-----------------------"); + Serial.println("Humidity (%): " + String(humid)); + Serial.println("Temperature (°C): " + String(temp)); + Serial.println("-----------------------"); + client.publish(humidityTopic, String(humid).c_str(), true); + client.publish(temperatureTopic, String(temp).c_str(), true); + } +} + +void yield(unsigned long yieldDuration) { //overload yield function to allow for any ms delay + unsigned long yieldBegan = millis(); + while ( (millis() - yieldBegan) < yieldDuration ) { + yield(); + } +} 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