merge in master, fix conflicts

.get_version.py

@@ -0,0 +1,32 @@
+from subprocess import check_output
+import os
+import os
+import platform
+import subprocess
+
+dir_path = os.path.dirname(os.path.realpath(__file__))
+os.chdir(dir_path)
+
+# http://stackoverflow.com/questions/11210104/check-if-a-program-exists-from-a-python-script
+def is_tool(name):
+    cmd = "where" if platform.system() == "Windows" else "which"
+    try:
+        check_output([cmd, "git"])
+        return True
+    except:
+        return False;
+
+version = "UNKNOWN"
+
+if is_tool("git"):
+    try:
+        version = check_output(["git", "describe", "--always"]).rstrip()
+    except:
+        try:
+            version = check_output(["git", "rev-parse", "--short", "HEAD"]).rstrip()
+        except:
+            pass
+        pass
+
+
+print("-DMILIGHT_HUB_VERSION=%s" % version)

lib/Settings/Settings.h

@@ -5,12 +5,15 @@
 #ifndef _SETTINGS_H_INCLUDED
 #define _SETTINGS_H_INCLUDED
 
+#define XQUOTE(x) #x
+#define QUOTE(x) XQUOTE(x)
+
 #ifndef FIRMWARE_VARIANT
-#define FIRMWARE_VARIANT "unknown"
+#define FIRMWARE_VARIANT unknown
 #endif
 
 #ifndef MILIGHT_HUB_VERSION
-#define MILIGHT_HUB_VERSION "unknown"
+#define MILIGHT_HUB_VERSION unknown
 #endif
 
 #define SETTINGS_FILE  "/config.json"
@@ -26,12 +29,12 @@
 
 class GatewayConfig {
 public:
-  GatewayConfig(uint16_t deviceId, uint16_t port, uint8_t protocolVersion) 
+  GatewayConfig(uint16_t deviceId, uint16_t port, uint8_t protocolVersion)
     : deviceId(deviceId),
       port(port),
       protocolVersion(protocolVersion)
     { }
-  
+
   const uint16_t deviceId;
   const uint16_t port;
   const uint8_t protocolVersion;
@@ -53,13 +56,13 @@ public:
     httpRepeatFactor(5),
     _autoRestartPeriod(0)
   { }
-  
+
   ~Settings() {
     if (deviceIds) {
       delete deviceIds;
     }
   }
-  
+
   bool hasAuthSettings();
   bool isAutoRestartEnabled();
   size_t getAutoRestartPeriod();
@@ -67,14 +70,14 @@ public:
   static void deserialize(Settings& settings, String json);
   static void deserialize(Settings& settings, JsonObject& json);
   static void load(Settings& settings);
-  
+
   void save();
   String toJson(const bool prettyPrint = true);
   void serialize(Stream& stream, const bool prettyPrint = false);
   void updateDeviceIds(JsonArray& arr);
   void updateGatewayConfigs(JsonArray& arr);
   void patch(JsonObject& obj);
-  
+
   String adminUsername;
   String adminPassword;
   uint8_t cePin;
@@ -85,9 +88,9 @@ public:
   size_t numDeviceIds;
   size_t packetRepeats;
   size_t httpRepeatFactor;
-  
+
 protected:
   size_t _autoRestartPeriod;
 };
 
-#endif 
+#endif

lib/WebServer/MiLightHttpServer.cpp

@@ -8,7 +8,7 @@
 
 void MiLightHttpServer::begin() {
   applySettings(settings);
-  
+
   server.on("/", HTTP_GET, handleServeFile(WEB_INDEX_FILENAME, "text/html", DEFAULT_INDEX_PAGE));
   server.on("/settings", HTTP_GET, handleServeFile(SETTINGS_FILE, "application/json"));
   server.on("/settings", HTTP_PUT, [this]() { handleUpdateSettings(); });
@@ -22,11 +22,11 @@ void MiLightHttpServer::begin() {
   server.on("/about", HTTP_GET, [this]() { handleAbout(); });
   server.on("/latest_release", HTTP_GET, [this]() { handleGetLatestRelease(); });
   server.on("/system", HTTP_POST, [this]() { handleSystemPost(); });
-  server.on("/firmware", HTTP_POST, 
+  server.on("/firmware", HTTP_POST,
     [this](){
       server.sendHeader("Connection", "close");
       server.sendHeader("Access-Control-Allow-Origin", "*");
-      
+
       if (Update.hasError()) {
         server.send_P(
           500,
@@ -40,7 +40,7 @@ void MiLightHttpServer::begin() {
           PSTR("Success. Device will now reboot.")
         );
       }
-      
+
       ESP.restart();
     },
     [this](){
@@ -64,7 +64,7 @@ void MiLightHttpServer::begin() {
       yield();
     }
   );
-  
+
   server.begin();
 }
 
@@ -75,9 +75,9 @@ void MiLightHttpServer::handleGetLatestRelease() {
     MILIGHT_GITHUB_REPO,
     "/releases/latest"
   );
-  
+
   Serial.println(path);
-  
+
   // This is an ugly hack, but probably not worth optimizing. The nice way
   // to do this would be to extract the content len from GitHub's response
   // and stream the body to the server directly. But this would require parsing
@@ -85,16 +85,16 @@ void MiLightHttpServer::handleGetLatestRelease() {
   // it's worth.
   const String& fsPath = "/_cv.json";
   size_t tries = 0;
-  
+
   while (tries++ < MAX_DOWNLOAD_ATTEMPTS && !client.download(path, fsPath)) {
     Serial.println(F("Failed download attempt."));
   }
-  
+
   if (!SPIFFS.exists(fsPath)) {
     server.send_P(500, "text/plain", PSTR("Failed to stream API request from GitHub. Check Serial logs for more information."));
     return;
   }
-  
+
   File file = SPIFFS.open(fsPath, "r");
   server.streamFile(file, "application/json");
   SPIFFS.remove(fsPath);
@@ -107,20 +107,20 @@ void MiLightHttpServer::handleClient() {
 void MiLightHttpServer::handleSystemPost() {
   DynamicJsonBuffer buffer;
   JsonObject& request = buffer.parse(server.arg("plain"));
-  
+
   bool handled = false;
-  
+
   if (request.containsKey("command")) {
     if (request["command"] == "restart") {
       Serial.println(F("Restarting..."));
       server.send(200, "text/plain", "true");
-      
+
       delay(100);
-      
+
       ESP.restart();
     }
   }
-  
+
   if (handled) {
     server.send(200, "text/plain", "true");
   } else {
@@ -131,13 +131,13 @@ void MiLightHttpServer::handleSystemPost() {
 void MiLightHttpServer::handleDownloadUpdate(const UrlTokenBindings* bindings) {
   GithubClient downloader = GithubClient::rawDownloader();
   const String& component = bindings->get("component");
-  
+
   if (component.equalsIgnoreCase("web")) {
     Serial.println(F("Attempting to update web UI..."));
-    
+
     bool result = false;
     size_t tries = 0;
-    
+
     while (!result && tries++ <= MAX_DOWNLOAD_ATTEMPTS) {
       printf("building url\n");
       String urlPath = GithubClient::buildRepoPath(
@@ -145,14 +145,14 @@ void MiLightHttpServer::handleDownloadUpdate(const UrlTokenBindings* bindings) {
         MILIGHT_GITHUB_REPO,
         MILIGHT_REPO_WEB_PATH
       );
-      
+
       printf("URL: %s\n", urlPath.c_str());
-      
+
       result = downloader.download(urlPath, WEB_INDEX_FILENAME);
     }
-    
+
     Serial.println(F("Download complete!"));
-    
+
     if (result) {
       server.sendHeader("Location", "/");
       server.send(302);
@@ -171,47 +171,47 @@ void MiLightHttpServer::applySettings(Settings& settings) {
   } else {
     server.disableAuthentication();
   }
-  
+
   milightClient->setResendCount(settings.packetRepeats);
 }
 
 void MiLightHttpServer::onSettingsSaved(SettingsSavedHandler handler) {
   this->settingsSavedHandler = handler;
 }
-  
+
 void MiLightHttpServer::handleAbout() {
   DynamicJsonBuffer buffer;
   JsonObject& response = buffer.createObject();
-  
-  response["version"] = MILIGHT_HUB_VERSION;
-  response["variant"] = FIRMWARE_VARIANT;
-  
+
+  response["version"] = QUOTE(MILIGHT_HUB_VERSION);
+  response["variant"] = QUOTE(FIRMWARE_VARIANT);
+
   String body;
   response.printTo(body);
-  
-  server.send(200, "application", body); 
+
+  server.send(200, "application", body);
 }
-  
+
 void MiLightHttpServer::handleGetRadioConfigs() {
   DynamicJsonBuffer buffer;
   JsonArray& arr = buffer.createArray();
-  
+
   for (size_t i = 0; i < MiLightRadioConfig::NUM_CONFIGS; i++) {
     const MiLightRadioConfig* config = MiLightRadioConfig::ALL_CONFIGS[i];
     arr.add(config->name);
   }
-  
+
   String body;
   arr.printTo(body);
-  
+
   server.send(200, "application/json", body);
 }
-  
+
 ESP8266WebServer::THandlerFunction MiLightHttpServer::handleServeFile(
-  const char* filename, 
-  const char* contentType, 
+  const char* filename,
+  const char* contentType,
   const char* defaultText) {
-    
+
   return [this, filename, contentType, defaultText]() {
     if (!serveFile(filename)) {
       if (defaultText) {
@@ -230,14 +230,14 @@ bool MiLightHttpServer::serveFile(const char* file, const char* contentType) {
     f.close();
     return true;
   }
-  
+
   return false;
 }
 
 ESP8266WebServer::THandlerFunction MiLightHttpServer::handleUpdateFile(const char* filename) {
   return [this, filename]() {
     HTTPUpload& upload = server.upload();
-    
+
     if (upload.status == UPLOAD_FILE_START) {
       updateFile = SPIFFS.open(filename, "w");
     } else if(upload.status == UPLOAD_FILE_WRITE){
@@ -254,14 +254,14 @@ void MiLightHttpServer::handleUpdateSettings() {
   DynamicJsonBuffer buffer;
   const String& rawSettings = server.arg("plain");
   JsonObject& parsedSettings = buffer.parse(rawSettings);
-  
+
   if (parsedSettings.success()) {
     settings.patch(parsedSettings);
     settings.save();
-    
+
     this->applySettings(settings);
     this->settingsSavedHandler();
-    
+
     server.send(200, "application/json", "true");
   } else {
     server.send(400, "application/json", "\"Invalid JSON\"");
@@ -271,140 +271,140 @@ void MiLightHttpServer::handleUpdateSettings() {
 void MiLightHttpServer::handleListenGateway(const UrlTokenBindings* bindings) {
   bool available = false;
   MiLightRadioConfig* config = MiLightRadioConfig::fromString(bindings->get("type"));
-  
+
   if (config == NULL) {
     String body = "Unknown device type: ";
     body += bindings->get("type");
-    
+
     server.send(400, "text/plain", body);
     return;
   }
-  
+
   milightClient->prepare(*config, 0, 0);
-  
+
   while (!available) {
     if (!server.clientConnected()) {
       return;
     }
-    
+
     if (milightClient->available()) {
       available = true;
     }
-    
+
     yield();
   }
-  
+
   uint8_t packet[config->getPacketLength()];
   milightClient->read(packet);
-  
+
   char response[200];
   char* responseBuffer = response;
-  
+
   responseBuffer += sprintf(responseBuffer, "\nPacket received (%d bytes):\n", sizeof(packet));
   milightClient->formatPacket(packet, responseBuffer);
-  
+
   server.send(200, "text/plain", response);
 }
 
 void MiLightHttpServer::handleUpdateGroup(const UrlTokenBindings* urlBindings) {
   DynamicJsonBuffer buffer;
   JsonObject& request = buffer.parse(server.arg("plain"));
-  
+
   if (!request.success()) {
     server.send(400, "text/plain", F("Invalid JSON"));
     return;
   }
-  
+
   const uint16_t deviceId = parseInt<uint16_t>(urlBindings->get("device_id"));
   const uint8_t groupId = urlBindings->get("group_id").toInt();
   MiLightRadioConfig* config = MiLightRadioConfig::fromString(urlBindings->get("type"));
-  
+
   if (config == NULL) {
     String body = "Unknown device type: ";
     body += urlBindings->get("type");
     server.send(400, "text/plain", body);
     return;
   }
-  
+
   milightClient->setResendCount(
     settings.httpRepeatFactor * settings.packetRepeats
   );
   milightClient->prepare(*config, deviceId, groupId);
-  
+
   if (request.containsKey("status")) {
     const String& statusStr = request.get<String>("status");
     MiLightStatus status = (statusStr == "on" || statusStr == "true") ? ON : OFF;
     milightClient->updateStatus(status);
   }
-      
+
   if (request.containsKey("command")) {
     if (request["command"] == "unpair") {
       milightClient->unpair();
     }
-    
+
     if (request["command"] == "pair") {
       milightClient->pair();
     }
-    
+
     if (request["command"] == "set_white") {
       milightClient->updateColorWhite();
     }
-    
+
     if (request["command"] == "level_up") {
       milightClient->increaseBrightness();
     }
-    
+
     if (request["command"] == "level_down") {
       milightClient->decreaseBrightness();
     }
-    
+
     if (request["command"] == "temperature_up") {
       milightClient->increaseTemperature();
     }
-    
+
     if (request["command"] == "temperature_down") {
       milightClient->decreaseTemperature();
     }
-    
+
     if (request["command"] == "next_mode") {
       milightClient->nextMode();
     }
-    
+
     if (request["command"] == "previous_mode") {
       milightClient->previousMode();
     }
-    
+
     if (request["command"] == "mode_speed_down") {
       milightClient->modeSpeedDown();
     }
-    
+
     if (request["command"] == "mode_speed_up") {
       milightClient->modeSpeedUp();
     }
   }
-  
+
   if (request.containsKey("hue")) {
     milightClient->updateHue(request["hue"]);
   }
-    
+
   if (request.containsKey("level")) {
     milightClient->updateBrightness(request["level"]);
   }
-    
+
   if (request.containsKey("temperature")) {
     milightClient->updateTemperature(request["temperature"]);
   }
-  
+
   if (request.containsKey("saturation")) {
     milightClient->updateSaturation(request["saturation"]);
   }
-  
+
   if (request.containsKey("mode")) {
     milightClient->updateMode(request["mode"]);
   }
-  
+
   milightClient->setResendCount(settings.packetRepeats);
-  
+
   server.send(200, "application/json", "true");
 }
 
@@ -412,29 +412,29 @@ void MiLightHttpServer::handleSendRaw(const UrlTokenBindings* bindings) {
   DynamicJsonBuffer buffer;
   JsonObject& request = buffer.parse(server.arg("plain"));
   MiLightRadioConfig* config = MiLightRadioConfig::fromString(bindings->get("type"));
-  
+
   if (config == NULL) {
     String body = "Unknown device type: ";
     body += bindings->get("type");
-    
+
     server.send(400, "text/plain", body);
     return;
   }
-  
+
   uint8_t packet[config->getPacketLength()];
   const String& hexPacket = request["packet"];
   hexStrToBytes<uint8_t>(hexPacket.c_str(), hexPacket.length(), packet, config->getPacketLength());
-  
+
   size_t numRepeats = MILIGHT_DEFAULT_RESEND_COUNT;
   if (request.containsKey("num_repeats")) {
     numRepeats = request["num_repeats"];
   }
-  
+
   milightClient->prepare(*config, 0, 0);
-  
+
   for (size_t i = 0; i < numRepeats; i++) {
     milightClient->write(packet);
   }
-  
+
   server.send(200, "text/plain", "true");
-}
+}

platformio.ini

@@ -16,7 +16,8 @@ lib_deps_external =
   RF24
   WiFiManager
   ArduinoJson
-build_flags = !echo -D MILIGHT_HUB_VERSION=\\\"$(git describe --always)\\\" -D MILIGHT_UDP_DEBUG
+build_flags = !python .get_version.py
+# -D MILIGHT_UDP_DEBUG
 
 [env:nodemcuv2]
 platform = espressif8266
@@ -25,7 +26,7 @@ board = nodemcuv2
 lib_deps =
   ${common.lib_deps_builtin}
   ${common.lib_deps_external}
-build_flags = ${common.build_flags} -D FIRMWARE_VARIANT=\\\"nodemcuv2\\\"
+build_flags = ${common.build_flags} -D FIRMWARE_VARIANT=nodemcuv2
 
 [env:d1_mini]
 platform = espressif8266
@@ -34,13 +35,13 @@ board = d1_mini
 lib_deps =
   ${common.lib_deps_builtin}
   ${common.lib_deps_external}
-build_flags = ${common.build_flags} -D FIRMWARE_VARIANT=\\\"d1_mini\\\"
+build_flags = ${common.build_flags} -D FIRMWARE_VARIANT=d1_mini
 
 [env:esp12]
 platform = espressif8266
 board = esp12e
 framework = arduino
-build_flags = ${common.build_flags} -Wl,-Tesp8266.flash.4m1m.ld -D FIRMWARE_VARIANT=\\\"esp12\\\"
+build_flags = ${common.build_flags} -Wl,-Tesp8266.flash.4m1m.ld -D FIRMWARE_VARIANT=esp12
 lib_deps =
   ${common.lib_deps_builtin}
   ${common.lib_deps_external}
@@ -49,7 +50,7 @@ lib_deps =
 platform = espressif8266
 board = esp07
 framework = arduino
-build_flags = ${common.build_flags} -Wl,-Tesp8266.flash.1m64.ld -D FIRMWARE_VARIANT=\\\"esp07\\\"
+build_flags = ${common.build_flags} -Wl,-Tesp8266.flash.1m64.ld -D FIRMWARE_VARIANT=esp07
 lib_deps =
   ${common.lib_deps_builtin}
   ${common.lib_deps_external}