Add Oregon decoder library
Mickael Hubert
This commit is contained in:
mickaelh51
@@ -0,0 +1,341 @@
|
||||
// Oregon V2 decoder modified for MySensors compatibility - Mickael Hubert <github@winlux.fr>
|
||||
// Oregon V2 decoder modified - Olivier Lebrun
|
||||
// Oregon V2 decoder added - Dominique Pierre
|
||||
// New code to decode OOK signals from weather sensors, etc.
|
||||
// 2010-04-11 <jcw@equi4.com> http://opensource.org/licenses/mit-license.php
|
||||
// $Id: ookDecoder.pde 5331 2010-04-17 10:45:17Z jcw $
|
||||
|
||||
#ifndef Oregon_h
|
||||
#define Oregon_h
|
||||
#include "Arduino.h"
|
||||
|
||||
/*--------------------------
|
||||
Class DecodeOOK
|
||||
--------------------------*/
|
||||
class DecodeOOK
|
||||
{
|
||||
protected:
|
||||
byte total_bits, bits, flip, state, pos, data[25];
|
||||
|
||||
virtual char decode (word width) =0;
|
||||
|
||||
public:
|
||||
|
||||
enum { UNKNOWN, T0, T1, T2, T3, OK, DONE };
|
||||
|
||||
DecodeOOK () { resetDecoder(); }
|
||||
|
||||
bool nextPulse (word width) {
|
||||
if (state != DONE)
|
||||
|
||||
switch (decode(width)) {
|
||||
case -1: resetDecoder(); break;
|
||||
case 1: done(); break;
|
||||
}
|
||||
return isDone();
|
||||
}
|
||||
|
||||
bool isDone () const { return state == DONE; }
|
||||
|
||||
const byte* getData (byte& count) const {
|
||||
count = pos;
|
||||
return data;
|
||||
}
|
||||
|
||||
void resetDecoder () {
|
||||
total_bits = bits = pos = flip = 0;
|
||||
state = UNKNOWN;
|
||||
}
|
||||
|
||||
// add one bit to the packet data buffer
|
||||
|
||||
virtual void gotBit (char value) {
|
||||
total_bits++;
|
||||
byte *ptr = data + pos;
|
||||
*ptr = (*ptr >> 1) | (value << 7);
|
||||
|
||||
if (++bits >= 8) {
|
||||
bits = 0;
|
||||
if (++pos >= sizeof data) {
|
||||
resetDecoder();
|
||||
return;
|
||||
}
|
||||
}
|
||||
state = OK;
|
||||
}
|
||||
|
||||
// store a bit using Manchester encoding
|
||||
void manchester (char value) {
|
||||
flip ^= value; // manchester code, long pulse flips the bit
|
||||
gotBit(flip);
|
||||
}
|
||||
|
||||
// move bits to the front so that all the bits are aligned to the end
|
||||
void alignTail (byte max =0) {
|
||||
// align bits
|
||||
if (bits != 0) {
|
||||
data[pos] >>= 8 - bits;
|
||||
for (byte i = 0; i < pos; ++i)
|
||||
data[i] = (data[i] >> bits) | (data[i+1] << (8 - bits));
|
||||
bits = 0;
|
||||
}
|
||||
// optionally shift bytes down if there are too many of 'em
|
||||
if (max > 0 && pos > max) {
|
||||
byte n = pos - max;
|
||||
pos = max;
|
||||
for (byte i = 0; i < pos; ++i)
|
||||
data[i] = data[i+n];
|
||||
}
|
||||
}
|
||||
|
||||
void reverseBits () {
|
||||
for (byte i = 0; i < pos; ++i) {
|
||||
byte b = data[i];
|
||||
for (byte j = 0; j < 8; ++j) {
|
||||
data[i] = (data[i] << 1) | (b & 1);
|
||||
b >>= 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void reverseNibbles () {
|
||||
for (byte i = 0; i < pos; ++i)
|
||||
data[i] = (data[i] << 4) | (data[i] >> 4);
|
||||
}
|
||||
|
||||
void done () {
|
||||
while (bits)
|
||||
gotBit(0); // padding
|
||||
state = DONE;
|
||||
}
|
||||
};
|
||||
|
||||
/*--------------------------
|
||||
Class OregonDecoderV2
|
||||
--------------------------*/
|
||||
class OregonDecoderV2 : public DecodeOOK {
|
||||
public:
|
||||
|
||||
OregonDecoderV2() {}
|
||||
|
||||
// add one bit to the packet data buffer
|
||||
virtual void gotBit (char value) {
|
||||
if(!(total_bits & 0x01))
|
||||
{
|
||||
data[pos] = (data[pos] >> 1) | (value ? 0x80 : 00);
|
||||
}
|
||||
total_bits++;
|
||||
pos = total_bits >> 4;
|
||||
if (pos >= sizeof data) {
|
||||
//Serial.println("sizeof data");
|
||||
resetDecoder();
|
||||
return;
|
||||
}
|
||||
state = OK;
|
||||
}
|
||||
|
||||
virtual char decode (word width) {
|
||||
if (200 <= width && width < 1200) {
|
||||
//Serial.println(width);
|
||||
byte w = width >= 700;
|
||||
|
||||
switch (state) {
|
||||
case UNKNOWN:
|
||||
if (w != 0) {
|
||||
// Long pulse
|
||||
++flip;
|
||||
} else if (w == 0 && 24 <= flip) {
|
||||
// Short pulse, start bit
|
||||
flip = 0;
|
||||
state = T0;
|
||||
} else {
|
||||
// Reset decoder
|
||||
return -1;
|
||||
}
|
||||
break;
|
||||
case OK:
|
||||
if (w == 0) {
|
||||
// Short pulse
|
||||
state = T0;
|
||||
} else {
|
||||
// Long pulse
|
||||
manchester(1);
|
||||
}
|
||||
break;
|
||||
case T0:
|
||||
if (w == 0) {
|
||||
// Second short pulse
|
||||
manchester(0);
|
||||
} else {
|
||||
// Reset decoder
|
||||
return -1;
|
||||
}
|
||||
break;
|
||||
}
|
||||
} else if (width >= 2500 && pos >= 8) {
|
||||
return 1;
|
||||
} else {
|
||||
return -1;
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
};
|
||||
|
||||
/*--------------------------
|
||||
Manipulation functions
|
||||
--------------------------*/
|
||||
OregonDecoderV2 orscV2;
|
||||
|
||||
volatile word pulse;
|
||||
|
||||
void ext_int_1(void)
|
||||
{
|
||||
static word last;
|
||||
// determine the pulse length in microseconds, for either polarity
|
||||
pulse = micros() - last;
|
||||
last += pulse;
|
||||
}
|
||||
|
||||
float temperature(const byte* data)
|
||||
{
|
||||
int sign = (data[6]&0x8) ? -1 : 1;
|
||||
float temp = ((data[5]&0xF0) >> 4)*10 + (data[5]&0xF) + (float)(((data[4]&0xF0) >> 4) / 10.0);
|
||||
float result = sign * temp;
|
||||
#ifdef MY_DEBUG
|
||||
Serial.println("Oregon temperature: " + String(result));
|
||||
#endif
|
||||
return sign * temp;
|
||||
}
|
||||
|
||||
|
||||
byte humidity(const byte* data)
|
||||
{
|
||||
byte humidity = (data[7]&0xF) * 10 + ((data[6]&0xF0) >> 4);
|
||||
#ifdef MY_DEBUG
|
||||
Serial.println("Oregon humidity: " + String(humidity));
|
||||
#endif
|
||||
return (humidity);
|
||||
}
|
||||
|
||||
//10 => battery lovel is LOW
|
||||
//90 => battery level is HIGH
|
||||
byte battery(const byte* data)
|
||||
{
|
||||
byte BatteryLevel = (data[4] & 0x4) ? 10 : 90;
|
||||
#ifdef MY_DEBUG
|
||||
Serial.println("Oregon battery level: " + String(BatteryLevel));
|
||||
#endif
|
||||
return BatteryLevel;
|
||||
}
|
||||
|
||||
//Find id from Oregon Sensors
|
||||
byte id(const byte* data)
|
||||
{
|
||||
#ifdef MY_DEBUG
|
||||
Serial.print("Oregon ID: " + String(data[3]) + " Hexadecimal: ");
|
||||
Serial.println(data[3],HEX);
|
||||
#endif
|
||||
return (data[3]);
|
||||
}
|
||||
|
||||
//Find Channel from Oregon Sensors
|
||||
byte channel(const byte* data)
|
||||
{
|
||||
byte channel;
|
||||
switch (data[2])
|
||||
{
|
||||
case 0x10:
|
||||
channel = 1;
|
||||
break;
|
||||
case 0x20:
|
||||
channel = 2;
|
||||
break;
|
||||
case 0x40:
|
||||
channel = 3;
|
||||
break;
|
||||
}
|
||||
#ifdef MY_DEBUG
|
||||
Serial.println("Oregon channel: " + String(channel));
|
||||
#endif
|
||||
return channel;
|
||||
}
|
||||
|
||||
// Detect type of sensor module
|
||||
const char* OregonType (const byte* data)
|
||||
{
|
||||
const char* Model;
|
||||
if(data[0] == 0xEA && data[1] == 0x4C)
|
||||
{
|
||||
Model = "THN132N";
|
||||
}
|
||||
else if(data[0] == 0x1A && data[1] == 0x2D)
|
||||
{
|
||||
Model = "THGR228N";
|
||||
}
|
||||
else
|
||||
{
|
||||
Model = "UNKNOWN";
|
||||
}
|
||||
#ifdef MY_DEBUG
|
||||
Serial.println("Oregon model: " + String(Model));
|
||||
#endif
|
||||
|
||||
return Model;
|
||||
}
|
||||
|
||||
// Decode data once
|
||||
const byte* DataToDecoder (class DecodeOOK& decoder)
|
||||
{
|
||||
byte pos;
|
||||
const byte* data = decoder.getData(pos);
|
||||
#ifdef MY_DEBUG
|
||||
Serial.println("Brute Hexadecimal data from sensor: ");
|
||||
for (byte i = 0; i < pos; ++i) {
|
||||
Serial.print(data[i] >> 4, HEX);
|
||||
Serial.print(data[i] & 0x0F, HEX);
|
||||
}
|
||||
Serial.println(' ');
|
||||
#endif
|
||||
decoder.resetDecoder();
|
||||
return data;
|
||||
}
|
||||
|
||||
int FindSensor (const int id, int maxsensor)
|
||||
{
|
||||
int i;
|
||||
for (i=0; i<maxsensor; i++){
|
||||
#ifdef MySensor_h
|
||||
int SensorID = loadState(i);
|
||||
#else
|
||||
int SensorID = EEPROM.read(i);
|
||||
#endif
|
||||
if(SensorID == 255)
|
||||
{
|
||||
#ifdef MySensor_h
|
||||
saveState(i,id);
|
||||
#else
|
||||
EEPROM.write(i,id);
|
||||
#endif
|
||||
|
||||
#ifdef MY_DEBUG
|
||||
Serial.print("Sensor ID: ");
|
||||
Serial.print(SensorID);
|
||||
Serial.print(" has been saved in position EEPROM: ");
|
||||
Serial.println(i);
|
||||
#endif
|
||||
return i;
|
||||
}
|
||||
|
||||
if(id == SensorID){
|
||||
#ifdef MY_DEBUG
|
||||
Serial.print("Sensor ID: ");
|
||||
Serial.print(SensorID);
|
||||
Serial.print(" has been find in position EEPROM: ");
|
||||
Serial.println(i);
|
||||
#endif
|
||||
return i;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#endif
|
||||
Reference in New Issue
Block a user