From 9bc3fc59102c5a498ceeb9a4d1de7be0a45cff45 Mon Sep 17 00:00:00 2001 From: Siwat Sirichai Date: Wed, 29 May 2024 20:21:56 +0700 Subject: [PATCH] initial commit --- .gitignore | 5 ++ .vscode/extensions.json | 10 ++++ LICENSE | 36 ++++++++++++++ README.md | 45 +++++++++++++++++ include/README | 39 +++++++++++++++ lib/README | 46 ++++++++++++++++++ platformio.ini | 17 +++++++ src/config.hpp | 19 ++++++++ src/main.cpp | 105 ++++++++++++++++++++++++++++++++++++++++ src/main.hpp | 25 ++++++++++ test/README | 11 +++++ 11 files changed, 358 insertions(+) create mode 100644 .gitignore create mode 100644 .vscode/extensions.json create mode 100644 LICENSE create mode 100644 README.md create mode 100644 include/README create mode 100644 lib/README create mode 100644 platformio.ini create mode 100644 src/config.hpp create mode 100644 src/main.cpp create mode 100644 src/main.hpp 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..080e70d --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,10 @@ +{ + // See http://go.microsoft.com/fwlink/?LinkId=827846 + // for the documentation about the extensions.json format + "recommendations": [ + "platformio.platformio-ide" + ], + "unwantedRecommendations": [ + "ms-vscode.cpptools-extension-pack" + ] +} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..929af2a --- /dev/null +++ b/LICENSE @@ -0,0 +1,36 @@ +SOFTWARE LICENSE AGREEMENT + +1. LICENSE GRANT: + Subject to the terms and conditions of this Agreement, SIWAT SYSTEM ("Vendor") hereby grants licensee + a non-exclusive, non-transferable, non-redistributable license ("License") to use the software product + identified as ESPMegaOS R.CUD ("Software"). + +2. PERMITTED USE: + Licensee may use the Software solely for licensee's own benifit. Licensee may modify + the Software for its internal use only. Any distribution, reproduction, or redistribution + of modified versions of the Software, whether for commercial or non-commercial purposes, + is expressly prohibited without prior written consent from the Vendor. + +3. OWNERSHIP: + Vendor retains all right, title, and interest in and to the Software, including all intellectual property + rights therein. This Agreement does not convey to Licensee any rights of ownership in the Software, + but only a limited right to use as expressly set forth herein. + +4. WARRANTY DISCLAIMER: + The software is provided "as is" without warranty of any kind, either express or implied, including, + but not limited to, the implied warranties of merchantability, fitness for a particular purpose, + or non-infringement. + +5. LIMITATION OF LIABILITY: + In no event shall Vendor be liable for any special, incidental, indirect, or consequential damages + whatsoever (including, without limitation, damages for loss of business profits, business interruption, + loss of business information, or any other pecuniary loss) arising out of the use of or inability to + use the Software, even if Vendor has been advised of the possibility of such damages. + +6. ACCEPTANCE OF TERMS: + By using, downloading, installing, or accessing the Software, Licensee acknowledges and + agrees that Licensee has read, understood, and accepted the terms and conditions of this Agreement. + Licensee further agrees that Licensee's use of the Software constitutes acceptance of the terms herein, + and this Agreement shall be deemed effective upon such use, downloading, installation, or access. + If Licensee does not agree to the terms of this Agreement, Licensee must not use, download, install, + or access the Software. diff --git a/README.md b/README.md new file mode 100644 index 0000000..69581fd --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# ESPMega PRO R.CUD Firmware +## Hardware Compatibility +This Sofware is made specifically for the Chulalongkorn University Secondary School IoT Project Deployment in 2024. The installation contain the following: +- ESPMega PRO R3.3c +- OMRON MY2N-GS-R Contact relay +- Mitsubishi S-T25 +## Features +## Installation +### USB (DFU) Upload +### Over-the-air (OTA) Upload +## Licenses +1. LICENSE GRANT: + Subject to the terms and conditions of this Agreement, SIWAT SYSTEM ("Vendor") hereby grants licensee + a non-exclusive, non-transferable, non-redistributable license ("License") to use the software product + identified as ESPMegaOS R.CUD ("Software"). + +2. PERMITTED USE: + Licensee may use the Software solely for licensee's own benifit. Licensee may modify + the Software for its internal use only. Any distribution, reproduction, or redistribution + of modified versions of the Software, whether for commercial or non-commercial purposes, + is expressly prohibited without prior written consent from the Vendor. + +3. OWNERSHIP: + Vendor retains all right, title, and interest in and to the Software, including all intellectual property + rights therein. This Agreement does not convey to Licensee any rights of ownership in the Software, + but only a limited right to use as expressly set forth herein. + +4. WARRANTY DISCLAIMER: + The software is provided "as is" without warranty of any kind, either express or implied, including, + but not limited to, the implied warranties of merchantability, fitness for a particular purpose, + or non-infringement. + +5. LIMITATION OF LIABILITY: + In no event shall Vendor be liable for any special, incidental, indirect, or consequential damages + whatsoever (including, without limitation, damages for loss of business profits, business interruption, + loss of business information, or any other pecuniary loss) arising out of the use of or inability to + use the Software, even if Vendor has been advised of the possibility of such damages. + +6. ACCEPTANCE OF TERMS: + By using, downloading, installing, or accessing the Software, Licensee acknowledges and + agrees that Licensee has read, understood, and accepted the terms and conditions of this Agreement. + Licensee further agrees that Licensee's use of the Software constitutes acceptance of the terms herein, + and this Agreement shall be deemed effective upon such use, downloading, installation, or access. + If Licensee does not agree to the terms of this Agreement, Licensee must not use, download, install, + or access the Software. 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..9ca21da --- /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:satitm-server] +platform = espressif32 +board = wt32-eth01 +framework = arduino +lib_deps = siwats/ESPMegaPROR3@^2.9.0 +monitor_speed = 115200 +build_flags = -DCORE_DEBUG_LEVEL=0 -DSW_VERSION='"cudserver-1.0.0"' -DBOARD_MODEL='"ESPMegaPRO R3.3b"' \ No newline at end of file diff --git a/src/config.hpp b/src/config.hpp new file mode 100644 index 0000000..49b9a58 --- /dev/null +++ b/src/config.hpp @@ -0,0 +1,19 @@ +#pragma once + +/*********************************************** + * Variants * + ***********************************************/ +// @note You can use -D flag to define the variant and comment out the line below +// #define AC_TYPE AC_TYPE_CEILING + +/*********************************************** + * Pin Definitions * + ***********************************************/ +#define TEMP_SENSOR_PIN 32 + +/*********************************************** + * Display Configuration * + ***********************************************/ +// UART Configuration +#define INTERNAL_DISPLAY_UART Serial +#define INTERNAL_DISPLAY_BAUDRATE 115200 \ No newline at end of file diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..ed36e1b --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,105 @@ +#include +/************************************************ + * Global Variables * + ************************************************/ +ESPMegaPRO espmega = ESPMegaPRO(); +ESPMegaDisplayOTA internalDisplayOTA = ESPMegaDisplayOTA(); + +DHTNEW dht(TEMP_SENSOR_PIN); + +/************************************************ + * End of Global Variables * + ************************************************/ + +void setup() +{ + // Initialize both displayports + INTERNAL_DISPLAY_UART.begin(INTERNAL_DISPLAY_BAUDRATE); + ESP_LOGI("CUD IoT OS", "Starting Initialization"); + send_stop_bytes(INTERNAL_DISPLAY_UART); + INTERNAL_DISPLAY_UART.print("rest"); + send_stop_bytes(INTERNAL_DISPLAY_UART); + // Wait for the display to reset + vTaskDelay(1000 / portTICK_PERIOD_MS); + // Initialize the ESPMegaPRO + ESP_LOGV("CUD IoT OS", "Initializing ESPMegaPRO"); + espmega.begin(); + // Initialize IoT Modules + ESP_LOGV("CUD IoT OS", "Initializing IoT Modules"); + espmega.setTimezone("ICT-7"); + espmega.enableIotModule(); + // Setup Ethernet + ESP_LOGV("CUD IoT OS", "Initializing Ethernet"); + ETH.begin(); + ESP_LOGD("CUD IoT OS", "Binding Ethernet Interface"); + espmega.iot->bindEthernetInterface(Ð); + // Connect to Network + ESP_LOGV("CUD IoT OS", "Connecting to Network"); + espmega.iot->loadNetworkConfig(); + espmega.iot->connectNetwork(); + // Connect to the MQTT Broker + ESP_LOGV("CUD IoT OS", "Connecting to MQTT Broker"); + espmega.iot->loadMqttConfig(); + vTaskDelay(3000 / portTICK_PERIOD_MS); // Wait for the network to stabilize + espmega.iot->connectToMqtt(); + // Enable Web Server + ESP_LOGV("CUD IoT OS", "Enabling Web Server"); + espmega.enableWebServer(80); + // Initialize Internal Display + ESP_LOGV("CUD IoT OS", "Initializing Internal Display"); + espmega.enableInternalDisplay(&INTERNAL_DISPLAY_UART); + // Register all cards with iot + ESP_LOGV("CUD IoT OS", "Registering Cards with IoT"); + espmega.iot->registerCard(0); + espmega.iot->registerCard(1); + // Input callbacks + // This pre-load the input buffers + // We need to do this to prevent switches that are left on the "on" position from triggering the callback + ESP_LOGV("CUD IoT OS", "Pre-loading input buffers"); + espmega.inputs.loop(); + espmega.inputs.registerCallback(handle_input_change); + espmega.iot->registerMqttCallback(handle_mqtt_message); + internalDisplayOTA.begin("/intdisp", espmega.display, espmega.webServer); + // Setup the temperature sensor + ESP_LOGI("CUD IoT OS", "Initialization Complete"); +} + +void loop() +{ + static uint32_t lastTempUpdate = 0; + if (millis() - lastTempUpdate > 5000) + { + if(dht.read() != DHTLIB_OK) + { + ESP_LOGE("CUD IoT OS", "Failed to read temperature and humidity"); + return; + } + + float temp = dht.getTemperature(); + float hum = dht.getHumidity(); + char buffer[50]; + snprintf(buffer, 50, "%.2f", temp); + espmega.iot->publishRelative("temperature", buffer); + snprintf(buffer, 50, "%.2f", hum); + espmega.iot->publishRelative("humidity", buffer); + lastTempUpdate = millis(); + } + espmega.loop(); +} + +void send_stop_bytes(HardwareSerial &uart) +{ + uart.write(0xFF); + uart.write(0xFF); + uart.write(0xFF); +} + +void handle_input_change(uint8_t pin, bool state) +{ + // Do nothing +} + +void handle_mqtt_message(char *topic, char *payload) +{ + // Do nothing +} \ No newline at end of file diff --git a/src/main.hpp b/src/main.hpp new file mode 100644 index 0000000..717d229 --- /dev/null +++ b/src/main.hpp @@ -0,0 +1,25 @@ +/** + * @file main.cpp + * @author Siwat Sirichai (siwat@siwatinc.com) + * @brief CU Demonstration Secondary School IoT 2024 Project Main File + * @version 1.0 + * @date 2024-03-19 + * + * @copyright Copyright (c) SIWAT SYSTEM 2024 + * + */ +#pragma once +#include +#include +#include +#include +#include "config.hpp" + +/*********************************************** + * Function Prototypes * + ***********************************************/ +void setup(); +void loop(); +void send_stop_bytes(HardwareSerial &uart); +void handle_input_change(uint8_t pin, bool state); +void handle_mqtt_message(char *topic, char *payload); \ No newline at end of file diff --git a/test/README b/test/README new file mode 100644 index 0000000..9b1e87b --- /dev/null +++ b/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PlatformIO Test Runner 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/en/latest/advanced/unit-testing/index.html