diff --git a/BrauHelferlein.ino b/BrauHelferlein.ino index f8cdb92..e45669d 100644 --- a/BrauHelferlein.ino +++ b/BrauHelferlein.ino @@ -1,483 +1,205 @@ -#include "ESPAsyncTCP.h" -#include "ESPAsyncWebServer.h" -#include -#include -#include -#include -#include -#include -#include - -const char* APssid = "Brauhaus"; -const char* STAssid = "uni_5"; -const char* STApassword = "xxxxxx"; - -#define ONE_WIRE_BUS 12 // DS18B20 on ESP pin12 -#define MISCHERPORT 2 -#define RELAISPORT 16 -float triggerC = 0.5; - -#define resolution 12 // 12bit resolution == 750ms update rate -#define OWinterval (800 / (1 << (12 - resolution))) -#define WindowSize (OWinterval * 6) -#define minWindow 150 - -#define OFF HIGH -#define ON LOW - -#define JSONSize 150 - -// addr, en,rw,rs,d4,d5,d6,d7 -LiquidCrystal_I2C lcd(0x27, 2, 1, 0, 4, 5, 6, 7, 3, POSITIVE); - -#define CONFIG_VERSION 1 -#define CONFIG_START 10 -struct StoreStruct{ - uint8_t version; - double solltemp, consKp, consKi, consKd; -} myStore; - -uint32_t lastrun, lastSetpoint = 0,windowStartTime; -uint8_t mischerOff = 0; -uint8_t mischerOn = 0; -uint16_t mischerPower = 0; -bool shouldReboot = false; -double temperature = 25, Output = 0; -PID myPID(&temperature, &Output, &myStore.solltemp,myStore.consKp,myStore.consKi,myStore.consKd, DIRECT); - -AsyncWebServer server(80); -AsyncEventSource events("/events"); // event source (Server-Sent events) - -OneWire oneWire(ONE_WIRE_BUS); -DallasTemperature DS18B20(&oneWire); -DeviceAddress tempDeviceAddress; - -void loadConfig() { - EEPROM.get(CONFIG_START, myStore); - - if (myStore.version != CONFIG_VERSION) - { - myStore.version = CONFIG_VERSION; - myStore.solltemp = 24; - myStore.consKp = 5000; - myStore.consKi = 0; - myStore.consKd = 0; - saveConfig(); - } -} - -void saveConfig() { - lcd.clear(); lcd.home(); lcd.print("EE save: "); - EEPROM.put(CONFIG_START, myStore); - EEPROM.commit(); - lcd.print(" OK"); -} - -void setup(){ - Serial.begin(115200); - Serial.println("sensors begin"); - - // Start up the DS18B20 - DS18B20.begin(); - DS18B20.getAddress(tempDeviceAddress, 0); - DS18B20.setResolution(tempDeviceAddress, resolution); - DS18B20.setWaitForConversion(false); - - // Init the Display - Wire.begin(4, 5); - lcd.begin (16,2); - lcd.backlight(); - lcd.clear(); - lcd.home(); - - // Load PID config - EEPROM.begin(512); - loadConfig(); - - analogWriteFreq(10000); - digitalWrite(RELAISPORT,HIGH); - pinMode(RELAISPORT, OUTPUT); - - digitalWrite(MISCHERPORT,HIGH); - pinMode(MISCHERPORT, OUTPUT); - - WifiStart(); - - // Start Web server configuration - events.onConnect([](AsyncEventSourceClient *client){ - if(client->lastId()){ - Serial.printf("Client reconnected! Last message ID that it gat is: %u\n", client->lastId()); - }}); - server.addHandler(&events); - - // respond to GET requests on URL /heap - server.on("/heap", HTTP_GET, [](AsyncWebServerRequest *request){ - request->send(200, "text/plain", String(ESP.getFreeHeap())); - }); - -// respond to GET requests on URL homepage - server.on("/", HTTP_ANY, [](AsyncWebServerRequest *request){ - - //Check if POST (but not File) parameter exists - if(request->hasParam("Tsoll", true)) { - AsyncWebParameter* p = request->getParam("Tsoll", true); - if (myStore.solltemp != p->value().toFloat()) { - myStore.solltemp = p->value().toFloat(); - lastSetpoint=0; - } - } - if(request->hasParam("Mon", true)) { - AsyncWebParameter* p; - p = request->getParam("Mon", true); - mischerOn = p->value().toInt(); - - p = request->getParam("Moff", true); - mischerOff = p->value().toInt(); - - p = request->getParam("MPw", true); - mischerPower = p->value().toInt(); - } - - AsyncResponseStream *response = request->beginResponseStream("text/html"); - - response->addHeader("Server","ESP Async Web Server"); - response->print(R"V0G0N( - - - -Braustube - - - - - -
-
-
-Braustube -
-
-
-Menu -
-
-
-
-
-
-
- - - - - - - - - - -
EinstellungenWertSlider
opacity Soll Temperatur:
-

watch_later T erreicht seit:
rotate_right Mischer aktiv::

replay_30 Mischer pausiert:

-
toys Mischer Drehzahl:

-
-
-
-
-)V0G0N"); - request->send(response); - }); - - - -// respond to requests on URL /settings for PID settings - server.on("/settings", HTTP_ANY, [](AsyncWebServerRequest *request){ - - //Check if POST (but not File) parameter exists - if(request->hasParam("Kp", true)) { - myStore.consKp = request->getParam("Kp", true)->value().toFloat(); - myStore.consKi = request->getParam("Ki", true)->value().toFloat(); - myStore.consKd = request->getParam("Kd", true)->value().toFloat(); - myPID.SetTunings(myStore.consKp, myStore.consKi, myStore.consKd); - resetPID(); - saveConfig(); - } - - AsyncResponseStream *response = request->beginResponseStream("text/html"); - - response->addHeader("Server","ESP Async Web Server"); - response->printf(R"V0G0N(Settings - -

PID settings

-Output: %-7.2f
-
-kP:
-kI:
-kD:
-
- )V0G0N",Output,myPID.GetKp(),myPID.GetKi(),myPID.GetKd()); - request->send(response); - }); - - // Simple Firmware Update Form - server.on("/update", HTTP_GET, [](AsyncWebServerRequest *request){ - request->send(200, "text/html", "
"); - }); - - server.on("/update", HTTP_POST, [](AsyncWebServerRequest *request){ - shouldReboot = !Update.hasError(); - AsyncWebServerResponse *response = request->beginResponse(200, "text/plain", shouldReboot?"OK":"FAIL"); - response->addHeader("Connection", "close"); - request->send(response); - },[](AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final){ - if(!index){ - Serial.printf("Update Start: %s\n", filename.c_str()); - //WiFiUDP::stopAll(); - Update.runAsync(true); - if(!Update.begin((ESP.getFreeSketchSpace() - 0x1000) & 0xFFFFF000)){ - Update.printError(Serial); - } - } - if(!Update.hasError()){ - if(Update.write(data, len) != len){ - Update.printError(Serial); - } - } - if(final){ - if(Update.end(true)){ - Serial.printf("Update Success: %uB\n", index+len); - } else { - Update.printError(Serial); - } - } - }); - - // Start the web server - server.begin(); - - DS18B20.requestTemperatures(); - - windowStartTime = millis(); - //tell the PID to range between 0 and the full window size - myPID.SetOutputLimits(minWindow, WindowSize); - myPID.SetTunings(myStore.consKp, myStore.consKi, myStore.consKd); - myPID.SetSampleTime(OWinterval); - //turn the PID on - resetPID(); - - delay(2000); - lcd.clear(); -} - -inline void relais(bool state) { - digitalWrite(RELAISPORT,state); -} - -void resetPID() { - myPID.SetMode(MANUAL); - Output=0; - myPID.SetMode(AUTOMATIC); -} - -void WifiStart() { - uint8_t i=0; - - lcd.setCursor(0,0); lcd.print("Wifi STA: last"); - WiFi.begin(); - //WiFi.setAutoReconnect(true); - lcd.setCursor(0,1); - - // We try to connect with the last known AP - while (WiFi.status() != WL_CONNECTED) { - delay(500); - i++; - if (i%15 == 0) { - lcd.setCursor(0,1); - lcd.print(" "); - lcd.setCursor(0,1); - } - else lcd.print("."); - - // We were unable, so try the hard coded AP - if (i == 20) { - lcd.clear(); - lcd.setCursor(0,0);lcd.print("Wifi STA:"); lcd.print(STAssid); - WiFi.begin(STAssid,STApassword); - lcd.setCursor(0,1); - } - - // No APs found, so we spin up own AP - // TODO: When in AP mode, we have no Internet, so the JS libraries cant be loaded on the client - // can we serve them from ESP? - if (i == 40) { - lcd.clear(); - lcd.setCursor(0,0); lcd.print("Wifi AP & STA"); - WiFi.disconnect(); - WiFi.mode(WIFI_AP_STA); - WiFi.softAP(APssid); - delay(2000); - lcd.setCursor(0,1);lcd.print("ApIP:");lcd.print(WiFi.softAPIP()); - break; - } - } - if (WiFi.status() == WL_CONNECTED) { - lcd.setCursor(0,1);lcd.print("IP:");lcd.print(WiFi.localIP()); - } -} - -void loop(){ - -StaticJsonBuffer jsonBuffer; -JsonObject& root = jsonBuffer.createObject(); - - if(shouldReboot){ - Serial.println("Rebooting..."); - delay(100); - ESP.restart(); - } - - // We run yet when we have new Temperatur data from DS18B20 - if (millis()-lastrun > OWinterval) { - lastrun = millis(); - - float tnew = DS18B20.getTempCByIndex(0); - DS18B20.requestTemperatures(); - - // test if we have valid temp reading - if (tnew==DEVICE_DISCONNECTED_C || // DISCONNECTED - (tnew==85.0 && abs(tnew - temperature) > 2 ) ) // we read 85 uninitialized but we are not close to 85 hot - { - Serial.println("DISCONNECTED"); - lcd.setCursor(0,0); lcd.print("-"); - } - else - { - temperature = tnew; - char buf[10]; - uint32_t passedT = 0; - - // calculate the time we are set in - if (lastSetpoint != 0) passedT = (millis() - lastSetpoint) / 1000; - else if ( abs(temperature-myStore.solltemp) < triggerC) // or we just reached it - { - lastSetpoint = millis(); - // reset the PID error here - resetPID(); - } - - // myPID.Compute(); - - if(millis() - windowStartTime > WindowSize) - { //time to shift the Relay Window and recalculate - windowStartTime = millis(); - myPID.Compute(); - } - - - snprintf (buf, sizeof(buf), "%03d:%02d", passedT/60, passedT%60); - root["timer"] = jsonBuffer.strdup(buf); - lcd.setCursor(10,1); lcd.print(buf); - - Serial.print("T: "); Serial.println(temperature); - snprintf (buf, sizeof(buf), "%6.2f", temperature); - lcd.setCursor(0,0); lcd.print("T:"); lcd.print(buf); lcd.print((char)223); - root["temp"] = temperature; - - snprintf (buf, sizeof(buf), "%6.2f", myStore.solltemp); - lcd.setCursor(0,1); lcd.print("S:"); lcd.print(buf); lcd.print((char)223); - root["sollT"] = myStore.solltemp; - - int8_t load = (Output-minWindow)*100.0 / (WindowSize-minWindow); - snprintf (buf, sizeof(buf), "%3u%%", load); - lcd.setCursor(12,0); - lcd.print(buf); - root["load"] = load; - - // We send JSON data to the client - char buffer[JSONSize]; - root.printTo(buffer, sizeof(buffer)); - events.send(buffer, "message"); - } - } - - // Translation of Power to Relay interval - if(Output > minWindow && Output > millis() - windowStartTime) relais(ON); - else relais(OFF); - - // Mischer interval calculation - static uint32_t lastmischer; - if (millis()-lastmischer > 1000) { - lastmischer = millis(); - if (mischerOn && (millis() / 1000) % (mischerOn + mischerOff) < mischerOn) { - analogWrite(MISCHERPORT, 10.23 * (100-mischerPower)); } - else { - digitalWrite(MISCHERPORT, true); - } - } -} \ No newline at end of file +#include +#include +#include +#include +#include +#include +#include "PID_Handler.h" +#include "Stirrer_Handler.h" +#include "VisualizerClass.h" +#include "WebserverManagerClass.h" +#include "WiFiManagerClass.h" +#include "FileStorageClass.h" +#include "ConfigClass.h" + +const String APssid = "JBLM-IoT-Wemos1"; +const String APpassword = "12345678"; +const String STAssid = "JBLM-IoT-Playground"; +const String STApassword = "WemosPi&Co"; + +#define ONE_WIRE_BUS 12 // DS18B20 on ESP pin12 +#define MISCHERPORT 2 +#define RELAISPORT 16 +float triggerC = 0.5; + +#define resolution 12 // 12bit resolution == 750ms update rate +#define OWinterval (800 / (1 << (12 - resolution))) +#define WindowSize (OWinterval * 6) +#define minWindow 150 + +#define OFF HIGH +#define ON LOW + +#define JSONSize 150 + +void relais(bool state) { + digitalWrite(RELAISPORT, state); +} + +OneWire oneWire(ONE_WIRE_BUS); +DallasTemperature DS18B20(&oneWire); +// addr, en,rw,rs,d4,d5,d6,d7 +LiquidCrystal lcd(27, 1, 1, 1, 1, 1); //(0x27, 2, 1, 0, 4, 5, 6, 7, 3, POSITIVE); + +Visualizer visualizer(&lcd); +Config config(&visualizer); +WifiManager wifiManager(&visualizer); +DeviceAddress ds18B20Address; +WebserverManager webserverManager(&visualizer, &config); + + +void setup() { + + visualizer.show("Init Wire"); + Wire.begin(4, 5); + visualizer.showSecondary("Wire initialized"); + + // waiting for China Display + //visualizer.show("Start LCD"); + //lcd.begin(16, 2); + ////lcd.backlight(); + //visualizer.showSecondary("LCD started"); + + wifiManager.wifiStart(APssid, APpassword, STAssid, STApassword); + webserverManager.startServer(); + + visualizer.show("DS18B20 Setup"); + + // Start up the DS18B20 + if (DS18B20.getDeviceCount() > 0 && DS18B20.isConnected(0)) + { + DS18B20.begin(); + DS18B20.getAddress(ds18B20Address, 0); + DS18B20.setResolution(ds18B20Address, resolution); + DS18B20.setWaitForConversion(false); + DS18B20.requestTemperatures(); + visualizer.show("Temp. Sensor", "OK"); + } + else + { + visualizer.show("Temp. Sensor", "Fehler"); + delay(1000); + } + + // init IoT_GPIO_Gedöns :o) + analogWriteFreq(10000); + digitalWrite(RELAISPORT, HIGH); + pinMode(RELAISPORT, OUTPUT); + + digitalWrite(MISCHERPORT, HIGH); + pinMode(MISCHERPORT, OUTPUT); + + config.load(); + windowStartTime = millis(); + //tell the PID to range between 0 and the full window size + pid.SetOutputLimits(minWindow, WindowSize); + pid.SetTunings(configStore.consKp, configStore.consKi, configStore.consKd); + pid.SetSampleTime(OWinterval); + //turn the PID on + resetPID(); + + delay(2000); + lcd.clear(); +} + + +void loop() { + + + if (shouldReboot) { + Serial.println("Rebooting..."); + delay(100); + ESP.restart(); + } + + + // We run yet when we have new Temperatur data from DS18B20 + if (millis() - lastrun > OWinterval) { + lastrun = millis(); + + float tnew = DS18B20.getTempCByIndex(0); + DS18B20.requestTemperatures(); + + // test if we have valid temp reading + if (tnew == DEVICE_DISCONNECTED_C || // DISCONNECTED + (tnew == 85.0 && abs(tnew - temperature) > 2)) // we read 85 uninitialized but we are not close to 85 hot + { + Serial.println("DISCONNECTED"); + lcd.setCursor(0, 0); lcd.print("-"); + } + else + { + temperature = tnew; + + uint32_t passedT = 0; + + // calculate the time we are set in + if (lastSetpoint != 0) passedT = (millis() - lastSetpoint) / 1000; + else if (abs(temperature - configStore.solltemp) < triggerC) // or we just reached it + { + lastSetpoint = millis(); + // reset the PID error here + resetPID(); + } + + // pid.Compute(); + + if (millis() - windowStartTime > WindowSize) + { //time to shift the Relay Window and recalculate + windowStartTime = millis(); + pid.Compute(); + } + + updateWebclientAndLcd(passedT); + + } + } + + // Translation of Power to Relay interval + if (Output > minWindow && Output > millis() - windowStartTime) relais(ON); + else relais(OFF); + + // Mischer interval calculation + static uint32_t lastmischer; + if (millis() - lastmischer > 1000) { + lastmischer = millis(); + if (mischerOn && (millis() / 1000) % (mischerOn + mischerOff) < mischerOn) { + analogWrite(MISCHERPORT, 10.23 * (100 - mischerPower)); + } + else { + digitalWrite(MISCHERPORT, true); + } + } +} + +void updateWebclientAndLcd(uint32_t aPassedT) +{ + char buf[10]; + StaticJsonBuffer jsonBuffer; + + JsonObject& root = jsonBuffer.createObject(); + + snprintf(buf, sizeof(buf), "%03d:%02d", aPassedT / 60, aPassedT % 60); + root["timer"] = jsonBuffer.strdup(buf); + lcd.setCursor(10, 1); lcd.print(buf); + + Serial.print("T: "); Serial.println(temperature); + snprintf(buf, sizeof(buf), "%6.2f", temperature); + lcd.setCursor(0, 0); lcd.print("T:"); lcd.print(buf); lcd.print((char)223); + root["temp"] = temperature; + + snprintf(buf, sizeof(buf), "%6.2f", configStore.solltemp); + lcd.setCursor(0, 1); lcd.print("S:"); lcd.print(buf); lcd.print((char)223); + root["sollT"] = configStore.solltemp; + + int8_t load = (Output - minWindow)*100.0 / (WindowSize - minWindow); + snprintf(buf, sizeof(buf), "%3u%%", load); + lcd.setCursor(12, 0); + lcd.print(buf); + root["load"] = load; + + // We send JSON data to the client + char buffer[JSONSize]; + root.printTo(buffer, sizeof(buffer)); + webserverManager.events.send(buffer, "message"); +} diff --git a/Brauhelferlein.aps b/Brauhelferlein.aps new file mode 100644 index 0000000..db550f2 Binary files /dev/null and b/Brauhelferlein.aps differ diff --git a/Brauhelferlein.sln b/Brauhelferlein.sln new file mode 100644 index 0000000..3d45b94 --- /dev/null +++ b/Brauhelferlein.sln @@ -0,0 +1,22 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio 14 +VisualStudioVersion = 14.0.25420.1 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "Brauhelferlein", "Brauhelferlein.vcxproj", "{C5F80730-F44F-4478-BDAE-6634EFC2CA88}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|x86 = Debug|x86 + Release|x86 = Release|x86 + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {C5F80730-F44F-4478-BDAE-6634EFC2CA88}.Debug|x86.ActiveCfg = Debug|Win32 + {C5F80730-F44F-4478-BDAE-6634EFC2CA88}.Debug|x86.Build.0 = Debug|Win32 + {C5F80730-F44F-4478-BDAE-6634EFC2CA88}.Release|x86.ActiveCfg = Release|Win32 + {C5F80730-F44F-4478-BDAE-6634EFC2CA88}.Release|x86.Build.0 = Release|Win32 + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection +EndGlobal diff --git a/Brauhelferlein.vcxproj b/Brauhelferlein.vcxproj new file mode 100644 index 0000000..f1a81ef --- /dev/null +++ b/Brauhelferlein.vcxproj @@ -0,0 +1,103 @@ + + + + + Debug + Win32 + + + Release + Win32 + + + + {C5F80730-F44F-4478-BDAE-6634EFC2CA88} + $safeprojectname$ + Brauhelferlein + + + + Application + true + + + MultiByte + + + Application + false + + + true + MultiByte + + + + + + + + + + + + + + + Level3 + Disabled + true + C:\Dev\IoT\Arduino\libraries\OneWire-master;C:\Dev\IoT\Arduino\libraries\Arduino-Temperature-Control-Library-master;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\libraries\Wire;C:\Program Files (x86)\Arduino\libraries\LiquidCrystal\src;C:\Dev\IoT\Arduino\libraries\ArduinoJson-master;C:\Dev\IoT\Arduino\libraries\Arduino-PID-Library-master;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\libraries\EEPROM;C:\Dev\IoT\Arduino\libraries\ESPAsyncTCP-master\src;C:\Dev\IoT\Arduino\libraries\ESPAsyncWebServer-master\src;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\libraries\ESP8266WiFi\src;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\libraries\Hash\src;C:\Dev\IoT\Arduino\libraries\ArduinoJson-master\utility;C:\Dev\IoT\Arduino\libraries\Arduino-PID-Library-master\utility;C:\Dev\IoT\Arduino\libraries\Arduino-Temperature-Control-Library-master\utility;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\libraries\EEPROM\utility;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\libraries\ESP8266WiFi\src\utility;C:\Dev\IoT\Arduino\libraries\ESPAsyncTCP-master\src\utility;C:\Dev\IoT\Arduino\libraries\ESPAsyncWebServer-master\src\utility;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\libraries\Hash\src\utility;C:\Program Files (x86)\Arduino\libraries\LiquidCrystal\src\utility;C:\Dev\IoT\Arduino\libraries\OneWire-master\utility;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\libraries\Wire\utility;C:\Program Files (x86)\Arduino\libraries;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\libraries;C:\Dev\IoT\Arduino\libraries;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\cores\esp8266;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\cores\esp8266\libb64;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\cores\esp8266\spiffs;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\cores\esp8266\umm_malloc;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\variants\d1_mini;C:\Dev\IoT\Arduino\Brauhelferlein;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2/tools/sdk/include;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2/tools/sdk/lwip/include;C:\Users\Jens\AppData\Local\Temp\VMicroBuilds\Brauhelferlein\esp8266_d1_mini/core;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\cores\esp8266;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\variants\d1_mini;C:\Dev\IoT\Arduino\libraries\OneWire-master;C:\Dev\IoT\Arduino\libraries\Arduino-Temperature-Control-Library-master;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\libraries\Wire;C:\Program Files (x86)\Arduino\libraries\LiquidCrystal\src;C:\Dev\IoT\Arduino\libraries\ArduinoJson-master;C:\Dev\IoT\Arduino\libraries\Arduino-PID-Library-master;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\libraries\EEPROM;C:\Dev\IoT\Arduino\libraries\ESPAsyncTCP-master\src;C:\Dev\IoT\Arduino\libraries\ESPAsyncWebServer-master\src;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\libraries\ESP8266WiFi\src;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\libraries\Hash\src;C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\IDE\Extensions\kttzedry.umf\Micro Platforms\default\debuggers\VM_DBG;C:\Program Files (x86)\Arduino\libraries;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\libraries;C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\IDE\Extensions\kttzedry.umf\Micro Platforms\default\debuggers;C:\Dev\IoT\Arduino\libraries;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\tools\xtensa-lx106-elf-gcc\1.20.0-26-gb404fb9-2\xtensa-lx106-elf\include\c++\4.8.2;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\tools\xtensa-lx106-elf-gcc\1.20.0-26-gb404fb9-2\xtensa-lx106-elf\include\c++\4.8.2\xtensa-lx106-elf;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\tools\xtensa-lx106-elf-gcc\1.20.0-26-gb404fb9-2\xtensa-lx106-elf\include;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\tools\xtensa-lx106-elf-gcc\1.20.0-26-gb404fb9-2\lib\gcc\xtensa-lx106-elf\4.8.2\include;C:\Users\Jens\AppData\Local\arduino15\packages\esp8266\hardware\esp8266\2.3.0-rc2\tools\sdk\include;%(AdditionalIncludeDirectories) + C:\Dev\IoT\Arduino\Brauhelferlein\__vm\.Brauhelferlein.vsarduino.h;%(ForcedIncludeFiles) + false + __ESP8266_ESp8266__;__ESP8266_ESP8266__;_VMDEBUG=1;__ets__;ICACHE_FLASH;F_CPU=80000000L;LWIP_OPEN_SRC;ARDUINO=106012;ARDUINO_ESP8266_WEMOS_D1MINI;ARDUINO_ARCH_ESP8266;ESP8266;__cplusplus=201103L;%(PreprocessorDefinitions) + + + true + + + + + Level3 + MaxSpeed + true + true + true + + + true + true + true + + + + + + + + CppCode + + + + + + + + + + + + + + + VisualMicroDebugger + + + + + + + + + + \ No newline at end of file diff --git a/Brauhelferlein.vcxproj.filters b/Brauhelferlein.vcxproj.filters new file mode 100644 index 0000000..fb4e05e --- /dev/null +++ b/Brauhelferlein.vcxproj.filters @@ -0,0 +1,45 @@ + + + + + {93995380-89BD-4b04-88EB-625FBE52EBFB} + h;hh;hpp;hxx;hm;inl;inc;xsd + + + {67DA6AB6-F800-4c08-8B7A-83BB121AAD01} + rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms + + + + + + + + Header Files + + + Header Files + + + Header Files + + + Header Files + + + Header Files + + + Header Files + + + Header Files + + + Header Files + + + Header Files + + + \ No newline at end of file diff --git a/ConfigClass.h b/ConfigClass.h new file mode 100644 index 0000000..0da214d --- /dev/null +++ b/ConfigClass.h @@ -0,0 +1,55 @@ +#pragma once + +#ifndef CONFIG_H +#define CONFIG_H + + + +#include +#include "VisualizerClass.h" +#include "Arduino.h" + +#define CONFIG_VERSION 1 +#define CONFIG_START 10 + +struct StoreStruct { + uint8_t version; + double solltemp, consKp, consKi, consKd; +} configStore; + +bool shouldReboot = false; + + +class Config { +public: + Config(Visualizer* aVisualizer) { + this->visualizer = aVisualizer; + EEPROM.begin(512); + } + + void save() { + if(visualizer) visualizer->show("EE save: ",mtSerial_LCD); + EEPROM.put(CONFIG_START, configStore); + EEPROM.commit(); + if (visualizer) visualizer->showSecondary("OK"); + } + + void load() { + if (visualizer) visualizer->show("EE load: ", mtSerial_LCD); + EEPROM.get(CONFIG_START, configStore); + + if (configStore.version != CONFIG_VERSION) + { + configStore.version = CONFIG_VERSION; + configStore.solltemp = 24; + configStore.consKp = 5000; + configStore.consKi = 0; + configStore.consKd = 0; + save(); + } + } +private: + Visualizer* visualizer; +}; + +#endif // !CONFIG_H \ No newline at end of file diff --git a/FileStorageClass.h b/FileStorageClass.h new file mode 100644 index 0000000..8a8892b --- /dev/null +++ b/FileStorageClass.h @@ -0,0 +1,58 @@ +#pragma once + +#ifndef FILESTORAGECLASS_H +#define FILESTORAGECLASS_H + + +#include +#include "Arduino.h" + +class FileStorage { +public: + inline FileStorage(Visualizer* aVisualizer) + { + this->visualizer = aVisualizer; + } + + inline void Initialize() + { + visualizer->show("Init SPIFFS", mtSerial_LCD); + if (!SPIFFS.begin()) visualizer->showSecondary("begin() failed!"); + if (!SPIFFS.format()) visualizer->showSecondary("format() failed!"); + this->visualizer->showSecondary("SPIFFS initialized"); + isInitialized = true; + } + + inline String getHtmlContentFromFile(String aFileName) + { + return this->getTextfileContent(aFileName,"/html/"); + } + +private: + Visualizer* visualizer; + bool isInitialized; + + inline String getTextfileContent(String aFileName, String aPath) + { + if (!isInitialized) + this->Initialize(); + String result = ""; + String file = aPath + aFileName; + + File fileHandle = fileHandle = SPIFFS.open(file, "r"); + if (!fileHandle) + { + visualizer->show("File.open() failed for file: " + aFileName); + return ""; + } + while (fileHandle.available()) + { + result += fileHandle.readStringUntil('\n'); + } + fileHandle.close(); + return result; + } + +}; + +#endif // !FILESTORAGECLASS_H diff --git a/LICENSE b/LICENSE index 9cecc1d..c65825e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,674 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - {one line to give the program's name and a brief idea of what it does.} - Copyright (C) {year} {name of author} - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - {project} Copyright (C) {year} {fullname} - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + {project} Copyright (C) {year} {fullname} + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/PID_Handler.h b/PID_Handler.h new file mode 100644 index 0000000..5c05cc2 --- /dev/null +++ b/PID_Handler.h @@ -0,0 +1,15 @@ +#pragma once + +#include +#include "ConfigClass.h" + +double temperature = 25, Output = 0; +uint32_t lastrun, lastSetpoint = 0, windowStartTime; + +PID pid(&temperature, &Output, &configStore.solltemp, configStore.consKp, configStore.consKi, configStore.consKd, DIRECT); + +inline void resetPID() { + pid.SetMode(MANUAL); + Output = 0; + pid.SetMode(AUTOMATIC); +} diff --git a/README.md b/README.md index 474349e..3db03f7 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,40 @@ -# Brauhelferlein - -Automatisierung des Maische Kochens mit minimalem Aufwand und lediglich eines ESP 8266 eigenständig für keine 10€. - -## Highlights - -- Temperatur PID Regelung auf zehntel Grad genau -- Rührwerk Drehzahlregelung -- Rührwerk Interwall Steuerung -- Graphen für Temperatur Verlauf -- Rast Zeit Erkennung -- Verwendet Wifi Zugang oder stellt eigenen AP bereit -- Web Flash Update - -### Screenshot - -![Screenshot](screenshot.png) - -## Anleitung - -### Benötigt wird - -- ein ESP8266 (D1 mini oder ESP-12E) -- ein Relais oder SSR -- ein DS18b20 Messfühler -- zur Steuerung des Maische Rührwerks (Scheibenwischermotor) einen Motor Treiber zB. VNH2SP30 -- optional ein Display (LCD I2C 1602). - -### Software - -- Arduino 1.6.x -- erweitern mit [ESP8266 Arduino](https://github.com/esp8266/Arduino) -- Installiere libraries - - OneWire.h - - DallasTemperature.h - - NewLiquidCrystal https://bitbucket.org/fmalpartida/new-liquidcrystal/wiki/Home - - PID_v1.h - - ArduinoJson.h - +# Brauhelferlein + +Automatisierung des Maische Kochens mit minimalem Aufwand und lediglich eines ESP 8266 eigenständig für keine 10€. + +## Highlights + +- Temperatur PID Regelung auf zehntel Grad genau +- Rührwerk Drehzahlregelung +- Rührwerk Interwall Steuerung +- Graphen für Temperatur Verlauf +- Rast Zeit Erkennung +- Verwendet Wifi Zugang oder stellt eigenen AP bereit +- Web Flash Update + +### Screenshot + +![Screenshot](screenshot.png) + +## Anleitung + +### Benötigt wird + +- ein ESP8266 (D1 mini oder ESP-12E) +- ein Relais oder SSR +- ein DS18b20 Messfühler +- zur Steuerung des Maische Rührwerks (Scheibenwischermotor) einen Motor Treiber zB. VNH2SP30 +- optional ein Display (LCD I2C 1602). + +### Software + +- Arduino 1.6.x +- erweitern mit [ESP8266 Arduino](https://github.com/esp8266/Arduino) +- Installiere libraries + - OneWire.h + - DallasTemperature.h + - NewLiquidCrystal https://bitbucket.org/fmalpartida/new-liquidcrystal/wiki/Home + - PID_v1.h + - ArduinoJson.h + Enjoy your beer! :) \ No newline at end of file diff --git a/Resource.aps b/Resource.aps new file mode 100644 index 0000000..bf3deac Binary files /dev/null and b/Resource.aps differ diff --git a/Stirrer_Handler.h b/Stirrer_Handler.h new file mode 100644 index 0000000..95228f4 --- /dev/null +++ b/Stirrer_Handler.h @@ -0,0 +1,6 @@ +#pragma once + + +uint8_t mischerOff = 0; +uint8_t mischerOn = 0; +uint16_t mischerPower = 0; \ No newline at end of file diff --git a/StringHelper.h b/StringHelper.h new file mode 100644 index 0000000..a46c7bc --- /dev/null +++ b/StringHelper.h @@ -0,0 +1,17 @@ +//#pragma once +// +//#include +//#include +//#include +//#include "Arduino.h" +// +//template +//String String_format(const String& format, Args ... args) +//{ +// +// size_t size = snprintf(nullptr, 0, format.c_str(), args ...) + 1; // Extra space for '\0' +// std::unique_ptr buf(new char[size]); +// snprintf(buf.get(), size, format.c_str(), args ...); +// auto combined = std::string(buf.get(), buf.get() + size - 1).c_str(); +// return String(combined); +//} \ No newline at end of file diff --git a/VisualizerClass.h b/VisualizerClass.h new file mode 100644 index 0000000..56c7802 --- /dev/null +++ b/VisualizerClass.h @@ -0,0 +1,74 @@ +#pragma once + +#ifndef VISUALIZER_H +#define VISUALIZER_H + +#include +#include "Arduino.h" + +enum MessageLevel { + mlPrimary, + mlSecondary, +}; + +enum MessageTarget { + mtSerial, + mtLCD, + mtSerial_LCD, +}; + +class Visualizer { +public: + + inline Visualizer(LiquidCrystal* aLCD) + { + this->lcd = aLCD; + Serial.begin(115200); + } + inline void show(String aMessage) + { + this->show(aMessage, mlPrimary, mtSerial); + } + inline void show(String aPrimaryMessage, String aSecondaryMessage) + { + this->show(aPrimaryMessage, mlPrimary, mtSerial_LCD); + this->show(aSecondaryMessage, mlSecondary, mtSerial_LCD); + } + inline void showSecondary(String aSecondaryMessage, MessageTarget aMessageTarget = mtSerial_LCD) + { + this->show(aSecondaryMessage, mlSecondary, aMessageTarget); + } + inline void show(String aMessage, MessageTarget aTarget) + { + this->show(aMessage, mlPrimary, aTarget); + } + inline void show(String aMessage, MessageLevel aLevel) + { + this->show(aMessage, aLevel, mtSerial); + } + inline void show(String aMessage, MessageLevel aLevel, MessageTarget aTarget) + { + if (!this->lcd && aTarget == mtLCD) + return; + if (!this->lcd && aTarget == mtSerial_LCD) + aTarget = mtSerial; + if (aTarget == mtSerial || mtSerial_LCD) + { + String prefix = aLevel == mlPrimary ? "" : " -> "; + Serial.println((prefix + aMessage).c_str()); + } + if (aTarget == mtLCD || mtSerial_LCD) + { + int line = aLevel == mlPrimary ? 0 : 1; + if (aLevel == mlPrimary) + lcd->clear(); + lcd->setCursor(0, line); + lcd->print(aMessage.c_str()); + } + } +private: + LiquidCrystal *lcd; + +}; + +#endif // !VISUALIZER_H \ No newline at end of file diff --git a/WebserverManagerClass.h b/WebserverManagerClass.h new file mode 100644 index 0000000..310ebda --- /dev/null +++ b/WebserverManagerClass.h @@ -0,0 +1,141 @@ +#pragma once + +#ifndef WEBSERVERMANAGERCLASS_H +#define WEBSERVERMANAGERCLASS_H + + +#include +#include +#include +#include "FileStorageClass.h" +#include "ConfigClass.h" +#include "StringHelper.h" +#include "PID_Handler.h" +#include "Stirrer_Handler.h" +#include "Arduino.h" + +class WebserverManager { +public: + + AsyncEventSource events = AsyncEventSource("/events"); + Visualizer* visualizer; + inline WebserverManager(Visualizer* aVisualizer, Config* aConfig) + { + this->visualizer = aVisualizer; + this->config = aConfig; + } + inline void startServer() + { + this->visualizer->show("Starting Webserver @ Port 80"); + fileStorage = FileStorage(visualizer); + server = AsyncWebServer(80); + fileStorage.Initialize(); + this->InitWebserverAndEvents(); + server.begin(); + this->visualizer->showSecondary("Webserver started"); + } +private: + FileStorage fileStorage = NULL; + Config* config; + AsyncWebServer server = NULL; + inline void InitWebserverAndEvents() + { + // Start Web server configuration + events.onConnect([this](AsyncEventSourceClient *client) { + if (client->lastId()) { + this->visualizer->show("Client reconnected! Last message ID that it got is: " + client->lastId()); + }}); + server.addHandler(&events); + + // respond to GET requests on URL /heap + server.on("/heap", HTTP_GET, [this](AsyncWebServerRequest *request) { + request->send(200, "text/plain", String(ESP.getFreeHeap())); + }); + // respond to GET requests on URL homepage + server.on("/", HTTP_ANY, [this](AsyncWebServerRequest *request) { + + //Check if POST (but not File) parameter exists + if (request->hasParam("Tsoll", true)) { + AsyncWebParameter* p = request->getParam("Tsoll", true); + if (configStore.solltemp != p->value().toFloat()) { + configStore.solltemp = p->value().toFloat(); + lastSetpoint = 0; + } + } + if (request->hasParam("Mon", true)) { + AsyncWebParameter* p; + p = request->getParam("Mon", true); + mischerOn = p->value().toInt(); + + p = request->getParam("Moff", true); + mischerOff = p->value().toInt(); + + p = request->getParam("MPw", true); + mischerPower = p->value().toInt(); + } + + AsyncResponseStream *response = request->beginResponseStream("text/html"); + + response->addHeader("Server", "ESP Async Web Server"); + response->print(fileStorage.getHtmlContentFromFile("index.html")); + request->send(response); + }); + + + // respond to requests on URL /settings for PID settings + server.on("/settings", HTTP_ANY, [this](AsyncWebServerRequest *request) { + + //Check if POST (but not File) parameter exists + if (request->hasParam("Kp", true)) { + configStore.consKp = request->getParam("Kp", true)->value().toFloat(); + configStore.consKi = request->getParam("Ki", true)->value().toFloat(); + configStore.consKd = request->getParam("Kd", true)->value().toFloat(); + pid.SetTunings(configStore.consKp, configStore.consKi, configStore.consKd); + resetPID(); + config->save(); + } + + AsyncResponseStream *response = request->beginResponseStream("text/html"); + + response->addHeader("Server", "ESP Async Web Server"); + response->printf(fileStorage.getHtmlContentFromFile("settings.html").c_str(), Output, pid.GetKp(), pid.GetKi(), pid.GetKd()); + request->send(response); + }); + // Simple Firmware Update Form + server.on("/update", HTTP_GET, [this](AsyncWebServerRequest *request) { + request->send(200, "text/html", fileStorage.getHtmlContentFromFile("update.html")); + }); + + server.on("/update", HTTP_POST, [this](AsyncWebServerRequest *request) { + shouldReboot = !Update.hasError(); + AsyncWebServerResponse *response = request->beginResponse(200, "text/plain", shouldReboot ? "OK" : "FAIL"); + response->addHeader("Connection", "close"); + request->send(response); + }, [this](AsyncWebServerRequest *request, String filename, std::size_t index, uint8_t *data, std::size_t len, bool final) { + if (!index) { + Serial.printf("Update Start: %s\n", filename.c_str()); + //WiFiUDP::stopAll(); + Update.runAsync(true); + if (!Update.begin((ESP.getFreeSketchSpace() - 0x1000) & 0xFFFFF000)) { + Update.printError(Serial); + } + } + if (!Update.hasError()) { + if (Update.write(data, len) != len) { + Update.printError(Serial); + } + } + if (final) { + if (Update.end(true)) { + Serial.printf("Update Success: %uB\n", index + len); + } + else { + Update.printError(Serial); + } + } + }); + this->visualizer->showSecondary("Server URIs and Events assigned"); + } +}; + +#endif // !WEBSERVERMANAGERCLASS_H \ No newline at end of file diff --git a/WiFiManagerClass.h b/WiFiManagerClass.h new file mode 100644 index 0000000..27cc9bc --- /dev/null +++ b/WiFiManagerClass.h @@ -0,0 +1,85 @@ +#pragma once + +#ifndef WIFIMANAGER_H +#define WIFIMANAGER_H + + +#include "Arduino.h" + +enum WifiConnectionType { + ctAP, + ctSTA, +}; + +class WifiManager { +public: + inline WifiManager(Visualizer* aVisualizer) + { + this->visualizer = aVisualizer; + } + inline void wifiStart(String aAPssid, String aAPpassword, String aSTAssid, String aSTApassword) { + uint8_t i = 0; + bool bResult; + + WiFi.disconnect(); + WiFi.softAPdisconnect(); + WiFi.mode(WIFI_AP_STA); + + visualizer->show("Initializing Soft-AP",mtSerial); + WiFi.softAP(aAPssid.c_str(), aAPpassword.c_str()); + bResult = waitForWiFiConnection(ctAP); + if (bResult) { + visualizer->show("AP ready!", WiFi.softAPIP().toString()); + } + + visualizer->show("Connecting to SSID: " + aSTAssid,mtSerial); + WiFi.begin(aSTAssid.c_str(), aSTApassword.c_str()); + bResult = waitForWiFiConnection(ctSTA); + if (bResult) { + visualizer->show("WiFi IP" + aSTAssid, WiFi.localIP().toString()); + } + } +private: + Visualizer* visualizer; + inline bool waitForWiFiConnection(WifiConnectionType connectionType) + { + switch (connectionType) + { + case ctAP: + for (int i = 0; i < 20; i++) + { + if (WiFi.softAPIP().toString() == "0.0.0.0") { + Serial.print("."); + delay(500); + yield(); + } + else { + visualizer->show(""); + visualizer->showSecondary("AP ready @ IP: " + WiFi.softAPIP().toString()); + return true; + } + } + break; + case ctSTA: + for (int i = 0; i < 20; i++) + { + if (WiFi.status() != WL_CONNECTED) { + Serial.print("."); + delay(500); + yield(); + } + else { + visualizer->show(""); + visualizer->showSecondary("STA WiFi ready @ IP: " + WiFi.localIP().toString()); + return true; + } + } + break; + default: + break; + } + Serial.print(" -> timed out!\n"); + return false; + } +}; +#endif // !WIFIMANAGER_H \ No newline at end of file diff --git a/data/html/index.html b/data/html/index.html new file mode 100644 index 0000000..7218d02 --- /dev/null +++ b/data/html/index.html @@ -0,0 +1,108 @@ + + + +Braustube + + + + + +
+
+
+Braustube +
+
+
+Menu +
+
+
+
+
+
+
+ + + + + + + + + + +
EinstellungenWertSlider
opacity Soll Temperatur:
+

watch_later T erreicht seit:
rotate_right Mischer aktiv::

replay_30 Mischer pausiert:

+
toys Mischer Drehzahl:

+
+
+
+
diff --git a/data/html/js/charts.loader.js b/data/html/js/charts.loader.js new file mode 100644 index 0000000..731b701 --- /dev/null +++ b/data/html/js/charts.loader.js @@ -0,0 +1,152 @@ +(function (){ var aa="\n//# sourceURL=",ba='