From c063391ab620846efc0de4ccf5bd1cec26952b9e Mon Sep 17 00:00:00 2001 From: kicap Date: Thu, 15 Jun 2023 23:42:56 +0800 Subject: [PATCH] first commit --- .gitignore | 5 ++++ .vscode/extensions.json | 10 +++++++ include/README | 39 +++++++++++++++++++++++++ lib/README | 46 +++++++++++++++++++++++++++++ platformio.ini | 18 ++++++++++++ src/main.cpp | 64 +++++++++++++++++++++++++++++++++++++++++ test/README | 11 +++++++ 7 files changed, 193 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..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/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..2c2b55a --- /dev/null +++ b/platformio.ini @@ -0,0 +1,18 @@ +; 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 +lib_deps = + arduino-libraries/NTPClient@^3.2.1 + arduino-libraries/ArduinoHttpClient@^0.4.0 + arduino-libraries/Arduino_JSON@^0.2.0 diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..40e632d --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,64 @@ +#include +#include +#include +#include +#include +#include + +const char *ssid = "KARAN"; +const char *password = "12345679"; + +ESP8266WebServer server(80); + +int GPIO_pin = D5; + +bool relayState = false; + +void handleRoot() { + server.send(200, "text/plain", "Hello from ESP8266!"); +} + +void handleRelayOn() { + digitalWrite(GPIO_pin, HIGH); + relayState = true; + JSONVar response; + response["status"] = "success"; + response["message"] = "Relay turned on"; + String jsonString = JSON.stringify(response); + server.send(200, "application/json", jsonString); + +} + +void handleRelayOff() { + digitalWrite(GPIO_pin, LOW); + relayState = false; + JSONVar response; + response["status"] = "success"; + response["message"] = "Relay turned off"; + String jsonString = JSON.stringify(response); + server.send(200, "application/json", jsonString); +} + +void setup() { + Serial.begin(9600); + pinMode(LED_BUILTIN, OUTPUT); // Set the built-in LED pin as an output + digitalWrite(LED_BUILTIN, HIGH); // Turn the LED on + pinMode(GPIO_pin, OUTPUT); // Set the GPIO pin as an output + WiFi.begin(ssid, password); + while (WiFi.status() != WL_CONNECTED) { + delay(1000); + Serial.println("Connecting to WiFi..."); + } + Serial.println("Connected to WiFi"); + // check the IP address + Serial.println(WiFi.localIP()); + digitalWrite(LED_BUILTIN, LOW); // Turn the LED off + server.on("/", handleRoot); + server.on("/relay/on", handleRelayOn); + server.on("/relay/off", handleRelayOff); + server.begin(); +} + +void loop() { + server.handleClient(); +} \ 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