added ZactuatorSomfy (#816)

* added ZactuatorSomfy
* added Somfy RTS docs

main/User_config.h

@@ -233,6 +233,7 @@ uint8_t wifiProtocol = 0; // default mode, automatic selection
 //#define ZboardM5STACK  "ZboardM5STACK"
 //#define ZradioCC1101   "CC1101"   //ESP8266, ESP32
 //#define ZactuatorPWM   "PWM"      //ESP8266, ESP32
+//#define ZactuatorSomfy "Somfy"    //ESP8266, Arduino, ESP32
 //#define ZgatewayRS232   "RS232"  //ESP8266, Arduino, ESP32
 
 /*-------------DEFINE YOUR MQTT ADVANCED PARAMETERS BELOW----------------*/

main/ZactuatorSomfy.ino

@@ -0,0 +1,80 @@
+/*  
+  OpenMQTTGateway  - ESP8266 or Arduino program for home automation 
+   Act as a wifi or ethernet gateway between your 433mhz/infrared IR signal  and a MQTT broker 
+   Send and receiving command by MQTT
+ 
+  This actor enables to:
+ - receive MQTT data from a topic and send Somfy RTS remote control signals corresponding to the received MQTT data
+  
+    Copyright (C) 2020 Leon Kiefer
+
+    This file is part of OpenMQTTGateway.
+    
+    OpenMQTTGateway is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+    OpenMQTTGateway is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+#include "User_config.h"
+
+#ifdef ZactuatorSomfy
+
+#  include <EEPROM.h>
+#  include <EEPROMRollingCodeStorage.h>
+#  include <SomfyRemote.h>
+
+#  ifdef ZradioCC1101
+#    include <ELECHOUSE_CC1101_SRC_DRV.h>
+#  endif
+
+void setupSomfy() {
+#  ifdef ZradioCC1101 //using with CC1101
+  ELECHOUSE_cc1101.Init();
+#  endif
+  pinMode(RF_EMITTER_GPIO, OUTPUT);
+  digitalWrite(RF_EMITTER_GPIO, LOW);
+
+#  if defined(ESP32)
+  if (!EEPROM.begin(max(4, SOMFY_REMOTE_NUM * 2))) {
+    Log.error(F("failed to initialise EEPROM" CR));
+  }
+#  elif defined(ESP8266)
+  EEPROM.begin(max(4, SOMFY_REMOTE_NUM * 2));
+#  endif
+
+  Log.trace(F("ZactuatorSomfy setup done " CR));
+}
+
+#  ifdef jsonReceiving
+void MQTTtoSomfy(char* topicOri, JsonObject& jsonData) {
+  if (cmpToMainTopic(topicOri, subjectMQTTtoSomfy)) {
+#    ifdef ZradioCC1101
+    ELECHOUSE_cc1101.SetTx(CC1101_FREQUENCY_SOMFY);
+#    endif
+    Log.trace(F("MQTTtoSomfy json data analysis" CR));
+
+    const int remoteIndex = jsonData["remote"];
+    if (remoteIndex >= SOMFY_REMOTE_NUM) {
+      Log.warning(F("ZactuatorSomfy remote does not exist" CR));
+      return;
+    }
+    const String commandData = jsonData["command"];
+    const Command command = getSomfyCommand(commandData);
+
+    EEPROMRollingCodeStorage rollingCodeStorage(EEPROM_ADDRESS_START + remoteIndex * 2);
+    SomfyRemote somfyRemote(RF_EMITTER_GPIO, somfyRemotes[remoteIndex], &rollingCodeStorage);
+    somfyRemote.sendCommand(command);
+#    ifdef ZradioCC1101
+    ELECHOUSE_cc1101.SetRx(CC1101_FREQUENCY); // set Receive on
+#    endif
+  }
+}
+#  endif
+
+#endif

main/config_Somfy.h

@@ -0,0 +1,45 @@
+/*  
+  OpenMQTTGateway  - ESP8266 or Arduino program for home automation 
+   Act as a wifi or ethernet gateway between your 433mhz/infrared IR signal  and a MQTT broker 
+   Send and receiving command by MQTT
+ 
+  This actor enables to:
+ - receive MQTT data from a topic and send Somfy RTS remote control signals corresponding to the received MQTT data
+  
+    Copyright (C) 2020 Leon Kiefer
+
+    This file is part of OpenMQTTGateway.
+    
+    OpenMQTTGateway is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+    OpenMQTTGateway is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+#ifndef config_Somfy_h
+#define config_Somfy_h
+
+#include <Arduino.h>
+#include <ArduinoJson.h>
+
+extern void setupSomfy();
+extern void MQTTtoSomfy(char* topicOri, JsonObject& RFdata);
+/*----------------------------USER PARAMETERS-----------------------------*/
+#define EEPROM_ADDRESS_START 0
+#define SOMFY_REMOTE_NUM     1
+
+// Do not change the order of the remotes, because based on the index the rolling codes are stored
+const uint32_t somfyRemotes[SOMFY_REMOTE_NUM] = {0x5184c8};
+
+/*-------------DEFINE YOUR MQTT PARAMETERS BELOW----------------*/
+#define subjectMQTTtoSomfy "/commands/MQTTtoSomfy"
+
+/*-------------------INTERNAL DEFINITIONS----------------------*/
+#define CC1101_FREQUENCY_SOMFY 433.42
+
+#endif

main/main.ino

@@ -57,7 +57,7 @@ StaticJsonBuffer<JSON_MSG_BUFFER> modulesBuffer;
 JsonArray& modules = modulesBuffer.createArray();
 
 // Modules config inclusion
-#if defined(ZgatewayRF) || defined(ZgatewayRF2) || defined(ZgatewayPilight)
+#if defined(ZgatewayRF) || defined(ZgatewayRF2) || defined(ZgatewayPilight) || defined(ZactuatorSomfy)
 #  include "config_RF.h"
 #endif
 #ifdef ZgatewayWeatherStation
@@ -132,6 +132,9 @@ JsonArray& modules = modulesBuffer.createArray();
 #ifdef ZactuatorPWM
 #  include "config_PWM.h"
 #endif
+#ifdef ZactuatorSomfy
+#  include "config_Somfy.h"
+#endif
 #if defined(ZboardM5STICKC) || defined(ZboardM5STICKCP) || defined(ZboardM5STACK)
 #  include "config_M5.h"
 #endif
@@ -690,6 +693,10 @@ void setup() {
   setupPWM();
   modules.add(ZactuatorPWM);
 #endif
+#ifdef ZactuatorSomfy
+  setupSomfy();
+  modules.add(ZactuatorSomfy);
+#endif
 #ifdef ZsensorDS1820
   setupZsensorDS1820();
   modules.add(ZsensorDS1820);
@@ -1520,6 +1527,9 @@ void receivingMQTT(char* topicOri, char* datacallback) {
 #  ifdef ZactuatorONOFF // outside the jsonpublishing macro due to the fact that we need to use simplepublishing with HA discovery
     MQTTtoONOFF(topicOri, jsondata);
 #  endif
+#  ifdef ZactuatorSomfy
+    MQTTtoSomfy(topicOri, jsondata);
+#  endif
 #  ifdef ZgatewayRS232
     MQTTtoRS232(topicOri, jsondata);
 #  endif