From b5bd395e5107eb193a9b35e68f907bbd3b059402 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Sun, 26 Nov 2017 22:02:07 +0200 Subject: [PATCH 1/3] Instruction for @PlatformIO --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/README.md b/README.md index 88588a48..ddd14fe9 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,41 @@ The old configurator is not available online anymore. You can download it [here] The Git repository contains the development version of Homie for ESP8266. Stable releases are available [on the releases page](https://github.com/marvinroger/homie-esp8266/releases). +## Using with PlatformIO + +[PlatformIO](http://platformio.org) is an open source ecosystem for IoT development with cross platform build system, library manager and full support for Espressif ESP8266 development. It works on the popular host OS: Mac OS X, Windows, Linux 32/64, Linux ARM (like Raspberry Pi, BeagleBone, CubieBoard). + +1. Install [PlatformIO IDE](http://platformio.org/platformio-ide) +2. Create new project using "PlatformIO Home > New Project" +3. Open [Project Configuration File `platformio.ini`](http://docs.platformio.org/page/projectconf.html) + +### Stable version + +4. Add "Homie" to project using `platformio.ini` and [lib_deps](http://docs.platformio.org/page/projectconf/section_env_library.html#lib-deps) option: +```ini +[env:myboard] +platform = espressif8266 +board = ... +framework = arduino +lib_deps = Homie +``` + +### Development version + +4. Update dev/platform to staging version: + - [Instruction for Espressif 8266](http://docs.platformio.org/en/latest/platforms/espressif8266.html#using-arduino-framework-with-staging-version) +5. Add development version of "Homie" to project using `platformio.ini` and [lib_deps](http://docs.platformio.org/page/projectconf/section_env_library.html#lib-deps) option: +```ini +[env:myboard] +platform = ... +board = ... +framework = arduino +lib_deps = https://github.com/marvinroger/homie-esp8266.git +``` + +----- +Happy coding with PlatformIO! + ## Features * Automatic connection/reconnection to Wi-Fi/MQTT From 0c4912acd5c8f82105e0ee0bd5a134b90793ad01 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Mon, 27 Nov 2017 00:13:24 +0200 Subject: [PATCH 2/3] Explain how to used tagged version with @PlatformIO --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index ddd14fe9..9788b83d 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,12 @@ lib_deps = Homie platform = ... board = ... framework = arduino + +; the latest deveopment branch lib_deps = https://github.com/marvinroger/homie-esp8266.git + +; or tagged version +lib_deps = https://github.com/marvinroger/homie-esp8266.git#v2.0.0-beta.1 ``` ----- From 7d873ca7cb05da6da1e57d4f84f9977e87543fcf Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Mon, 27 Nov 2017 00:14:29 +0200 Subject: [PATCH 3/3] Explain how to use tagged version with @PlatformIO --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9788b83d..abe1403f 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ platform = ... board = ... framework = arduino -; the latest deveopment branch +; the latest development branch lib_deps = https://github.com/marvinroger/homie-esp8266.git ; or tagged version