CropIoT Device Settings Library

This a Arduino/NodeMCU compatible library to provide device settings setup out of the box through a REST API and SPA UI.

Installation using PlatformIO:

Add library dependency at platformio.ini file:

lib_deps =
  https://github.com/rrgarciach/cropiot-device-settings.git

Add include line in your main.cpp:

#include "CropIoTDeviceSettings.h"

Declare the name of your device inside setup(). This name will be used as the Access Point name as well:

void setup() {
  DEVICE_TYPE = "my_device_name";
  ...

Start Serial and run function to connect WiFi inside setup():

  Serial.begin(115200);
  Serial.println("Starting...");

  connectWiFi();

Generate any required WLAN:

  wlanClient1 = generateWiFiClient();
  connectMQTT(mqttClient1);

Add any required device custom endpoints as /include/device_endpoints.h (and include them using #include "../include/device_endpoints.h") with content similar as follows:

#ifndef DEVICE_ENDPOINTS_H_
#define DEVICE_ENDPOINTS_H_

// Device setup endpoints
struct {
  struct {
    struct  {
      const char* PH_CALIBRATE = "/api/device/ph/calibrate";
      const char* EC_CALIBRATE = "/api/device/ec/calibrate";
    } DEVICE;
  } API;
} DEVICE_URLS;

#endif

Implement function to load device endpoints:

void loadDeviceEndpoints() {
  server.on(DEVICE_URLS.API.DEVICE.PH_CALIBRATE, HTTP_GET, [&](AsyncWebServerRequest *request){
    AsyncResponseStream *response = request->beginResponseStream("application/json");
    DynamicJsonBuffer jsonBuffer;
    JsonObject &root = jsonBuffer.createObject();
    root["value"] = avgValue;
    root.printTo(*response);
    request->send(response);
  });
  server.on(DEVICE_URLS.API.DEVICE.PH_CALIBRATE, HTTP_POST, [&](AsyncWebServerRequest *request){
    if(request->hasParam("ph4Reading", true) && request->hasParam("ph7Reading", true)) {
      const String ph4Reading = request->getParam("ph4Reading", true)->value().c_str();
      const String ph7Reading = request->getParam("ph7Reading", true)->value().c_str();
      writeMem(PH4_READING_MEM_ADDR, ph4Reading);
      writeMem(PH7_READING_MEM_ADDR, ph7Reading);
      slope = calcSlope();
      intercept = calcIntercept();
      request->send(200);
    } else {
      request->send(400);
    }
  });
}

Call loadDeviceEndpoints on setup:

// setup()
connectMQTT();
loadDeviceEndpoints();

Dependencies

Additional hints

To upload static files from /data directory simply run: pio run -t uploadfs

Additional documentation

https://github.com/esp8266/Arduino/blob/master/doc/esp8266wifi/station-class.rst https://github.com/knolleary/pubsubclient/blob/master/examples/mqtt_esp8266/mqtt_esp8266.ino