Skip to content

Implement RESET Server using Arduino on ESP32 board

Using esp32 board with arduino platform to create REST server

BOM
esp32 seeed_xiao_esp32s3

init project

1
2
3
4
5
[env:seeed_xiao_esp32]
platform = espressif32
board = seeed_xiao_esp32s3
framework = arduino
lib_deps = bblanchon/ArduinoJson@^7.3.0

init vscode project

Create vscode c_cpp_properties.json for declared board in the platformio.ini files

1
pio init --ide vscode

Install libraries

1
pio lib install bblanchon/ArduinoJson@^7.3.0

REST App

  • Simple code that init the wifi and create GET REST api getValues that return json
code 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
#include <Arduino.h>
#include <WiFi.h>
#include <WebServer.h>
#include <ArduinoJson.h>

#pragma region consts
const char* ssid = "xxx";
const char* password = "xxxx";
#pragma endregion

#pragma region globals
WebServer server(80);
StaticJsonDocument<1024> jsonDocument;
char buffer[1024];
#pragma endregion

#pragma region REST API
void getValues(){
  Serial.println("get all values");
  jsonDocument.clear();
    jsonDocument["name"] = "hello";
  serializeJson(jsonDocument, buffer);
    server.send(200, "application/json", buffer);
}
void setupApi() {
  server.on("/getValues", getValues);
  // server.on("/setStatus", HTTP_POST, handlePost);

  // start server
  server.begin();
}

#pragma endregion REST API

#pragma region init
void initWiFi() {
  WiFi.mode(WIFI_STA);
  WiFi.begin(ssid, password);
  Serial.print("Connecting to WiFi ..");
  while (WiFi.status() != WL_CONNECTED) {
    Serial.println(".!");
    delay(1000);
  }
  Serial.println(WiFi.localIP());

}
#pragma endregion

void setup() {
  Serial.begin(115200);
  initWiFi();
  Serial.print("RRSI: ");
  Serial.println(WiFi.RSSI());
  setupApi();
}

void loop() {
  server.handleClient();
}

build and upload

1
2
3
4
5
# build
pio run

# upload
pio run --target upload

usage

1
http://10.100.102.24/getValues

Add POST

Post 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
void handlePost() {
  if (server.hasArg("plain")) {  // Check if there is a body
      String message = server.arg("plain");  // Get POST body
      deserializeJson(jsonDocument, message);
      Serial.println("Received POST Data: " + message);
      Serial.println("Received json Data: " + String((const char*)jsonDocument["cmd"]));
      server.send(HTTP_OK, CONTENT_TYPE, "{\"status\":\"success\"}");
  } else {
      server.send(HTTP_ERROR, "text/plain", "Bad Request");
  }
}

void setupApi() {
    server.on("/getValues", getValues);
    server.on("/setStatus", HTTP_POST, handlePost);

    server.begin();
}

usage

1
2
3
4
5
6
curl -X POST http://10.100.102.24/setStatus \
     -H "Content-Type: application/json" \
     -d '{"cmd": "value"}'

# result
{"status":"success"}(venv)

Reference