homieiot · timpur · Sep 22, 2016 · Sep 22, 2016 · Jun 29, 2017 · Nov 15, 2017
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -8,13 +8,13 @@ jobs:
       - checkout
       - run:
           name: install PlatformIO
-          command: sudo pip install -U https://github.com/platformio/platformio-core/archive/develop.zip
+          command: sudo pip install -U platformio
       - run:
           name: install current code as a PlatformIO library with all dependencies
           command: platformio lib -g install file://.
       - run:
-          name: install staging version of Arduino Core for ESP8266
-          command: platformio platform install https://github.com/platformio/platform-espressif8266.git#feature/stage
+          name: install Arduino Core for ESP8266
+          command: platformio platform install espressif8266
       - run:
           name: install exemples dependencies
           command: platformio lib -g install Shutters@2.1.1 SonoffDual@1.1.0

diff --git a/README.md b/README.md
@@ -7,6 +7,8 @@ Homie for ESP8266
 
 An Arduino for ESP8266 implementation of [Homie](https://github.com/marvinroger/homie), an MQTT convention for the IoT.
 
+Currently Homie for ESP8266 implements [Homie 2.0.1](https://github.com/marvinroger/homie/releases/tag/v2.0.1)
+
 ## Note for v1.x users
 
 The old configurator is not available online anymore. You can download it [here](https://github.com/marvinroger/homie-esp8266/releases/download/v1.5.0/homie-esp8266-v1-setup.zip).

diff --git a/data/homie/README.md b/data/homie/README.md
@@ -4,7 +4,9 @@
 This folder contains the data you can upload to the SPIFFS of your ESP8266.
 This is optional.
 
-To upload files to the SPIFFS of your device, create a folder named `data` in your sketch directory. In this `data` folder, create an `homie` directory. You can put two files in it:
+To upload files to the SPIFFS of your device, first create a folder named `data` in your sketch directory. In this `data` folder, create an `homie` directory. You can put two files in it:
 
 1. The `config.json` file, if you want to bypass the `configuration` mode.
 2. The `ui_bundle.gz` file, that you can download [here](http://setup.homie-esp8266.marvinroger.fr/ui_bundle.gz). If present, the configuration UI will be served directly from the ESP8266.
+
+Finally initiate the [SPIFFS upload process](http://docs.platformio.org/en/stable/platforms/espressif8266.html?highlight=spiffs#uploading-files-to-file-system-spiffs) via PlatformIO, or via the [Arduino IDE](http://esp8266.github.io/Arduino/versions/2.3.0/doc/filesystem.html#uploading-files-to-file-system)
diff --git a/docs/advanced-usage/custom-settings.md b/docs/advanced-usage/custom-settings.md
@@ -36,3 +36,17 @@ For this example, if you want to provide the `percentage` setting, you will have
 See the following example for a concrete use case:
 
 [![GitHub logo](../assets/github.png) CustomSettings.ino](https://github.com/marvinroger/homie-esp8266/blob/develop/examples/CustomSettings/CustomSettings.ino)
+
+You can also change the value of the setting at any time via updates to the config file or via code using:
+
+```c++
+percentageSetting.set(50, true);
+```
+
+You can also load the value of setthings from the config file before homie is setup. This is useful when you need these settings to setup nodes before you call `Homie.setup`.
+
+```c++
+Homie.loadSettings();
+```
+
+See the [API](http://marvinroger.github.io/homie-esp8266/docs/develop/others/cpp-api-reference/#homiesetting) for more information.
diff --git a/docs/advanced-usage/miscellaneous.md b/docs/advanced-usage/miscellaneous.md
@@ -25,6 +25,7 @@ You can get access to the configuration of the device. The representation of the
 struct ConfigStruct {
   char* name;
   char* deviceId;
+  uint16_t deviceStatsInterval;
 
   struct WiFi {
     char* ssid;
@@ -35,6 +36,11 @@ struct ConfigStruct {
     struct Server {
       char* host;
       uint16_t port;
+      struct {
+        bool enabled;
+        bool hasFingerprint;
+        uint8_t fingerprint[MAX_FINGERPRINT_SIZE];
+      } ssl;
     } server;
     char* baseTopic;
     bool auth;

diff --git a/docs/configuration/http-json-api.md b/docs/configuration/http-json-api.md
@@ -49,7 +49,10 @@ If anything goes wrong, a return code != 2xx will be returned, with a JSON `erro
     ```json
     {
       "hardware_device_id": "52a8fa5d",
-      "homie_esp8266_version": "2.0.0",
+      "homie_version": "2.0.0",
+      "homie_esp8266_version": "2.1.0",
+      "device_config_state": false,
+      "device_config_state_error": "ERROR MESSAGE",
       "firmware": {
         "name": "awesome-device",
         "version": "1.0.0"
@@ -116,6 +119,60 @@ If anything goes wrong, a return code != 2xx will be returned, with a JSON `erro
 
 --------------
 
+??? summary "GET `/config`"
+    Retrieve the Config file of the device.
+
+    ## Response
+
+    !!! success "In case of success"
+        `200 OK (application/json)`
+
+        ```json
+        {
+          "name": "The kitchen light",
+          "device_id": "kitchen-light",
+          "device_stats_interval": 60,
+          "wifi": {
+            "ssid": "Network_1",
+            "password": "I'm a Wi-Fi password!",
+            "bssid": "DE:AD:BE:EF:BA:BE",
+            "channel": 1,
+            "ip": "192.168.1.5",
+            "mask": "255.255.255.0",
+            "gw": "192.168.1.1",
+            "dns1": "8.8.8.8",
+            "dns2": "8.8.4.4"
+          },
+          "mqtt": {
+            "host": "192.168.1.10",
+            "port": 1883,
+            "base_topic": "devices/",
+            "auth": true,
+            "username": "user",
+            "password": "pass",
+            "ssl": true,
+            "ssl_fingerprint": "a27992d3420c89f293d351378ba5f5675f74fe3c"
+          },
+          "ota": {
+            "enabled": true
+          },
+          "settings": {
+            "percentage": 55
+          }
+        }
+        ```
+
+    !!! failure "In case there was something wrong loading the current config."
+        `500 Service Unavailable (application/json)`
+
+        ```json
+        {
+          "error": "ERROR MESSAGE"
+        }
+        ```
+
+--------------
+
 ??? summary "PUT `/config`"
     Save the config to the device.
 
@@ -158,7 +215,39 @@ If anything goes wrong, a return code != 2xx will be returned, with a JSON `erro
 
 --------------
 
-??? summary "GET `/wifi/connect`"
+??? summary "POST `/config/patch`"
+    Save the config to the device via incremental patches.
+
+    ## Request body
+
+    `(application/json)`
+
+    See [JSON configuration file](json-configuration-file.md).
+
+    ## Response
+
+    !!! success "In case of success"
+        `200 OK (application/json)`
+
+        ```json
+        {
+          "success": true
+        }
+        ```
+
+    !!! failure "In case of error in the payload"
+        `400 Bad Request (application/json)`
+
+        ```json
+        {
+          "success": false,
+          "error": "Reason why the payload is invalid"
+        }
+        ```
+
+--------------
+
+??? summary "POST `/wifi/connect`"
     Initiates the connection of the device to the Wi-Fi network while in configuation mode. This request is not synchronous and the result (Wi-Fi connected or not) must be obtained by with `GET /wifi/status`.
 
     ## Request body
@@ -221,7 +310,7 @@ If anything goes wrong, a return code != 2xx will be returned, with a JSON `erro
 
 --------------
 
-??? summary "PUT `/proxy/control`"
+??? summary "POST `/proxy/control`"
     Enable/disable the device to act as a transparent proxy between AP and Station networks.
 
     All requests that don't collide with existing API paths will be bridged to the destination according to the `Host` HTTP header. The destination host is called using the existing Wi-Fi connection (established after a `PUT /wifi/connect`) and all contents are bridged back to the connection made to the AP side.

diff --git a/docs/configuration/json-configuration-file.md b/docs/configuration/json-configuration-file.md
@@ -24,7 +24,9 @@ Below is the format of the JSON configuration you will have to provide:
     "base_topic": "devices/",
     "auth": true,
     "username": "user",
-    "password": "pass"
+    "password": "pass",
+    "ssl": true,
+    "ssl_fingerprint": "a27992d3420c89f293d351378ba5f5675f74fe3c"
   },
   "ota": {
     "enabled": true
@@ -45,7 +47,8 @@ Here are the rules:
 * `bssid`, `channel`, `ip`, `mask`, `gw`, `dns1`, `dns2` are not mandatory and are only needed to if there is a requirement to specify particular AP or set Static IP address. There are some rules which needs to be satisfied:
    - `bssid` and `channel` have to be defined together and these settings are independand of settings related to static IP
    - to define static IP, `ip` (IP address), `mask` (netmask) and `gw` (gateway) settings have to be defined at the same time
-   - to define second DNS `dns2` the first one `dns1` has to be defined. Set DNS without `ip`, `mask` and `gw` does not affect the configuration (dns server will be provided by DHCP). It is not required to set DNS servers.
+   - to define second DNS `dns2` the first one `dns1` has to be defined. Set `ip`, `mask` and `gw` without DNS, does not affect the configuration (dns server will be provided by DHCP). It is not required to set DNS servers.
+* `ssl_fingerprint` is not required if `ssl` is enabled.
 
 
 Default values if not provided:
@@ -55,5 +58,6 @@ Default values if not provided:
 * `mqtt.port`: `1883`
 * `mqtt.base_topic`: `homie/`
 * `mqtt.auth`: `false`
+* `mqtt.ssl`: `false`
 
 The `mqtt.host` field can be either an IP or an hostname.
diff --git a/docs/others/cpp-api-reference.md b/docs/others/cpp-api-reference.md
@@ -1,4 +1,5 @@
 # Homie
+## Main
 
 You don't have to instantiate an `Homie` instance, it is done internally.
 
@@ -20,7 +21,7 @@ Handle Homie work.
 !!! warning "Mandatory!"
     Must be called once in `loop()`.
 
-## Functions to call *before* `Homie.setup()`
+### Functions to call *before* `Homie.setup()`
 
 ```c++
 void Homie_setFirmware(const char* name, const char* version);
@@ -45,6 +46,16 @@ Set the brand of the device, used in the configuration AP, the device hostname a
 
 * **`name`**: Name of the brand. Default value is `Homie`
 
+```c++
+bool loadSettings();
+```
+
+Validates settings and loads the config file setting values. Returns true if the config file load was successful and false if it failed.
+
+**Note**, if config file load faild then only default values will be present.
+
+**Note**, since this method loads the config file, you can also use `getConfiguration()` before `setup()`.
+
 ```c++
 Homie& disableLogging();
 ```
@@ -119,7 +130,7 @@ Set the event handler. Useful if you want to hook to Homie events.
 Homie& setResetTrigger(uint8_t pin, uint8_t state, uint16_t time);
 ```
 
-Set the reset trigger. By default, the device will reset when pin `0` is `LOW` for `5000`ms.
+Set the reset trigger and the Homie Button. By default, the device will reset when pin `0` is `LOW` for `5000`ms. This Homie button can also be used by the user with `setHomieButtonClick(fnc)` and also used to swap between boot modes. This is usefull to update the config.
 
 * **`pin`**: Pin of the reset trigger
 * **`state`**: Reset when the pin reaches this state for the given time
@@ -153,13 +164,27 @@ Homie& setStandalone();
 
 This will mark the Homie firmware as standalone, meaning it will first boot in `standalone` mode. To configure it and boot to `configuration` mode, the device has to be resetted.
 
-## Functions to call *after* `Homie.setup()`
+```c++
+  HomieClass& setHomieButtonClick(std::function<void()> function);
+```
+
+You can provide the function that will be called when the homie button is clicked.
+
+* **`callback`**: Loop function
+
+### Functions to call *after* `Homie.setup()`
+
+```c++
+void reboot();
+```
+
+Flag the device for reboot (restart).
 
 ```c++
 void reset();
 ```
 
-Flag the device for reset.
+Flag the device for reset (Wipes config).
 
 ```c++
 void setIdle(bool idle);
@@ -179,7 +204,7 @@ Prepare the device for deep sleep. It ensures messages are sent and disconnects
 void doDeepSleep(uint32_t time_us = 0, RFMode mode = RF_DEFAULT);
 ```
 
-Puth the device into deep sleep. It ensures the Serial is flushed.
+Puts the device into deep sleep. It ensures the Serial is flushed.
 
 ```c++
 bool isConfigured() const;
@@ -214,9 +239,21 @@ Logger& getLogger();
 
 Get the underlying `Logger` object, which is only a wrapper around `Serial` by default.
 
+```c++
+String getDeviceID();
+```
+
+Get the Device ID, which homie is using. Could be the config `device_id` or the inertnal device `mac`.
+
+```c++
+HomieBootMode getHomieBootMode();
+```
+
+Get the boot mode of homie: `UNDEFINED,STANDALONE,CONFIGURATION,NORMAL`.
+
 -------
 
-# HomieNode
+## HomieNode
 
 ```c++
 HomieNode(const char* id, const char* type, std::function<bool(const String& property, const HomieRange& range, const String& value)> handler = );
@@ -282,7 +319,7 @@ uint16_t send(const String& value);  // finally send the property, return the pa
 
 Method names should be self-explanatory.
 
-# HomieSetting
+## HomieSetting
 
 ```c++
 HomieSetting<T>(const char* name, const char* description);
@@ -300,6 +337,12 @@ T get() const;
 
 Get the default value if the setting is optional and not provided, or the provided value if the setting is required or optional but provided.
 
+```c++
+bool set(T value, bool saveToConfig = false);
+```
+
+Sets the setting to a new value. Use `saveToConfig` to eaither save this new value to the config file or just use it in memory.
+
 ```c++
 bool wasProvided() const;
 ```

diff --git a/docs/others/homie-implementation-specifics.md b/docs/others/homie-implementation-specifics.md
@@ -8,6 +8,10 @@ The Homie `$implementation` identifier is `esp8266`.
 
 * `$implementation/reset`: You can publish a `true` to this topic to reset the device
 
+# Restart
+
+* `$implementation/restart`: You can publish a `true` to this topic to restart the device
+
 # Configuration
 
 * `$implementation/config`: The `configuration.json` is published there, with `wifi.password`, `mqtt.username` and `mqtt.password` fields stripped

diff --git a/docs/quickstart/getting-started.md b/docs/quickstart/getting-started.md
@@ -23,7 +23,7 @@ There is a YouTube video with instructions:
 
 Homie for ESP8266 has 5 dependencies:
 
-* [ArduinoJson](https://github.com/bblanchon/ArduinoJson) >= 5.0.8
+* [ArduinoJson](https://github.com/bblanchon/ArduinoJson) >= 5.10.0
 * [Bounce2](https://github.com/thomasfredericks/Bounce2)
 * [ESPAsyncTCP](https://github.com/me-no-dev/ESPAsyncTCP) >= [c8ed544](https://github.com/me-no-dev/ESPAsyncTCP)
 * [AsyncMqttClient](https://github.com/marvinroger/async-mqtt-client)