ZgatewaySRFB.ino

/*  
  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 gateway enables to:
   - receive MQTT data from a topic and send RF 433Mhz signal corresponding to the received MQTT data using SONOFF RF BRIDGE
   - publish MQTT data to a different topic related to received 433Mhz signal using SONOFF RF BRIDGE
 
    This implementation into OpenMQTTGateway is based on Xose Pérez work ESPURNA (https://bitbucket.org/xoseperez/espurna)

    Copyright (C) 2016-2017 by Xose Pérez <xose dot perez at gmail dot com>
    OpenMQTTGateway integration by Florian ROBERT
  
    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/>.
*/

#ifdef ZgatewaySRFB

unsigned char _uartbuf[RF_MESSAGE_SIZE+3] = {0};
unsigned char _uartpos = 0;

void setupSRFB(){
  trc(F("ZgatewaySRFB setup done "));
  trc("Serial Baud" + String(SERIAL_BAUD));
}

void MQTTtoSRFB(char * topicOri, char * datacallback) {

  // RF DATA ANALYSIS
  String topic = topicOri;
  int valueRPT = 0;
  
  if (topic == subjectMQTTtoSRFB){

    int valueMiniPLSL  = 0;
    int valueMaxiPLSL  = 0;
    int valueSYNC  = 0;

    int pos = topic.lastIndexOf(SRFBRptKey);       
    if (pos != -1){
      pos = pos + +strlen(SRFBRptKey);
      valueRPT = (topic.substring(pos,pos + 1)).toInt();
      trc(F("SRFB Repeat:"));
      trc(valueRPT);
    }

    int pos2 = topic.lastIndexOf(SRFBminipulselengthKey);
    if (pos2 != -1) {
      pos2 = pos2 + strlen(SRFBminipulselengthKey);
      valueMiniPLSL = (topic.substring(pos2,pos2 + 3)).toInt();
      trc(F("RF Mini Pulse Lgth:"));
      trc(valueMiniPLSL);
    }

    int pos3 = topic.lastIndexOf(SRFBmaxipulselengthKey);       
    if (pos3 != -1){
      pos3 = pos3 + strlen(SRFBmaxipulselengthKey);
      valueMaxiPLSL = (topic.substring(pos3,pos3 + 2)).toInt();
      trc(F("RF Maxi Pulse Lgth:"));
      trc(valueMaxiPLSL);
    }

    int pos4 = topic.lastIndexOf(SRFBsyncKey);       
    if (pos4 != -1){
      pos4 = pos4 + strlen(SRFBsyncKey);
      valueSYNC = (topic.substring(pos4,pos4 + 2)).toInt();
      trc(F("RF sync:"));
      trc(valueSYNC);
    }

      trc(F("MQTTtoSRFB prts"));
      if (valueRPT == 0) valueRPT = 1;
      if (valueMiniPLSL == 0) valueMiniPLSL = 320;
      if (valueMaxiPLSL == 0) valueMaxiPLSL = 900;
      if (valueSYNC == 0) valueSYNC = 9500;
      
      byte hex_valueMiniPLSL[2];
      hex_valueMiniPLSL[0] = (int)((valueMiniPLSL >> 8) & 0xFF) ;
      hex_valueMiniPLSL[1] = (int)(valueMiniPLSL & 0xFF) ;
      
      byte hex_valueMaxiPLSL[2];
      hex_valueMaxiPLSL[0] = (int)((valueMaxiPLSL >> 8) & 0xFF) ;
      hex_valueMaxiPLSL[1] = (int)(valueMaxiPLSL & 0xFF) ;
      
      byte hex_valueSYNC[2];
      hex_valueSYNC[0] = (int)((valueSYNC >> 8) & 0xFF) ;
      hex_valueSYNC[1] = (int)(valueSYNC & 0xFF) ;

      unsigned long data = strtoul(datacallback, NULL, 10); // we will not be able to pass values > 4294967295
      byte hex_data[3];
      hex_data[0] = (unsigned long)((data >> 16) & 0xFF) ;
      hex_data[1] = (unsigned long)((data >> 8) & 0xFF) ;
      hex_data[2] = (unsigned long)(data & 0xFF) ;   
  
      byte message_b[RF_MESSAGE_SIZE];
  
      memcpy(message_b, hex_valueSYNC, 2);
      memcpy(message_b + 2, hex_valueMiniPLSL, 2);
      memcpy(message_b + 4, hex_valueMaxiPLSL, 2);
      memcpy(message_b + 6, hex_data, 3);

      _rfbSend(message_b, valueRPT);
      // Acknowledgement to the GTWRF topic 
      boolean result = client.publish(subjectGTWSRFBtoMQTT, datacallback);// we acknowledge the sending by publishing the value to an acknowledgement topic, for the moment even if it is a signal repetition we acknowledge also
      if (result) trc(F("MQTTtoSRFB ack pub."));
  }
  if (topic == subjectMQTTtoSRFBRaw){

      int pos = topic.lastIndexOf(SRFBRptKey);       
      if (pos != -1){
        pos = pos + +strlen(SRFBRptKey);
        valueRPT = (topic.substring(pos,pos + 1)).toInt();
        trc(F("SRFB Repeat:"));
        trc(valueRPT);
      }
      if (valueRPT == 0) valueRPT = 1;
      
      byte message_b[RF_MESSAGE_SIZE];
      _rfbToArray(datacallback,message_b);
      _rfbSend(message_b, valueRPT);
      // Acknowledgement to the GTWRF topic 
      boolean result = client.publish(subjectGTWSRFBtoMQTT, datacallback);// we acknowledge the sending by publishing the value to an acknowledgement topic, for the moment even if it is a signal repetition we acknowledge also
      if (result) trc(F("MQTTtoSRFBRaw ack pub."));
  }
}

void _rfbSend(byte * message) {
    Serial.println();
    Serial.write(RF_CODE_START);
    Serial.write(RF_CODE_RFOUT);
    for (unsigned char j=0; j<RF_MESSAGE_SIZE; j++) {
        Serial.write(message[j]);
    }
    Serial.write(RF_CODE_STOP);
    Serial.flush();
    Serial.println();
}

void _rfbSend(byte * message, int times) {

    char buffer[RF_MESSAGE_SIZE];
    _rfbToChar(message, buffer);
    trc("[RFBRIDGE] Sending MESSAGE '%s' %d time(s)\n");

    for (int i=0; i<times; i++) {
        if (i>0) {
            unsigned long start = millis();
            while (millis() - start < RF_SEND_DELAY) delay(1);
        }
        _rfbSend(message);
    }
}

boolean SRFBtoMQTT() {
  
    static bool receiving = false;

    while (Serial.available()) {
        yield();
        byte c = Serial.read();

        if (receiving) {
            if (c == RF_CODE_STOP) {
                _rfbDecode();
                receiving = false;
            } else {
                _uartbuf[_uartpos++] = c;
            }
        } else if (c == RF_CODE_START) {
            _uartpos = 0;
            receiving = true;
        }

    }
    return receiving;    
}

void _rfbDecode() {

    static unsigned long last = 0;
    if (millis() - last < RF_RECEIVE_DELAY) return;
    last = millis();

    byte action = _uartbuf[0];
    char buffer[RF_MESSAGE_SIZE * 2 + 1] = {0};

    if (action == RF_CODE_RFIN) {
        _rfbToChar(&_uartbuf[1], buffer);
        client.publish(subjectSRFBtoMQTTRaw,buffer);
        
        char val[8]= {0};
        extract_char(buffer, val, 12 ,8, false,true); 
        client.publish(subjectSRFBtoMQTT,val); 

        char val_Tsyn[4]= {0};
        extract_char(buffer, val_Tsyn, 0 ,4, false, true);       
        client.publish(subjectSRFBtoMQTTTsyn,val_Tsyn);
        
        char val_Thigh[4]= {0};
        extract_char(buffer, val_Thigh, 4 ,4, false, true);   
        client.publish(subjectSRFBtoMQTTThigh,val_Thigh);

        char val_Tlow[4]= {0};
        extract_char(buffer, val_Tlow, 8 ,4, false, true);
        client.publish(subjectSRFBtoMQTTTlow,val_Tlow);
        
        _rfbAck();
    }
}

void _rfbAck() {
    trc("[RFBRIDGE] Sending ACK\n");
    Serial.println();
    Serial.write(RF_CODE_START);
    Serial.write(RF_CODE_ACK);
    Serial.write(RF_CODE_STOP);
    Serial.flush();
    Serial.println();
}

/*
From an hexa char array ("A220EE...") to a byte array (half the size)
 */
bool _rfbToArray(const char * in, byte * out) {
    if (strlen(in) != RF_MESSAGE_SIZE * 2) return false;
    char tmp[3] = {0};
    for (unsigned char p = 0; p<RF_MESSAGE_SIZE; p++) {
        memcpy(tmp, &in[p*2], 2);
        out[p] = strtol(tmp, NULL, 16);
    }
    return true;
}

/*
From a byte array to an hexa char array ("A220EE...", double the size)
 */
bool _rfbToChar(byte * in, char * out) {
    for (unsigned char p = 0; p<RF_MESSAGE_SIZE; p++) {
        sprintf_P(&out[p*2], PSTR("%02X"), in[p]);
    }
    return true;
}

#endif