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

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

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

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

  IotWebConf *iotWebConf;

Eric Duminil's avatar
Eric Duminil committed
24
25
  // -- Configuration specific key. The value should be modified if config structure was changed.

Eric Duminil's avatar
Eric Duminil committed
26
  const char config_version[IOTWEBCONF_CONFIG_VERSION_LENGTH] = "a04";
27
  using namespace iotwebconf;
28

Eric Duminil's avatar
Eric Duminil committed
29
30
31
  /**
   * Services
   */
Eric Duminil's avatar
Eric Duminil committed
32
33
34
  iotwebconf::CheckboxTParameter ampelWifiParam = iotwebconf::Builder<iotwebconf::CheckboxTParameter>("WiFi").label(
      "WiFi").defaultValue(true).build();

Eric Duminil's avatar
Eric Duminil committed
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
60
61
62
  //TODO: Distribute to corresponding classes, possibly with callbacks?
  /**
   * CO2 sensor
   */
  iotwebconf::ParameterGroup co2Params = iotwebconf::ParameterGroup("co2", "CO2 Sensor"); //TODO: Conflict with labels?

  //TODO: UIntTParameter?
  iotwebconf::IntTParameter<uint16_t> timestepParam = iotwebconf::Builder<iotwebconf::IntTParameter<uint16_t>>(
      "timestep").label("Measurement timestep").defaultValue(MEASUREMENT_TIMESTEP).min(2).max(1800).step(1).placeholder(
      "2..1800").build();

  iotwebconf::FloatTParameter temperatureOffsetParam =
      iotwebconf::Builder<iotwebconf::FloatTParameter>("temp_offset").label("Temperature offset").defaultValue(
      TEMPERATURE_OFFSET).placeholder("-3").step(0.1).build();

  iotwebconf::IntTParameter<uint16_t> altitudeParam = iotwebconf::Builder<iotwebconf::IntTParameter<uint16_t>>(
      "altitude").label("Altitude").defaultValue(ALTITUDE_ABOVE_SEA_LEVEL).min(0).step(1).build();

  iotwebconf::IntTParameter<uint16_t> atmosphericCO2Param = iotwebconf::Builder<iotwebconf::IntTParameter<uint16_t>>(
      "atmospheric_co2").label("Atmospheric CO2 concentration").defaultValue(
  ATMOSPHERIC_CO2_CONCENTRATION).min(400).max(2000).step(1).placeholder("400..2000").build();

  iotwebconf::CheckboxTParameter autoCalibrateParam = iotwebconf::Builder<iotwebconf::CheckboxTParameter>("asc").label(
      "Auto-calibration").defaultValue(true).build();

  /**
   * CSV
   */
Eric Duminil's avatar
Eric Duminil committed
63
  iotwebconf::OptionalParameterGroup csvParams = iotwebconf::OptionalParameterGroup("CSV", "CSV", true);
Eric Duminil's avatar
Eric Duminil committed
64
65
66
67
68
69
70

  iotwebconf::IntTParameter<uint16_t> csvTimestepParam = iotwebconf::Builder<iotwebconf::IntTParameter<uint16_t>>(
      "csv_timestep").label("CSV timestep").defaultValue(CSV_INTERVAL).min(0).step(1).build();

  /**
   * MQTT
   */
Eric Duminil's avatar
Eric Duminil committed
71
  iotwebconf::OptionalParameterGroup mqttParams = iotwebconf::OptionalParameterGroup("MQTT", "MQTT", true);
Eric Duminil's avatar
Eric Duminil committed
72
73
74
75
76
77
78
79

  iotwebconf::IntTParameter<uint16_t> mqttTimestepParam = iotwebconf::Builder<iotwebconf::IntTParameter<uint16_t>>(
      "mqtt_timestep").label("MQTT timestep").defaultValue(
  MQTT_SENDING_INTERVAL).min(0).step(1).defaultValue(300).build();

  iotwebconf::CheckboxTParameter mqttCommandsParam = iotwebconf::Builder<iotwebconf::CheckboxTParameter>(
      "mqtt_commands").label("MQTT commands").defaultValue(false).build();

Eric Duminil's avatar
Eric Duminil committed
80
  iotwebconf::TextTParameter<STRING_LEN> mqttServerParam = iotwebconf::Builder<iotwebconf::TextTParameter<STRING_LEN>>(
Eric Duminil's avatar
Eric Duminil committed
81
82
83
84
85
      "mqtt_server").label("MQTT Server").defaultValue(MQTT_SERVER).build();

  iotwebconf::IntTParameter<uint16_t> mqttPortParam = iotwebconf::Builder<iotwebconf::IntTParameter<uint16_t>>(
      "mqtt_port").label("MQTT Port").defaultValue(MQTT_PORT).build();

Eric Duminil's avatar
Eric Duminil committed
86
87
  iotwebconf::TextTParameter<STRING_LEN> mqttUserParam = iotwebconf::Builder<iotwebconf::TextTParameter<STRING_LEN>>(
      "mqtt_user").label("MQTT User").defaultValue(MQTT_USER).build();
Eric Duminil's avatar
Eric Duminil committed
88

Eric Duminil's avatar
TODO    
Eric Duminil committed
89
  //TODO: Show the number of * for password?
Eric Duminil's avatar
Eric Duminil committed
90
91
92
  iotwebconf::PasswordTParameter<STRING_LEN> mqttPasswordParam = iotwebconf::Builder<
      iotwebconf::PasswordTParameter< STRING_LEN>>("mqtt_password").label("MQTT password").defaultValue(
  MQTT_PASSWORD).build();
Eric Duminil's avatar
Eric Duminil committed
93

Eric Duminil's avatar
Eric Duminil committed
94
95
96
  /**
   * NTP Time
   */
Eric Duminil's avatar
Eric Duminil committed
97

Eric Duminil's avatar
Eric Duminil committed
98
  iotwebconf::ParameterGroup timeParams = iotwebconf::ParameterGroup("NTP", "Time server");
99
  iotwebconf::TextTParameter<STRING_LEN> ntpParam = iotwebconf::Builder<iotwebconf::TextTParameter< STRING_LEN>>(
Eric Duminil's avatar
Eric Duminil committed
100
      "ntp_server").label("NTP Server").defaultValue(NTP_SERVER).build();
101
102
103
104
105
  iotwebconf::IntTParameter<int16_t> timeOffsetParam = iotwebconf::Builder<iotwebconf::IntTParameter<int16_t>>(
      "timezone").label("Timezone").defaultValue((UTC_OFFSET_IN_SECONDS) / 3600).min(-23).max(23).step(1).build();
  iotwebconf::CheckboxTParameter dstParam = iotwebconf::Builder<iotwebconf::CheckboxTParameter>("dst").label(
      "Daylight Saving Time").defaultValue(false).build();

Eric Duminil's avatar
Eric Duminil committed
106
107
108
  /**
   * LED
   */
Eric Duminil's avatar
Eric Duminil committed
109

Eric Duminil's avatar
Eric Duminil committed
110
111
112
  /**
   * LoRa & Stuff
   */
113
114
115
116
117
118
  iotwebconf::OptionalParameterGroup loraParams = iotwebconf::OptionalParameterGroup("LoRaWan", "LoRaWan", false);
  iotwebconf::IntTParameter<uint16_t> loraTimestepParam = iotwebconf::Builder<iotwebconf::IntTParameter<uint16_t>>(
      "lora_timestep").label("LoRa timestep").defaultValue(
  LORAWAN_SENDING_INTERVAL).min(0).step(1).defaultValue(300).build();

  iotwebconf::OptionalGroupHtmlFormatProvider optionalGroupHtmlFormatProvider;
119
120
121
122
123

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

Eric Duminil's avatar
Eric Duminil committed
124
125
126
127
128
129
130
131
132
133
134
  void setWifiConnectionCallback(void (*function)()) {
    iotWebConf->setWifiConnectionCallback(function);
  }

  void setWifiConnectionFailedCallback(void (*function)()) {
    iotWebConf->setWifiConnectionFailedHandler([&function]() -> iotwebconf::WifiAuthInfo* {
      function();
      return NULL;
    });
  }

135
136
137
  void initialize() {
    iotWebConf = new IotWebConf(ampel.sensorId, &dnsServer, &http, HTTP_PASSWORD, config_version);

138
139
140
    iotWebConf->setHtmlFormatProvider(&optionalGroupHtmlFormatProvider);

    iotWebConf->addSystemParameter(&ampelWifiParam);
Eric Duminil's avatar
Eric Duminil committed
141
142
143

    co2Params.addItem(&timestepParam);
    co2Params.addItem(&temperatureOffsetParam);
Eric Duminil's avatar
Eric Duminil committed
144
145
146
    co2Params.addItem(&altitudeParam);
    co2Params.addItem(&atmosphericCO2Param);
    co2Params.addItem(&autoCalibrateParam);
Eric Duminil's avatar
Eric Duminil committed
147

148
149
150
151
    timeParams.addItem(&ntpParam);
    timeParams.addItem(&timeOffsetParam);
    timeParams.addItem(&dstParam);

Eric Duminil's avatar
Eric Duminil committed
152
153
154
155
156
157
158
159
160
    csvParams.addItem(&csvTimestepParam);

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

161
162
    loraParams.addItem(&loraTimestepParam);

Eric Duminil's avatar
Eric Duminil committed
163
    iotWebConf->addParameterGroup(&co2Params);
164
    iotWebConf->addParameterGroup(&timeParams);
Eric Duminil's avatar
Eric Duminil committed
165
166
    iotWebConf->addParameterGroup(&csvParams);
    iotWebConf->addParameterGroup(&mqttParams);
167
    iotWebConf->addParameterGroup(&loraParams);
Eric Duminil's avatar
Eric Duminil committed
168
169
170

    sensor_console::defineCommand("reset_config", []() {
      Serial.println(F("Resetting config..."));
Eric Duminil's avatar
Notes    
Eric Duminil committed
171
      //TODO: Reset every group
Eric Duminil's avatar
Eric Duminil committed
172
173
174
175
176
      iotWebConf->getSystemParameterGroup()->applyDefaultValue();
      iotWebConf->saveConfig();
      Serial.println(F("Done!"));
    }, F("(resets the complete IotWeb config)"));

Eric Duminil's avatar
Eric Duminil committed
177
178
179
180
181
182
183
184
    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
185
186
187
188
189
#if !defined(AMPEL_WIFI)
    iotWebConf->loadConfig();
    return;
#endif

190
191
192
193
194
195
196
197
198
    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
199
  WiFi.hostname(ampel.sensorId);
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
#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
218
219
    //TODO: Authenticate only if required?
    //TODO: / captive fast return?
220
221
222
223

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

225
226
227
228
229
    http.onNotFound([]() {
      iotWebConf->handleNotFound();
    });
  }
}