homieiot / homie-esp8266

💡 ESP8266 framework for Homie, a lightweight MQTT convention for the IoT
http://homieiot.github.io/homie-esp8266
MIT License
1.36k stars 308 forks source link

Homie v1.5 on platformio and wrong documentation #246

Closed elbowz closed 7 years ago

elbowz commented 7 years ago

Hi,

if I follow the Getting started of documentation (https://homie-esp8266.readme.io/docs/getting-started):

But this install the version 1.5 that don't run the bare-minimum sketch:

#include <Homie.h>

void setup() {
  Homie_setFirmware("bare-minimum", "1.0.0"); // The "_" is not a typo! See Magic bytes
  Homie.setup();
}

void loop() {
  Homie.loop();
}

edit: For solve the issue I have downloaded Homie from git (master) and edit the platformio.ini:

[...]
lib_deps = AsyncMqttClient, ArduinoJson, Bounce2
benzino77 commented 7 years ago

You can install Homie v2 by putting this to your project properties:

lib_deps =  https://github.com/marvinroger/homie-esp8266.git
elbowz commented 7 years ago

Great!

...I guess edit the documentation according to this could be better

benzino77 commented 7 years ago

To tell the truth it can be mixed . Have a look here: platformio lib_deps

elbowz commented 7 years ago

I see! I have just started to use platformio, so I don't know this feature.

Anyway, if you follow the documentation for Homie v2, you'll get error

elbowz commented 7 years ago

The "workaround":

platformio.ini

lib_deps = https://github.com/marvinroger/homie-esp8266.git, ArduinoJson, AsyncMqttClient, Bounce2
marvinroger commented 7 years ago

Homie v2 is not yet released, so stable version is still the v1.5. The v2 docs is made as if it was already released, so that as soon as the v2 code is ready we can release it.

elbowz commented 7 years ago

Well, I have understand...anyway in the v2 docs is the only "mistake" I have found :+1:

feel free to close the issue...thanks!

marvinroger commented 7 years ago

Yeah I know it's kind of messy.. Sorry about that. ;)