web_config.cpp 9.96 KB
Newer Older
1
2
#include "web_config.h"

Eric Duminil's avatar
Eric Duminil committed
3
4
5
6
7
8
9
10
11
12
13
14
#if defined(ESP8266)
#  include <ESP8266WebServer.h>
#elif defined(ESP32)
#  include <WebServer.h>
#endif

#include "config.h"
#include "util.h"
#include "sensor_console.h"
#include <IotWebConf.h>
#include <IotWebConfOptionalGroup.h>

Eric Duminil's avatar
Eric Duminil committed
15
namespace config {
Eric Duminil's avatar
Eric Duminil committed
16
17
18
  using namespace iotwebconf;
  TextTParameter<STRING_LEN> stringParam =
      Builder<TextTParameter<STRING_LEN>>("stringParam").label("String param").build();
Eric Duminil's avatar
Eric Duminil committed
19
20
}

Eric Duminil's avatar
Notes    
Eric Duminil committed
21
22
//TODO: Is there any conflict with SPIFFS/LittleFS?
//TODO: Actually use those parameters
23
24
//TODO: Check memory consumption. Disable DEBUG info?
//TODO: Convert all strings to F-strings
Eric Duminil's avatar
Notes    
Eric Duminil committed
25

26
27
28
29
30
31
32
namespace web_config {
#if defined(ESP8266)
  ESP8266WebServer http(80); // Create a webserver object that listens for HTTP request on port 80
#elif defined(ESP32)
  WebServer http(80);
#endif

Eric Duminil's avatar
Eric Duminil committed
33
  DNSServer dnsServer; //TODO: Check if needed
34
35
36

  IotWebConf *iotWebConf;

Eric Duminil's avatar
Eric Duminil committed
37
  const char config_version[IOTWEBCONF_CONFIG_VERSION_LENGTH] = "a05"; // -- Configuration specific key. The value should be modified if config structure was changed.
38
  using namespace iotwebconf;
39

Eric Duminil's avatar
Eric Duminil committed
40
  /**
Eric Duminil's avatar
Eric Duminil committed
41
   * WiFi params
Eric Duminil's avatar
Eric Duminil committed
42
   */
Eric Duminil's avatar
Eric Duminil committed
43
  CheckboxTParameter ampelWifiParam = Builder<CheckboxTParameter>("WiFi").label("WiFi").defaultValue(true).build();
Eric Duminil's avatar
Eric Duminil committed
44
45
46
  IntTParameter<uint16_t> wifiTimeoutParam =
      Builder<IntTParameter<uint16_t>>("wifi_timeout").label("WiFi timeout").defaultValue(WIFI_TIMEOUT).min(0).placeholder(
          "[s]").build();
Eric Duminil's avatar
Eric Duminil committed
47

Eric Duminil's avatar
Eric Duminil committed
48
49
50
51
  //TODO: Distribute to corresponding classes, possibly with callbacks?
  /**
   * CO2 sensor
   */
Eric Duminil's avatar
Eric Duminil committed
52
  ParameterGroup co2Params = ParameterGroup("co2", "CO2 Sensor"); //TODO: Conflict with labels?
Eric Duminil's avatar
Eric Duminil committed
53
54

  //TODO: UIntTParameter?
Eric Duminil's avatar
Eric Duminil committed
55
56
  IntTParameter<uint16_t> timestepParam =
      Builder<IntTParameter<uint16_t>>("timestep").label("Measurement timestep").defaultValue(MEASUREMENT_TIMESTEP).min(
Eric Duminil's avatar
Eric Duminil committed
57
          2).max(1800).placeholder("[s]").build();
Eric Duminil's avatar
Eric Duminil committed
58

Eric Duminil's avatar
Eric Duminil committed
59
  FloatTParameter temperatureOffsetParam =
Eric Duminil's avatar
Eric Duminil committed
60
      Builder<FloatTParameter>("temp_offset").label("Temperature offset").defaultValue(TEMPERATURE_OFFSET).placeholder(
Eric Duminil's avatar
Eric Duminil committed
61
          "[K]").step(0.1).build();
Eric Duminil's avatar
Eric Duminil committed
62

Eric Duminil's avatar
Eric Duminil committed
63
  IntTParameter<uint16_t> altitudeParam = Builder<IntTParameter<uint16_t>>("altitude").label("Altitude").defaultValue(
Eric Duminil's avatar
Eric Duminil committed
64
  ALTITUDE_ABOVE_SEA_LEVEL).min(0).step(1).placeholder("[m]").build();
Eric Duminil's avatar
Eric Duminil committed
65

Eric Duminil's avatar
Eric Duminil committed
66
67
  IntTParameter<uint16_t> atmosphericCO2Param = Builder<IntTParameter<uint16_t>>("atmospheric_co2").label(
      "Atmospheric CO2 concentration").defaultValue(
Eric Duminil's avatar
Eric Duminil committed
68
  ATMOSPHERIC_CO2_CONCENTRATION).min(400).max(2000).step(1).placeholder("ppm").build();
Eric Duminil's avatar
Eric Duminil committed
69

Eric Duminil's avatar
Eric Duminil committed
70
  CheckboxTParameter autoCalibrateParam = Builder<CheckboxTParameter>("asc").label("Auto-calibration").defaultValue(
Eric Duminil's avatar
Eric Duminil committed
71
  AUTO_CALIBRATE_SENSOR).build();
Eric Duminil's avatar
Eric Duminil committed
72

Eric Duminil's avatar
Eric Duminil committed
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
  /**
   * LED
   */
  ParameterGroup ledParams = ParameterGroup("LED", "LED");

  IntTParameter<uint8_t> maxBrightnessParam =
      Builder<IntTParameter<uint8_t>>("max_brightness").label("Max Brightness").defaultValue(MAX_BRIGHTNESS).min(0).max(
          255).build();
  IntTParameter<uint8_t> minBrightnessParam =
      Builder<IntTParameter<uint8_t>>("min_brightness").label("Min Brightness").defaultValue(MIN_BRIGHTNESS).min(0).max(
          255).build();
  IntTParameter<uint8_t> ledCountParam = Builder<IntTParameter<uint8_t>>("led_count").label("LED ring").defaultValue(
  LED_COUNT).min(12).max(16).step(4).build();

//  #  define HTTP_USER "co2ampel"
//  #  define HTTP_PASSWORD "my_password"

// WARNING: If AMPEL_LORAWAN is enabled, you need to modify the 3 following constants!
// This EUI must be in little-endian format, so least-significant-byte first.
// When copying an EUI from ttnctl output, this means to reverse the bytes.

Eric Duminil's avatar
Eric Duminil committed
94
95
96
  /**
   * CSV
   */
Eric Duminil's avatar
Eric Duminil committed
97
  OptionalParameterGroup csvParams = OptionalParameterGroup("CSV", "CSV", true);
Eric Duminil's avatar
Eric Duminil committed
98

Eric Duminil's avatar
Eric Duminil committed
99
  IntTParameter<uint16_t> csvTimestepParam =
Eric Duminil's avatar
Eric Duminil committed
100
101
      Builder<IntTParameter<uint16_t>>("csv_timestep").label("CSV timestep").defaultValue(CSV_INTERVAL).min(0).step(1).placeholder(
          "[s]").build();
Eric Duminil's avatar
Eric Duminil committed
102
103
104
105

  /**
   * MQTT
   */
Eric Duminil's avatar
Eric Duminil committed
106
  OptionalParameterGroup mqttParams = OptionalParameterGroup("MQTT", "MQTT", true);
Eric Duminil's avatar
Eric Duminil committed
107

Eric Duminil's avatar
Eric Duminil committed
108
109
  IntTParameter<uint16_t> mqttTimestepParam =
      Builder<IntTParameter<uint16_t>>("mqtt_timestep").label("MQTT timestep").defaultValue(
Eric Duminil's avatar
Eric Duminil committed
110
      MQTT_SENDING_INTERVAL).min(0).step(1).defaultValue(300).placeholder("[s]").build();
Eric Duminil's avatar
Eric Duminil committed
111

Eric Duminil's avatar
Eric Duminil committed
112
113
  CheckboxTParameter mqttCommandsParam =
      Builder<CheckboxTParameter>("mqtt_commands").label("MQTT commands").defaultValue(false).build();
Eric Duminil's avatar
Eric Duminil committed
114

Eric Duminil's avatar
Eric Duminil committed
115
116
  TextTParameter<STRING_LEN> mqttServerParam =
      Builder<TextTParameter<STRING_LEN>>("mqtt_server").label("MQTT Server").defaultValue(MQTT_SERVER).build();
Eric Duminil's avatar
Eric Duminil committed
117

Eric Duminil's avatar
Eric Duminil committed
118
119
  IntTParameter<uint16_t> mqttPortParam = Builder<IntTParameter<uint16_t>>("mqtt_port").label("MQTT Port").defaultValue(
  MQTT_PORT).build();
Eric Duminil's avatar
Eric Duminil committed
120

Eric Duminil's avatar
Eric Duminil committed
121
122
  TextTParameter<STRING_LEN> mqttUserParam =
      Builder<TextTParameter<STRING_LEN>>("mqtt_user").label("MQTT User").defaultValue(MQTT_USER).build();
Eric Duminil's avatar
Eric Duminil committed
123

Eric Duminil's avatar
TODO    
Eric Duminil committed
124
  //TODO: Show the number of * for password?
Eric Duminil's avatar
Eric Duminil committed
125
126
  PasswordTParameter<STRING_LEN> mqttPasswordParam = Builder<PasswordTParameter< STRING_LEN>>("mqtt_password").label(
      "MQTT password").defaultValue(MQTT_PASSWORD).build();
Eric Duminil's avatar
Eric Duminil committed
127

Eric Duminil's avatar
Eric Duminil committed
128
129
130
  /**
   * NTP Time
   */
Eric Duminil's avatar
Eric Duminil committed
131

Eric Duminil's avatar
Eric Duminil committed
132
133
134
135
  ParameterGroup timeParams = ParameterGroup("NTP", "Time server");
  TextTParameter<STRING_LEN> ntpParam =
      Builder<TextTParameter< STRING_LEN>>("ntp_server").label("NTP Server").defaultValue(NTP_SERVER).build();
  IntTParameter<int16_t> timeOffsetParam = Builder<IntTParameter<int16_t>>("timezone").label("Timezone").defaultValue(
Eric Duminil's avatar
Eric Duminil committed
136
      (UTC_OFFSET_IN_SECONDS) / 3600).min(-23).max(23).step(1).placeholder("[h]").build();
Eric Duminil's avatar
Eric Duminil committed
137
138
  CheckboxTParameter dstParam =
      Builder<CheckboxTParameter>("dst").label("Daylight Saving Time").defaultValue(false).build();
139

Eric Duminil's avatar
Eric Duminil committed
140
141
142
  /**
   * LED
   */
Eric Duminil's avatar
Eric Duminil committed
143

Eric Duminil's avatar
Eric Duminil committed
144
145
146
  /**
   * LoRa & Stuff
   */
Eric Duminil's avatar
Eric Duminil committed
147
148
149
  OptionalParameterGroup loraParams = OptionalParameterGroup("LoRaWan", "LoRaWan", false);
  IntTParameter<uint16_t> loraTimestepParam =
      Builder<IntTParameter<uint16_t>>("lora_timestep").label("LoRa timestep").defaultValue(
Eric Duminil's avatar
Eric Duminil committed
150
151
152
153
154
155
156
157
      LORAWAN_SENDING_INTERVAL).min(0).step(1).defaultValue(300).placeholder("[s]").build();

  TextTParameter<17> deviceEUIParam = Builder<TextTParameter<17>>("device_eui").label("Device EUI").defaultValue(
      "70B3D5...").build();
  TextTParameter<17> appEUIParam =
      Builder<TextTParameter<17>>("app_eui").label("App EUI").defaultValue("00EA07...").build();
  TextTParameter<32> appKeyParam =
      Builder<TextTParameter<32>>("app_key").label("App key").defaultValue("81CCFE...").build();
158

Eric Duminil's avatar
Eric Duminil committed
159
  OptionalGroupHtmlFormatProvider optionalGroupHtmlFormatProvider;
160
161
162
163
164

  void update() {
    iotWebConf->doLoop(); // Listen for HTTP requests from clients
  }

Eric Duminil's avatar
Eric Duminil committed
165
166
167
168
169
  void setWifiConnectionCallback(void (*function)()) {
    iotWebConf->setWifiConnectionCallback(function);
  }

  void setWifiConnectionFailedCallback(void (*function)()) {
Eric Duminil's avatar
Eric Duminil committed
170
    iotWebConf->setWifiConnectionFailedHandler([&function]() -> WifiAuthInfo* {
Eric Duminil's avatar
Eric Duminil committed
171
172
173
174
175
      function();
      return NULL;
    });
  }

176
177
178
  void initialize() {
    iotWebConf = new IotWebConf(ampel.sensorId, &dnsServer, &http, HTTP_PASSWORD, config_version);

179
180
181
    iotWebConf->setHtmlFormatProvider(&optionalGroupHtmlFormatProvider);

    iotWebConf->addSystemParameter(&ampelWifiParam);
Eric Duminil's avatar
Eric Duminil committed
182
    iotWebConf->addSystemParameter(&wifiTimeoutParam);
Eric Duminil's avatar
Eric Duminil committed
183
184
185

    co2Params.addItem(&timestepParam);
    co2Params.addItem(&temperatureOffsetParam);
Eric Duminil's avatar
Eric Duminil committed
186
187
188
    co2Params.addItem(&altitudeParam);
    co2Params.addItem(&atmosphericCO2Param);
    co2Params.addItem(&autoCalibrateParam);
Eric Duminil's avatar
Eric Duminil committed
189

Eric Duminil's avatar
Eric Duminil committed
190
191
192
193
    ledParams.addItem(&maxBrightnessParam);
    ledParams.addItem(&minBrightnessParam);
    ledParams.addItem(&ledCountParam);

194
195
196
197
    timeParams.addItem(&ntpParam);
    timeParams.addItem(&timeOffsetParam);
    timeParams.addItem(&dstParam);

Eric Duminil's avatar
Eric Duminil committed
198
199
200
201
202
203
204
205
206
    csvParams.addItem(&csvTimestepParam);

    mqttParams.addItem(&mqttTimestepParam);
    mqttParams.addItem(&mqttCommandsParam);
    mqttParams.addItem(&mqttServerParam);
    mqttParams.addItem(&mqttPortParam);
    mqttParams.addItem(&mqttUserParam);
    mqttParams.addItem(&mqttPasswordParam);

Eric Duminil's avatar
Eric Duminil committed
207
    //TODO: Only for ESP32
208
    loraParams.addItem(&loraTimestepParam);
Eric Duminil's avatar
Eric Duminil committed
209
210
211
    loraParams.addItem(&deviceEUIParam);
    loraParams.addItem(&appEUIParam);
    loraParams.addItem(&appKeyParam);
212

Eric Duminil's avatar
Eric Duminil committed
213
    iotWebConf->addParameterGroup(&co2Params);
Eric Duminil's avatar
Eric Duminil committed
214
    iotWebConf->addParameterGroup(&ledParams);
215
    iotWebConf->addParameterGroup(&timeParams);
Eric Duminil's avatar
Eric Duminil committed
216
217
    iotWebConf->addParameterGroup(&csvParams);
    iotWebConf->addParameterGroup(&mqttParams);
218
    iotWebConf->addParameterGroup(&loraParams);
Eric Duminil's avatar
Eric Duminil committed
219
220
221

    sensor_console::defineCommand("reset_config", []() {
      Serial.println(F("Resetting config..."));
Eric Duminil's avatar
Notes    
Eric Duminil committed
222
      //TODO: Reset every group
Eric Duminil's avatar
Eric Duminil committed
223
224
225
226
227
      iotWebConf->getSystemParameterGroup()->applyDefaultValue();
      iotWebConf->saveConfig();
      Serial.println(F("Done!"));
    }, F("(resets the complete IotWeb config)"));

Eric Duminil's avatar
Eric Duminil committed
228
229
230
231
232
233
234
235
    sensor_console::defineStringCommand("conf", [](char *new_value) {
      Serial.print(F("Setting stringParam to "));
      Serial.println(new_value);
      strncpy(config::stringParam.value(), new_value, STRING_LEN);
      Serial.println(F("Done"));
      iotWebConf->saveConfig();
    }, F("some_text (config setter)"));

Eric Duminil's avatar
Eric Duminil committed
236
237
238
239
240
#if !defined(AMPEL_WIFI)
    iotWebConf->loadConfig();
    return;
#endif

241
242
243
244
245
246
247
248
249
    const int ONBOARD_LED_PIN = 2;
# ifdef ESP8266
    iotWebConf->setStatusPin(ONBOARD_LED_PIN, LOW);
# else
    iotWebConf->setStatusPin(ONBOARD_LED_PIN, HIGH);
# endif
    iotWebConf->setWifiConnectionTimeoutMs(1000UL * WIFI_TIMEOUT);

#if defined(ESP8266)
Eric Duminil's avatar
Eric Duminil committed
250
  WiFi.hostname(ampel.sensorId);
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
#elif defined(ESP32)
    WiFi.setHostname(ampel.sensorId);
#endif

    iotWebConf->skipApStartup();
    //TODO: Add callbacks
    //TODO: Add LED effects
    //TODO: Allow offline config loading
    //TODO: Add default values for SSID/password
    //TODO: Add other params
    //TODO: Use HTTP_USER / HTTP_PASSWORD for config
    //TODO: Move to own class
    //TODO: Remove AP Password config?
    //TODO: Save LoRaWAN key if possible?
    //FIXME: Why does MQTT fail? (on ESP32)

    iotWebConf->init();

Eric Duminil's avatar
Eric Duminil committed
269
270
    //TODO: Authenticate only if required?
    //TODO: / captive fast return?
271
272
273
274

    http.on("/config", [] {
      iotWebConf->handleConfig();
    });
Eric Duminil's avatar
Eric Duminil committed
275

276
277
278
279
280
    http.onNotFound([]() {
      iotWebConf->handleNotFound();
    });
  }
}