From c379da94c1f4c823248d5b865a2e75522509aa3e Mon Sep 17 00:00:00 2001 From: Jarda Date: Mon, 21 Aug 2023 15:30:52 +0200 Subject: [PATCH] Add SD webpage example - wifi, platformio --- SW/ESPlan_SD_webpage/.gitignore | 5 + SW/ESPlan_SD_webpage/.vscode/extensions.json | 10 ++ SW/ESPlan_SD_webpage/include/README | 39 ++++++ SW/ESPlan_SD_webpage/index.htm | 10 ++ SW/ESPlan_SD_webpage/lib/README | 46 ++++++ SW/ESPlan_SD_webpage/platformio.ini | 15 ++ SW/ESPlan_SD_webpage/src/main.cpp | 139 +++++++++++++++++++ SW/ESPlan_SD_webpage/test/README | 11 ++ 8 files changed, 275 insertions(+) create mode 100644 SW/ESPlan_SD_webpage/.gitignore create mode 100644 SW/ESPlan_SD_webpage/.vscode/extensions.json create mode 100644 SW/ESPlan_SD_webpage/include/README create mode 100644 SW/ESPlan_SD_webpage/index.htm create mode 100644 SW/ESPlan_SD_webpage/lib/README create mode 100644 SW/ESPlan_SD_webpage/platformio.ini create mode 100644 SW/ESPlan_SD_webpage/src/main.cpp create mode 100644 SW/ESPlan_SD_webpage/test/README diff --git a/SW/ESPlan_SD_webpage/.gitignore b/SW/ESPlan_SD_webpage/.gitignore new file mode 100644 index 0000000..89cc49c --- /dev/null +++ b/SW/ESPlan_SD_webpage/.gitignore @@ -0,0 +1,5 @@ +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch diff --git a/SW/ESPlan_SD_webpage/.vscode/extensions.json b/SW/ESPlan_SD_webpage/.vscode/extensions.json new file mode 100644 index 0000000..080e70d --- /dev/null +++ b/SW/ESPlan_SD_webpage/.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/SW/ESPlan_SD_webpage/include/README b/SW/ESPlan_SD_webpage/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/SW/ESPlan_SD_webpage/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/SW/ESPlan_SD_webpage/index.htm b/SW/ESPlan_SD_webpage/index.htm new file mode 100644 index 0000000..30b1916 --- /dev/null +++ b/SW/ESPlan_SD_webpage/index.htm @@ -0,0 +1,10 @@ + + + + Web page + + +

Hello, world!

+

This is example web page.

+ + \ No newline at end of file diff --git a/SW/ESPlan_SD_webpage/lib/README b/SW/ESPlan_SD_webpage/lib/README new file mode 100644 index 0000000..6debab1 --- /dev/null +++ b/SW/ESPlan_SD_webpage/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/SW/ESPlan_SD_webpage/platformio.ini b/SW/ESPlan_SD_webpage/platformio.ini new file mode 100644 index 0000000..457ca3e --- /dev/null +++ b/SW/ESPlan_SD_webpage/platformio.ini @@ -0,0 +1,15 @@ +; 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:esp32dev] +platform = espressif32 +board = esp32dev +framework = arduino +monitor_speed = 115200 diff --git a/SW/ESPlan_SD_webpage/src/main.cpp b/SW/ESPlan_SD_webpage/src/main.cpp new file mode 100644 index 0000000..22fc02e --- /dev/null +++ b/SW/ESPlan_SD_webpage/src/main.cpp @@ -0,0 +1,139 @@ +/* Webserver SD webpage example for LaskaKit ESPlan + * Place index.htm file on SD card or create your own html example, rename it to index.htm and place it on SD card + * After boot connect to http://esplan.local or to IP adress of ESP32 (for example 192.168.0.98) + * You should see webpage saved on SD card + * Email:podpora@laskakit.cz + * Web:laskakit.cz + */ + +#include +#include +#include +#include +#include +#include +#include + +const char *ssid = "WiFi_6"; +const char *password = "WiFiBurian6"; +const char *host = "esplan"; + +// SD card defines +#define SCK 14 +#define MISO 12 +#define MOSI 13 +#define CS 15 +SPIClass spi = SPIClass(HSPI); + +WebServer server(80); + +void handleNotFound() +{ + String message = "SD card or index.htm file not detected\n\n"; + message += "URI: "; + message += server.uri(); + message += "\nMethod: "; + message += (server.method() == HTTP_GET) ? "GET" : "POST"; + message += "\nArguments: "; + message += server.args(); + message += "\n"; + for (uint8_t i = 0; i < server.args(); i++) + { + message += " NAME:" + server.argName(i) + "\n VALUE:" + server.arg(i) + "\n"; + } + server.send(404, "text/plain", message); + Serial.print(message); +} + +void handleRoot() +{ + spi.begin(SCK, MISO, MOSI, CS); + if (SD.begin(CS, spi)) + { + Serial.println("SD Card initialized."); + } + else + { + handleNotFound(); + return; + } + File dataFile = SD.open("/index.htm"); + + if (!dataFile) + { + SD.end(); + spi.end(); + handleNotFound(); + return; + } + + if (server.streamFile(dataFile, "text/html") != dataFile.size()) + { + Serial.println("Sent less data than expected!"); + } + + dataFile.close(); + SD.end(); + spi.end(); +} + +void wifi_setup() +{ + uint8_t i = 0; + WiFi.mode(WIFI_STA); + WiFi.begin(ssid, password); + Serial.print("Connecting to "); + Serial.println(ssid); + // Wait for connection + while (WiFi.status() != WL_CONNECTED && i++ < 20) + { + Serial.print("."); + delay(500); + } + if (i == 21) + { + Serial.print("\n"); + Serial.print("Could not connect to "); + Serial.println(ssid); + while (1) + { + delay(500); + } + } + Serial.print("\n"); + Serial.print("Connected! IP address: "); + Serial.println(WiFi.localIP()); +} + +void DNS_setup() +{ + if (MDNS.begin(host)) + { + MDNS.addService("http", "tcp", 80); + Serial.println("MDNS responder started"); + Serial.print("You can now connect to http://"); + Serial.print(host); + Serial.println(".local"); + } +} + +void setup(void) +{ + Serial.begin(115200); + Serial.print("\n"); + + wifi_setup(); + DNS_setup(); + + server.on("/", handleRoot); // Main page + server.onNotFound(handleNotFound); + + server.begin(); + Serial.println("HTTP server started"); +} + +void loop(void) +{ + server.handleClient(); + delay(2); // allow the cpu to switch to other tasks +} \ No newline at end of file diff --git a/SW/ESPlan_SD_webpage/test/README b/SW/ESPlan_SD_webpage/test/README new file mode 100644 index 0000000..9b1e87b --- /dev/null +++ b/SW/ESPlan_SD_webpage/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