.pio | |||||
.vscode/.browse.c_cpp.db* | |||||
.vscode/c_cpp_properties.json | |||||
.vscode/launch.json | |||||
.vscode/ipch | |||||
include/wifi_credentials.h |
{ | |||||
// See http://go.microsoft.com/fwlink/?LinkId=827846 | |||||
// for the documentation about the extensions.json format | |||||
"recommendations": [ | |||||
"platformio.platformio-ide" | |||||
] | |||||
} |
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 |
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 <Foo.h> | |||||
#include <Bar.h> | |||||
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 |
; 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:esp01_1m] | |||||
platform = espressif8266 | |||||
board = esp01_1m | |||||
framework = arduino | |||||
#include <Arduino.h> | |||||
#include <ESP8266WiFi.h> | |||||
#include <ESP8266mDNS.h> | |||||
#include <WiFiUdp.h> | |||||
#include <ArduinoOTA.h> | |||||
#include <WiFiClient.h> | |||||
#include <ESP8266WebServer.h> | |||||
#include <ESP8266mDNS.h> | |||||
#include "wifi_credentials.h" | |||||
const char* ssid = STASSID; | |||||
const char* password = STAPSK; | |||||
const int led = 13; | |||||
ESP8266WebServer server(80); | |||||
void handleRoot() { | |||||
digitalWrite(led, 1); | |||||
char temp[400]; | |||||
int sec = millis() / 1000; | |||||
int min = sec / 60; | |||||
int hr = min / 60; | |||||
snprintf(temp, 400, | |||||
"<html>\ | |||||
<head>\ | |||||
<meta http-equiv='refresh' content='5'/>\ | |||||
<title>ESP8266 Demo</title>\ | |||||
<style>\ | |||||
body { background-color: #cccccc; font-family: Arial, Helvetica, Sans-Serif; Color: #000088; }\ | |||||
</style>\ | |||||
</head>\ | |||||
<body>\ | |||||
<h1>Hello from ESP8266!</h1>\ | |||||
<p>Uptime: %02d:%02d:%02d</p>\ | |||||
<img src=\"/test.svg\" />\ | |||||
</body>\ | |||||
</html>", | |||||
hr, min % 60, sec % 60 | |||||
); | |||||
server.send(200, "text/html", temp); | |||||
digitalWrite(led, 0); | |||||
} | |||||
void handleNotFound() { | |||||
digitalWrite(led, 1); | |||||
String message = "File Not Found\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 += " " + server.argName(i) + ": " + server.arg(i) + "\n"; | |||||
} | |||||
server.send(404, "text/plain", message); | |||||
digitalWrite(led, 0); | |||||
} | |||||
void setup_webserver() { | |||||
pinMode(led, OUTPUT); | |||||
digitalWrite(led, 0); | |||||
Serial.println(""); | |||||
// Wait for connection | |||||
while (WiFi.status() != WL_CONNECTED) { | |||||
delay(500); | |||||
Serial.print("."); | |||||
} | |||||
Serial.println(""); | |||||
Serial.print("Connected to "); | |||||
Serial.println(ssid); | |||||
Serial.print("IP address: "); | |||||
Serial.println(WiFi.localIP()); | |||||
if (MDNS.begin("esp8266")) { | |||||
Serial.println("MDNS responder started"); | |||||
} | |||||
server.on("/", handleRoot); | |||||
server.on("/inline", []() { | |||||
server.send(200, "text/plain", "this works as well"); | |||||
}); | |||||
server.onNotFound(handleNotFound); | |||||
server.begin(); | |||||
Serial.println("HTTP server started"); | |||||
} | |||||
void setup() { | |||||
Serial.begin(115200); | |||||
Serial.println("Booting"); | |||||
WiFi.mode(WIFI_STA); | |||||
WiFi.begin(ssid, password); | |||||
while (WiFi.waitForConnectResult() != WL_CONNECTED) { | |||||
Serial.println("Connection Failed! Rebooting..."); | |||||
delay(5000); | |||||
ESP.restart(); | |||||
} | |||||
// Port defaults to 8266 | |||||
// ArduinoOTA.setPort(8266); | |||||
// Hostname defaults to esp8266-[ChipID] | |||||
ArduinoOTA.setHostname("myesp8266"); | |||||
// No authentication by default | |||||
// ArduinoOTA.setPassword("admin"); | |||||
// Password can be set with it's md5 value as well | |||||
// MD5(admin) = 21232f297a57a5a743894a0e4a801fc3 | |||||
// ArduinoOTA.setPasswordHash("21232f297a57a5a743894a0e4a801fc3"); | |||||
ArduinoOTA.onStart([]() { | |||||
String type; | |||||
if (ArduinoOTA.getCommand() == U_FLASH) { | |||||
type = "sketch"; | |||||
} else { // U_FS | |||||
type = "filesystem"; | |||||
} | |||||
// NOTE: if updating FS this would be the place to unmount FS using FS.end() | |||||
Serial.println("Start updating " + type); | |||||
}); | |||||
ArduinoOTA.onEnd([]() { | |||||
Serial.println("\nEnd"); | |||||
}); | |||||
ArduinoOTA.onProgress([](unsigned int progress, unsigned int total) { | |||||
Serial.printf("Progress: %u%%\r", (progress / (total / 100))); | |||||
}); | |||||
ArduinoOTA.onError([](ota_error_t error) { | |||||
Serial.printf("Error[%u]: ", error); | |||||
if (error == OTA_AUTH_ERROR) { | |||||
Serial.println("Auth Failed"); | |||||
} else if (error == OTA_BEGIN_ERROR) { | |||||
Serial.println("Begin Failed"); | |||||
} else if (error == OTA_CONNECT_ERROR) { | |||||
Serial.println("Connect Failed"); | |||||
} else if (error == OTA_RECEIVE_ERROR) { | |||||
Serial.println("Receive Failed"); | |||||
} else if (error == OTA_END_ERROR) { | |||||
Serial.println("End Failed"); | |||||
} | |||||
}); | |||||
ArduinoOTA.begin(); | |||||
Serial.println("Ready"); | |||||
Serial.print("IP address: "); | |||||
Serial.println(WiFi.localIP()); | |||||
setup_webserver(); | |||||
} | |||||
void loop() { | |||||
ArduinoOTA.handle(); | |||||
server.handleClient(); | |||||
} |
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 |