mirror of
https://github.com/meshtastic/python.git
synced 2025-12-27 01:47:50 -05:00
254 lines
18 KiB
HTML
254 lines
18 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.serial_interface API documentation</title>
|
|
<meta name="description" content="Serial interface 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.serial_interface</code></h1>
|
|
</header>
|
|
<section id="section-intro">
|
|
<p>Serial interface class</p>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">""" Serial interface class
|
|
"""
|
|
import logging
|
|
import platform
|
|
import os
|
|
import stat
|
|
import serial
|
|
|
|
from .stream_interface import StreamInterface
|
|
from .util import findPorts, our_exit
|
|
|
|
class SerialInterface(StreamInterface):
|
|
"""Interface class for meshtastic devices over a serial link"""
|
|
|
|
def __init__(self, devPath=None, debugOut=None, noProto=False, connectNow=True):
|
|
"""Constructor, opens a connection to a specified serial port, or if unspecified try to
|
|
find one Meshtastic device by probing
|
|
|
|
Keyword Arguments:
|
|
devPath {string} -- A filepath to a device, i.e. /dev/ttyUSB0 (default: {None})
|
|
debugOut {stream} -- If a stream is provided, any debug serial output from the device will be emitted to that stream. (default: {None})
|
|
"""
|
|
|
|
if devPath is None:
|
|
ports = findPorts()
|
|
logging.debug(f"ports:{ports}")
|
|
if len(ports) == 0:
|
|
our_exit("Warning: No Meshtastic devices detected.")
|
|
elif len(ports) > 1:
|
|
message = "Warning: Multiple serial ports were detected so one serial port must be specified with the '--port'.\n"
|
|
message += f" Ports detected:{ports}"
|
|
our_exit(message)
|
|
else:
|
|
devPath = ports[0]
|
|
|
|
logging.debug(f"Connecting to {devPath}")
|
|
|
|
# Note: we provide None for port here, because we will be opening it later
|
|
self.stream = serial.Serial(
|
|
None, 921600, exclusive=True, timeout=0.5, write_timeout=0)
|
|
|
|
# rts=False Needed to prevent TBEAMs resetting on OSX, because rts is connected to reset
|
|
self.stream.port = devPath
|
|
|
|
# HACK: If the platform driving the serial port is unable to leave the RTS pin in high-impedance
|
|
# mode, set RTS to false so that the device platform won't be reset spuriously.
|
|
# Linux does this properly, so don't apply this hack on Linux (because it makes the reset button not work).
|
|
if self._hostPlatformAlwaysDrivesUartRts():
|
|
self.stream.rts = False
|
|
self.stream.open()
|
|
|
|
StreamInterface.__init__(
|
|
self, debugOut=debugOut, noProto=noProto, connectNow=connectNow)
|
|
|
|
"""true if platform driving the serial port is Windows Subsystem for Linux 1."""
|
|
def _isWsl1(self):
|
|
# WSL1 identifies itself as Linux, but has a special char device at /dev/lxss for use with session control,
|
|
# e.g. /init. We should treat WSL1 as Windows for the RTS-driving hack because the underlying platfrom
|
|
# serial driver for the CP21xx still exhibits the buggy behavior.
|
|
# WSL2 is not covered here, as it does not (as of 2021-May-25) support the appropriate functionality to
|
|
# share or pass-through serial ports.
|
|
try:
|
|
# Claims to be Linux, but has /dev/lxss; must be WSL 1
|
|
return platform.system() == 'Linux' and stat.S_ISCHR(os.stat('/dev/lxss').st_mode)
|
|
except:
|
|
# Couldn't stat /dev/lxss special device; not WSL1
|
|
return False
|
|
|
|
def _hostPlatformAlwaysDrivesUartRts(self):
|
|
# OS-X/Windows seems to have a bug in its CP21xx serial drivers. It ignores that we asked for no RTSCTS
|
|
# control and will always drive RTS either high or low (rather than letting the CP102 leave
|
|
# it as an open-collector floating pin).
|
|
# TODO: When WSL2 supports USB passthrough, this will get messier. If/when WSL2 gets virtual serial
|
|
# ports that "share" the Windows serial port (and thus the Windows drivers), this code will need to be
|
|
# updated to reflect that as well -- or if T-Beams get made with an alternate USB to UART bridge that has
|
|
# a less buggy driver.
|
|
return platform.system() != 'Linux' or self._isWsl1()</code></pre>
|
|
</details>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
<h2 class="section-title" id="header-classes">Classes</h2>
|
|
<dl>
|
|
<dt id="meshtastic.serial_interface.SerialInterface"><code class="flex name class">
|
|
<span>class <span class="ident">SerialInterface</span></span>
|
|
<span>(</span><span>devPath=None, debugOut=None, noProto=False, connectNow=True)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<div class="desc"><p>Interface class for meshtastic devices over a serial link</p>
|
|
<p>Constructor, opens a connection to a specified serial port, or if unspecified try to
|
|
find one Meshtastic device by probing</p>
|
|
<p>Keyword Arguments:
|
|
devPath {string} – A filepath to a device, i.e. /dev/ttyUSB0 (default: {None})
|
|
debugOut {stream} – If a stream is provided, any debug serial output from the device will be emitted to that stream. (default: {None})</p></div>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">class SerialInterface(StreamInterface):
|
|
"""Interface class for meshtastic devices over a serial link"""
|
|
|
|
def __init__(self, devPath=None, debugOut=None, noProto=False, connectNow=True):
|
|
"""Constructor, opens a connection to a specified serial port, or if unspecified try to
|
|
find one Meshtastic device by probing
|
|
|
|
Keyword Arguments:
|
|
devPath {string} -- A filepath to a device, i.e. /dev/ttyUSB0 (default: {None})
|
|
debugOut {stream} -- If a stream is provided, any debug serial output from the device will be emitted to that stream. (default: {None})
|
|
"""
|
|
|
|
if devPath is None:
|
|
ports = findPorts()
|
|
logging.debug(f"ports:{ports}")
|
|
if len(ports) == 0:
|
|
our_exit("Warning: No Meshtastic devices detected.")
|
|
elif len(ports) > 1:
|
|
message = "Warning: Multiple serial ports were detected so one serial port must be specified with the '--port'.\n"
|
|
message += f" Ports detected:{ports}"
|
|
our_exit(message)
|
|
else:
|
|
devPath = ports[0]
|
|
|
|
logging.debug(f"Connecting to {devPath}")
|
|
|
|
# Note: we provide None for port here, because we will be opening it later
|
|
self.stream = serial.Serial(
|
|
None, 921600, exclusive=True, timeout=0.5, write_timeout=0)
|
|
|
|
# rts=False Needed to prevent TBEAMs resetting on OSX, because rts is connected to reset
|
|
self.stream.port = devPath
|
|
|
|
# HACK: If the platform driving the serial port is unable to leave the RTS pin in high-impedance
|
|
# mode, set RTS to false so that the device platform won't be reset spuriously.
|
|
# Linux does this properly, so don't apply this hack on Linux (because it makes the reset button not work).
|
|
if self._hostPlatformAlwaysDrivesUartRts():
|
|
self.stream.rts = False
|
|
self.stream.open()
|
|
|
|
StreamInterface.__init__(
|
|
self, debugOut=debugOut, noProto=noProto, connectNow=connectNow)
|
|
|
|
"""true if platform driving the serial port is Windows Subsystem for Linux 1."""
|
|
def _isWsl1(self):
|
|
# WSL1 identifies itself as Linux, but has a special char device at /dev/lxss for use with session control,
|
|
# e.g. /init. We should treat WSL1 as Windows for the RTS-driving hack because the underlying platfrom
|
|
# serial driver for the CP21xx still exhibits the buggy behavior.
|
|
# WSL2 is not covered here, as it does not (as of 2021-May-25) support the appropriate functionality to
|
|
# share or pass-through serial ports.
|
|
try:
|
|
# Claims to be Linux, but has /dev/lxss; must be WSL 1
|
|
return platform.system() == 'Linux' and stat.S_ISCHR(os.stat('/dev/lxss').st_mode)
|
|
except:
|
|
# Couldn't stat /dev/lxss special device; not WSL1
|
|
return False
|
|
|
|
def _hostPlatformAlwaysDrivesUartRts(self):
|
|
# OS-X/Windows seems to have a bug in its CP21xx serial drivers. It ignores that we asked for no RTSCTS
|
|
# control and will always drive RTS either high or low (rather than letting the CP102 leave
|
|
# it as an open-collector floating pin).
|
|
# TODO: When WSL2 supports USB passthrough, this will get messier. If/when WSL2 gets virtual serial
|
|
# ports that "share" the Windows serial port (and thus the Windows drivers), this code will need to be
|
|
# updated to reflect that as well -- or if T-Beams get made with an alternate USB to UART bridge that has
|
|
# a less buggy driver.
|
|
return platform.system() != 'Linux' or self._isWsl1()</code></pre>
|
|
</details>
|
|
<h3>Ancestors</h3>
|
|
<ul class="hlist">
|
|
<li><a title="meshtastic.stream_interface.StreamInterface" href="stream_interface.html#meshtastic.stream_interface.StreamInterface">StreamInterface</a></li>
|
|
<li><a title="meshtastic.mesh_interface.MeshInterface" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface">MeshInterface</a></li>
|
|
</ul>
|
|
<h3>Inherited members</h3>
|
|
<ul class="hlist">
|
|
<li><code><b><a title="meshtastic.stream_interface.StreamInterface" href="stream_interface.html#meshtastic.stream_interface.StreamInterface">StreamInterface</a></b></code>:
|
|
<ul class="hlist">
|
|
<li><code><a title="meshtastic.stream_interface.StreamInterface.close" href="stream_interface.html#meshtastic.stream_interface.StreamInterface.close">close</a></code></li>
|
|
<li><code><a title="meshtastic.stream_interface.StreamInterface.connect" href="stream_interface.html#meshtastic.stream_interface.StreamInterface.connect">connect</a></code></li>
|
|
<li><code><a title="meshtastic.stream_interface.StreamInterface.getLongName" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.getLongName">getLongName</a></code></li>
|
|
<li><code><a title="meshtastic.stream_interface.StreamInterface.getMyNodeInfo" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.getMyNodeInfo">getMyNodeInfo</a></code></li>
|
|
<li><code><a title="meshtastic.stream_interface.StreamInterface.getMyUser" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.getMyUser">getMyUser</a></code></li>
|
|
<li><code><a title="meshtastic.stream_interface.StreamInterface.getNode" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.getNode">getNode</a></code></li>
|
|
<li><code><a title="meshtastic.stream_interface.StreamInterface.getShortName" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.getShortName">getShortName</a></code></li>
|
|
<li><code><a title="meshtastic.stream_interface.StreamInterface.sendData" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.sendData">sendData</a></code></li>
|
|
<li><code><a title="meshtastic.stream_interface.StreamInterface.sendPosition" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.sendPosition">sendPosition</a></code></li>
|
|
<li><code><a title="meshtastic.stream_interface.StreamInterface.sendText" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.sendText">sendText</a></code></li>
|
|
<li><code><a title="meshtastic.stream_interface.StreamInterface.showInfo" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.showInfo">showInfo</a></code></li>
|
|
<li><code><a title="meshtastic.stream_interface.StreamInterface.showNodes" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.showNodes">showNodes</a></code></li>
|
|
<li><code><a title="meshtastic.stream_interface.StreamInterface.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.serial_interface.SerialInterface" href="#meshtastic.serial_interface.SerialInterface">SerialInterface</a></code></h4>
|
|
</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> |