Added Hildon Banners, bugfixes, new keysets
[pierogi] / protocols / dishprotocol.cpp
diff --git a/protocols/dishprotocol.cpp b/protocols/dishprotocol.cpp
new file mode 100644 (file)
index 0000000..6f74e07
--- /dev/null
@@ -0,0 +1,140 @@
+#include "dishprotocol.h"
+
+#include "pirrx51hardware.h"
+
+#include "pirexception.h"
+
+// Some global communications stuff:
+#include <QMutex>
+extern bool commandInFlight;
+extern QMutex commandIFMutex;
+
+// Dish Network, or now just "Dish", has a unique protocol.  It uses "space"
+// encoding, but otherwise is unlike just about anything else out there.
+// Here's what I've got on it:
+// A "zero" is encoded with a 400 usec pulse, 2800 usec space.
+// A "one" is encoded with a 400 usec pulse, 1600 usec space.
+// The header is a 400 usec pulse, 6000 usec space.
+// Commands end with a trailing 400 usec pulse.
+// Commands are repeated without the header (or, if you like, you can consider
+// the trailing pulse to be the header for the next repetition).
+// There is a 6000 usec gap between repetitions.
+// The carrier frequency is apparently 57600 kHz, or thereabouts.
+// The duty cycle is 1/3.
+
+DishProtocol::DishProtocol(
+  QObject *guiObject,
+  unsigned int index)
+  : SpaceProtocol(
+      guiObject, index,
+      400, 2800,
+      400, 1600,
+      400, 6000,
+      400,
+      6000, false)
+{
+  setCarrierFrequency(57600);
+  setDutyCycle(33);
+}
+
+
+void DishProtocol::startSendingCommand(
+  unsigned int threadableID,
+  PIRKeyName command)
+{
+  // Exceptions here are problematic; I'll try to weed them out by putting the
+  // whole thing in a try/catch block:
+  try
+  {
+    // First, check if we are meant to be the recipient of this command:
+    if (threadableID != id) return;
+
+    clearRepeatFlag();
+
+    KeycodeCollection::const_iterator i = keycodes.find(command);
+
+    // Do we even have this key defined?
+    if (i == keycodes.end())
+    {
+      std::string s = "Tried to send a non-existent command.\n";
+      throw PIRException(s);
+    }
+
+    // construct the device:
+    PIRRX51Hardware rx51device(carrierFrequency, dutyCycle);
+
+    int repeatCount = 0;
+    int commandDuration = 0;
+    while (repeatCount < MAX_REPEAT_COUNT)
+    {
+      // If this is not a repetition, we need to add the initial header:
+      if (repeatCount == 0)
+      {
+        rx51device.addPair(headerPulse, headerSpace);
+        commandDuration += (headerPulse + headerSpace);
+      }
+
+      // generate the rest of the command:
+      commandDuration += generateStandardCommand(i->second, rx51device);
+
+      // Now, tell the device to send the whole command:
+      rx51device.sendCommandToDevice();
+
+      // sleep until the next repetition of command:
+      sleepUntilRepeat(commandDuration);
+
+      // Check whether we've reached the minimum required number of repetitons:
+      if (repeatCount >= minimumRepetitions)
+      {
+        // Check whether we've been asked to stop:
+        if (checkRepeatFlag())
+        {
+          QMutexLocker cifLocker(&commandIFMutex);
+          commandInFlight = false;
+          return;
+        }
+      }
+
+      ++repeatCount;
+    }
+  }
+  catch (PIRException e)
+  {
+    // inform the gui:
+    emit commandFailed(e.getError().c_str());
+  }
+
+  QMutexLocker cifLocker(&commandIFMutex);
+  commandInFlight = false;
+}
+
+
+int DishProtocol::generateStandardCommand(
+  const PIRKeyBits &pkb,
+  PIRRX51Hardware &rx51device)
+{
+  int duration = 0;
+
+  // In the Dish protocol, the pulse train consists of 6 bits of command
+  // data followed by 10 bits of, uhm, other stuff.  I know that at least the
+  // first four bits of these ten can be used for pairing purposes.  It looks
+  // like the last five bits can be used as additional command data.  For
+  // now, I'm going to split this into 5 "address" and 5 "more command" bits.
+  //
+  // The command data is sent MSB-first (I know that at least the first
+  // 6 bits are, I'll represent the last 5 that way as well).
+  // The pairing data is sent LSB-first, god knows why.
+  // - "firstCode" should contain 6-bit value
+  // - "preData" should contain 5 bits of pairing data
+  // - "secondCode" should contain the last 5 bits.
+  duration += pushBits(pkb.firstCode, rx51device);
+  duration += pushReverseBits(postData, rx51device);
+  duration += pushBits(pkb.secondCode, rx51device);
+
+  // Finally add the "trail":
+  rx51device.addSingle(trailerPulse);
+  duration += trailerPulse;
+
+  return duration;
+}
+