From 7b2a49b329af42c347c6f992453cd4165ff53a25 Mon Sep 17 00:00:00 2001 From: Joe Tretter Date: Mon, 21 Sep 2020 17:57:22 -0500 Subject: [PATCH] Init Shared Repo --- .gitignore | 5 ++ .vscode/extensions.json | 7 ++ include/README | 39 ++++++++++ lib/README | 46 +++++++++++ platformio.ini | 17 +++++ src/credentials.h | 2 + src/main.cpp | 165 ++++++++++++++++++++++++++++++++++++++++ test/README | 11 +++ 8 files changed, 292 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/credentials.h create mode 100644 src/main.cpp create mode 100644 test/README diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..89cc49c --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch 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..45496b1 --- /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..8c9c29c --- /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..3a67b5d --- /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:esp32doit-devkit-v1] +platform = espressif32 +board = esp32doit-devkit-v1 +framework = arduino +lib_deps = xose/FauxmoESP@^3.1.0 + +monitor_speed = 115200 \ No newline at end of file diff --git a/src/credentials.h b/src/credentials.h new file mode 100644 index 0000000..12591a5 --- /dev/null +++ b/src/credentials.h @@ -0,0 +1,2 @@ +#define WIFI_SSID "JoeNelsDarlings" +#define WIFI_PASS "Paris2016" diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..fb65896 --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,165 @@ +#include +#ifdef ESP32 + #include +#else + #include +#endif +#include "fauxmoESP.h" + +// Rename the credentials.sample.h file to credentials.h and +// edit it according to your router configuration +#include "credentials.h" + +fauxmoESP fauxmo; + +// ----------------------------------------------------------------------------- + +#define SERIAL_BAUDRATE 115200 + +#define LED_YELLOW LED_BUILTIN //4 +#define LED_GREEN LED_BUILTIN //5 +#define LED_BLUE LED_BUILTIN //0 +#define LED_PINK LED_BUILTIN //2 +#define LED_WHITE LED_BUILTIN //15 + +#define ID_YELLOW "yellow lamp" +#define ID_GREEN "green lamp" +#define ID_BLUE "blue lamp" +#define ID_PINK "pink lamp" +#define ID_WHITE "white lamp" + +// ----------------------------------------------------------------------------- + +// ----------------------------------------------------------------------------- +// Wifi +// ----------------------------------------------------------------------------- + +void wifiSetup() { + + // Set WIFI module to STA mode + WiFi.mode(WIFI_STA); + + // Connect + Serial.printf("[WIFI] Connecting to %s ", WIFI_SSID); + WiFi.begin(WIFI_SSID, WIFI_PASS); + + // Wait + while (WiFi.status() != WL_CONNECTED) { + Serial.print("."); + delay(100); + } + Serial.println(); + + // Connected! + Serial.printf("[WIFI] STATION Mode, SSID: %s, IP address: %s\n", WiFi.SSID().c_str(), WiFi.localIP().toString().c_str()); + +} + +// setting PWM properties +const int freq = 5000; +const int ledChannel = 0; +const int resolution = 8; + +void setup() { + + // Init serial port and clean garbage + Serial.begin(SERIAL_BAUDRATE); + Serial.println(); + Serial.println(); + + // LEDs + /* pinMode(LED_YELLOW, OUTPUT); + pinMode(LED_GREEN, OUTPUT); + pinMode(LED_BLUE, OUTPUT); + pinMode(LED_PINK, OUTPUT); + pinMode(LED_WHITE, OUTPUT); + digitalWrite(LED_YELLOW, LOW); + digitalWrite(LED_GREEN, LOW); + digitalWrite(LED_BLUE, LOW); + digitalWrite(LED_PINK, LOW); + digitalWrite(LED_WHITE, LOW); */ + +// configure LED PWM functionalitites + ledcSetup(ledChannel, freq, resolution); + + // attach the channel to the GPIO to be controlled + ledcAttachPin(LED_BLUE, ledChannel); + + // Wifi + wifiSetup(); + + // By default, fauxmoESP creates it's own webserver on the defined port + // The TCP port must be 80 for gen3 devices (default is 1901) + // This has to be done before the call to enable() + fauxmo.createServer(true); // not needed, this is the default value + fauxmo.setPort(80); // This is required for gen3 devices + + // You have to call enable(true) once you have a WiFi connection + // You can enable or disable the library at any moment + // Disabling it will prevent the devices from being discovered and switched + fauxmo.enable(true); + + // You can use different ways to invoke alexa to modify the devices state: + // "Alexa, turn yellow lamp on" + // "Alexa, turn on yellow lamp + // "Alexa, set yellow lamp to fifty" (50 means 50% of brightness, note, this example does not use this functionality) + + // Add virtual devices + //fauxmo.addDevice(ID_YELLOW); + //fauxmo.addDevice(ID_GREEN); + fauxmo.addDevice(ID_BLUE); + //fauxmo.addDevice(ID_PINK); + //fauxmo.addDevice(ID_WHITE); + + fauxmo.onSetState([](unsigned char device_id, const char * device_name, bool state, unsigned char value) { + + // Callback when a command from Alexa is received. + // You can use device_id or device_name to choose the element to perform an action onto (relay, LED,...) + // State is a boolean (ON/OFF) and value a number from 0 to 255 (if you say "set kitchen light to 50%" you will receive a 128 here). + // Just remember not to delay too much here, this is a callback, exit as soon as possible. + // If you have to do something more involved here set a flag and process it in your main loop. + + Serial.printf("[MAIN] Device #%d (%s) state: %s value: %d\n", device_id, device_name, state ? "ON" : "OFF", value); + + // Checking for device_id is simpler if you are certain about the order they are loaded and it does not change. + // Otherwise comparing the device_name is safer. + + if (strcmp(device_name, ID_BLUE)==0) { + //digitalWrite(LED_YELLOW, state ? HIGH : LOW); + if (!state) { // if the lamp is off, it doesn't matter what the brighness level is set to be. + value=0; + } + ledcWrite(ledChannel, value); + } /*else if (strcmp(device_name, ID_GREEN)==0) { + digitalWrite(LED_GREEN, state ? HIGH : LOW); + } else if (strcmp(device_name, ID_BLUE)==0) { + digitalWrite(LED_BLUE, state ? HIGH : LOW); + } else if (strcmp(device_name, ID_PINK)==0) { + digitalWrite(LED_PINK, state ? HIGH : LOW); + } else if (strcmp(device_name, ID_WHITE)==0) { + digitalWrite(LED_WHITE, state ? HIGH : LOW); + } */ + + }); + +} + +void loop() { + + // fauxmoESP uses an async TCP server but a sync UDP server + // Therefore, we have to manually poll for UDP packets + fauxmo.handle(); + + // This is a sample code to output free heap every 5 seconds + // This is a cheap way to detect memory leaks + static unsigned long last = millis(); + if (millis() - last > 5000) { + last = millis(); + Serial.printf("[MAIN] Free heap: %d bytes\n", ESP.getFreeHeap()); + } + + // If your device state is changed by any other means (MQTT, physical button,...) + // you can instruct the library to report the new state to Alexa on next request: + // fauxmo.setState(ID_YELLOW, true, 255); + +} diff --git a/test/README b/test/README new file mode 100644 index 0000000..e7d1588 --- /dev/null +++ b/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PlatformIO 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 PlatformIO Unit Testing: +- https://docs.platformio.org/page/plus/unit-testing.html