rflink_rPi/Plugins/Plugin_032.c

//#######################################################################################################
//##                    This Plugin is only for use with the RFLink software package                   ##
//##                                        Plugin-32 AlectoV4                                         ##
//#######################################################################################################
/*********************************************************************************************\
 * This plugin takes care of decoding the protocol used for outdoor sensors of the Alecto weather stations 
 * following protocol version 4
 * This Plugin works at least with: Banggood SKU174397, Sako CH113, Homemart/Onemall FD030 and Blokker (Dake) 1730796 outdoor sensors
 * But probably with many others as the OEM sensor is sold under many brand names
 * 
 * Author             : StuntTeam
 * Support            : http://sourceforge.net/projects/rflink/
 * License            : This code is free for use in any open source project when this header is included.
 *                      Usage of any parts of this code in a commercial application is prohibited!
 *********************************************************************************************
 * Technische informatie:
 * Message Format: (9 nibbles, 36 bits):
 *
 * Format for Temperature Humidity
 *   AAAAAAAA AAAA BCDD EEEE EEEE EEEE FFFFFFFF 
 *   01011100 0001 1000 1111 0111 1011 00001110
     01110000 0000 1111 1011 0000 0000 00000101
     10110101 0000 1x00                01001001

     01000101 1000 0110 1111 0000 1100 00100110
     01011111 1101 1000 0000 1111 0001 00001110
     01000101 1000 0010
 *
 *   A = Rolling Code
 *   B = 1 (fixed value)
 *   C = 0=scheduled transmission, 1=requested transmission (button press)
 *   D = Channel number (00=ch1 01=ch2 10=ch3)
 *   E = Temperature (two's complement)
 *   F = Humidity BCD format
 *
 * 20;3F;DEBUG;Pulses=74;Pulses(uSec)=525,1725,425,3600,425,1725,425,3600,425,3625,425,1725,425,3600,425,1725,425,1725,425,1700,425,3600,425,3600,425,3600,425,1725,425,1725,425,1725,425,1725,425,1725,400,1725,425,3600,425,1725,425,1725,425,1725,425,3600,400,1725,425,1725,425,3625,400,1725,425,1725,425,1750,400,3600,425,1725,400,1750,400,3625,425,1725,400,1725,425;
 * 20;C2;DEBUG;Pulses=76;Pulses(uSec)=325,500,250,1800,375,3650,375,1775,375,3650,375,3650,375,1775,375,3650,375,1800,350,1800,375,3650,375,3650,375,3650,375,3650,375,1775,375,1775,375,1775,375,1775,375,1775,375,1775,375,1775,375,3650,375,3650,375,3650,375,1775,375,3650,375,3650,375,1775,375,1775,375,1775,375,1775,375,1775,375,1775,375,3650,375,3650,375,3650,375,3650,375;
 * 20;3E;DEBUG;Pulses=78;Pulses(uSec)=525,250,500,375,600,1650,450,3550,475,1675,450,3550,475,3550,450,1675,450,3575,450,1675,450,1700,450,1700,450,3575,425,3600,450,3575,475,1700,425,1725,425,1725,425,1725,400,1725,425,1725,425,3625,425,1725,425,1725,425,1725,425,3600,425,1725,400,1725,425,3600,425,1725,425,1725,400,1725,425,3600,400,1725,425,1725,400,3600,425,1725,425,1725,400;
 \*********************************************************************************************/
#ifdef PLUGIN_032
boolean Plugin_032(byte function, char *string) {
      if (RawSignal.Number < 74 || RawSignal.Number > 78 ) return false;
      unsigned long bitstream=0L;
      int temperature=0;
      int humidity=0;
      byte rc=0;
      byte rc2=0;
      
      //==================================================================================
      byte start=0;
      if (RawSignal.Number == 78) start=4;
      if (RawSignal.Number == 76) start=2;
      for(int x=2+start; x<=56+start; x=x+2) {                     // Get first 28 bits
        if (RawSignal.Pulses[x+1]*RawSignal.Multiply > 550) return false;
        if (RawSignal.Pulses[x]*RawSignal.Multiply > 3000) {
           bitstream = (bitstream << 1) | 0x01;
        } else {
           if (RawSignal.Pulses[x]*RawSignal.Multiply > 1500) {
              if (RawSignal.Pulses[x]*RawSignal.Multiply > 2100) return false;
              bitstream = (bitstream << 1);
           } else {
              return false;
           }              
        }
      }
      for(int x=58+start;x<=72+start; x=x+2) {                          // Get remaining 8 bits
        if (RawSignal.Pulses[x+1]*RawSignal.Multiply > 550) return false;
        if(RawSignal.Pulses[x]*RawSignal.Multiply > 3000) {
          humidity = (humidity << 1) | 0x01;
        } else { 
          humidity = (humidity << 1);
        }
      }
      //==================================================================================
      // Prevent repeating signals from showing up
      //==================================================================================
      if( (SignalHash!=SignalHashPrevious) || ((RepeatingTimer+3000) < millis()) ) { // 1000
         // not seen the RF packet recently
         if (bitstream == 0) return false;   // Sanity check
         if (humidity==0) return false;      // Sanity check
      } else {
         // already seen the RF packet recently
         return true;
      } 
      //==================================================================================
      // Sort data
      rc = (bitstream >> 20) & 0xff;
      rc2= (bitstream >> 12) & 0xfb;         
      if ( ((rc2)&0x08) != 0x08) return false;         // needs to be 1
      temperature = (bitstream) & 0xfff;
      //fix 12 bit signed number conversion
      if ((temperature & 0x800) == 0x800) {
         temperature=4096-temperature;                 // fix for minus temperatures
         if (temperature > 0x258) return false;        // temperature out of range ( > 60.0 degrees) 
         temperature=temperature | 0x8000;             // turn highest bit on for minus values
      } else {
         if (temperature > 0x258) return false;        // temperature out of range ( > 60.0 degrees) 
      }
      if (humidity > 99) return false;                 // Humidity out of range
      //==================================================================================
      // Output
      // ----------------------------------
      sprintf(pbuffer, "20;%02X;", PKSequenceNumber++);// Node and packet number 
      Serial.print( pbuffer );
      // ----------------------------------
      Serial.print(F("Alecto V4;"));                   // Label
      sprintf(pbuffer, "ID=%02x%02x;", rc, rc2);       // ID 
      Serial.print( pbuffer );
      sprintf(pbuffer, "TEMP=%04x;", temperature);     
      Serial.print( pbuffer );
      if (humidity < 99) {                             // Only report valid humidty values
         sprintf(pbuffer, "HUM=%02d;", humidity);      // decimal value..
         Serial.print( pbuffer );        
      }
      Serial.println();
      //==================================================================================
      RawSignal.Repeats=true;                          // suppress repeats of the same RF packet
      RawSignal.Number=0;
      return true;
}
#endif // PLUGIN_032