Bump to 1.5.0

homieiot · Apr 23, 2016 · 64fc541 · 64fc541
1 parent 8fb6d92
commit 64fc541
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 7 deletions.
diff --git a/docs/5.-JSON-configuration-file.md b/docs/5.-JSON-configuration-file.md
@@ -15,6 +15,7 @@ Below is the format of the JSON configuration you will have to provide:
   "mqtt": {
     "host": "192.168.1.10",
     "port": 1883,
+    "mdns": "mqtt",
     "base_topic": "devices/",
     "auth": true,
     "username": "user",
@@ -26,6 +27,7 @@ Below is the format of the JSON configuration you will have to provide:
     "enabled": true,
     "host": "192.168.1.10",
     "port": 80,
+    "mdns": "ota",
     "path": "/custom_ota",
     "ssl": true,
     "fingerprint": "CF 05 98 89 CA FF 8E D8 5E 5C E0 C2 E4 F7 E6 C3 C7 50 DD 5C"
@@ -35,9 +37,12 @@ Below is the format of the JSON configuration you will have to provide:
 
 The above JSON contains every field that can be customized.
 
-`name`, `wifi.ssid`, `wifi.password`, `mqtt.host` and `ota.enabled` are mandatory. `wifi.password` can be `""` if connecting to an open network.
+Here are the rules:
 
-If `mqtt.auth` is `true`, `mqtt.username` and `mqtt.password` must be provided.
+* `name`, `wifi.ssid`, `wifi.password`, `mqtt.host` (or `mqtt.mdns`) and `ota.enabled` are mandatory
+* `wifi.password` can be `""` if connecting to an open network
+* If `mqtt.auth` is `true`, `mqtt.username` and `mqtt.password` must be provided
+* If a `mdns` field is set, the device will ignore the `host` and `port` fields and query for the corresponding mDNS service and get the first IP and port found
 
 Default values if not provided:
 
@@ -51,6 +56,8 @@ Default values if not provided:
 * `ota.path`: `/ota`
 * `ota.ssl`: `false`
 
+`host` fields can be either an IP or an hostname.
+
 The SSL fingerprints can be of the following format:
 
 * `CF 05 98 89 CA FF 8E D8 5E 5C E0 C2 E4 F7 E6 C3 C7 50 DD 5C`

diff --git a/docs/6.-Configuration-API.md b/docs/6.-Configuration-API.md
@@ -121,7 +121,7 @@ See [JSON configuration file](5.-JSON-configuration-file.md).
 400 Bad Request (application/json)
 
 ```json
-{ "success": false, "error": "reason why the payload is invalid" }
+{ "success": false, "error": "Reason why the payload is invalid" }
 ```
 
 * In case the device already received a valid configuration and is waiting for reboot:

diff --git a/docs/index.md b/docs/index.md
@@ -1,6 +1,6 @@
 Welcome to the Homie for ESP8266 docs. This will help you to understand the framework and to use it in an effective manner.
 
-**<p align="center">This documentation is valid for Homie <u>v1.4.1</u></p>**
+**<p align="center">This documentation is valid for Homie <u>v1.5.0</u></p>**
 
 -----
 

diff --git a/library.json b/library.json
@@ -12,7 +12,7 @@
     "type": "git",
     "url": "https://github.com/marvinroger/homie-esp8266.git"
   },
-  "version": "1.4.1",
+  "version": "1.5.0",
   "frameworks": "arduino",
   "platforms": "espressif",
   "dependencies": [

diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=Homie
-version=1.4.1
+version=1.5.0
 author=Marvin Roger
 maintainer=Marvin Roger
 sentence=ESP8266 framework for Homie, a lightweight MQTT convention for the IoT

diff --git a/src/Homie/Constants.hpp b/src/Homie/Constants.hpp
@@ -3,7 +3,7 @@
 #include <ESP8266WiFi.h>
 
 namespace HomieInternals {
-  const char VERSION[] = "1.4.1";
+  const char VERSION[] = "1.5.0";
   const unsigned long BAUD_RATE = 115200;
 
   const IPAddress ACCESS_POINT_IP(192, 168, 1, 1);