enocean

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revisionBoth sides next revision
enocean [10.03.2018 04:55] – [get wifimanager to work] Pascal Suterenocean [16.03.2018 06:15] – [esp8266] Pascal Suter
Line 13: Line 13:
 {{::enocean:enoceansensorstransceiverpinout-300x225.jpg?400|}} {{::enocean:enoceansensorstransceiverpinout-300x225.jpg?400|}}
  
-thanks to [[http://www.kerrywong.com/2014/08/10/a-quick-overview-of-the-enocean-pi-and-enocean-sensor-kit/|Kerry D. Wong]] who published this Information +thanks to [[http://www.kerrywong.com/2014/08/10/a-quick-overview-of-the-enocean-pi-and-enocean-sensor-kit/|Kerry D. Wong]] who published this Information. He writes:  
 +> The IOVdd and Vdd pins are connected directly to pin 1 (3.3V) on Raspberry Pi. Besides the power and ground pins, the only connections are to the hardware UART pins (header pin 8 and pin 10). 
 ===== esp8266 ===== ===== esp8266 =====
 I plan on using a Wemos D1 mini module (or a clone of it i guess) which can be purchased on aliexpress for a few $. i will then use the arduino core on it to program it via the arduino IDE.  I plan on using a Wemos D1 mini module (or a clone of it i guess) which can be purchased on aliexpress for a few $. i will then use the arduino core on it to program it via the arduino IDE. 
Line 24: Line 24:
 here are a few libraries i have found beforehand and intend on trying out:  here are a few libraries i have found beforehand and intend on trying out: 
   * [[https://github.com/marvinroger/async-mqtt-client|Async MQTT client]] for mqtt obviously   * [[https://github.com/marvinroger/async-mqtt-client|Async MQTT client]] for mqtt obviously
-  * [[https://github.com/me-no-dev/ESPAsyncTCP|ESPAsyncTCP]] to plot debug messages to a netcat server while working with the enOcean module on the serial port.. this is to avoid using SoftSerial+  * <del>[[https://github.com/me-no-dev/ESPAsyncTCP|ESPAsyncTCP]] to plot debug messages to a netcat server while working with the enOcean module on the serial port.. turns out i could still use Serial for debugging as well as to receive enOcean messages, so this was not needed.</del> As a matter of fact it prevented the MQTT Client class to operate correctly. However, I wrote a little gide on Using the [[ESP AsyncPrinter]] just to keep my example of how i got it to work for later reference
   * [[https://github.com/tzapu/WiFiManager|WiFiManager]] seems to do all we need to make the final device easy to get configured without a serial connection (has automatic fall back to AP mode with captive portal config page).    * [[https://github.com/tzapu/WiFiManager|WiFiManager]] seems to do all we need to make the final device easy to get configured without a serial connection (has automatic fall back to AP mode with captive portal config page). 
 +  * [[https://bitbucket.org/charly37/arduino_enocean_lib/downloads/|arduino enocean library]] with a [[http://djynet.net/?p=635|description from the developer]]
 +  * [[https://github.com/KoljaWindeler/ESP8266_mqtt_pwm_pir_temp/tree/master/JKW_MQTT_PWM_PIR_TEMP/src|a similar project]] i found only after starting this. maybe i could just expand that one rather than writing my own? a shame i found it so late. 
  
 ===== setup and development ===== ===== setup and development =====
Line 58: Line 60:
   // put your main code here, to run repeatedly:   // put your main code here, to run repeatedly:
   wifiManager.process();   wifiManager.process();
 +}
 +</code>
 +
 +
 +==== add enOcean ====
 +now we can finally add the enocean receiver to our setup. we therefore connect the +3.3V to the +3.3V of the Wemos D1, the GND to the GND and we cross connect the RX of the enocean Module to the TX of the Wemos D1 and the same for the TX fo the enOcean that goes to the RX of the Wemos 
 +
 +next we need the [[http://djynet.net/?p=635|enOceanMsg]] library.. however, i have modified it slightly (removed all serial debugging and changed the enOcean communication part from ''Serial1'' to ''Serial'' as the ESP8266's ''Serial1'' only supports transmitting data but not receiving. So either you do these modifications yourself or you get {{ :enocean:enoceanmsg.zip |my Version}} of it. 
 +
 +extract the contents of this ZIP to the ''sketchbook/libraries'' folder. I then also modified the Sketch to both include the enOcean stuff and to disable serial debugging of the WiFiManager when online-debugging is requested. 
 +<code cpp>
 +#include <ESP8266WiFi.h>          //ESP8266 Core WiFi Library (you most likely already have this in your sketch)
 +#include <DNSServer.h>            //Local DNS Server used for redirecting all requests to the configuration portal
 +#include <ESP8266WebServer.h>     //Local WebServer used to serve the configuration portal
 +#include <WiFiManager.h>          //https://github.com/tzapu/WiFiManager WiFi Configuration Magic
 +#include <AsyncPrinter.h>
 +#include <EnOceanMsg.h>           //http://djynet.net/?p=635
 +
 +bool enableOnlineDebugging=true;
 +const char *debuggerHost="192.168.168.48";
 +
 +EnOceanMsg _Msg;
 +AsyncPrinter ap;
 +WiFiManager wifiManager;
 +bool debugOnline=false;
 +bool firstround=true;
 +int lastPayload=0;
 +void setup() {
 +  // put your setup code here, to run once:
 +  Serial.begin(57600);
 +  if(enableOnlineDebugging){
 +    wifiManager.setDebugOutput(false);
 +  }
 +  wifiManager.autoConnect();
 +  wifiManager.startWebPortal();
 +  ap.connect(debuggerHost,3333);
 +  if(enableOnlineDebugging){
 +    //block for maximum 5 seconds trying to reach the debugger
 +    for ( int i = 0; i < 10 ; i++){
 +      if(ap.connected()){
 +        debugOnline=true;
 +        ap.println("connected");
 +        break;
 +      } else {
 +        delay(500);
 +      }
 +    }
 +  }
 +}
 +
 +void debug(const char *message){
 +  if(debugOnline){
 +    ap.println(message);
 +  } else {
 +    Serial.println("debugger is not online");
 +  }
 +  _Msg.decode();
 +  if (_Msg.dataAvailable() == true){
 +    
 +  }
 +}
 +
 +void debugHex(int payload){
 +  if(debugOnline){
 +    ap.println(payload,HEX);
 +  }  
 +}
 +
 +
 +void loop() {
 +  // put your main code here, to run repeatedly:
 +  int payload=0;
 +  wifiManager.process();
 +  if(firstround){
 +    debug("hello world");
 +    firstround=false;
 +  }
 +  _Msg.decode();
 +  if(_Msg.dataAvailable() == true){
 +    payload=_Msg.getPayload();
 +    if(payload!=lastPayload){
 +      debug("new payload received:");
 +      debugHex(payload);
 +      lastPayload=payload;
 +      debugHex(_Msg.getSenderId());
 +    }
 +  }
 +  delay(50);
 +}
 +</code>
 +now you should see output like this on your netcat console after you started the sketch and then pressed a button: 
 +<code>
 +connected
 +hello world
 +new payload received:
 +70
 +3102F7
 +new payload received:
 +0
 +3102F7
 +</code>
 +''70'' is the hex code for one of the buttons and ''3102f7'' is actually ''0x00 0x31 0x02 0xf7'' which is the enOcean device's address which can also be found on the lable on the device itself. 
 +
 +==== MQTT ====
 +next up is MQTT support throught he [[https://github.com/marvinroger/async-mqtt-client|Async MQTT Library]]. 
 +
 +download the [[https://github.com/marvinroger/async-mqtt-client/releases|latest release]] as zip file and then add it via Sketch->Include Library->Add .ZIP library
 +
 +this is just a copy paste of a code that somewhat worked.. before i clean it out and re-post here
 +
 +<code cpp>
 +#include <ESP8266WiFi.h>          //ESP8266 Core WiFi Library (you most likely already have this in your sketch)
 +#include <DNSServer.h>            //Local DNS Server used for redirecting all requests to the configuration portal
 +#include <ESP8266WebServer.h>     //Local WebServer used to serve the configuration portal
 +#include <WiFiManager.h>          //https://github.com/tzapu/WiFiManager WiFi Configuration Magic
 +#include <AsyncPrinter.h>
 +#include <EnOceanMsg.h>           //http://djynet.net/?p=635
 +#include <AsyncMqttClient.h>       //https://github.com/marvinroger/async-mqtt-client
 +
 +bool enableOnlineDebugging=true;
 +const char *debuggerHost="192.168.168.48";
 +const char *mqttServer="192.168.168.1";
 +int mqttPort=1883;
 +
 +EnOceanMsg _Msg;
 +AsyncPrinter ap;
 +WiFiManager wifiManager;
 +bool debugOnline=false;
 +bool firstround=true;
 +int lastPayload=0;
 +AsyncMqttClient mqtt;
 +bool mqttConnected=false;
 +String mqttBaseTopic="enOcean";
 +
 +void onMqttConnect(bool sessionPresent){
 +  debug("connected to mqtt server");
 +  mqttConnected=true;
 +}
 +
 +void setup() {
 +  // put your setup code here, to run once:
 +  Serial.begin(57600);
 +  if(enableOnlineDebugging){
 +    wifiManager.setDebugOutput(false);
 +  }
 +  wifiManager.autoConnect();
 +  wifiManager.startWebPortal();
 +  ap.connect(debuggerHost,3333);
 +  mqtt.setServer(mqttServer,mqttPort);
 +  mqtt.onConnect(onMqttConnect);
 +  if(enableOnlineDebugging){
 +    //block for maximum 5 seconds trying to reach the debugger
 +    for ( int i = 0; i < 10 ; i++){
 +      if(ap.connected()){
 +        debugOnline=true;
 +        ap.println("connected");
 +        debug("initiate mqtt connection");
 +        mqtt.connect();
 +        break;
 +      } else {
 +        delay(500);
 +      }
 +    }
 +  }
 +}
 +
 +void debug(const char *message){
 +  if(debugOnline){
 +    ap.println(message);
 +  } else {
 +    Serial.println("debugger is not online");
 +  }
 +  _Msg.decode();
 +  if (_Msg.dataAvailable() == true){
 +    
 +  }
 +}
 +
 +void debugHex(int payload){
 +  if(debugOnline){
 +    ap.println(payload,HEX);
 +  }  
 +}
 +
 +
 +void loop() {
 +  // put your main code here, to run repeatedly:
 +  int payload=0;
 +  uint32_t senderId=0;
 +  char * topic;
 +  
 +  wifiManager.process();
 +  if(firstround){
 +    debug("hello world");
 +    firstround=false;
 +  }
 +  _Msg.decode();
 +  if(_Msg.dataAvailable() == true){
 +    payload=_Msg.getPayload();
 +    if(payload!=lastPayload){
 +      debug("new payload received:");
 +      debugHex(payload);
 +      lastPayload=payload;
 +      senderId=_Msg.getSenderId();
 +      debugHex(senderId);
 +      if(payload > 0 && senderId > 0 && mqttConnected){
 +        //String t = String(mqttBaseTopic+"/"+senderId+"/"+payload);
 +        //char topic[sizeof(t)];
 +        //t.toCharArray(topic,sizeof(topic));
 +        debug("publish ON message");
 +        uint16_t packetIdPub1 = mqtt.publish("enocean/button", 1, true, "ON");
 +      } else {
 +        debug("publish OFF message");
 +        uint16_t packetIdPub1 = mqtt.publish("enocean/button", 1, true, "OFF");
 +      }
 +    }
 +  }
 +  delay(50);
 } }
 </code> </code>
  • enocean.txt
  • Last modified: 16.03.2018 06:18
  • by Pascal Suter