mirror of
https://github.com/meshtastic/python.git
synced 2025-12-27 01:47:50 -05:00
464 lines
20 KiB
HTML
464 lines
20 KiB
HTML
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
|
|
<meta name="generator" content="pdoc 0.9.1" />
|
|
<title>meshtastic.test API documentation</title>
|
|
<meta name="description" content="" />
|
|
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
|
|
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
|
|
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
|
|
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
|
|
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
|
|
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
|
|
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
|
|
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
|
|
</head>
|
|
<body>
|
|
<main>
|
|
<article id="content">
|
|
<header>
|
|
<h1 class="title">Module <code>meshtastic.test</code></h1>
|
|
</header>
|
|
<section id="section-intro">
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">import logging
|
|
from . import util
|
|
from . import SerialInterface, BROADCAST_NUM
|
|
from pubsub import pub
|
|
import time
|
|
import sys
|
|
import threading
|
|
from dotmap import DotMap
|
|
|
|
"""The interfaces we are using for our tests"""
|
|
interfaces = None
|
|
|
|
"""A list of all packets we received while the current test was running"""
|
|
receivedPackets = None
|
|
|
|
testsRunning = False
|
|
|
|
testNumber = 0
|
|
|
|
sendingInterface = None
|
|
|
|
|
|
def onReceive(packet, interface):
|
|
"""Callback invoked when a packet arrives"""
|
|
if sendingInterface == interface:
|
|
pass
|
|
# print("Ignoring sending interface")
|
|
else:
|
|
# print(f"From {interface.stream.port}: {packet}")
|
|
p = DotMap(packet)
|
|
|
|
if p.decoded.portnum == "TEXT_MESSAGE_APP":
|
|
# We only care a about clear text packets
|
|
receivedPackets.append(p)
|
|
|
|
|
|
def onNode(node):
|
|
"""Callback invoked when the node DB changes"""
|
|
print(f"Node changed: {node}")
|
|
|
|
|
|
def subscribe():
|
|
"""Subscribe to the topics the user probably wants to see, prints output to stdout"""
|
|
|
|
pub.subscribe(onNode, "meshtastic.node")
|
|
|
|
|
|
def testSend(fromInterface, toInterface, isBroadcast=False, asBinary=False, wantAck=False):
|
|
"""
|
|
Sends one test packet between two nodes and then returns success or failure
|
|
|
|
Arguments:
|
|
fromInterface {[type]} -- [description]
|
|
toInterface {[type]} -- [description]
|
|
|
|
Returns:
|
|
boolean -- True for success
|
|
"""
|
|
global receivedPackets
|
|
receivedPackets = []
|
|
fromNode = fromInterface.myInfo.my_node_num
|
|
|
|
if isBroadcast:
|
|
toNode = BROADCAST_NUM
|
|
else:
|
|
toNode = toInterface.myInfo.my_node_num
|
|
|
|
logging.debug(f"Sending test wantAck={wantAck} packet from {fromNode} to {toNode}")
|
|
global sendingInterface
|
|
sendingInterface = fromInterface
|
|
if not asBinary:
|
|
fromInterface.sendText(f"Test {testNumber}", toNode, wantAck=wantAck)
|
|
else:
|
|
fromInterface.sendData((f"Binary {testNumber}").encode(
|
|
"utf-8"), toNode, wantAck=wantAck)
|
|
for sec in range(60): # max of 60 secs before we timeout
|
|
time.sleep(1)
|
|
if (len(receivedPackets) >= 1):
|
|
return True
|
|
return False # Failed to send
|
|
|
|
|
|
def runTests(numTests=50, wantAck=False, maxFailures=0):
|
|
logging.info(f"Running {numTests} tests with wantAck={wantAck}")
|
|
numFail = 0
|
|
numSuccess = 0
|
|
for i in range(numTests):
|
|
global testNumber
|
|
testNumber = testNumber + 1
|
|
isBroadcast = True
|
|
# asBinary=(i % 2 == 0)
|
|
success = testSend(
|
|
interfaces[0], interfaces[1], isBroadcast, asBinary=False, wantAck=wantAck)
|
|
if not success:
|
|
numFail = numFail + 1
|
|
logging.error(
|
|
f"Test failed, expected packet not received ({numFail} failures so far)")
|
|
else:
|
|
numSuccess = numSuccess + 1
|
|
logging.info(
|
|
f"Test succeeded {numSuccess} successes {numFail} failures so far")
|
|
|
|
#if numFail >= 3:
|
|
# for i in interfaces:
|
|
# i.close()
|
|
# return
|
|
|
|
time.sleep(1)
|
|
|
|
if numFail > maxFailures:
|
|
logging.error("Too many failures! Test failed!")
|
|
|
|
return numFail
|
|
|
|
def testThread(numTests=50):
|
|
logging.info("Found devices, starting tests...")
|
|
runTests(numTests, wantAck=True)
|
|
runTests(numTests, wantAck=False, maxFailures=5) # Allow a few dropped packets
|
|
|
|
|
|
def onConnection(topic=pub.AUTO_TOPIC):
|
|
"""Callback invoked when we connect/disconnect from a radio"""
|
|
print(f"Connection changed: {topic.getName()}")
|
|
|
|
|
|
def openDebugLog(portName):
|
|
debugname = "log" + portName.replace("/", "_")
|
|
logging.info(f"Writing serial debugging to {debugname}")
|
|
return open(debugname, 'w+', buffering=1)
|
|
|
|
|
|
def testAll():
|
|
"""
|
|
Run a series of tests using devices we can find.
|
|
|
|
Raises:
|
|
Exception: If not enough devices are found
|
|
"""
|
|
ports = util.findPorts()
|
|
if (len(ports) < 2):
|
|
raise Exception("Must have at least two devices connected to USB")
|
|
|
|
pub.subscribe(onConnection, "meshtastic.connection")
|
|
pub.subscribe(onReceive, "meshtastic.receive")
|
|
global interfaces
|
|
interfaces = list(map(lambda port: SerialInterface(
|
|
port, debugOut=openDebugLog(port), connectNow=True), ports))
|
|
|
|
logging.info("Ports opened, starting test")
|
|
testThread()
|
|
|
|
for i in interfaces:
|
|
i.close()</code></pre>
|
|
</details>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
<h2 class="section-title" id="header-variables">Global variables</h2>
|
|
<dl>
|
|
<dt id="meshtastic.test.interfaces"><code class="name">var <span class="ident">interfaces</span></code></dt>
|
|
<dd>
|
|
<div class="desc"><p>A list of all packets we received while the current test was running</p></div>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
<section>
|
|
<h2 class="section-title" id="header-functions">Functions</h2>
|
|
<dl>
|
|
<dt id="meshtastic.test.onConnection"><code class="name flex">
|
|
<span>def <span class="ident">onConnection</span></span>(<span>topic=pubsub.core.callables.AUTO_TOPIC)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<div class="desc"><p>Callback invoked when we connect/disconnect from a radio</p></div>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def onConnection(topic=pub.AUTO_TOPIC):
|
|
"""Callback invoked when we connect/disconnect from a radio"""
|
|
print(f"Connection changed: {topic.getName()}")</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="meshtastic.test.onNode"><code class="name flex">
|
|
<span>def <span class="ident">onNode</span></span>(<span>node)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<div class="desc"><p>Callback invoked when the node DB changes</p></div>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def onNode(node):
|
|
"""Callback invoked when the node DB changes"""
|
|
print(f"Node changed: {node}")</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="meshtastic.test.onReceive"><code class="name flex">
|
|
<span>def <span class="ident">onReceive</span></span>(<span>packet, interface)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<div class="desc"><p>Callback invoked when a packet arrives</p></div>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def onReceive(packet, interface):
|
|
"""Callback invoked when a packet arrives"""
|
|
if sendingInterface == interface:
|
|
pass
|
|
# print("Ignoring sending interface")
|
|
else:
|
|
# print(f"From {interface.stream.port}: {packet}")
|
|
p = DotMap(packet)
|
|
|
|
if p.decoded.portnum == "TEXT_MESSAGE_APP":
|
|
# We only care a about clear text packets
|
|
receivedPackets.append(p)</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="meshtastic.test.openDebugLog"><code class="name flex">
|
|
<span>def <span class="ident">openDebugLog</span></span>(<span>portName)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<div class="desc"></div>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def openDebugLog(portName):
|
|
debugname = "log" + portName.replace("/", "_")
|
|
logging.info(f"Writing serial debugging to {debugname}")
|
|
return open(debugname, 'w+', buffering=1)</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="meshtastic.test.runTests"><code class="name flex">
|
|
<span>def <span class="ident">runTests</span></span>(<span>numTests=50, wantAck=False, maxFailures=0)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<div class="desc"></div>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def runTests(numTests=50, wantAck=False, maxFailures=0):
|
|
logging.info(f"Running {numTests} tests with wantAck={wantAck}")
|
|
numFail = 0
|
|
numSuccess = 0
|
|
for i in range(numTests):
|
|
global testNumber
|
|
testNumber = testNumber + 1
|
|
isBroadcast = True
|
|
# asBinary=(i % 2 == 0)
|
|
success = testSend(
|
|
interfaces[0], interfaces[1], isBroadcast, asBinary=False, wantAck=wantAck)
|
|
if not success:
|
|
numFail = numFail + 1
|
|
logging.error(
|
|
f"Test failed, expected packet not received ({numFail} failures so far)")
|
|
else:
|
|
numSuccess = numSuccess + 1
|
|
logging.info(
|
|
f"Test succeeded {numSuccess} successes {numFail} failures so far")
|
|
|
|
#if numFail >= 3:
|
|
# for i in interfaces:
|
|
# i.close()
|
|
# return
|
|
|
|
time.sleep(1)
|
|
|
|
if numFail > maxFailures:
|
|
logging.error("Too many failures! Test failed!")
|
|
|
|
return numFail</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="meshtastic.test.subscribe"><code class="name flex">
|
|
<span>def <span class="ident">subscribe</span></span>(<span>)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<div class="desc"><p>Subscribe to the topics the user probably wants to see, prints output to stdout</p></div>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def subscribe():
|
|
"""Subscribe to the topics the user probably wants to see, prints output to stdout"""
|
|
|
|
pub.subscribe(onNode, "meshtastic.node")</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="meshtastic.test.testAll"><code class="name flex">
|
|
<span>def <span class="ident">testAll</span></span>(<span>)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<div class="desc"><p>Run a series of tests using devices we can find.</p>
|
|
<h2 id="raises">Raises</h2>
|
|
<dl>
|
|
<dt><code>Exception</code></dt>
|
|
<dd>If not enough devices are found</dd>
|
|
</dl></div>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def testAll():
|
|
"""
|
|
Run a series of tests using devices we can find.
|
|
|
|
Raises:
|
|
Exception: If not enough devices are found
|
|
"""
|
|
ports = util.findPorts()
|
|
if (len(ports) < 2):
|
|
raise Exception("Must have at least two devices connected to USB")
|
|
|
|
pub.subscribe(onConnection, "meshtastic.connection")
|
|
pub.subscribe(onReceive, "meshtastic.receive")
|
|
global interfaces
|
|
interfaces = list(map(lambda port: SerialInterface(
|
|
port, debugOut=openDebugLog(port), connectNow=True), ports))
|
|
|
|
logging.info("Ports opened, starting test")
|
|
testThread()
|
|
|
|
for i in interfaces:
|
|
i.close()</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="meshtastic.test.testSend"><code class="name flex">
|
|
<span>def <span class="ident">testSend</span></span>(<span>fromInterface, toInterface, isBroadcast=False, asBinary=False, wantAck=False)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<div class="desc"><p>Sends one test packet between two nodes and then returns success or failure</p>
|
|
<h2 id="arguments">Arguments</h2>
|
|
<p>fromInterface {[type]} – [description]
|
|
toInterface {[type]} – [description]</p>
|
|
<h2 id="returns">Returns</h2>
|
|
<p>boolean – True for success</p></div>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def testSend(fromInterface, toInterface, isBroadcast=False, asBinary=False, wantAck=False):
|
|
"""
|
|
Sends one test packet between two nodes and then returns success or failure
|
|
|
|
Arguments:
|
|
fromInterface {[type]} -- [description]
|
|
toInterface {[type]} -- [description]
|
|
|
|
Returns:
|
|
boolean -- True for success
|
|
"""
|
|
global receivedPackets
|
|
receivedPackets = []
|
|
fromNode = fromInterface.myInfo.my_node_num
|
|
|
|
if isBroadcast:
|
|
toNode = BROADCAST_NUM
|
|
else:
|
|
toNode = toInterface.myInfo.my_node_num
|
|
|
|
logging.debug(f"Sending test wantAck={wantAck} packet from {fromNode} to {toNode}")
|
|
global sendingInterface
|
|
sendingInterface = fromInterface
|
|
if not asBinary:
|
|
fromInterface.sendText(f"Test {testNumber}", toNode, wantAck=wantAck)
|
|
else:
|
|
fromInterface.sendData((f"Binary {testNumber}").encode(
|
|
"utf-8"), toNode, wantAck=wantAck)
|
|
for sec in range(60): # max of 60 secs before we timeout
|
|
time.sleep(1)
|
|
if (len(receivedPackets) >= 1):
|
|
return True
|
|
return False # Failed to send</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="meshtastic.test.testThread"><code class="name flex">
|
|
<span>def <span class="ident">testThread</span></span>(<span>numTests=50)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<div class="desc"></div>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def testThread(numTests=50):
|
|
logging.info("Found devices, starting tests...")
|
|
runTests(numTests, wantAck=True)
|
|
runTests(numTests, wantAck=False, maxFailures=5) # Allow a few dropped packets</code></pre>
|
|
</details>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
</article>
|
|
<nav id="sidebar">
|
|
<h1>Index</h1>
|
|
<div class="toc">
|
|
<ul></ul>
|
|
</div>
|
|
<ul id="index">
|
|
<li><h3>Super-module</h3>
|
|
<ul>
|
|
<li><code><a title="meshtastic" href="index.html">meshtastic</a></code></li>
|
|
</ul>
|
|
</li>
|
|
<li><h3><a href="#header-variables">Global variables</a></h3>
|
|
<ul class="">
|
|
<li><code><a title="meshtastic.test.interfaces" href="#meshtastic.test.interfaces">interfaces</a></code></li>
|
|
</ul>
|
|
</li>
|
|
<li><h3><a href="#header-functions">Functions</a></h3>
|
|
<ul class="two-column">
|
|
<li><code><a title="meshtastic.test.onConnection" href="#meshtastic.test.onConnection">onConnection</a></code></li>
|
|
<li><code><a title="meshtastic.test.onNode" href="#meshtastic.test.onNode">onNode</a></code></li>
|
|
<li><code><a title="meshtastic.test.onReceive" href="#meshtastic.test.onReceive">onReceive</a></code></li>
|
|
<li><code><a title="meshtastic.test.openDebugLog" href="#meshtastic.test.openDebugLog">openDebugLog</a></code></li>
|
|
<li><code><a title="meshtastic.test.runTests" href="#meshtastic.test.runTests">runTests</a></code></li>
|
|
<li><code><a title="meshtastic.test.subscribe" href="#meshtastic.test.subscribe">subscribe</a></code></li>
|
|
<li><code><a title="meshtastic.test.testAll" href="#meshtastic.test.testAll">testAll</a></code></li>
|
|
<li><code><a title="meshtastic.test.testSend" href="#meshtastic.test.testSend">testSend</a></code></li>
|
|
<li><code><a title="meshtastic.test.testThread" href="#meshtastic.test.testThread">testThread</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</main>
|
|
<footer id="footer">
|
|
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
|
|
</footer>
|
|
</body>
|
|
</html> |