add paused, maxlen properties, getitem, and docstrings

[Adafruit_Blinka-hackapet.git] / src / adafruit_blinka / microcontroller / raspi_23 / pulseio / PulseIn.py

diff --git a/src/adafruit_blinka/microcontroller/raspi_23/pulseio/PulseIn.py b/src/adafruit_blinka/microcontroller/raspi_23/pulseio/PulseIn.py
index 2cda6471619939483ef83b9d26229b3f923bb7f0..dbe6152773e9f54c1120a6bfe203aba0f78ac6a6 100644 (file)
--- a/src/adafruit_blinka/microcontroller/raspi_23/pulseio/PulseIn.py
+++ b/src/adafruit_blinka/microcontroller/raspi_23/pulseio/PulseIn.py
@@ -14,6 +14,8 @@ procs = []
 
 # The message queues live outside of python space, and must be formally cleaned!
 def final():
+    """In case the program is cancelled or quit, we need to clean up the PulseIn
+    helper process and also the message queue, this is called at exit to do so"""
     if DEBUG:
         print("Cleaning up message queues", queues)
         print("Cleaning up processes", procs)
@@ -25,6 +27,11 @@ atexit.register(final)
 
 class PulseIn:
     def __init__(self, pin, maxlen=2, idle_state=False):
+        """Create a PulseIn object associated with the given pin.
+        The object acts as a read-only sequence of pulse lengths with
+        a given max length. When it is active, new pulse lengths are
+        added to the end of the list. When there is no more room
+        (len() == maxlen) the oldest pulse length is removed to make room."""
         self._pin = pin
         self._maxlen = maxlen
         self._idle_state = idle_state
@@ -53,12 +60,27 @@ class PulseIn:
         # wait for it to start up
         if DEBUG:
             print("Waiting for startup success message from subprocess")
-        message = self._mq.receive(type=2)
+        message = self._wait_receive_msg()
         if message[0] != b'!':
             raise RuntimeError("Could not establish message queue with subprocess")
+        self._paused = False
 
+    def _wait_receive_msg(self, timeout=0.25, type=2):
+        """Internal helper that will wait for new messages of a given type,
+        and throw an exception on timeout"""
+        stamp = time.monotonic()
+        while (time.monotonic() - stamp) < timeout:
+            try:
+                message = self._mq.receive(block=False, type=2)
+                return message
+            except sysv_ipc.BusyError:
+                time.sleep(0.001) # wait a bit then retry!
+        # uh-oh timed out
+        raise RuntimeError("Timed out waiting for PulseIn message")
 
     def deinit(self):
+        """Deinitialises the PulseIn and releases any hardware and software
+        resources for reuse."""
         # Clean up after ourselves
         self._process.terminate()
         procs.remove(self._process)
@@ -66,32 +88,63 @@ class PulseIn:
         queues.remove(self._mq)
 
     def __enter__(self):
+        """No-op used by Context Managers."""
         return self
 
     def __exit__(self, exc_type, exc_value, tb):
+        """Automatically deinitializes the hardware when exiting a context."""
         self.deinit()
 
     def resume(self, trigger_duration=0):
+        """Resumes pulse capture after an optional trigger pulse."""
         if trigger_duration != 0:
             self._mq.send("t%d" % trigger_duration, True, type=1)
         else:
             self._mq.send("r", True, type=1)
+        self._paused = False
 
     def pause(self):
+        """Pause pulse capture"""
         self._mq.send("p", True, type=1)
+        self._paused = True
+
+    @property
+    def paused(self):
+        """True when pulse capture is paused as a result of pause() or
+        an error during capture such as a signal that is too fast."""
+        return self._paused
+
+    @property
+    def maxlen(self):
+        """The maximum length of the PulseIn. When len() is equal to maxlen,
+        it is unclear which pulses are active and which are idle."""
+        return self._maxlen
 
     def clear(self):
+        """Clears all captured pulses"""
         self._mq.send("c", True, type=1)
 
     def popleft(self):
+        """Removes and returns the oldest read pulse."""
         self._mq.send("^", True, type=1)
-        message = self._mq.receive(type=2)
+        message = self._wait_receive_msg()
         reply = int(message[0].decode('utf-8'))
+        #print(reply)
         if reply == -1:
-            reply = None
+            raise IndexError("pop from empty list")
         return reply
 
     def __len__(self):
+        """Returns the current pulse length"""
         self._mq.send("l", True, type=1)
-        message = self._mq.receive(type=2)
+        message = self._wait_receive_msg()
         return int(message[0].decode('utf-8'))
+
+    def __getitem__(self, index, type=None):
+        """Returns the value at the given index or values in slice."""
+        self._mq.send("i%d" % index, True, type=1)
+        message = self._wait_receive_msg()
+        ret = int(message[0].decode('utf-8'))
+        if ret == -1:
+            raise IndexError("list index out of range")
+        return ret