src/adafruit_blinka/microcontroller/bcm283x/pulseio/PulseIn.py

   1 """Custom PulseIn Class to read PWM signals"""
   2 import time
   3 import subprocess
   4 import os
   5 import atexit
   6 import random
   7 import sysv_ipc
   8
   9 DEBUG = False
  10 queues = []
  11 procs = []
  12
  13 # The message queues live outside of python space, and must be formally cleaned!
  14 def final():
  15     """In case the program is cancelled or quit, we need to clean up the PulseIn
  16     helper process and also the message queue, this is called at exit to do so"""
  17     if DEBUG:
  18         print("Cleaning up message queues", queues)
  19         print("Cleaning up processes", procs)
  20     for q in queues:
  21         q.remove()
  22     for proc in procs:
  23         proc.terminate()
  24
  25
  26 atexit.register(final)
  27
  28 # pylint: disable=c-extension-no-member
  29 class PulseIn:
  30     """PulseIn Class to read PWM signals"""
  31
  32     def __init__(self, pin, maxlen=2, idle_state=False):
  33         """Create a PulseIn object associated with the given pin.
  34         The object acts as a read-only sequence of pulse lengths with
  35         a given max length. When it is active, new pulse lengths are
  36         added to the end of the list. When there is no more room
  37         (len() == maxlen) the oldest pulse length is removed to make room."""
  38         self._pin = pin
  39         self._maxlen = maxlen
  40         self._idle_state = idle_state
  41         self._queue_key = random.randint(1, 9999)
  42         try:
  43             self._mq = sysv_ipc.MessageQueue(None, flags=sysv_ipc.IPC_CREX)
  44             if DEBUG:
  45                 print("Message Queue Key: ", self._mq.key)
  46             queues.append(self._mq)
  47         except sysv_ipc.ExistentialError:
  48             raise RuntimeError("Message queue creation failed")
  49
  50         dir_path = os.path.dirname(os.path.realpath(__file__))
  51         cmd = [
  52             dir_path + "/libgpiod_pulsein",
  53             "--pulses",
  54             str(maxlen),
  55             "--queue",
  56             str(self._mq.key),
  57         ]
  58         if idle_state:
  59             cmd.append("-i")
  60         cmd.append("gpiochip0")
  61         cmd.append(str(pin))
  62         if DEBUG:
  63             print(cmd)
  64
  65         self._process = subprocess.Popen(cmd)
  66         procs.append(self._process)
  67
  68         # wait for it to start up
  69         if DEBUG:
  70             print("Waiting for startup success message from subprocess")
  71         message = self._wait_receive_msg()
  72         if message[0] != b"!":
  73             raise RuntimeError("Could not establish message queue with subprocess")
  74         self._paused = False
  75
  76     # pylint: disable=redefined-builtin
  77     def _wait_receive_msg(self, timeout=0.25, type=2):
  78         """Internal helper that will wait for new messages of a given type,
  79         and throw an exception on timeout"""
  80         stamp = time.monotonic()
  81         while (time.monotonic() - stamp) < timeout:
  82             try:
  83                 message = self._mq.receive(block=False, type=type)
  84                 return message
  85             except sysv_ipc.BusyError:
  86                 time.sleep(0.001)  # wait a bit then retry!
  87         # uh-oh timed out
  88         raise RuntimeError("Timed out waiting for PulseIn message")
  89
  90     # pylint: enable=redefined-builtin
  91
  92     def deinit(self):
  93         """Deinitialises the PulseIn and releases any hardware and software
  94         resources for reuse."""
  95         # Clean up after ourselves
  96         self._process.terminate()
  97         procs.remove(self._process)
  98         self._mq.remove()
  99         queues.remove(self._mq)
 100
 101     def __enter__(self):
 102         """No-op used by Context Managers."""
 103         return self
 104
 105     def __exit__(self, exc_type, exc_value, tb):
 106         """Automatically deinitializes the hardware when exiting a context."""
 107         self.deinit()
 108
 109     def resume(self, trigger_duration=0):
 110         """Resumes pulse capture after an optional trigger pulse."""
 111         if trigger_duration != 0:
 112             self._mq.send("t%d" % trigger_duration, True, type=1)
 113         else:
 114             self._mq.send("r", True, type=1)
 115         self._paused = False
 116
 117     def pause(self):
 118         """Pause pulse capture"""
 119         self._mq.send("p", True, type=1)
 120         self._paused = True
 121
 122     @property
 123     def paused(self):
 124         """True when pulse capture is paused as a result of pause() or
 125         an error during capture such as a signal that is too fast."""
 126         return self._paused
 127
 128     @property
 129     def maxlen(self):
 130         """The maximum length of the PulseIn. When len() is equal to maxlen,
 131         it is unclear which pulses are active and which are idle."""
 132         return self._maxlen
 133
 134     def clear(self):
 135         """Clears all captured pulses"""
 136         self._mq.send("c", True, type=1)
 137
 138     def popleft(self):
 139         """Removes and returns the oldest read pulse."""
 140         self._mq.send("^", True, type=1)
 141         message = self._wait_receive_msg()
 142         reply = int(message[0].decode("utf-8"))
 143         # print(reply)
 144         if reply == -1:
 145             raise IndexError("pop from empty list")
 146         return reply
 147
 148     def __len__(self):
 149         """Returns the current pulse length"""
 150         self._mq.send("l", True, type=1)
 151         message = self._wait_receive_msg()
 152         return int(message[0].decode("utf-8"))
 153
 154     # pylint: disable=redefined-builtin
 155     def __getitem__(self, index, type=None):
 156         """Returns the value at the given index or values in slice."""
 157         self._mq.send("i%d" % index, True, type=1)
 158         message = self._wait_receive_msg()
 159         ret = int(message[0].decode("utf-8"))
 160         if ret == -1:
 161             raise IndexError("list index out of range")
 162         return ret
 163
 164     # pylint: enable=redefined-builtin