951 lines
33 KiB
C++
951 lines
33 KiB
C++
/*
|
|
RCSwitch - Arduino libary for remote control outlet switches
|
|
Copyright (c) 2011 Suat Özgür. All right reserved.
|
|
|
|
Contributors:
|
|
- Andre Koehler / info(at)tomate-online(dot)de
|
|
- Gordeev Andrey Vladimirovich / gordeev(at)openpyro(dot)com
|
|
- Skineffect / http://forum.ardumote.com/viewtopic.php?f=2&t=46
|
|
- Dominik Fischer / dom_fischer(at)web(dot)de
|
|
- Frank Oltmanns / <first name>.<last name>(at)gmail(dot)com
|
|
- Andreas Steinel / A.<lastname>(at)gmail(dot)com
|
|
- Max Horn / max(at)quendi(dot)de
|
|
- Robert ter Vehn / <first name>.<last name>(at)gmail(dot)com
|
|
- Johann Richard / <first name>.<last name>(at)gmail(dot)com
|
|
- Vlad Gheorghe / <first name>.<last name>(at)gmail(dot)com https://github.com/vgheo
|
|
|
|
Project home: https://github.com/sui77/rc-switch/
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2.1 of the License, or (at your option) any later version.
|
|
|
|
This library 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
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#define KeeLoq_NLF 0x3A5C742EUL
|
|
|
|
#include "RCSwitch.h"
|
|
|
|
#ifdef RaspberryPi
|
|
// PROGMEM and _P functions are for AVR based microprocessors,
|
|
// so we must normalize these for the ARM processor:
|
|
#define PROGMEM
|
|
#define memcpy_P(dest, src, num) memcpy((dest), (src), (num))
|
|
#endif
|
|
|
|
#if defined(ESP8266) || defined(ESP32)
|
|
// interrupt handler and related code must be in RAM on ESP8266,
|
|
// according to issue #46.
|
|
#define RECEIVE_ATTR ICACHE_RAM_ATTR
|
|
#else
|
|
#define RECEIVE_ATTR
|
|
#endif
|
|
|
|
|
|
/* Формат для описания протокола:
|
|
*
|
|
* {Pulse length, Preamble, Sync bit, "0" bit, "1" bit, Inverted Signal, Guard time}
|
|
*
|
|
* Pulse length: длительность импульса Te в микросекундах,
|
|
* например 350
|
|
* Preamble: преамбула - Чередование высоких и низких уровней
|
|
* {20, 1} означает 20 чередований длительностью 1 Te
|
|
* _ _ _ _ _ _ _ _ _ _
|
|
* | |_| |_| |_| |_| |_| |_| |_| |_| |_| |_
|
|
* Sync bit: Хедер и синхроимпульс
|
|
* {1, 31} означает 1 импульс длительностью Te высокого уровня и 31 низкого
|
|
* _
|
|
* | |_______________________________ (don't count the vertical bars)
|
|
* "0" bit: форма импульсов, определяющая бит данных, являющийся логическим "0"
|
|
* {1, 3} означает 1 импульс длительностью Te высокого уровня и 3 низкого
|
|
* _
|
|
* | |___
|
|
* "1" bit: форма импульсов, определяющая бит данных, являющийся логической "1"
|
|
* {3, 1} означает 3 импульса длительностью Te высокого уровня и 1 низкого
|
|
* ___
|
|
* | |_
|
|
*
|
|
* (примечание: для формирования бита состояния Z (Tri-State bit) эти два кода объединяются)
|
|
* Inverted Signal: Инверсия сигнала - если принимает значение true, то это означает
|
|
* замену высокого уровня на низкий в передаваемом/принимаемом пакете
|
|
* Guard time: Защитное время, после которого следует очередная преамбула следующего пакета
|
|
* например 39 импульсов длительностью Te низкого уровня
|
|
*/
|
|
#if defined(ESP8266) || defined(ESP32)
|
|
static const RCSwitch::Protocol proto[] = {
|
|
#else
|
|
static const RCSwitch::Protocol PROGMEM proto[] = {
|
|
#endif
|
|
{ 350, 0, { 0, 0 }, 1, { 1, 31 }, { 1, 3 }, { 3, 1 }, false, 0 }, // 01 (Princeton, PT-2240)
|
|
{ 650, 0, { 0, 0 }, 1, { 1, 10 }, { 1, 2 }, { 2, 1 }, false, 0 }, // 02
|
|
{ 100, 0, { 0, 0 }, 1, { 30, 71 }, { 4, 11 }, { 9, 6 }, false, 0 }, // 03
|
|
{ 380, 0, { 0, 0 }, 1, { 1, 6 }, { 1, 3 }, { 3, 1 }, false, 0 }, // 04
|
|
{ 500, 0, { 0, 0 }, 1, { 6, 14 }, { 1, 2 }, { 2, 1 }, false, 0 }, // 05
|
|
{ 450, 0, { 0, 0 }, 1, { 23, 1 }, { 1, 2 }, { 2, 1 }, true, 0 }, // 06 (HT6P20B)
|
|
{ 150, 0, { 0, 0 }, 1, { 2, 62 }, { 1, 6 }, { 6, 1 }, false, 0 }, // 07 (HS2303-PT, i. e. used in AUKEY Remote)
|
|
{ 320, 0, { 0, 0 }, 1, { 36, 1 }, { 1, 2 }, { 2, 1 }, true, 0 }, // 08 (Came 12bit, HT12E)
|
|
{ 700, 0, { 0, 0 }, 1, { 32, 1 }, { 1, 2 }, { 2, 1 }, true, 0 }, // 09 (Nice_Flo 12bit)
|
|
{ 420, 0, { 0, 0 }, 1, { 60, 6 }, { 1, 2 }, { 2, 1 }, true, 0 }, // 10 (V2 phoenix)
|
|
{ 500, 2, { 3, 3 }, 0, { 0, 0 }, { 1, 2 }, { 2, 1 }, false, 37 }, // 11 (Nice_FloR-S 52bit)
|
|
{ 400, 23, { 1, 1 }, 1, { 0, 9 }, { 2, 1 }, { 1, 2 }, false, 39 }, // 12 (Keeloq 64/66)
|
|
{ 300, 6, { 2, 2 }, 3, { 8, 3 }, { 2, 2 }, { 3, 3 }, false, 0 }, // 13 test (CFM)
|
|
{ 250, 12, { 4, 4 }, 0, { 0, 0 }, { 1, 1 }, { 2, 2 }, false, 0 }, // 14 test (StarLine)
|
|
{ 500, 0, { 0, 0 }, 0, { 100, 1 }, { 1, 2 }, { 2, 1 }, false, 35 }, // 15
|
|
|
|
{ 361, 0, { 0, 0 }, 1, { 52, 1 }, { 1, 3 }, { 3, 1 }, true, 0 }, // 16 (Einhell)
|
|
{ 500, 0, { 0, 0 }, 1, { 1, 23 }, { 1, 2 }, { 2, 1 }, false, 0 }, // 17 (InterTechno PAR-1000)
|
|
{ 180, 0, { 0, 0 }, 1, { 1, 15 }, { 1, 1 }, { 1, 8 }, false, 0 }, // 18 (Intertechno ITT-1500)
|
|
{ 350, 0, { 0, 0 }, 1, { 1, 2 }, { 0, 2 }, { 3, 2 }, false, 0 }, // 19 (Murcury)
|
|
{ 150, 0, { 0, 0 }, 1, { 34, 3 }, { 1, 3 }, { 3, 1 }, false, 0 }, // 20 (AC114)
|
|
{ 360, 0, { 0, 0 }, 1, { 13, 4 }, { 1, 2 }, { 2, 1 }, false, 0 }, // 21 (DC250)
|
|
{ 650, 0, { 0, 0 }, 1, { 1, 10 }, { 1, 2 }, { 2, 1 }, true, 0 }, // 22 (Mandolyn/Lidl TR-502MSV/RC-402/RC-402DX)
|
|
{ 641, 0, { 0, 0 }, 1, { 115, 1 }, { 1, 2 }, { 2, 1 }, true, 0 }, // 23 (Lidl TR-502MSV/RC-402 - Flavien)
|
|
{ 620, 0, { 0, 0 }, 1, { 0, 64 }, { 0, 1 }, { 1, 0 }, false, 0 }, // 24 (Lidl TR-502MSV/RC701)
|
|
{ 560, 0, { 0, 0 }, 1, { 16, 8 }, { 1, 1 }, { 1, 3 }, false, 0 }, // 25 (NEC)
|
|
{ 385, 0, { 0, 0 }, 1, { 1, 17 }, { 1, 2 }, { 2, 1 }, false, 0 }, // 26 (Arlec RC210)
|
|
{ 188, 0, { 0, 0 }, 1, { 1, 31 }, { 1, 3 }, { 3, 1 }, false, 0 }, // 27 (Zap, FHT-7901)
|
|
|
|
{ 700, 1, { 0, 1 }, 1, { 116, 0 }, { 1, 2 }, { 2, 1 }, true, 0 }, // 28 (Quigg GT-7000)
|
|
{ 220, 0, { 0, 0 }, 1, { 1, 46 }, { 1, 6 }, { 1, 1 }, false, 2 }, // 29 (NEXA)
|
|
{ 260, 0, { 0, 0 }, 1, { 1, 8 }, { 1, 4 }, { 4, 1 }, true, 0 }, // 30 (Anima)
|
|
|
|
{ 400, 0, { 0, 0 }, 1, { 1, 1 }, { 1, 2 }, { 2, 1 }, false, 43 } // 31 (Mertik Maxitrol G6R-H4T1)
|
|
};
|
|
|
|
enum {
|
|
numProto = sizeof(proto) / sizeof(proto[0])
|
|
};
|
|
|
|
#if not defined( RCSwitchDisableReceiving )
|
|
volatile unsigned long long RCSwitch::nReceivedValue = 0;
|
|
volatile unsigned int RCSwitch::nReceivedBitlength = 0;
|
|
volatile unsigned int RCSwitch::nReceivedDelay = 0;
|
|
volatile unsigned int RCSwitch::nReceivedProtocol = 0;
|
|
int RCSwitch::nReceiveTolerance = 60;
|
|
const unsigned int RCSwitch::nSeparationLimit = 4100; // 4300 default
|
|
// separationLimit: minimum microseconds between received codes, closer codes are ignored.
|
|
// according to discussion on issue #14 it might be more suitable to set the separation
|
|
// limit to the same time as the 'low' part of the sync signal for the current protocol.
|
|
unsigned int RCSwitch::timings[RCSWITCH_MAX_CHANGES];
|
|
unsigned int RCSwitch::buftimings[4];
|
|
#endif
|
|
|
|
RCSwitch::RCSwitch() {
|
|
this->nTransmitterPin = -1;
|
|
this->setRepeatTransmit(5);
|
|
this->setProtocol(1);
|
|
#if not defined( RCSwitchDisableReceiving )
|
|
this->nReceiverInterrupt = -1;
|
|
this->setReceiveTolerance(60);
|
|
RCSwitch::nReceivedValue = 0;
|
|
#endif
|
|
}
|
|
|
|
/**
|
|
* Sets the protocol to send.
|
|
*/
|
|
void RCSwitch::setProtocol(Protocol protocol) {
|
|
this->protocol = protocol;
|
|
}
|
|
|
|
/**
|
|
* Sets the protocol to send, from a list of predefined protocols
|
|
*/
|
|
void RCSwitch::setProtocol(int nProtocol) {
|
|
if (nProtocol < 1 || nProtocol > numProto) {
|
|
nProtocol = 1; // TODO: trigger an error, e.g. "bad protocol" ???
|
|
}
|
|
#if defined(ESP8266) || defined(ESP32)
|
|
this->protocol = proto[nProtocol-1];
|
|
#else
|
|
memcpy_P(&this->protocol, &proto[nProtocol-1], sizeof(Protocol));
|
|
#endif
|
|
}
|
|
|
|
/**
|
|
* Sets the protocol to send with pulse length in microseconds.
|
|
*/
|
|
void RCSwitch::setProtocol(int nProtocol, int nPulseLength) {
|
|
setProtocol(nProtocol);
|
|
this->setPulseLength(nPulseLength);
|
|
}
|
|
|
|
|
|
/**
|
|
* Sets pulse length in microseconds
|
|
*/
|
|
void RCSwitch::setPulseLength(int nPulseLength) {
|
|
this->protocol.pulseLength = nPulseLength;
|
|
}
|
|
|
|
/**
|
|
* Sets Repeat Transmits
|
|
*/
|
|
void RCSwitch::setRepeatTransmit(int nRepeatTransmit) {
|
|
this->nRepeatTransmit = nRepeatTransmit;
|
|
}
|
|
|
|
/**
|
|
* Set Receiving Tolerance
|
|
*/
|
|
#if not defined( RCSwitchDisableReceiving )
|
|
void RCSwitch::setReceiveTolerance(int nPercent) {
|
|
RCSwitch::nReceiveTolerance = nPercent;
|
|
}
|
|
#endif
|
|
|
|
|
|
/**
|
|
* Enable transmissions
|
|
*
|
|
* @param nTransmitterPin Arduino Pin to which the sender is connected to
|
|
*/
|
|
void RCSwitch::enableTransmit(int nTransmitterPin) {
|
|
this->nTransmitterPin = nTransmitterPin;
|
|
pinMode(this->nTransmitterPin, OUTPUT);
|
|
}
|
|
|
|
/**
|
|
* Disable transmissions
|
|
*/
|
|
void RCSwitch::disableTransmit() {
|
|
this->nTransmitterPin = -1;
|
|
}
|
|
|
|
/**
|
|
* Switch a remote switch on (Type D REV)
|
|
*
|
|
* @param sGroup Code of the switch group (A,B,C,D)
|
|
* @param nDevice Number of the switch itself (1..3)
|
|
*/
|
|
void RCSwitch::switchOn(char sGroup, int nDevice) {
|
|
this->sendTriState( this->getCodeWordD(sGroup, nDevice, true) );
|
|
}
|
|
|
|
/**
|
|
* Switch a remote switch off (Type D REV)
|
|
*
|
|
* @param sGroup Code of the switch group (A,B,C,D)
|
|
* @param nDevice Number of the switch itself (1..3)
|
|
*/
|
|
void RCSwitch::switchOff(char sGroup, int nDevice) {
|
|
this->sendTriState( this->getCodeWordD(sGroup, nDevice, false) );
|
|
}
|
|
|
|
/**
|
|
* Switch a remote switch on (Type C Intertechno)
|
|
*
|
|
* @param sFamily Familycode (a..f)
|
|
* @param nGroup Number of group (1..4)
|
|
* @param nDevice Number of device (1..4)
|
|
*/
|
|
void RCSwitch::switchOn(char sFamily, int nGroup, int nDevice) {
|
|
this->sendTriState( this->getCodeWordC(sFamily, nGroup, nDevice, true) );
|
|
}
|
|
|
|
/**
|
|
* Switch a remote switch off (Type C Intertechno)
|
|
*
|
|
* @param sFamily Familycode (a..f)
|
|
* @param nGroup Number of group (1..4)
|
|
* @param nDevice Number of device (1..4)
|
|
*/
|
|
void RCSwitch::switchOff(char sFamily, int nGroup, int nDevice) {
|
|
this->sendTriState( this->getCodeWordC(sFamily, nGroup, nDevice, false) );
|
|
}
|
|
|
|
/**
|
|
* Switch a remote switch on (Type B with two rotary/sliding switches)
|
|
*
|
|
* @param nAddressCode Number of the switch group (1..4)
|
|
* @param nChannelCode Number of the switch itself (1..4)
|
|
*/
|
|
void RCSwitch::switchOn(int nAddressCode, int nChannelCode) {
|
|
this->sendTriState( this->getCodeWordB(nAddressCode, nChannelCode, true) );
|
|
}
|
|
|
|
/**
|
|
* Switch a remote switch off (Type B with two rotary/sliding switches)
|
|
*
|
|
* @param nAddressCode Number of the switch group (1..4)
|
|
* @param nChannelCode Number of the switch itself (1..4)
|
|
*/
|
|
void RCSwitch::switchOff(int nAddressCode, int nChannelCode) {
|
|
this->sendTriState( this->getCodeWordB(nAddressCode, nChannelCode, false) );
|
|
}
|
|
|
|
/**
|
|
* Deprecated, use switchOn(const char* sGroup, const char* sDevice) instead!
|
|
* Switch a remote switch on (Type A with 10 pole DIP switches)
|
|
*
|
|
* @param sGroup Code of the switch group (refers to DIP switches 1..5 where "1" = on and "0" = off, if all DIP switches are on it's "11111")
|
|
* @param nChannelCode Number of the switch itself (1..5)
|
|
*/
|
|
void RCSwitch::switchOn(const char* sGroup, int nChannel) {
|
|
const char* code[6] = { "00000", "10000", "01000", "00100", "00010", "00001" };
|
|
this->switchOn(sGroup, code[nChannel]);
|
|
}
|
|
|
|
/**
|
|
* Deprecated, use switchOff(const char* sGroup, const char* sDevice) instead!
|
|
* Switch a remote switch off (Type A with 10 pole DIP switches)
|
|
*
|
|
* @param sGroup Code of the switch group (refers to DIP switches 1..5 where "1" = on and "0" = off, if all DIP switches are on it's "11111")
|
|
* @param nChannelCode Number of the switch itself (1..5)
|
|
*/
|
|
void RCSwitch::switchOff(const char* sGroup, int nChannel) {
|
|
const char* code[6] = { "00000", "10000", "01000", "00100", "00010", "00001" };
|
|
this->switchOff(sGroup, code[nChannel]);
|
|
}
|
|
|
|
/**
|
|
* Switch a remote switch on (Type A with 10 pole DIP switches)
|
|
*
|
|
* @param sGroup Code of the switch group (refers to DIP switches 1..5 where "1" = on and "0" = off, if all DIP switches are on it's "11111")
|
|
* @param sDevice Code of the switch device (refers to DIP switches 6..10 (A..E) where "1" = on and "0" = off, if all DIP switches are on it's "11111")
|
|
*/
|
|
void RCSwitch::switchOn(const char* sGroup, const char* sDevice) {
|
|
this->sendTriState( this->getCodeWordA(sGroup, sDevice, true) );
|
|
}
|
|
|
|
/**
|
|
* Switch a remote switch off (Type A with 10 pole DIP switches)
|
|
*
|
|
* @param sGroup Code of the switch group (refers to DIP switches 1..5 where "1" = on and "0" = off, if all DIP switches are on it's "11111")
|
|
* @param sDevice Code of the switch device (refers to DIP switches 6..10 (A..E) where "1" = on and "0" = off, if all DIP switches are on it's "11111")
|
|
*/
|
|
void RCSwitch::switchOff(const char* sGroup, const char* sDevice) {
|
|
this->sendTriState( this->getCodeWordA(sGroup, sDevice, false) );
|
|
}
|
|
|
|
|
|
/**
|
|
* Returns a char[13], representing the code word to be send.
|
|
*
|
|
*/
|
|
char* RCSwitch::getCodeWordA(const char* sGroup, const char* sDevice, bool bStatus) {
|
|
static char sReturn[13];
|
|
int nReturnPos = 0;
|
|
|
|
for (int i = 0; i < 5; i++) {
|
|
sReturn[nReturnPos++] = (sGroup[i] == '0') ? 'F' : '0';
|
|
}
|
|
|
|
for (int i = 0; i < 5; i++) {
|
|
sReturn[nReturnPos++] = (sDevice[i] == '0') ? 'F' : '0';
|
|
}
|
|
|
|
sReturn[nReturnPos++] = bStatus ? '0' : 'F';
|
|
sReturn[nReturnPos++] = bStatus ? 'F' : '0';
|
|
|
|
sReturn[nReturnPos] = '\0';
|
|
return sReturn;
|
|
}
|
|
|
|
/**
|
|
* Encoding for type B switches with two rotary/sliding switches.
|
|
*
|
|
* The code word is a tristate word and with following bit pattern:
|
|
*
|
|
* +-----------------------------+-----------------------------+----------+------------+
|
|
* | 4 bits address | 4 bits address | 3 bits | 1 bit |
|
|
* | switch group | switch number | not used | on / off |
|
|
* | 1=0FFF 2=F0FF 3=FF0F 4=FFF0 | 1=0FFF 2=F0FF 3=FF0F 4=FFF0 | FFF | on=F off=0 |
|
|
* +-----------------------------+-----------------------------+----------+------------+
|
|
*
|
|
* @param nAddressCode Number of the switch group (1..4)
|
|
* @param nChannelCode Number of the switch itself (1..4)
|
|
* @param bStatus Whether to switch on (true) or off (false)
|
|
*
|
|
* @return char[13], representing a tristate code word of length 12
|
|
*/
|
|
char* RCSwitch::getCodeWordB(int nAddressCode, int nChannelCode, bool bStatus) {
|
|
static char sReturn[13];
|
|
int nReturnPos = 0;
|
|
|
|
if (nAddressCode < 1 || nAddressCode > 4 || nChannelCode < 1 || nChannelCode > 4) {
|
|
return 0;
|
|
}
|
|
|
|
for (int i = 1; i <= 4; i++) {
|
|
sReturn[nReturnPos++] = (nAddressCode == i) ? '0' : 'F';
|
|
}
|
|
|
|
for (int i = 1; i <= 4; i++) {
|
|
sReturn[nReturnPos++] = (nChannelCode == i) ? '0' : 'F';
|
|
}
|
|
|
|
sReturn[nReturnPos++] = 'F';
|
|
sReturn[nReturnPos++] = 'F';
|
|
sReturn[nReturnPos++] = 'F';
|
|
|
|
sReturn[nReturnPos++] = bStatus ? 'F' : '0';
|
|
|
|
sReturn[nReturnPos] = '\0';
|
|
return sReturn;
|
|
}
|
|
|
|
/**
|
|
* Like getCodeWord (Type C = Intertechno)
|
|
*/
|
|
char* RCSwitch::getCodeWordC(char sFamily, int nGroup, int nDevice, bool bStatus) {
|
|
static char sReturn[13];
|
|
int nReturnPos = 0;
|
|
|
|
int nFamily = (int)sFamily - 'a';
|
|
if ( nFamily < 0 || nFamily > 15 || nGroup < 1 || nGroup > 4 || nDevice < 1 || nDevice > 4) {
|
|
return 0;
|
|
}
|
|
|
|
// encode the family into four bits
|
|
sReturn[nReturnPos++] = (nFamily & 1) ? 'F' : '0';
|
|
sReturn[nReturnPos++] = (nFamily & 2) ? 'F' : '0';
|
|
sReturn[nReturnPos++] = (nFamily & 4) ? 'F' : '0';
|
|
sReturn[nReturnPos++] = (nFamily & 8) ? 'F' : '0';
|
|
|
|
// encode the device and group
|
|
sReturn[nReturnPos++] = ((nDevice-1) & 1) ? 'F' : '0';
|
|
sReturn[nReturnPos++] = ((nDevice-1) & 2) ? 'F' : '0';
|
|
sReturn[nReturnPos++] = ((nGroup-1) & 1) ? 'F' : '0';
|
|
sReturn[nReturnPos++] = ((nGroup-1) & 2) ? 'F' : '0';
|
|
|
|
// encode the status code
|
|
sReturn[nReturnPos++] = '0';
|
|
sReturn[nReturnPos++] = 'F';
|
|
sReturn[nReturnPos++] = 'F';
|
|
sReturn[nReturnPos++] = bStatus ? 'F' : '0';
|
|
|
|
sReturn[nReturnPos] = '\0';
|
|
return sReturn;
|
|
}
|
|
|
|
/**
|
|
* Encoding for the REV Switch Type
|
|
*
|
|
* The code word is a tristate word and with following bit pattern:
|
|
*
|
|
* +-----------------------------+-------------------+----------+--------------+
|
|
* | 4 bits address | 3 bits address | 3 bits | 2 bits |
|
|
* | switch group | device number | not used | on / off |
|
|
* | A=1FFF B=F1FF C=FF1F D=FFF1 | 1=0FF 2=F0F 3=FF0 | 000 | on=10 off=01 |
|
|
* +-----------------------------+-------------------+----------+--------------+
|
|
*
|
|
* Source: http://www.the-intruder.net/funksteckdosen-von-rev-uber-arduino-ansteuern/
|
|
*
|
|
* @param sGroup Name of the switch group (A..D, resp. a..d)
|
|
* @param nDevice Number of the switch itself (1..3)
|
|
* @param bStatus Whether to switch on (true) or off (false)
|
|
*
|
|
* @return char[13], representing a tristate code word of length 12
|
|
*/
|
|
char* RCSwitch::getCodeWordD(char sGroup, int nDevice, bool bStatus) {
|
|
static char sReturn[13];
|
|
int nReturnPos = 0;
|
|
|
|
// sGroup must be one of the letters in "abcdABCD"
|
|
int nGroup = (sGroup >= 'a') ? (int)sGroup - 'a' : (int)sGroup - 'A';
|
|
if ( nGroup < 0 || nGroup > 3 || nDevice < 1 || nDevice > 3) {
|
|
return 0;
|
|
}
|
|
|
|
for (int i = 0; i < 4; i++) {
|
|
sReturn[nReturnPos++] = (nGroup == i) ? '1' : 'F';
|
|
}
|
|
|
|
for (int i = 1; i <= 3; i++) {
|
|
sReturn[nReturnPos++] = (nDevice == i) ? '1' : 'F';
|
|
}
|
|
|
|
sReturn[nReturnPos++] = '0';
|
|
sReturn[nReturnPos++] = '0';
|
|
sReturn[nReturnPos++] = '0';
|
|
|
|
sReturn[nReturnPos++] = bStatus ? '1' : '0';
|
|
sReturn[nReturnPos++] = bStatus ? '0' : '1';
|
|
|
|
sReturn[nReturnPos] = '\0';
|
|
return sReturn;
|
|
}
|
|
|
|
/**
|
|
* @param sCodeWord a tristate code word consisting of the letter 0, 1, F
|
|
*/
|
|
void RCSwitch::sendTriState(const char* sCodeWord) {
|
|
// turn the tristate code word into the corresponding bit pattern, then send it
|
|
unsigned long long code = 0;
|
|
unsigned int length = 0;
|
|
for (const char* p = sCodeWord; *p; p++) {
|
|
code <<= 2L;
|
|
switch (*p) {
|
|
case '0':
|
|
// bit pattern 00
|
|
break;
|
|
case 'F':
|
|
// bit pattern 01
|
|
code |= 1ULL;
|
|
break;
|
|
case '1':
|
|
// bit pattern 11
|
|
code |= 3ULL;
|
|
break;
|
|
}
|
|
length += 2;
|
|
}
|
|
this->send(code, length);
|
|
}
|
|
|
|
/**
|
|
* @param sCodeWord a binary code word consisting of the letter 0, 1
|
|
*/
|
|
void RCSwitch::send(const char* sCodeWord) {
|
|
// turn the tristate code word into the corresponding bit pattern, then send it
|
|
unsigned long long code = 0;
|
|
unsigned int length = 0;
|
|
for (const char* p = sCodeWord; *p; p++) {
|
|
code <<= 1ULL;
|
|
if (*p != '0')
|
|
code |= 1ULL;
|
|
length++;
|
|
}
|
|
this->send(code, length);
|
|
}
|
|
|
|
/**
|
|
* Transmit the first 'length' bits of the integer 'code'. The
|
|
* bits are sent from MSB to LSB, i.e., first the bit at position length-1,
|
|
* then the bit at position length-2, and so on, till finally the bit at position 0.
|
|
*/
|
|
void RCSwitch::send(unsigned long long code, unsigned int length) {
|
|
if (this->nTransmitterPin == -1)
|
|
return;
|
|
|
|
#if not defined( RCSwitchDisableReceiving )
|
|
// make sure the receiver is disabled while we transmit
|
|
int nReceiverInterrupt_backup = nReceiverInterrupt;
|
|
if (nReceiverInterrupt_backup != -1) {
|
|
this->disableReceive();
|
|
}
|
|
#endif
|
|
|
|
// повторяем отправку пакета nRepeatTransmit раз
|
|
for (int nRepeat = 0; nRepeat < nRepeatTransmit; nRepeat++) {
|
|
// отправляем преамбулу (меандр)
|
|
for (int i = 0; i < ((protocol.PreambleFactor / 2) + (protocol.PreambleFactor %2 )); i++) {
|
|
this->transmit({protocol.Preamble.high, protocol.Preamble.low});
|
|
}
|
|
// отправляем хедер
|
|
if (protocol.HeaderFactor > 0) {
|
|
for (int i = 0; i < protocol.HeaderFactor; i++) {
|
|
this->transmit(protocol.Header);
|
|
}
|
|
}
|
|
// отправляем код посылки
|
|
for (int i = length - 1; i >= 0; i--) {
|
|
if (code & (1ULL << i))
|
|
this->transmit(protocol.one);
|
|
else
|
|
this->transmit(protocol.zero);
|
|
}
|
|
// для килока должна быть длительность 66, а сохраняется 64 значащих кода данных
|
|
// поэтому отправим еще два бита для ровного счета
|
|
if (length == 64) {
|
|
if (nRepeat == 0) {
|
|
this->transmit(protocol.zero);
|
|
this->transmit(protocol.zero);
|
|
} else {
|
|
this->transmit(protocol.one);
|
|
this->transmit(protocol.one);
|
|
}
|
|
}
|
|
// выдерживаем Защитное время (Guard Time)
|
|
if (protocol.Guard > 0) {
|
|
digitalWrite(this->nTransmitterPin, LOW);
|
|
delayMicroseconds(this->protocol.pulseLength * protocol.Guard);
|
|
}
|
|
}
|
|
|
|
// Disable transmit after sending (i.e., for inverted protocols)
|
|
digitalWrite(this->nTransmitterPin, LOW);
|
|
|
|
#if not defined( RCSwitchDisableReceiving )
|
|
// enable receiver again if we just disabled it
|
|
if (nReceiverInterrupt_backup != -1) {
|
|
this->enableReceive(nReceiverInterrupt_backup);
|
|
}
|
|
#endif
|
|
}
|
|
|
|
/**
|
|
* Transmit a single high-low pulse.
|
|
*/
|
|
void RCSwitch::transmit(HighLow pulses) {
|
|
uint8_t firstLogicLevel = (this->protocol.invertedSignal) ? LOW : HIGH;
|
|
uint8_t secondLogicLevel = (this->protocol.invertedSignal) ? HIGH : LOW;
|
|
|
|
if (pulses.high > 0) {
|
|
digitalWrite(this->nTransmitterPin, firstLogicLevel);
|
|
delayMicroseconds( this->protocol.pulseLength * pulses.high);
|
|
}
|
|
if (pulses.low > 0) {
|
|
digitalWrite(this->nTransmitterPin, secondLogicLevel);
|
|
delayMicroseconds( this->protocol.pulseLength * pulses.low);
|
|
}
|
|
}
|
|
|
|
|
|
#if not defined( RCSwitchDisableReceiving )
|
|
/**
|
|
* Enable receiving data
|
|
*/
|
|
void RCSwitch::enableReceive(int interrupt) {
|
|
this->nReceiverInterrupt = interrupt;
|
|
this->enableReceive();
|
|
}
|
|
|
|
void RCSwitch::enableReceive() {
|
|
if (this->nReceiverInterrupt != -1) {
|
|
RCSwitch::nReceivedValue = 0;
|
|
RCSwitch::nReceivedBitlength = 0;
|
|
#if defined(RaspberryPi) // Raspberry Pi
|
|
wiringPiISR(this->nReceiverInterrupt, INT_EDGE_BOTH, &handleInterrupt);
|
|
#else // Arduino
|
|
attachInterrupt(this->nReceiverInterrupt, handleInterrupt, CHANGE);
|
|
#endif
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Disable receiving data
|
|
*/
|
|
void RCSwitch::disableReceive() {
|
|
#if not defined(RaspberryPi) // Arduino
|
|
detachInterrupt(this->nReceiverInterrupt);
|
|
#endif // For Raspberry Pi (wiringPi) you can't unregister the ISR
|
|
this->nReceiverInterrupt = -1;
|
|
}
|
|
|
|
bool RCSwitch::available() {
|
|
return RCSwitch::nReceivedValue != 0;
|
|
}
|
|
|
|
void RCSwitch::resetAvailable() {
|
|
RCSwitch::nReceivedValue = 0;
|
|
}
|
|
|
|
unsigned long long RCSwitch::getReceivedValue() {
|
|
return RCSwitch::nReceivedValue;
|
|
}
|
|
|
|
unsigned int RCSwitch::getReceivedBitlength() {
|
|
return RCSwitch::nReceivedBitlength;
|
|
}
|
|
|
|
unsigned int RCSwitch::getReceivedDelay() {
|
|
return RCSwitch::nReceivedDelay;
|
|
}
|
|
|
|
unsigned int RCSwitch::getReceivedProtocol() {
|
|
return RCSwitch::nReceivedProtocol;
|
|
}
|
|
|
|
unsigned int* RCSwitch::getReceivedRawdata() {
|
|
return RCSwitch::timings;
|
|
}
|
|
|
|
/* helper function for the receiveProtocol method */
|
|
static inline unsigned int diff(int A, int B) {
|
|
return abs(A - B);
|
|
}
|
|
|
|
/**
|
|
*
|
|
*/
|
|
bool RECEIVE_ATTR RCSwitch::receiveProtocol(const int p, unsigned int changeCount) {
|
|
#if defined(ESP8266) || defined(ESP32)
|
|
const Protocol &pro = proto[p-1];
|
|
#else
|
|
Protocol pro;
|
|
memcpy_P(&pro, &proto[p-1], sizeof(Protocol));
|
|
#endif
|
|
|
|
unsigned long long code = 0;
|
|
unsigned int FirstTiming = 0;
|
|
if (pro.PreambleFactor > 0) {
|
|
FirstTiming = pro.PreambleFactor + 1;
|
|
}
|
|
unsigned int BeginData = 0;
|
|
if (pro.HeaderFactor > 0) {
|
|
BeginData = (pro.invertedSignal) ? (2) : (1);
|
|
// коррекция на количество импульсов в Хедере для более одного
|
|
if (pro.HeaderFactor > 1) {
|
|
BeginData += (pro.HeaderFactor - 1) * 2;
|
|
}
|
|
}
|
|
//Assuming the longer pulse length is the pulse captured in timings[FirstTiming]
|
|
// берем наибольшее значение из Header
|
|
const unsigned int syncLengthInPulses = ((pro.Header.low) > (pro.Header.high)) ? (pro.Header.low) : (pro.Header.high);
|
|
// определяем длительность Te как длительность первого импульса header деленную на количество импульсов в нем
|
|
// или как длительность импульса preamble деленную на количество Te в нем
|
|
unsigned int sdelay = 0;
|
|
if (syncLengthInPulses > 0) {
|
|
sdelay = RCSwitch::timings[FirstTiming] / syncLengthInPulses;
|
|
} else {
|
|
sdelay = RCSwitch::timings[FirstTiming-2] / pro.PreambleFactor;
|
|
}
|
|
const unsigned int delay = sdelay;
|
|
// nReceiveTolerance = 60
|
|
// допустимое отклонение длительностей импульсов на 60 %
|
|
const unsigned int delayTolerance = delay * RCSwitch::nReceiveTolerance / 100;
|
|
|
|
// 0 - sync перед preamble или data
|
|
// BeginData - сдвиг на 1 или 2 от sync к preamble/data
|
|
// FirstTiming - сдвиг на preamble к header
|
|
// firstDataTiming первый импульс data
|
|
// bitChangeCount - количество импульсов в data
|
|
|
|
/* For protocols that start low, the sync period looks like
|
|
* _________
|
|
* _____________| |XXXXXXXXXXXX|
|
|
*
|
|
* |--1st dur--|-2nd dur-|-Start data-|
|
|
*
|
|
* The 3rd saved duration starts the data.
|
|
*
|
|
* For protocols that start high, the sync period looks like
|
|
*
|
|
* ______________
|
|
* | |____________|XXXXXXXXXXXXX|
|
|
*
|
|
* |-filtered out-|--1st dur--|--Start data--|
|
|
*
|
|
* The 2nd saved duration starts the data
|
|
*/
|
|
// если invertedSignal=false, то сигнал начинается с 1 элемента массива (высокий уровень)
|
|
// если invertedSignal=true, то сигнал начинается со 2 элемента массива (низкий уровень)
|
|
// добавляем поправку на Преамбулу и Хедер
|
|
const unsigned int firstDataTiming = BeginData + FirstTiming;
|
|
unsigned int bitChangeCount = changeCount - firstDataTiming - 1 + pro.invertedSignal;
|
|
if (bitChangeCount > 128) {
|
|
bitChangeCount = 128;
|
|
}
|
|
|
|
for (unsigned int i = firstDataTiming; i < firstDataTiming + bitChangeCount; i += 2) {
|
|
code <<= 1;
|
|
if (diff(RCSwitch::timings[i], delay * pro.zero.high) < delayTolerance &&
|
|
diff(RCSwitch::timings[i + 1], delay * pro.zero.low) < delayTolerance) {
|
|
// zero
|
|
} else if (diff(RCSwitch::timings[i], delay * pro.one.high) < delayTolerance &&
|
|
diff(RCSwitch::timings[i + 1], delay * pro.one.low) < delayTolerance) {
|
|
// one
|
|
code |= 1;
|
|
} else {
|
|
// Failed
|
|
return false;
|
|
}
|
|
}
|
|
|
|
if (bitChangeCount > 14) { // ignore very short transmissions: no device sends them, so this must be noise
|
|
RCSwitch::nReceivedValue = code;
|
|
RCSwitch::nReceivedBitlength = bitChangeCount / 2;
|
|
RCSwitch::nReceivedDelay = delay;
|
|
RCSwitch::nReceivedProtocol = p;
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
void RECEIVE_ATTR RCSwitch::handleInterrupt() {
|
|
|
|
static unsigned int changeCount = 0;
|
|
static unsigned long lastTime = 0;
|
|
static byte repeatCount = 0;
|
|
|
|
const long time = micros();
|
|
const unsigned int duration = time - lastTime;
|
|
|
|
RCSwitch::buftimings[3]=RCSwitch::buftimings[2];
|
|
RCSwitch::buftimings[2]=RCSwitch::buftimings[1];
|
|
RCSwitch::buftimings[1]=RCSwitch::buftimings[0];
|
|
RCSwitch::buftimings[0]=duration;
|
|
|
|
if (duration > RCSwitch::nSeparationLimit ||
|
|
changeCount == 156 ||
|
|
(diff(RCSwitch::buftimings[3], RCSwitch::buftimings[2]) < 50 &&
|
|
diff(RCSwitch::buftimings[2], RCSwitch::buftimings[1]) < 50 &&
|
|
changeCount > 25)) {
|
|
// принят длинный импульс продолжительностью более nSeparationLimit (4300)
|
|
// A long stretch without signal level change occurred. This could
|
|
// be the gap between two transmission.
|
|
if (diff(duration, RCSwitch::timings[0]) < 400 ||
|
|
changeCount == 156 ||
|
|
(diff(RCSwitch::buftimings[3], RCSwitch::timings[1]) < 50 &&
|
|
diff(RCSwitch::buftimings[2], RCSwitch::timings[2]) < 50 &&
|
|
diff(RCSwitch::buftimings[1], RCSwitch::timings[3]) < 50 &&
|
|
changeCount > 25)) {
|
|
// если его длительность отличается от первого импульса,
|
|
// который приняли раньше, менее чем на +-200 (исходно 200)
|
|
// то считаем это повторным пакетом и игнорируем его
|
|
// This long signal is close in length to the long signal which
|
|
// started the previously recorded timings; this suggests that
|
|
// it may indeed by a a gap between two transmissions (we assume
|
|
// here that a sender will send the signal multiple times,
|
|
// with roughly the same gap between them).
|
|
|
|
// количество повторных пакетов
|
|
repeatCount++;
|
|
// при приеме второго повторного начинаем анализ принятого первым
|
|
if (repeatCount == 1) {
|
|
for(unsigned int i = 1; i <= numProto; i++) {
|
|
if (receiveProtocol(i, changeCount)) {
|
|
// receive succeeded for protocol i
|
|
break;
|
|
}
|
|
}
|
|
// очищаем количество повторных пакетов
|
|
repeatCount = 0;
|
|
}
|
|
}
|
|
// дительность отличается более чем на +-200 от первого
|
|
// принятого ранее, очищаем счетчик для приема нового пакета
|
|
changeCount = 0;
|
|
if (diff(RCSwitch::buftimings[3], RCSwitch::buftimings[2]) < 50 &&
|
|
diff(RCSwitch::buftimings[2], RCSwitch::buftimings[1]) < 50) {
|
|
RCSwitch::timings[1]=RCSwitch::buftimings[3];
|
|
RCSwitch::timings[2]=RCSwitch::buftimings[2];
|
|
RCSwitch::timings[3]=RCSwitch::buftimings[1];
|
|
changeCount = 4;
|
|
}
|
|
}
|
|
|
|
// detect overflow
|
|
if (changeCount >= RCSWITCH_MAX_CHANGES) {
|
|
changeCount = 0;
|
|
repeatCount = 0;
|
|
}
|
|
|
|
// заносим в массив длительность очередного принятого импульса
|
|
if (changeCount > 0 && duration < 100) { // игнорируем шумовые всплески менее 100 мкс
|
|
RCSwitch::timings[changeCount-1] += duration;
|
|
} else {
|
|
RCSwitch::timings[changeCount++] = duration;
|
|
}
|
|
lastTime = time;
|
|
}
|
|
#endif
|
|
|
|
/**
|
|
* Initilize Keeloq
|
|
*/
|
|
Keeloq::Keeloq() {
|
|
_keyHigh = 0;
|
|
_keyLow = 0;
|
|
}
|
|
|
|
/**
|
|
* Set Keeloq 64 bit cypher key
|
|
*/
|
|
void Keeloq::SetKey(unsigned long keyHigh, unsigned long keyLow) {
|
|
_keyHigh = keyHigh;
|
|
_keyLow = keyLow;
|
|
}
|
|
|
|
/**
|
|
* Get Key data
|
|
*/
|
|
unsigned long Keeloq::GetKey(bool HighLow) {
|
|
if (HighLow) {
|
|
return _keyHigh;
|
|
}
|
|
return _keyLow;
|
|
}
|
|
|
|
/**
|
|
* Encrypt Keeloq 32 bit data
|
|
*/
|
|
unsigned long Keeloq::Encrypt(unsigned long data) {
|
|
unsigned long x = data;
|
|
unsigned long r;
|
|
int keyBitNo, index;
|
|
unsigned long keyBitVal,bitVal;
|
|
|
|
for (r = 0; r < 528; r++) {
|
|
keyBitNo = r & 63;
|
|
if (keyBitNo < 32) {
|
|
keyBitVal = bitRead(_keyLow,keyBitNo);
|
|
} else {
|
|
keyBitVal = bitRead(_keyHigh, keyBitNo - 32);
|
|
}
|
|
index = 1 * bitRead(x, 1) + 2 * bitRead(x, 9) + 4 * bitRead(x, 20) + 8 * bitRead(x, 26) + 16 * bitRead(x, 31);
|
|
bitVal = bitRead(x, 0) ^ bitRead(x, 16) ^ bitRead(KeeLoq_NLF, index) ^ keyBitVal;
|
|
x = (x >> 1) ^ bitVal << 31;
|
|
}
|
|
return x;
|
|
}
|
|
|
|
/**
|
|
* Decrypt Keeloq 32 bit data
|
|
*/
|
|
unsigned long Keeloq::Decrypt(unsigned long data) {
|
|
unsigned long x = data;
|
|
unsigned long r;
|
|
int keyBitNo, index;
|
|
unsigned long keyBitVal,bitVal;
|
|
|
|
for (r = 0; r < 528; r++) {
|
|
keyBitNo = (15-r) & 63;
|
|
if(keyBitNo < 32) {
|
|
keyBitVal = bitRead(_keyLow,keyBitNo);
|
|
} else {
|
|
keyBitVal = bitRead(_keyHigh, keyBitNo - 32);
|
|
}
|
|
index = 1 * bitRead(x, 0) + 2 * bitRead(x, 8) + 4 * bitRead(x, 19) + 8 * bitRead(x, 25) + 16 * bitRead(x, 30);
|
|
bitVal = bitRead(x, 31) ^ bitRead(x, 15) ^ bitRead(KeeLoq_NLF, index) ^ keyBitVal;
|
|
x = (x << 1) ^ bitVal;
|
|
}
|
|
return x;
|
|
}
|
|
|
|
/**
|
|
* Set Normal Learning Keeloq key
|
|
*/
|
|
void Keeloq::NormLearn(unsigned long FixSN) {
|
|
unsigned long tmpFixSN;
|
|
// заготовки для формируемого ключа
|
|
unsigned long NewkeyHigh;
|
|
unsigned long NewkeyLow;
|
|
|
|
tmpFixSN = FixSN & 0x0FFFFFFF;
|
|
tmpFixSN |= 0x20000000;
|
|
NewkeyLow = Decrypt(tmpFixSN);
|
|
tmpFixSN = FixSN & 0x0FFFFFFF;
|
|
tmpFixSN |= 0x60000000;
|
|
NewkeyHigh = Decrypt(tmpFixSN);
|
|
_keyHigh = NewkeyHigh;
|
|
_keyLow = NewkeyLow;
|
|
}
|
|
|
|
/**
|
|
* Reflect a 32 bit package
|
|
*/
|
|
unsigned long Keeloq::ReflectPack(unsigned long PackSrc) {
|
|
unsigned long long PackOut = 0;
|
|
for (byte i = 0; i < 32; i++) {
|
|
PackOut = PackOut << 1;
|
|
if (PackSrc & 1) {
|
|
PackOut = PackOut | 1;
|
|
}
|
|
PackSrc = PackSrc >> 1;
|
|
}
|
|
return PackOut;
|
|
}
|