Added MagiQuest Wand

Author: mpflaga

IRremote.cpp

@@ -221,6 +221,30 @@ void IRsend::sendJVC(int32_t data, int16_t nbits, int16_t repeat)
  mark(JVC_BIT_MARK);
  space(0);
 }
+
+void IRsend::sendMagiQuest(uint32_t wand_id, uint16_t magnitude)
+{
+ magiquest data;
+ //data.cmd.scrap = 0x00;
+ data.cmd.padding = 0x00;
+ data.cmd.magnitude = magnitude;
+ data.cmd.wand_id = wand_id;
+ 
+ enableIROut(38);
+ for (uint16_t i = 0; i < 56; i++) {
+ data.llword <<= 1;
+ if (((int8_t) data.byte[6]) < 0) { // if negative then MSBit is one.
+ mark(MAGIQUEST_MARK_ONE);
+ space(MAGIQUEST_SPACE_ONE);
+ }
+ else {
+ mark(MAGIQUEST_MARK_ZERO);
+ space(MAGIQUEST_SPACE_ZERO);
+ }
+ }
+ Serial.println();
+}
+
 void IRsend::mark(int time) {
  // Sends an IR mark for the specified number of microseconds.
  // The mark output is modulated at the PWM frequency.
@@ -439,6 +463,12 @@ int16_t IRrecv::decode(decode_results *results) {
  if (decodeJVC(results)) {
  return DECODED;
  }
+#ifdef DEBUG
+ Serial.println("Attempting MagiQuest decode");
+#endif
+ if (decodeMagiQuest(results)) {
+ return DECODED;
+ }
  // decodeHash returns a hash on any input.
  // Thus, it needs to be last in the list.
  // If you add any decodes, add them before this.
@@ -896,6 +926,66 @@ int32_t IRrecv::decodeJVC(decode_results *results) {
  return DECODED;
 }
 
+int32_t IRrecv::decodeMagiQuest(decode_results *results) {
+ magiquest data;
+ data.llword = 0;
+
+ int16_t offset = 1;
+ uint16_t mark_;
+ uint16_t space_;
+ uint8_t multiple_;
+
+ if (irparams.rawlen < 2 * MAGIQUEST_BITS) {
+ return ERR;
+ }
+
+ while (offset + 1 < irparams.rawlen) {
+ mark_ = results->rawbuf[offset];
+ space_ = results->rawbuf[offset+1];
+ multiple_ = space_ / mark_;
+ // it is either 25% + 75% or 50% + 50%
+
+#ifdef DEBUG
+ Serial.print("mark=");
+ Serial.print(mark_ * USECPERTICK);
+ Serial.print(" space=");
+ Serial.print(space_ * USECPERTICK);
+ Serial.print(" mult=");
+ Serial.print(multiple_);
+ Serial.print(" ");
+#endif
+ if (MATCH_MARK(space_ + mark_, MAGIQUEST_PERIOD)) {
+ if (multiple_ > 1) {
+#ifdef DEBUG
+ Serial.print("0-MPF ");
+ MATCH_MARK(results->rawbuf[offset], MAGIQUEST_MARK_ZERO);
+#endif
+ data.llword <<= 1;
+ } else {
+#ifdef DEBUG
+ Serial.print("1-MPF ");
+ MATCH_MARK(results->rawbuf[offset], MAGIQUEST_MARK_ONE);
+#endif
+ data.llword = (data.llword << 1) | 1;
+ }
+ } else {
+ return ERR;
+ }
+ offset++;
+ offset++;
+ }
+ // Success
+ results->bits = (offset + 1) / 2;
+ if (results->bits < 12) {
+ results->bits = 0;
+ return ERR;
+ }
+ results->magiquestMagnitude = data.cmd.magnitude;
+ results->value = data.cmd.wand_id;
+ results->decode_type = MAGIQUEST;
+ return DECODED;
+}
+
 /* -----------------------------------------------------------------------
  * hashdecode - decode an arbitrary IR code.
  * Instead of decoding using a standard encoding scheme

IRremote.h

@@ -24,11 +24,26 @@
 // #define DEBUG
 // #define TEST
 
+// MagiQuest packet is both Wand ID and magnitude of swish and flick
+union magiquest {
+ uint64_t llword;
+ uint8_t byte[8];
+// uint16_t word[4];
+// uint32_t lword[2];
+ struct {
+ uint16_t magnitude;
+ uint32_t wand_id;
+ uint8_t padding;
+ uint8_t scrap;
+ } cmd ;
+} ;
+
 // Results returned from the decoder
 class decode_results {
 public:
  int16_t decode_type; // NEC, SONY, RC5, UNKNOWN
  uint16_t panasonicAddress; // This is only used for decoding Panasonic data
+ uint16_t magiquestMagnitude; // This is only used for MagiQuest
  int32_t value; // Decoded value //mpf need to make unsigned.
  int16_t bits; // Number of bits in decoded value
  volatile uint16_t *rawbuf; // Raw intervals in .5 us ticks
@@ -46,6 +61,7 @@ class decode_results {
 #define JVC 8
 #define SANYO 9
 #define MITSUBISHI 10
+#define MAGIQUEST 11
 #define UNKNOWN -1
 
 // Decoded value for NEC when a repeat code is received
@@ -71,6 +87,7 @@ class IRrecv
  int32_t decodeRC6(decode_results *results);
  int32_t decodePanasonic(decode_results *results);
  int32_t decodeJVC(decode_results *results);
+ int32_t decodeMagiQuest(decode_results *results);
  int32_t decodeHash(decode_results *results);
  int16_t compare(uint16_t oldval, uint16_t newval);
 
@@ -100,6 +117,7 @@ class IRsend
  void sendSharp(int32_t data, int16_t nbits);
  void sendPanasonic(uint16_t address, int32_t data);
  void sendJVC(int32_t data, int16_t nbits, int16_t repeat); // *Note instead of sending the REPEAT constant if you want the JVC repeat signal sent, send the original code value and change the repeat argument from 0 to 1. JVC protocol repeats by skipping the header NOT by sending a separate code value like NEC does.
+ void sendMagiQuest(uint32_t wand_id, uint16_t magitude);
  // private:
  void enableIROut(int16_t khz);
  VIRTUAL void mark(int16_t usec);
@@ -110,7 +128,7 @@ class IRsend
 // Some useful constants
 
 #define USECPERTICK 50 // microseconds per clock interrupt tick
-#define RAWBUF 100 // Length of raw duration buffer
+#define RAWBUF 112 // Length of raw duration buffer
 
 // Marks tend to be 100us too long, and spaces 100us too short
 // when received due to sensor lag.

IRremoteInt.h

@@ -162,6 +162,11 @@
 #define SHARP_BITS 15
 #define DISH_BITS 16
 
+#define MAGIQUEST_PERIOD 1150
+#define MAGIQUEST_MARK_ZERO 280
+#define MAGIQUEST_SPACE_ZERO 850
+#define MAGIQUEST_MARK_ONE 580
+#define MAGIQUEST_SPACE_ONE 600
 #define TOLERANCE 25 // percent tolerance in measurements
 #define LTOL (1.0 - TOLERANCE/100.) 
 #define UTOL (1.0 + TOLERANCE/100.) 
@@ -213,7 +218,7 @@ extern volatile irparams_t irparams;
 #define MIN_RC6_SAMPLES 1
 #define PANASONIC_BITS 48
 #define JVC_BITS 16
-
+#define MAGIQUEST_BITS 56
 
 
 

examples/IRrecord/IRrecord.ino

@@ -86,6 +86,9 @@ void storeCode(decode_results *results) {
  else if (codeType == RC6) {
  Serial.print("Received RC6: ");
  } 
+ else if (codeType == MAGIQUEST) {
+ Serial.print("Received MAGIQUEST: ");
+ } 
  else {
  Serial.print("Unexpected codeType ");
  Serial.print(codeType, DEC);
@@ -133,6 +136,11 @@ void sendCode(int repeat) {
  Serial.println(codeValue, HEX);
  }
  } 
+ else if (codeType == MAGIQUEST) {
+ irsend.sendSony(codeValue, codeLen);
+ Serial.print("Sent MAGIQUEST ");
+ Serial.println(codeValue, HEX);
+ } 
  else if (codeType == UNKNOWN /* i.e. raw */) {
  // Assume 38 KHz
  irsend.sendRaw(rawCodes, codeLen, 38);

examples/IRrecvDump/IRrecvDump.ino

@@ -37,6 +37,11 @@ void dump(decode_results *results) {
  else if (results->decode_type == SONY) {
  Serial.print("Decoded SONY: ");
  } 
+ else if (results->decode_type == MAGIQUEST) {
+ Serial.print("Decoded MAGIQUEST - Magnitude=");
+ Serial.print(results->magiquestMagnitude, HEX);
+ Serial.print(", wand_id=");
+ }
  else if (results->decode_type == RC5) {
  Serial.print("Decoded RC5: ");
  } 

examples/IRrelay/IRrelay.ino

@@ -37,6 +37,9 @@ void dump(decode_results *results) {
  else if (results->decode_type == RC6) {
  Serial.print("Decoded RC6: ");
  }
+ else if (results->decode_type == MAGIQUEST) {
+ Serial.print("Decoded MAGIQUEST: ");
+ }
  Serial.print(results->value, HEX);
  Serial.print(" (");
  Serial.print(results->bits, DEC);

examples/IRtest2/IRtest2.ino

@@ -95,6 +95,9 @@ void dump(decode_results *results) {
  else if (results->decode_type == RC6) {
  Serial.print("Decoded RC6: ");
  }
+ else if (results->decode_type == MAGIQUEST) {
+ Serial.print("Decoded MAGIQUEST: ");
+ }
  Serial.print(results->value, HEX);
  Serial.print(" (");
  Serial.print(results->bits, DEC);
@@ -140,6 +143,9 @@ void test(char *label, int type, unsigned long value, int bits) {
  else if (type == RC6) {
  irsend.sendRC6(value, bits);
  } 
+ else if (type == MAGIQUEST) {
+ irsend.sendMagiQuest(value, bits);
+ } 
  else {
  Serial.print(label);
  Serial.println("Bad type!");
@@ -273,6 +279,7 @@ void loop() {
  test("RC61", RC6, 0x12345678, 32);
  test("RC62", RC6, 0x0, 32);
  test("RC63", RC6, 0xffffffff, 32);
+ test("MAGIQUEST", MAGIQUEST, 0x12345678, 56);
 
  // Tests of raw sending and receiving.
  // First test sending raw and receiving raw.

keywords.txt

@@ -30,6 +30,7 @@ sendDISH KEYWORD2
 sendSharp KEYWORD2
 sendPanasonic KEYWORD2
 sendJVC KEYWORD2
+sendMagiQuest KEYWORD2
 
 #
 #######################################
@@ -46,5 +47,6 @@ DISH LITERAL1
 SHARP LITERAL1
 PANASONIC LITERAL1
 JVC LITERAL1
+MAGIQUEST	LITERAL1
 UNKNOWN	LITERAL1
 REPEAT	LITERAL1