mirror of
https://github.com/meshtastic/python.git
synced 2025-12-27 01:47:50 -05:00
519 lines
27 KiB
HTML
519 lines
27 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.10.0" />
|
|
<title>meshtastic.stream_interface API documentation</title>
|
|
<meta name="description" content="Stream Interface base class" />
|
|
<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.stream_interface</code></h1>
|
|
</header>
|
|
<section id="section-intro">
|
|
<p>Stream Interface base class</p>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">"""Stream Interface base class
|
|
"""
|
|
import logging
|
|
import threading
|
|
import time
|
|
import traceback
|
|
import serial
|
|
|
|
|
|
from .mesh_interface import MeshInterface
|
|
from .util import stripnl
|
|
|
|
|
|
START1 = 0x94
|
|
START2 = 0xc3
|
|
HEADER_LEN = 4
|
|
MAX_TO_FROM_RADIO_SIZE = 512
|
|
|
|
|
|
class StreamInterface(MeshInterface):
|
|
"""Interface class for meshtastic devices over a stream link (serial, TCP, etc)"""
|
|
|
|
def __init__(self, debugOut=None, noProto=False, connectNow=True):
|
|
"""Constructor, opens a connection to self.stream
|
|
|
|
Keyword Arguments:
|
|
debugOut {stream} -- If a stream is provided, any debug serial output from the
|
|
device will be emitted to that stream. (default: {None})
|
|
|
|
Raises:
|
|
Exception: [description]
|
|
Exception: [description]
|
|
"""
|
|
|
|
if not hasattr(self, 'stream') and not noProto:
|
|
raise Exception(
|
|
"StreamInterface is now abstract (to update existing code create SerialInterface instead)")
|
|
self._rxBuf = bytes() # empty
|
|
self._wantExit = False
|
|
|
|
# FIXME, figure out why daemon=True causes reader thread to exit too early
|
|
self._rxThread = threading.Thread(target=self.__reader, args=(), daemon=True)
|
|
|
|
MeshInterface.__init__(self, debugOut=debugOut, noProto=noProto)
|
|
|
|
# Start the reader thread after superclass constructor completes init
|
|
if connectNow:
|
|
self.connect()
|
|
if not noProto:
|
|
self.waitForConfig()
|
|
|
|
def connect(self):
|
|
"""Connect to our radio
|
|
|
|
Normally this is called automatically by the constructor, but if you
|
|
passed in connectNow=False you can manually start the reading thread later.
|
|
"""
|
|
|
|
# Send some bogus UART characters to force a sleeping device to wake, and
|
|
# if the reading statemachine was parsing a bad packet make sure
|
|
# we write enought start bytes to force it to resync (we don't use START1
|
|
# because we want to ensure it is looking for START1)
|
|
p = bytearray([START2] * 32)
|
|
self._writeBytes(p)
|
|
time.sleep(0.1) # wait 100ms to give device time to start running
|
|
|
|
self._rxThread.start()
|
|
|
|
self._startConfig()
|
|
|
|
if not self.noProto: # Wait for the db download if using the protocol
|
|
self._waitConnected()
|
|
|
|
def _disconnected(self):
|
|
"""We override the superclass implementation to close our port"""
|
|
MeshInterface._disconnected(self)
|
|
|
|
logging.debug("Closing our port")
|
|
# pylint: disable=E0203
|
|
if not self.stream is None:
|
|
# pylint: disable=E0203
|
|
self.stream.close()
|
|
# pylint: disable=W0201
|
|
self.stream = None
|
|
|
|
def _writeBytes(self, b):
|
|
"""Write an array of bytes to our stream and flush"""
|
|
if self.stream: # ignore writes when stream is closed
|
|
self.stream.write(b)
|
|
self.stream.flush()
|
|
|
|
def _readBytes(self, length):
|
|
"""Read an array of bytes from our stream"""
|
|
if self.stream:
|
|
return self.stream.read(length)
|
|
else:
|
|
return None
|
|
|
|
def _sendToRadioImpl(self, toRadio):
|
|
"""Send a ToRadio protobuf to the device"""
|
|
logging.debug(f"Sending: {stripnl(toRadio)}")
|
|
b = toRadio.SerializeToString()
|
|
bufLen = len(b)
|
|
# We convert into a string, because the TCP code doesn't work with byte arrays
|
|
header = bytes([START1, START2, (bufLen >> 8) & 0xff, bufLen & 0xff])
|
|
logging.debug(f'sending header:{header} b:{b}')
|
|
self._writeBytes(header + b)
|
|
|
|
def close(self):
|
|
"""Close a connection to the device"""
|
|
logging.debug("Closing stream")
|
|
MeshInterface.close(self)
|
|
# pyserial cancel_read doesn't seem to work, therefore we ask the
|
|
# reader thread to close things for us
|
|
self._wantExit = True
|
|
if self._rxThread != threading.current_thread():
|
|
self._rxThread.join() # wait for it to exit
|
|
|
|
def __reader(self):
|
|
"""The reader thread that reads bytes from our stream"""
|
|
logging.debug('in __reader()')
|
|
empty = bytes()
|
|
|
|
try:
|
|
while not self._wantExit:
|
|
logging.debug("reading character")
|
|
b = self._readBytes(1)
|
|
logging.debug("In reader loop")
|
|
#logging.debug(f"read returned {b}")
|
|
if len(b) > 0:
|
|
c = b[0]
|
|
#logging.debug(f'c:{c}')
|
|
ptr = len(self._rxBuf)
|
|
|
|
# Assume we want to append this byte, fixme use bytearray instead
|
|
self._rxBuf = self._rxBuf + b
|
|
|
|
if ptr == 0: # looking for START1
|
|
if c != START1:
|
|
self._rxBuf = empty # failed to find start
|
|
if self.debugOut is not None:
|
|
try:
|
|
self.debugOut.write(b.decode("utf-8"))
|
|
except:
|
|
self.debugOut.write('?')
|
|
|
|
elif ptr == 1: # looking for START2
|
|
if c != START2:
|
|
self._rxBuf = empty # failed to find start2
|
|
elif ptr >= HEADER_LEN - 1: # we've at least got a header
|
|
#logging.debug('at least we received a header')
|
|
# big endian length follows header
|
|
packetlen = (self._rxBuf[2] << 8) + self._rxBuf[3]
|
|
|
|
if ptr == HEADER_LEN - 1: # we _just_ finished reading the header, validate length
|
|
if packetlen > MAX_TO_FROM_RADIO_SIZE:
|
|
self._rxBuf = empty # length was out out bounds, restart
|
|
|
|
if len(self._rxBuf) != 0 and ptr + 1 >= packetlen + HEADER_LEN:
|
|
try:
|
|
self._handleFromRadio(self._rxBuf[HEADER_LEN:])
|
|
except Exception as ex:
|
|
logging.error(f"Error while handling message from radio {ex}")
|
|
traceback.print_exc()
|
|
self._rxBuf = empty
|
|
else:
|
|
# logging.debug(f"timeout")
|
|
pass
|
|
except serial.SerialException as ex:
|
|
if not self._wantExit: # We might intentionally get an exception during shutdown
|
|
logging.warning(f"Meshtastic serial port disconnected, disconnecting... {ex}")
|
|
except OSError as ex:
|
|
if not self._wantExit: # We might intentionally get an exception during shutdown
|
|
logging.error(f"Unexpected OSError, terminating meshtastic reader... {ex}")
|
|
except Exception as ex:
|
|
logging.error(f"Unexpected exception, terminating meshtastic reader... {ex}")
|
|
finally:
|
|
logging.debug("reader is exiting")
|
|
self._disconnected()</code></pre>
|
|
</details>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
<h2 class="section-title" id="header-classes">Classes</h2>
|
|
<dl>
|
|
<dt id="meshtastic.stream_interface.StreamInterface"><code class="flex name class">
|
|
<span>class <span class="ident">StreamInterface</span></span>
|
|
<span>(</span><span>debugOut=None, noProto=False, connectNow=True)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<div class="desc"><p>Interface class for meshtastic devices over a stream link (serial, TCP, etc)</p>
|
|
<p>Constructor, opens a connection to self.stream</p>
|
|
<p>Keyword Arguments:
|
|
debugOut {stream} – If a stream is provided, any debug serial output from the
|
|
device will be emitted to that stream. (default: {None})</p>
|
|
<h2 id="raises">Raises</h2>
|
|
<dl>
|
|
<dt><code>Exception</code></dt>
|
|
<dd>[description]</dd>
|
|
<dt><code>Exception</code></dt>
|
|
<dd>[description]</dd>
|
|
</dl></div>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">class StreamInterface(MeshInterface):
|
|
"""Interface class for meshtastic devices over a stream link (serial, TCP, etc)"""
|
|
|
|
def __init__(self, debugOut=None, noProto=False, connectNow=True):
|
|
"""Constructor, opens a connection to self.stream
|
|
|
|
Keyword Arguments:
|
|
debugOut {stream} -- If a stream is provided, any debug serial output from the
|
|
device will be emitted to that stream. (default: {None})
|
|
|
|
Raises:
|
|
Exception: [description]
|
|
Exception: [description]
|
|
"""
|
|
|
|
if not hasattr(self, 'stream') and not noProto:
|
|
raise Exception(
|
|
"StreamInterface is now abstract (to update existing code create SerialInterface instead)")
|
|
self._rxBuf = bytes() # empty
|
|
self._wantExit = False
|
|
|
|
# FIXME, figure out why daemon=True causes reader thread to exit too early
|
|
self._rxThread = threading.Thread(target=self.__reader, args=(), daemon=True)
|
|
|
|
MeshInterface.__init__(self, debugOut=debugOut, noProto=noProto)
|
|
|
|
# Start the reader thread after superclass constructor completes init
|
|
if connectNow:
|
|
self.connect()
|
|
if not noProto:
|
|
self.waitForConfig()
|
|
|
|
def connect(self):
|
|
"""Connect to our radio
|
|
|
|
Normally this is called automatically by the constructor, but if you
|
|
passed in connectNow=False you can manually start the reading thread later.
|
|
"""
|
|
|
|
# Send some bogus UART characters to force a sleeping device to wake, and
|
|
# if the reading statemachine was parsing a bad packet make sure
|
|
# we write enought start bytes to force it to resync (we don't use START1
|
|
# because we want to ensure it is looking for START1)
|
|
p = bytearray([START2] * 32)
|
|
self._writeBytes(p)
|
|
time.sleep(0.1) # wait 100ms to give device time to start running
|
|
|
|
self._rxThread.start()
|
|
|
|
self._startConfig()
|
|
|
|
if not self.noProto: # Wait for the db download if using the protocol
|
|
self._waitConnected()
|
|
|
|
def _disconnected(self):
|
|
"""We override the superclass implementation to close our port"""
|
|
MeshInterface._disconnected(self)
|
|
|
|
logging.debug("Closing our port")
|
|
# pylint: disable=E0203
|
|
if not self.stream is None:
|
|
# pylint: disable=E0203
|
|
self.stream.close()
|
|
# pylint: disable=W0201
|
|
self.stream = None
|
|
|
|
def _writeBytes(self, b):
|
|
"""Write an array of bytes to our stream and flush"""
|
|
if self.stream: # ignore writes when stream is closed
|
|
self.stream.write(b)
|
|
self.stream.flush()
|
|
|
|
def _readBytes(self, length):
|
|
"""Read an array of bytes from our stream"""
|
|
if self.stream:
|
|
return self.stream.read(length)
|
|
else:
|
|
return None
|
|
|
|
def _sendToRadioImpl(self, toRadio):
|
|
"""Send a ToRadio protobuf to the device"""
|
|
logging.debug(f"Sending: {stripnl(toRadio)}")
|
|
b = toRadio.SerializeToString()
|
|
bufLen = len(b)
|
|
# We convert into a string, because the TCP code doesn't work with byte arrays
|
|
header = bytes([START1, START2, (bufLen >> 8) & 0xff, bufLen & 0xff])
|
|
logging.debug(f'sending header:{header} b:{b}')
|
|
self._writeBytes(header + b)
|
|
|
|
def close(self):
|
|
"""Close a connection to the device"""
|
|
logging.debug("Closing stream")
|
|
MeshInterface.close(self)
|
|
# pyserial cancel_read doesn't seem to work, therefore we ask the
|
|
# reader thread to close things for us
|
|
self._wantExit = True
|
|
if self._rxThread != threading.current_thread():
|
|
self._rxThread.join() # wait for it to exit
|
|
|
|
def __reader(self):
|
|
"""The reader thread that reads bytes from our stream"""
|
|
logging.debug('in __reader()')
|
|
empty = bytes()
|
|
|
|
try:
|
|
while not self._wantExit:
|
|
logging.debug("reading character")
|
|
b = self._readBytes(1)
|
|
logging.debug("In reader loop")
|
|
#logging.debug(f"read returned {b}")
|
|
if len(b) > 0:
|
|
c = b[0]
|
|
#logging.debug(f'c:{c}')
|
|
ptr = len(self._rxBuf)
|
|
|
|
# Assume we want to append this byte, fixme use bytearray instead
|
|
self._rxBuf = self._rxBuf + b
|
|
|
|
if ptr == 0: # looking for START1
|
|
if c != START1:
|
|
self._rxBuf = empty # failed to find start
|
|
if self.debugOut is not None:
|
|
try:
|
|
self.debugOut.write(b.decode("utf-8"))
|
|
except:
|
|
self.debugOut.write('?')
|
|
|
|
elif ptr == 1: # looking for START2
|
|
if c != START2:
|
|
self._rxBuf = empty # failed to find start2
|
|
elif ptr >= HEADER_LEN - 1: # we've at least got a header
|
|
#logging.debug('at least we received a header')
|
|
# big endian length follows header
|
|
packetlen = (self._rxBuf[2] << 8) + self._rxBuf[3]
|
|
|
|
if ptr == HEADER_LEN - 1: # we _just_ finished reading the header, validate length
|
|
if packetlen > MAX_TO_FROM_RADIO_SIZE:
|
|
self._rxBuf = empty # length was out out bounds, restart
|
|
|
|
if len(self._rxBuf) != 0 and ptr + 1 >= packetlen + HEADER_LEN:
|
|
try:
|
|
self._handleFromRadio(self._rxBuf[HEADER_LEN:])
|
|
except Exception as ex:
|
|
logging.error(f"Error while handling message from radio {ex}")
|
|
traceback.print_exc()
|
|
self._rxBuf = empty
|
|
else:
|
|
# logging.debug(f"timeout")
|
|
pass
|
|
except serial.SerialException as ex:
|
|
if not self._wantExit: # We might intentionally get an exception during shutdown
|
|
logging.warning(f"Meshtastic serial port disconnected, disconnecting... {ex}")
|
|
except OSError as ex:
|
|
if not self._wantExit: # We might intentionally get an exception during shutdown
|
|
logging.error(f"Unexpected OSError, terminating meshtastic reader... {ex}")
|
|
except Exception as ex:
|
|
logging.error(f"Unexpected exception, terminating meshtastic reader... {ex}")
|
|
finally:
|
|
logging.debug("reader is exiting")
|
|
self._disconnected()</code></pre>
|
|
</details>
|
|
<h3>Ancestors</h3>
|
|
<ul class="hlist">
|
|
<li><a title="meshtastic.mesh_interface.MeshInterface" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface">MeshInterface</a></li>
|
|
</ul>
|
|
<h3>Subclasses</h3>
|
|
<ul class="hlist">
|
|
<li><a title="meshtastic.serial_interface.SerialInterface" href="serial_interface.html#meshtastic.serial_interface.SerialInterface">SerialInterface</a></li>
|
|
<li><a title="meshtastic.tcp_interface.TCPInterface" href="tcp_interface.html#meshtastic.tcp_interface.TCPInterface">TCPInterface</a></li>
|
|
</ul>
|
|
<h3>Methods</h3>
|
|
<dl>
|
|
<dt id="meshtastic.stream_interface.StreamInterface.close"><code class="name flex">
|
|
<span>def <span class="ident">close</span></span>(<span>self)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<div class="desc"><p>Close a connection to the device</p></div>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def close(self):
|
|
"""Close a connection to the device"""
|
|
logging.debug("Closing stream")
|
|
MeshInterface.close(self)
|
|
# pyserial cancel_read doesn't seem to work, therefore we ask the
|
|
# reader thread to close things for us
|
|
self._wantExit = True
|
|
if self._rxThread != threading.current_thread():
|
|
self._rxThread.join() # wait for it to exit</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="meshtastic.stream_interface.StreamInterface.connect"><code class="name flex">
|
|
<span>def <span class="ident">connect</span></span>(<span>self)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<div class="desc"><p>Connect to our radio</p>
|
|
<p>Normally this is called automatically by the constructor, but if you
|
|
passed in connectNow=False you can manually start the reading thread later.</p></div>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def connect(self):
|
|
"""Connect to our radio
|
|
|
|
Normally this is called automatically by the constructor, but if you
|
|
passed in connectNow=False you can manually start the reading thread later.
|
|
"""
|
|
|
|
# Send some bogus UART characters to force a sleeping device to wake, and
|
|
# if the reading statemachine was parsing a bad packet make sure
|
|
# we write enought start bytes to force it to resync (we don't use START1
|
|
# because we want to ensure it is looking for START1)
|
|
p = bytearray([START2] * 32)
|
|
self._writeBytes(p)
|
|
time.sleep(0.1) # wait 100ms to give device time to start running
|
|
|
|
self._rxThread.start()
|
|
|
|
self._startConfig()
|
|
|
|
if not self.noProto: # Wait for the db download if using the protocol
|
|
self._waitConnected()</code></pre>
|
|
</details>
|
|
</dd>
|
|
</dl>
|
|
<h3>Inherited members</h3>
|
|
<ul class="hlist">
|
|
<li><code><b><a title="meshtastic.mesh_interface.MeshInterface" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface">MeshInterface</a></b></code>:
|
|
<ul class="hlist">
|
|
<li><code><a title="meshtastic.mesh_interface.MeshInterface.getLongName" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.getLongName">getLongName</a></code></li>
|
|
<li><code><a title="meshtastic.mesh_interface.MeshInterface.getMyNodeInfo" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.getMyNodeInfo">getMyNodeInfo</a></code></li>
|
|
<li><code><a title="meshtastic.mesh_interface.MeshInterface.getMyUser" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.getMyUser">getMyUser</a></code></li>
|
|
<li><code><a title="meshtastic.mesh_interface.MeshInterface.getNode" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.getNode">getNode</a></code></li>
|
|
<li><code><a title="meshtastic.mesh_interface.MeshInterface.getShortName" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.getShortName">getShortName</a></code></li>
|
|
<li><code><a title="meshtastic.mesh_interface.MeshInterface.sendData" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.sendData">sendData</a></code></li>
|
|
<li><code><a title="meshtastic.mesh_interface.MeshInterface.sendPosition" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.sendPosition">sendPosition</a></code></li>
|
|
<li><code><a title="meshtastic.mesh_interface.MeshInterface.sendText" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.sendText">sendText</a></code></li>
|
|
<li><code><a title="meshtastic.mesh_interface.MeshInterface.showInfo" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.showInfo">showInfo</a></code></li>
|
|
<li><code><a title="meshtastic.mesh_interface.MeshInterface.showNodes" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.showNodes">showNodes</a></code></li>
|
|
<li><code><a title="meshtastic.mesh_interface.MeshInterface.waitForConfig" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.waitForConfig">waitForConfig</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</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-classes">Classes</a></h3>
|
|
<ul>
|
|
<li>
|
|
<h4><code><a title="meshtastic.stream_interface.StreamInterface" href="#meshtastic.stream_interface.StreamInterface">StreamInterface</a></code></h4>
|
|
<ul class="">
|
|
<li><code><a title="meshtastic.stream_interface.StreamInterface.close" href="#meshtastic.stream_interface.StreamInterface.close">close</a></code></li>
|
|
<li><code><a title="meshtastic.stream_interface.StreamInterface.connect" href="#meshtastic.stream_interface.StreamInterface.connect">connect</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</main>
|
|
<footer id="footer">
|
|
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
|
|
</footer>
|
|
</body>
|
|
</html> |