First Extras-Testing Candidate Release
[pierogi] / protocols / mceprotocol.cpp
diff --git a/protocols/mceprotocol.cpp b/protocols/mceprotocol.cpp
new file mode 100644 (file)
index 0000000..9096c7e
--- /dev/null
@@ -0,0 +1,261 @@
+#include "mceprotocol.h"
+
+#include "pirrx51hardware.h"
+
+#include "pirexception.h"
+
+#include <QMutex>
+extern bool commandInFlight;
+extern QMutex commandIFMutex;
+
+// These defines might need to be turned into variables, for odd devices.
+#define HEADER_PULSE 2666
+#define HEADER_SPACE 888
+#define TRAILER_BIPHASE 888
+
+// Ok, what I've got on MCE protocol is this:
+// It is based on RC6 mode 6A, with a few odd tweaks.
+// The biphase unit of time is 444 usec.
+// The RC6 header block starts with the normal 2666 usec pulse, 888 usec space.
+// The next bit is fixed as a "1", as usual.
+// The next three bits are 110, marking this as a mode 6 protocol.
+// The trailer bit has an 888 usec biphase, is set to 0, and is _not_ toggled!
+// The next 16 bits I'm not sure about.  Hopefully they will be a fixed value
+// for any given device...
+// Then, the next bit is the new toggle bit.
+// Following this, there are seven "device address" bits, and then eight
+// "command" bits.
+// A space of (at least) 2666 usec must follow any command.
+// The carrier frequency is 36 kHZ, duty cycle between 25 and 50 %.
+
+MCEProtocol::MCEProtocol(
+  QObject *guiObject,
+  unsigned int index,
+  unsigned int oemData)
+  : PIRProtocol(guiObject, index, 2666, false),
+    biphaseUnit(444),
+    buffer(0),
+    keypressCount(0)
+{
+  setCarrierFrequency(36000);
+  appendToBitSeq(oemBits, oemData, 16);
+}
+
+
+void MCEProtocol::startSendingCommand(
+  unsigned int threadableID,
+  PIRKeyName command)
+{
+  try
+  {
+    // Is this command meant for us?
+    if (threadableID != id) return;
+
+    clearRepeatFlag();
+
+    KeycodeCollection::const_iterator i = keycodes.find(command);
+
+    // Sanity check:
+    if (i == keycodes.end())
+    {
+      std::string s = "Tried to send a non-existent command.\n";
+      throw PIRException(s);
+    }
+
+    PIRRX51Hardware rx51device(carrierFrequency, dutyCycle);
+
+    int repeatCount = 0;
+    int duration = 0;
+    while (repeatCount < MAX_REPEAT_COUNT)
+    {
+      bufferContainsSpace = false;
+      bufferContainsPulse = false;
+      // First, construct the "Header" segment of the pulse train.
+      //
+      // The header involves:
+      // a) a "lead" of 2666 us pulse, 888 us space;
+      // b) a "start bit", value 1 (so 444 us pulse, 444 us space)
+      // c) three control bits, set to "110" (i.e., mode "6")
+      // d) the double-sized "trailer" bit, set to 0.
+
+      rx51device.addSingle(HEADER_PULSE); // lead pulse
+      duration += HEADER_PULSE;
+      rx51device.addSingle(HEADER_SPACE); // lead space
+      duration += HEADER_SPACE;
+      rx51device.addSingle(biphaseUnit); // start bit pulse
+      duration += biphaseUnit;
+      rx51device.addSingle(biphaseUnit); // start bit space
+      duration += biphaseUnit;
+      rx51device.addSingle(biphaseUnit); // bit 1 pulse;
+      duration += biphaseUnit;
+      rx51device.addSingle(biphaseUnit); // bit 1 space;
+      duration += biphaseUnit;
+      rx51device.addSingle(biphaseUnit); // bit 2 pulse;
+      duration += biphaseUnit;
+      rx51device.addSingle(2 * biphaseUnit); // bit 2 space + bit 3 space;
+      duration += 2 * biphaseUnit;
+      rx51device.addSingle(biphaseUnit); // bit 3 pulse;
+      duration += biphaseUnit;
+      rx51device.addSingle(2 * biphaseUnit); // trailer space
+      duration += 2 * biphaseUnit;
+      buffer = 2 * biphaseUnit; // trailer pulse goes into the buffer
+      bufferContainsPulse = true;
+
+      // Now, we can start the normal buffering process:
+
+      // push the "OEM" data:
+      duration += pushBits(oemBits, rx51device);
+
+      // The next bit is the MCE toggle bit:
+      if (keypressCount % 2)
+      {
+        pushOne(rx51device);
+      }
+      else
+      {
+        pushZero(rx51device);
+      }
+
+      // push the device address data:
+      duration += pushBits(preData, rx51device);
+
+      // push the command data:
+      duration += pushBits((*i).second.firstCode, rx51device);
+
+      // Flush out the buffer, if necessary:
+      if (buffer)
+      {
+        rx51device.addSingle(buffer);
+        duration += buffer;
+        buffer = 0;
+      }
+
+      // Actually send out the command:
+      rx51device.sendCommandToDevice();
+
+      // Sleep for an amount of time.  (RC6 demands an addtional 6 unit space
+      // at the end of any command...)
+      sleepUntilRepeat(duration + 6 * biphaseUnit);
+
+      // Have we been told to stop yet?
+      if (checkRepeatFlag())
+      {
+        // Yes, we can now quit repeating:
+        ++keypressCount;
+        QMutexLocker ciflocker(&commandIFMutex);
+        commandInFlight = false;
+        return;
+      }
+    }
+  }
+  catch (PIRException e)
+  {
+    emit commandFailed(e.getError().c_str());
+  }
+
+  ++keypressCount;
+  QMutexLocker cifLocker(&commandIFMutex);
+  commandInFlight = false;
+}
+
+
+int MCEProtocol::pushBits(
+  const CommandSequence &bits,
+  PIRRX51Hardware &rx51device)
+{
+  int duration = 0;
+
+  CommandSequence::const_iterator i = bits.begin();
+
+  while (i != bits.end())
+  {
+    if (*i)
+    {
+      duration += pushOne(rx51device);
+    }
+    else
+    {
+      duration += pushZero(rx51device);
+    }
+
+    ++i;
+  }
+
+  return duration;
+}
+
+
+// This should be part of a general RC6 parent maybe?
+int MCEProtocol::pushZero(
+  PIRRX51Hardware &rx51device)
+{
+  // Need to add a space, then a pulse.
+  int duration = 0;
+
+  if (bufferContainsSpace)
+  {
+    // Merge this space and the previous one, and send to device:
+    rx51device.addSingle(buffer + biphaseUnit);
+    duration += (buffer + biphaseUnit);
+    buffer = 0;
+     bufferContainsSpace = false;
+  }
+  else
+  {
+    if (bufferContainsPulse)
+    {
+      // Flush out the buffer:
+      rx51device.addSingle(buffer);
+      duration += buffer;
+      buffer = 0;
+      bufferContainsPulse = false;
+    }
+
+    // push a space onto the device:
+    rx51device.addSingle(biphaseUnit);
+    duration += biphaseUnit;
+  }
+
+  // Put a pulse into the buffer to wait:
+  buffer = biphaseUnit;
+  bufferContainsPulse = true;
+
+  return duration;
+}
+
+
+int MCEProtocol::pushOne(
+  PIRRX51Hardware &rx51device)
+{
+  // Need to add a pulse, then a space.
+  int duration = 0;
+
+  // First, the pulse:
+  if (bufferContainsPulse)
+  {
+    rx51device.addSingle(buffer + biphaseUnit);
+    duration += (buffer + biphaseUnit);
+    buffer = 0;
+    bufferContainsPulse = false;
+  }
+  else
+  {
+    if (bufferContainsSpace)
+    {
+      // Flush the buffer:
+      rx51device.addSingle(buffer);
+      duration += buffer;
+      buffer = 0;
+      bufferContainsSpace = false;
+    }
+    // Now, add the pulse:
+    rx51device.addSingle(biphaseUnit);
+    duration += biphaseUnit;
+  }
+
+  // Next, push a space onto the buffer:
+  buffer = biphaseUnit;
+  bufferContainsSpace = true;
+
+  return duration;
+}