From 9c0a1c6055f6c0d6c3231f55d51780f0e14f5eab Mon Sep 17 00:00:00 2001 From: Bram Prieshof Date: Sun, 6 Aug 2023 16:45:16 +0200 Subject: [PATCH] Initial commit --- .gitignore | 5 +++++ .vscode/extensions.json | 10 +++++++++ .vscode/tasks.json | 30 +++++++++++++++++++++++++++ include/README | 39 ++++++++++++++++++++++++++++++++++ lib/README | 46 +++++++++++++++++++++++++++++++++++++++++ platformio.ini | 25 ++++++++++++++++++++++ src/main.cpp | 44 +++++++++++++++++++++++++++++++++++++++ test/README | 11 ++++++++++ 8 files changed, 210 insertions(+) create mode 100644 .gitignore create mode 100644 .vscode/extensions.json create mode 100644 .vscode/tasks.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/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..428024c --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,30 @@ +{ + // See https://go.microsoft.com/fwlink/?LinkId=733558 + // for the documentation about the tasks.json format + "version": "2.0.0", + "tasks": [ + { + "label": "Erase,Upload,Monitor", + "type": "shell", + "command": "PioExec=~/.platformio/penv/bin/pio; $PioExec run -t erase -e ${input:TargetPlatform} && $PioExec run -t upload -e ${input:TargetPlatform} && $PioExec run -t monitor -e ${input:TargetPlatform}", + "problemMatcher": [], + "group": { + "kind": "build", + "isDefault": true + } + } + ], + "inputs": [ + { + "type": "pickString", + "id": "TargetPlatform", + "description": "Wich platform is used?", + "options": [ + "ESP8266", + "ESP32s" + ], + "default": "ESP8266" + }, + ] +} + 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..9daecb4 --- /dev/null +++ b/platformio.ini @@ -0,0 +1,25 @@ +; 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] +monitor_speed = 115200 + +[env:ESP8266] +platform = espressif8266 +board = esp01_1m +framework = arduino +upload_resetmethod = nodemcu +build_flags = -D ESP8266_BOARD + +[env:ESP32s] +platform = espressif32 +board = node32s +framework = arduino +build_flags = -D ESP32n_BOARDder \ No newline at end of file diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..8a39df0 --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,44 @@ +#include +#ifdef ESP8266_BOARD + #include + #define LedBuildIn 2 //Define buildin led +#endif +#ifdef ESP32_BOARD + #define LedBuildIn 2 //Define buildin led + #include +#endif + + +void WifiScan(){ + WiFi.mode(WIFI_STA); + WiFi.disconnect(); + delay(100); + Serial.println("Scanning Wifi..."); //Send text over serial + int n = WiFi.scanNetworks(); + Serial.print(n); + Serial.println(" network(s) found"); + for (int i = 0; i < n; i++) + { + Serial.println(WiFi.SSID(i)); + } + Serial.println(""); + delay(1500); +} + +void setup() { + pinMode(LedBuildIn, OUTPUT); //Setup Led + Serial.begin(115200); //Setup serial + Serial.println("Initializing..."); //Send text over serial + delay(1500); // wait for a second + Serial.println("Hello from ESP"); //Send text over serial + WifiScan(); +} + +void loop() { + digitalWrite(LedBuildIn, HIGH); // turn the LED on + Serial.println("Ping"); //Send text over serial + delay(1000); // wait for a second + digitalWrite(LedBuildIn, LOW); // turn the LED off + Serial.println("Pong"); //Send text over serial + delay(1000); // wait for a second +} \ No newline at end of file diff --git a/test/README b/test/README new file mode 100644 index 0000000..b94d089 --- /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