1.2.23

docs/meshtastic/util.html

@@ -30,9 +30,7 @@
 import serial
 import serial.tools.list_ports
 from queue import Queue
-import threading
-import sys
-import logging
+import threading, sys, time, logging
 
 """Some devices such as a seger jlink we never want to accidentally open"""
 blacklistVids = dict.fromkeys([0x1366])
@@ -76,6 +74,26 @@ class dotdict(dict):
     __delattr__ = dict.__delitem__
 
 
+class Timeout:
+    def __init__(self, maxSecs=20):
+        self.expireTime = 0
+        self.sleepInterval = 0.1
+        self.expireTimeout = maxSecs
+
+    def reset(self):
+        """Restart the waitForSet timer"""
+        self.expireTime = time.time() + self.expireTimeout
+
+    def waitForSet(self, target, attrs=()):
+        """Block until the specified attributes are set. Returns True if config has been received."""
+        self.reset()
+        while time.time() < self.expireTime:
+            if all(map(lambda a: getattr(target, a, None), attrs)):
+                return True
+            time.sleep(self.sleepInterval)
+        return False
+
+
 class DeferredExecution():
     """A thread that accepts closures to run, and runs them as they are received"""
 
@@ -227,6 +245,72 @@ class DeferredExecution():
 </dd>
 </dl>
 </dd>
+<dt id="meshtastic.util.Timeout"><code class="flex name class">
+<span>class <span class="ident">Timeout</span></span>
+<span>(</span><span>maxSecs=20)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">class Timeout:
+    def __init__(self, maxSecs=20):
+        self.expireTime = 0
+        self.sleepInterval = 0.1
+        self.expireTimeout = maxSecs
+
+    def reset(self):
+        &#34;&#34;&#34;Restart the waitForSet timer&#34;&#34;&#34;
+        self.expireTime = time.time() + self.expireTimeout
+
+    def waitForSet(self, target, attrs=()):
+        &#34;&#34;&#34;Block until the specified attributes are set. Returns True if config has been received.&#34;&#34;&#34;
+        self.reset()
+        while time.time() &lt; self.expireTime:
+            if all(map(lambda a: getattr(target, a, None), attrs)):
+                return True
+            time.sleep(self.sleepInterval)
+        return False</code></pre>
+</details>
+<h3>Methods</h3>
+<dl>
+<dt id="meshtastic.util.Timeout.reset"><code class="name flex">
+<span>def <span class="ident">reset</span></span>(<span>self)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Restart the waitForSet timer</p></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def reset(self):
+    &#34;&#34;&#34;Restart the waitForSet timer&#34;&#34;&#34;
+    self.expireTime = time.time() + self.expireTimeout</code></pre>
+</details>
+</dd>
+<dt id="meshtastic.util.Timeout.waitForSet"><code class="name flex">
+<span>def <span class="ident">waitForSet</span></span>(<span>self, target, attrs=())</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Block until the specified attributes are set. Returns True if config has been received.</p></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def waitForSet(self, target, attrs=()):
+    &#34;&#34;&#34;Block until the specified attributes are set. Returns True if config has been received.&#34;&#34;&#34;
+    self.reset()
+    while time.time() &lt; self.expireTime:
+        if all(map(lambda a: getattr(target, a, None), attrs)):
+            return True
+        time.sleep(self.sleepInterval)
+    return False</code></pre>
+</details>
+</dd>
+</dl>
+</dd>
 <dt id="meshtastic.util.dotdict"><code class="flex name class">
 <span>class <span class="ident">dotdict</span></span>
 <span>(</span><span>*args, **kwargs)</span>
@@ -279,6 +363,13 @@ class DeferredExecution():
 </ul>
 </li>
 <li>
+<h4><code><a title="meshtastic.util.Timeout" href="#meshtastic.util.Timeout">Timeout</a></code></h4>
+<ul class="">
+<li><code><a title="meshtastic.util.Timeout.reset" href="#meshtastic.util.Timeout.reset">reset</a></code></li>
+<li><code><a title="meshtastic.util.Timeout.waitForSet" href="#meshtastic.util.Timeout.waitForSet">waitForSet</a></code></li>
+</ul>
+</li>
+<li>
 <h4><code><a title="meshtastic.util.dotdict" href="#meshtastic.util.dotdict">dotdict</a></code></h4>
 </li>
 </ul>