From ccf05e99331e8fc2160871b41d67a694d261f1b7 Mon Sep 17 00:00:00 2001 From: Vivian Lim Date: Mon, 27 Jul 2020 00:18:41 -0700 Subject: [PATCH] initial commit --- .gitignore | 6 ++ .vscode/extensions.json | 7 ++ include/README | 39 +++++++++ lib/README | 46 ++++++++++ platformio.ini | 23 +++++ src/main.cpp | 187 ++++++++++++++++++++++++++++++++++++++++ test/README | 11 +++ 7 files changed, 319 insertions(+) create mode 100644 .gitignore create mode 100644 .vscode/extensions.json create mode 100644 include/README create mode 100644 lib/README create mode 100644 platformio.ini create mode 100644 src/main.cpp create mode 100644 test/README diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..26a5265 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch +src/wifi-creds.h \ No newline at end of file diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..e80666b --- /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/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..7475f11 --- /dev/null +++ b/platformio.ini @@ -0,0 +1,23 @@ +; 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:m5stick-c] +platform = espressif32 +board = m5stick-c +framework = arduino + +lib_deps = + M5StickC + WiFi + ESP32 + AsyncTCP + Arduino_JSON + +upload_port = COM3 \ No newline at end of file diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..ef6d7cf --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,187 @@ +/*#include + +void setup() { + // put your setup code here, to run once: +} + +void loop() { + // put your main code here, to run repeatedly: +} +*/ +#include +#if defined(ESP32) +#include +#include <./wifi-creds.h> // needs to define hostname, ssid, password +#else +#include +#endif + +#include + +int val = 0; //value for storing moisture value +int soilPin = 36;//Declare a variable for the soil moisture sensor +int soilPower = 26;//Variable for Soil moisture Power +int readIndicatorLed = 10;//pin for LED indicating read is happening + +int modeButton = 37; + +char spinner[] = {'/','-','\\','|'}; +int spinnerIndex = 0; + +bool logging = false; +bool buttonWasDown = false; + +uint16_t textColor = WHITE; + +const char* url = "http://192.168.1.101:9989/api/log/m5stick"; + +const long nonLoggingModeInterval = 2000; // every second +const long loggingModeInterval = 1800000; // every 30 minutes + +long remainingInInterval = 0; +const int loopInterval = 1000; + +int moist = 0; // moisture readings + +// the setup routine runs once when M5StickC starts up +void setup() { + + // initialize the M5StickC object + M5.begin(); + + M5.Lcd.setRotation(1); + pinMode(soilPin, INPUT); + pinMode(soilPower, OUTPUT); + + pinMode(modeButton, INPUT); + + + M5.Lcd.fillScreen(BLACK); + M5.Lcd.setCursor(10, 10); + M5.Lcd.setTextColor(WHITE); + M5.Lcd.setTextSize(1); + M5.Axp.ScreenBreath(8); // set lower than default backlight level + + #if defined(ESP32) + WiFi.setHostname(hostname); + #else + WiFi.hostname(hostname); + #endif + WiFi.begin(ssid, password); + M5.Lcd.printf("Connecting to wifi"); + { + uint8_t timeout = 10; + + // Wait for connection, 5s timeout + do { + delay(500); + Serial.print("."); + M5.Lcd.print("."); + timeout--; + } while (timeout && WiFi.status() != WL_CONNECTED); + } +} + +//This is a function used to get the soil moisture content +int readSoil() +{ + + digitalWrite(soilPower, HIGH);//turn D7 "On" + digitalWrite(readIndicatorLed, HIGH);//turn D7 "On" + delay(100);//wait 10 milliseconds + val = analogRead(soilPin);//Read the SIG value form sensor + digitalWrite(soilPower, LOW);//turn D7 "Off" + digitalWrite(readIndicatorLed, LOW);//turn D7 "Off" + return val;//send current moisture value +} + +void report(int value){ + if (WiFi.status() != WL_CONNECTED) + return; + + char urlBuffer[80]; + sprintf(urlBuffer, "%s/%d", url, value); + + HTTPClient http; + + http.begin(urlBuffer); + + int responseCode = http.GET(); + + if (responseCode > 0){ + textColor = WHITE; + } + else { + textColor = RED; + } + + http.end(); +} + +void handleModeButton(){ + // press: low + int buttonState = digitalRead(modeButton); + + if (!buttonState) + { + buttonWasDown = true; + textColor = PURPLE; // visual indication that the buttonpress was read + } + else { + if (buttonWasDown == true){ + // mode switch here + logging = !logging; + buttonWasDown = false; + remainingInInterval = 0; // force an action immediately. + textColor = WHITE; + } + } +} + +// the loop routine runs over and over again forever +void loop(){ + handleModeButton(); + + remainingInInterval -= loopInterval; + + bool shouldAct = remainingInInterval <= 0; + + if (shouldAct) + { + moist = readSoil(); + // reset interval + remainingInInterval = logging ? loggingModeInterval : nonLoggingModeInterval; + } + + M5.Lcd.fillScreen(BLACK); + M5.Lcd.setCursor(10, 10); + M5.Lcd.setTextColor(textColor); + M5.Lcd.setTextSize(5); + M5.Lcd.printf("%d", moist); + M5.Lcd.setCursor(5, 60); + M5.Lcd.setTextSize(2); + M5.Lcd.printf("%c ", spinner[spinnerIndex]); + spinnerIndex = (spinnerIndex + 1) % 4; + + if (WiFi.status() == WL_CONNECTED) + M5.Lcd.printf("W "); + + if (logging) { + M5.Lcd.print("L "); + + if (shouldAct){ + report(moist); + } + } + + M5.Lcd.setTextSize(1); + if (remainingInInterval >= 1000){ + M5.Lcd.printf("next: %lds", remainingInInterval/1000); + } + else{ + M5.Lcd.printf("next: %ldms", remainingInInterval); + } + + delay(loopInterval);//wait 10 milliseconds + //M5.update(); +} \ No newline at end of file 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