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

Eric Duminil's avatar
Eric Duminil committed
3
namespace config {
Eric Duminil's avatar
Eric Duminil committed
4
5
6
  using namespace iotwebconf;
  TextTParameter<STRING_LEN> stringParam =
      Builder<TextTParameter<STRING_LEN>>("stringParam").label("String param").build();
Eric Duminil's avatar
Eric Duminil committed
7
8
}

Eric Duminil's avatar
Notes    
Eric Duminil committed
9
10
//TODO: Is there any conflict with SPIFFS/LittleFS?
//TODO: Actually use those parameters
11
12
//TODO: Check memory consumption. Disable DEBUG info?
//TODO: Convert all strings to F-strings
Eric Duminil's avatar
Notes    
Eric Duminil committed
13

14
15
16
17
18
19
20
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
21
  DNSServer dnsServer; //TODO: Check if needed
22
23
24

  IotWebConf *iotWebConf;

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

Eric Duminil's avatar
Eric Duminil committed
28
  /**
Eric Duminil's avatar
Eric Duminil committed
29
   * WiFi params
Eric Duminil's avatar
Eric Duminil committed
30
   */
Eric Duminil's avatar
Eric Duminil committed
31
  CheckboxTParameter ampelWifiParam = Builder<CheckboxTParameter>("WiFi").label("WiFi").defaultValue(true).build();
Eric Duminil's avatar
Eric Duminil committed
32
33
34
  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
35

Eric Duminil's avatar
Eric Duminil committed
36
37
38
39
  //TODO: Distribute to corresponding classes, possibly with callbacks?
  /**
   * CO2 sensor
   */
Eric Duminil's avatar
Eric Duminil committed
40
  ParameterGroup co2Params = ParameterGroup("co2", "CO2 Sensor"); //TODO: Conflict with labels?
Eric Duminil's avatar
Eric Duminil committed
41
42

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

Eric Duminil's avatar
Eric Duminil committed
47
48
  FloatTParameter temperatureOffsetParam =
      Builder<FloatTParameter>("temp_offset").label("Temperature offset").defaultValue( TEMPERATURE_OFFSET).placeholder(
Eric Duminil's avatar
Eric Duminil committed
49
          "[K]").step(0.1).build();
Eric Duminil's avatar
Eric Duminil committed
50

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

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

Eric Duminil's avatar
Eric Duminil committed
58
59
  CheckboxTParameter autoCalibrateParam = Builder<CheckboxTParameter>("asc").label("Auto-calibration").defaultValue(
      true).build();
Eric Duminil's avatar
Eric Duminil committed
60

Eric Duminil's avatar
Eric Duminil committed
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
  /**
   * 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
82
83
84
  /**
   * CSV
   */
Eric Duminil's avatar
Eric Duminil committed
85
  OptionalParameterGroup csvParams = OptionalParameterGroup("CSV", "CSV", true);
Eric Duminil's avatar
Eric Duminil committed
86

Eric Duminil's avatar
Eric Duminil committed
87
  IntTParameter<uint16_t> csvTimestepParam =
Eric Duminil's avatar
Eric Duminil committed
88
89
      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
90
91
92
93

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

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

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

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

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

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

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

Eric Duminil's avatar
Eric Duminil committed
116
117
118
  /**
   * NTP Time
   */
Eric Duminil's avatar
Eric Duminil committed
119

Eric Duminil's avatar
Eric Duminil committed
120
121
122
123
  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
124
      (UTC_OFFSET_IN_SECONDS) / 3600).min(-23).max(23).step(1).placeholder("[h]").build();
Eric Duminil's avatar
Eric Duminil committed
125
126
  CheckboxTParameter dstParam =
      Builder<CheckboxTParameter>("dst").label("Daylight Saving Time").defaultValue(false).build();
127

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

Eric Duminil's avatar
Eric Duminil committed
132
133
134
  /**
   * LoRa & Stuff
   */
Eric Duminil's avatar
Eric Duminil committed
135
136
137
  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
138
139
140
141
142
143
144
145
      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();
146

Eric Duminil's avatar
Eric Duminil committed
147
  OptionalGroupHtmlFormatProvider optionalGroupHtmlFormatProvider;
148
149
150
151
152

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

Eric Duminil's avatar
Eric Duminil committed
153
154
155
156
157
  void setWifiConnectionCallback(void (*function)()) {
    iotWebConf->setWifiConnectionCallback(function);
  }

  void setWifiConnectionFailedCallback(void (*function)()) {
Eric Duminil's avatar
Eric Duminil committed
158
    iotWebConf->setWifiConnectionFailedHandler([&function]() -> WifiAuthInfo* {
Eric Duminil's avatar
Eric Duminil committed
159
160
161
162
163
      function();
      return NULL;
    });
  }

164
165
166
  void initialize() {
    iotWebConf = new IotWebConf(ampel.sensorId, &dnsServer, &http, HTTP_PASSWORD, config_version);

167
168
169
    iotWebConf->setHtmlFormatProvider(&optionalGroupHtmlFormatProvider);

    iotWebConf->addSystemParameter(&ampelWifiParam);
Eric Duminil's avatar
Eric Duminil committed
170
    iotWebConf->addSystemParameter(&wifiTimeoutParam);
Eric Duminil's avatar
Eric Duminil committed
171
172
173

    co2Params.addItem(&timestepParam);
    co2Params.addItem(&temperatureOffsetParam);
Eric Duminil's avatar
Eric Duminil committed
174
175
176
    co2Params.addItem(&altitudeParam);
    co2Params.addItem(&atmosphericCO2Param);
    co2Params.addItem(&autoCalibrateParam);
Eric Duminil's avatar
Eric Duminil committed
177

Eric Duminil's avatar
Eric Duminil committed
178
179
180
181
    ledParams.addItem(&maxBrightnessParam);
    ledParams.addItem(&minBrightnessParam);
    ledParams.addItem(&ledCountParam);

182
183
184
185
    timeParams.addItem(&ntpParam);
    timeParams.addItem(&timeOffsetParam);
    timeParams.addItem(&dstParam);

Eric Duminil's avatar
Eric Duminil committed
186
187
188
189
190
191
192
193
194
    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
195
    //TODO: Only for ESP32
196
    loraParams.addItem(&loraTimestepParam);
Eric Duminil's avatar
Eric Duminil committed
197
198
199
    loraParams.addItem(&deviceEUIParam);
    loraParams.addItem(&appEUIParam);
    loraParams.addItem(&appKeyParam);
200

Eric Duminil's avatar
Eric Duminil committed
201
    iotWebConf->addParameterGroup(&co2Params);
Eric Duminil's avatar
Eric Duminil committed
202
    iotWebConf->addParameterGroup(&ledParams);
203
    iotWebConf->addParameterGroup(&timeParams);
Eric Duminil's avatar
Eric Duminil committed
204
205
    iotWebConf->addParameterGroup(&csvParams);
    iotWebConf->addParameterGroup(&mqttParams);
206
    iotWebConf->addParameterGroup(&loraParams);
Eric Duminil's avatar
Eric Duminil committed
207
208
209

    sensor_console::defineCommand("reset_config", []() {
      Serial.println(F("Resetting config..."));
Eric Duminil's avatar
Notes    
Eric Duminil committed
210
      //TODO: Reset every group
Eric Duminil's avatar
Eric Duminil committed
211
212
213
214
215
      iotWebConf->getSystemParameterGroup()->applyDefaultValue();
      iotWebConf->saveConfig();
      Serial.println(F("Done!"));
    }, F("(resets the complete IotWeb config)"));

Eric Duminil's avatar
Eric Duminil committed
216
217
218
219
220
221
222
223
    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
224
225
226
227
228
#if !defined(AMPEL_WIFI)
    iotWebConf->loadConfig();
    return;
#endif

229
230
231
232
233
234
235
236
237
    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
238
  WiFi.hostname(ampel.sensorId);
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
#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
257
258
    //TODO: Authenticate only if required?
    //TODO: / captive fast return?
259
260
261
262

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

264
265
266
267
268
    http.onNotFound([]() {
      iotWebConf->handleNotFound();
    });
  }
}