Skip to content

Commit

Permalink
refactor: total project naming refactor
Browse files Browse the repository at this point in the history 
- update file names to be a consistent snake case
- update folder names to be a consistent lower case
- changed updateCommandHandlers to addAPICommand to be more explicit
- changed userEndpointsVector to custom_html_files to be more explicit

BREAKING CHANGES changed API method names
  • Loading branch information
@ZanzyTHEbar
ZanzyTHEbar committed Jun 21, 2023
1 parent ed4770b commit 39c8722
Show file tree
Hide file tree
Showing 29 changed files with 301 additions and 265 deletions.
50 changes: 48 additions & 2 deletions EasyNetworkManager.code-workspace
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,17 @@
}
],
"settings": {
"cSpell.words": ["successs", "WEBMANAGER"],
"cSpell.words": [
"GIGA",
"MKRWIFI",
"mycommands",
"NICLA",
"PORTENTA",
"SAMD",
"successs",
"txpower",
"WEBMANAGER"
],
"files.associations": {
"*.json.liquid": "json",
"*.yaml.liquid": "yaml",
Expand Down Expand Up @@ -70,7 +80,43 @@
"stdexcept": "cpp",
"streambuf": "cpp",
"cinttypes": "cpp",
"typeinfo": "cpp"
"typeinfo": "cpp",
"bit": "cpp",
"charconv": "cpp",
"chrono": "cpp",
"compare": "cpp",
"concepts": "cpp",
"condition_variable": "cpp",
"coroutine": "cpp",
"format": "cpp",
"forward_list": "cpp",
"ios": "cpp",
"list": "cpp",
"locale": "cpp",
"mutex": "cpp",
"queue": "cpp",
"ranges": "cpp",
"ratio": "cpp",
"span": "cpp",
"stack": "cpp",
"stop_token": "cpp",
"thread": "cpp",
"xfacet": "cpp",
"xhash": "cpp",
"xiosbase": "cpp",
"xlocale": "cpp",
"xlocbuf": "cpp",
"xlocinfo": "cpp",
"xlocmes": "cpp",
"xlocmon": "cpp",
"xlocnum": "cpp",
"xloctime": "cpp",
"xmemory": "cpp",
"xstddef": "cpp",
"xstring": "cpp",
"xtr1common": "cpp",
"xtree": "cpp",
"xutility": "cpp"
}
}
}
221 changes: 161 additions & 60 deletions NetworkManager/examples/customHTML.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@
// with an asterisk (*)

//! Optional header files
#include <network/mDNS/MDNSManager.hpp>
#include <network/ota/OTA.hpp>
#include <network/mdns/mdns_manager.hpp>
#include <network/ota/basic_ota.hpp>
#include <utilities/network_utilities.hpp> // various network utilities
// (unique_ptr) to create unique objects
// #include <utilities/Observer.hpp>
// #include <utilities/api_utilities.hpp>
// #include <utilities/enuminheritance.hpp> // used for extending enums with new
Expand All @@ -19,41 +20,174 @@
//! Required header files
#include <EasyNetworkManager.h> // (*)

ProjectConfig configManager;
WiFiHandler network(&configManager, &wifiStateManager, "", "", 1);
// Note: The Project Config Manager is used to store and retrieve the
// configuration
// data ? The config manager constructor takes two (optional) parameters: ? 1.
// The name of the project (used to create the config file name) ? 2. The
// hostname for your device on the network(used for mDNS, OTA, etc.)
ProjectConfig configManager("easynetwork", MDNS_HOSTNAME);
ConfigHandler configHandler(configManager);

APIServer server(80, &configManager, "/api/v1", "/wifimanager",
"/userCommands");
OTA ota(&configManager); //! Second argument is the Hostname for OTA
MDNSHandler mDNS(&mdnsStateManager, &configManager, "_easynetwork", "test",
"_tcp", "_api_port",
"80"); //! service name and service protocol have to be
//! lowercase and begin with an underscore
// Note: The WiFi Handler is used to manage the WiFi connection
// Note: The WiFi Handler constructor takes four parameters:
// Note: 1. A pointer to the config manager
// Note: 2. A pointer to the WiFi State Manager
// Note: 3. The SSID of the WiFi network to connect to
// Note: 4. The password of the WiFi network to connect to
WiFiHandler network(configManager, WIFI_SSID, WIFI_PASSWORD, 1);

// Note: The API Server is used to create a web server that can be used to send
// commands to the device ? The API Server constructor takes five parameters:
// Note: 1. The port number to use for the web server
// Note: 2. A pointer to the config manager
// Note: 3. The root path for the API
// Note: 4. The path for the WiFi Manager html page
// Note: 5. The root path for the user commands for the API
// Note: This file example will create a web server on port 80, with the root
// path:
// http://easynetwork.local/api/mycommands/command/helloWorld
// http://easynetwork.local/api/mycommands/command/blink
// http://easynetwork.local/api/mycommands/command/params?Axes1=1&Axes2=2
APIServer server(80, configManager, "/api", "/wifimanager", "/mycommands");
OTA ota(configManager);

// Note: The mDNS Manager is used to create a mDNS service for the device
// Note: The mDNS Manager constructor takes seven parameters:
// Note: 1. A pointer to the mDNS State Manager
// Note: 2. A pointer to the config manager
// Note: 3. The service name
// Note: 4. The service instance name
// Note: 5. The service protocol
// Note: 6. The service description
// Note: 7. The service port

//! service name and service protocol have to be
//! lowercase and begin with an underscore
MDNSHandler mDNS(configManager, "_easynetwork", "test", "_tcp", "_api_port",
"80");

class CustomConfig : public CustomConfigInterface {
void save() override {
Serial.println("Saving custom config");
}

void load() override {
Serial.println("Loading custom config");
}
};

CustomConfig customConfig;

class Temp {
public:
Temp() {
Serial.println("Temp created");
}
~Temp() {
Serial.println("Temp destroyed");
}
// Note: Here is a function that can be used to handle custom API requests
// inside Note: of a class
void grabParams(AsyncWebServerRequest* request) {
int params = request->params();
log_d("Number of Params: %d", params);
std::string y;
std::string x;
for (int i = 0; i < params; i++) {
AsyncWebParameter* param = request->getParam(i);
if (param->name() == "Axes1") {
x = param->value().c_str();
} else if (param->name() == "Axes2") {
y = param->value().c_str();
}
}
Serial.printf("Axes1: %s, Axes2: %s\n", x.c_str(), y.c_str());
request->send(200, "text/plain", "OK");
}
};

// Note: Here is a function that can be used to handle custom API requests
void grabParams(AsyncWebServerRequest* request) {
int params = request->params();
std::string axes1;
std::string axes2;

for (int i = 0; i < params; i++) {
AsyncWebParameter* param = request->getParam(i);
if (param->name() == "Axes1") {
axes1 = param->value().c_str();
} else if (param->name() == "Axes2") {
axes2 = param->value().c_str();
}
}
int ax1 = atoi(axes1.c_str());
int ax2 = atoi(axes2.c_str());
int ax5 = ax1 - ax2;
int ax6 = ax1 + ax2;
Serial.printf("Axes1: %d, Axes2: %d\n", ax1, ax2);
request->send(200, "text/plain", "OK");
}

// Note: Here are two functions that can be used to handle custom API requests
void printHelloWorld(AsyncWebServerRequest* request) {
Serial.println("Hello World!");
request->send(200, "text/plain", "Hello World!");
}

void blink(AsyncWebServerRequest* request) {
digitalWrite(27, HIGH);
Network_Utilities::my_delay(0.5); // delay for 500ms
digitalWrite(27, LOW);
Network_Utilities::my_delay(0.5); // delay for 500ms
digitalWrite(4, HIGH);
Network_Utilities::my_delay(1); // delay for 1sec
digitalWrite(4, LOW);
Network_Utilities::my_delay(1); // delay for 1sec
request->send(200, "text/plain", "Blink!");
}

void setupServer() {
// add command handlers to the API server
// you can add as many as you want - you can also add methods.
log_d("[SETUP]: Starting API Server");

// This is an example of how to add a custom html file to the web server
// Note: The first parameter is the url endpoint to access the file
// Note: The second parameter is the path to the file on the SPIFFS
// Note: The third parameter is the HTTP method to use to access the file
server.custom_html_files.emplace_back("/hello", "/helloWorld.html", "GET");
server.custom_html_files.emplace_back("/goodbye", "/goodbye.html", "POST");

// Note: This is an example of how to add a custom API commands
// Note: The first parameter is the url endpoint
// Note: The second parameter is the function to call

// Note: The function can be a lambda function or a normal function
server.addAPICommand("blink", blink);
server.addAPICommand("helloWorld", printHelloWorld);
server.addAPICommand("params", grabParams);
server.addAPICommand("paramsClass", [&](AsyncWebServerRequest* request) {
Temp t;
t.grabParams(request);
});
server.begin();
log_d("[SETUP]: API Server Started");
}

void setup() {
Serial.begin(115200);
Serial.println("Hello, EasyNetworkManager!");
pinMode(4, OUTPUT);
Serial.println("\nHello, EasyNetworkManager!");

configManager.attach(configHandler);
//* Optionally register a custom config - this will be saved and loaded
configManager.registerUserConfig(&customConfig);
configManager.attach(network);
configManager.attach(
&mDNS); // attach the config manager to the mdns object - this will
// update the config when mdns hostname changes
configManager.load(); // load the config from flash
mDNS); // attach the config manager to the mdns object - this will
// update the config when mdns hostname changes

network.begin(); // setup wifi connection
mDNS.begin(); // start mDNS service (optional)
configHandler.begin(); // load the config from flash
network.begin(); // setup wifi connection
mDNS.begin(); // start mDNS service (optional)

// handle the WiFi connection state changes
// only start the API server if we have wifi connection
switch (wifiStateManager.getCurrentState()) {
case WiFiState_e::WiFiState_Disconnected: {
break;
Expand All @@ -62,46 +196,13 @@ void setup() {
break;
}
case WiFiState_e::WiFiState_ADHOC: {
// you can add as many as you want
// The first argument is the route name
// The second argument is the path to the html file to be served
// The third argument is the request method (GET, POST, PUT, DELETE,
// PATCH, OPTIONS)
server.userEndpointsVector.emplace_back(
"/hello", "/helloWorld.html",
"GET"); // add a user endpoint to the vector
server.userEndpointsVector.emplace_back(
"/goodbye", "/goodbye.html",
"POST"); // add a second user endpoint to the vector

server.updateCommandHandlers(
"blink",
blink); // add a command handler to the API server - you can
// add as many as you want - you can also add methods.
server.updateCommandHandlers(
"helloWorld", printHelloWorld); // add a second command handler
// to the API server
log_d("[SETUP]: Starting API Server");
server.begin(); // start the API server
// only start the API server if we have AP connection
setupServer();
break;
}
case WiFiState_e::WiFiState_Connected: {
server.userEndpointsVector.emplace_back(
"/hello", "/helloWorld.html",
"GET"); // add a user endpoint to the vector
server.userEndpointsVector.emplace_back(
"/goodbye", "/goodbye.html",
"POST"); // add a second user endpoint to the vector

server.updateCommandHandlers(
"blink",
blink); // add a command handler to the API server - you can
// add as many as you want - you can also add methods.
server.updateCommandHandlers(
"helloWorld", printHelloWorld); // add a second command handler
// to the API server
server.begin(); // start the API server
log_d("[SETUP]: Starting API Server");
// only start the API server if we have wifi connection
setupServer();
break;
}
case WiFiState_e::WiFiState_Connecting: {
Expand All @@ -116,4 +217,4 @@ void setup() {

void loop() {
ota.handleOTAUpdate();
}
}
Loading

0 comments on commit 39c8722

Please sign in to comment.