├── .gitignore ├── telegram ├── settings.h ├── README.md ├── esp8266_p1meter.ino └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | # Prerequisites 2 | *.d 3 | 4 | # Compiled Object files 5 | *.slo 6 | *.lo 7 | *.o 8 | *.obj 9 | 10 | # Precompiled Headers 11 | *.gch 12 | *.pch 13 | 14 | # Compiled Dynamic libraries 15 | *.so 16 | *.dylib 17 | *.dll 18 | 19 | # Fortran module files 20 | *.mod 21 | *.smod 22 | 23 | # Compiled Static libraries 24 | *.lai 25 | *.la 26 | *.a 27 | *.lib 28 | 29 | # Executables 30 | *.exe 31 | *.out 32 | *.app 33 | -------------------------------------------------------------------------------- /telegram: -------------------------------------------------------------------------------- 1 | /XMX5LGBBFG1012463817 2 | 1-3:0.2.8(42) 3 | 0-0:1.0.0(180624024002S) 4 | 0-0:96.1.1(4530303331303033323632373634333136) 5 | 1-0:1.8.1(002200.945*kWh) 6 | 1-0:1.8.2(001961.604*kWh) 7 | 1-0:2.8.1(000000.000*kWh) 8 | 1-0:2.8.2(000000.000*kWh) 9 | 0-0:96.14.0(0001) 10 | 1-0:1.7.0(00.378*kW) 11 | 1-0:2.7.0(00.000*kW) 12 | 0-0:96.7.21(00003) 13 | 0-0:96.7.9(00001) 14 | 1-0:99.97.0(1)(0-0:96.7.19)(170214081346W)(0000006334*s) 15 | 1-0:32.32.0(00000) 16 | 1-0:32.36.0(00000) 17 | 0-0:96.13.1() 18 | 0-0:96.13.0() 19 | 1-0:31.7.0(002*A) 20 | 1-0:21.7.0(00.378*kW) 21 | 1-0:22.7.0(00.000*kW) 22 | 0-1:24.1.0(003) 23 | 0-1:96.1.0(4730303235303033333630383535373136) 24 | 0-1:24.2.1(180624020000S)(00968.481*m3) 25 | !8711 26 | -------------------------------------------------------------------------------- /settings.h: -------------------------------------------------------------------------------- 1 | // ********************************** 2 | // * Ledstrip Settings * 3 | // ********************************** 4 | 5 | // * Baud rate for both hardware and software serial 6 | #define BAUD_RATE 115200 7 | 8 | // * P1 Meter RX pin 9 | #define P1_SERIAL_RX D2 10 | 11 | // * Max telegram length 12 | #define P1_MAXLINELENGTH 1024 13 | 14 | // * The hostname of our little creature 15 | #define HOSTNAME "p1meter" 16 | 17 | // * The password used for OTA 18 | #define OTA_PASSWORD "admin" 19 | 20 | // * Wifi timeout in milliseconds 21 | #define WIFI_TIMEOUT 30000 22 | 23 | // * MQTT network settings 24 | #define MQTT_MAX_RECONNECT_TRIES 10 25 | 26 | // * MQTT root topic 27 | #define MQTT_ROOT_TOPIC "sensors/power/p1meter" 28 | 29 | // * MQTT Last reconnection counter 30 | long LAST_RECONNECT_ATTEMPT = 0; 31 | 32 | // * To be filled with EEPROM data 33 | char MQTT_HOST[64] = ""; 34 | char MQTT_PORT[6] = ""; 35 | char MQTT_USER[32] = ""; 36 | char MQTT_PASS[32] = ""; 37 | 38 | // * Set to store received telegram 39 | char telegram[P1_MAXLINELENGTH]; 40 | 41 | // * Set to store the data values read 42 | long CONSUMPTION_LOW_TARIF; 43 | long CONSUMPTION_HIGH_TARIF; 44 | long ACTUAL_CONSUMPTION; 45 | long INSTANT_POWER_CURRENT; 46 | long INSTANT_POWER_USAGE; 47 | long GAS_METER_M3; 48 | 49 | // Set to store data counters read 50 | long ACTUAL_TARIF; 51 | long SHORT_POWER_OUTAGES; 52 | long LONG_POWER_OUTAGES; 53 | long SHORT_POWER_DROPS; 54 | long SHORT_POWER_PEAKS; 55 | 56 | // * Set during CRC checking 57 | unsigned int currentCRC = 0; 58 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # esp8266_p1meter 2 | 3 | Software for the ESP2866 that sends P1 smart meter data to an mqtt broker (with OTA firmware updates) 4 | 5 | **08-05-2021: I've not used this sketch myself for several years now and as such it became a bit outdated: It supports only older meters with version 2.2 and 2.0 and the development has halted. I recommend people with newer meters to have a look at [this fork](https://github.com/daniel-jong/esp8266_p1meter) instead.** 6 | 7 | ## Connection of the P1 meter to the ESP8266 8 | 9 | | ESP8266 Pin | P1 Pin | 10 | | ---- | ---- | 11 | | GND | GND | 12 | | 3V3 | RTS | 13 | | DATA (RXD) | D2 | 14 | 15 | To connect my Landys and Gyr E350 (ZCF110), I used a 10K resistor connected between DATA (RXD) and RTS. 16 | Many howto's mention RTS requires 5V (VIN) to activate the P1 port, but for me 3V3 suffices. 17 | 18 | ![RJ11 P1 connetor](http://gejanssen.com/howto/Slimme-meter-uitlezen/RJ11-pinout.png) 19 | 20 | 21 | 22 | ## Data Sent 23 | 24 | All metrics are send to their own MQTT topic. 25 | The nodemcu sends out to the following MQTT topics: 26 | 27 | ``` 28 | sensors/power/p1meter/consumption_low_tarif 2209397 29 | sensors/power/p1meter/consumption_high_tarif 1964962 30 | sensors/power/p1meter/actual_consumption 313 31 | sensors/power/p1meter/instant_power_usage 313 32 | sensors/power/p1meter/instant_power_current 1000 33 | sensors/power/p1meter/gas_meter_m3 968922 34 | sensors/power/p1meter/actual_tarif_group 2 35 | sensors/power/p1meter/short_power_outages 3 36 | sensors/power/p1meter/long_power_outages 1 37 | sensors/power/p1meter/short_power_drops 0 38 | sensors/power/p1meter/short_power_peaks 0 39 | ``` 40 | 41 | As I don't have solar panels (yet) I do not collect the data for power returns as I don't have any. 42 | They are however easy to add if you know the codes used. 43 | 44 | ## Home Assistant Configuration 45 | 46 | I use this for home assistant `sensors.yaml`: 47 | 48 | ``` 49 | - platform: mqtt 50 | name: P1 Consumption Low Tarif 51 | unit_of_measurement: 'kWh' 52 | state_topic: "sensors/power/p1meter/consumption_low_tarif" 53 | value_template: "{{ value|float / 1000 }}" 54 | 55 | - platform: mqtt 56 | name: P1 Consumption High Tarif 57 | unit_of_measurement: 'kWh' 58 | state_topic: "sensors/power/p1meter/consumption_high_tarif" 59 | value_template: "{{ value|float / 1000 }}" 60 | 61 | - platform: mqtt 62 | name: P1 Actual Power Consumption 63 | unit_of_measurement: 'kW' 64 | state_topic: "sensors/power/p1meter/actual_consumption" 65 | value_template: "{{ value|float / 1000 }}" 66 | 67 | - platform: mqtt 68 | name: P1 Instant Power Usage 69 | unit_of_measurement: 'kW' 70 | state_topic: "sensors/power/p1meter/instant_power_usage" 71 | value_template: "{{ value|float / 1000 }}" 72 | 73 | - platform: mqtt 74 | name: P1 Instant Power Current 75 | unit_of_measurement: 'A' 76 | state_topic: "sensors/power/p1meter/instant_power_current" 77 | value_template: "{{ value|float / 1000 }}" 78 | 79 | - platform: mqtt 80 | name: P1 Gas Usage 81 | unit_of_measurement: 'm3' 82 | state_topic: "sensors/power/p1meter/gas_meter_m3" 83 | value_template: "{{ value|float / 1000 }}" 84 | 85 | - platform: mqtt 86 | name: P1 Actual Tarif Group 87 | state_topic: "sensors/power/p1meter/actual_tarif_group" 88 | 89 | - platform: mqtt 90 | name: P1 Short Power Outages 91 | state_topic: "sensors/power/p1meter/short_power_outages" 92 | 93 | - platform: mqtt 94 | name: P1 Long Power Outages 95 | state_topic: "sensors/power/p1meter/long_power_outages" 96 | 97 | - platform: mqtt 98 | name: P1 Short Power Drops 99 | state_topic: "sensors/power/p1meter/short_power_drops" 100 | 101 | - platform: mqtt 102 | name: P1 Short Power Peaks 103 | state_topic: "sensors/power/p1meter/short_power_peaks" 104 | ``` 105 | 106 | The automations are yours to create. 107 | And always remember that sending alerts in case of a power outtage only make sense when you own a UPS battery :) 108 | 109 | 110 | ## Thanks to 111 | 112 | This sketch is mostly copied and pasted from several other projects. 113 | Standing on the heads of giants, big thanks and great respect to the writers and/or creators of: 114 | 115 | - https://github.com/jantenhove/P1-Meter-ESP8266 116 | - https://github.com/neographikal/P1-Meter-ESP8266-MQTT 117 | - http://gejanssen.com/howto/Slimme-meter-uitlezen/ 118 | - https://github.com/rroethof/p1reader/ 119 | - http://romix.macuser.nl/software.html 120 | - http://blog.regout.info/category/slimmeter/ 121 | - http://domoticx.com/p1-poort-slimme-meter-hardware/ 122 | -------------------------------------------------------------------------------- /esp8266_p1meter.ino: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include 6 | #include 7 | #include 8 | #include 9 | #include 10 | #include 11 | #include 12 | 13 | // * Include settings 14 | #include "settings.h" 15 | 16 | // * Initiate led blinker library 17 | Ticker ticker; 18 | 19 | // * Initiate WIFI client 20 | WiFiClient espClient; 21 | 22 | // * Initiate MQTT client 23 | PubSubClient mqtt_client(espClient); 24 | 25 | // * Initiate Software Serial 26 | SoftwareSerial p1_serial(P1_SERIAL_RX, -1, true); // (RX, TX. inverted) 27 | 28 | // ********************************** 29 | // * WIFI * 30 | // ********************************** 31 | 32 | // * Gets called when WiFiManager enters configuration mode 33 | void configModeCallback(WiFiManager *myWiFiManager) 34 | { 35 | Serial.println(F("Entered config mode")); 36 | Serial.println(WiFi.softAPIP()); 37 | 38 | // * If you used auto generated SSID, print it 39 | Serial.println(myWiFiManager->getConfigPortalSSID()); 40 | 41 | // * Entered config mode, make led toggle faster 42 | ticker.attach(0.2, tick); 43 | } 44 | 45 | // ********************************** 46 | // * Ticker (System LED Blinker) * 47 | // ********************************** 48 | 49 | // * Blink on-board Led 50 | void tick() 51 | { 52 | // * Toggle state 53 | int state = digitalRead(LED_BUILTIN); // * Get the current state of GPIO1 pin 54 | digitalWrite(LED_BUILTIN, !state); // * Set pin to the opposite state 55 | } 56 | 57 | // ********************************** 58 | // * MQTT * 59 | // ********************************** 60 | 61 | // * Send a message to a broker topic 62 | void send_mqtt_message(const char *topic, char *payload) 63 | { 64 | Serial.printf("MQTT Outgoing on %s: ", topic); 65 | Serial.println(payload); 66 | 67 | bool result = mqtt_client.publish(topic, payload, false); 68 | 69 | if (!result) 70 | { 71 | Serial.printf("MQTT publish to topic %s failed\n", topic); 72 | } 73 | } 74 | 75 | // * Reconnect to MQTT server and subscribe to in and out topics 76 | bool mqtt_reconnect() 77 | { 78 | // * Loop until we're reconnected 79 | int MQTT_RECONNECT_RETRIES = 0; 80 | 81 | while (!mqtt_client.connected() && MQTT_RECONNECT_RETRIES < MQTT_MAX_RECONNECT_TRIES) 82 | { 83 | MQTT_RECONNECT_RETRIES++; 84 | Serial.printf("MQTT connection attempt %d / %d ...\n", MQTT_RECONNECT_RETRIES, MQTT_MAX_RECONNECT_TRIES); 85 | 86 | // * Attempt to connect 87 | if (mqtt_client.connect(HOSTNAME, MQTT_USER, MQTT_PASS)) 88 | { 89 | Serial.println(F("MQTT connected!")); 90 | 91 | // * Once connected, publish an announcement... 92 | char *message = new char[16 + strlen(HOSTNAME) + 1]; 93 | strcpy(message, "p1 meter alive: "); 94 | strcat(message, HOSTNAME); 95 | mqtt_client.publish("hass/status", message); 96 | 97 | Serial.printf("MQTT root topic: %s\n", MQTT_ROOT_TOPIC); 98 | } 99 | else 100 | { 101 | Serial.print(F("MQTT Connection failed: rc=")); 102 | Serial.println(mqtt_client.state()); 103 | Serial.println(F(" Retrying in 5 seconds")); 104 | Serial.println(""); 105 | 106 | // * Wait 5 seconds before retrying 107 | delay(5000); 108 | } 109 | } 110 | 111 | if (MQTT_RECONNECT_RETRIES >= MQTT_MAX_RECONNECT_TRIES) 112 | { 113 | Serial.printf("*** MQTT connection failed, giving up after %d tries ...\n", MQTT_RECONNECT_RETRIES); 114 | return false; 115 | } 116 | 117 | return true; 118 | } 119 | 120 | void send_metric(String name, long metric) 121 | { 122 | Serial.print(F("Sending metric to broker: ")); 123 | Serial.print(name); 124 | Serial.print(F("=")); 125 | Serial.println(metric); 126 | 127 | char output[10]; 128 | ltoa(metric, output, sizeof(output)); 129 | 130 | String topic = String(MQTT_ROOT_TOPIC) + "/" + name; 131 | send_mqtt_message(topic.c_str(), output); 132 | } 133 | 134 | void send_data_to_broker() 135 | { 136 | send_metric("consumption_low_tarif", CONSUMPTION_LOW_TARIF); 137 | send_metric("consumption_high_tarif", CONSUMPTION_HIGH_TARIF); 138 | send_metric("actual_consumption", ACTUAL_CONSUMPTION); 139 | send_metric("instant_power_usage", INSTANT_POWER_USAGE); 140 | send_metric("instant_power_current", INSTANT_POWER_CURRENT); 141 | send_metric("gas_meter_m3", GAS_METER_M3); 142 | 143 | send_metric("actual_tarif_group", ACTUAL_TARIF); 144 | send_metric("short_power_outages", SHORT_POWER_OUTAGES); 145 | send_metric("long_power_outages", LONG_POWER_OUTAGES); 146 | send_metric("short_power_drops", SHORT_POWER_DROPS); 147 | send_metric("short_power_peaks", SHORT_POWER_PEAKS); 148 | } 149 | 150 | // ********************************** 151 | // * P1 * 152 | // ********************************** 153 | 154 | unsigned int CRC16(unsigned int crc, unsigned char *buf, int len) 155 | { 156 | for (int pos = 0; pos < len; pos++) 157 | { 158 | crc ^= (unsigned int)buf[pos]; // * XOR byte into least sig. byte of crc 159 | // * Loop over each bit 160 | for (int i = 8; i != 0; i--) 161 | { 162 | // * If the LSB is set 163 | if ((crc & 0x0001) != 0) 164 | { 165 | // * Shift right and XOR 0xA001 166 | crc >>= 1; 167 | crc ^= 0xA001; 168 | } 169 | // * Else LSB is not set 170 | else 171 | // * Just shift right 172 | crc >>= 1; 173 | } 174 | } 175 | return crc; 176 | } 177 | 178 | bool isNumber(char *res, int len) 179 | { 180 | for (int i = 0; i < len; i++) 181 | { 182 | if (((res[i] < '0') || (res[i] > '9')) && (res[i] != '.' && res[i] != 0)) 183 | return false; 184 | } 185 | return true; 186 | } 187 | 188 | int FindCharInArrayRev(char array[], char c, int len) 189 | { 190 | for (int i = len - 1; i >= 0; i--) 191 | { 192 | if (array[i] == c) 193 | return i; 194 | } 195 | return -1; 196 | } 197 | 198 | long getValue(char *buffer, int maxlen, char startchar, char endchar) 199 | { 200 | int s = FindCharInArrayRev(buffer, startchar, maxlen - 2); 201 | int l = FindCharInArrayRev(buffer, endchar, maxlen - 2) - s - 1; 202 | 203 | char res[16]; 204 | memset(res, 0, sizeof(res)); 205 | 206 | if (strncpy(res, buffer + s + 1, l)) 207 | { 208 | if (endchar == '*') 209 | { 210 | if (isNumber(res, l)) 211 | // * Lazy convert float to long 212 | return (1000 * atof(res)); 213 | } 214 | else if (endchar == ')') 215 | { 216 | if (isNumber(res, l)) 217 | return atof(res); 218 | } 219 | } 220 | return 0; 221 | } 222 | 223 | bool decode_telegram(int len) 224 | { 225 | int startChar = FindCharInArrayRev(telegram, '/', len); 226 | int endChar = FindCharInArrayRev(telegram, '!', len); 227 | bool validCRCFound = false; 228 | 229 | for (int cnt = 0; cnt < len; cnt++) 230 | Serial.print(telegram[cnt]); 231 | 232 | if (startChar >= 0) 233 | { 234 | // * Start found. Reset CRC calculation 235 | currentCRC = CRC16(0x0000,(unsigned char *) telegram+startChar, len-startChar); 236 | } 237 | else if (endChar >= 0) 238 | { 239 | // * Add to crc calc 240 | currentCRC = CRC16(currentCRC,(unsigned char*)telegram+endChar, 1); 241 | 242 | char messageCRC[5]; 243 | strncpy(messageCRC, telegram + endChar + 1, 4); 244 | 245 | messageCRC[4] = 0; // * Thanks to HarmOtten (issue 5) 246 | validCRCFound = (strtol(messageCRC, NULL, 16) == currentCRC); 247 | 248 | if (validCRCFound) 249 | Serial.println(F("CRC Valid!")); 250 | else 251 | Serial.println(F("CRC Invalid!")); 252 | 253 | currentCRC = 0; 254 | } 255 | else 256 | { 257 | currentCRC = CRC16(currentCRC, (unsigned char*) telegram, len); 258 | } 259 | 260 | // 1-0:1.8.1(000992.992*kWh) 261 | // 1-0:1.8.1 = Elektra verbruik laag tarief (DSMR v4.0) 262 | if (strncmp(telegram, "1-0:1.8.1", strlen("1-0:1.8.1")) == 0) 263 | { 264 | CONSUMPTION_LOW_TARIF = getValue(telegram, len, '(', '*'); 265 | } 266 | 267 | // 1-0:1.8.2(000560.157*kWh) 268 | // 1-0:1.8.2 = Elektra verbruik hoog tarief (DSMR v4.0) 269 | if (strncmp(telegram, "1-0:1.8.2", strlen("1-0:1.8.2")) == 0) 270 | { 271 | CONSUMPTION_HIGH_TARIF = getValue(telegram, len, '(', '*'); 272 | } 273 | 274 | // 1-0:1.7.0(00.424*kW) Actueel verbruik 275 | // 1-0:2.7.0(00.000*kW) Actuele teruglevering 276 | // 1-0:1.7.x = Electricity consumption actual usage (DSMR v4.0) 277 | if (strncmp(telegram, "1-0:1.7.0", strlen("1-0:1.7.0")) == 0) 278 | { 279 | ACTUAL_CONSUMPTION = getValue(telegram, len, '(', '*'); 280 | } 281 | 282 | // 1-0:21.7.0(00.378*kW) 283 | // 1-0:21.7.0 = Instantaan vermogen Elektriciteit levering 284 | if (strncmp(telegram, "1-0:21.7.0", strlen("1-0:21.7.0")) == 0) 285 | { 286 | INSTANT_POWER_USAGE = getValue(telegram, len, '(', '*'); 287 | } 288 | 289 | // 1-0:31.7.0(002*A) 290 | // 1-0:31.7.0 = Instantane stroom Elektriciteit 291 | if (strncmp(telegram, "1-0:31.7.0", strlen("1-0:31.7.0")) == 0) 292 | { 293 | INSTANT_POWER_CURRENT = getValue(telegram, len, '(', '*'); 294 | } 295 | 296 | // 0-1:24.2.1(150531200000S)(00811.923*m3) 297 | // 0-1:24.2.1 = Gas (DSMR v4.0) on Kaifa MA105 meter 298 | if (strncmp(telegram, "0-1:24.2.1", strlen("0-1:24.2.1")) == 0) 299 | { 300 | GAS_METER_M3 = getValue(telegram, len, '(', '*'); 301 | } 302 | 303 | // 0-0:96.14.0(0001) 304 | // 0-0:96.14.0 = Actual Tarif 305 | if (strncmp(telegram, "0-0:96.14.0", strlen("0-0:96.14.0")) == 0) 306 | { 307 | ACTUAL_TARIF = getValue(telegram, len, '(', ')'); 308 | } 309 | 310 | // 0-0:96.7.21(00003) 311 | // 0-0:96.7.21 = Aantal onderbrekingen Elektriciteit 312 | if (strncmp(telegram, "0-0:96.7.21", strlen("0-0:96.7.21")) == 0) 313 | { 314 | SHORT_POWER_OUTAGES = getValue(telegram, len, '(', ')'); 315 | } 316 | 317 | // 0-0:96.7.9(00001) 318 | // 0-0:96.7.9 = Aantal lange onderbrekingen Elektriciteit 319 | if (strncmp(telegram, "0-0:96.7.9", strlen("0-0:96.7.9")) == 0) 320 | { 321 | LONG_POWER_OUTAGES = getValue(telegram, len, '(', ')'); 322 | } 323 | 324 | // 1-0:32.32.0(00000) 325 | // 1-0:32.32.0 = Aantal korte spanningsdalingen Elektriciteit in fase 1 326 | if (strncmp(telegram, "1-0:32.32.0", strlen("1-0:32.32.0")) == 0) 327 | { 328 | SHORT_POWER_DROPS = getValue(telegram, len, '(', ')'); 329 | } 330 | 331 | // 1-0:32.36.0(00000) 332 | // 1-0:32.36.0 = Aantal korte spanningsstijgingen Elektriciteit in fase 1 333 | if (strncmp(telegram, "1-0:32.36.0", strlen("1-0:32.36.0")) == 0) 334 | { 335 | SHORT_POWER_PEAKS = getValue(telegram, len, '(', ')'); 336 | } 337 | 338 | return validCRCFound; 339 | } 340 | 341 | void read_p1_serial() 342 | { 343 | if (p1_serial.available()) 344 | { 345 | memset(telegram, 0, sizeof(telegram)); 346 | 347 | while (p1_serial.available()) 348 | { 349 | ESP.wdtDisable(); 350 | int len = p1_serial.readBytesUntil('\n', telegram, P1_MAXLINELENGTH); 351 | ESP.wdtEnable(1); 352 | 353 | telegram[len] = '\n'; 354 | telegram[len + 1] = 0; 355 | yield(); 356 | 357 | bool result = decode_telegram(len + 1); 358 | if (result) 359 | send_data_to_broker(); 360 | } 361 | } 362 | } 363 | 364 | // ********************************** 365 | // * EEPROM helpers * 366 | // ********************************** 367 | 368 | String read_eeprom(int offset, int len) 369 | { 370 | Serial.print(F("read_eeprom()")); 371 | 372 | String res = ""; 373 | for (int i = 0; i < len; ++i) 374 | { 375 | res += char(EEPROM.read(i + offset)); 376 | } 377 | return res; 378 | } 379 | 380 | void write_eeprom(int offset, int len, String value) 381 | { 382 | Serial.println(F("write_eeprom()")); 383 | for (int i = 0; i < len; ++i) 384 | { 385 | if ((unsigned)i < value.length()) 386 | { 387 | EEPROM.write(i + offset, value[i]); 388 | } 389 | else 390 | { 391 | EEPROM.write(i + offset, 0); 392 | } 393 | } 394 | } 395 | 396 | // ****************************************** 397 | // * Callback for saving WIFI config * 398 | // ****************************************** 399 | 400 | bool shouldSaveConfig = false; 401 | 402 | // * Callback notifying us of the need to save config 403 | void save_wifi_config_callback () 404 | { 405 | Serial.println(F("Should save config")); 406 | shouldSaveConfig = true; 407 | } 408 | 409 | // ********************************** 410 | // * Setup OTA * 411 | // ********************************** 412 | 413 | void setup_ota() 414 | { 415 | Serial.println(F("Arduino OTA activated.")); 416 | 417 | // * Port defaults to 8266 418 | ArduinoOTA.setPort(8266); 419 | 420 | // * Set hostname for OTA 421 | ArduinoOTA.setHostname(HOSTNAME); 422 | ArduinoOTA.setPassword(OTA_PASSWORD); 423 | 424 | ArduinoOTA.onStart([]() 425 | { 426 | Serial.println(F("Arduino OTA: Start")); 427 | }); 428 | 429 | ArduinoOTA.onEnd([]() 430 | { 431 | Serial.println(F("Arduino OTA: End (Running reboot)")); 432 | }); 433 | 434 | ArduinoOTA.onProgress([](unsigned int progress, unsigned int total) 435 | { 436 | Serial.printf("Arduino OTA Progress: %u%%\r", (progress / (total / 100))); 437 | }); 438 | 439 | ArduinoOTA.onError([](ota_error_t error) 440 | { 441 | Serial.printf("Arduino OTA Error[%u]: ", error); 442 | if (error == OTA_AUTH_ERROR) 443 | Serial.println(F("Arduino OTA: Auth Failed")); 444 | else if (error == OTA_BEGIN_ERROR) 445 | Serial.println(F("Arduino OTA: Begin Failed")); 446 | else if (error == OTA_CONNECT_ERROR) 447 | Serial.println(F("Arduino OTA: Connect Failed")); 448 | else if (error == OTA_RECEIVE_ERROR) 449 | Serial.println(F("Arduino OTA: Receive Failed")); 450 | else if (error == OTA_END_ERROR) 451 | Serial.println(F("Arduino OTA: End Failed")); 452 | }); 453 | 454 | ArduinoOTA.begin(); 455 | Serial.println(F("Arduino OTA finished")); 456 | } 457 | 458 | // ********************************** 459 | // * Setup MDNS discovery service * 460 | // ********************************** 461 | 462 | void setup_mdns() 463 | { 464 | Serial.println(F("Starting MDNS responder service")); 465 | 466 | bool mdns_result = MDNS.begin(HOSTNAME); 467 | if (mdns_result) 468 | { 469 | MDNS.addService("http", "tcp", 80); 470 | } 471 | } 472 | 473 | // ********************************** 474 | // * Setup Main * 475 | // ********************************** 476 | 477 | void setup() 478 | { 479 | // * Configure Serial and EEPROM 480 | Serial.begin(BAUD_RATE); 481 | EEPROM.begin(512); 482 | 483 | // * Set led pin as output 484 | pinMode(LED_BUILTIN, OUTPUT); 485 | 486 | // * Start ticker with 0.5 because we start in AP mode and try to connect 487 | ticker.attach(0.6, tick); 488 | 489 | // * Start software serial for p1 meter 490 | p1_serial.begin(BAUD_RATE); 491 | 492 | // * Get MQTT Server settings 493 | String settings_available = read_eeprom(134, 1); 494 | 495 | if (settings_available == "1") 496 | { 497 | read_eeprom(0, 64).toCharArray(MQTT_HOST, 64); // * 0-63 498 | read_eeprom(64, 6).toCharArray(MQTT_PORT, 6); // * 64-69 499 | read_eeprom(70, 32).toCharArray(MQTT_USER, 32); // * 70-101 500 | read_eeprom(102, 32).toCharArray(MQTT_PASS, 32); // * 102-133 501 | } 502 | 503 | WiFiManagerParameter CUSTOM_MQTT_HOST("host", "MQTT hostname", MQTT_HOST, 64); 504 | WiFiManagerParameter CUSTOM_MQTT_PORT("port", "MQTT port", MQTT_PORT, 6); 505 | WiFiManagerParameter CUSTOM_MQTT_USER("user", "MQTT user", MQTT_USER, 32); 506 | WiFiManagerParameter CUSTOM_MQTT_PASS("pass", "MQTT pass", MQTT_PASS, 32); 507 | 508 | // * WiFiManager local initialization. Once its business is done, there is no need to keep it around 509 | WiFiManager wifiManager; 510 | 511 | // * Reset settings - uncomment for testing 512 | // wifiManager.resetSettings(); 513 | 514 | // * Set callback that gets called when connecting to previous WiFi fails, and enters Access Point mode 515 | wifiManager.setAPCallback(configModeCallback); 516 | 517 | // * Set timeout 518 | wifiManager.setConfigPortalTimeout(WIFI_TIMEOUT); 519 | 520 | // * Set save config callback 521 | wifiManager.setSaveConfigCallback(save_wifi_config_callback); 522 | 523 | // * Add all your parameters here 524 | wifiManager.addParameter(&CUSTOM_MQTT_HOST); 525 | wifiManager.addParameter(&CUSTOM_MQTT_PORT); 526 | wifiManager.addParameter(&CUSTOM_MQTT_USER); 527 | wifiManager.addParameter(&CUSTOM_MQTT_PASS); 528 | 529 | // * Fetches SSID and pass and tries to connect 530 | // * Reset when no connection after 10 seconds 531 | if (!wifiManager.autoConnect()) 532 | { 533 | Serial.println(F("Failed to connect to WIFI and hit timeout")); 534 | 535 | // * Reset and try again, or maybe put it to deep sleep 536 | ESP.reset(); 537 | delay(WIFI_TIMEOUT); 538 | } 539 | 540 | // * Read updated parameters 541 | strcpy(MQTT_HOST, CUSTOM_MQTT_HOST.getValue()); 542 | strcpy(MQTT_PORT, CUSTOM_MQTT_PORT.getValue()); 543 | strcpy(MQTT_USER, CUSTOM_MQTT_USER.getValue()); 544 | strcpy(MQTT_PASS, CUSTOM_MQTT_PASS.getValue()); 545 | 546 | // * Save the custom parameters to FS 547 | if (shouldSaveConfig) 548 | { 549 | Serial.println(F("Saving WiFiManager config")); 550 | 551 | write_eeprom(0, 64, MQTT_HOST); // * 0-63 552 | write_eeprom(64, 6, MQTT_PORT); // * 64-69 553 | write_eeprom(70, 32, MQTT_USER); // * 70-101 554 | write_eeprom(102, 32, MQTT_PASS); // * 102-133 555 | write_eeprom(134, 1, "1"); // * 134 --> always "1" 556 | EEPROM.commit(); 557 | } 558 | 559 | // * If you get here you have connected to the WiFi 560 | Serial.println(F("Connected to WIFI...")); 561 | 562 | // * Keep LED on 563 | ticker.detach(); 564 | digitalWrite(LED_BUILTIN, LOW); 565 | 566 | // * Configure OTA 567 | setup_ota(); 568 | 569 | // * Startup MDNS Service 570 | setup_mdns(); 571 | 572 | // * Setup MQTT 573 | Serial.printf("MQTT connecting to: %s:%s\n", MQTT_HOST, MQTT_PORT); 574 | 575 | mqtt_client.setServer(MQTT_HOST, atoi(MQTT_PORT)); 576 | 577 | } 578 | 579 | // ********************************** 580 | // * Loop * 581 | // ********************************** 582 | 583 | void loop() 584 | { 585 | ArduinoOTA.handle(); 586 | 587 | if (!mqtt_client.connected()) 588 | { 589 | long now = millis(); 590 | 591 | if (now - LAST_RECONNECT_ATTEMPT > 5000) 592 | { 593 | LAST_RECONNECT_ATTEMPT = now; 594 | 595 | if (mqtt_reconnect()) 596 | { 597 | LAST_RECONNECT_ATTEMPT = 0; 598 | } 599 | } 600 | } 601 | else 602 | { 603 | mqtt_client.loop(); 604 | } 605 | 606 | read_p1_serial(); 607 | } 608 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------