Merge pull request #327 from meshtastic/device-updates-release

Updated protos

.coveragerc

@@ -1,2 +1,6 @@
 [run]
 omit = meshtastic/*_pb2.py,meshtastic/tests/*.py,meshtastic/test.py
+
+[report]
+exclude_lines =
+    if __name__ == .__main__.:

.github/workflows/ci.yml

@@ -10,12 +10,18 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.6"
+          - "3.7"
+          - "3.8"
+          - "3.9"
+          - "3.10"
     steps:
       - uses: actions/checkout@v2
       - name: Install Python 3
         uses: actions/setup-python@v1
-        with:
-          python-version: 3.9
       - name: Uninstall meshtastic
         run: |
           pip3 uninstall meshtastic
@@ -29,17 +35,35 @@ jobs:
           which meshtastic
           meshtastic --version
       - name: Run pylint
-        run: pylint meshtastic
+        run: pylint meshtastic examples/
       - name: Run tests with pytest
         run: pytest --cov=meshtastic
+      - name: Generate coverage report
+        run: |
+          pytest --cov=meshtastic --cov-report=xml
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: true
+          verbose: true
   validate:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.6"
+          - "3.7"
+          - "3.8"
+          - "3.9"
+          - "3.10"
     steps:
       - uses: actions/checkout@v2
       - name: Install Python 3
         uses: actions/setup-python@v1
-        with:
-          python-version: 3.9
       - name: Install meshtastic from local
         run: |
           pip3 install .

.github/workflows/release.yml

@@ -0,0 +1,198 @@
+name: Make Release
+on: workflow_dispatch
+
+jobs:
+  release_create:
+    runs-on: ubuntu-latest
+
+    outputs:
+      version: ${{ steps.get_version.outputs.version }}
+      upload_url: ${{ steps.create_release.outputs.upload_url }}
+      new_sha: ${{ steps.commit_updated.outputs.sha }}
+
+    steps:
+
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Bump version
+      run: >-
+        bin/bump_version.py
+
+    - name: Commit updated version.py
+      id: commit_updated
+      run: |
+        git config --global user.name 'github-actions'
+        git config --global user.email 'bot@noreply.github.com'
+        git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
+        git add setup.py
+        git commit -m "bump version" && git push || echo "No changes to commit"
+        git log -n 1 --pretty=format:"%H" | tail -n 1 | awk '{print "::set-output name=sha::"$0}'
+
+    - name: Get version
+      id: get_version
+      run: >-
+        bin/show_version.py
+
+    - name: Create GitHub release
+      uses: actions/create-release@v1
+      id: create_release
+
+      with:
+        draft: true
+        prerelease: true
+        release_name: Meshtastic Python ${{ steps.get_version.outputs.version }}
+        tag_name: ${{ steps.get_version.outputs.version }}
+        body: |
+          Autogenerated by github action, developer should edit as required before publishing...
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+
+    - name: Install pypa/build
+      run: >-
+        python -m
+        pip install
+        build
+        --user
+
+    - name: Build a binary wheel and a source tarball
+      run: >-
+        python -m
+        build
+        --sdist
+        --wheel
+        --outdir dist/
+        .
+
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@master
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}
+
+
+  build-and-publish-mac:
+    runs-on: macos-latest
+    needs: release_create
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ needs.release_create.outputs.new_sha }}
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - name: Setup code signing
+        env:
+          MACOS_CERTIFICATE: ${{ secrets.MACOS_CERTIFICATE }}
+          MACOS_CERTIFICATE_PWD: ${{ secrets.MACOS_CERTIFICATE_PWD }}
+          MACOS_KEYCHAIN_PASSWORD: ${{ secrets.MACOS_KEYCHAIN_PASSWORD }}
+        run: |
+          echo $MACOS_CERTIFICATE | base64 --decode > certificate.p12
+          security create-keychain -p "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
+          security default-keychain -s meshtastic.keychain
+          security unlock-keychain -p "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
+          security import certificate.p12 -k meshtastic.keychain -P "$MACOS_CERTIFICATE_PWD" -T /usr/bin/codesign
+          security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
+
+      - name: Build
+        env:
+          MACOS_SIGNING_IDENTITY: ${{ secrets.MACOS_SIGNING_IDENTITY }}
+        run: |
+          pip install pyinstaller
+          pip install -r requirements.txt
+          pip install .
+          pyinstaller -F -n meshtastic --collect-all meshtastic --codesign-identity "$MACOS_SIGNING_IDENTITY" meshtastic/__main__.py
+
+      - name: Add mac to release
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.release_create.outputs.upload_url }}
+          asset_path: dist/meshtastic
+          asset_name: meshtastic_mac
+          asset_content_type: application/zip
+
+  build-and-publish-ubuntu:
+    runs-on: ubuntu-latest
+    needs: release_create
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ needs.release_create.outputs.new_sha }}
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - name: Build
+        run: |
+          pip install pyinstaller
+          pip install -r requirements.txt
+          pip install .
+          pyinstaller -F -n meshtastic --collect-all meshtastic meshtastic/__main__.py
+
+      - name: Add ubuntu to release
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.release_create.outputs.upload_url }}
+          asset_path: dist/meshtastic
+          asset_name: meshtastic_ubuntu
+          asset_content_type: application/zip
+
+      - name: Add readme.txt to release
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.release_create.outputs.upload_url }}
+          asset_path: standalone_readme.txt
+          asset_name: readme.txt
+          asset_content_type: text/plain
+
+  build-and-publish-windows:
+    runs-on: windows-latest
+    needs: release_create
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ needs.release_create.outputs.new_sha }}
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - name: Build
+        run: |
+          pip install pyinstaller
+          pip install -r requirements.txt
+          pip install .
+          pyinstaller -F -n meshtastic --collect-all meshtastic meshtastic/__main__.py
+
+      - name: Add windows to release
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.release_create.outputs.upload_url }}
+          asset_path: dist/meshtastic.exe
+          asset_name: meshtastic_windows
+          asset_content_type: application/zip

.github/workflows/update_protobufs.yml

@@ -15,10 +15,22 @@ jobs:
         run: |
           git pull --recurse-submodules
           git submodule update --remote --recursive
+          
+      - name: Download nanopb
+        run: |
+          wget https://jpa.kapsi.fi/nanopb/download/nanopb-0.4.4-linux-x86.tar.gz
+          tar xvzf nanopb-0.4.4-linux-x86.tar.gz
+          mv nanopb-0.4.4-linux-x86 nanopb-0.4.4
+          
+      - name: Re-generate protocol buffers
+        run: |
+          ./bin/regen-protos.sh  
+          
       - name: Commit update
         run: |
           git config --global user.name 'github-actions'
           git config --global user.email 'bot@noreply.github.com'
           git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
           git add proto
+          git add meshtastic
           git commit -m "Update protobuf submodule" && git push || echo "No changes to commit"

.gitignore

@@ -6,6 +6,7 @@ dist
 log_*
 .eggs
 nanopb-0.4.4
+nanopb-0.4.5
 .*swp
 .coverage
 *.py-E
@@ -14,3 +15,4 @@ venv/
 .DS_Store
 __pycache__
 examples/__pycache__
+meshtastic.spec

.pylintrc

@@ -7,7 +7,7 @@
 
 # Add files or directories matching the regex patterns to the blacklist. The
 # regex matches against base names, not paths.
-ignore-patterns=mqtt_pb2.py,channel_pb2.py,environmental_measurement_pb2.py,admin_pb2.py,radioconfig_pb2.py,deviceonly_pb2.py,apponly_pb2.py,remote_hardware_pb2.py,portnums_pb2.py,mesh_pb2.py,storeforward_pb2.py
+ignore-patterns=mqtt_pb2.py,channel_pb2.py,telemetry_pb2.py,admin_pb2.py,radioconfig_pb2.py,deviceonly_pb2.py,apponly_pb2.py,remote_hardware_pb2.py,portnums_pb2.py,mesh_pb2.py,storeforward_pb2.py,cannedmessages_pb2.py
 
 
 
@@ -23,7 +23,7 @@ ignore-patterns=mqtt_pb2.py,channel_pb2.py,environmental_measurement_pb2.py,admi
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
 #
-disable=invalid-name,fixme,logging-fstring-interpolation,too-many-statements,too-many-branches,too-many-locals,no-member,f-string-without-interpolation,protected-access,no-self-use,pointless-string-statement,too-few-public-methods,consider-using-f-string,broad-except,no-else-return,unused-argument,global-statement,global-variable-not-assigned,too-many-boolean-expressions,no-else-raise,bare-except,c-extension-no-member
+disable=invalid-name,fixme,logging-fstring-interpolation,too-many-statements,too-many-branches,too-many-locals,no-member,f-string-without-interpolation,protected-access,no-self-use,pointless-string-statement,too-few-public-methods,broad-except,no-else-return,no-else-raise,bare-except,too-many-public-methods
 
 
 [BASIC]
@@ -41,7 +41,7 @@ bad-names=foo,bar,baz,toto,tutu,tata
 max-line-length=150
 
 # Maximum number of lines in a module
-max-module-lines=1200
+max-module-lines=1400
 
 
 

Makefile

@@ -2,6 +2,14 @@
 test:
 	pytest -m unit
 
+# only run the smoke tests against the virtual device
+virt:
+	pytest -m smokevirt
+
+# run the smoke1 test (after doing a factory reset and unplugging/replugging in device)
+smoke1:
+	pytest -m smoke1 -s -vv
+
 # local install
 install:
 	pip install .
@@ -12,11 +20,17 @@ docs:
 
 # lint the codebase
 lint:
-	pylint meshtastic
+	pylint meshtastic examples
 
 # show the slowest unit tests
 slow:
-	pytest --durations=0
+	pytest -m unit --durations=5
+
+proto: FORCE
+	git submodule update --init --recursive
+	git pull --rebase
+	git submodule update --remote --merge
+	./bin/regen-protos.sh
 
 # run the coverage report and open results in a browser
 cov:

README.md

@@ -2,6 +2,9 @@
 
 [![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/meshtastic/Meshtastic-python)
 ![Unit Tests](https://github.com/meshtastic/Meshtastic-python/actions/workflows/ci.yml/badge.svg)
+[![codecov](https://codecov.io/gh/meshtastic/Meshtastic-python/branch/master/graph/badge.svg?token=TIWPJL73KV)](https://codecov.io/gh/meshtastic/Meshtastic-python)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/meshtastic)
+[![CLA assistant](https://cla-assistant.io/readme/badge/meshtastic/Meshtastic-python)](https://cla-assistant.io/meshtastic/Meshtastic-python)
 
 A python client for using [Meshtastic](https://www.meshtastic.org) devices. This small library (and example application) provides an easy API for sending and receiving messages over mesh radios. It also provides access to any of the operations/data available in the device user interface or the Android application. Events are delivered using a publish-subscribe model, and you can subscribe to only the message types you are interested in.
 

bin/bump_version.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python
+"""Bump the version number"""
+
+version_filename = "setup.py"
+
+lines = None
+
+with open(version_filename, 'r', encoding='utf-8') as f:
+    lines = f.readlines()
+
+with open(version_filename, 'w', encoding='utf-8') as f:
+    for line in lines:
+        if line.lstrip().startswith("version="):
+            # get rid of quotes around the version
+            line = line.replace('"', '')
+            # get rid of trailing comma
+            line = line.replace(",", "")
+            # split on '='
+            words = line.split("=")
+            # split the version into parts (by period)
+            v = words[1].split(".")
+            ver = f'{v[0]}.{v[1]}.{int(v[2]) + 1}'
+            f.write(f'    version="{ver}",\n')
+        else:
+            f.write(line)

bin/regen-protos.sh

@@ -1,15 +1,15 @@
 #!/bin/bash
 
-./nanopb-0.4.4/generator-bin/protoc -I=proto --python_out meshtastic `ls proto/*.proto`
+./nanopb-0.4.5/generator-bin/protoc -I=proto --python_out meshtastic `ls proto/*.proto`
 
 # workaround for import bug in protoc https://github.com/protocolbuffers/protobuf/issues/1491#issuecomment-690618628
 
 if [[ $OSTYPE == 'darwin'* ]]; then
-  sed -i -E 's/^\(import.*_pb2\)/from . \1/' meshtastic/*.py
+  sed -i '' -E 's/^(import.*_pb2)/from . \1/' meshtastic/*.py
+  # automate the current workaround (may be related to Meshtastic-protobufs issue #27 https://github.com/meshtastic/Meshtastic-protobufs/issues/27)
+  sed -i '' -E "s/^None = 0/globals()['None'] = 0/" meshtastic/mesh_pb2.py
 else
-  sed -i -E 's/^import.*_pb2/from . \0/' meshtastic/*.py
+  sed -i -e 's/^import.*_pb2/from . \0/' meshtastic/*.py
+  # automate the current workaround (may be related to Meshtastic-protobufs issue #27 https://github.com/meshtastic/Meshtastic-protobufs/issues/27)
+  sed -i -e "s/^None = 0/globals()['None'] = 0/" meshtastic/mesh_pb2.py
 fi
-  
-
-# automate the current workaround (may be related to Meshtastic-protobufs issue #27 https://github.com/meshtastic/Meshtastic-protobufs/issues/27)
-sed -i '' -e "s/^None = 0/globals()['None'] = 0/" meshtastic/mesh_pb2.py

bin/show_version.py

@@ -0,0 +1,20 @@
+#!/usr/bin/env python
+"""Show the version number"""
+
+version_filename = "setup.py"
+
+lines = None
+
+with open(version_filename, 'r', encoding='utf-8') as f:
+    lines = f.readlines()
+
+for line in lines:
+    if line.lstrip().startswith("version="):
+        # get rid of quotes around the version
+        line2 = line.replace('"', '')
+        # get rid of the trailing comma
+        line2 = line2.replace(',', '')
+        # split on =
+        words = line2.split("=")
+        # Note: This format is for github actions
+        print(f'::set-output name=version::{words[1].strip()}')

bin/upload-release.sh

@@ -1,7 +1,5 @@
 rm dist/*
 set -e
 
-bin/regen-docs.sh
-pandoc --from=markdown --to=rst --output=README README.md
 python3 setup.py sdist bdist_wheel
-python3 -m twine upload dist/*
+python3 -m twine upload dist/*

docs/meshtastic/apponly_pb2.html

@@ -1,707 +0,0 @@
-<!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.apponly_pb2 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.apponly_pb2</code></h1>
-</header>
-<section id="section-intro">
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python"># -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: apponly.proto
-
-from google.protobuf import descriptor as _descriptor
-from google.protobuf import message as _message
-from google.protobuf import reflection as _reflection
-from google.protobuf import symbol_database as _symbol_database
-# @@protoc_insertion_point(imports)
-
-_sym_db = _symbol_database.Default()
-
-
-from . import channel_pb2 as channel__pb2
-
-
-DESCRIPTOR = _descriptor.FileDescriptor(
-  name=&#39;apponly.proto&#39;,
-  package=&#39;&#39;,
-  syntax=&#39;proto3&#39;,
-  serialized_options=b&#39;\n\023com.geeksville.meshB\rAppOnlyProtosH\003Z!github.com/meshtastic/gomeshproto&#39;,
-  serialized_pb=b&#39;\n\rapponly.proto\x1a\rchannel.proto\&#34;0\n\nChannelSet\x12\&#34;\n\x08settings\x18\x01 \x03(\x0b\x32\x10.ChannelSettingsBI\n\x13\x63om.geeksville.meshB\rAppOnlyProtosH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3&#39;
-  ,
-  dependencies=[channel__pb2.DESCRIPTOR,])
-
-
-
-
-_CHANNELSET = _descriptor.Descriptor(
-  name=&#39;ChannelSet&#39;,
-  full_name=&#39;ChannelSet&#39;,
-  filename=None,
-  file=DESCRIPTOR,
-  containing_type=None,
-  fields=[
-    _descriptor.FieldDescriptor(
-      name=&#39;settings&#39;, full_name=&#39;ChannelSet.settings&#39;, index=0,
-      number=1, type=11, cpp_type=10, label=3,
-      has_default_value=False, default_value=[],
-      message_type=None, enum_type=None, containing_type=None,
-      is_extension=False, extension_scope=None,
-      serialized_options=None, file=DESCRIPTOR),
-  ],
-  extensions=[
-  ],
-  nested_types=[],
-  enum_types=[
-  ],
-  serialized_options=None,
-  is_extendable=False,
-  syntax=&#39;proto3&#39;,
-  extension_ranges=[],
-  oneofs=[
-  ],
-  serialized_start=32,
-  serialized_end=80,
-)
-
-_CHANNELSET.fields_by_name[&#39;settings&#39;].message_type = channel__pb2._CHANNELSETTINGS
-DESCRIPTOR.message_types_by_name[&#39;ChannelSet&#39;] = _CHANNELSET
-_sym_db.RegisterFileDescriptor(DESCRIPTOR)
-
-ChannelSet = _reflection.GeneratedProtocolMessageType(&#39;ChannelSet&#39;, (_message.Message,), {
-  &#39;DESCRIPTOR&#39; : _CHANNELSET,
-  &#39;__module__&#39; : &#39;apponly_pb2&#39;
-  # @@protoc_insertion_point(class_scope:ChannelSet)
-  })
-_sym_db.RegisterMessage(ChannelSet)
-
-
-DESCRIPTOR._options = None
-# @@protoc_insertion_point(module_scope)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="meshtastic.apponly_pb2.ChannelSet"><code class="flex name class">
-<span>class <span class="ident">ChannelSet</span></span>
-<span>(</span><span>**kwargs)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Abstract base class for protocol messages.</p>
-<p>Protocol message classes are almost always generated by the protocol
-compiler.
-These generated types subclass Message and implement the methods
-shown below.</p></div>
-<h3>Ancestors</h3>
-<ul class="hlist">
-<li>google.protobuf.message.Message</li>
-</ul>
-<h3>Class variables</h3>
-<dl>
-<dt id="meshtastic.apponly_pb2.ChannelSet.DESCRIPTOR"><code class="name">var <span class="ident">DESCRIPTOR</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt id="meshtastic.apponly_pb2.ChannelSet.SETTINGS_FIELD_NUMBER"><code class="name">var <span class="ident">SETTINGS_FIELD_NUMBER</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-</dl>
-<h3>Static methods</h3>
-<dl>
-<dt id="meshtastic.apponly_pb2.ChannelSet.FromString"><code class="name flex">
-<span>def <span class="ident">FromString</span></span>(<span>s)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def FromString(s):
-  message = cls()
-  message.MergeFromString(s)
-  return message</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.apponly_pb2.ChannelSet.RegisterExtension"><code class="name flex">
-<span>def <span class="ident">RegisterExtension</span></span>(<span>extension_handle)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def RegisterExtension(extension_handle):
-  extension_handle.containing_type = cls.DESCRIPTOR
-  # TODO(amauryfa): Use cls.MESSAGE_FACTORY.pool when available.
-  # pylint: disable=protected-access
-  cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(extension_handle)
-  _AttachFieldHelpers(cls, extension_handle)</code></pre>
-</details>
-</dd>
-</dl>
-<h3>Instance variables</h3>
-<dl>
-<dt id="meshtastic.apponly_pb2.ChannelSet.settings"><code class="name">var <span class="ident">settings</span></code></dt>
-<dd>
-<div class="desc"><p>Getter for settings.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def getter(self):
-  field_value = self._fields.get(field)
-  if field_value is None:
-    # Construct a new object to represent this field.
-    field_value = field._default_constructor(self)
-
-    # Atomically check if another thread has preempted us and, if not, swap
-    # in the new object we just created.  If someone has preempted us, we
-    # take that object and discard ours.
-    # WARNING:  We are relying on setdefault() being atomic.  This is true
-    #   in CPython but we haven&#39;t investigated others.  This warning appears
-    #   in several other locations in this file.
-    field_value = self._fields.setdefault(field, field_value)
-  return field_value</code></pre>
-</details>
-</dd>
-</dl>
-<h3>Methods</h3>
-<dl>
-<dt id="meshtastic.apponly_pb2.ChannelSet.ByteSize"><code class="name flex">
-<span>def <span class="ident">ByteSize</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def ByteSize(self):
-  if not self._cached_byte_size_dirty:
-    return self._cached_byte_size
-
-  size = 0
-  descriptor = self.DESCRIPTOR
-  if descriptor.GetOptions().map_entry:
-    # Fields of map entry should always be serialized.
-    size = descriptor.fields_by_name[&#39;key&#39;]._sizer(self.key)
-    size += descriptor.fields_by_name[&#39;value&#39;]._sizer(self.value)
-  else:
-    for field_descriptor, field_value in self.ListFields():
-      size += field_descriptor._sizer(field_value)
-    for tag_bytes, value_bytes in self._unknown_fields:
-      size += len(tag_bytes) + len(value_bytes)
-
-  self._cached_byte_size = size
-  self._cached_byte_size_dirty = False
-  self._listener_for_children.dirty = False
-  return size</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.apponly_pb2.ChannelSet.Clear"><code class="name flex">
-<span>def <span class="ident">Clear</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def _Clear(self):
-  # Clear fields.
-  self._fields = {}
-  self._unknown_fields = ()
-  # pylint: disable=protected-access
-  if self._unknown_field_set is not None:
-    self._unknown_field_set._clear()
-    self._unknown_field_set = None
-
-  self._oneofs = {}
-  self._Modified()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.apponly_pb2.ChannelSet.ClearField"><code class="name flex">
-<span>def <span class="ident">ClearField</span></span>(<span>self, field_name)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def ClearField(self, field_name):
-  try:
-    field = message_descriptor.fields_by_name[field_name]
-  except KeyError:
-    try:
-      field = message_descriptor.oneofs_by_name[field_name]
-      if field in self._oneofs:
-        field = self._oneofs[field]
-      else:
-        return
-    except KeyError:
-      raise ValueError(&#39;Protocol message %s has no &#34;%s&#34; field.&#39; %
-                       (message_descriptor.name, field_name))
-
-  if field in self._fields:
-    # To match the C++ implementation, we need to invalidate iterators
-    # for map fields when ClearField() happens.
-    if hasattr(self._fields[field], &#39;InvalidateIterators&#39;):
-      self._fields[field].InvalidateIterators()
-
-    # Note:  If the field is a sub-message, its listener will still point
-    #   at us.  That&#39;s fine, because the worst than can happen is that it
-    #   will call _Modified() and invalidate our byte size.  Big deal.
-    del self._fields[field]
-
-    if self._oneofs.get(field.containing_oneof, None) is field:
-      del self._oneofs[field.containing_oneof]
-
-  # Always call _Modified() -- even if nothing was changed, this is
-  # a mutating method, and thus calling it should cause the field to become
-  # present in the parent message.
-  self._Modified()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.apponly_pb2.ChannelSet.DiscardUnknownFields"><code class="name flex">
-<span>def <span class="ident">DiscardUnknownFields</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def _DiscardUnknownFields(self):
-  self._unknown_fields = []
-  self._unknown_field_set = None      # pylint: disable=protected-access
-  for field, value in self.ListFields():
-    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
-      if _IsMapField(field):
-        if _IsMessageMapField(field):
-          for key in value:
-            value[key].DiscardUnknownFields()
-      elif field.label == _FieldDescriptor.LABEL_REPEATED:
-        for sub_message in value:
-          sub_message.DiscardUnknownFields()
-      else:
-        value.DiscardUnknownFields()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.apponly_pb2.ChannelSet.FindInitializationErrors"><code class="name flex">
-<span>def <span class="ident">FindInitializationErrors</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Finds required fields which are not initialized.</p>
-<h2 id="returns">Returns</h2>
-<p>A list of strings.
-Each string is a path to an uninitialized field from
-the top-level message, e.g. "foo.bar[5].baz".</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def FindInitializationErrors(self):
-  &#34;&#34;&#34;Finds required fields which are not initialized.
-
-  Returns:
-    A list of strings.  Each string is a path to an uninitialized field from
-    the top-level message, e.g. &#34;foo.bar[5].baz&#34;.
-  &#34;&#34;&#34;
-
-  errors = []  # simplify things
-
-  for field in required_fields:
-    if not self.HasField(field.name):
-      errors.append(field.name)
-
-  for field, value in self.ListFields():
-    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
-      if field.is_extension:
-        name = &#39;(%s)&#39; % field.full_name
-      else:
-        name = field.name
-
-      if _IsMapField(field):
-        if _IsMessageMapField(field):
-          for key in value:
-            element = value[key]
-            prefix = &#39;%s[%s].&#39; % (name, key)
-            sub_errors = element.FindInitializationErrors()
-            errors += [prefix + error for error in sub_errors]
-        else:
-          # ScalarMaps can&#39;t have any initialization errors.
-          pass
-      elif field.label == _FieldDescriptor.LABEL_REPEATED:
-        for i in range(len(value)):
-          element = value[i]
-          prefix = &#39;%s[%d].&#39; % (name, i)
-          sub_errors = element.FindInitializationErrors()
-          errors += [prefix + error for error in sub_errors]
-      else:
-        prefix = name + &#39;.&#39;
-        sub_errors = value.FindInitializationErrors()
-        errors += [prefix + error for error in sub_errors]
-
-  return errors</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.apponly_pb2.ChannelSet.HasField"><code class="name flex">
-<span>def <span class="ident">HasField</span></span>(<span>self, field_name)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def HasField(self, field_name):
-  try:
-    field = hassable_fields[field_name]
-  except KeyError:
-    raise ValueError(error_msg % (message_descriptor.full_name, field_name))
-
-  if isinstance(field, descriptor_mod.OneofDescriptor):
-    try:
-      return HasField(self, self._oneofs[field].name)
-    except KeyError:
-      return False
-  else:
-    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
-      value = self._fields.get(field)
-      return value is not None and value._is_present_in_parent
-    else:
-      return field in self._fields</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.apponly_pb2.ChannelSet.IsInitialized"><code class="name flex">
-<span>def <span class="ident">IsInitialized</span></span>(<span>self, errors=None)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Checks if all required fields of a message are set.</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>errors</code></strong></dt>
-<dd>A list which, if provided, will be populated with the field
-paths of all missing required fields.</dd>
-</dl>
-<h2 id="returns">Returns</h2>
-<p>True iff the specified message has all required fields set.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def IsInitialized(self, errors=None):
-  &#34;&#34;&#34;Checks if all required fields of a message are set.
-
-  Args:
-    errors:  A list which, if provided, will be populated with the field
-             paths of all missing required fields.
-
-  Returns:
-    True iff the specified message has all required fields set.
-  &#34;&#34;&#34;
-
-  # Performance is critical so we avoid HasField() and ListFields().
-
-  for field in required_fields:
-    if (field not in self._fields or
-        (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
-         not self._fields[field]._is_present_in_parent)):
-      if errors is not None:
-        errors.extend(self.FindInitializationErrors())
-      return False
-
-  for field, value in list(self._fields.items()):  # dict can change size!
-    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
-      if field.label == _FieldDescriptor.LABEL_REPEATED:
-        if (field.message_type.has_options and
-            field.message_type.GetOptions().map_entry):
-          continue
-        for element in value:
-          if not element.IsInitialized():
-            if errors is not None:
-              errors.extend(self.FindInitializationErrors())
-            return False
-      elif value._is_present_in_parent and not value.IsInitialized():
-        if errors is not None:
-          errors.extend(self.FindInitializationErrors())
-        return False
-
-  return True</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.apponly_pb2.ChannelSet.ListFields"><code class="name flex">
-<span>def <span class="ident">ListFields</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def ListFields(self):
-  all_fields = [item for item in self._fields.items() if _IsPresent(item)]
-  all_fields.sort(key = lambda item: item[0].number)
-  return all_fields</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.apponly_pb2.ChannelSet.MergeFrom"><code class="name flex">
-<span>def <span class="ident">MergeFrom</span></span>(<span>self, msg)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def MergeFrom(self, msg):
-  if not isinstance(msg, cls):
-    raise TypeError(
-        &#39;Parameter to MergeFrom() must be instance of same class: &#39;
-        &#39;expected %s got %s.&#39; % (_FullyQualifiedClassName(cls),
-                                 _FullyQualifiedClassName(msg.__class__)))
-
-  assert msg is not self
-  self._Modified()
-
-  fields = self._fields
-
-  for field, value in msg._fields.items():
-    if field.label == LABEL_REPEATED:
-      field_value = fields.get(field)
-      if field_value is None:
-        # Construct a new object to represent this field.
-        field_value = field._default_constructor(self)
-        fields[field] = field_value
-      field_value.MergeFrom(value)
-    elif field.cpp_type == CPPTYPE_MESSAGE:
-      if value._is_present_in_parent:
-        field_value = fields.get(field)
-        if field_value is None:
-          # Construct a new object to represent this field.
-          field_value = field._default_constructor(self)
-          fields[field] = field_value
-        field_value.MergeFrom(value)
-    else:
-      self._fields[field] = value
-      if field.containing_oneof:
-        self._UpdateOneofState(field)
-
-  if msg._unknown_fields:
-    if not self._unknown_fields:
-      self._unknown_fields = []
-    self._unknown_fields.extend(msg._unknown_fields)
-    # pylint: disable=protected-access
-    if self._unknown_field_set is None:
-      self._unknown_field_set = containers.UnknownFieldSet()
-    self._unknown_field_set._extend(msg._unknown_field_set)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.apponly_pb2.ChannelSet.MergeFromString"><code class="name flex">
-<span>def <span class="ident">MergeFromString</span></span>(<span>self, serialized)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def MergeFromString(self, serialized):
-  serialized = memoryview(serialized)
-  length = len(serialized)
-  try:
-    if self._InternalParse(serialized, 0, length) != length:
-      # The only reason _InternalParse would return early is if it
-      # encountered an end-group tag.
-      raise message_mod.DecodeError(&#39;Unexpected end-group tag.&#39;)
-  except (IndexError, TypeError):
-    # Now ord(buf[p:p+1]) == ord(&#39;&#39;) gets TypeError.
-    raise message_mod.DecodeError(&#39;Truncated message.&#39;)
-  except struct.error as e:
-    raise message_mod.DecodeError(e)
-  return length   # Return this for legacy reasons.</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.apponly_pb2.ChannelSet.SerializePartialToString"><code class="name flex">
-<span>def <span class="ident">SerializePartialToString</span></span>(<span>self, **kwargs)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def SerializePartialToString(self, **kwargs):
-  out = BytesIO()
-  self._InternalSerialize(out.write, **kwargs)
-  return out.getvalue()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.apponly_pb2.ChannelSet.SerializeToString"><code class="name flex">
-<span>def <span class="ident">SerializeToString</span></span>(<span>self, **kwargs)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def SerializeToString(self, **kwargs):
-  # Check if the message has all of its required fields set.
-  if not self.IsInitialized():
-    raise message_mod.EncodeError(
-        &#39;Message %s is missing required fields: %s&#39; % (
-        self.DESCRIPTOR.full_name, &#39;,&#39;.join(self.FindInitializationErrors())))
-  return self.SerializePartialToString(**kwargs)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.apponly_pb2.ChannelSet.SetInParent"><code class="name flex">
-<span>def <span class="ident">SetInParent</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Sets the _cached_byte_size_dirty bit to true,
-and propagates this to our listener iff this was a state change.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def Modified(self):
-  &#34;&#34;&#34;Sets the _cached_byte_size_dirty bit to true,
-  and propagates this to our listener iff this was a state change.
-  &#34;&#34;&#34;
-
-  # Note:  Some callers check _cached_byte_size_dirty before calling
-  #   _Modified() as an extra optimization.  So, if this method is ever
-  #   changed such that it does stuff even when _cached_byte_size_dirty is
-  #   already true, the callers need to be updated.
-  if not self._cached_byte_size_dirty:
-    self._cached_byte_size_dirty = True
-    self._listener_for_children.dirty = True
-    self._is_present_in_parent = True
-    self._listener.Modified()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.apponly_pb2.ChannelSet.UnknownFields"><code class="name flex">
-<span>def <span class="ident">UnknownFields</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def _UnknownFields(self):
-  if self._unknown_field_set is None:  # pylint: disable=protected-access
-    # pylint: disable=protected-access
-    self._unknown_field_set = containers.UnknownFieldSet()
-  return self._unknown_field_set    # pylint: disable=protected-access</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.apponly_pb2.ChannelSet.WhichOneof"><code class="name flex">
-<span>def <span class="ident">WhichOneof</span></span>(<span>self, oneof_name)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Returns the name of the currently set field inside a oneof, or None.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def WhichOneof(self, oneof_name):
-  &#34;&#34;&#34;Returns the name of the currently set field inside a oneof, or None.&#34;&#34;&#34;
-  try:
-    field = message_descriptor.oneofs_by_name[oneof_name]
-  except KeyError:
-    raise ValueError(
-        &#39;Protocol message has no oneof &#34;%s&#34; field.&#39; % oneof_name)
-
-  nested_field = self._oneofs.get(field, None)
-  if nested_field is not None and self.HasField(nested_field.name):
-    return nested_field.name
-  else:
-    return None</code></pre>
-</details>
-</dd>
-</dl>
-</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.apponly_pb2.ChannelSet" href="#meshtastic.apponly_pb2.ChannelSet">ChannelSet</a></code></h4>
-<ul class="">
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.ByteSize" href="#meshtastic.apponly_pb2.ChannelSet.ByteSize">ByteSize</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.Clear" href="#meshtastic.apponly_pb2.ChannelSet.Clear">Clear</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.ClearField" href="#meshtastic.apponly_pb2.ChannelSet.ClearField">ClearField</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.DESCRIPTOR" href="#meshtastic.apponly_pb2.ChannelSet.DESCRIPTOR">DESCRIPTOR</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.DiscardUnknownFields" href="#meshtastic.apponly_pb2.ChannelSet.DiscardUnknownFields">DiscardUnknownFields</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.FindInitializationErrors" href="#meshtastic.apponly_pb2.ChannelSet.FindInitializationErrors">FindInitializationErrors</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.FromString" href="#meshtastic.apponly_pb2.ChannelSet.FromString">FromString</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.HasField" href="#meshtastic.apponly_pb2.ChannelSet.HasField">HasField</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.IsInitialized" href="#meshtastic.apponly_pb2.ChannelSet.IsInitialized">IsInitialized</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.ListFields" href="#meshtastic.apponly_pb2.ChannelSet.ListFields">ListFields</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.MergeFrom" href="#meshtastic.apponly_pb2.ChannelSet.MergeFrom">MergeFrom</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.MergeFromString" href="#meshtastic.apponly_pb2.ChannelSet.MergeFromString">MergeFromString</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.RegisterExtension" href="#meshtastic.apponly_pb2.ChannelSet.RegisterExtension">RegisterExtension</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.SETTINGS_FIELD_NUMBER" href="#meshtastic.apponly_pb2.ChannelSet.SETTINGS_FIELD_NUMBER">SETTINGS_FIELD_NUMBER</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.SerializePartialToString" href="#meshtastic.apponly_pb2.ChannelSet.SerializePartialToString">SerializePartialToString</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.SerializeToString" href="#meshtastic.apponly_pb2.ChannelSet.SerializeToString">SerializeToString</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.SetInParent" href="#meshtastic.apponly_pb2.ChannelSet.SetInParent">SetInParent</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.UnknownFields" href="#meshtastic.apponly_pb2.ChannelSet.UnknownFields">UnknownFields</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.WhichOneof" href="#meshtastic.apponly_pb2.ChannelSet.WhichOneof">WhichOneof</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2.ChannelSet.settings" href="#meshtastic.apponly_pb2.ChannelSet.settings">settings</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>

docs/meshtastic/ble.html

@@ -1,53 +0,0 @@
-<!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.ble 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.ble</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</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>
-</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>

docs/meshtastic/ble_interface.html

@@ -1,212 +0,0 @@
-<!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.ble_interface API documentation</title>
-<meta name="description" content="Bluetooth interface" />
-<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.ble_interface</code></h1>
-</header>
-<section id="section-intro">
-<p>Bluetooth interface</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Bluetooth interface
-&#34;&#34;&#34;
-import logging
-import pygatt
-
-
-from .mesh_interface import MeshInterface
-
-# Our standard BLE characteristics
-TORADIO_UUID = &#34;f75c76d2-129e-4dad-a1dd-7866124401e7&#34;
-FROMRADIO_UUID = &#34;8ba2bcc2-ee02-4a55-a531-c525c5e454d5&#34;
-FROMNUM_UUID = &#34;ed9da18c-a800-4f66-a670-aa7547e34453&#34;
-
-
-class BLEInterface(MeshInterface):
-    &#34;&#34;&#34;A not quite ready - FIXME - BLE interface to devices&#34;&#34;&#34;
-
-    def __init__(self, address, noProto=False, debugOut=None):
-        self.address = address
-        if not noProto:
-            self.adapter = pygatt.GATTToolBackend()  # BGAPIBackend()
-            self.adapter.start()
-            logging.debug(f&#34;Connecting to {self.address}&#34;)
-            self.device = self.adapter.connect(address)
-        else:
-            self.adapter = None
-            self.device = None
-        logging.debug(&#34;Connected to device&#34;)
-        # fromradio = self.device.char_read(FROMRADIO_UUID)
-        MeshInterface.__init__(self, debugOut=debugOut, noProto=noProto)
-
-        self._readFromRadio()  # read the initial responses
-
-        def handle_data(handle, data):
-            self._handleFromRadio(data)
-
-        if self.device:
-            self.device.subscribe(FROMNUM_UUID, callback=handle_data)
-
-    def _sendToRadioImpl(self, toRadio):
-        &#34;&#34;&#34;Send a ToRadio protobuf to the device&#34;&#34;&#34;
-        #logging.debug(f&#34;Sending: {stripnl(toRadio)}&#34;)
-        b = toRadio.SerializeToString()
-        self.device.char_write(TORADIO_UUID, b)
-
-    def close(self):
-        MeshInterface.close(self)
-        if self.adapter:
-            self.adapter.stop()
-
-    def _readFromRadio(self):
-        if not self.noProto:
-            wasEmpty = False
-            while not wasEmpty:
-                if self.device:
-                    b = self.device.char_read(FROMRADIO_UUID)
-                    wasEmpty = len(b) == 0
-                    if not wasEmpty:
-                        self._handleFromRadio(b)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="meshtastic.ble_interface.BLEInterface"><code class="flex name class">
-<span>class <span class="ident">BLEInterface</span></span>
-<span>(</span><span>address, noProto=False, debugOut=None)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>A not quite ready - FIXME - BLE interface to devices</p>
-<p>Constructor</p>
-<p>Keyword Arguments:
-noProto &ndash; If True, don't try to run our protocol on the
-link - just be a dumb serial client.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class BLEInterface(MeshInterface):
-    &#34;&#34;&#34;A not quite ready - FIXME - BLE interface to devices&#34;&#34;&#34;
-
-    def __init__(self, address, noProto=False, debugOut=None):
-        self.address = address
-        if not noProto:
-            self.adapter = pygatt.GATTToolBackend()  # BGAPIBackend()
-            self.adapter.start()
-            logging.debug(f&#34;Connecting to {self.address}&#34;)
-            self.device = self.adapter.connect(address)
-        else:
-            self.adapter = None
-            self.device = None
-        logging.debug(&#34;Connected to device&#34;)
-        # fromradio = self.device.char_read(FROMRADIO_UUID)
-        MeshInterface.__init__(self, debugOut=debugOut, noProto=noProto)
-
-        self._readFromRadio()  # read the initial responses
-
-        def handle_data(handle, data):
-            self._handleFromRadio(data)
-
-        if self.device:
-            self.device.subscribe(FROMNUM_UUID, callback=handle_data)
-
-    def _sendToRadioImpl(self, toRadio):
-        &#34;&#34;&#34;Send a ToRadio protobuf to the device&#34;&#34;&#34;
-        #logging.debug(f&#34;Sending: {stripnl(toRadio)}&#34;)
-        b = toRadio.SerializeToString()
-        self.device.char_write(TORADIO_UUID, b)
-
-    def close(self):
-        MeshInterface.close(self)
-        if self.adapter:
-            self.adapter.stop()
-
-    def _readFromRadio(self):
-        if not self.noProto:
-            wasEmpty = False
-            while not wasEmpty:
-                if self.device:
-                    b = self.device.char_read(FROMRADIO_UUID)
-                    wasEmpty = len(b) == 0
-                    if not wasEmpty:
-                        self._handleFromRadio(b)</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>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.close" href="mesh_interface.html#meshtastic.mesh_interface.MeshInterface.close">close</a></code></li>
-<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.ble_interface.BLEInterface" href="#meshtastic.ble_interface.BLEInterface">BLEInterface</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>

docs/meshtastic/environmental_measurement_pb2.html

@@ -1,746 +0,0 @@
-<!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.environmental_measurement_pb2 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.environmental_measurement_pb2</code></h1>
-</header>
-<section id="section-intro">
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python"># -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: environmental_measurement.proto
-
-from google.protobuf import descriptor as _descriptor
-from google.protobuf import message as _message
-from google.protobuf import reflection as _reflection
-from google.protobuf import symbol_database as _symbol_database
-# @@protoc_insertion_point(imports)
-
-_sym_db = _symbol_database.Default()
-
-
-
-
-DESCRIPTOR = _descriptor.FileDescriptor(
-  name=&#39;environmental_measurement.proto&#39;,
-  package=&#39;&#39;,
-  syntax=&#39;proto3&#39;,
-  serialized_options=b&#39;Z!github.com/meshtastic/gomeshproto&#39;,
-  serialized_pb=b&#39;\n\x1f\x65nvironmental_measurement.proto\&#34;g\n\x18\x45nvironmentalMeasurement\x12\x13\n\x0btemperature\x18\x01 \x01(\x02\x12\x19\n\x11relative_humidity\x18\x02 \x01(\x02\x12\x1b\n\x13\x62\x61rometric_pressure\x18\x03 \x01(\x02\x42#Z!github.com/meshtastic/gomeshprotob\x06proto3&#39;
-)
-
-
-
-
-_ENVIRONMENTALMEASUREMENT = _descriptor.Descriptor(
-  name=&#39;EnvironmentalMeasurement&#39;,
-  full_name=&#39;EnvironmentalMeasurement&#39;,
-  filename=None,
-  file=DESCRIPTOR,
-  containing_type=None,
-  fields=[
-    _descriptor.FieldDescriptor(
-      name=&#39;temperature&#39;, full_name=&#39;EnvironmentalMeasurement.temperature&#39;, index=0,
-      number=1, type=2, cpp_type=6, label=1,
-      has_default_value=False, default_value=float(0),
-      message_type=None, enum_type=None, containing_type=None,
-      is_extension=False, extension_scope=None,
-      serialized_options=None, file=DESCRIPTOR),
-    _descriptor.FieldDescriptor(
-      name=&#39;relative_humidity&#39;, full_name=&#39;EnvironmentalMeasurement.relative_humidity&#39;, index=1,
-      number=2, type=2, cpp_type=6, label=1,
-      has_default_value=False, default_value=float(0),
-      message_type=None, enum_type=None, containing_type=None,
-      is_extension=False, extension_scope=None,
-      serialized_options=None, file=DESCRIPTOR),
-    _descriptor.FieldDescriptor(
-      name=&#39;barometric_pressure&#39;, full_name=&#39;EnvironmentalMeasurement.barometric_pressure&#39;, index=2,
-      number=3, type=2, cpp_type=6, label=1,
-      has_default_value=False, default_value=float(0),
-      message_type=None, enum_type=None, containing_type=None,
-      is_extension=False, extension_scope=None,
-      serialized_options=None, file=DESCRIPTOR),
-  ],
-  extensions=[
-  ],
-  nested_types=[],
-  enum_types=[
-  ],
-  serialized_options=None,
-  is_extendable=False,
-  syntax=&#39;proto3&#39;,
-  extension_ranges=[],
-  oneofs=[
-  ],
-  serialized_start=35,
-  serialized_end=138,
-)
-
-DESCRIPTOR.message_types_by_name[&#39;EnvironmentalMeasurement&#39;] = _ENVIRONMENTALMEASUREMENT
-_sym_db.RegisterFileDescriptor(DESCRIPTOR)
-
-EnvironmentalMeasurement = _reflection.GeneratedProtocolMessageType(&#39;EnvironmentalMeasurement&#39;, (_message.Message,), {
-  &#39;DESCRIPTOR&#39; : _ENVIRONMENTALMEASUREMENT,
-  &#39;__module__&#39; : &#39;environmental_measurement_pb2&#39;
-  # @@protoc_insertion_point(class_scope:EnvironmentalMeasurement)
-  })
-_sym_db.RegisterMessage(EnvironmentalMeasurement)
-
-
-DESCRIPTOR._options = None
-# @@protoc_insertion_point(module_scope)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement"><code class="flex name class">
-<span>class <span class="ident">EnvironmentalMeasurement</span></span>
-<span>(</span><span>**kwargs)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Abstract base class for protocol messages.</p>
-<p>Protocol message classes are almost always generated by the protocol
-compiler.
-These generated types subclass Message and implement the methods
-shown below.</p></div>
-<h3>Ancestors</h3>
-<ul class="hlist">
-<li>google.protobuf.message.Message</li>
-</ul>
-<h3>Class variables</h3>
-<dl>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.BAROMETRIC_PRESSURE_FIELD_NUMBER"><code class="name">var <span class="ident">BAROMETRIC_PRESSURE_FIELD_NUMBER</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.DESCRIPTOR"><code class="name">var <span class="ident">DESCRIPTOR</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.RELATIVE_HUMIDITY_FIELD_NUMBER"><code class="name">var <span class="ident">RELATIVE_HUMIDITY_FIELD_NUMBER</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.TEMPERATURE_FIELD_NUMBER"><code class="name">var <span class="ident">TEMPERATURE_FIELD_NUMBER</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-</dl>
-<h3>Static methods</h3>
-<dl>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.FromString"><code class="name flex">
-<span>def <span class="ident">FromString</span></span>(<span>s)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def FromString(s):
-  message = cls()
-  message.MergeFromString(s)
-  return message</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.RegisterExtension"><code class="name flex">
-<span>def <span class="ident">RegisterExtension</span></span>(<span>extension_handle)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def RegisterExtension(extension_handle):
-  extension_handle.containing_type = cls.DESCRIPTOR
-  # TODO(amauryfa): Use cls.MESSAGE_FACTORY.pool when available.
-  # pylint: disable=protected-access
-  cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(extension_handle)
-  _AttachFieldHelpers(cls, extension_handle)</code></pre>
-</details>
-</dd>
-</dl>
-<h3>Instance variables</h3>
-<dl>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.barometric_pressure"><code class="name">var <span class="ident">barometric_pressure</span></code></dt>
-<dd>
-<div class="desc"><p>Getter for barometric_pressure.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def getter(self):
-  # TODO(protobuf-team): This may be broken since there may not be
-  # default_value.  Combine with has_default_value somehow.
-  return self._fields.get(field, default_value)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.relative_humidity"><code class="name">var <span class="ident">relative_humidity</span></code></dt>
-<dd>
-<div class="desc"><p>Getter for relative_humidity.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def getter(self):
-  # TODO(protobuf-team): This may be broken since there may not be
-  # default_value.  Combine with has_default_value somehow.
-  return self._fields.get(field, default_value)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.temperature"><code class="name">var <span class="ident">temperature</span></code></dt>
-<dd>
-<div class="desc"><p>Getter for temperature.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def getter(self):
-  # TODO(protobuf-team): This may be broken since there may not be
-  # default_value.  Combine with has_default_value somehow.
-  return self._fields.get(field, default_value)</code></pre>
-</details>
-</dd>
-</dl>
-<h3>Methods</h3>
-<dl>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.ByteSize"><code class="name flex">
-<span>def <span class="ident">ByteSize</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def ByteSize(self):
-  if not self._cached_byte_size_dirty:
-    return self._cached_byte_size
-
-  size = 0
-  descriptor = self.DESCRIPTOR
-  if descriptor.GetOptions().map_entry:
-    # Fields of map entry should always be serialized.
-    size = descriptor.fields_by_name[&#39;key&#39;]._sizer(self.key)
-    size += descriptor.fields_by_name[&#39;value&#39;]._sizer(self.value)
-  else:
-    for field_descriptor, field_value in self.ListFields():
-      size += field_descriptor._sizer(field_value)
-    for tag_bytes, value_bytes in self._unknown_fields:
-      size += len(tag_bytes) + len(value_bytes)
-
-  self._cached_byte_size = size
-  self._cached_byte_size_dirty = False
-  self._listener_for_children.dirty = False
-  return size</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.Clear"><code class="name flex">
-<span>def <span class="ident">Clear</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def _Clear(self):
-  # Clear fields.
-  self._fields = {}
-  self._unknown_fields = ()
-  # pylint: disable=protected-access
-  if self._unknown_field_set is not None:
-    self._unknown_field_set._clear()
-    self._unknown_field_set = None
-
-  self._oneofs = {}
-  self._Modified()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.ClearField"><code class="name flex">
-<span>def <span class="ident">ClearField</span></span>(<span>self, field_name)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def ClearField(self, field_name):
-  try:
-    field = message_descriptor.fields_by_name[field_name]
-  except KeyError:
-    try:
-      field = message_descriptor.oneofs_by_name[field_name]
-      if field in self._oneofs:
-        field = self._oneofs[field]
-      else:
-        return
-    except KeyError:
-      raise ValueError(&#39;Protocol message %s has no &#34;%s&#34; field.&#39; %
-                       (message_descriptor.name, field_name))
-
-  if field in self._fields:
-    # To match the C++ implementation, we need to invalidate iterators
-    # for map fields when ClearField() happens.
-    if hasattr(self._fields[field], &#39;InvalidateIterators&#39;):
-      self._fields[field].InvalidateIterators()
-
-    # Note:  If the field is a sub-message, its listener will still point
-    #   at us.  That&#39;s fine, because the worst than can happen is that it
-    #   will call _Modified() and invalidate our byte size.  Big deal.
-    del self._fields[field]
-
-    if self._oneofs.get(field.containing_oneof, None) is field:
-      del self._oneofs[field.containing_oneof]
-
-  # Always call _Modified() -- even if nothing was changed, this is
-  # a mutating method, and thus calling it should cause the field to become
-  # present in the parent message.
-  self._Modified()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.DiscardUnknownFields"><code class="name flex">
-<span>def <span class="ident">DiscardUnknownFields</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def _DiscardUnknownFields(self):
-  self._unknown_fields = []
-  self._unknown_field_set = None      # pylint: disable=protected-access
-  for field, value in self.ListFields():
-    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
-      if _IsMapField(field):
-        if _IsMessageMapField(field):
-          for key in value:
-            value[key].DiscardUnknownFields()
-      elif field.label == _FieldDescriptor.LABEL_REPEATED:
-        for sub_message in value:
-          sub_message.DiscardUnknownFields()
-      else:
-        value.DiscardUnknownFields()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.FindInitializationErrors"><code class="name flex">
-<span>def <span class="ident">FindInitializationErrors</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Finds required fields which are not initialized.</p>
-<h2 id="returns">Returns</h2>
-<p>A list of strings.
-Each string is a path to an uninitialized field from
-the top-level message, e.g. "foo.bar[5].baz".</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def FindInitializationErrors(self):
-  &#34;&#34;&#34;Finds required fields which are not initialized.
-
-  Returns:
-    A list of strings.  Each string is a path to an uninitialized field from
-    the top-level message, e.g. &#34;foo.bar[5].baz&#34;.
-  &#34;&#34;&#34;
-
-  errors = []  # simplify things
-
-  for field in required_fields:
-    if not self.HasField(field.name):
-      errors.append(field.name)
-
-  for field, value in self.ListFields():
-    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
-      if field.is_extension:
-        name = &#39;(%s)&#39; % field.full_name
-      else:
-        name = field.name
-
-      if _IsMapField(field):
-        if _IsMessageMapField(field):
-          for key in value:
-            element = value[key]
-            prefix = &#39;%s[%s].&#39; % (name, key)
-            sub_errors = element.FindInitializationErrors()
-            errors += [prefix + error for error in sub_errors]
-        else:
-          # ScalarMaps can&#39;t have any initialization errors.
-          pass
-      elif field.label == _FieldDescriptor.LABEL_REPEATED:
-        for i in range(len(value)):
-          element = value[i]
-          prefix = &#39;%s[%d].&#39; % (name, i)
-          sub_errors = element.FindInitializationErrors()
-          errors += [prefix + error for error in sub_errors]
-      else:
-        prefix = name + &#39;.&#39;
-        sub_errors = value.FindInitializationErrors()
-        errors += [prefix + error for error in sub_errors]
-
-  return errors</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.HasField"><code class="name flex">
-<span>def <span class="ident">HasField</span></span>(<span>self, field_name)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def HasField(self, field_name):
-  try:
-    field = hassable_fields[field_name]
-  except KeyError:
-    raise ValueError(error_msg % (message_descriptor.full_name, field_name))
-
-  if isinstance(field, descriptor_mod.OneofDescriptor):
-    try:
-      return HasField(self, self._oneofs[field].name)
-    except KeyError:
-      return False
-  else:
-    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
-      value = self._fields.get(field)
-      return value is not None and value._is_present_in_parent
-    else:
-      return field in self._fields</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.IsInitialized"><code class="name flex">
-<span>def <span class="ident">IsInitialized</span></span>(<span>self, errors=None)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Checks if all required fields of a message are set.</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>errors</code></strong></dt>
-<dd>A list which, if provided, will be populated with the field
-paths of all missing required fields.</dd>
-</dl>
-<h2 id="returns">Returns</h2>
-<p>True iff the specified message has all required fields set.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def IsInitialized(self, errors=None):
-  &#34;&#34;&#34;Checks if all required fields of a message are set.
-
-  Args:
-    errors:  A list which, if provided, will be populated with the field
-             paths of all missing required fields.
-
-  Returns:
-    True iff the specified message has all required fields set.
-  &#34;&#34;&#34;
-
-  # Performance is critical so we avoid HasField() and ListFields().
-
-  for field in required_fields:
-    if (field not in self._fields or
-        (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
-         not self._fields[field]._is_present_in_parent)):
-      if errors is not None:
-        errors.extend(self.FindInitializationErrors())
-      return False
-
-  for field, value in list(self._fields.items()):  # dict can change size!
-    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
-      if field.label == _FieldDescriptor.LABEL_REPEATED:
-        if (field.message_type.has_options and
-            field.message_type.GetOptions().map_entry):
-          continue
-        for element in value:
-          if not element.IsInitialized():
-            if errors is not None:
-              errors.extend(self.FindInitializationErrors())
-            return False
-      elif value._is_present_in_parent and not value.IsInitialized():
-        if errors is not None:
-          errors.extend(self.FindInitializationErrors())
-        return False
-
-  return True</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.ListFields"><code class="name flex">
-<span>def <span class="ident">ListFields</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def ListFields(self):
-  all_fields = [item for item in self._fields.items() if _IsPresent(item)]
-  all_fields.sort(key = lambda item: item[0].number)
-  return all_fields</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.MergeFrom"><code class="name flex">
-<span>def <span class="ident">MergeFrom</span></span>(<span>self, msg)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def MergeFrom(self, msg):
-  if not isinstance(msg, cls):
-    raise TypeError(
-        &#39;Parameter to MergeFrom() must be instance of same class: &#39;
-        &#39;expected %s got %s.&#39; % (_FullyQualifiedClassName(cls),
-                                 _FullyQualifiedClassName(msg.__class__)))
-
-  assert msg is not self
-  self._Modified()
-
-  fields = self._fields
-
-  for field, value in msg._fields.items():
-    if field.label == LABEL_REPEATED:
-      field_value = fields.get(field)
-      if field_value is None:
-        # Construct a new object to represent this field.
-        field_value = field._default_constructor(self)
-        fields[field] = field_value
-      field_value.MergeFrom(value)
-    elif field.cpp_type == CPPTYPE_MESSAGE:
-      if value._is_present_in_parent:
-        field_value = fields.get(field)
-        if field_value is None:
-          # Construct a new object to represent this field.
-          field_value = field._default_constructor(self)
-          fields[field] = field_value
-        field_value.MergeFrom(value)
-    else:
-      self._fields[field] = value
-      if field.containing_oneof:
-        self._UpdateOneofState(field)
-
-  if msg._unknown_fields:
-    if not self._unknown_fields:
-      self._unknown_fields = []
-    self._unknown_fields.extend(msg._unknown_fields)
-    # pylint: disable=protected-access
-    if self._unknown_field_set is None:
-      self._unknown_field_set = containers.UnknownFieldSet()
-    self._unknown_field_set._extend(msg._unknown_field_set)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.MergeFromString"><code class="name flex">
-<span>def <span class="ident">MergeFromString</span></span>(<span>self, serialized)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def MergeFromString(self, serialized):
-  serialized = memoryview(serialized)
-  length = len(serialized)
-  try:
-    if self._InternalParse(serialized, 0, length) != length:
-      # The only reason _InternalParse would return early is if it
-      # encountered an end-group tag.
-      raise message_mod.DecodeError(&#39;Unexpected end-group tag.&#39;)
-  except (IndexError, TypeError):
-    # Now ord(buf[p:p+1]) == ord(&#39;&#39;) gets TypeError.
-    raise message_mod.DecodeError(&#39;Truncated message.&#39;)
-  except struct.error as e:
-    raise message_mod.DecodeError(e)
-  return length   # Return this for legacy reasons.</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.SerializePartialToString"><code class="name flex">
-<span>def <span class="ident">SerializePartialToString</span></span>(<span>self, **kwargs)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def SerializePartialToString(self, **kwargs):
-  out = BytesIO()
-  self._InternalSerialize(out.write, **kwargs)
-  return out.getvalue()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.SerializeToString"><code class="name flex">
-<span>def <span class="ident">SerializeToString</span></span>(<span>self, **kwargs)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def SerializeToString(self, **kwargs):
-  # Check if the message has all of its required fields set.
-  if not self.IsInitialized():
-    raise message_mod.EncodeError(
-        &#39;Message %s is missing required fields: %s&#39; % (
-        self.DESCRIPTOR.full_name, &#39;,&#39;.join(self.FindInitializationErrors())))
-  return self.SerializePartialToString(**kwargs)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.SetInParent"><code class="name flex">
-<span>def <span class="ident">SetInParent</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Sets the _cached_byte_size_dirty bit to true,
-and propagates this to our listener iff this was a state change.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def Modified(self):
-  &#34;&#34;&#34;Sets the _cached_byte_size_dirty bit to true,
-  and propagates this to our listener iff this was a state change.
-  &#34;&#34;&#34;
-
-  # Note:  Some callers check _cached_byte_size_dirty before calling
-  #   _Modified() as an extra optimization.  So, if this method is ever
-  #   changed such that it does stuff even when _cached_byte_size_dirty is
-  #   already true, the callers need to be updated.
-  if not self._cached_byte_size_dirty:
-    self._cached_byte_size_dirty = True
-    self._listener_for_children.dirty = True
-    self._is_present_in_parent = True
-    self._listener.Modified()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.UnknownFields"><code class="name flex">
-<span>def <span class="ident">UnknownFields</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def _UnknownFields(self):
-  if self._unknown_field_set is None:  # pylint: disable=protected-access
-    # pylint: disable=protected-access
-    self._unknown_field_set = containers.UnknownFieldSet()
-  return self._unknown_field_set    # pylint: disable=protected-access</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.WhichOneof"><code class="name flex">
-<span>def <span class="ident">WhichOneof</span></span>(<span>self, oneof_name)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Returns the name of the currently set field inside a oneof, or None.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def WhichOneof(self, oneof_name):
-  &#34;&#34;&#34;Returns the name of the currently set field inside a oneof, or None.&#34;&#34;&#34;
-  try:
-    field = message_descriptor.oneofs_by_name[oneof_name]
-  except KeyError:
-    raise ValueError(
-        &#39;Protocol message has no oneof &#34;%s&#34; field.&#39; % oneof_name)
-
-  nested_field = self._oneofs.get(field, None)
-  if nested_field is not None and self.HasField(nested_field.name):
-    return nested_field.name
-  else:
-    return None</code></pre>
-</details>
-</dd>
-</dl>
-</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.environmental_measurement_pb2.EnvironmentalMeasurement" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement">EnvironmentalMeasurement</a></code></h4>
-<ul class="">
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.BAROMETRIC_PRESSURE_FIELD_NUMBER" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.BAROMETRIC_PRESSURE_FIELD_NUMBER">BAROMETRIC_PRESSURE_FIELD_NUMBER</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.ByteSize" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.ByteSize">ByteSize</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.Clear" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.Clear">Clear</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.ClearField" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.ClearField">ClearField</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.DESCRIPTOR" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.DESCRIPTOR">DESCRIPTOR</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.DiscardUnknownFields" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.DiscardUnknownFields">DiscardUnknownFields</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.FindInitializationErrors" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.FindInitializationErrors">FindInitializationErrors</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.FromString" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.FromString">FromString</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.HasField" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.HasField">HasField</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.IsInitialized" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.IsInitialized">IsInitialized</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.ListFields" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.ListFields">ListFields</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.MergeFrom" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.MergeFrom">MergeFrom</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.MergeFromString" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.MergeFromString">MergeFromString</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.RELATIVE_HUMIDITY_FIELD_NUMBER" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.RELATIVE_HUMIDITY_FIELD_NUMBER">RELATIVE_HUMIDITY_FIELD_NUMBER</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.RegisterExtension" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.RegisterExtension">RegisterExtension</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.SerializePartialToString" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.SerializePartialToString">SerializePartialToString</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.SerializeToString" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.SerializeToString">SerializeToString</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.SetInParent" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.SetInParent">SetInParent</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.TEMPERATURE_FIELD_NUMBER" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.TEMPERATURE_FIELD_NUMBER">TEMPERATURE_FIELD_NUMBER</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.UnknownFields" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.UnknownFields">UnknownFields</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.WhichOneof" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.WhichOneof">WhichOneof</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.barometric_pressure" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.barometric_pressure">barometric_pressure</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.relative_humidity" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.relative_humidity">relative_humidity</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.temperature" href="#meshtastic.environmental_measurement_pb2.EnvironmentalMeasurement.temperature">temperature</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>

docs/meshtastic/globals.html

@@ -1,380 +0,0 @@
-<!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.globals API documentation</title>
-<meta name="description" content="Globals singleton 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.globals</code></h1>
-</header>
-<section id="section-intro">
-<p>Globals singleton class.</p>
-<p>Instead of using a global, stuff your variables in this "trash can".
-This is not much better than using python's globals, but it allows
-us to better test meshtastic. Plus, there are some weird python
-global issues/gotcha that we can hopefully avoid by using this
-class instead.</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Globals singleton class.
-
-   Instead of using a global, stuff your variables in this &#34;trash can&#34;.
-   This is not much better than using python&#39;s globals, but it allows
-   us to better test meshtastic. Plus, there are some weird python
-   global issues/gotcha that we can hopefully avoid by using this
-   class instead.
-
-&#34;&#34;&#34;
-
-class Globals:
-    &#34;&#34;&#34;Globals class is a Singleton.&#34;&#34;&#34;
-    __instance = None
-
-    @staticmethod
-    def getInstance():
-        &#34;&#34;&#34;Get an instance of the Globals class.&#34;&#34;&#34;
-        if Globals.__instance is None:
-            Globals()
-        return Globals.__instance
-
-    def __init__(self):
-        &#34;&#34;&#34;Constructor for the Globals CLass&#34;&#34;&#34;
-        if Globals.__instance is not None:
-            raise Exception(&#34;This class is a singleton&#34;)
-        else:
-            Globals.__instance = self
-        self.args = None
-        self.parser = None
-        self.target_node = None
-        self.channel_index = None
-
-    def reset(self):
-        &#34;&#34;&#34;Reset all of our globals. If you add a member, add it to this method, too.&#34;&#34;&#34;
-        self.args = None
-        self.parser = None
-        self.target_node = None
-        self.channel_index = None
-
-    def set_args(self, args):
-        &#34;&#34;&#34;Set the args&#34;&#34;&#34;
-        self.args = args
-
-    def set_parser(self, parser):
-        &#34;&#34;&#34;Set the parser&#34;&#34;&#34;
-        self.parser = parser
-
-    def set_target_node(self, target_node):
-        &#34;&#34;&#34;Set the target_node&#34;&#34;&#34;
-        self.target_node = target_node
-
-    def set_channel_index(self, channel_index):
-        &#34;&#34;&#34;Set the channel_index&#34;&#34;&#34;
-        self.channel_index = channel_index
-
-    def get_args(self):
-        &#34;&#34;&#34;Get args&#34;&#34;&#34;
-        return self.args
-
-    def get_parser(self):
-        &#34;&#34;&#34;Get parser&#34;&#34;&#34;
-        return self.parser
-
-    def get_target_node(self):
-        &#34;&#34;&#34;Get target_node&#34;&#34;&#34;
-        return self.target_node
-
-    def get_channel_index(self):
-        &#34;&#34;&#34;Get channel_index&#34;&#34;&#34;
-        return self.channel_index</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="meshtastic.globals.Globals"><code class="flex name class">
-<span>class <span class="ident">Globals</span></span>
-</code></dt>
-<dd>
-<div class="desc"><p>Globals class is a Singleton.</p>
-<p>Constructor for the Globals CLass</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class Globals:
-    &#34;&#34;&#34;Globals class is a Singleton.&#34;&#34;&#34;
-    __instance = None
-
-    @staticmethod
-    def getInstance():
-        &#34;&#34;&#34;Get an instance of the Globals class.&#34;&#34;&#34;
-        if Globals.__instance is None:
-            Globals()
-        return Globals.__instance
-
-    def __init__(self):
-        &#34;&#34;&#34;Constructor for the Globals CLass&#34;&#34;&#34;
-        if Globals.__instance is not None:
-            raise Exception(&#34;This class is a singleton&#34;)
-        else:
-            Globals.__instance = self
-        self.args = None
-        self.parser = None
-        self.target_node = None
-        self.channel_index = None
-
-    def reset(self):
-        &#34;&#34;&#34;Reset all of our globals. If you add a member, add it to this method, too.&#34;&#34;&#34;
-        self.args = None
-        self.parser = None
-        self.target_node = None
-        self.channel_index = None
-
-    def set_args(self, args):
-        &#34;&#34;&#34;Set the args&#34;&#34;&#34;
-        self.args = args
-
-    def set_parser(self, parser):
-        &#34;&#34;&#34;Set the parser&#34;&#34;&#34;
-        self.parser = parser
-
-    def set_target_node(self, target_node):
-        &#34;&#34;&#34;Set the target_node&#34;&#34;&#34;
-        self.target_node = target_node
-
-    def set_channel_index(self, channel_index):
-        &#34;&#34;&#34;Set the channel_index&#34;&#34;&#34;
-        self.channel_index = channel_index
-
-    def get_args(self):
-        &#34;&#34;&#34;Get args&#34;&#34;&#34;
-        return self.args
-
-    def get_parser(self):
-        &#34;&#34;&#34;Get parser&#34;&#34;&#34;
-        return self.parser
-
-    def get_target_node(self):
-        &#34;&#34;&#34;Get target_node&#34;&#34;&#34;
-        return self.target_node
-
-    def get_channel_index(self):
-        &#34;&#34;&#34;Get channel_index&#34;&#34;&#34;
-        return self.channel_index</code></pre>
-</details>
-<h3>Static methods</h3>
-<dl>
-<dt id="meshtastic.globals.Globals.getInstance"><code class="name flex">
-<span>def <span class="ident">getInstance</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Get an instance of the Globals class.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@staticmethod
-def getInstance():
-    &#34;&#34;&#34;Get an instance of the Globals class.&#34;&#34;&#34;
-    if Globals.__instance is None:
-        Globals()
-    return Globals.__instance</code></pre>
-</details>
-</dd>
-</dl>
-<h3>Methods</h3>
-<dl>
-<dt id="meshtastic.globals.Globals.get_args"><code class="name flex">
-<span>def <span class="ident">get_args</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Get args</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def get_args(self):
-    &#34;&#34;&#34;Get args&#34;&#34;&#34;
-    return self.args</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.globals.Globals.get_channel_index"><code class="name flex">
-<span>def <span class="ident">get_channel_index</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Get channel_index</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def get_channel_index(self):
-    &#34;&#34;&#34;Get channel_index&#34;&#34;&#34;
-    return self.channel_index</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.globals.Globals.get_parser"><code class="name flex">
-<span>def <span class="ident">get_parser</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Get parser</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def get_parser(self):
-    &#34;&#34;&#34;Get parser&#34;&#34;&#34;
-    return self.parser</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.globals.Globals.get_target_node"><code class="name flex">
-<span>def <span class="ident">get_target_node</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Get target_node</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def get_target_node(self):
-    &#34;&#34;&#34;Get target_node&#34;&#34;&#34;
-    return self.target_node</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.globals.Globals.reset"><code class="name flex">
-<span>def <span class="ident">reset</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Reset all of our globals. If you add a member, add it to this method, too.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def reset(self):
-    &#34;&#34;&#34;Reset all of our globals. If you add a member, add it to this method, too.&#34;&#34;&#34;
-    self.args = None
-    self.parser = None
-    self.target_node = None
-    self.channel_index = None</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.globals.Globals.set_args"><code class="name flex">
-<span>def <span class="ident">set_args</span></span>(<span>self, args)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Set the args</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def set_args(self, args):
-    &#34;&#34;&#34;Set the args&#34;&#34;&#34;
-    self.args = args</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.globals.Globals.set_channel_index"><code class="name flex">
-<span>def <span class="ident">set_channel_index</span></span>(<span>self, channel_index)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Set the channel_index</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def set_channel_index(self, channel_index):
-    &#34;&#34;&#34;Set the channel_index&#34;&#34;&#34;
-    self.channel_index = channel_index</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.globals.Globals.set_parser"><code class="name flex">
-<span>def <span class="ident">set_parser</span></span>(<span>self, parser)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Set the parser</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def set_parser(self, parser):
-    &#34;&#34;&#34;Set the parser&#34;&#34;&#34;
-    self.parser = parser</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.globals.Globals.set_target_node"><code class="name flex">
-<span>def <span class="ident">set_target_node</span></span>(<span>self, target_node)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Set the target_node</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def set_target_node(self, target_node):
-    &#34;&#34;&#34;Set the target_node&#34;&#34;&#34;
-    self.target_node = target_node</code></pre>
-</details>
-</dd>
-</dl>
-</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.globals.Globals" href="#meshtastic.globals.Globals">Globals</a></code></h4>
-<ul class="two-column">
-<li><code><a title="meshtastic.globals.Globals.getInstance" href="#meshtastic.globals.Globals.getInstance">getInstance</a></code></li>
-<li><code><a title="meshtastic.globals.Globals.get_args" href="#meshtastic.globals.Globals.get_args">get_args</a></code></li>
-<li><code><a title="meshtastic.globals.Globals.get_channel_index" href="#meshtastic.globals.Globals.get_channel_index">get_channel_index</a></code></li>
-<li><code><a title="meshtastic.globals.Globals.get_parser" href="#meshtastic.globals.Globals.get_parser">get_parser</a></code></li>
-<li><code><a title="meshtastic.globals.Globals.get_target_node" href="#meshtastic.globals.Globals.get_target_node">get_target_node</a></code></li>
-<li><code><a title="meshtastic.globals.Globals.reset" href="#meshtastic.globals.Globals.reset">reset</a></code></li>
-<li><code><a title="meshtastic.globals.Globals.set_args" href="#meshtastic.globals.Globals.set_args">set_args</a></code></li>
-<li><code><a title="meshtastic.globals.Globals.set_channel_index" href="#meshtastic.globals.Globals.set_channel_index">set_channel_index</a></code></li>
-<li><code><a title="meshtastic.globals.Globals.set_parser" href="#meshtastic.globals.Globals.set_parser">set_parser</a></code></li>
-<li><code><a title="meshtastic.globals.Globals.set_target_node" href="#meshtastic.globals.Globals.set_target_node">set_target_node</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>

docs/meshtastic/index.html

@@ -1,538 +0,0 @@
-<!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 API documentation</title>
-<meta name="description" content="an API for Meshtastic devices …" />
-<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">Package <code>meshtastic</code></h1>
-</header>
-<section id="section-intro">
-<h1 id="an-api-for-meshtastic-devices">an API for Meshtastic devices</h1>
-<p>Primary class: SerialInterface
-Install with pip: "<a href="https://pypi.org/project/meshtastic/">pip3 install meshtastic</a>"
-Source code on <a href="https://github.com/meshtastic/Meshtastic-python">github</a></p>
-<p>properties of SerialInterface:</p>
-<ul>
-<li>radioConfig - Current radio configuration and device settings, if you write to this the new settings will be applied to
-the device.</li>
-<li>nodes - The database of received nodes.
-Includes always up-to-date location and username information for each
-node in the mesh.
-This is a read-only datastructure.</li>
-<li>nodesByNum - like "nodes" but keyed by nodeNum instead of nodeId</li>
-<li>myInfo - Contains read-only information about the local radio device (software version, hardware version, etc)</li>
-</ul>
-<h1 id="published-pubsub-topics">Published PubSub topics</h1>
-<p>We use a <a href="https://pypubsub.readthedocs.io/en/v4.0.3/">publish-subscribe</a> model to communicate asynchronous events.
-Available
-topics:</p>
-<ul>
-<li>meshtastic.connection.established - published once we've successfully connected to the radio and downloaded the node DB</li>
-<li>meshtastic.connection.lost - published once we've lost our link to the radio</li>
-<li>meshtastic.receive.text(packet) - delivers a received packet as a dictionary, if you only care about a particular
-type of packet, you should subscribe to the full topic name.
-If you want to see all packets, simply subscribe to "meshtastic.receive".</li>
-<li>meshtastic.receive.position(packet)</li>
-<li>meshtastic.receive.user(packet)</li>
-<li>meshtastic.receive.data.portnum(packet) (where portnum is an integer or well known PortNum enum)</li>
-<li>meshtastic.node.updated(node = NodeInfo) - published when a node in the DB changes (appears, location changed, username changed, etc&hellip;)</li>
-</ul>
-<p>We receive position, user, or data packets from the mesh.
-You probably only care about meshtastic.receive.data.
-The first argument for
-that publish will be the packet.
-Text or binary data packets (from sendData or sendText) will both arrive this way.
-If you print packet
-you'll see the fields in the dictionary.
-decoded.data.payload will contain the raw bytes that were sent.
-If the packet was sent with
-sendText, decoded.data.text will <strong>also</strong> be populated with the decoded string.
-For ASCII these two strings will be the same, but for
-unicode scripts they can be different.</p>
-<h1 id="example-usage">Example Usage</h1>
-<pre><code>import meshtastic
-import meshtastic.serial_interface
-from pubsub import pub
-
-def onReceive(packet, interface): # called when a packet arrives
-    print(f&quot;Received: {packet}&quot;)
-
-def onConnection(interface, topic=pub.AUTO_TOPIC): # called when we (re)connect to the radio
-    # defaults to broadcast, specify a destination ID if you wish
-    interface.sendText(&quot;hello mesh&quot;)
-
-pub.subscribe(onReceive, &quot;meshtastic.receive&quot;)
-pub.subscribe(onConnection, &quot;meshtastic.connection.established&quot;)
-# By default will try to find a meshtastic device, otherwise provide a device path like /dev/ttyUSB0
-interface = meshtastic.serial_interface.SerialInterface()
-
-</code></pre>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;
-# an API for Meshtastic devices
-
-Primary class: SerialInterface
-Install with pip: &#34;[pip3 install meshtastic](https://pypi.org/project/meshtastic/)&#34;
-Source code on [github](https://github.com/meshtastic/Meshtastic-python)
-
-properties of SerialInterface:
-
-- radioConfig - Current radio configuration and device settings, if you write to this the new settings will be applied to
-the device.
-- nodes - The database of received nodes.  Includes always up-to-date location and username information for each
-node in the mesh.  This is a read-only datastructure.
-- nodesByNum - like &#34;nodes&#34; but keyed by nodeNum instead of nodeId
-- myInfo - Contains read-only information about the local radio device (software version, hardware version, etc)
-
-# Published PubSub topics
-
-We use a [publish-subscribe](https://pypubsub.readthedocs.io/en/v4.0.3/) model to communicate asynchronous events.  Available
-topics:
-
-- meshtastic.connection.established - published once we&#39;ve successfully connected to the radio and downloaded the node DB
-- meshtastic.connection.lost - published once we&#39;ve lost our link to the radio
-- meshtastic.receive.text(packet) - delivers a received packet as a dictionary, if you only care about a particular
-type of packet, you should subscribe to the full topic name.  If you want to see all packets, simply subscribe to &#34;meshtastic.receive&#34;.
-- meshtastic.receive.position(packet)
-- meshtastic.receive.user(packet)
-- meshtastic.receive.data.portnum(packet) (where portnum is an integer or well known PortNum enum)
-- meshtastic.node.updated(node = NodeInfo) - published when a node in the DB changes (appears, location changed, username changed, etc...)
-
-We receive position, user, or data packets from the mesh.  You probably only care about meshtastic.receive.data.  The first argument for
-that publish will be the packet.  Text or binary data packets (from sendData or sendText) will both arrive this way.  If you print packet
-you&#39;ll see the fields in the dictionary.  decoded.data.payload will contain the raw bytes that were sent.  If the packet was sent with
-sendText, decoded.data.text will **also** be populated with the decoded string.  For ASCII these two strings will be the same, but for
-unicode scripts they can be different.
-
-# Example Usage
-```
-import meshtastic
-import meshtastic.serial_interface
-from pubsub import pub
-
-def onReceive(packet, interface): # called when a packet arrives
-    print(f&#34;Received: {packet}&#34;)
-
-def onConnection(interface, topic=pub.AUTO_TOPIC): # called when we (re)connect to the radio
-    # defaults to broadcast, specify a destination ID if you wish
-    interface.sendText(&#34;hello mesh&#34;)
-
-pub.subscribe(onReceive, &#34;meshtastic.receive&#34;)
-pub.subscribe(onConnection, &#34;meshtastic.connection.established&#34;)
-# By default will try to find a meshtastic device, otherwise provide a device path like /dev/ttyUSB0
-interface = meshtastic.serial_interface.SerialInterface()
-
-```
-
-&#34;&#34;&#34;
-
-import base64
-import logging
-import os
-import platform
-import random
-import socket
-import sys
-import stat
-import threading
-import traceback
-import time
-from datetime import datetime
-from typing import *
-import serial
-import timeago
-import google.protobuf.json_format
-import pygatt
-from pubsub import pub
-from dotmap import DotMap
-from tabulate import tabulate
-from google.protobuf.json_format import MessageToJson
-from .util import fixme, catchAndIgnore, stripnl, DeferredExecution, Timeout
-from .node import Node
-from . import mesh_pb2, portnums_pb2, apponly_pb2, admin_pb2, environmental_measurement_pb2, remote_hardware_pb2, channel_pb2, radioconfig_pb2, util
-
-# Note: To follow PEP224, comments should be after the module variable.
-
-LOCAL_ADDR = &#34;^local&#34;
-&#34;&#34;&#34;A special ID that means the local node&#34;&#34;&#34;
-
-BROADCAST_NUM = 0xffffffff
-&#34;&#34;&#34;if using 8 bit nodenums this will be shortend on the target&#34;&#34;&#34;
-
-BROADCAST_ADDR = &#34;^all&#34;
-&#34;&#34;&#34;A special ID that means broadcast&#34;&#34;&#34;
-
-OUR_APP_VERSION = 20200
-&#34;&#34;&#34;The numeric buildnumber (shared with android apps) specifying the
-   level of device code we are guaranteed to understand
-
-   format is Mmmss (where M is 1+the numeric major number. i.e. 20120 means 1.1.20
-&#34;&#34;&#34;
-
-publishingThread = DeferredExecution(&#34;publishing&#34;)
-
-
-class ResponseHandler(NamedTuple):
-    &#34;&#34;&#34;A pending response callback, waiting for a response to one of our messages&#34;&#34;&#34;
-    # requestId: int - used only as a key
-    callback: Callable
-    # FIXME, add timestamp and age out old requests
-
-
-class KnownProtocol(NamedTuple):
-    &#34;&#34;&#34;Used to automatically decode known protocol payloads&#34;&#34;&#34;
-    name: str
-    # portnum: int, now a key
-    # If set, will be called to prase as a protocol buffer
-    protobufFactory: Callable = None
-    # If set, invoked as onReceive(interface, packet)
-    onReceive: Callable = None
-
-
-def _onTextReceive(iface, asDict):
-    &#34;&#34;&#34;Special text auto parsing for received messages&#34;&#34;&#34;
-    # We don&#39;t throw if the utf8 is invalid in the text message.  Instead we just don&#39;t populate
-    # the decoded.data.text and we log an error message.  This at least allows some delivery to
-    # the app and the app can deal with the missing decoded representation.
-    #
-    # Usually btw this problem is caused by apps sending binary data but setting the payload type to
-    # text.
-    try:
-        asBytes = asDict[&#34;decoded&#34;][&#34;payload&#34;]
-        asDict[&#34;decoded&#34;][&#34;text&#34;] = asBytes.decode(&#34;utf-8&#34;)
-    except Exception as ex:
-        logging.error(f&#34;Malformatted utf8 in text message: {ex}&#34;)
-    _receiveInfoUpdate(iface, asDict)
-
-
-def _onPositionReceive(iface, asDict):
-    &#34;&#34;&#34;Special auto parsing for received messages&#34;&#34;&#34;
-    p = asDict[&#34;decoded&#34;][&#34;position&#34;]
-    iface._fixupPosition(p)
-    # update node DB as needed
-    iface._getOrCreateByNum(asDict[&#34;from&#34;])[&#34;position&#34;] = p
-
-
-def _onNodeInfoReceive(iface, asDict):
-    &#34;&#34;&#34;Special auto parsing for received messages&#34;&#34;&#34;
-    p = asDict[&#34;decoded&#34;][&#34;user&#34;]
-    # decode user protobufs and update nodedb, provide decoded version as &#34;position&#34; in the published msg
-    # update node DB as needed
-    n = iface._getOrCreateByNum(asDict[&#34;from&#34;])
-    n[&#34;user&#34;] = p
-    # We now have a node ID, make sure it is uptodate in that table
-    iface.nodes[p[&#34;id&#34;]] = n
-    _receiveInfoUpdate(iface, asDict)
-
-
-def _receiveInfoUpdate(iface, asDict):
-    if &#34;from&#34; in asDict:
-        iface._getOrCreateByNum(asDict[&#34;from&#34;])[&#34;lastReceived&#34;] = asDict
-        iface._getOrCreateByNum(asDict[&#34;from&#34;])[&#34;lastHeard&#34;] = asDict.get(&#34;rxTime&#34;)
-        iface._getOrCreateByNum(asDict[&#34;from&#34;])[&#34;snr&#34;] = asDict.get(&#34;rxSnr&#34;)
-        iface._getOrCreateByNum(asDict[&#34;from&#34;])[&#34;hopLimit&#34;] = asDict.get(&#34;hopLimit&#34;)
-
-
-&#34;&#34;&#34;Well known message payloads can register decoders for automatic protobuf parsing&#34;&#34;&#34;
-protocols = {
-    portnums_pb2.PortNum.TEXT_MESSAGE_APP: KnownProtocol(&#34;text&#34;, onReceive=_onTextReceive),
-    portnums_pb2.PortNum.POSITION_APP: KnownProtocol(&#34;position&#34;, mesh_pb2.Position, _onPositionReceive),
-    portnums_pb2.PortNum.NODEINFO_APP: KnownProtocol(&#34;user&#34;, mesh_pb2.User, _onNodeInfoReceive),
-    portnums_pb2.PortNum.ADMIN_APP: KnownProtocol(&#34;admin&#34;, admin_pb2.AdminMessage),
-    portnums_pb2.PortNum.ROUTING_APP: KnownProtocol(&#34;routing&#34;, mesh_pb2.Routing),
-    portnums_pb2.PortNum.ENVIRONMENTAL_MEASUREMENT_APP: KnownProtocol(&#34;environmental&#34;, environmental_measurement_pb2.EnvironmentalMeasurement),
-    portnums_pb2.PortNum.REMOTE_HARDWARE_APP: KnownProtocol(
-        &#34;remotehw&#34;, remote_hardware_pb2.HardwareMessage)
-}</code></pre>
-</details>
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="meshtastic.admin_pb2" href="admin_pb2.html">meshtastic.admin_pb2</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.apponly_pb2" href="apponly_pb2.html">meshtastic.apponly_pb2</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.ble" href="ble.html">meshtastic.ble</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.ble_interface" href="ble_interface.html">meshtastic.ble_interface</a></code></dt>
-<dd>
-<div class="desc"><p>Bluetooth interface</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.channel_pb2" href="channel_pb2.html">meshtastic.channel_pb2</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.deviceonly_pb2" href="deviceonly_pb2.html">meshtastic.deviceonly_pb2</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.environmental_measurement_pb2" href="environmental_measurement_pb2.html">meshtastic.environmental_measurement_pb2</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.globals" href="globals.html">meshtastic.globals</a></code></dt>
-<dd>
-<div class="desc"><p>Globals singleton class …</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.mesh_interface" href="mesh_interface.html">meshtastic.mesh_interface</a></code></dt>
-<dd>
-<div class="desc"><p>Mesh Interface class</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.mesh_pb2" href="mesh_pb2.html">meshtastic.mesh_pb2</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.mqtt_pb2" href="mqtt_pb2.html">meshtastic.mqtt_pb2</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.node" href="node.html">meshtastic.node</a></code></dt>
-<dd>
-<div class="desc"><p>Node class</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.portnums_pb2" href="portnums_pb2.html">meshtastic.portnums_pb2</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.radioconfig_pb2" href="radioconfig_pb2.html">meshtastic.radioconfig_pb2</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.remote_hardware" href="remote_hardware.html">meshtastic.remote_hardware</a></code></dt>
-<dd>
-<div class="desc"><p>Remote hardware</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.remote_hardware_pb2" href="remote_hardware_pb2.html">meshtastic.remote_hardware_pb2</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.serial_interface" href="serial_interface.html">meshtastic.serial_interface</a></code></dt>
-<dd>
-<div class="desc"><p>Serial interface class</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.storeforward_pb2" href="storeforward_pb2.html">meshtastic.storeforward_pb2</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.stream_interface" href="stream_interface.html">meshtastic.stream_interface</a></code></dt>
-<dd>
-<div class="desc"><p>Stream Interface base class</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.tcp_interface" href="tcp_interface.html">meshtastic.tcp_interface</a></code></dt>
-<dd>
-<div class="desc"><p>TCPInterface class for interfacing with http endpoint</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.test" href="test.html">meshtastic.test</a></code></dt>
-<dd>
-<div class="desc"><p>With two radios connected serially, send and receive test
-messages and report back if successful.</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.tests" href="tests/index.html">meshtastic.tests</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.tunnel" href="tunnel.html">meshtastic.tunnel</a></code></dt>
-<dd>
-<div class="desc"><p>Code for IP tunnel over a mesh …</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.util" href="util.html">meshtastic.util</a></code></dt>
-<dd>
-<div class="desc"><p>Utility functions.</p></div>
-</dd>
-</dl>
-</section>
-<section>
-<h2 class="section-title" id="header-variables">Global variables</h2>
-<dl>
-<dt id="meshtastic.BROADCAST_ADDR"><code class="name">var <span class="ident">BROADCAST_ADDR</span></code></dt>
-<dd>
-<div class="desc"><p>A special ID that means broadcast</p></div>
-</dd>
-<dt id="meshtastic.BROADCAST_NUM"><code class="name">var <span class="ident">BROADCAST_NUM</span></code></dt>
-<dd>
-<div class="desc"><p>if using 8 bit nodenums this will be shortend on the target</p></div>
-</dd>
-<dt id="meshtastic.LOCAL_ADDR"><code class="name">var <span class="ident">LOCAL_ADDR</span></code></dt>
-<dd>
-<div class="desc"><p>A special ID that means the local node</p></div>
-</dd>
-<dt id="meshtastic.OUR_APP_VERSION"><code class="name">var <span class="ident">OUR_APP_VERSION</span></code></dt>
-<dd>
-<div class="desc"><p>The numeric buildnumber (shared with android apps) specifying the
-level of device code we are guaranteed to understand</p>
-<p>format is Mmmss (where M is 1+the numeric major number. i.e. 20120 means 1.1.20</p></div>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="meshtastic.KnownProtocol"><code class="flex name class">
-<span>class <span class="ident">KnownProtocol</span></span>
-<span>(</span><span>name: str, protobufFactory: Callable = None, onReceive: Callable = None)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Used to automatically decode known protocol payloads</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class KnownProtocol(NamedTuple):
-    &#34;&#34;&#34;Used to automatically decode known protocol payloads&#34;&#34;&#34;
-    name: str
-    # portnum: int, now a key
-    # If set, will be called to prase as a protocol buffer
-    protobufFactory: Callable = None
-    # If set, invoked as onReceive(interface, packet)
-    onReceive: Callable = None</code></pre>
-</details>
-<h3>Ancestors</h3>
-<ul class="hlist">
-<li>builtins.tuple</li>
-</ul>
-<h3>Instance variables</h3>
-<dl>
-<dt id="meshtastic.KnownProtocol.name"><code class="name">var <span class="ident">name</span> : str</code></dt>
-<dd>
-<div class="desc"><p>Alias for field number 0</p></div>
-</dd>
-<dt id="meshtastic.KnownProtocol.onReceive"><code class="name">var <span class="ident">onReceive</span> : Callable</code></dt>
-<dd>
-<div class="desc"><p>Alias for field number 2</p></div>
-</dd>
-<dt id="meshtastic.KnownProtocol.protobufFactory"><code class="name">var <span class="ident">protobufFactory</span> : Callable</code></dt>
-<dd>
-<div class="desc"><p>Alias for field number 1</p></div>
-</dd>
-</dl>
-</dd>
-<dt id="meshtastic.ResponseHandler"><code class="flex name class">
-<span>class <span class="ident">ResponseHandler</span></span>
-<span>(</span><span>callback: Callable)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>A pending response callback, waiting for a response to one of our messages</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class ResponseHandler(NamedTuple):
-    &#34;&#34;&#34;A pending response callback, waiting for a response to one of our messages&#34;&#34;&#34;
-    # requestId: int - used only as a key
-    callback: Callable
-    # FIXME, add timestamp and age out old requests</code></pre>
-</details>
-<h3>Ancestors</h3>
-<ul class="hlist">
-<li>builtins.tuple</li>
-</ul>
-<h3>Instance variables</h3>
-<dl>
-<dt id="meshtastic.ResponseHandler.callback"><code class="name">var <span class="ident">callback</span> : Callable</code></dt>
-<dd>
-<div class="desc"><p>Alias for field number 0</p></div>
-</dd>
-</dl>
-</dd>
-</dl>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul>
-<li><a href="#an-api-for-meshtastic-devices">an API for Meshtastic devices</a></li>
-<li><a href="#published-pubsub-topics">Published PubSub topics</a></li>
-<li><a href="#example-usage">Example Usage</a></li>
-</ul>
-</div>
-<ul id="index">
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="meshtastic.admin_pb2" href="admin_pb2.html">meshtastic.admin_pb2</a></code></li>
-<li><code><a title="meshtastic.apponly_pb2" href="apponly_pb2.html">meshtastic.apponly_pb2</a></code></li>
-<li><code><a title="meshtastic.ble" href="ble.html">meshtastic.ble</a></code></li>
-<li><code><a title="meshtastic.ble_interface" href="ble_interface.html">meshtastic.ble_interface</a></code></li>
-<li><code><a title="meshtastic.channel_pb2" href="channel_pb2.html">meshtastic.channel_pb2</a></code></li>
-<li><code><a title="meshtastic.deviceonly_pb2" href="deviceonly_pb2.html">meshtastic.deviceonly_pb2</a></code></li>
-<li><code><a title="meshtastic.environmental_measurement_pb2" href="environmental_measurement_pb2.html">meshtastic.environmental_measurement_pb2</a></code></li>
-<li><code><a title="meshtastic.globals" href="globals.html">meshtastic.globals</a></code></li>
-<li><code><a title="meshtastic.mesh_interface" href="mesh_interface.html">meshtastic.mesh_interface</a></code></li>
-<li><code><a title="meshtastic.mesh_pb2" href="mesh_pb2.html">meshtastic.mesh_pb2</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2" href="mqtt_pb2.html">meshtastic.mqtt_pb2</a></code></li>
-<li><code><a title="meshtastic.node" href="node.html">meshtastic.node</a></code></li>
-<li><code><a title="meshtastic.portnums_pb2" href="portnums_pb2.html">meshtastic.portnums_pb2</a></code></li>
-<li><code><a title="meshtastic.radioconfig_pb2" href="radioconfig_pb2.html">meshtastic.radioconfig_pb2</a></code></li>
-<li><code><a title="meshtastic.remote_hardware" href="remote_hardware.html">meshtastic.remote_hardware</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2" href="remote_hardware_pb2.html">meshtastic.remote_hardware_pb2</a></code></li>
-<li><code><a title="meshtastic.serial_interface" href="serial_interface.html">meshtastic.serial_interface</a></code></li>
-<li><code><a title="meshtastic.storeforward_pb2" href="storeforward_pb2.html">meshtastic.storeforward_pb2</a></code></li>
-<li><code><a title="meshtastic.stream_interface" href="stream_interface.html">meshtastic.stream_interface</a></code></li>
-<li><code><a title="meshtastic.tcp_interface" href="tcp_interface.html">meshtastic.tcp_interface</a></code></li>
-<li><code><a title="meshtastic.test" href="test.html">meshtastic.test</a></code></li>
-<li><code><a title="meshtastic.tests" href="tests/index.html">meshtastic.tests</a></code></li>
-<li><code><a title="meshtastic.tunnel" href="tunnel.html">meshtastic.tunnel</a></code></li>
-<li><code><a title="meshtastic.util" href="util.html">meshtastic.util</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-variables">Global variables</a></h3>
-<ul class="">
-<li><code><a title="meshtastic.BROADCAST_ADDR" href="#meshtastic.BROADCAST_ADDR">BROADCAST_ADDR</a></code></li>
-<li><code><a title="meshtastic.BROADCAST_NUM" href="#meshtastic.BROADCAST_NUM">BROADCAST_NUM</a></code></li>
-<li><code><a title="meshtastic.LOCAL_ADDR" href="#meshtastic.LOCAL_ADDR">LOCAL_ADDR</a></code></li>
-<li><code><a title="meshtastic.OUR_APP_VERSION" href="#meshtastic.OUR_APP_VERSION">OUR_APP_VERSION</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="meshtastic.KnownProtocol" href="#meshtastic.KnownProtocol">KnownProtocol</a></code></h4>
-<ul class="">
-<li><code><a title="meshtastic.KnownProtocol.name" href="#meshtastic.KnownProtocol.name">name</a></code></li>
-<li><code><a title="meshtastic.KnownProtocol.onReceive" href="#meshtastic.KnownProtocol.onReceive">onReceive</a></code></li>
-<li><code><a title="meshtastic.KnownProtocol.protobufFactory" href="#meshtastic.KnownProtocol.protobufFactory">protobufFactory</a></code></li>
-</ul>
-</li>
-<li>
-<h4><code><a title="meshtastic.ResponseHandler" href="#meshtastic.ResponseHandler">ResponseHandler</a></code></h4>
-<ul class="">
-<li><code><a title="meshtastic.ResponseHandler.callback" href="#meshtastic.ResponseHandler.callback">callback</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>

docs/meshtastic/mqtt_pb2.html

@@ -1,759 +0,0 @@
-<!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.mqtt_pb2 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.mqtt_pb2</code></h1>
-</header>
-<section id="section-intro">
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python"># -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: mqtt.proto
-
-from google.protobuf import descriptor as _descriptor
-from google.protobuf import message as _message
-from google.protobuf import reflection as _reflection
-from google.protobuf import symbol_database as _symbol_database
-# @@protoc_insertion_point(imports)
-
-_sym_db = _symbol_database.Default()
-
-
-from . import mesh_pb2 as mesh__pb2
-
-
-DESCRIPTOR = _descriptor.FileDescriptor(
-  name=&#39;mqtt.proto&#39;,
-  package=&#39;&#39;,
-  syntax=&#39;proto3&#39;,
-  serialized_options=b&#39;\n\023com.geeksville.meshB\nMQTTProtosH\003Z!github.com/meshtastic/gomeshproto&#39;,
-  serialized_pb=b&#39;\n\nmqtt.proto\x1a\nmesh.proto\&#34;V\n\x0fServiceEnvelope\x12\x1b\n\x06packet\x18\x01 \x01(\x0b\x32\x0b.MeshPacket\x12\x12\n\nchannel_id\x18\x02 \x01(\t\x12\x12\n\ngateway_id\x18\x03 \x01(\tBF\n\x13\x63om.geeksville.meshB\nMQTTProtosH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3&#39;
-  ,
-  dependencies=[mesh__pb2.DESCRIPTOR,])
-
-
-
-
-_SERVICEENVELOPE = _descriptor.Descriptor(
-  name=&#39;ServiceEnvelope&#39;,
-  full_name=&#39;ServiceEnvelope&#39;,
-  filename=None,
-  file=DESCRIPTOR,
-  containing_type=None,
-  fields=[
-    _descriptor.FieldDescriptor(
-      name=&#39;packet&#39;, full_name=&#39;ServiceEnvelope.packet&#39;, index=0,
-      number=1, type=11, cpp_type=10, label=1,
-      has_default_value=False, default_value=None,
-      message_type=None, enum_type=None, containing_type=None,
-      is_extension=False, extension_scope=None,
-      serialized_options=None, file=DESCRIPTOR),
-    _descriptor.FieldDescriptor(
-      name=&#39;channel_id&#39;, full_name=&#39;ServiceEnvelope.channel_id&#39;, index=1,
-      number=2, type=9, cpp_type=9, label=1,
-      has_default_value=False, default_value=b&#34;&#34;.decode(&#39;utf-8&#39;),
-      message_type=None, enum_type=None, containing_type=None,
-      is_extension=False, extension_scope=None,
-      serialized_options=None, file=DESCRIPTOR),
-    _descriptor.FieldDescriptor(
-      name=&#39;gateway_id&#39;, full_name=&#39;ServiceEnvelope.gateway_id&#39;, index=2,
-      number=3, type=9, cpp_type=9, label=1,
-      has_default_value=False, default_value=b&#34;&#34;.decode(&#39;utf-8&#39;),
-      message_type=None, enum_type=None, containing_type=None,
-      is_extension=False, extension_scope=None,
-      serialized_options=None, file=DESCRIPTOR),
-  ],
-  extensions=[
-  ],
-  nested_types=[],
-  enum_types=[
-  ],
-  serialized_options=None,
-  is_extendable=False,
-  syntax=&#39;proto3&#39;,
-  extension_ranges=[],
-  oneofs=[
-  ],
-  serialized_start=26,
-  serialized_end=112,
-)
-
-_SERVICEENVELOPE.fields_by_name[&#39;packet&#39;].message_type = mesh__pb2._MESHPACKET
-DESCRIPTOR.message_types_by_name[&#39;ServiceEnvelope&#39;] = _SERVICEENVELOPE
-_sym_db.RegisterFileDescriptor(DESCRIPTOR)
-
-ServiceEnvelope = _reflection.GeneratedProtocolMessageType(&#39;ServiceEnvelope&#39;, (_message.Message,), {
-  &#39;DESCRIPTOR&#39; : _SERVICEENVELOPE,
-  &#39;__module__&#39; : &#39;mqtt_pb2&#39;
-  # @@protoc_insertion_point(class_scope:ServiceEnvelope)
-  })
-_sym_db.RegisterMessage(ServiceEnvelope)
-
-
-DESCRIPTOR._options = None
-# @@protoc_insertion_point(module_scope)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope"><code class="flex name class">
-<span>class <span class="ident">ServiceEnvelope</span></span>
-<span>(</span><span>**kwargs)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Abstract base class for protocol messages.</p>
-<p>Protocol message classes are almost always generated by the protocol
-compiler.
-These generated types subclass Message and implement the methods
-shown below.</p></div>
-<h3>Ancestors</h3>
-<ul class="hlist">
-<li>google.protobuf.message.Message</li>
-</ul>
-<h3>Class variables</h3>
-<dl>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.CHANNEL_ID_FIELD_NUMBER"><code class="name">var <span class="ident">CHANNEL_ID_FIELD_NUMBER</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.DESCRIPTOR"><code class="name">var <span class="ident">DESCRIPTOR</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.GATEWAY_ID_FIELD_NUMBER"><code class="name">var <span class="ident">GATEWAY_ID_FIELD_NUMBER</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.PACKET_FIELD_NUMBER"><code class="name">var <span class="ident">PACKET_FIELD_NUMBER</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-</dl>
-<h3>Static methods</h3>
-<dl>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.FromString"><code class="name flex">
-<span>def <span class="ident">FromString</span></span>(<span>s)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def FromString(s):
-  message = cls()
-  message.MergeFromString(s)
-  return message</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.RegisterExtension"><code class="name flex">
-<span>def <span class="ident">RegisterExtension</span></span>(<span>extension_handle)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def RegisterExtension(extension_handle):
-  extension_handle.containing_type = cls.DESCRIPTOR
-  # TODO(amauryfa): Use cls.MESSAGE_FACTORY.pool when available.
-  # pylint: disable=protected-access
-  cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(extension_handle)
-  _AttachFieldHelpers(cls, extension_handle)</code></pre>
-</details>
-</dd>
-</dl>
-<h3>Instance variables</h3>
-<dl>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.channel_id"><code class="name">var <span class="ident">channel_id</span></code></dt>
-<dd>
-<div class="desc"><p>Getter for channel_id.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def getter(self):
-  # TODO(protobuf-team): This may be broken since there may not be
-  # default_value.  Combine with has_default_value somehow.
-  return self._fields.get(field, default_value)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.gateway_id"><code class="name">var <span class="ident">gateway_id</span></code></dt>
-<dd>
-<div class="desc"><p>Getter for gateway_id.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def getter(self):
-  # TODO(protobuf-team): This may be broken since there may not be
-  # default_value.  Combine with has_default_value somehow.
-  return self._fields.get(field, default_value)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.packet"><code class="name">var <span class="ident">packet</span></code></dt>
-<dd>
-<div class="desc"><p>Getter for packet.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def getter(self):
-  field_value = self._fields.get(field)
-  if field_value is None:
-    # Construct a new object to represent this field.
-    field_value = field._default_constructor(self)
-
-    # Atomically check if another thread has preempted us and, if not, swap
-    # in the new object we just created.  If someone has preempted us, we
-    # take that object and discard ours.
-    # WARNING:  We are relying on setdefault() being atomic.  This is true
-    #   in CPython but we haven&#39;t investigated others.  This warning appears
-    #   in several other locations in this file.
-    field_value = self._fields.setdefault(field, field_value)
-  return field_value</code></pre>
-</details>
-</dd>
-</dl>
-<h3>Methods</h3>
-<dl>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.ByteSize"><code class="name flex">
-<span>def <span class="ident">ByteSize</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def ByteSize(self):
-  if not self._cached_byte_size_dirty:
-    return self._cached_byte_size
-
-  size = 0
-  descriptor = self.DESCRIPTOR
-  if descriptor.GetOptions().map_entry:
-    # Fields of map entry should always be serialized.
-    size = descriptor.fields_by_name[&#39;key&#39;]._sizer(self.key)
-    size += descriptor.fields_by_name[&#39;value&#39;]._sizer(self.value)
-  else:
-    for field_descriptor, field_value in self.ListFields():
-      size += field_descriptor._sizer(field_value)
-    for tag_bytes, value_bytes in self._unknown_fields:
-      size += len(tag_bytes) + len(value_bytes)
-
-  self._cached_byte_size = size
-  self._cached_byte_size_dirty = False
-  self._listener_for_children.dirty = False
-  return size</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.Clear"><code class="name flex">
-<span>def <span class="ident">Clear</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def _Clear(self):
-  # Clear fields.
-  self._fields = {}
-  self._unknown_fields = ()
-  # pylint: disable=protected-access
-  if self._unknown_field_set is not None:
-    self._unknown_field_set._clear()
-    self._unknown_field_set = None
-
-  self._oneofs = {}
-  self._Modified()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.ClearField"><code class="name flex">
-<span>def <span class="ident">ClearField</span></span>(<span>self, field_name)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def ClearField(self, field_name):
-  try:
-    field = message_descriptor.fields_by_name[field_name]
-  except KeyError:
-    try:
-      field = message_descriptor.oneofs_by_name[field_name]
-      if field in self._oneofs:
-        field = self._oneofs[field]
-      else:
-        return
-    except KeyError:
-      raise ValueError(&#39;Protocol message %s has no &#34;%s&#34; field.&#39; %
-                       (message_descriptor.name, field_name))
-
-  if field in self._fields:
-    # To match the C++ implementation, we need to invalidate iterators
-    # for map fields when ClearField() happens.
-    if hasattr(self._fields[field], &#39;InvalidateIterators&#39;):
-      self._fields[field].InvalidateIterators()
-
-    # Note:  If the field is a sub-message, its listener will still point
-    #   at us.  That&#39;s fine, because the worst than can happen is that it
-    #   will call _Modified() and invalidate our byte size.  Big deal.
-    del self._fields[field]
-
-    if self._oneofs.get(field.containing_oneof, None) is field:
-      del self._oneofs[field.containing_oneof]
-
-  # Always call _Modified() -- even if nothing was changed, this is
-  # a mutating method, and thus calling it should cause the field to become
-  # present in the parent message.
-  self._Modified()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.DiscardUnknownFields"><code class="name flex">
-<span>def <span class="ident">DiscardUnknownFields</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def _DiscardUnknownFields(self):
-  self._unknown_fields = []
-  self._unknown_field_set = None      # pylint: disable=protected-access
-  for field, value in self.ListFields():
-    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
-      if _IsMapField(field):
-        if _IsMessageMapField(field):
-          for key in value:
-            value[key].DiscardUnknownFields()
-      elif field.label == _FieldDescriptor.LABEL_REPEATED:
-        for sub_message in value:
-          sub_message.DiscardUnknownFields()
-      else:
-        value.DiscardUnknownFields()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.FindInitializationErrors"><code class="name flex">
-<span>def <span class="ident">FindInitializationErrors</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Finds required fields which are not initialized.</p>
-<h2 id="returns">Returns</h2>
-<p>A list of strings.
-Each string is a path to an uninitialized field from
-the top-level message, e.g. "foo.bar[5].baz".</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def FindInitializationErrors(self):
-  &#34;&#34;&#34;Finds required fields which are not initialized.
-
-  Returns:
-    A list of strings.  Each string is a path to an uninitialized field from
-    the top-level message, e.g. &#34;foo.bar[5].baz&#34;.
-  &#34;&#34;&#34;
-
-  errors = []  # simplify things
-
-  for field in required_fields:
-    if not self.HasField(field.name):
-      errors.append(field.name)
-
-  for field, value in self.ListFields():
-    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
-      if field.is_extension:
-        name = &#39;(%s)&#39; % field.full_name
-      else:
-        name = field.name
-
-      if _IsMapField(field):
-        if _IsMessageMapField(field):
-          for key in value:
-            element = value[key]
-            prefix = &#39;%s[%s].&#39; % (name, key)
-            sub_errors = element.FindInitializationErrors()
-            errors += [prefix + error for error in sub_errors]
-        else:
-          # ScalarMaps can&#39;t have any initialization errors.
-          pass
-      elif field.label == _FieldDescriptor.LABEL_REPEATED:
-        for i in range(len(value)):
-          element = value[i]
-          prefix = &#39;%s[%d].&#39; % (name, i)
-          sub_errors = element.FindInitializationErrors()
-          errors += [prefix + error for error in sub_errors]
-      else:
-        prefix = name + &#39;.&#39;
-        sub_errors = value.FindInitializationErrors()
-        errors += [prefix + error for error in sub_errors]
-
-  return errors</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.HasField"><code class="name flex">
-<span>def <span class="ident">HasField</span></span>(<span>self, field_name)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def HasField(self, field_name):
-  try:
-    field = hassable_fields[field_name]
-  except KeyError:
-    raise ValueError(error_msg % (message_descriptor.full_name, field_name))
-
-  if isinstance(field, descriptor_mod.OneofDescriptor):
-    try:
-      return HasField(self, self._oneofs[field].name)
-    except KeyError:
-      return False
-  else:
-    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
-      value = self._fields.get(field)
-      return value is not None and value._is_present_in_parent
-    else:
-      return field in self._fields</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.IsInitialized"><code class="name flex">
-<span>def <span class="ident">IsInitialized</span></span>(<span>self, errors=None)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Checks if all required fields of a message are set.</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>errors</code></strong></dt>
-<dd>A list which, if provided, will be populated with the field
-paths of all missing required fields.</dd>
-</dl>
-<h2 id="returns">Returns</h2>
-<p>True iff the specified message has all required fields set.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def IsInitialized(self, errors=None):
-  &#34;&#34;&#34;Checks if all required fields of a message are set.
-
-  Args:
-    errors:  A list which, if provided, will be populated with the field
-             paths of all missing required fields.
-
-  Returns:
-    True iff the specified message has all required fields set.
-  &#34;&#34;&#34;
-
-  # Performance is critical so we avoid HasField() and ListFields().
-
-  for field in required_fields:
-    if (field not in self._fields or
-        (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
-         not self._fields[field]._is_present_in_parent)):
-      if errors is not None:
-        errors.extend(self.FindInitializationErrors())
-      return False
-
-  for field, value in list(self._fields.items()):  # dict can change size!
-    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
-      if field.label == _FieldDescriptor.LABEL_REPEATED:
-        if (field.message_type.has_options and
-            field.message_type.GetOptions().map_entry):
-          continue
-        for element in value:
-          if not element.IsInitialized():
-            if errors is not None:
-              errors.extend(self.FindInitializationErrors())
-            return False
-      elif value._is_present_in_parent and not value.IsInitialized():
-        if errors is not None:
-          errors.extend(self.FindInitializationErrors())
-        return False
-
-  return True</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.ListFields"><code class="name flex">
-<span>def <span class="ident">ListFields</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def ListFields(self):
-  all_fields = [item for item in self._fields.items() if _IsPresent(item)]
-  all_fields.sort(key = lambda item: item[0].number)
-  return all_fields</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.MergeFrom"><code class="name flex">
-<span>def <span class="ident">MergeFrom</span></span>(<span>self, msg)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def MergeFrom(self, msg):
-  if not isinstance(msg, cls):
-    raise TypeError(
-        &#39;Parameter to MergeFrom() must be instance of same class: &#39;
-        &#39;expected %s got %s.&#39; % (_FullyQualifiedClassName(cls),
-                                 _FullyQualifiedClassName(msg.__class__)))
-
-  assert msg is not self
-  self._Modified()
-
-  fields = self._fields
-
-  for field, value in msg._fields.items():
-    if field.label == LABEL_REPEATED:
-      field_value = fields.get(field)
-      if field_value is None:
-        # Construct a new object to represent this field.
-        field_value = field._default_constructor(self)
-        fields[field] = field_value
-      field_value.MergeFrom(value)
-    elif field.cpp_type == CPPTYPE_MESSAGE:
-      if value._is_present_in_parent:
-        field_value = fields.get(field)
-        if field_value is None:
-          # Construct a new object to represent this field.
-          field_value = field._default_constructor(self)
-          fields[field] = field_value
-        field_value.MergeFrom(value)
-    else:
-      self._fields[field] = value
-      if field.containing_oneof:
-        self._UpdateOneofState(field)
-
-  if msg._unknown_fields:
-    if not self._unknown_fields:
-      self._unknown_fields = []
-    self._unknown_fields.extend(msg._unknown_fields)
-    # pylint: disable=protected-access
-    if self._unknown_field_set is None:
-      self._unknown_field_set = containers.UnknownFieldSet()
-    self._unknown_field_set._extend(msg._unknown_field_set)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.MergeFromString"><code class="name flex">
-<span>def <span class="ident">MergeFromString</span></span>(<span>self, serialized)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def MergeFromString(self, serialized):
-  serialized = memoryview(serialized)
-  length = len(serialized)
-  try:
-    if self._InternalParse(serialized, 0, length) != length:
-      # The only reason _InternalParse would return early is if it
-      # encountered an end-group tag.
-      raise message_mod.DecodeError(&#39;Unexpected end-group tag.&#39;)
-  except (IndexError, TypeError):
-    # Now ord(buf[p:p+1]) == ord(&#39;&#39;) gets TypeError.
-    raise message_mod.DecodeError(&#39;Truncated message.&#39;)
-  except struct.error as e:
-    raise message_mod.DecodeError(e)
-  return length   # Return this for legacy reasons.</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.SerializePartialToString"><code class="name flex">
-<span>def <span class="ident">SerializePartialToString</span></span>(<span>self, **kwargs)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def SerializePartialToString(self, **kwargs):
-  out = BytesIO()
-  self._InternalSerialize(out.write, **kwargs)
-  return out.getvalue()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.SerializeToString"><code class="name flex">
-<span>def <span class="ident">SerializeToString</span></span>(<span>self, **kwargs)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def SerializeToString(self, **kwargs):
-  # Check if the message has all of its required fields set.
-  if not self.IsInitialized():
-    raise message_mod.EncodeError(
-        &#39;Message %s is missing required fields: %s&#39; % (
-        self.DESCRIPTOR.full_name, &#39;,&#39;.join(self.FindInitializationErrors())))
-  return self.SerializePartialToString(**kwargs)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.SetInParent"><code class="name flex">
-<span>def <span class="ident">SetInParent</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Sets the _cached_byte_size_dirty bit to true,
-and propagates this to our listener iff this was a state change.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def Modified(self):
-  &#34;&#34;&#34;Sets the _cached_byte_size_dirty bit to true,
-  and propagates this to our listener iff this was a state change.
-  &#34;&#34;&#34;
-
-  # Note:  Some callers check _cached_byte_size_dirty before calling
-  #   _Modified() as an extra optimization.  So, if this method is ever
-  #   changed such that it does stuff even when _cached_byte_size_dirty is
-  #   already true, the callers need to be updated.
-  if not self._cached_byte_size_dirty:
-    self._cached_byte_size_dirty = True
-    self._listener_for_children.dirty = True
-    self._is_present_in_parent = True
-    self._listener.Modified()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.UnknownFields"><code class="name flex">
-<span>def <span class="ident">UnknownFields</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def _UnknownFields(self):
-  if self._unknown_field_set is None:  # pylint: disable=protected-access
-    # pylint: disable=protected-access
-    self._unknown_field_set = containers.UnknownFieldSet()
-  return self._unknown_field_set    # pylint: disable=protected-access</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.mqtt_pb2.ServiceEnvelope.WhichOneof"><code class="name flex">
-<span>def <span class="ident">WhichOneof</span></span>(<span>self, oneof_name)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Returns the name of the currently set field inside a oneof, or None.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def WhichOneof(self, oneof_name):
-  &#34;&#34;&#34;Returns the name of the currently set field inside a oneof, or None.&#34;&#34;&#34;
-  try:
-    field = message_descriptor.oneofs_by_name[oneof_name]
-  except KeyError:
-    raise ValueError(
-        &#39;Protocol message has no oneof &#34;%s&#34; field.&#39; % oneof_name)
-
-  nested_field = self._oneofs.get(field, None)
-  if nested_field is not None and self.HasField(nested_field.name):
-    return nested_field.name
-  else:
-    return None</code></pre>
-</details>
-</dd>
-</dl>
-</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.mqtt_pb2.ServiceEnvelope" href="#meshtastic.mqtt_pb2.ServiceEnvelope">ServiceEnvelope</a></code></h4>
-<ul class="">
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.ByteSize" href="#meshtastic.mqtt_pb2.ServiceEnvelope.ByteSize">ByteSize</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.CHANNEL_ID_FIELD_NUMBER" href="#meshtastic.mqtt_pb2.ServiceEnvelope.CHANNEL_ID_FIELD_NUMBER">CHANNEL_ID_FIELD_NUMBER</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.Clear" href="#meshtastic.mqtt_pb2.ServiceEnvelope.Clear">Clear</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.ClearField" href="#meshtastic.mqtt_pb2.ServiceEnvelope.ClearField">ClearField</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.DESCRIPTOR" href="#meshtastic.mqtt_pb2.ServiceEnvelope.DESCRIPTOR">DESCRIPTOR</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.DiscardUnknownFields" href="#meshtastic.mqtt_pb2.ServiceEnvelope.DiscardUnknownFields">DiscardUnknownFields</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.FindInitializationErrors" href="#meshtastic.mqtt_pb2.ServiceEnvelope.FindInitializationErrors">FindInitializationErrors</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.FromString" href="#meshtastic.mqtt_pb2.ServiceEnvelope.FromString">FromString</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.GATEWAY_ID_FIELD_NUMBER" href="#meshtastic.mqtt_pb2.ServiceEnvelope.GATEWAY_ID_FIELD_NUMBER">GATEWAY_ID_FIELD_NUMBER</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.HasField" href="#meshtastic.mqtt_pb2.ServiceEnvelope.HasField">HasField</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.IsInitialized" href="#meshtastic.mqtt_pb2.ServiceEnvelope.IsInitialized">IsInitialized</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.ListFields" href="#meshtastic.mqtt_pb2.ServiceEnvelope.ListFields">ListFields</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.MergeFrom" href="#meshtastic.mqtt_pb2.ServiceEnvelope.MergeFrom">MergeFrom</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.MergeFromString" href="#meshtastic.mqtt_pb2.ServiceEnvelope.MergeFromString">MergeFromString</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.PACKET_FIELD_NUMBER" href="#meshtastic.mqtt_pb2.ServiceEnvelope.PACKET_FIELD_NUMBER">PACKET_FIELD_NUMBER</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.RegisterExtension" href="#meshtastic.mqtt_pb2.ServiceEnvelope.RegisterExtension">RegisterExtension</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.SerializePartialToString" href="#meshtastic.mqtt_pb2.ServiceEnvelope.SerializePartialToString">SerializePartialToString</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.SerializeToString" href="#meshtastic.mqtt_pb2.ServiceEnvelope.SerializeToString">SerializeToString</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.SetInParent" href="#meshtastic.mqtt_pb2.ServiceEnvelope.SetInParent">SetInParent</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.UnknownFields" href="#meshtastic.mqtt_pb2.ServiceEnvelope.UnknownFields">UnknownFields</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.WhichOneof" href="#meshtastic.mqtt_pb2.ServiceEnvelope.WhichOneof">WhichOneof</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.channel_id" href="#meshtastic.mqtt_pb2.ServiceEnvelope.channel_id">channel_id</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.gateway_id" href="#meshtastic.mqtt_pb2.ServiceEnvelope.gateway_id">gateway_id</a></code></li>
-<li><code><a title="meshtastic.mqtt_pb2.ServiceEnvelope.packet" href="#meshtastic.mqtt_pb2.ServiceEnvelope.packet">packet</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>

docs/meshtastic/portnums_pb2.html

@@ -1,190 +0,0 @@
-<!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.portnums_pb2 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.portnums_pb2</code></h1>
-</header>
-<section id="section-intro">
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python"># -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: portnums.proto
-
-from google.protobuf.internal import enum_type_wrapper
-from google.protobuf import descriptor as _descriptor
-from google.protobuf import message as _message
-from google.protobuf import reflection as _reflection
-from google.protobuf import symbol_database as _symbol_database
-# @@protoc_insertion_point(imports)
-
-_sym_db = _symbol_database.Default()
-
-
-
-
-DESCRIPTOR = _descriptor.FileDescriptor(
-  name=&#39;portnums.proto&#39;,
-  package=&#39;&#39;,
-  syntax=&#39;proto3&#39;,
-  serialized_options=b&#39;\n\023com.geeksville.meshB\010PortnumsH\003Z!github.com/meshtastic/gomeshproto&#39;,
-  serialized_pb=b&#39;\n\x0eportnums.proto*\xcb\x02\n\x07PortNum\x12\x0f\n\x0bUNKNOWN_APP\x10\x00\x12\x14\n\x10TEXT_MESSAGE_APP\x10\x01\x12\x17\n\x13REMOTE_HARDWARE_APP\x10\x02\x12\x10\n\x0cPOSITION_APP\x10\x03\x12\x10\n\x0cNODEINFO_APP\x10\x04\x12\x0f\n\x0bROUTING_APP\x10\x05\x12\r\n\tADMIN_APP\x10\x06\x12\r\n\tREPLY_APP\x10 \x12\x11\n\rIP_TUNNEL_APP\x10!\x12\x0e\n\nSERIAL_APP\x10@\x12\x15\n\x11STORE_FORWARD_APP\x10\x41\x12\x12\n\x0eRANGE_TEST_APP\x10\x42\x12!\n\x1d\x45NVIRONMENTAL_MEASUREMENT_APP\x10\x43\x12\x0b\n\x07ZPS_APP\x10\x44\x12\x10\n\x0bPRIVATE_APP\x10\x80\x02\x12\x13\n\x0e\x41TAK_FORWARDER\x10\x81\x02\x12\x08\n\x03MAX\x10\xff\x03\x42\x44\n\x13\x63om.geeksville.meshB\x08PortnumsH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3&#39;
-)
-
-_PORTNUM = _descriptor.EnumDescriptor(
-  name=&#39;PortNum&#39;,
-  full_name=&#39;PortNum&#39;,
-  filename=None,
-  file=DESCRIPTOR,
-  values=[
-    _descriptor.EnumValueDescriptor(
-      name=&#39;UNKNOWN_APP&#39;, index=0, number=0,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;TEXT_MESSAGE_APP&#39;, index=1, number=1,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;REMOTE_HARDWARE_APP&#39;, index=2, number=2,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;POSITION_APP&#39;, index=3, number=3,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;NODEINFO_APP&#39;, index=4, number=4,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;ROUTING_APP&#39;, index=5, number=5,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;ADMIN_APP&#39;, index=6, number=6,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;REPLY_APP&#39;, index=7, number=32,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;IP_TUNNEL_APP&#39;, index=8, number=33,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;SERIAL_APP&#39;, index=9, number=64,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;STORE_FORWARD_APP&#39;, index=10, number=65,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;RANGE_TEST_APP&#39;, index=11, number=66,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;ENVIRONMENTAL_MEASUREMENT_APP&#39;, index=12, number=67,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;ZPS_APP&#39;, index=13, number=68,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;PRIVATE_APP&#39;, index=14, number=256,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;ATAK_FORWARDER&#39;, index=15, number=257,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;MAX&#39;, index=16, number=511,
-      serialized_options=None,
-      type=None),
-  ],
-  containing_type=None,
-  serialized_options=None,
-  serialized_start=19,
-  serialized_end=350,
-)
-_sym_db.RegisterEnumDescriptor(_PORTNUM)
-
-PortNum = enum_type_wrapper.EnumTypeWrapper(_PORTNUM)
-UNKNOWN_APP = 0
-TEXT_MESSAGE_APP = 1
-REMOTE_HARDWARE_APP = 2
-POSITION_APP = 3
-NODEINFO_APP = 4
-ROUTING_APP = 5
-ADMIN_APP = 6
-REPLY_APP = 32
-IP_TUNNEL_APP = 33
-SERIAL_APP = 64
-STORE_FORWARD_APP = 65
-RANGE_TEST_APP = 66
-ENVIRONMENTAL_MEASUREMENT_APP = 67
-ZPS_APP = 68
-PRIVATE_APP = 256
-ATAK_FORWARDER = 257
-MAX = 511
-
-
-DESCRIPTOR.enum_types_by_name[&#39;PortNum&#39;] = _PORTNUM
-_sym_db.RegisterFileDescriptor(DESCRIPTOR)
-
-
-DESCRIPTOR._options = None
-# @@protoc_insertion_point(module_scope)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</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>
-</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>

docs/meshtastic/remote_hardware.html

@@ -1,324 +0,0 @@
-<!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.remote_hardware API documentation</title>
-<meta name="description" content="Remote hardware" />
-<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.remote_hardware</code></h1>
-</header>
-<section id="section-intro">
-<p>Remote hardware</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Remote hardware
-&#34;&#34;&#34;
-import logging
-from pubsub import pub
-from . import portnums_pb2, remote_hardware_pb2
-from .util import our_exit
-
-
-def onGPIOreceive(packet, interface):
-    &#34;&#34;&#34;Callback for received GPIO responses
-    &#34;&#34;&#34;
-    logging.debug(f&#34;packet:{packet} interface:{interface}&#34;)
-    hw = packet[&#34;decoded&#34;][&#34;remotehw&#34;]
-    gpioValue = hw[&#34;gpioValue&#34;]
-    #print(f&#39;mask:{interface.mask}&#39;)
-    value = int(gpioValue) &amp; int(interface.mask)
-    print(f&#39;Received RemoteHardware typ={hw[&#34;typ&#34;]}, gpio_value={gpioValue} value={value}&#39;)
-    interface.gotResponse = True
-
-
-class RemoteHardwareClient:
-    &#34;&#34;&#34;
-    This is the client code to control/monitor simple hardware built into the
-    meshtastic devices.  It is intended to be both a useful API/service and example
-    code for how you can connect to your own custom meshtastic services
-    &#34;&#34;&#34;
-
-    def __init__(self, iface):
-        &#34;&#34;&#34;
-        Constructor
-
-        iface is the already open MeshInterface instance
-        &#34;&#34;&#34;
-        self.iface = iface
-        ch = iface.localNode.getChannelByName(&#34;gpio&#34;)
-        if not ch:
-            our_exit(
-                &#34;Warning: No channel named &#39;gpio&#39; was found.\n&#34;\
-                &#34;On the sending and receive nodes create a channel named &#39;gpio&#39;.\n&#34;\
-                &#34;For example, run &#39;--ch-add gpio&#39; on one device, then &#39;--seturl&#39; on\n&#34;\
-                &#34;the other devices using the url from the device where the channel was added.&#34;)
-        self.channelIndex = ch.index
-
-        pub.subscribe(onGPIOreceive, &#34;meshtastic.receive.remotehw&#34;)
-
-    def _sendHardware(self, nodeid, r, wantResponse=False, onResponse=None):
-        if not nodeid:
-            our_exit(r&#34;Warning: Must use a destination node ID for this operation (use --dest \!xxxxxxxxx)&#34;)
-        return self.iface.sendData(r, nodeid, portnums_pb2.REMOTE_HARDWARE_APP,
-                                   wantAck=True, channelIndex=self.channelIndex,
-                                   wantResponse=wantResponse, onResponse=onResponse)
-
-    def writeGPIOs(self, nodeid, mask, vals):
-        &#34;&#34;&#34;
-        Write the specified vals bits to the device GPIOs.  Only bits in mask that
-        are 1 will be changed
-        &#34;&#34;&#34;
-        logging.debug(f&#39;writeGPIOs nodeid:{nodeid} mask:{mask} vals:{vals}&#39;)
-        r = remote_hardware_pb2.HardwareMessage()
-        r.typ = remote_hardware_pb2.HardwareMessage.Type.WRITE_GPIOS
-        r.gpio_mask = mask
-        r.gpio_value = vals
-        return self._sendHardware(nodeid, r)
-
-    def readGPIOs(self, nodeid, mask, onResponse = None):
-        &#34;&#34;&#34;Read the specified bits from GPIO inputs on the device&#34;&#34;&#34;
-        logging.debug(f&#39;readGPIOs nodeid:{nodeid} mask:{mask}&#39;)
-        r = remote_hardware_pb2.HardwareMessage()
-        r.typ = remote_hardware_pb2.HardwareMessage.Type.READ_GPIOS
-        r.gpio_mask = mask
-        return self._sendHardware(nodeid, r, wantResponse=True, onResponse=onResponse)
-
-    def watchGPIOs(self, nodeid, mask):
-        &#34;&#34;&#34;Watch the specified bits from GPIO inputs on the device for changes&#34;&#34;&#34;
-        logging.debug(f&#39;watchGPIOs nodeid:{nodeid} mask:{mask}&#39;)
-        r = remote_hardware_pb2.HardwareMessage()
-        r.typ = remote_hardware_pb2.HardwareMessage.Type.WATCH_GPIOS
-        r.gpio_mask = mask
-        self.iface.mask = mask
-        return self._sendHardware(nodeid, r)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="meshtastic.remote_hardware.onGPIOreceive"><code class="name flex">
-<span>def <span class="ident">onGPIOreceive</span></span>(<span>packet, interface)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Callback for received GPIO responses</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def onGPIOreceive(packet, interface):
-    &#34;&#34;&#34;Callback for received GPIO responses
-    &#34;&#34;&#34;
-    logging.debug(f&#34;packet:{packet} interface:{interface}&#34;)
-    hw = packet[&#34;decoded&#34;][&#34;remotehw&#34;]
-    gpioValue = hw[&#34;gpioValue&#34;]
-    #print(f&#39;mask:{interface.mask}&#39;)
-    value = int(gpioValue) &amp; int(interface.mask)
-    print(f&#39;Received RemoteHardware typ={hw[&#34;typ&#34;]}, gpio_value={gpioValue} value={value}&#39;)
-    interface.gotResponse = True</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="meshtastic.remote_hardware.RemoteHardwareClient"><code class="flex name class">
-<span>class <span class="ident">RemoteHardwareClient</span></span>
-<span>(</span><span>iface)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>This is the client code to control/monitor simple hardware built into the
-meshtastic devices.
-It is intended to be both a useful API/service and example
-code for how you can connect to your own custom meshtastic services</p>
-<p>Constructor</p>
-<p>iface is the already open MeshInterface instance</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class RemoteHardwareClient:
-    &#34;&#34;&#34;
-    This is the client code to control/monitor simple hardware built into the
-    meshtastic devices.  It is intended to be both a useful API/service and example
-    code for how you can connect to your own custom meshtastic services
-    &#34;&#34;&#34;
-
-    def __init__(self, iface):
-        &#34;&#34;&#34;
-        Constructor
-
-        iface is the already open MeshInterface instance
-        &#34;&#34;&#34;
-        self.iface = iface
-        ch = iface.localNode.getChannelByName(&#34;gpio&#34;)
-        if not ch:
-            our_exit(
-                &#34;Warning: No channel named &#39;gpio&#39; was found.\n&#34;\
-                &#34;On the sending and receive nodes create a channel named &#39;gpio&#39;.\n&#34;\
-                &#34;For example, run &#39;--ch-add gpio&#39; on one device, then &#39;--seturl&#39; on\n&#34;\
-                &#34;the other devices using the url from the device where the channel was added.&#34;)
-        self.channelIndex = ch.index
-
-        pub.subscribe(onGPIOreceive, &#34;meshtastic.receive.remotehw&#34;)
-
-    def _sendHardware(self, nodeid, r, wantResponse=False, onResponse=None):
-        if not nodeid:
-            our_exit(r&#34;Warning: Must use a destination node ID for this operation (use --dest \!xxxxxxxxx)&#34;)
-        return self.iface.sendData(r, nodeid, portnums_pb2.REMOTE_HARDWARE_APP,
-                                   wantAck=True, channelIndex=self.channelIndex,
-                                   wantResponse=wantResponse, onResponse=onResponse)
-
-    def writeGPIOs(self, nodeid, mask, vals):
-        &#34;&#34;&#34;
-        Write the specified vals bits to the device GPIOs.  Only bits in mask that
-        are 1 will be changed
-        &#34;&#34;&#34;
-        logging.debug(f&#39;writeGPIOs nodeid:{nodeid} mask:{mask} vals:{vals}&#39;)
-        r = remote_hardware_pb2.HardwareMessage()
-        r.typ = remote_hardware_pb2.HardwareMessage.Type.WRITE_GPIOS
-        r.gpio_mask = mask
-        r.gpio_value = vals
-        return self._sendHardware(nodeid, r)
-
-    def readGPIOs(self, nodeid, mask, onResponse = None):
-        &#34;&#34;&#34;Read the specified bits from GPIO inputs on the device&#34;&#34;&#34;
-        logging.debug(f&#39;readGPIOs nodeid:{nodeid} mask:{mask}&#39;)
-        r = remote_hardware_pb2.HardwareMessage()
-        r.typ = remote_hardware_pb2.HardwareMessage.Type.READ_GPIOS
-        r.gpio_mask = mask
-        return self._sendHardware(nodeid, r, wantResponse=True, onResponse=onResponse)
-
-    def watchGPIOs(self, nodeid, mask):
-        &#34;&#34;&#34;Watch the specified bits from GPIO inputs on the device for changes&#34;&#34;&#34;
-        logging.debug(f&#39;watchGPIOs nodeid:{nodeid} mask:{mask}&#39;)
-        r = remote_hardware_pb2.HardwareMessage()
-        r.typ = remote_hardware_pb2.HardwareMessage.Type.WATCH_GPIOS
-        r.gpio_mask = mask
-        self.iface.mask = mask
-        return self._sendHardware(nodeid, r)</code></pre>
-</details>
-<h3>Methods</h3>
-<dl>
-<dt id="meshtastic.remote_hardware.RemoteHardwareClient.readGPIOs"><code class="name flex">
-<span>def <span class="ident">readGPIOs</span></span>(<span>self, nodeid, mask, onResponse=None)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Read the specified bits from GPIO inputs on the device</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def readGPIOs(self, nodeid, mask, onResponse = None):
-    &#34;&#34;&#34;Read the specified bits from GPIO inputs on the device&#34;&#34;&#34;
-    logging.debug(f&#39;readGPIOs nodeid:{nodeid} mask:{mask}&#39;)
-    r = remote_hardware_pb2.HardwareMessage()
-    r.typ = remote_hardware_pb2.HardwareMessage.Type.READ_GPIOS
-    r.gpio_mask = mask
-    return self._sendHardware(nodeid, r, wantResponse=True, onResponse=onResponse)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.remote_hardware.RemoteHardwareClient.watchGPIOs"><code class="name flex">
-<span>def <span class="ident">watchGPIOs</span></span>(<span>self, nodeid, mask)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Watch the specified bits from GPIO inputs on the device for changes</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def watchGPIOs(self, nodeid, mask):
-    &#34;&#34;&#34;Watch the specified bits from GPIO inputs on the device for changes&#34;&#34;&#34;
-    logging.debug(f&#39;watchGPIOs nodeid:{nodeid} mask:{mask}&#39;)
-    r = remote_hardware_pb2.HardwareMessage()
-    r.typ = remote_hardware_pb2.HardwareMessage.Type.WATCH_GPIOS
-    r.gpio_mask = mask
-    self.iface.mask = mask
-    return self._sendHardware(nodeid, r)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.remote_hardware.RemoteHardwareClient.writeGPIOs"><code class="name flex">
-<span>def <span class="ident">writeGPIOs</span></span>(<span>self, nodeid, mask, vals)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Write the specified vals bits to the device GPIOs.
-Only bits in mask that
-are 1 will be changed</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def writeGPIOs(self, nodeid, mask, vals):
-    &#34;&#34;&#34;
-    Write the specified vals bits to the device GPIOs.  Only bits in mask that
-    are 1 will be changed
-    &#34;&#34;&#34;
-    logging.debug(f&#39;writeGPIOs nodeid:{nodeid} mask:{mask} vals:{vals}&#39;)
-    r = remote_hardware_pb2.HardwareMessage()
-    r.typ = remote_hardware_pb2.HardwareMessage.Type.WRITE_GPIOS
-    r.gpio_mask = mask
-    r.gpio_value = vals
-    return self._sendHardware(nodeid, r)</code></pre>
-</details>
-</dd>
-</dl>
-</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-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="meshtastic.remote_hardware.onGPIOreceive" href="#meshtastic.remote_hardware.onGPIOreceive">onGPIOreceive</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="meshtastic.remote_hardware.RemoteHardwareClient" href="#meshtastic.remote_hardware.RemoteHardwareClient">RemoteHardwareClient</a></code></h4>
-<ul class="">
-<li><code><a title="meshtastic.remote_hardware.RemoteHardwareClient.readGPIOs" href="#meshtastic.remote_hardware.RemoteHardwareClient.readGPIOs">readGPIOs</a></code></li>
-<li><code><a title="meshtastic.remote_hardware.RemoteHardwareClient.watchGPIOs" href="#meshtastic.remote_hardware.RemoteHardwareClient.watchGPIOs">watchGPIOs</a></code></li>
-<li><code><a title="meshtastic.remote_hardware.RemoteHardwareClient.writeGPIOs" href="#meshtastic.remote_hardware.RemoteHardwareClient.writeGPIOs">writeGPIOs</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>

docs/meshtastic/remote_hardware_pb2.html

@@ -1,822 +0,0 @@
-<!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.remote_hardware_pb2 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.remote_hardware_pb2</code></h1>
-</header>
-<section id="section-intro">
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python"># -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: remote_hardware.proto
-
-from google.protobuf import descriptor as _descriptor
-from google.protobuf import message as _message
-from google.protobuf import reflection as _reflection
-from google.protobuf import symbol_database as _symbol_database
-# @@protoc_insertion_point(imports)
-
-_sym_db = _symbol_database.Default()
-
-
-
-
-DESCRIPTOR = _descriptor.FileDescriptor(
-  name=&#39;remote_hardware.proto&#39;,
-  package=&#39;&#39;,
-  syntax=&#39;proto3&#39;,
-  serialized_options=b&#39;\n\023com.geeksville.meshB\016RemoteHardwareH\003Z!github.com/meshtastic/gomeshproto&#39;,
-  serialized_pb=b&#39;\n\x15remote_hardware.proto\&#34;\xca\x01\n\x0fHardwareMessage\x12\&#34;\n\x03typ\x18\x01 \x01(\x0e\x32\x15.HardwareMessage.Type\x12\x11\n\tgpio_mask\x18\x02 \x01(\x04\x12\x12\n\ngpio_value\x18\x03 \x01(\x04\&#34;l\n\x04Type\x12\t\n\x05UNSET\x10\x00\x12\x0f\n\x0bWRITE_GPIOS\x10\x01\x12\x0f\n\x0bWATCH_GPIOS\x10\x02\x12\x11\n\rGPIOS_CHANGED\x10\x03\x12\x0e\n\nREAD_GPIOS\x10\x04\x12\x14\n\x10READ_GPIOS_REPLY\x10\x05\x42J\n\x13\x63om.geeksville.meshB\x0eRemoteHardwareH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3&#39;
-)
-
-
-
-_HARDWAREMESSAGE_TYPE = _descriptor.EnumDescriptor(
-  name=&#39;Type&#39;,
-  full_name=&#39;HardwareMessage.Type&#39;,
-  filename=None,
-  file=DESCRIPTOR,
-  values=[
-    _descriptor.EnumValueDescriptor(
-      name=&#39;UNSET&#39;, index=0, number=0,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;WRITE_GPIOS&#39;, index=1, number=1,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;WATCH_GPIOS&#39;, index=2, number=2,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;GPIOS_CHANGED&#39;, index=3, number=3,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;READ_GPIOS&#39;, index=4, number=4,
-      serialized_options=None,
-      type=None),
-    _descriptor.EnumValueDescriptor(
-      name=&#39;READ_GPIOS_REPLY&#39;, index=5, number=5,
-      serialized_options=None,
-      type=None),
-  ],
-  containing_type=None,
-  serialized_options=None,
-  serialized_start=120,
-  serialized_end=228,
-)
-_sym_db.RegisterEnumDescriptor(_HARDWAREMESSAGE_TYPE)
-
-
-_HARDWAREMESSAGE = _descriptor.Descriptor(
-  name=&#39;HardwareMessage&#39;,
-  full_name=&#39;HardwareMessage&#39;,
-  filename=None,
-  file=DESCRIPTOR,
-  containing_type=None,
-  fields=[
-    _descriptor.FieldDescriptor(
-      name=&#39;typ&#39;, full_name=&#39;HardwareMessage.typ&#39;, index=0,
-      number=1, type=14, cpp_type=8, label=1,
-      has_default_value=False, default_value=0,
-      message_type=None, enum_type=None, containing_type=None,
-      is_extension=False, extension_scope=None,
-      serialized_options=None, file=DESCRIPTOR),
-    _descriptor.FieldDescriptor(
-      name=&#39;gpio_mask&#39;, full_name=&#39;HardwareMessage.gpio_mask&#39;, index=1,
-      number=2, type=4, cpp_type=4, label=1,
-      has_default_value=False, default_value=0,
-      message_type=None, enum_type=None, containing_type=None,
-      is_extension=False, extension_scope=None,
-      serialized_options=None, file=DESCRIPTOR),
-    _descriptor.FieldDescriptor(
-      name=&#39;gpio_value&#39;, full_name=&#39;HardwareMessage.gpio_value&#39;, index=2,
-      number=3, type=4, cpp_type=4, label=1,
-      has_default_value=False, default_value=0,
-      message_type=None, enum_type=None, containing_type=None,
-      is_extension=False, extension_scope=None,
-      serialized_options=None, file=DESCRIPTOR),
-  ],
-  extensions=[
-  ],
-  nested_types=[],
-  enum_types=[
-    _HARDWAREMESSAGE_TYPE,
-  ],
-  serialized_options=None,
-  is_extendable=False,
-  syntax=&#39;proto3&#39;,
-  extension_ranges=[],
-  oneofs=[
-  ],
-  serialized_start=26,
-  serialized_end=228,
-)
-
-_HARDWAREMESSAGE.fields_by_name[&#39;typ&#39;].enum_type = _HARDWAREMESSAGE_TYPE
-_HARDWAREMESSAGE_TYPE.containing_type = _HARDWAREMESSAGE
-DESCRIPTOR.message_types_by_name[&#39;HardwareMessage&#39;] = _HARDWAREMESSAGE
-_sym_db.RegisterFileDescriptor(DESCRIPTOR)
-
-HardwareMessage = _reflection.GeneratedProtocolMessageType(&#39;HardwareMessage&#39;, (_message.Message,), {
-  &#39;DESCRIPTOR&#39; : _HARDWAREMESSAGE,
-  &#39;__module__&#39; : &#39;remote_hardware_pb2&#39;
-  # @@protoc_insertion_point(class_scope:HardwareMessage)
-  })
-_sym_db.RegisterMessage(HardwareMessage)
-
-
-DESCRIPTOR._options = None
-# @@protoc_insertion_point(module_scope)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage"><code class="flex name class">
-<span>class <span class="ident">HardwareMessage</span></span>
-<span>(</span><span>**kwargs)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Abstract base class for protocol messages.</p>
-<p>Protocol message classes are almost always generated by the protocol
-compiler.
-These generated types subclass Message and implement the methods
-shown below.</p></div>
-<h3>Ancestors</h3>
-<ul class="hlist">
-<li>google.protobuf.message.Message</li>
-</ul>
-<h3>Class variables</h3>
-<dl>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.DESCRIPTOR"><code class="name">var <span class="ident">DESCRIPTOR</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.GPIOS_CHANGED"><code class="name">var <span class="ident">GPIOS_CHANGED</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.GPIO_MASK_FIELD_NUMBER"><code class="name">var <span class="ident">GPIO_MASK_FIELD_NUMBER</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.GPIO_VALUE_FIELD_NUMBER"><code class="name">var <span class="ident">GPIO_VALUE_FIELD_NUMBER</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.READ_GPIOS"><code class="name">var <span class="ident">READ_GPIOS</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.READ_GPIOS_REPLY"><code class="name">var <span class="ident">READ_GPIOS_REPLY</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.TYP_FIELD_NUMBER"><code class="name">var <span class="ident">TYP_FIELD_NUMBER</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.Type"><code class="name">var <span class="ident">Type</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.UNSET"><code class="name">var <span class="ident">UNSET</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.WATCH_GPIOS"><code class="name">var <span class="ident">WATCH_GPIOS</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.WRITE_GPIOS"><code class="name">var <span class="ident">WRITE_GPIOS</span></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-</dl>
-<h3>Static methods</h3>
-<dl>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.FromString"><code class="name flex">
-<span>def <span class="ident">FromString</span></span>(<span>s)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def FromString(s):
-  message = cls()
-  message.MergeFromString(s)
-  return message</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.RegisterExtension"><code class="name flex">
-<span>def <span class="ident">RegisterExtension</span></span>(<span>extension_handle)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def RegisterExtension(extension_handle):
-  extension_handle.containing_type = cls.DESCRIPTOR
-  # TODO(amauryfa): Use cls.MESSAGE_FACTORY.pool when available.
-  # pylint: disable=protected-access
-  cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(extension_handle)
-  _AttachFieldHelpers(cls, extension_handle)</code></pre>
-</details>
-</dd>
-</dl>
-<h3>Instance variables</h3>
-<dl>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.gpio_mask"><code class="name">var <span class="ident">gpio_mask</span></code></dt>
-<dd>
-<div class="desc"><p>Getter for gpio_mask.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def getter(self):
-  # TODO(protobuf-team): This may be broken since there may not be
-  # default_value.  Combine with has_default_value somehow.
-  return self._fields.get(field, default_value)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.gpio_value"><code class="name">var <span class="ident">gpio_value</span></code></dt>
-<dd>
-<div class="desc"><p>Getter for gpio_value.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def getter(self):
-  # TODO(protobuf-team): This may be broken since there may not be
-  # default_value.  Combine with has_default_value somehow.
-  return self._fields.get(field, default_value)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.typ"><code class="name">var <span class="ident">typ</span></code></dt>
-<dd>
-<div class="desc"><p>Getter for typ.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def getter(self):
-  # TODO(protobuf-team): This may be broken since there may not be
-  # default_value.  Combine with has_default_value somehow.
-  return self._fields.get(field, default_value)</code></pre>
-</details>
-</dd>
-</dl>
-<h3>Methods</h3>
-<dl>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.ByteSize"><code class="name flex">
-<span>def <span class="ident">ByteSize</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def ByteSize(self):
-  if not self._cached_byte_size_dirty:
-    return self._cached_byte_size
-
-  size = 0
-  descriptor = self.DESCRIPTOR
-  if descriptor.GetOptions().map_entry:
-    # Fields of map entry should always be serialized.
-    size = descriptor.fields_by_name[&#39;key&#39;]._sizer(self.key)
-    size += descriptor.fields_by_name[&#39;value&#39;]._sizer(self.value)
-  else:
-    for field_descriptor, field_value in self.ListFields():
-      size += field_descriptor._sizer(field_value)
-    for tag_bytes, value_bytes in self._unknown_fields:
-      size += len(tag_bytes) + len(value_bytes)
-
-  self._cached_byte_size = size
-  self._cached_byte_size_dirty = False
-  self._listener_for_children.dirty = False
-  return size</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.Clear"><code class="name flex">
-<span>def <span class="ident">Clear</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def _Clear(self):
-  # Clear fields.
-  self._fields = {}
-  self._unknown_fields = ()
-  # pylint: disable=protected-access
-  if self._unknown_field_set is not None:
-    self._unknown_field_set._clear()
-    self._unknown_field_set = None
-
-  self._oneofs = {}
-  self._Modified()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.ClearField"><code class="name flex">
-<span>def <span class="ident">ClearField</span></span>(<span>self, field_name)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def ClearField(self, field_name):
-  try:
-    field = message_descriptor.fields_by_name[field_name]
-  except KeyError:
-    try:
-      field = message_descriptor.oneofs_by_name[field_name]
-      if field in self._oneofs:
-        field = self._oneofs[field]
-      else:
-        return
-    except KeyError:
-      raise ValueError(&#39;Protocol message %s has no &#34;%s&#34; field.&#39; %
-                       (message_descriptor.name, field_name))
-
-  if field in self._fields:
-    # To match the C++ implementation, we need to invalidate iterators
-    # for map fields when ClearField() happens.
-    if hasattr(self._fields[field], &#39;InvalidateIterators&#39;):
-      self._fields[field].InvalidateIterators()
-
-    # Note:  If the field is a sub-message, its listener will still point
-    #   at us.  That&#39;s fine, because the worst than can happen is that it
-    #   will call _Modified() and invalidate our byte size.  Big deal.
-    del self._fields[field]
-
-    if self._oneofs.get(field.containing_oneof, None) is field:
-      del self._oneofs[field.containing_oneof]
-
-  # Always call _Modified() -- even if nothing was changed, this is
-  # a mutating method, and thus calling it should cause the field to become
-  # present in the parent message.
-  self._Modified()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.DiscardUnknownFields"><code class="name flex">
-<span>def <span class="ident">DiscardUnknownFields</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def _DiscardUnknownFields(self):
-  self._unknown_fields = []
-  self._unknown_field_set = None      # pylint: disable=protected-access
-  for field, value in self.ListFields():
-    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
-      if _IsMapField(field):
-        if _IsMessageMapField(field):
-          for key in value:
-            value[key].DiscardUnknownFields()
-      elif field.label == _FieldDescriptor.LABEL_REPEATED:
-        for sub_message in value:
-          sub_message.DiscardUnknownFields()
-      else:
-        value.DiscardUnknownFields()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.FindInitializationErrors"><code class="name flex">
-<span>def <span class="ident">FindInitializationErrors</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Finds required fields which are not initialized.</p>
-<h2 id="returns">Returns</h2>
-<p>A list of strings.
-Each string is a path to an uninitialized field from
-the top-level message, e.g. "foo.bar[5].baz".</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def FindInitializationErrors(self):
-  &#34;&#34;&#34;Finds required fields which are not initialized.
-
-  Returns:
-    A list of strings.  Each string is a path to an uninitialized field from
-    the top-level message, e.g. &#34;foo.bar[5].baz&#34;.
-  &#34;&#34;&#34;
-
-  errors = []  # simplify things
-
-  for field in required_fields:
-    if not self.HasField(field.name):
-      errors.append(field.name)
-
-  for field, value in self.ListFields():
-    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
-      if field.is_extension:
-        name = &#39;(%s)&#39; % field.full_name
-      else:
-        name = field.name
-
-      if _IsMapField(field):
-        if _IsMessageMapField(field):
-          for key in value:
-            element = value[key]
-            prefix = &#39;%s[%s].&#39; % (name, key)
-            sub_errors = element.FindInitializationErrors()
-            errors += [prefix + error for error in sub_errors]
-        else:
-          # ScalarMaps can&#39;t have any initialization errors.
-          pass
-      elif field.label == _FieldDescriptor.LABEL_REPEATED:
-        for i in range(len(value)):
-          element = value[i]
-          prefix = &#39;%s[%d].&#39; % (name, i)
-          sub_errors = element.FindInitializationErrors()
-          errors += [prefix + error for error in sub_errors]
-      else:
-        prefix = name + &#39;.&#39;
-        sub_errors = value.FindInitializationErrors()
-        errors += [prefix + error for error in sub_errors]
-
-  return errors</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.HasField"><code class="name flex">
-<span>def <span class="ident">HasField</span></span>(<span>self, field_name)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def HasField(self, field_name):
-  try:
-    field = hassable_fields[field_name]
-  except KeyError:
-    raise ValueError(error_msg % (message_descriptor.full_name, field_name))
-
-  if isinstance(field, descriptor_mod.OneofDescriptor):
-    try:
-      return HasField(self, self._oneofs[field].name)
-    except KeyError:
-      return False
-  else:
-    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
-      value = self._fields.get(field)
-      return value is not None and value._is_present_in_parent
-    else:
-      return field in self._fields</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.IsInitialized"><code class="name flex">
-<span>def <span class="ident">IsInitialized</span></span>(<span>self, errors=None)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Checks if all required fields of a message are set.</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>errors</code></strong></dt>
-<dd>A list which, if provided, will be populated with the field
-paths of all missing required fields.</dd>
-</dl>
-<h2 id="returns">Returns</h2>
-<p>True iff the specified message has all required fields set.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def IsInitialized(self, errors=None):
-  &#34;&#34;&#34;Checks if all required fields of a message are set.
-
-  Args:
-    errors:  A list which, if provided, will be populated with the field
-             paths of all missing required fields.
-
-  Returns:
-    True iff the specified message has all required fields set.
-  &#34;&#34;&#34;
-
-  # Performance is critical so we avoid HasField() and ListFields().
-
-  for field in required_fields:
-    if (field not in self._fields or
-        (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
-         not self._fields[field]._is_present_in_parent)):
-      if errors is not None:
-        errors.extend(self.FindInitializationErrors())
-      return False
-
-  for field, value in list(self._fields.items()):  # dict can change size!
-    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
-      if field.label == _FieldDescriptor.LABEL_REPEATED:
-        if (field.message_type.has_options and
-            field.message_type.GetOptions().map_entry):
-          continue
-        for element in value:
-          if not element.IsInitialized():
-            if errors is not None:
-              errors.extend(self.FindInitializationErrors())
-            return False
-      elif value._is_present_in_parent and not value.IsInitialized():
-        if errors is not None:
-          errors.extend(self.FindInitializationErrors())
-        return False
-
-  return True</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.ListFields"><code class="name flex">
-<span>def <span class="ident">ListFields</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def ListFields(self):
-  all_fields = [item for item in self._fields.items() if _IsPresent(item)]
-  all_fields.sort(key = lambda item: item[0].number)
-  return all_fields</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.MergeFrom"><code class="name flex">
-<span>def <span class="ident">MergeFrom</span></span>(<span>self, msg)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def MergeFrom(self, msg):
-  if not isinstance(msg, cls):
-    raise TypeError(
-        &#39;Parameter to MergeFrom() must be instance of same class: &#39;
-        &#39;expected %s got %s.&#39; % (_FullyQualifiedClassName(cls),
-                                 _FullyQualifiedClassName(msg.__class__)))
-
-  assert msg is not self
-  self._Modified()
-
-  fields = self._fields
-
-  for field, value in msg._fields.items():
-    if field.label == LABEL_REPEATED:
-      field_value = fields.get(field)
-      if field_value is None:
-        # Construct a new object to represent this field.
-        field_value = field._default_constructor(self)
-        fields[field] = field_value
-      field_value.MergeFrom(value)
-    elif field.cpp_type == CPPTYPE_MESSAGE:
-      if value._is_present_in_parent:
-        field_value = fields.get(field)
-        if field_value is None:
-          # Construct a new object to represent this field.
-          field_value = field._default_constructor(self)
-          fields[field] = field_value
-        field_value.MergeFrom(value)
-    else:
-      self._fields[field] = value
-      if field.containing_oneof:
-        self._UpdateOneofState(field)
-
-  if msg._unknown_fields:
-    if not self._unknown_fields:
-      self._unknown_fields = []
-    self._unknown_fields.extend(msg._unknown_fields)
-    # pylint: disable=protected-access
-    if self._unknown_field_set is None:
-      self._unknown_field_set = containers.UnknownFieldSet()
-    self._unknown_field_set._extend(msg._unknown_field_set)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.MergeFromString"><code class="name flex">
-<span>def <span class="ident">MergeFromString</span></span>(<span>self, serialized)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def MergeFromString(self, serialized):
-  serialized = memoryview(serialized)
-  length = len(serialized)
-  try:
-    if self._InternalParse(serialized, 0, length) != length:
-      # The only reason _InternalParse would return early is if it
-      # encountered an end-group tag.
-      raise message_mod.DecodeError(&#39;Unexpected end-group tag.&#39;)
-  except (IndexError, TypeError):
-    # Now ord(buf[p:p+1]) == ord(&#39;&#39;) gets TypeError.
-    raise message_mod.DecodeError(&#39;Truncated message.&#39;)
-  except struct.error as e:
-    raise message_mod.DecodeError(e)
-  return length   # Return this for legacy reasons.</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.SerializePartialToString"><code class="name flex">
-<span>def <span class="ident">SerializePartialToString</span></span>(<span>self, **kwargs)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def SerializePartialToString(self, **kwargs):
-  out = BytesIO()
-  self._InternalSerialize(out.write, **kwargs)
-  return out.getvalue()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.SerializeToString"><code class="name flex">
-<span>def <span class="ident">SerializeToString</span></span>(<span>self, **kwargs)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def SerializeToString(self, **kwargs):
-  # Check if the message has all of its required fields set.
-  if not self.IsInitialized():
-    raise message_mod.EncodeError(
-        &#39;Message %s is missing required fields: %s&#39; % (
-        self.DESCRIPTOR.full_name, &#39;,&#39;.join(self.FindInitializationErrors())))
-  return self.SerializePartialToString(**kwargs)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.SetInParent"><code class="name flex">
-<span>def <span class="ident">SetInParent</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Sets the _cached_byte_size_dirty bit to true,
-and propagates this to our listener iff this was a state change.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def Modified(self):
-  &#34;&#34;&#34;Sets the _cached_byte_size_dirty bit to true,
-  and propagates this to our listener iff this was a state change.
-  &#34;&#34;&#34;
-
-  # Note:  Some callers check _cached_byte_size_dirty before calling
-  #   _Modified() as an extra optimization.  So, if this method is ever
-  #   changed such that it does stuff even when _cached_byte_size_dirty is
-  #   already true, the callers need to be updated.
-  if not self._cached_byte_size_dirty:
-    self._cached_byte_size_dirty = True
-    self._listener_for_children.dirty = True
-    self._is_present_in_parent = True
-    self._listener.Modified()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.UnknownFields"><code class="name flex">
-<span>def <span class="ident">UnknownFields</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def _UnknownFields(self):
-  if self._unknown_field_set is None:  # pylint: disable=protected-access
-    # pylint: disable=protected-access
-    self._unknown_field_set = containers.UnknownFieldSet()
-  return self._unknown_field_set    # pylint: disable=protected-access</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.remote_hardware_pb2.HardwareMessage.WhichOneof"><code class="name flex">
-<span>def <span class="ident">WhichOneof</span></span>(<span>self, oneof_name)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Returns the name of the currently set field inside a oneof, or None.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def WhichOneof(self, oneof_name):
-  &#34;&#34;&#34;Returns the name of the currently set field inside a oneof, or None.&#34;&#34;&#34;
-  try:
-    field = message_descriptor.oneofs_by_name[oneof_name]
-  except KeyError:
-    raise ValueError(
-        &#39;Protocol message has no oneof &#34;%s&#34; field.&#39; % oneof_name)
-
-  nested_field = self._oneofs.get(field, None)
-  if nested_field is not None and self.HasField(nested_field.name):
-    return nested_field.name
-  else:
-    return None</code></pre>
-</details>
-</dd>
-</dl>
-</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.remote_hardware_pb2.HardwareMessage" href="#meshtastic.remote_hardware_pb2.HardwareMessage">HardwareMessage</a></code></h4>
-<ul class="">
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.ByteSize" href="#meshtastic.remote_hardware_pb2.HardwareMessage.ByteSize">ByteSize</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.Clear" href="#meshtastic.remote_hardware_pb2.HardwareMessage.Clear">Clear</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.ClearField" href="#meshtastic.remote_hardware_pb2.HardwareMessage.ClearField">ClearField</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.DESCRIPTOR" href="#meshtastic.remote_hardware_pb2.HardwareMessage.DESCRIPTOR">DESCRIPTOR</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.DiscardUnknownFields" href="#meshtastic.remote_hardware_pb2.HardwareMessage.DiscardUnknownFields">DiscardUnknownFields</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.FindInitializationErrors" href="#meshtastic.remote_hardware_pb2.HardwareMessage.FindInitializationErrors">FindInitializationErrors</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.FromString" href="#meshtastic.remote_hardware_pb2.HardwareMessage.FromString">FromString</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.GPIOS_CHANGED" href="#meshtastic.remote_hardware_pb2.HardwareMessage.GPIOS_CHANGED">GPIOS_CHANGED</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.GPIO_MASK_FIELD_NUMBER" href="#meshtastic.remote_hardware_pb2.HardwareMessage.GPIO_MASK_FIELD_NUMBER">GPIO_MASK_FIELD_NUMBER</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.GPIO_VALUE_FIELD_NUMBER" href="#meshtastic.remote_hardware_pb2.HardwareMessage.GPIO_VALUE_FIELD_NUMBER">GPIO_VALUE_FIELD_NUMBER</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.HasField" href="#meshtastic.remote_hardware_pb2.HardwareMessage.HasField">HasField</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.IsInitialized" href="#meshtastic.remote_hardware_pb2.HardwareMessage.IsInitialized">IsInitialized</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.ListFields" href="#meshtastic.remote_hardware_pb2.HardwareMessage.ListFields">ListFields</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.MergeFrom" href="#meshtastic.remote_hardware_pb2.HardwareMessage.MergeFrom">MergeFrom</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.MergeFromString" href="#meshtastic.remote_hardware_pb2.HardwareMessage.MergeFromString">MergeFromString</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.READ_GPIOS" href="#meshtastic.remote_hardware_pb2.HardwareMessage.READ_GPIOS">READ_GPIOS</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.READ_GPIOS_REPLY" href="#meshtastic.remote_hardware_pb2.HardwareMessage.READ_GPIOS_REPLY">READ_GPIOS_REPLY</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.RegisterExtension" href="#meshtastic.remote_hardware_pb2.HardwareMessage.RegisterExtension">RegisterExtension</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.SerializePartialToString" href="#meshtastic.remote_hardware_pb2.HardwareMessage.SerializePartialToString">SerializePartialToString</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.SerializeToString" href="#meshtastic.remote_hardware_pb2.HardwareMessage.SerializeToString">SerializeToString</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.SetInParent" href="#meshtastic.remote_hardware_pb2.HardwareMessage.SetInParent">SetInParent</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.TYP_FIELD_NUMBER" href="#meshtastic.remote_hardware_pb2.HardwareMessage.TYP_FIELD_NUMBER">TYP_FIELD_NUMBER</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.Type" href="#meshtastic.remote_hardware_pb2.HardwareMessage.Type">Type</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.UNSET" href="#meshtastic.remote_hardware_pb2.HardwareMessage.UNSET">UNSET</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.UnknownFields" href="#meshtastic.remote_hardware_pb2.HardwareMessage.UnknownFields">UnknownFields</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.WATCH_GPIOS" href="#meshtastic.remote_hardware_pb2.HardwareMessage.WATCH_GPIOS">WATCH_GPIOS</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.WRITE_GPIOS" href="#meshtastic.remote_hardware_pb2.HardwareMessage.WRITE_GPIOS">WRITE_GPIOS</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.WhichOneof" href="#meshtastic.remote_hardware_pb2.HardwareMessage.WhichOneof">WhichOneof</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.gpio_mask" href="#meshtastic.remote_hardware_pb2.HardwareMessage.gpio_mask">gpio_mask</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.gpio_value" href="#meshtastic.remote_hardware_pb2.HardwareMessage.gpio_value">gpio_value</a></code></li>
-<li><code><a title="meshtastic.remote_hardware_pb2.HardwareMessage.typ" href="#meshtastic.remote_hardware_pb2.HardwareMessage.typ">typ</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>

docs/meshtastic/serial_interface.html

@@ -1,254 +0,0 @@
-<!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">&#34;&#34;&#34; Serial interface class
-&#34;&#34;&#34;
-import logging
-import platform
-import os
-import stat
-import serial
-
-import meshtastic.util
-from .stream_interface import StreamInterface
-
-class SerialInterface(StreamInterface):
-    &#34;&#34;&#34;Interface class for meshtastic devices over a serial link&#34;&#34;&#34;
-
-    def __init__(self, devPath=None, debugOut=None, noProto=False, connectNow=True):
-        &#34;&#34;&#34;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})
-        &#34;&#34;&#34;
-
-        if devPath is None:
-            ports = meshtastic.util.findPorts()
-            logging.debug(f&#34;ports:{ports}&#34;)
-            if len(ports) == 0:
-                meshtastic.util.our_exit(&#34;Warning: No Meshtastic devices detected.&#34;)
-            elif len(ports) &gt; 1:
-                message = &#34;Warning: Multiple serial ports were detected so one serial port must be specified with the &#39;--port&#39;.\n&#34;
-                message += f&#34;  Ports detected:{ports}&#34;
-                meshtastic.util.our_exit(message)
-            else:
-                devPath = ports[0]
-
-        logging.debug(f&#34;Connecting to {devPath}&#34;)
-
-        # 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&#39;t be reset spuriously.
-        # Linux does this properly, so don&#39;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)
-
-    &#34;&#34;&#34;true if platform driving the serial port is Windows Subsystem for Linux 1.&#34;&#34;&#34;
-    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() == &#39;Linux&#39; and stat.S_ISCHR(os.stat(&#39;/dev/lxss&#39;).st_mode)
-        except:
-            # Couldn&#39;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 &#34;share&#34; 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() != &#39;Linux&#39; 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} &ndash; A filepath to a device, i.e. /dev/ttyUSB0 (default: {None})
-debugOut {stream} &ndash; 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):
-    &#34;&#34;&#34;Interface class for meshtastic devices over a serial link&#34;&#34;&#34;
-
-    def __init__(self, devPath=None, debugOut=None, noProto=False, connectNow=True):
-        &#34;&#34;&#34;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})
-        &#34;&#34;&#34;
-
-        if devPath is None:
-            ports = meshtastic.util.findPorts()
-            logging.debug(f&#34;ports:{ports}&#34;)
-            if len(ports) == 0:
-                meshtastic.util.our_exit(&#34;Warning: No Meshtastic devices detected.&#34;)
-            elif len(ports) &gt; 1:
-                message = &#34;Warning: Multiple serial ports were detected so one serial port must be specified with the &#39;--port&#39;.\n&#34;
-                message += f&#34;  Ports detected:{ports}&#34;
-                meshtastic.util.our_exit(message)
-            else:
-                devPath = ports[0]
-
-        logging.debug(f&#34;Connecting to {devPath}&#34;)
-
-        # 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&#39;t be reset spuriously.
-        # Linux does this properly, so don&#39;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)
-
-    &#34;&#34;&#34;true if platform driving the serial port is Windows Subsystem for Linux 1.&#34;&#34;&#34;
-    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() == &#39;Linux&#39; and stat.S_ISCHR(os.stat(&#39;/dev/lxss&#39;).st_mode)
-        except:
-            # Couldn&#39;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 &#34;share&#34; 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() != &#39;Linux&#39; 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>

docs/meshtastic/stream_interface.html

@@ -1,519 +0,0 @@
-<!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">&#34;&#34;&#34;Stream Interface base class
-&#34;&#34;&#34;
-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):
-    &#34;&#34;&#34;Interface class for meshtastic devices over a stream link (serial, TCP, etc)&#34;&#34;&#34;
-
-    def __init__(self, debugOut=None, noProto=False, connectNow=True):
-        &#34;&#34;&#34;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]
-        &#34;&#34;&#34;
-
-        if not hasattr(self, &#39;stream&#39;) and not noProto:
-            raise Exception(
-                &#34;StreamInterface is now abstract (to update existing code create SerialInterface instead)&#34;)
-        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):
-        &#34;&#34;&#34;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.
-        &#34;&#34;&#34;
-
-        # 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&#39;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):
-        &#34;&#34;&#34;We override the superclass implementation to close our port&#34;&#34;&#34;
-        MeshInterface._disconnected(self)
-
-        logging.debug(&#34;Closing our port&#34;)
-        # 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):
-        &#34;&#34;&#34;Write an array of bytes to our stream and flush&#34;&#34;&#34;
-        if self.stream:  # ignore writes when stream is closed
-            self.stream.write(b)
-            self.stream.flush()
-
-    def _readBytes(self, length):
-        &#34;&#34;&#34;Read an array of bytes from our stream&#34;&#34;&#34;
-        if self.stream:
-            return self.stream.read(length)
-        else:
-            return None
-
-    def _sendToRadioImpl(self, toRadio):
-        &#34;&#34;&#34;Send a ToRadio protobuf to the device&#34;&#34;&#34;
-        logging.debug(f&#34;Sending: {stripnl(toRadio)}&#34;)
-        b = toRadio.SerializeToString()
-        bufLen = len(b)
-        # We convert into a string, because the TCP code doesn&#39;t work with byte arrays
-        header = bytes([START1, START2, (bufLen &gt;&gt; 8) &amp; 0xff,  bufLen &amp; 0xff])
-        logging.debug(f&#39;sending header:{header} b:{b}&#39;)
-        self._writeBytes(header + b)
-
-    def close(self):
-        &#34;&#34;&#34;Close a connection to the device&#34;&#34;&#34;
-        logging.debug(&#34;Closing stream&#34;)
-        MeshInterface.close(self)
-        # pyserial cancel_read doesn&#39;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):
-        &#34;&#34;&#34;The reader thread that reads bytes from our stream&#34;&#34;&#34;
-        logging.debug(&#39;in __reader()&#39;)
-        empty = bytes()
-
-        try:
-            while not self._wantExit:
-                logging.debug(&#34;reading character&#34;)
-                b = self._readBytes(1)
-                logging.debug(&#34;In reader loop&#34;)
-                #logging.debug(f&#34;read returned {b}&#34;)
-                if len(b) &gt; 0:
-                    c = b[0]
-                    #logging.debug(f&#39;c:{c}&#39;)
-                    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(&#34;utf-8&#34;))
-                                except:
-                                    self.debugOut.write(&#39;?&#39;)
-
-                    elif ptr == 1:  # looking for START2
-                        if c != START2:
-                            self._rxBuf = empty  # failed to find start2
-                    elif ptr &gt;= HEADER_LEN - 1:  # we&#39;ve at least got a header
-                        #logging.debug(&#39;at least we received a header&#39;)
-                        # big endian length follows header
-                        packetlen = (self._rxBuf[2] &lt;&lt; 8) + self._rxBuf[3]
-
-                        if ptr == HEADER_LEN - 1:  # we _just_ finished reading the header, validate length
-                            if packetlen &gt; MAX_TO_FROM_RADIO_SIZE:
-                                self._rxBuf = empty  # length was out out bounds, restart
-
-                        if len(self._rxBuf) != 0 and ptr + 1 &gt;= packetlen + HEADER_LEN:
-                            try:
-                                self._handleFromRadio(self._rxBuf[HEADER_LEN:])
-                            except Exception as ex:
-                                logging.error(f&#34;Error while handling message from radio {ex}&#34;)
-                                traceback.print_exc()
-                            self._rxBuf = empty
-                else:
-                    # logging.debug(f&#34;timeout&#34;)
-                    pass
-        except serial.SerialException as ex:
-            if not self._wantExit:  # We might intentionally get an exception during shutdown
-                logging.warning(f&#34;Meshtastic serial port disconnected, disconnecting... {ex}&#34;)
-        except OSError as ex:
-            if not self._wantExit:  # We might intentionally get an exception during shutdown
-                logging.error(f&#34;Unexpected OSError, terminating meshtastic reader... {ex}&#34;)
-        except Exception as ex:
-            logging.error(f&#34;Unexpected exception, terminating meshtastic reader... {ex}&#34;)
-        finally:
-            logging.debug(&#34;reader is exiting&#34;)
-            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} &ndash; 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):
-    &#34;&#34;&#34;Interface class for meshtastic devices over a stream link (serial, TCP, etc)&#34;&#34;&#34;
-
-    def __init__(self, debugOut=None, noProto=False, connectNow=True):
-        &#34;&#34;&#34;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]
-        &#34;&#34;&#34;
-
-        if not hasattr(self, &#39;stream&#39;) and not noProto:
-            raise Exception(
-                &#34;StreamInterface is now abstract (to update existing code create SerialInterface instead)&#34;)
-        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):
-        &#34;&#34;&#34;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.
-        &#34;&#34;&#34;
-
-        # 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&#39;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):
-        &#34;&#34;&#34;We override the superclass implementation to close our port&#34;&#34;&#34;
-        MeshInterface._disconnected(self)
-
-        logging.debug(&#34;Closing our port&#34;)
-        # 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):
-        &#34;&#34;&#34;Write an array of bytes to our stream and flush&#34;&#34;&#34;
-        if self.stream:  # ignore writes when stream is closed
-            self.stream.write(b)
-            self.stream.flush()
-
-    def _readBytes(self, length):
-        &#34;&#34;&#34;Read an array of bytes from our stream&#34;&#34;&#34;
-        if self.stream:
-            return self.stream.read(length)
-        else:
-            return None
-
-    def _sendToRadioImpl(self, toRadio):
-        &#34;&#34;&#34;Send a ToRadio protobuf to the device&#34;&#34;&#34;
-        logging.debug(f&#34;Sending: {stripnl(toRadio)}&#34;)
-        b = toRadio.SerializeToString()
-        bufLen = len(b)
-        # We convert into a string, because the TCP code doesn&#39;t work with byte arrays
-        header = bytes([START1, START2, (bufLen &gt;&gt; 8) &amp; 0xff,  bufLen &amp; 0xff])
-        logging.debug(f&#39;sending header:{header} b:{b}&#39;)
-        self._writeBytes(header + b)
-
-    def close(self):
-        &#34;&#34;&#34;Close a connection to the device&#34;&#34;&#34;
-        logging.debug(&#34;Closing stream&#34;)
-        MeshInterface.close(self)
-        # pyserial cancel_read doesn&#39;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):
-        &#34;&#34;&#34;The reader thread that reads bytes from our stream&#34;&#34;&#34;
-        logging.debug(&#39;in __reader()&#39;)
-        empty = bytes()
-
-        try:
-            while not self._wantExit:
-                logging.debug(&#34;reading character&#34;)
-                b = self._readBytes(1)
-                logging.debug(&#34;In reader loop&#34;)
-                #logging.debug(f&#34;read returned {b}&#34;)
-                if len(b) &gt; 0:
-                    c = b[0]
-                    #logging.debug(f&#39;c:{c}&#39;)
-                    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(&#34;utf-8&#34;))
-                                except:
-                                    self.debugOut.write(&#39;?&#39;)
-
-                    elif ptr == 1:  # looking for START2
-                        if c != START2:
-                            self._rxBuf = empty  # failed to find start2
-                    elif ptr &gt;= HEADER_LEN - 1:  # we&#39;ve at least got a header
-                        #logging.debug(&#39;at least we received a header&#39;)
-                        # big endian length follows header
-                        packetlen = (self._rxBuf[2] &lt;&lt; 8) + self._rxBuf[3]
-
-                        if ptr == HEADER_LEN - 1:  # we _just_ finished reading the header, validate length
-                            if packetlen &gt; MAX_TO_FROM_RADIO_SIZE:
-                                self._rxBuf = empty  # length was out out bounds, restart
-
-                        if len(self._rxBuf) != 0 and ptr + 1 &gt;= packetlen + HEADER_LEN:
-                            try:
-                                self._handleFromRadio(self._rxBuf[HEADER_LEN:])
-                            except Exception as ex:
-                                logging.error(f&#34;Error while handling message from radio {ex}&#34;)
-                                traceback.print_exc()
-                            self._rxBuf = empty
-                else:
-                    # logging.debug(f&#34;timeout&#34;)
-                    pass
-        except serial.SerialException as ex:
-            if not self._wantExit:  # We might intentionally get an exception during shutdown
-                logging.warning(f&#34;Meshtastic serial port disconnected, disconnecting... {ex}&#34;)
-        except OSError as ex:
-            if not self._wantExit:  # We might intentionally get an exception during shutdown
-                logging.error(f&#34;Unexpected OSError, terminating meshtastic reader... {ex}&#34;)
-        except Exception as ex:
-            logging.error(f&#34;Unexpected exception, terminating meshtastic reader... {ex}&#34;)
-        finally:
-            logging.debug(&#34;reader is exiting&#34;)
-            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):
-    &#34;&#34;&#34;Close a connection to the device&#34;&#34;&#34;
-    logging.debug(&#34;Closing stream&#34;)
-    MeshInterface.close(self)
-    # pyserial cancel_read doesn&#39;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):
-    &#34;&#34;&#34;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.
-    &#34;&#34;&#34;
-
-    # 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&#39;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>

docs/meshtastic/tcp_interface.html

@@ -1,251 +0,0 @@
-<!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.tcp_interface API documentation</title>
-<meta name="description" content="TCPInterface class for interfacing with http endpoint" />
-<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.tcp_interface</code></h1>
-</header>
-<section id="section-intro">
-<p>TCPInterface class for interfacing with http endpoint</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;TCPInterface class for interfacing with http endpoint
-&#34;&#34;&#34;
-import logging
-import socket
-from typing import AnyStr
-
-from .stream_interface import StreamInterface
-
-class TCPInterface(StreamInterface):
-    &#34;&#34;&#34;Interface class for meshtastic devices over a TCP link&#34;&#34;&#34;
-
-    def __init__(self, hostname: AnyStr, debugOut=None, noProto=False,
-                 connectNow=True, portNumber=4403):
-        &#34;&#34;&#34;Constructor, opens a connection to a specified IP address/hostname
-
-        Keyword Arguments:
-            hostname {string} -- Hostname/IP address of the device to connect to
-        &#34;&#34;&#34;
-
-        # Instead of wrapping as a stream, we use the native socket API
-        # self.stream = sock.makefile(&#39;rw&#39;)
-        self.stream = None
-
-        self.hostname = hostname
-        self.portNumber = portNumber
-
-        if connectNow:
-            logging.debug(f&#34;Connecting to {hostname}&#34;)
-            server_address = (hostname, portNumber)
-            sock = socket.create_connection(server_address)
-            self.socket = sock
-        else:
-            self.socket = None
-
-        StreamInterface.__init__(self, debugOut=debugOut, noProto=noProto,
-                                 connectNow=connectNow)
-
-    def myConnect(self):
-        &#34;&#34;&#34;Connect to socket&#34;&#34;&#34;
-        server_address = (self.hostname, self.portNumber)
-        sock = socket.create_connection(server_address)
-        self.socket = sock
-
-    def close(self):
-        &#34;&#34;&#34;Close a connection to the device&#34;&#34;&#34;
-        logging.debug(&#34;Closing TCP stream&#34;)
-        StreamInterface.close(self)
-        # Sometimes the socket read might be blocked in the reader thread.
-        # Therefore we force the shutdown by closing the socket here
-        self._wantExit = True
-        if not self.socket is None:
-            try:
-                self.socket.shutdown(socket.SHUT_RDWR)
-            except:
-                pass  # Ignore errors in shutdown, because we might have a race with the server
-            self.socket.close()
-
-    def _writeBytes(self, b):
-        &#34;&#34;&#34;Write an array of bytes to our stream and flush&#34;&#34;&#34;
-        self.socket.send(b)
-
-    def _readBytes(self, length):
-        &#34;&#34;&#34;Read an array of bytes from our stream&#34;&#34;&#34;
-        return self.socket.recv(length)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="meshtastic.tcp_interface.TCPInterface"><code class="flex name class">
-<span>class <span class="ident">TCPInterface</span></span>
-<span>(</span><span>hostname: ~AnyStr, debugOut=None, noProto=False, connectNow=True, portNumber=4403)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Interface class for meshtastic devices over a TCP link</p>
-<p>Constructor, opens a connection to a specified IP address/hostname</p>
-<p>Keyword Arguments:
-hostname {string} &ndash; Hostname/IP address of the device to connect to</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class TCPInterface(StreamInterface):
-    &#34;&#34;&#34;Interface class for meshtastic devices over a TCP link&#34;&#34;&#34;
-
-    def __init__(self, hostname: AnyStr, debugOut=None, noProto=False,
-                 connectNow=True, portNumber=4403):
-        &#34;&#34;&#34;Constructor, opens a connection to a specified IP address/hostname
-
-        Keyword Arguments:
-            hostname {string} -- Hostname/IP address of the device to connect to
-        &#34;&#34;&#34;
-
-        # Instead of wrapping as a stream, we use the native socket API
-        # self.stream = sock.makefile(&#39;rw&#39;)
-        self.stream = None
-
-        self.hostname = hostname
-        self.portNumber = portNumber
-
-        if connectNow:
-            logging.debug(f&#34;Connecting to {hostname}&#34;)
-            server_address = (hostname, portNumber)
-            sock = socket.create_connection(server_address)
-            self.socket = sock
-        else:
-            self.socket = None
-
-        StreamInterface.__init__(self, debugOut=debugOut, noProto=noProto,
-                                 connectNow=connectNow)
-
-    def myConnect(self):
-        &#34;&#34;&#34;Connect to socket&#34;&#34;&#34;
-        server_address = (self.hostname, self.portNumber)
-        sock = socket.create_connection(server_address)
-        self.socket = sock
-
-    def close(self):
-        &#34;&#34;&#34;Close a connection to the device&#34;&#34;&#34;
-        logging.debug(&#34;Closing TCP stream&#34;)
-        StreamInterface.close(self)
-        # Sometimes the socket read might be blocked in the reader thread.
-        # Therefore we force the shutdown by closing the socket here
-        self._wantExit = True
-        if not self.socket is None:
-            try:
-                self.socket.shutdown(socket.SHUT_RDWR)
-            except:
-                pass  # Ignore errors in shutdown, because we might have a race with the server
-            self.socket.close()
-
-    def _writeBytes(self, b):
-        &#34;&#34;&#34;Write an array of bytes to our stream and flush&#34;&#34;&#34;
-        self.socket.send(b)
-
-    def _readBytes(self, length):
-        &#34;&#34;&#34;Read an array of bytes from our stream&#34;&#34;&#34;
-        return self.socket.recv(length)</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>Methods</h3>
-<dl>
-<dt id="meshtastic.tcp_interface.TCPInterface.myConnect"><code class="name flex">
-<span>def <span class="ident">myConnect</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Connect to socket</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def myConnect(self):
-    &#34;&#34;&#34;Connect to socket&#34;&#34;&#34;
-    server_address = (self.hostname, self.portNumber)
-    sock = socket.create_connection(server_address)
-    self.socket = sock</code></pre>
-</details>
-</dd>
-</dl>
-<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.tcp_interface.TCPInterface" href="#meshtastic.tcp_interface.TCPInterface">TCPInterface</a></code></h4>
-<ul class="">
-<li><code><a title="meshtastic.tcp_interface.TCPInterface.myConnect" href="#meshtastic.tcp_interface.TCPInterface.myConnect">myConnect</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>

docs/meshtastic/test.html

@@ -1,544 +0,0 @@
-<!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.test API documentation</title>
-<meta name="description" content="With two radios connected serially, send and receive test
-messages and report back if successful." />
-<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">
-<p>With two radios connected serially, send and receive test
-messages and report back if successful.</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;With two radios connected serially, send and receive test
-   messages and report back if successful.
-&#34;&#34;&#34;
-import logging
-import time
-import sys
-import traceback
-from dotmap import DotMap
-from pubsub import pub
-import meshtastic.util
-from .__init__ import BROADCAST_NUM
-from .serial_interface import SerialInterface
-from .tcp_interface import TCPInterface
-
-
-&#34;&#34;&#34;The interfaces we are using for our tests&#34;&#34;&#34;
-interfaces = None
-
-&#34;&#34;&#34;A list of all packets we received while the current test was running&#34;&#34;&#34;
-receivedPackets = None
-
-testsRunning = False
-
-testNumber = 0
-
-sendingInterface = None
-
-
-def onReceive(packet, interface):
-    &#34;&#34;&#34;Callback invoked when a packet arrives&#34;&#34;&#34;
-    if sendingInterface == interface:
-        pass
-        # print(&#34;Ignoring sending interface&#34;)
-    else:
-        # print(f&#34;From {interface.stream.port}: {packet}&#34;)
-        p = DotMap(packet)
-
-        if p.decoded.portnum == &#34;TEXT_MESSAGE_APP&#34;:
-            # We only care a about clear text packets
-            if receivedPackets is not None:
-                receivedPackets.append(p)
-
-
-def onNode(node):
-    &#34;&#34;&#34;Callback invoked when the node DB changes&#34;&#34;&#34;
-    print(f&#34;Node changed: {node}&#34;)
-
-
-def subscribe():
-    &#34;&#34;&#34;Subscribe to the topics the user probably wants to see, prints output to stdout&#34;&#34;&#34;
-
-    pub.subscribe(onNode, &#34;meshtastic.node&#34;)
-
-
-def testSend(fromInterface, toInterface, isBroadcast=False, asBinary=False, wantAck=False):
-    &#34;&#34;&#34;
-    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
-    &#34;&#34;&#34;
-    global receivedPackets
-    receivedPackets = []
-    fromNode = fromInterface.myInfo.my_node_num
-
-    if isBroadcast:
-        toNode = BROADCAST_NUM
-    else:
-        toNode = toInterface.myInfo.my_node_num
-
-    logging.debug(
-        f&#34;Sending test wantAck={wantAck} packet from {fromNode} to {toNode}&#34;)
-    global sendingInterface
-    sendingInterface = fromInterface
-    if not asBinary:
-        fromInterface.sendText(f&#34;Test {testNumber}&#34;, toNode, wantAck=wantAck)
-    else:
-        fromInterface.sendData((f&#34;Binary {testNumber}&#34;).encode(
-            &#34;utf-8&#34;), toNode, wantAck=wantAck)
-    for _ in range(60):  # max of 60 secs before we timeout
-        time.sleep(1)
-        if  len(receivedPackets) &gt;= 1:
-            return True
-    return False  # Failed to send
-
-
-def runTests(numTests=50, wantAck=False, maxFailures=0):
-    &#34;&#34;&#34;Run the tests.&#34;&#34;&#34;
-    logging.info(f&#34;Running {numTests} tests with wantAck={wantAck}&#34;)
-    numFail = 0
-    numSuccess = 0
-    for _ 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&#34;Test {testNumber} failed, expected packet not received ({numFail} failures so far)&#34;)
-        else:
-            numSuccess = numSuccess + 1
-            logging.info(
-                f&#34;Test {testNumber} succeeded {numSuccess} successes {numFail} failures so far&#34;)
-
-        time.sleep(1)
-
-    if numFail &gt; maxFailures:
-        logging.error(&#34;Too many failures! Test failed!&#34;)
-        return False
-    return True
-
-
-def testThread(numTests=50):
-    &#34;&#34;&#34;Test thread&#34;&#34;&#34;
-    logging.info(&#34;Found devices, starting tests...&#34;)
-    result = runTests(numTests, wantAck=True)
-    if result:
-        # Run another test
-        # Allow a few dropped packets
-        result = runTests(numTests, wantAck=False, maxFailures=1)
-    return result
-
-
-def onConnection(topic=pub.AUTO_TOPIC):
-    &#34;&#34;&#34;Callback invoked when we connect/disconnect from a radio&#34;&#34;&#34;
-    print(f&#34;Connection changed: {topic.getName()}&#34;)
-
-
-def openDebugLog(portName):
-    &#34;&#34;&#34;Open the debug log file&#34;&#34;&#34;
-    debugname = &#34;log&#34; + portName.replace(&#34;/&#34;, &#34;_&#34;)
-    logging.info(f&#34;Writing serial debugging to {debugname}&#34;)
-    return open(debugname, &#39;w+&#39;, buffering=1, encoding=&#39;utf8&#39;)
-
-
-def testAll(numTests=5):
-    &#34;&#34;&#34;
-    Run a series of tests using devices we can find.
-    This is called from the cli with the &#34;--test&#34; option.
-
-    &#34;&#34;&#34;
-    ports = meshtastic.util.findPorts()
-    if len(ports) &lt; 2:
-        meshtastic.util.our_exit(&#34;Warning: Must have at least two devices connected to USB.&#34;)
-
-    pub.subscribe(onConnection, &#34;meshtastic.connection&#34;)
-    pub.subscribe(onReceive, &#34;meshtastic.receive&#34;)
-    global interfaces
-    interfaces = list(map(lambda port: SerialInterface(
-        port, debugOut=openDebugLog(port), connectNow=True), ports))
-
-    logging.info(&#34;Ports opened, starting test&#34;)
-    result = testThread(numTests)
-
-    for i in interfaces:
-        i.close()
-
-    return result
-
-
-def testSimulator():
-    &#34;&#34;&#34;
-    Assume that someone has launched meshtastic-native as a simulated node.
-    Talk to that node over TCP, do some operations and if they are successful
-    exit the process with a success code, else exit with a non zero exit code.
-
-    Run with
-    python3 -c &#39;from meshtastic.test import testSimulator; testSimulator()&#39;
-    &#34;&#34;&#34;
-    logging.basicConfig(level=logging.DEBUG)
-    logging.info(&#34;Connecting to simulator on localhost!&#34;)
-    try:
-        iface = TCPInterface(&#34;localhost&#34;)
-        iface.showInfo()
-        iface.localNode.showInfo()
-        iface.localNode.exitSimulator()
-        iface.close()
-        logging.info(&#34;Integration test successful!&#34;)
-    except:
-        print(&#34;Error while testing simulator:&#34;, sys.exc_info()[0])
-        traceback.print_exc()
-        sys.exit(1)
-    sys.exit(0)</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):
-    &#34;&#34;&#34;Callback invoked when we connect/disconnect from a radio&#34;&#34;&#34;
-    print(f&#34;Connection changed: {topic.getName()}&#34;)</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):
-    &#34;&#34;&#34;Callback invoked when the node DB changes&#34;&#34;&#34;
-    print(f&#34;Node changed: {node}&#34;)</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):
-    &#34;&#34;&#34;Callback invoked when a packet arrives&#34;&#34;&#34;
-    if sendingInterface == interface:
-        pass
-        # print(&#34;Ignoring sending interface&#34;)
-    else:
-        # print(f&#34;From {interface.stream.port}: {packet}&#34;)
-        p = DotMap(packet)
-
-        if p.decoded.portnum == &#34;TEXT_MESSAGE_APP&#34;:
-            # We only care a about clear text packets
-            if receivedPackets is not None:
-                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"><p>Open the debug log file</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def openDebugLog(portName):
-    &#34;&#34;&#34;Open the debug log file&#34;&#34;&#34;
-    debugname = &#34;log&#34; + portName.replace(&#34;/&#34;, &#34;_&#34;)
-    logging.info(f&#34;Writing serial debugging to {debugname}&#34;)
-    return open(debugname, &#39;w+&#39;, buffering=1, encoding=&#39;utf8&#39;)</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"><p>Run the tests.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def runTests(numTests=50, wantAck=False, maxFailures=0):
-    &#34;&#34;&#34;Run the tests.&#34;&#34;&#34;
-    logging.info(f&#34;Running {numTests} tests with wantAck={wantAck}&#34;)
-    numFail = 0
-    numSuccess = 0
-    for _ 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&#34;Test {testNumber} failed, expected packet not received ({numFail} failures so far)&#34;)
-        else:
-            numSuccess = numSuccess + 1
-            logging.info(
-                f&#34;Test {testNumber} succeeded {numSuccess} successes {numFail} failures so far&#34;)
-
-        time.sleep(1)
-
-    if numFail &gt; maxFailures:
-        logging.error(&#34;Too many failures! Test failed!&#34;)
-        return False
-    return True</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():
-    &#34;&#34;&#34;Subscribe to the topics the user probably wants to see, prints output to stdout&#34;&#34;&#34;
-
-    pub.subscribe(onNode, &#34;meshtastic.node&#34;)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.test.testAll"><code class="name flex">
-<span>def <span class="ident">testAll</span></span>(<span>numTests=5)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Run a series of tests using devices we can find.
-This is called from the cli with the "&ndash;test" option.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def testAll(numTests=5):
-    &#34;&#34;&#34;
-    Run a series of tests using devices we can find.
-    This is called from the cli with the &#34;--test&#34; option.
-
-    &#34;&#34;&#34;
-    ports = meshtastic.util.findPorts()
-    if len(ports) &lt; 2:
-        meshtastic.util.our_exit(&#34;Warning: Must have at least two devices connected to USB.&#34;)
-
-    pub.subscribe(onConnection, &#34;meshtastic.connection&#34;)
-    pub.subscribe(onReceive, &#34;meshtastic.receive&#34;)
-    global interfaces
-    interfaces = list(map(lambda port: SerialInterface(
-        port, debugOut=openDebugLog(port), connectNow=True), ports))
-
-    logging.info(&#34;Ports opened, starting test&#34;)
-    result = testThread(numTests)
-
-    for i in interfaces:
-        i.close()
-
-    return result</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]} &ndash; [description]
-toInterface {[type]} &ndash; [description]</p>
-<h2 id="returns">Returns</h2>
-<p>boolean &ndash; 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):
-    &#34;&#34;&#34;
-    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
-    &#34;&#34;&#34;
-    global receivedPackets
-    receivedPackets = []
-    fromNode = fromInterface.myInfo.my_node_num
-
-    if isBroadcast:
-        toNode = BROADCAST_NUM
-    else:
-        toNode = toInterface.myInfo.my_node_num
-
-    logging.debug(
-        f&#34;Sending test wantAck={wantAck} packet from {fromNode} to {toNode}&#34;)
-    global sendingInterface
-    sendingInterface = fromInterface
-    if not asBinary:
-        fromInterface.sendText(f&#34;Test {testNumber}&#34;, toNode, wantAck=wantAck)
-    else:
-        fromInterface.sendData((f&#34;Binary {testNumber}&#34;).encode(
-            &#34;utf-8&#34;), toNode, wantAck=wantAck)
-    for _ in range(60):  # max of 60 secs before we timeout
-        time.sleep(1)
-        if  len(receivedPackets) &gt;= 1:
-            return True
-    return False  # Failed to send</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.test.testSimulator"><code class="name flex">
-<span>def <span class="ident">testSimulator</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Assume that someone has launched meshtastic-native as a simulated node.
-Talk to that node over TCP, do some operations and if they are successful
-exit the process with a success code, else exit with a non zero exit code.</p>
-<p>Run with
-python3 -c 'from meshtastic.test import testSimulator; testSimulator()'</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def testSimulator():
-    &#34;&#34;&#34;
-    Assume that someone has launched meshtastic-native as a simulated node.
-    Talk to that node over TCP, do some operations and if they are successful
-    exit the process with a success code, else exit with a non zero exit code.
-
-    Run with
-    python3 -c &#39;from meshtastic.test import testSimulator; testSimulator()&#39;
-    &#34;&#34;&#34;
-    logging.basicConfig(level=logging.DEBUG)
-    logging.info(&#34;Connecting to simulator on localhost!&#34;)
-    try:
-        iface = TCPInterface(&#34;localhost&#34;)
-        iface.showInfo()
-        iface.localNode.showInfo()
-        iface.localNode.exitSimulator()
-        iface.close()
-        logging.info(&#34;Integration test successful!&#34;)
-    except:
-        print(&#34;Error while testing simulator:&#34;, sys.exc_info()[0])
-        traceback.print_exc()
-        sys.exit(1)
-    sys.exit(0)</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"><p>Test thread</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def testThread(numTests=50):
-    &#34;&#34;&#34;Test thread&#34;&#34;&#34;
-    logging.info(&#34;Found devices, starting tests...&#34;)
-    result = runTests(numTests, wantAck=True)
-    if result:
-        # Run another test
-        # Allow a few dropped packets
-        result = runTests(numTests, wantAck=False, maxFailures=1)
-    return result</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.testSimulator" href="#meshtastic.test.testSimulator">testSimulator</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" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
-</footer>
-</body>
-</html>

docs/meshtastic/tests/conftest.html

@@ -1,199 +0,0 @@
-<!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.tests.conftest API documentation</title>
-<meta name="description" content="Common pytest code (place for fixtures)." />
-<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.tests.conftest</code></h1>
-</header>
-<section id="section-intro">
-<p>Common pytest code (place for fixtures).</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Common pytest code (place for fixtures).&#34;&#34;&#34;
-
-import argparse
-
-from unittest.mock import MagicMock
-import pytest
-
-from meshtastic.__main__ import Globals
-from ..mesh_interface import MeshInterface
-
-
-@pytest.fixture
-def reset_globals():
-    &#34;&#34;&#34;Fixture to reset globals.&#34;&#34;&#34;
-    parser = None
-    parser = argparse.ArgumentParser()
-    Globals.getInstance().reset()
-    Globals.getInstance().set_parser(parser)
-
-
-@pytest.fixture
-def iface_with_nodes():
-    &#34;&#34;&#34;Fixture to setup some nodes.&#34;&#34;&#34;
-    nodesById = {
-            &#39;!9388f81c&#39;: {
-                &#39;num&#39;: 2475227164,
-                &#39;user&#39;: {
-                    &#39;id&#39;: &#39;!9388f81c&#39;,
-                    &#39;longName&#39;: &#39;Unknown f81c&#39;,
-                    &#39;shortName&#39;: &#39;?1C&#39;,
-                    &#39;macaddr&#39;: &#39;RBeTiPgc&#39;,
-                    &#39;hwModel&#39;: &#39;TBEAM&#39;
-                    },
-                &#39;position&#39;: {},
-                &#39;lastHeard&#39;: 1640204888
-                }
-            }
-
-    nodesByNum = {
-            2475227164: {
-                &#39;num&#39;: 2475227164,
-                &#39;user&#39;: {
-                    &#39;id&#39;: &#39;!9388f81c&#39;,
-                    &#39;longName&#39;: &#39;Unknown f81c&#39;,
-                    &#39;shortName&#39;: &#39;?1C&#39;,
-                    &#39;macaddr&#39;: &#39;RBeTiPgc&#39;,
-                    &#39;hwModel&#39;: &#39;TBEAM&#39;
-                    },
-                &#39;position&#39;: {
-                    &#39;time&#39;: 1640206266
-                    },
-                &#39;lastHeard&#39;: 1640206266
-                }
-            }
-    iface = MeshInterface(noProto=True)
-    iface.nodes = nodesById
-    iface.nodesByNum = nodesByNum
-    myInfo = MagicMock()
-    iface.myInfo = myInfo
-    iface.myInfo.my_node_num = 2475227164
-    return iface</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="meshtastic.tests.conftest.iface_with_nodes"><code class="name flex">
-<span>def <span class="ident">iface_with_nodes</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Fixture to setup some nodes.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.fixture
-def iface_with_nodes():
-    &#34;&#34;&#34;Fixture to setup some nodes.&#34;&#34;&#34;
-    nodesById = {
-            &#39;!9388f81c&#39;: {
-                &#39;num&#39;: 2475227164,
-                &#39;user&#39;: {
-                    &#39;id&#39;: &#39;!9388f81c&#39;,
-                    &#39;longName&#39;: &#39;Unknown f81c&#39;,
-                    &#39;shortName&#39;: &#39;?1C&#39;,
-                    &#39;macaddr&#39;: &#39;RBeTiPgc&#39;,
-                    &#39;hwModel&#39;: &#39;TBEAM&#39;
-                    },
-                &#39;position&#39;: {},
-                &#39;lastHeard&#39;: 1640204888
-                }
-            }
-
-    nodesByNum = {
-            2475227164: {
-                &#39;num&#39;: 2475227164,
-                &#39;user&#39;: {
-                    &#39;id&#39;: &#39;!9388f81c&#39;,
-                    &#39;longName&#39;: &#39;Unknown f81c&#39;,
-                    &#39;shortName&#39;: &#39;?1C&#39;,
-                    &#39;macaddr&#39;: &#39;RBeTiPgc&#39;,
-                    &#39;hwModel&#39;: &#39;TBEAM&#39;
-                    },
-                &#39;position&#39;: {
-                    &#39;time&#39;: 1640206266
-                    },
-                &#39;lastHeard&#39;: 1640206266
-                }
-            }
-    iface = MeshInterface(noProto=True)
-    iface.nodes = nodesById
-    iface.nodesByNum = nodesByNum
-    myInfo = MagicMock()
-    iface.myInfo = myInfo
-    iface.myInfo.my_node_num = 2475227164
-    return iface</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.conftest.reset_globals"><code class="name flex">
-<span>def <span class="ident">reset_globals</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Fixture to reset globals.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.fixture
-def reset_globals():
-    &#34;&#34;&#34;Fixture to reset globals.&#34;&#34;&#34;
-    parser = None
-    parser = argparse.ArgumentParser()
-    Globals.getInstance().reset()
-    Globals.getInstance().set_parser(parser)</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.tests" href="index.html">meshtastic.tests</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="meshtastic.tests.conftest.iface_with_nodes" href="#meshtastic.tests.conftest.iface_with_nodes">iface_with_nodes</a></code></li>
-<li><code><a title="meshtastic.tests.conftest.reset_globals" href="#meshtastic.tests.conftest.reset_globals">reset_globals</a></code></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>

docs/meshtastic/tests/index.html

@@ -1,142 +0,0 @@
-<!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.tests 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.tests</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="meshtastic.tests.conftest" href="conftest.html">meshtastic.tests.conftest</a></code></dt>
-<dd>
-<div class="desc"><p>Common pytest code (place for fixtures).</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.tests.test_ble_interface" href="test_ble_interface.html">meshtastic.tests.test_ble_interface</a></code></dt>
-<dd>
-<div class="desc"><p>Meshtastic unit tests for ble_interface.py</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.tests.test_examples" href="test_examples.html">meshtastic.tests.test_examples</a></code></dt>
-<dd>
-<div class="desc"><p>Meshtastic test that the examples run as expected.
-We assume you have a python virtual environment in current directory.
-If not, you need to run: …</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.tests.test_globals" href="test_globals.html">meshtastic.tests.test_globals</a></code></dt>
-<dd>
-<div class="desc"><p>Meshtastic unit tests for globals.py</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.tests.test_int" href="test_int.html">meshtastic.tests.test_int</a></code></dt>
-<dd>
-<div class="desc"><p>Meshtastic integration tests</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.tests.test_main" href="test_main.html">meshtastic.tests.test_main</a></code></dt>
-<dd>
-<div class="desc"><p>Meshtastic unit tests for <strong>main</strong>.py</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.tests.test_mesh_interface" href="test_mesh_interface.html">meshtastic.tests.test_mesh_interface</a></code></dt>
-<dd>
-<div class="desc"><p>Meshtastic unit tests for mesh_interface.py</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.tests.test_node" href="test_node.html">meshtastic.tests.test_node</a></code></dt>
-<dd>
-<div class="desc"><p>Meshtastic unit tests for node.py</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.tests.test_remote_hardware" href="test_remote_hardware.html">meshtastic.tests.test_remote_hardware</a></code></dt>
-<dd>
-<div class="desc"><p>Meshtastic unit tests for remote_hardware.py</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.tests.test_serial_interface" href="test_serial_interface.html">meshtastic.tests.test_serial_interface</a></code></dt>
-<dd>
-<div class="desc"><p>Meshtastic unit tests for serial_interface.py</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.tests.test_smoke1" href="test_smoke1.html">meshtastic.tests.test_smoke1</a></code></dt>
-<dd>
-<div class="desc"><p>Meshtastic smoke tests with a single device via USB</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.tests.test_smoke2" href="test_smoke2.html">meshtastic.tests.test_smoke2</a></code></dt>
-<dd>
-<div class="desc"><p>Meshtastic smoke tests with 2 devices connected via USB</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.tests.test_smoke_wifi" href="test_smoke_wifi.html">meshtastic.tests.test_smoke_wifi</a></code></dt>
-<dd>
-<div class="desc"><p>Meshtastic smoke tests a device setup with wifi …</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.tests.test_stream_interface" href="test_stream_interface.html">meshtastic.tests.test_stream_interface</a></code></dt>
-<dd>
-<div class="desc"><p>Meshtastic unit tests for stream_interface.py</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.tests.test_tcp_interface" href="test_tcp_interface.html">meshtastic.tests.test_tcp_interface</a></code></dt>
-<dd>
-<div class="desc"><p>Meshtastic unit tests for tcp_interface.py</p></div>
-</dd>
-<dt><code class="name"><a title="meshtastic.tests.test_util" href="test_util.html">meshtastic.tests.test_util</a></code></dt>
-<dd>
-<div class="desc"><p>Meshtastic unit tests for util.py</p></div>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</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-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="meshtastic.tests.conftest" href="conftest.html">meshtastic.tests.conftest</a></code></li>
-<li><code><a title="meshtastic.tests.test_ble_interface" href="test_ble_interface.html">meshtastic.tests.test_ble_interface</a></code></li>
-<li><code><a title="meshtastic.tests.test_examples" href="test_examples.html">meshtastic.tests.test_examples</a></code></li>
-<li><code><a title="meshtastic.tests.test_globals" href="test_globals.html">meshtastic.tests.test_globals</a></code></li>
-<li><code><a title="meshtastic.tests.test_int" href="test_int.html">meshtastic.tests.test_int</a></code></li>
-<li><code><a title="meshtastic.tests.test_main" href="test_main.html">meshtastic.tests.test_main</a></code></li>
-<li><code><a title="meshtastic.tests.test_mesh_interface" href="test_mesh_interface.html">meshtastic.tests.test_mesh_interface</a></code></li>
-<li><code><a title="meshtastic.tests.test_node" href="test_node.html">meshtastic.tests.test_node</a></code></li>
-<li><code><a title="meshtastic.tests.test_remote_hardware" href="test_remote_hardware.html">meshtastic.tests.test_remote_hardware</a></code></li>
-<li><code><a title="meshtastic.tests.test_serial_interface" href="test_serial_interface.html">meshtastic.tests.test_serial_interface</a></code></li>
-<li><code><a title="meshtastic.tests.test_smoke1" href="test_smoke1.html">meshtastic.tests.test_smoke1</a></code></li>
-<li><code><a title="meshtastic.tests.test_smoke2" href="test_smoke2.html">meshtastic.tests.test_smoke2</a></code></li>
-<li><code><a title="meshtastic.tests.test_smoke_wifi" href="test_smoke_wifi.html">meshtastic.tests.test_smoke_wifi</a></code></li>
-<li><code><a title="meshtastic.tests.test_stream_interface" href="test_stream_interface.html">meshtastic.tests.test_stream_interface</a></code></li>
-<li><code><a title="meshtastic.tests.test_tcp_interface" href="test_tcp_interface.html">meshtastic.tests.test_tcp_interface</a></code></li>
-<li><code><a title="meshtastic.tests.test_util" href="test_util.html">meshtastic.tests.test_util</a></code></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>

docs/meshtastic/tests/test_ble_interface.html

@@ -1,95 +0,0 @@
-<!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.tests.test_ble_interface API documentation</title>
-<meta name="description" content="Meshtastic unit tests for ble_interface.py" />
-<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.tests.test_ble_interface</code></h1>
-</header>
-<section id="section-intro">
-<p>Meshtastic unit tests for ble_interface.py</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Meshtastic unit tests for ble_interface.py&#34;&#34;&#34;
-
-
-import pytest
-
-from ..ble_interface import BLEInterface
-
-@pytest.mark.unit
-def test_BLEInterface():
-    &#34;&#34;&#34;Test that we can instantiate a BLEInterface&#34;&#34;&#34;
-    iface = BLEInterface(&#39;foo&#39;, debugOut=True, noProto=True)
-    iface.close()</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="meshtastic.tests.test_ble_interface.test_BLEInterface"><code class="name flex">
-<span>def <span class="ident">test_BLEInterface</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test that we can instantiate a BLEInterface</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_BLEInterface():
-    &#34;&#34;&#34;Test that we can instantiate a BLEInterface&#34;&#34;&#34;
-    iface = BLEInterface(&#39;foo&#39;, debugOut=True, noProto=True)
-    iface.close()</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.tests" href="index.html">meshtastic.tests</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="meshtastic.tests.test_ble_interface.test_BLEInterface" href="#meshtastic.tests.test_ble_interface.test_BLEInterface">test_BLEInterface</a></code></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>

docs/meshtastic/tests/test_examples.html

@@ -1,132 +0,0 @@
-<!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.tests.test_examples API documentation</title>
-<meta name="description" content="Meshtastic test that the examples run as expected.
-We assume you have a python virtual environment in current directory.
-If not, you need to run: …" />
-<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.tests.test_examples</code></h1>
-</header>
-<section id="section-intro">
-<p>Meshtastic test that the examples run as expected.
-We assume you have a python virtual environment in current directory.
-If not, you need to run: "python3 -m venv venv", "source venv/bin/activate", "pip install ."</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Meshtastic test that the examples run as expected.
-   We assume you have a python virtual environment in current directory.
-   If not, you need to run: &#34;python3 -m venv venv&#34;, &#34;source venv/bin/activate&#34;, &#34;pip install .&#34;
-&#34;&#34;&#34;
-import subprocess
-
-import pytest
-
-@pytest.mark.examples
-def test_examples_hello_world_serial_no_arg():
-    &#34;&#34;&#34;Test hello_world_serial without any args&#34;&#34;&#34;
-    return_value, _ = subprocess.getstatusoutput(&#39;source venv/bin/activate; python3 examples/hello_world_serial.py&#39;)
-    assert return_value == 3
-
-
-@pytest.mark.examples
-def test_examples_hello_world_serial_with_arg(capsys):
-    &#34;&#34;&#34;Test hello_world_serial with arg&#34;&#34;&#34;
-    return_value, _ = subprocess.getstatusoutput(&#39;source venv/bin/activate; python3 examples/hello_world_serial.py hello&#39;)
-    assert return_value == 1
-    _, err = capsys.readouterr()
-    assert err == &#39;&#39;
-    # TODO: Why does this not work?
-    # assert out == &#39;Warning: No Meshtastic devices detected.&#39;</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="meshtastic.tests.test_examples.test_examples_hello_world_serial_no_arg"><code class="name flex">
-<span>def <span class="ident">test_examples_hello_world_serial_no_arg</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test hello_world_serial without any args</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.examples
-def test_examples_hello_world_serial_no_arg():
-    &#34;&#34;&#34;Test hello_world_serial without any args&#34;&#34;&#34;
-    return_value, _ = subprocess.getstatusoutput(&#39;source venv/bin/activate; python3 examples/hello_world_serial.py&#39;)
-    assert return_value == 3</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_examples.test_examples_hello_world_serial_with_arg"><code class="name flex">
-<span>def <span class="ident">test_examples_hello_world_serial_with_arg</span></span>(<span>capsys)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test hello_world_serial with arg</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.examples
-def test_examples_hello_world_serial_with_arg(capsys):
-    &#34;&#34;&#34;Test hello_world_serial with arg&#34;&#34;&#34;
-    return_value, _ = subprocess.getstatusoutput(&#39;source venv/bin/activate; python3 examples/hello_world_serial.py hello&#39;)
-    assert return_value == 1
-    _, err = capsys.readouterr()
-    assert err == &#39;&#39;
-    # TODO: Why does this not work?
-    # assert out == &#39;Warning: No Meshtastic devices detected.&#39;</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.tests" href="index.html">meshtastic.tests</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="meshtastic.tests.test_examples.test_examples_hello_world_serial_no_arg" href="#meshtastic.tests.test_examples.test_examples_hello_world_serial_no_arg">test_examples_hello_world_serial_no_arg</a></code></li>
-<li><code><a title="meshtastic.tests.test_examples.test_examples_hello_world_serial_with_arg" href="#meshtastic.tests.test_examples.test_examples_hello_world_serial_with_arg">test_examples_hello_world_serial_with_arg</a></code></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>

docs/meshtastic/tests/test_globals.html

@@ -1,130 +0,0 @@
-<!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.tests.test_globals API documentation</title>
-<meta name="description" content="Meshtastic unit tests for globals.py" />
-<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.tests.test_globals</code></h1>
-</header>
-<section id="section-intro">
-<p>Meshtastic unit tests for globals.py</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Meshtastic unit tests for globals.py
-&#34;&#34;&#34;
-
-import pytest
-
-from ..globals import Globals
-
-
-@pytest.mark.unit
-def test_globals_get_instaance():
-    &#34;&#34;&#34;Test that we can instantiate a Globals instance&#34;&#34;&#34;
-    ourglobals = Globals.getInstance()
-    ourglobals2 = Globals.getInstance()
-    assert ourglobals == ourglobals2
-
-
-@pytest.mark.unit
-def test_globals_there_can_be_only_one():
-    &#34;&#34;&#34;Test that we can cannot create two Globals instances&#34;&#34;&#34;
-    # if we have an instance, delete it
-    Globals.getInstance()
-    with pytest.raises(Exception) as pytest_wrapped_e:
-        # try to create another instance
-        Globals()
-    assert pytest_wrapped_e.type == Exception</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="meshtastic.tests.test_globals.test_globals_get_instaance"><code class="name flex">
-<span>def <span class="ident">test_globals_get_instaance</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test that we can instantiate a Globals instance</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_globals_get_instaance():
-    &#34;&#34;&#34;Test that we can instantiate a Globals instance&#34;&#34;&#34;
-    ourglobals = Globals.getInstance()
-    ourglobals2 = Globals.getInstance()
-    assert ourglobals == ourglobals2</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_globals.test_globals_there_can_be_only_one"><code class="name flex">
-<span>def <span class="ident">test_globals_there_can_be_only_one</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test that we can cannot create two Globals instances</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_globals_there_can_be_only_one():
-    &#34;&#34;&#34;Test that we can cannot create two Globals instances&#34;&#34;&#34;
-    # if we have an instance, delete it
-    Globals.getInstance()
-    with pytest.raises(Exception) as pytest_wrapped_e:
-        # try to create another instance
-        Globals()
-    assert pytest_wrapped_e.type == Exception</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.tests" href="index.html">meshtastic.tests</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="meshtastic.tests.test_globals.test_globals_get_instaance" href="#meshtastic.tests.test_globals.test_globals_get_instaance">test_globals_get_instaance</a></code></li>
-<li><code><a title="meshtastic.tests.test_globals.test_globals_there_can_be_only_one" href="#meshtastic.tests.test_globals.test_globals_there_can_be_only_one">test_globals_there_can_be_only_one</a></code></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>

docs/meshtastic/tests/test_int.html

@@ -1,177 +0,0 @@
-<!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.tests.test_int API documentation</title>
-<meta name="description" content="Meshtastic integration tests" />
-<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.tests.test_int</code></h1>
-</header>
-<section id="section-intro">
-<p>Meshtastic integration tests</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Meshtastic integration tests&#34;&#34;&#34;
-import re
-import subprocess
-
-import pytest
-
-
-@pytest.mark.int
-def test_int_no_args():
-    &#34;&#34;&#34;Test without any args&#34;&#34;&#34;
-    return_value, out = subprocess.getstatusoutput(&#39;meshtastic&#39;)
-    assert re.match(r&#39;usage: meshtastic&#39;, out)
-    assert return_value == 1
-
-
-@pytest.mark.int
-def test_int_version():
-    &#34;&#34;&#34;Test &#39;--version&#39;.&#34;&#34;&#34;
-    return_value, out = subprocess.getstatusoutput(&#39;meshtastic --version&#39;)
-    assert re.match(r&#39;[0-9]+\.[0-9]+\.[0-9]&#39;, out)
-    assert return_value == 0
-
-
-@pytest.mark.int
-def test_int_help():
-    &#34;&#34;&#34;Test &#39;--help&#39;.&#34;&#34;&#34;
-    return_value, out = subprocess.getstatusoutput(&#39;meshtastic --help&#39;)
-    assert re.match(r&#39;usage: meshtastic &#39;, out)
-    assert return_value == 0
-
-
-@pytest.mark.int
-def test_int_support():
-    &#34;&#34;&#34;Test &#39;--support&#39;.&#34;&#34;&#34;
-    return_value, out = subprocess.getstatusoutput(&#39;meshtastic --support&#39;)
-    assert re.search(r&#39;System&#39;, out)
-    assert re.search(r&#39;Python&#39;, out)
-    assert return_value == 0</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="meshtastic.tests.test_int.test_int_help"><code class="name flex">
-<span>def <span class="ident">test_int_help</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test '&ndash;help'.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.int
-def test_int_help():
-    &#34;&#34;&#34;Test &#39;--help&#39;.&#34;&#34;&#34;
-    return_value, out = subprocess.getstatusoutput(&#39;meshtastic --help&#39;)
-    assert re.match(r&#39;usage: meshtastic &#39;, out)
-    assert return_value == 0</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_int.test_int_no_args"><code class="name flex">
-<span>def <span class="ident">test_int_no_args</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test without any args</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.int
-def test_int_no_args():
-    &#34;&#34;&#34;Test without any args&#34;&#34;&#34;
-    return_value, out = subprocess.getstatusoutput(&#39;meshtastic&#39;)
-    assert re.match(r&#39;usage: meshtastic&#39;, out)
-    assert return_value == 1</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_int.test_int_support"><code class="name flex">
-<span>def <span class="ident">test_int_support</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test '&ndash;support'.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.int
-def test_int_support():
-    &#34;&#34;&#34;Test &#39;--support&#39;.&#34;&#34;&#34;
-    return_value, out = subprocess.getstatusoutput(&#39;meshtastic --support&#39;)
-    assert re.search(r&#39;System&#39;, out)
-    assert re.search(r&#39;Python&#39;, out)
-    assert return_value == 0</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_int.test_int_version"><code class="name flex">
-<span>def <span class="ident">test_int_version</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test '&ndash;version'.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.int
-def test_int_version():
-    &#34;&#34;&#34;Test &#39;--version&#39;.&#34;&#34;&#34;
-    return_value, out = subprocess.getstatusoutput(&#39;meshtastic --version&#39;)
-    assert re.match(r&#39;[0-9]+\.[0-9]+\.[0-9]&#39;, out)
-    assert return_value == 0</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.tests" href="index.html">meshtastic.tests</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="meshtastic.tests.test_int.test_int_help" href="#meshtastic.tests.test_int.test_int_help">test_int_help</a></code></li>
-<li><code><a title="meshtastic.tests.test_int.test_int_no_args" href="#meshtastic.tests.test_int.test_int_no_args">test_int_no_args</a></code></li>
-<li><code><a title="meshtastic.tests.test_int.test_int_support" href="#meshtastic.tests.test_int.test_int_support">test_int_support</a></code></li>
-<li><code><a title="meshtastic.tests.test_int.test_int_version" href="#meshtastic.tests.test_int.test_int_version">test_int_version</a></code></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>

docs/meshtastic/tests/test_remote_hardware.html

@@ -1,304 +0,0 @@
-<!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.tests.test_remote_hardware API documentation</title>
-<meta name="description" content="Meshtastic unit tests for remote_hardware.py" />
-<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.tests.test_remote_hardware</code></h1>
-</header>
-<section id="section-intro">
-<p>Meshtastic unit tests for remote_hardware.py</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Meshtastic unit tests for remote_hardware.py&#34;&#34;&#34;
-
-import logging
-import re
-
-from unittest.mock import patch, MagicMock
-import pytest
-
-from ..remote_hardware import RemoteHardwareClient, onGPIOreceive
-from ..serial_interface import SerialInterface
-
-
-@pytest.mark.unit
-def test_RemoteHardwareClient():
-    &#34;&#34;&#34;Test that we can instantiate a RemoteHardwareClient instance&#34;&#34;&#34;
-    iface = MagicMock(autospec=SerialInterface)
-    rhw = RemoteHardwareClient(iface)
-    assert rhw.iface == iface
-    iface.close()
-
-
-@pytest.mark.unit
-def test_onGPIOreceive(capsys):
-    &#34;&#34;&#34;Test onGPIOreceive&#34;&#34;&#34;
-    iface = MagicMock(autospec=SerialInterface)
-    packet = {&#39;decoded&#39;: {&#39;remotehw&#39;: {&#39;typ&#39;: &#39;foo&#39;, &#39;gpioValue&#39;: &#39;4096&#39; }}}
-    onGPIOreceive(packet, iface)
-    out, err = capsys.readouterr()
-    assert re.search(r&#39;Received RemoteHardware&#39;, out)
-    assert err == &#39;&#39;
-
-
-@pytest.mark.unit
-def test_RemoteHardwareClient_no_gpio_channel(capsys):
-    &#34;&#34;&#34;Test that we can instantiate a RemoteHardwareClient instance but there is no channel named channel &#39;gpio&#39;&#34;&#34;&#34;
-    iface = MagicMock(autospec=SerialInterface)
-    with patch(&#39;meshtastic.serial_interface.SerialInterface&#39;, return_value=iface) as mo:
-        mo.localNode.getChannelByName.return_value = None
-        with pytest.raises(SystemExit) as pytest_wrapped_e:
-            RemoteHardwareClient(mo)
-        assert pytest_wrapped_e.type == SystemExit
-        assert pytest_wrapped_e.value.code == 1
-        out, err = capsys.readouterr()
-        assert re.search(r&#39;Warning: No channel named&#39;, out)
-        assert err == &#34;&#34;
-
-
-@pytest.mark.unit
-def test_readGPIOs(caplog):
-    &#34;&#34;&#34;Test readGPIOs&#34;&#34;&#34;
-    iface = MagicMock(autospec=SerialInterface)
-    rhw = RemoteHardwareClient(iface)
-    with caplog.at_level(logging.DEBUG):
-        rhw.readGPIOs(&#39;0x10&#39;, 123)
-    assert re.search(r&#39;readGPIOs&#39;, caplog.text, re.MULTILINE)
-    iface.close()
-
-
-@pytest.mark.unit
-def test_writeGPIOs(caplog):
-    &#34;&#34;&#34;Test writeGPIOs&#34;&#34;&#34;
-    iface = MagicMock(autospec=SerialInterface)
-    rhw = RemoteHardwareClient(iface)
-    with caplog.at_level(logging.DEBUG):
-        rhw.writeGPIOs(&#39;0x10&#39;, 123, 1)
-    assert re.search(r&#39;writeGPIOs&#39;, caplog.text, re.MULTILINE)
-    iface.close()
-
-
-@pytest.mark.unit
-def test_watchGPIOs(caplog):
-    &#34;&#34;&#34;Test watchGPIOs&#34;&#34;&#34;
-    iface = MagicMock(autospec=SerialInterface)
-    rhw = RemoteHardwareClient(iface)
-    with caplog.at_level(logging.DEBUG):
-        rhw.watchGPIOs(&#39;0x10&#39;, 123)
-    assert re.search(r&#39;watchGPIOs&#39;, caplog.text, re.MULTILINE)
-    iface.close()
-
-
-@pytest.mark.unit
-def test_sendHardware_no_nodeid():
-    &#34;&#34;&#34;Test sending no nodeid to _sendHardware()&#34;&#34;&#34;
-    iface = MagicMock(autospec=SerialInterface)
-    with patch(&#39;meshtastic.serial_interface.SerialInterface&#39;, return_value=iface) as mo:
-        with pytest.raises(SystemExit) as pytest_wrapped_e:
-            rhw = RemoteHardwareClient(mo)
-            rhw._sendHardware(None, None)
-        assert pytest_wrapped_e.type == SystemExit</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="meshtastic.tests.test_remote_hardware.test_RemoteHardwareClient"><code class="name flex">
-<span>def <span class="ident">test_RemoteHardwareClient</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test that we can instantiate a RemoteHardwareClient instance</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_RemoteHardwareClient():
-    &#34;&#34;&#34;Test that we can instantiate a RemoteHardwareClient instance&#34;&#34;&#34;
-    iface = MagicMock(autospec=SerialInterface)
-    rhw = RemoteHardwareClient(iface)
-    assert rhw.iface == iface
-    iface.close()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_remote_hardware.test_RemoteHardwareClient_no_gpio_channel"><code class="name flex">
-<span>def <span class="ident">test_RemoteHardwareClient_no_gpio_channel</span></span>(<span>capsys)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test that we can instantiate a RemoteHardwareClient instance but there is no channel named channel 'gpio'</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_RemoteHardwareClient_no_gpio_channel(capsys):
-    &#34;&#34;&#34;Test that we can instantiate a RemoteHardwareClient instance but there is no channel named channel &#39;gpio&#39;&#34;&#34;&#34;
-    iface = MagicMock(autospec=SerialInterface)
-    with patch(&#39;meshtastic.serial_interface.SerialInterface&#39;, return_value=iface) as mo:
-        mo.localNode.getChannelByName.return_value = None
-        with pytest.raises(SystemExit) as pytest_wrapped_e:
-            RemoteHardwareClient(mo)
-        assert pytest_wrapped_e.type == SystemExit
-        assert pytest_wrapped_e.value.code == 1
-        out, err = capsys.readouterr()
-        assert re.search(r&#39;Warning: No channel named&#39;, out)
-        assert err == &#34;&#34;</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_remote_hardware.test_onGPIOreceive"><code class="name flex">
-<span>def <span class="ident">test_onGPIOreceive</span></span>(<span>capsys)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test onGPIOreceive</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_onGPIOreceive(capsys):
-    &#34;&#34;&#34;Test onGPIOreceive&#34;&#34;&#34;
-    iface = MagicMock(autospec=SerialInterface)
-    packet = {&#39;decoded&#39;: {&#39;remotehw&#39;: {&#39;typ&#39;: &#39;foo&#39;, &#39;gpioValue&#39;: &#39;4096&#39; }}}
-    onGPIOreceive(packet, iface)
-    out, err = capsys.readouterr()
-    assert re.search(r&#39;Received RemoteHardware&#39;, out)
-    assert err == &#39;&#39;</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_remote_hardware.test_readGPIOs"><code class="name flex">
-<span>def <span class="ident">test_readGPIOs</span></span>(<span>caplog)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test readGPIOs</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_readGPIOs(caplog):
-    &#34;&#34;&#34;Test readGPIOs&#34;&#34;&#34;
-    iface = MagicMock(autospec=SerialInterface)
-    rhw = RemoteHardwareClient(iface)
-    with caplog.at_level(logging.DEBUG):
-        rhw.readGPIOs(&#39;0x10&#39;, 123)
-    assert re.search(r&#39;readGPIOs&#39;, caplog.text, re.MULTILINE)
-    iface.close()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_remote_hardware.test_sendHardware_no_nodeid"><code class="name flex">
-<span>def <span class="ident">test_sendHardware_no_nodeid</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test sending no nodeid to _sendHardware()</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_sendHardware_no_nodeid():
-    &#34;&#34;&#34;Test sending no nodeid to _sendHardware()&#34;&#34;&#34;
-    iface = MagicMock(autospec=SerialInterface)
-    with patch(&#39;meshtastic.serial_interface.SerialInterface&#39;, return_value=iface) as mo:
-        with pytest.raises(SystemExit) as pytest_wrapped_e:
-            rhw = RemoteHardwareClient(mo)
-            rhw._sendHardware(None, None)
-        assert pytest_wrapped_e.type == SystemExit</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_remote_hardware.test_watchGPIOs"><code class="name flex">
-<span>def <span class="ident">test_watchGPIOs</span></span>(<span>caplog)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test watchGPIOs</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_watchGPIOs(caplog):
-    &#34;&#34;&#34;Test watchGPIOs&#34;&#34;&#34;
-    iface = MagicMock(autospec=SerialInterface)
-    rhw = RemoteHardwareClient(iface)
-    with caplog.at_level(logging.DEBUG):
-        rhw.watchGPIOs(&#39;0x10&#39;, 123)
-    assert re.search(r&#39;watchGPIOs&#39;, caplog.text, re.MULTILINE)
-    iface.close()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_remote_hardware.test_writeGPIOs"><code class="name flex">
-<span>def <span class="ident">test_writeGPIOs</span></span>(<span>caplog)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test writeGPIOs</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_writeGPIOs(caplog):
-    &#34;&#34;&#34;Test writeGPIOs&#34;&#34;&#34;
-    iface = MagicMock(autospec=SerialInterface)
-    rhw = RemoteHardwareClient(iface)
-    with caplog.at_level(logging.DEBUG):
-        rhw.writeGPIOs(&#39;0x10&#39;, 123, 1)
-    assert re.search(r&#39;writeGPIOs&#39;, caplog.text, re.MULTILINE)
-    iface.close()</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.tests" href="index.html">meshtastic.tests</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="meshtastic.tests.test_remote_hardware.test_RemoteHardwareClient" href="#meshtastic.tests.test_remote_hardware.test_RemoteHardwareClient">test_RemoteHardwareClient</a></code></li>
-<li><code><a title="meshtastic.tests.test_remote_hardware.test_RemoteHardwareClient_no_gpio_channel" href="#meshtastic.tests.test_remote_hardware.test_RemoteHardwareClient_no_gpio_channel">test_RemoteHardwareClient_no_gpio_channel</a></code></li>
-<li><code><a title="meshtastic.tests.test_remote_hardware.test_onGPIOreceive" href="#meshtastic.tests.test_remote_hardware.test_onGPIOreceive">test_onGPIOreceive</a></code></li>
-<li><code><a title="meshtastic.tests.test_remote_hardware.test_readGPIOs" href="#meshtastic.tests.test_remote_hardware.test_readGPIOs">test_readGPIOs</a></code></li>
-<li><code><a title="meshtastic.tests.test_remote_hardware.test_sendHardware_no_nodeid" href="#meshtastic.tests.test_remote_hardware.test_sendHardware_no_nodeid">test_sendHardware_no_nodeid</a></code></li>
-<li><code><a title="meshtastic.tests.test_remote_hardware.test_watchGPIOs" href="#meshtastic.tests.test_remote_hardware.test_watchGPIOs">test_watchGPIOs</a></code></li>
-<li><code><a title="meshtastic.tests.test_remote_hardware.test_writeGPIOs" href="#meshtastic.tests.test_remote_hardware.test_writeGPIOs">test_writeGPIOs</a></code></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>

docs/meshtastic/tests/test_serial_interface.html

@@ -1,186 +0,0 @@
-<!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.tests.test_serial_interface API documentation</title>
-<meta name="description" content="Meshtastic unit tests for serial_interface.py" />
-<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.tests.test_serial_interface</code></h1>
-</header>
-<section id="section-intro">
-<p>Meshtastic unit tests for serial_interface.py</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Meshtastic unit tests for serial_interface.py&#34;&#34;&#34;
-
-import re
-
-
-from unittest.mock import patch
-import pytest
-
-from ..serial_interface import SerialInterface
-
-@pytest.mark.unit
-@patch(&#39;serial.Serial&#39;)
-@patch(&#39;meshtastic.util.findPorts&#39;, return_value=[&#39;/dev/ttyUSBfake&#39;])
-def test_SerialInterface_single_port(mocked_findPorts, mocked_serial):
-    &#34;&#34;&#34;Test that we can instantiate a SerialInterface with a single port&#34;&#34;&#34;
-    iface = SerialInterface(noProto=True)
-    iface.showInfo()
-    iface.localNode.showInfo()
-    iface.close()
-    mocked_findPorts.assert_called()
-    mocked_serial.assert_called()
-
-
-@pytest.mark.unit
-@patch(&#39;meshtastic.util.findPorts&#39;, return_value=[])
-def test_SerialInterface_no_ports(mocked_findPorts, capsys):
-    &#34;&#34;&#34;Test that we can instantiate a SerialInterface with no ports&#34;&#34;&#34;
-    with pytest.raises(SystemExit) as pytest_wrapped_e:
-        SerialInterface(noProto=True)
-    mocked_findPorts.assert_called()
-    assert pytest_wrapped_e.type == SystemExit
-    assert pytest_wrapped_e.value.code == 1
-    out, err = capsys.readouterr()
-    assert re.search(r&#39;Warning: No Meshtastic devices detected&#39;, out, re.MULTILINE)
-    assert err == &#39;&#39;
-
-
-@pytest.mark.unit
-@patch(&#39;meshtastic.util.findPorts&#39;, return_value=[&#39;/dev/ttyUSBfake1&#39;, &#39;/dev/ttyUSBfake2&#39;])
-def test_SerialInterface_multiple_ports(mocked_findPorts, capsys):
-    &#34;&#34;&#34;Test that we can instantiate a SerialInterface with two ports&#34;&#34;&#34;
-    with pytest.raises(SystemExit) as pytest_wrapped_e:
-        SerialInterface(noProto=True)
-    mocked_findPorts.assert_called()
-    assert pytest_wrapped_e.type == SystemExit
-    assert pytest_wrapped_e.value.code == 1
-    out, err = capsys.readouterr()
-    assert re.search(r&#39;Warning: Multiple serial ports were detected&#39;, out, re.MULTILINE)
-    assert err == &#39;&#39;</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="meshtastic.tests.test_serial_interface.test_SerialInterface_multiple_ports"><code class="name flex">
-<span>def <span class="ident">test_SerialInterface_multiple_ports</span></span>(<span>mocked_findPorts, capsys)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test that we can instantiate a SerialInterface with two ports</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-@patch(&#39;meshtastic.util.findPorts&#39;, return_value=[&#39;/dev/ttyUSBfake1&#39;, &#39;/dev/ttyUSBfake2&#39;])
-def test_SerialInterface_multiple_ports(mocked_findPorts, capsys):
-    &#34;&#34;&#34;Test that we can instantiate a SerialInterface with two ports&#34;&#34;&#34;
-    with pytest.raises(SystemExit) as pytest_wrapped_e:
-        SerialInterface(noProto=True)
-    mocked_findPorts.assert_called()
-    assert pytest_wrapped_e.type == SystemExit
-    assert pytest_wrapped_e.value.code == 1
-    out, err = capsys.readouterr()
-    assert re.search(r&#39;Warning: Multiple serial ports were detected&#39;, out, re.MULTILINE)
-    assert err == &#39;&#39;</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_serial_interface.test_SerialInterface_no_ports"><code class="name flex">
-<span>def <span class="ident">test_SerialInterface_no_ports</span></span>(<span>mocked_findPorts, capsys)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test that we can instantiate a SerialInterface with no ports</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-@patch(&#39;meshtastic.util.findPorts&#39;, return_value=[])
-def test_SerialInterface_no_ports(mocked_findPorts, capsys):
-    &#34;&#34;&#34;Test that we can instantiate a SerialInterface with no ports&#34;&#34;&#34;
-    with pytest.raises(SystemExit) as pytest_wrapped_e:
-        SerialInterface(noProto=True)
-    mocked_findPorts.assert_called()
-    assert pytest_wrapped_e.type == SystemExit
-    assert pytest_wrapped_e.value.code == 1
-    out, err = capsys.readouterr()
-    assert re.search(r&#39;Warning: No Meshtastic devices detected&#39;, out, re.MULTILINE)
-    assert err == &#39;&#39;</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_serial_interface.test_SerialInterface_single_port"><code class="name flex">
-<span>def <span class="ident">test_SerialInterface_single_port</span></span>(<span>mocked_findPorts, mocked_serial)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test that we can instantiate a SerialInterface with a single port</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-@patch(&#39;serial.Serial&#39;)
-@patch(&#39;meshtastic.util.findPorts&#39;, return_value=[&#39;/dev/ttyUSBfake&#39;])
-def test_SerialInterface_single_port(mocked_findPorts, mocked_serial):
-    &#34;&#34;&#34;Test that we can instantiate a SerialInterface with a single port&#34;&#34;&#34;
-    iface = SerialInterface(noProto=True)
-    iface.showInfo()
-    iface.localNode.showInfo()
-    iface.close()
-    mocked_findPorts.assert_called()
-    mocked_serial.assert_called()</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.tests" href="index.html">meshtastic.tests</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="meshtastic.tests.test_serial_interface.test_SerialInterface_multiple_ports" href="#meshtastic.tests.test_serial_interface.test_SerialInterface_multiple_ports">test_SerialInterface_multiple_ports</a></code></li>
-<li><code><a title="meshtastic.tests.test_serial_interface.test_SerialInterface_no_ports" href="#meshtastic.tests.test_serial_interface.test_SerialInterface_no_ports">test_SerialInterface_no_ports</a></code></li>
-<li><code><a title="meshtastic.tests.test_serial_interface.test_SerialInterface_single_port" href="#meshtastic.tests.test_serial_interface.test_SerialInterface_single_port">test_SerialInterface_single_port</a></code></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>

docs/meshtastic/tests/test_smoke2.html

@@ -1,127 +0,0 @@
-<!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.tests.test_smoke2 API documentation</title>
-<meta name="description" content="Meshtastic smoke tests with 2 devices connected via USB" />
-<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.tests.test_smoke2</code></h1>
-</header>
-<section id="section-intro">
-<p>Meshtastic smoke tests with 2 devices connected via USB</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Meshtastic smoke tests with 2 devices connected via USB&#34;&#34;&#34;
-import re
-import subprocess
-
-import pytest
-
-
-@pytest.mark.smoke2
-def test_smoke2_info():
-    &#34;&#34;&#34;Test --info with 2 devices connected serially&#34;&#34;&#34;
-    return_value, out = subprocess.getstatusoutput(&#39;meshtastic --info&#39;)
-    assert re.search(r&#39;Warning: Multiple&#39;, out, re.MULTILINE)
-    assert return_value == 1
-
-
-@pytest.mark.smoke2
-def test_smoke2_test():
-    &#34;&#34;&#34;Test --test&#34;&#34;&#34;
-    return_value, out = subprocess.getstatusoutput(&#39;meshtastic --test&#39;)
-    assert re.search(r&#39;Writing serial debugging&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;Ports opened&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;Running 5 tests&#39;, out, re.MULTILINE)
-    assert return_value == 0</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="meshtastic.tests.test_smoke2.test_smoke2_info"><code class="name flex">
-<span>def <span class="ident">test_smoke2_info</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test &ndash;info with 2 devices connected serially</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.smoke2
-def test_smoke2_info():
-    &#34;&#34;&#34;Test --info with 2 devices connected serially&#34;&#34;&#34;
-    return_value, out = subprocess.getstatusoutput(&#39;meshtastic --info&#39;)
-    assert re.search(r&#39;Warning: Multiple&#39;, out, re.MULTILINE)
-    assert return_value == 1</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_smoke2.test_smoke2_test"><code class="name flex">
-<span>def <span class="ident">test_smoke2_test</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test &ndash;test</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.smoke2
-def test_smoke2_test():
-    &#34;&#34;&#34;Test --test&#34;&#34;&#34;
-    return_value, out = subprocess.getstatusoutput(&#39;meshtastic --test&#39;)
-    assert re.search(r&#39;Writing serial debugging&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;Ports opened&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;Running 5 tests&#39;, out, re.MULTILINE)
-    assert return_value == 0</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.tests" href="index.html">meshtastic.tests</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="meshtastic.tests.test_smoke2.test_smoke2_info" href="#meshtastic.tests.test_smoke2.test_smoke2_info">test_smoke2_info</a></code></li>
-<li><code><a title="meshtastic.tests.test_smoke2.test_smoke2_test" href="#meshtastic.tests.test_smoke2.test_smoke2_test">test_smoke2_test</a></code></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>

docs/meshtastic/tests/test_smoke_wifi.html

@@ -1,115 +0,0 @@
-<!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.tests.test_smoke_wifi API documentation</title>
-<meta name="description" content="Meshtastic smoke tests a device setup with wifi …" />
-<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.tests.test_smoke_wifi</code></h1>
-</header>
-<section id="section-intro">
-<p>Meshtastic smoke tests a device setup with wifi.</p>
-<p>Need to have run the following on an esp32 device:
-meshtastic &ndash;set wifi_ssid 'foo' &ndash;set wifi_password 'sekret'</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Meshtastic smoke tests a device setup with wifi.
-
-   Need to have run the following on an esp32 device:
-      meshtastic --set wifi_ssid &#39;foo&#39; --set wifi_password &#39;sekret&#39;
-&#34;&#34;&#34;
-import re
-import subprocess
-
-import pytest
-
-
-@pytest.mark.smokewifi
-def test_smokewifi_info():
-    &#34;&#34;&#34;Test --info&#34;&#34;&#34;
-    return_value, out = subprocess.getstatusoutput(&#39;meshtastic --info --host meshtastic.local&#39;)
-    assert re.search(r&#39;^Owner&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;^My info&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;^Nodes in mesh&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;^Preferences&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;^Channels&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;^  PRIMARY&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;^Primary channel URL&#39;, out, re.MULTILINE)
-    assert return_value == 0</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="meshtastic.tests.test_smoke_wifi.test_smokewifi_info"><code class="name flex">
-<span>def <span class="ident">test_smokewifi_info</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test &ndash;info</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.smokewifi
-def test_smokewifi_info():
-    &#34;&#34;&#34;Test --info&#34;&#34;&#34;
-    return_value, out = subprocess.getstatusoutput(&#39;meshtastic --info --host meshtastic.local&#39;)
-    assert re.search(r&#39;^Owner&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;^My info&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;^Nodes in mesh&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;^Preferences&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;^Channels&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;^  PRIMARY&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;^Primary channel URL&#39;, out, re.MULTILINE)
-    assert return_value == 0</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.tests" href="index.html">meshtastic.tests</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="meshtastic.tests.test_smoke_wifi.test_smokewifi_info" href="#meshtastic.tests.test_smoke_wifi.test_smokewifi_info">test_smokewifi_info</a></code></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>

docs/meshtastic/tests/test_stream_interface.html

@@ -1,246 +0,0 @@
-<!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.tests.test_stream_interface API documentation</title>
-<meta name="description" content="Meshtastic unit tests for stream_interface.py" />
-<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.tests.test_stream_interface</code></h1>
-</header>
-<section id="section-intro">
-<p>Meshtastic unit tests for stream_interface.py</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Meshtastic unit tests for stream_interface.py&#34;&#34;&#34;
-
-import logging
-import re
-
-from unittest.mock import MagicMock
-import pytest
-
-from ..stream_interface import StreamInterface
-
-
-@pytest.mark.unit
-def test_StreamInterface():
-    &#34;&#34;&#34;Test that we cannot instantiate a StreamInterface based on noProto&#34;&#34;&#34;
-    with pytest.raises(Exception) as pytest_wrapped_e:
-        StreamInterface()
-    assert pytest_wrapped_e.type == Exception
-
-
-# Note: This takes a bit, so moving from unit to slow
-@pytest.mark.unitslow
-def test_StreamInterface_with_noProto(caplog, reset_globals):
-    &#34;&#34;&#34;Test that we can instantiate a StreamInterface based on nonProto
-       and we can read/write bytes from a mocked stream
-    &#34;&#34;&#34;
-    stream = MagicMock()
-    test_data = b&#39;hello&#39;
-    stream.read.return_value = test_data
-    with caplog.at_level(logging.DEBUG):
-        iface = StreamInterface(noProto=True, connectNow=False)
-        iface.stream = stream
-        iface._writeBytes(test_data)
-        data = iface._readBytes(len(test_data))
-        assert data == test_data
-
-
-# Note: This takes a bit, so moving from unit to slow
-# Tip: If you want to see the print output, run with &#39;-s&#39; flag:
-#      pytest -s meshtastic/tests/test_stream_interface.py::test_sendToRadioImpl
-@pytest.mark.unitslow
-def test_sendToRadioImpl(caplog, reset_globals):
-    &#34;&#34;&#34;Test _sendToRadioImpl()&#34;&#34;&#34;
-
-#    def add_header(b):
-#        &#34;&#34;&#34;Add header stuffs for radio&#34;&#34;&#34;
-#        bufLen = len(b)
-#        header = bytes([START1, START2, (bufLen &gt;&gt; 8) &amp; 0xff,  bufLen &amp; 0xff])
-#        return header + b
-
-    # captured raw bytes of a Heltec2.1 radio with 2 channels (primary and a secondary channel named &#34;gpio&#34;)
-    raw_1_my_info = b&#39;\x1a,\x08\xdc\x8c\xd5\xc5\x02\x18\r2\x0e1.2.49.5354c49P\x15]\xe1%\x17Eh\xe0\xa7\x12p\xe8\x9d\x01x\x08\x90\x01\x01&#39;
-    raw_2_node_info = b&#39;&#34;9\x08\xdc\x8c\xd5\xc5\x02\x12(\n\t!28b5465c\x12\x0cUnknown 465c\x1a\x03?5C&#34;\x06$o(\xb5F\\0\n\x1a\x02 1%M&lt;\xc6a&#39;
-    # pylint: disable=C0301
-    raw_3_node_info = b&#39;&#34;C\x08\xa4\x8c\xd5\xc5\x02\x12(\n\t!28b54624\x12\x0cUnknown 4624\x1a\x03?24&#34;\x06$o(\xb5F$0\n\x1a\x07 5MH&lt;\xc6a%G&lt;\xc6a=\x00\x00\xc0@&#39;
-    raw_4_complete = b&#39;@\xcf\xe5\xd1\x8c\x0e&#39;
-    # pylint: disable=C0301
-    raw_5_prefs = b&#39;Z6\r\\F\xb5(\x15\\F\xb5(&#34;\x1c\x08\x06\x12\x13*\x11\n\x0f0\x84\x07P\xac\x02\x88\x01\x01\xb0\t#\xb8\t\x015]$\xddk5\xd5\x7f!b=M&lt;\xc6aP\x03`F&#39;
-    # pylint: disable=C0301
-    raw_6_channel0 = b&#39;Z.\r\\F\xb5(\x15\\F\xb5(&#34;\x14\x08\x06\x12\x0b:\t\x12\x05\x18\x01&#34;\x01\x01\x18\x015^$\xddk5\xd6\x7f!b=M&lt;\xc6aP\x03`F&#39;
-    # pylint: disable=C0301
-    raw_7_channel1 = b&#39;ZS\r\\F\xb5(\x15\\F\xb5(&#34;9\x08\x06\x120:.\x08\x01\x12(&#34; \xb4&amp;\xb3\xc7\x06\xd8\xe39%\xba\xa5\xee\x8eH\x06\xf6\xf4H\xe8\xd5\xc1[ao\xb5Y\\\xb4&#34;\xafmi*\x04gpio\x18\x025_$\xddk5\xd7\x7f!b=M&lt;\xc6aP\x03`F&#39;
-    raw_8_channel2 = b&#39;Z)\r\\F\xb5(\x15\\F\xb5(&#34;\x0f\x08\x06\x12\x06:\x04\x08\x02\x12\x005`$\xddk5\xd8\x7f!b=M&lt;\xc6aP\x03`F&#39;
-    raw_blank = b&#39;&#39;
-
-    test_data = b&#39;hello&#39;
-    stream = MagicMock()
-    #stream.read.return_value = add_header(test_data)
-    stream.read.side_effect = [ raw_1_my_info, raw_2_node_info, raw_3_node_info, raw_4_complete,
-                                raw_5_prefs, raw_6_channel0, raw_7_channel1, raw_8_channel2,
-                                raw_blank, raw_blank]
-    toRadio = MagicMock()
-    toRadio.SerializeToString.return_value = test_data
-    with caplog.at_level(logging.DEBUG):
-        iface = StreamInterface(noProto=True, connectNow=False)
-        iface.stream = stream
-        iface.connect()
-        iface._sendToRadioImpl(toRadio)
-        assert re.search(r&#39;Sending: &#39;, caplog.text, re.MULTILINE)
-        assert re.search(r&#39;reading character&#39;, caplog.text, re.MULTILINE)
-        assert re.search(r&#39;In reader loop&#39;, caplog.text, re.MULTILINE)
-        print(caplog.text)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="meshtastic.tests.test_stream_interface.test_StreamInterface"><code class="name flex">
-<span>def <span class="ident">test_StreamInterface</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test that we cannot instantiate a StreamInterface based on noProto</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_StreamInterface():
-    &#34;&#34;&#34;Test that we cannot instantiate a StreamInterface based on noProto&#34;&#34;&#34;
-    with pytest.raises(Exception) as pytest_wrapped_e:
-        StreamInterface()
-    assert pytest_wrapped_e.type == Exception</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_stream_interface.test_StreamInterface_with_noProto"><code class="name flex">
-<span>def <span class="ident">test_StreamInterface_with_noProto</span></span>(<span>caplog, reset_globals)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test that we can instantiate a StreamInterface based on nonProto
-and we can read/write bytes from a mocked stream</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unitslow
-def test_StreamInterface_with_noProto(caplog, reset_globals):
-    &#34;&#34;&#34;Test that we can instantiate a StreamInterface based on nonProto
-       and we can read/write bytes from a mocked stream
-    &#34;&#34;&#34;
-    stream = MagicMock()
-    test_data = b&#39;hello&#39;
-    stream.read.return_value = test_data
-    with caplog.at_level(logging.DEBUG):
-        iface = StreamInterface(noProto=True, connectNow=False)
-        iface.stream = stream
-        iface._writeBytes(test_data)
-        data = iface._readBytes(len(test_data))
-        assert data == test_data</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_stream_interface.test_sendToRadioImpl"><code class="name flex">
-<span>def <span class="ident">test_sendToRadioImpl</span></span>(<span>caplog, reset_globals)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test _sendToRadioImpl()</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unitslow
-def test_sendToRadioImpl(caplog, reset_globals):
-    &#34;&#34;&#34;Test _sendToRadioImpl()&#34;&#34;&#34;
-
-#    def add_header(b):
-#        &#34;&#34;&#34;Add header stuffs for radio&#34;&#34;&#34;
-#        bufLen = len(b)
-#        header = bytes([START1, START2, (bufLen &gt;&gt; 8) &amp; 0xff,  bufLen &amp; 0xff])
-#        return header + b
-
-    # captured raw bytes of a Heltec2.1 radio with 2 channels (primary and a secondary channel named &#34;gpio&#34;)
-    raw_1_my_info = b&#39;\x1a,\x08\xdc\x8c\xd5\xc5\x02\x18\r2\x0e1.2.49.5354c49P\x15]\xe1%\x17Eh\xe0\xa7\x12p\xe8\x9d\x01x\x08\x90\x01\x01&#39;
-    raw_2_node_info = b&#39;&#34;9\x08\xdc\x8c\xd5\xc5\x02\x12(\n\t!28b5465c\x12\x0cUnknown 465c\x1a\x03?5C&#34;\x06$o(\xb5F\\0\n\x1a\x02 1%M&lt;\xc6a&#39;
-    # pylint: disable=C0301
-    raw_3_node_info = b&#39;&#34;C\x08\xa4\x8c\xd5\xc5\x02\x12(\n\t!28b54624\x12\x0cUnknown 4624\x1a\x03?24&#34;\x06$o(\xb5F$0\n\x1a\x07 5MH&lt;\xc6a%G&lt;\xc6a=\x00\x00\xc0@&#39;
-    raw_4_complete = b&#39;@\xcf\xe5\xd1\x8c\x0e&#39;
-    # pylint: disable=C0301
-    raw_5_prefs = b&#39;Z6\r\\F\xb5(\x15\\F\xb5(&#34;\x1c\x08\x06\x12\x13*\x11\n\x0f0\x84\x07P\xac\x02\x88\x01\x01\xb0\t#\xb8\t\x015]$\xddk5\xd5\x7f!b=M&lt;\xc6aP\x03`F&#39;
-    # pylint: disable=C0301
-    raw_6_channel0 = b&#39;Z.\r\\F\xb5(\x15\\F\xb5(&#34;\x14\x08\x06\x12\x0b:\t\x12\x05\x18\x01&#34;\x01\x01\x18\x015^$\xddk5\xd6\x7f!b=M&lt;\xc6aP\x03`F&#39;
-    # pylint: disable=C0301
-    raw_7_channel1 = b&#39;ZS\r\\F\xb5(\x15\\F\xb5(&#34;9\x08\x06\x120:.\x08\x01\x12(&#34; \xb4&amp;\xb3\xc7\x06\xd8\xe39%\xba\xa5\xee\x8eH\x06\xf6\xf4H\xe8\xd5\xc1[ao\xb5Y\\\xb4&#34;\xafmi*\x04gpio\x18\x025_$\xddk5\xd7\x7f!b=M&lt;\xc6aP\x03`F&#39;
-    raw_8_channel2 = b&#39;Z)\r\\F\xb5(\x15\\F\xb5(&#34;\x0f\x08\x06\x12\x06:\x04\x08\x02\x12\x005`$\xddk5\xd8\x7f!b=M&lt;\xc6aP\x03`F&#39;
-    raw_blank = b&#39;&#39;
-
-    test_data = b&#39;hello&#39;
-    stream = MagicMock()
-    #stream.read.return_value = add_header(test_data)
-    stream.read.side_effect = [ raw_1_my_info, raw_2_node_info, raw_3_node_info, raw_4_complete,
-                                raw_5_prefs, raw_6_channel0, raw_7_channel1, raw_8_channel2,
-                                raw_blank, raw_blank]
-    toRadio = MagicMock()
-    toRadio.SerializeToString.return_value = test_data
-    with caplog.at_level(logging.DEBUG):
-        iface = StreamInterface(noProto=True, connectNow=False)
-        iface.stream = stream
-        iface.connect()
-        iface._sendToRadioImpl(toRadio)
-        assert re.search(r&#39;Sending: &#39;, caplog.text, re.MULTILINE)
-        assert re.search(r&#39;reading character&#39;, caplog.text, re.MULTILINE)
-        assert re.search(r&#39;In reader loop&#39;, caplog.text, re.MULTILINE)
-        print(caplog.text)</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.tests" href="index.html">meshtastic.tests</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="meshtastic.tests.test_stream_interface.test_StreamInterface" href="#meshtastic.tests.test_stream_interface.test_StreamInterface">test_StreamInterface</a></code></li>
-<li><code><a title="meshtastic.tests.test_stream_interface.test_StreamInterface_with_noProto" href="#meshtastic.tests.test_stream_interface.test_StreamInterface_with_noProto">test_StreamInterface_with_noProto</a></code></li>
-<li><code><a title="meshtastic.tests.test_stream_interface.test_sendToRadioImpl" href="#meshtastic.tests.test_stream_interface.test_sendToRadioImpl">test_sendToRadioImpl</a></code></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>

docs/meshtastic/tests/test_tcp_interface.html

@@ -1,120 +0,0 @@
-<!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.tests.test_tcp_interface API documentation</title>
-<meta name="description" content="Meshtastic unit tests for tcp_interface.py" />
-<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.tests.test_tcp_interface</code></h1>
-</header>
-<section id="section-intro">
-<p>Meshtastic unit tests for tcp_interface.py</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Meshtastic unit tests for tcp_interface.py&#34;&#34;&#34;
-
-import re
-
-from unittest.mock import patch
-import pytest
-
-from ..tcp_interface import TCPInterface
-
-
-@pytest.mark.unit
-def test_TCPInterface(capsys):
-    &#34;&#34;&#34;Test that we can instantiate a TCPInterface&#34;&#34;&#34;
-    with patch(&#39;socket.socket&#39;) as mock_socket:
-        iface = TCPInterface(hostname=&#39;localhost&#39;, noProto=True)
-        iface.showInfo()
-        iface.localNode.showInfo()
-        out, err = capsys.readouterr()
-        assert re.search(r&#39;Owner: None \(None\)&#39;, out, re.MULTILINE)
-        assert re.search(r&#39;Nodes&#39;, out, re.MULTILINE)
-        assert re.search(r&#39;Preferences&#39;, out, re.MULTILINE)
-        assert re.search(r&#39;Channels&#39;, out, re.MULTILINE)
-        assert re.search(r&#39;Primary channel URL&#39;, out, re.MULTILINE)
-        assert err == &#39;&#39;
-        assert mock_socket.called
-        iface.close()</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="meshtastic.tests.test_tcp_interface.test_TCPInterface"><code class="name flex">
-<span>def <span class="ident">test_TCPInterface</span></span>(<span>capsys)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test that we can instantiate a TCPInterface</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_TCPInterface(capsys):
-    &#34;&#34;&#34;Test that we can instantiate a TCPInterface&#34;&#34;&#34;
-    with patch(&#39;socket.socket&#39;) as mock_socket:
-        iface = TCPInterface(hostname=&#39;localhost&#39;, noProto=True)
-        iface.showInfo()
-        iface.localNode.showInfo()
-        out, err = capsys.readouterr()
-        assert re.search(r&#39;Owner: None \(None\)&#39;, out, re.MULTILINE)
-        assert re.search(r&#39;Nodes&#39;, out, re.MULTILINE)
-        assert re.search(r&#39;Preferences&#39;, out, re.MULTILINE)
-        assert re.search(r&#39;Channels&#39;, out, re.MULTILINE)
-        assert re.search(r&#39;Primary channel URL&#39;, out, re.MULTILINE)
-        assert err == &#39;&#39;
-        assert mock_socket.called
-        iface.close()</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.tests" href="index.html">meshtastic.tests</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="meshtastic.tests.test_tcp_interface.test_TCPInterface" href="#meshtastic.tests.test_tcp_interface.test_TCPInterface">test_TCPInterface</a></code></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>

docs/meshtastic/tests/test_util.html

@@ -1,519 +0,0 @@
-<!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.tests.test_util API documentation</title>
-<meta name="description" content="Meshtastic unit tests for util.py" />
-<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.tests.test_util</code></h1>
-</header>
-<section id="section-intro">
-<p>Meshtastic unit tests for util.py</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Meshtastic unit tests for util.py&#34;&#34;&#34;
-
-import re
-import logging
-
-import pytest
-
-from meshtastic.util import (fixme, stripnl, pskToString, our_exit,
-                             support_info, genPSK256, fromStr, fromPSK,
-                             quoteBooleans, catchAndIgnore)
-
-
-@pytest.mark.unit
-def test_genPSK256():
-    &#34;&#34;&#34;Test genPSK256&#34;&#34;&#34;
-    assert genPSK256() != &#39;&#39;
-
-
-@pytest.mark.unit
-def test_fromStr():
-    &#34;&#34;&#34;Test fromStr&#34;&#34;&#34;
-    assert fromStr(&#39;&#39;) == b&#39;&#39;
-    assert fromStr(&#39;0x12&#39;) == b&#39;\x12&#39;
-    assert fromStr(&#39;t&#39;)
-    assert fromStr(&#39;T&#39;)
-    assert fromStr(&#39;true&#39;)
-    assert fromStr(&#39;True&#39;)
-    assert fromStr(&#39;yes&#39;)
-    assert fromStr(&#39;Yes&#39;)
-    assert fromStr(&#39;f&#39;) is False
-    assert fromStr(&#39;F&#39;) is False
-    assert fromStr(&#39;false&#39;) is False
-    assert fromStr(&#39;False&#39;) is False
-    assert fromStr(&#39;no&#39;) is False
-    assert fromStr(&#39;No&#39;) is False
-    assert fromStr(&#39;100.01&#39;) == 100.01
-    assert fromStr(&#39;123&#39;) == 123
-    assert fromStr(&#39;abc&#39;) == &#39;abc&#39;
-
-
-@pytest.mark.unit
-def test_quoteBooleans():
-    &#34;&#34;&#34;Test quoteBooleans&#34;&#34;&#34;
-    assert quoteBooleans(&#39;&#39;) == &#39;&#39;
-    assert quoteBooleans(&#39;foo&#39;) == &#39;foo&#39;
-    assert quoteBooleans(&#39;true&#39;) == &#39;true&#39;
-    assert quoteBooleans(&#39;false&#39;) == &#39;false&#39;
-    assert quoteBooleans(&#39;: true&#39;) == &#34;: &#39;true&#39;&#34;
-    assert quoteBooleans(&#39;: false&#39;) == &#34;: &#39;false&#39;&#34;
-
-@pytest.mark.unit
-def test_fromPSK():
-    &#34;&#34;&#34;Test fromPSK&#34;&#34;&#34;
-    assert fromPSK(&#39;random&#39;) != &#39;&#39;
-    assert fromPSK(&#39;none&#39;) == b&#39;\x00&#39;
-    assert fromPSK(&#39;default&#39;) == b&#39;\x01&#39;
-    assert fromPSK(&#39;simple22&#39;) == b&#39;\x17&#39;
-    assert fromPSK(&#39;trash&#39;) == &#39;trash&#39;
-
-
-@pytest.mark.unit
-def test_stripnl():
-    &#34;&#34;&#34;Test stripnl&#34;&#34;&#34;
-    assert stripnl(&#39;&#39;) == &#39;&#39;
-    assert stripnl(&#39;a\n&#39;) == &#39;a&#39;
-    assert stripnl(&#39; a \n &#39;) == &#39;a&#39;
-    assert stripnl(&#39;a\nb&#39;) == &#39;a b&#39;
-
-
-@pytest.mark.unit
-def test_pskToString_empty_string():
-    &#34;&#34;&#34;Test pskToString empty string&#34;&#34;&#34;
-    assert pskToString(&#39;&#39;) == &#39;unencrypted&#39;
-
-
-@pytest.mark.unit
-def test_pskToString_string():
-    &#34;&#34;&#34;Test pskToString string&#34;&#34;&#34;
-    assert pskToString(&#39;hunter123&#39;) == &#39;secret&#39;
-
-
-@pytest.mark.unit
-def test_pskToString_one_byte_zero_value():
-    &#34;&#34;&#34;Test pskToString one byte that is value of 0&#34;&#34;&#34;
-    assert pskToString(bytes([0x00])) == &#39;unencrypted&#39;
-
-
-@pytest.mark.unit
-def test_pskToString_one_byte_non_zero_value():
-    &#34;&#34;&#34;Test pskToString one byte that is non-zero&#34;&#34;&#34;
-    assert pskToString(bytes([0x01])) == &#39;default&#39;
-
-
-@pytest.mark.unit
-def test_pskToString_many_bytes():
-    &#34;&#34;&#34;Test pskToString many bytes&#34;&#34;&#34;
-    assert pskToString(bytes([0x02, 0x01])) == &#39;secret&#39;
-
-
-@pytest.mark.unit
-def test_pskToString_simple():
-    &#34;&#34;&#34;Test pskToString simple&#34;&#34;&#34;
-    assert pskToString(bytes([0x03])) == &#39;simple2&#39;
-
-
-@pytest.mark.unit
-def test_our_exit_zero_return_value():
-    &#34;&#34;&#34;Test our_exit with a zero return value&#34;&#34;&#34;
-    with pytest.raises(SystemExit) as pytest_wrapped_e:
-        our_exit(&#34;Warning: Some message&#34;, 0)
-    assert pytest_wrapped_e.type == SystemExit
-    assert pytest_wrapped_e.value.code == 0
-
-
-@pytest.mark.unit
-def test_our_exit_non_zero_return_value():
-    &#34;&#34;&#34;Test our_exit with a non-zero return value&#34;&#34;&#34;
-    with pytest.raises(SystemExit) as pytest_wrapped_e:
-        our_exit(&#34;Error: Some message&#34;, 1)
-    assert pytest_wrapped_e.type == SystemExit
-    assert pytest_wrapped_e.value.code == 1
-
-
-@pytest.mark.unit
-def test_fixme():
-    &#34;&#34;&#34;Test fixme()&#34;&#34;&#34;
-    with pytest.raises(Exception) as pytest_wrapped_e:
-        fixme(&#34;some exception&#34;)
-    assert pytest_wrapped_e.type == Exception
-
-
-@pytest.mark.unit
-def test_support_info(capsys):
-    &#34;&#34;&#34;Test support_info&#34;&#34;&#34;
-    support_info()
-    out, err = capsys.readouterr()
-    assert re.search(r&#39;System&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;Platform&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;Machine&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;Executable&#39;, out, re.MULTILINE)
-    assert err == &#39;&#39;
-
-
-@pytest.mark.unit
-def test_catchAndIgnore(caplog):
-    &#34;&#34;&#34;Test catchAndIgnore() does not actually throw an exception, but just logs&#34;&#34;&#34;
-    def some_closure():
-        raise Exception(&#39;foo&#39;)
-    with caplog.at_level(logging.DEBUG):
-        catchAndIgnore(&#34;something&#34;, some_closure)
-    assert re.search(r&#39;Exception thrown in something&#39;, caplog.text, re.MULTILINE)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="meshtastic.tests.test_util.test_catchAndIgnore"><code class="name flex">
-<span>def <span class="ident">test_catchAndIgnore</span></span>(<span>caplog)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test catchAndIgnore() does not actually throw an exception, but just logs</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_catchAndIgnore(caplog):
-    &#34;&#34;&#34;Test catchAndIgnore() does not actually throw an exception, but just logs&#34;&#34;&#34;
-    def some_closure():
-        raise Exception(&#39;foo&#39;)
-    with caplog.at_level(logging.DEBUG):
-        catchAndIgnore(&#34;something&#34;, some_closure)
-    assert re.search(r&#39;Exception thrown in something&#39;, caplog.text, re.MULTILINE)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_util.test_fixme"><code class="name flex">
-<span>def <span class="ident">test_fixme</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test fixme()</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_fixme():
-    &#34;&#34;&#34;Test fixme()&#34;&#34;&#34;
-    with pytest.raises(Exception) as pytest_wrapped_e:
-        fixme(&#34;some exception&#34;)
-    assert pytest_wrapped_e.type == Exception</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_util.test_fromPSK"><code class="name flex">
-<span>def <span class="ident">test_fromPSK</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test fromPSK</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_fromPSK():
-    &#34;&#34;&#34;Test fromPSK&#34;&#34;&#34;
-    assert fromPSK(&#39;random&#39;) != &#39;&#39;
-    assert fromPSK(&#39;none&#39;) == b&#39;\x00&#39;
-    assert fromPSK(&#39;default&#39;) == b&#39;\x01&#39;
-    assert fromPSK(&#39;simple22&#39;) == b&#39;\x17&#39;
-    assert fromPSK(&#39;trash&#39;) == &#39;trash&#39;</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_util.test_fromStr"><code class="name flex">
-<span>def <span class="ident">test_fromStr</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test fromStr</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_fromStr():
-    &#34;&#34;&#34;Test fromStr&#34;&#34;&#34;
-    assert fromStr(&#39;&#39;) == b&#39;&#39;
-    assert fromStr(&#39;0x12&#39;) == b&#39;\x12&#39;
-    assert fromStr(&#39;t&#39;)
-    assert fromStr(&#39;T&#39;)
-    assert fromStr(&#39;true&#39;)
-    assert fromStr(&#39;True&#39;)
-    assert fromStr(&#39;yes&#39;)
-    assert fromStr(&#39;Yes&#39;)
-    assert fromStr(&#39;f&#39;) is False
-    assert fromStr(&#39;F&#39;) is False
-    assert fromStr(&#39;false&#39;) is False
-    assert fromStr(&#39;False&#39;) is False
-    assert fromStr(&#39;no&#39;) is False
-    assert fromStr(&#39;No&#39;) is False
-    assert fromStr(&#39;100.01&#39;) == 100.01
-    assert fromStr(&#39;123&#39;) == 123
-    assert fromStr(&#39;abc&#39;) == &#39;abc&#39;</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_util.test_genPSK256"><code class="name flex">
-<span>def <span class="ident">test_genPSK256</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test genPSK256</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_genPSK256():
-    &#34;&#34;&#34;Test genPSK256&#34;&#34;&#34;
-    assert genPSK256() != &#39;&#39;</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_util.test_our_exit_non_zero_return_value"><code class="name flex">
-<span>def <span class="ident">test_our_exit_non_zero_return_value</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test our_exit with a non-zero return value</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_our_exit_non_zero_return_value():
-    &#34;&#34;&#34;Test our_exit with a non-zero return value&#34;&#34;&#34;
-    with pytest.raises(SystemExit) as pytest_wrapped_e:
-        our_exit(&#34;Error: Some message&#34;, 1)
-    assert pytest_wrapped_e.type == SystemExit
-    assert pytest_wrapped_e.value.code == 1</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_util.test_our_exit_zero_return_value"><code class="name flex">
-<span>def <span class="ident">test_our_exit_zero_return_value</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test our_exit with a zero return value</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_our_exit_zero_return_value():
-    &#34;&#34;&#34;Test our_exit with a zero return value&#34;&#34;&#34;
-    with pytest.raises(SystemExit) as pytest_wrapped_e:
-        our_exit(&#34;Warning: Some message&#34;, 0)
-    assert pytest_wrapped_e.type == SystemExit
-    assert pytest_wrapped_e.value.code == 0</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_util.test_pskToString_empty_string"><code class="name flex">
-<span>def <span class="ident">test_pskToString_empty_string</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test pskToString empty string</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_pskToString_empty_string():
-    &#34;&#34;&#34;Test pskToString empty string&#34;&#34;&#34;
-    assert pskToString(&#39;&#39;) == &#39;unencrypted&#39;</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_util.test_pskToString_many_bytes"><code class="name flex">
-<span>def <span class="ident">test_pskToString_many_bytes</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test pskToString many bytes</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_pskToString_many_bytes():
-    &#34;&#34;&#34;Test pskToString many bytes&#34;&#34;&#34;
-    assert pskToString(bytes([0x02, 0x01])) == &#39;secret&#39;</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_util.test_pskToString_one_byte_non_zero_value"><code class="name flex">
-<span>def <span class="ident">test_pskToString_one_byte_non_zero_value</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test pskToString one byte that is non-zero</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_pskToString_one_byte_non_zero_value():
-    &#34;&#34;&#34;Test pskToString one byte that is non-zero&#34;&#34;&#34;
-    assert pskToString(bytes([0x01])) == &#39;default&#39;</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_util.test_pskToString_one_byte_zero_value"><code class="name flex">
-<span>def <span class="ident">test_pskToString_one_byte_zero_value</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test pskToString one byte that is value of 0</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_pskToString_one_byte_zero_value():
-    &#34;&#34;&#34;Test pskToString one byte that is value of 0&#34;&#34;&#34;
-    assert pskToString(bytes([0x00])) == &#39;unencrypted&#39;</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_util.test_pskToString_simple"><code class="name flex">
-<span>def <span class="ident">test_pskToString_simple</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test pskToString simple</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_pskToString_simple():
-    &#34;&#34;&#34;Test pskToString simple&#34;&#34;&#34;
-    assert pskToString(bytes([0x03])) == &#39;simple2&#39;</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_util.test_pskToString_string"><code class="name flex">
-<span>def <span class="ident">test_pskToString_string</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test pskToString string</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_pskToString_string():
-    &#34;&#34;&#34;Test pskToString string&#34;&#34;&#34;
-    assert pskToString(&#39;hunter123&#39;) == &#39;secret&#39;</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_util.test_quoteBooleans"><code class="name flex">
-<span>def <span class="ident">test_quoteBooleans</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test quoteBooleans</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_quoteBooleans():
-    &#34;&#34;&#34;Test quoteBooleans&#34;&#34;&#34;
-    assert quoteBooleans(&#39;&#39;) == &#39;&#39;
-    assert quoteBooleans(&#39;foo&#39;) == &#39;foo&#39;
-    assert quoteBooleans(&#39;true&#39;) == &#39;true&#39;
-    assert quoteBooleans(&#39;false&#39;) == &#39;false&#39;
-    assert quoteBooleans(&#39;: true&#39;) == &#34;: &#39;true&#39;&#34;
-    assert quoteBooleans(&#39;: false&#39;) == &#34;: &#39;false&#39;&#34;</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_util.test_stripnl"><code class="name flex">
-<span>def <span class="ident">test_stripnl</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test stripnl</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_stripnl():
-    &#34;&#34;&#34;Test stripnl&#34;&#34;&#34;
-    assert stripnl(&#39;&#39;) == &#39;&#39;
-    assert stripnl(&#39;a\n&#39;) == &#39;a&#39;
-    assert stripnl(&#39; a \n &#39;) == &#39;a&#39;
-    assert stripnl(&#39;a\nb&#39;) == &#39;a b&#39;</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tests.test_util.test_support_info"><code class="name flex">
-<span>def <span class="ident">test_support_info</span></span>(<span>capsys)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Test support_info</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@pytest.mark.unit
-def test_support_info(capsys):
-    &#34;&#34;&#34;Test support_info&#34;&#34;&#34;
-    support_info()
-    out, err = capsys.readouterr()
-    assert re.search(r&#39;System&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;Platform&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;Machine&#39;, out, re.MULTILINE)
-    assert re.search(r&#39;Executable&#39;, out, re.MULTILINE)
-    assert err == &#39;&#39;</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.tests" href="index.html">meshtastic.tests</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="meshtastic.tests.test_util.test_catchAndIgnore" href="#meshtastic.tests.test_util.test_catchAndIgnore">test_catchAndIgnore</a></code></li>
-<li><code><a title="meshtastic.tests.test_util.test_fixme" href="#meshtastic.tests.test_util.test_fixme">test_fixme</a></code></li>
-<li><code><a title="meshtastic.tests.test_util.test_fromPSK" href="#meshtastic.tests.test_util.test_fromPSK">test_fromPSK</a></code></li>
-<li><code><a title="meshtastic.tests.test_util.test_fromStr" href="#meshtastic.tests.test_util.test_fromStr">test_fromStr</a></code></li>
-<li><code><a title="meshtastic.tests.test_util.test_genPSK256" href="#meshtastic.tests.test_util.test_genPSK256">test_genPSK256</a></code></li>
-<li><code><a title="meshtastic.tests.test_util.test_our_exit_non_zero_return_value" href="#meshtastic.tests.test_util.test_our_exit_non_zero_return_value">test_our_exit_non_zero_return_value</a></code></li>
-<li><code><a title="meshtastic.tests.test_util.test_our_exit_zero_return_value" href="#meshtastic.tests.test_util.test_our_exit_zero_return_value">test_our_exit_zero_return_value</a></code></li>
-<li><code><a title="meshtastic.tests.test_util.test_pskToString_empty_string" href="#meshtastic.tests.test_util.test_pskToString_empty_string">test_pskToString_empty_string</a></code></li>
-<li><code><a title="meshtastic.tests.test_util.test_pskToString_many_bytes" href="#meshtastic.tests.test_util.test_pskToString_many_bytes">test_pskToString_many_bytes</a></code></li>
-<li><code><a title="meshtastic.tests.test_util.test_pskToString_one_byte_non_zero_value" href="#meshtastic.tests.test_util.test_pskToString_one_byte_non_zero_value">test_pskToString_one_byte_non_zero_value</a></code></li>
-<li><code><a title="meshtastic.tests.test_util.test_pskToString_one_byte_zero_value" href="#meshtastic.tests.test_util.test_pskToString_one_byte_zero_value">test_pskToString_one_byte_zero_value</a></code></li>
-<li><code><a title="meshtastic.tests.test_util.test_pskToString_simple" href="#meshtastic.tests.test_util.test_pskToString_simple">test_pskToString_simple</a></code></li>
-<li><code><a title="meshtastic.tests.test_util.test_pskToString_string" href="#meshtastic.tests.test_util.test_pskToString_string">test_pskToString_string</a></code></li>
-<li><code><a title="meshtastic.tests.test_util.test_quoteBooleans" href="#meshtastic.tests.test_util.test_quoteBooleans">test_quoteBooleans</a></code></li>
-<li><code><a title="meshtastic.tests.test_util.test_stripnl" href="#meshtastic.tests.test_util.test_stripnl">test_stripnl</a></code></li>
-<li><code><a title="meshtastic.tests.test_util.test_support_info" href="#meshtastic.tests.test_util.test_support_info">test_support_info</a></code></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>

docs/meshtastic/tunnel.html

@@ -1,615 +0,0 @@
-<!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.tunnel API documentation</title>
-<meta name="description" content="Code for IP tunnel over a mesh …" />
-<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.tunnel</code></h1>
-</header>
-<section id="section-intro">
-<p>Code for IP tunnel over a mesh</p>
-<h1 id="note-python-pytuntap-was-too-buggy">Note python-pytuntap was too buggy</h1>
-<h1 id="using-pip3-install-pytap2">using pip3 install pytap2</h1>
-<h1 id="make-sure-to-sudo-setcap-cap_net_admineip-usrbinpython38-so-python-can-access-tun-device-without-being-root">make sure to "sudo setcap cap_net_admin+eip /usr/bin/python3.8" so python can access tun device without being root</h1>
-<h1 id="sudo-ip-tuntap-del-mode-tun-tun0">sudo ip tuntap del mode tun tun0</h1>
-<h1 id="sudo-binrunsh-port-devttyusb0-setch-shortfast">sudo bin/run.sh &ndash;port /dev/ttyUSB0 &ndash;setch-shortfast</h1>
-<h1 id="sudo-binrunsh-port-devttyusb0-tunnel-debug">sudo bin/run.sh &ndash;port /dev/ttyUSB0 &ndash;tunnel &ndash;debug</h1>
-<h1 id="ssh-y-root19216810151-or-dietpi-default-password-p">ssh -Y root@192.168.10.151 (or dietpi), default password p</h1>
-<h1 id="ncat-e-bincat-k-u-l-1235">ncat -e /bin/cat -k -u -l 1235</h1>
-<h1 id="ncat-u-1011564152-1235">ncat -u 10.115.64.152 1235</h1>
-<h1 id="ping-c-1-w-20-1011564152">ping -c 1 -W 20 10.115.64.152</h1>
-<h1 id="ping-i-30-w-30-1011564152">ping -i 30 -W 30 10.115.64.152</h1>
-<h1 id="fixme-use-a-more-optimal-mtu">FIXME: use a more optimal MTU</h1>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Code for IP tunnel over a mesh
-
-# Note python-pytuntap was too buggy
-# using pip3 install pytap2
-# make sure to &#34;sudo setcap cap_net_admin+eip /usr/bin/python3.8&#34; so python can access tun device without being root
-# sudo ip tuntap del mode tun tun0
-# sudo bin/run.sh --port /dev/ttyUSB0 --setch-shortfast
-# sudo bin/run.sh --port /dev/ttyUSB0 --tunnel --debug
-# ssh -Y root@192.168.10.151 (or dietpi), default password p
-# ncat -e /bin/cat -k -u -l 1235
-# ncat -u 10.115.64.152 1235
-# ping -c 1 -W 20 10.115.64.152
-# ping -i 30 -W 30 10.115.64.152
-
-# FIXME: use a more optimal MTU
-&#34;&#34;&#34;
-
-import logging
-import threading
-from pubsub import pub
-
-from pytap2 import TapDevice
-
-from . import portnums_pb2
-
-# A new non standard log level that is lower level than DEBUG
-LOG_TRACE = 5
-
-# fixme - find a way to move onTunnelReceive inside of the class
-tunnelInstance = None
-
-&#34;&#34;&#34;A list of chatty UDP services we should never accidentally
-forward to our slow network&#34;&#34;&#34;
-udpBlacklist = {
-    1900,  # SSDP
-    5353,  # multicast DNS
-}
-
-&#34;&#34;&#34;A list of TCP services to block&#34;&#34;&#34;
-tcpBlacklist = {}
-
-&#34;&#34;&#34;A list of protocols we ignore&#34;&#34;&#34;
-protocolBlacklist = {
-    0x02,  # IGMP
-    0x80,  # Service-Specific Connection-Oriented Protocol in a Multilink and Connectionless Environment
-}
-
-
-def hexstr(barray):
-    &#34;&#34;&#34;Print a string of hex digits&#34;&#34;&#34;
-    return &#34;:&#34;.join(&#39;{:02x}&#39;.format(x) for x in barray)
-
-
-def ipstr(barray):
-    &#34;&#34;&#34;Print a string of ip digits&#34;&#34;&#34;
-    return &#34;.&#34;.join(&#39;{}&#39;.format(x) for x in barray)
-
-
-def readnet_u16(p, offset):
-    &#34;&#34;&#34;Read big endian u16 (network byte order)&#34;&#34;&#34;
-    return p[offset] * 256 + p[offset + 1]
-
-
-def onTunnelReceive(packet, interface):
-    &#34;&#34;&#34;Callback for received tunneled messages from mesh
-
-    FIXME figure out how to do closures with methods in python&#34;&#34;&#34;
-    tunnelInstance.onReceive(packet)
-
-
-class Tunnel:
-    &#34;&#34;&#34;A TUN based IP tunnel over meshtastic&#34;&#34;&#34;
-
-    def __init__(self, iface, subnet=None, netmask=&#34;255.255.0.0&#34;):
-        &#34;&#34;&#34;
-        Constructor
-
-        iface is the already open MeshInterface instance
-        subnet is used to construct our network number (normally 10.115.x.x)
-        &#34;&#34;&#34;
-
-        if subnet is None:
-            subnet = &#34;10.115&#34;
-
-        self.iface = iface
-        self.subnetPrefix = subnet
-
-        global tunnelInstance
-        tunnelInstance = self
-
-        logging.info(&#34;Starting IP to mesh tunnel (you must be root for this *pre-alpha* &#34;\
-                     &#34;feature to work).  Mesh members:&#34;)
-
-        pub.subscribe(onTunnelReceive, &#34;meshtastic.receive.data.IP_TUNNEL_APP&#34;)
-        myAddr = self._nodeNumToIp(self.iface.myInfo.my_node_num)
-
-        for node in self.iface.nodes.values():
-            nodeId = node[&#34;user&#34;][&#34;id&#34;]
-            ip = self._nodeNumToIp(node[&#34;num&#34;])
-            logging.info(f&#34;Node { nodeId } has IP address { ip }&#34;)
-
-        logging.debug(&#34;creating TUN device with MTU=200&#34;)
-        # FIXME - figure out real max MTU, it should be 240 - the overhead bytes for SubPacket and Data
-        self.tun = TapDevice(name=&#34;mesh&#34;)
-        self.tun.up()
-        self.tun.ifconfig(address=myAddr, netmask=netmask, mtu=200)
-        logging.debug(f&#34;starting TUN reader, our IP address is {myAddr}&#34;)
-        self._rxThread = threading.Thread(
-            target=self.__tunReader, args=(), daemon=True)
-        self._rxThread.start()
-
-    def onReceive(self, packet):
-        &#34;&#34;&#34;onReceive&#34;&#34;&#34;
-        p = packet[&#34;decoded&#34;][&#34;payload&#34;]
-        if packet[&#34;from&#34;] == self.iface.myInfo.my_node_num:
-            logging.debug(&#34;Ignoring message we sent&#34;)
-        else:
-            logging.debug(
-                f&#34;Received mesh tunnel message type={type(p)} len={len(p)}&#34;)
-            # we don&#39;t really need to check for filtering here (sender should have checked),
-            # but this provides useful debug printing on types of packets received
-            if not self._shouldFilterPacket(p):
-                self.tun.write(p)
-
-    def _shouldFilterPacket(self, p):
-        &#34;&#34;&#34;Given a packet, decode it and return true if it should be ignored&#34;&#34;&#34;
-        protocol = p[8 + 1]
-        srcaddr = p[12:16]
-        destAddr = p[16:20]
-        subheader = 20
-        ignore = False  # Assume we will be forwarding the packet
-        if protocol in protocolBlacklist:
-            ignore = True
-            logging.log(
-                LOG_TRACE, f&#34;Ignoring blacklisted protocol 0x{protocol:02x}&#34;)
-        elif protocol == 0x01:  # ICMP
-            icmpType = p[20]
-            icmpCode = p[21]
-            checksum = p[22:24]
-            # pylint: disable=line-too-long
-            logging.debug(f&#34;forwarding ICMP message src={ipstr(srcaddr)}, dest={ipstr(destAddr)}, type={icmpType}, code={icmpCode}, checksum={checksum}&#34;)
-            # reply to pings (swap src and dest but keep rest of packet unchanged)
-            #pingback = p[:12]+p[16:20]+p[12:16]+p[20:]
-            # tap.write(pingback)
-        elif protocol == 0x11:  # UDP
-            srcport = readnet_u16(p, subheader)
-            destport = readnet_u16(p, subheader + 2)
-            if destport in udpBlacklist:
-                ignore = True
-                logging.log(
-                    LOG_TRACE, f&#34;ignoring blacklisted UDP port {destport}&#34;)
-            else:
-                logging.debug(
-                    f&#34;forwarding udp srcport={srcport}, destport={destport}&#34;)
-        elif protocol == 0x06:  # TCP
-            srcport = readnet_u16(p, subheader)
-            destport = readnet_u16(p, subheader + 2)
-            if destport in tcpBlacklist:
-                ignore = True
-                logging.log(LOG_TRACE, f&#34;ignoring blacklisted TCP port {destport}&#34;)
-            else:
-                logging.debug(f&#34;forwarding tcp srcport={srcport}, destport={destport}&#34;)
-        else:
-            logging.warning(f&#34;forwarding unexpected protocol 0x{protocol:02x}, &#34;\
-                             &#34;src={ipstr(srcaddr)}, dest={ipstr(destAddr)}&#34;)
-
-        return ignore
-
-    def __tunReader(self):
-        tap = self.tun
-        logging.debug(&#34;TUN reader running&#34;)
-        while True:
-            p = tap.read()
-            #logging.debug(f&#34;IP packet received on TUN interface, type={type(p)}&#34;)
-            destAddr = p[16:20]
-
-            if not self._shouldFilterPacket(p):
-                self.sendPacket(destAddr, p)
-
-    def _ipToNodeId(self, ipAddr):
-        # We only consider the last 16 bits of the nodenum for IP address matching
-        ipBits = ipAddr[2] * 256 + ipAddr[3]
-
-        if ipBits == 0xffff:
-            return &#34;^all&#34;
-
-        for node in self.iface.nodes.values():
-            nodeNum = node[&#34;num&#34;] &amp; 0xffff
-            # logging.debug(f&#34;Considering nodenum 0x{nodeNum:x} for ipBits 0x{ipBits:x}&#34;)
-            if (nodeNum) == ipBits:
-                return node[&#34;user&#34;][&#34;id&#34;]
-        return None
-
-    def _nodeNumToIp(self, nodeNum):
-        return f&#34;{self.subnetPrefix}.{(nodeNum &gt;&gt; 8) &amp; 0xff}.{nodeNum &amp; 0xff}&#34;
-
-    def sendPacket(self, destAddr, p):
-        &#34;&#34;&#34;Forward the provided IP packet into the mesh&#34;&#34;&#34;
-        nodeId = self._ipToNodeId(destAddr)
-        if nodeId is not None:
-            logging.debug(f&#34;Forwarding packet bytelen={len(p)} dest={ipstr(destAddr)}, destNode={nodeId}&#34;)
-            self.iface.sendData(
-                p, nodeId, portnums_pb2.IP_TUNNEL_APP, wantAck=False)
-        else:
-            logging.warning(f&#34;Dropping packet because no node found for destIP={ipstr(destAddr)}&#34;)
-
-    def close(self):
-        &#34;&#34;&#34;Close&#34;&#34;&#34;
-        self.tun.close()</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-variables">Global variables</h2>
-<dl>
-<dt id="meshtastic.tunnel.tcpBlacklist"><code class="name">var <span class="ident">tcpBlacklist</span></code></dt>
-<dd>
-<div class="desc"><p>A list of protocols we ignore</p></div>
-</dd>
-<dt id="meshtastic.tunnel.tunnelInstance"><code class="name">var <span class="ident">tunnelInstance</span></code></dt>
-<dd>
-<div class="desc"><p>A list of chatty UDP services we should never accidentally
-forward to our slow network</p></div>
-</dd>
-<dt id="meshtastic.tunnel.udpBlacklist"><code class="name">var <span class="ident">udpBlacklist</span></code></dt>
-<dd>
-<div class="desc"><p>A list of TCP services to block</p></div>
-</dd>
-</dl>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="meshtastic.tunnel.hexstr"><code class="name flex">
-<span>def <span class="ident">hexstr</span></span>(<span>barray)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Print a string of hex digits</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def hexstr(barray):
-    &#34;&#34;&#34;Print a string of hex digits&#34;&#34;&#34;
-    return &#34;:&#34;.join(&#39;{:02x}&#39;.format(x) for x in barray)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tunnel.ipstr"><code class="name flex">
-<span>def <span class="ident">ipstr</span></span>(<span>barray)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Print a string of ip digits</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def ipstr(barray):
-    &#34;&#34;&#34;Print a string of ip digits&#34;&#34;&#34;
-    return &#34;.&#34;.join(&#39;{}&#39;.format(x) for x in barray)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tunnel.onTunnelReceive"><code class="name flex">
-<span>def <span class="ident">onTunnelReceive</span></span>(<span>packet, interface)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Callback for received tunneled messages from mesh</p>
-<p>FIXME figure out how to do closures with methods in python</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def onTunnelReceive(packet, interface):
-    &#34;&#34;&#34;Callback for received tunneled messages from mesh
-
-    FIXME figure out how to do closures with methods in python&#34;&#34;&#34;
-    tunnelInstance.onReceive(packet)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tunnel.readnet_u16"><code class="name flex">
-<span>def <span class="ident">readnet_u16</span></span>(<span>p, offset)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Read big endian u16 (network byte order)</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def readnet_u16(p, offset):
-    &#34;&#34;&#34;Read big endian u16 (network byte order)&#34;&#34;&#34;
-    return p[offset] * 256 + p[offset + 1]</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="meshtastic.tunnel.Tunnel"><code class="flex name class">
-<span>class <span class="ident">Tunnel</span></span>
-<span>(</span><span>iface, subnet=None, netmask='255.255.0.0')</span>
-</code></dt>
-<dd>
-<div class="desc"><p>A TUN based IP tunnel over meshtastic</p>
-<p>Constructor</p>
-<p>iface is the already open MeshInterface instance
-subnet is used to construct our network number (normally 10.115.x.x)</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class Tunnel:
-    &#34;&#34;&#34;A TUN based IP tunnel over meshtastic&#34;&#34;&#34;
-
-    def __init__(self, iface, subnet=None, netmask=&#34;255.255.0.0&#34;):
-        &#34;&#34;&#34;
-        Constructor
-
-        iface is the already open MeshInterface instance
-        subnet is used to construct our network number (normally 10.115.x.x)
-        &#34;&#34;&#34;
-
-        if subnet is None:
-            subnet = &#34;10.115&#34;
-
-        self.iface = iface
-        self.subnetPrefix = subnet
-
-        global tunnelInstance
-        tunnelInstance = self
-
-        logging.info(&#34;Starting IP to mesh tunnel (you must be root for this *pre-alpha* &#34;\
-                     &#34;feature to work).  Mesh members:&#34;)
-
-        pub.subscribe(onTunnelReceive, &#34;meshtastic.receive.data.IP_TUNNEL_APP&#34;)
-        myAddr = self._nodeNumToIp(self.iface.myInfo.my_node_num)
-
-        for node in self.iface.nodes.values():
-            nodeId = node[&#34;user&#34;][&#34;id&#34;]
-            ip = self._nodeNumToIp(node[&#34;num&#34;])
-            logging.info(f&#34;Node { nodeId } has IP address { ip }&#34;)
-
-        logging.debug(&#34;creating TUN device with MTU=200&#34;)
-        # FIXME - figure out real max MTU, it should be 240 - the overhead bytes for SubPacket and Data
-        self.tun = TapDevice(name=&#34;mesh&#34;)
-        self.tun.up()
-        self.tun.ifconfig(address=myAddr, netmask=netmask, mtu=200)
-        logging.debug(f&#34;starting TUN reader, our IP address is {myAddr}&#34;)
-        self._rxThread = threading.Thread(
-            target=self.__tunReader, args=(), daemon=True)
-        self._rxThread.start()
-
-    def onReceive(self, packet):
-        &#34;&#34;&#34;onReceive&#34;&#34;&#34;
-        p = packet[&#34;decoded&#34;][&#34;payload&#34;]
-        if packet[&#34;from&#34;] == self.iface.myInfo.my_node_num:
-            logging.debug(&#34;Ignoring message we sent&#34;)
-        else:
-            logging.debug(
-                f&#34;Received mesh tunnel message type={type(p)} len={len(p)}&#34;)
-            # we don&#39;t really need to check for filtering here (sender should have checked),
-            # but this provides useful debug printing on types of packets received
-            if not self._shouldFilterPacket(p):
-                self.tun.write(p)
-
-    def _shouldFilterPacket(self, p):
-        &#34;&#34;&#34;Given a packet, decode it and return true if it should be ignored&#34;&#34;&#34;
-        protocol = p[8 + 1]
-        srcaddr = p[12:16]
-        destAddr = p[16:20]
-        subheader = 20
-        ignore = False  # Assume we will be forwarding the packet
-        if protocol in protocolBlacklist:
-            ignore = True
-            logging.log(
-                LOG_TRACE, f&#34;Ignoring blacklisted protocol 0x{protocol:02x}&#34;)
-        elif protocol == 0x01:  # ICMP
-            icmpType = p[20]
-            icmpCode = p[21]
-            checksum = p[22:24]
-            # pylint: disable=line-too-long
-            logging.debug(f&#34;forwarding ICMP message src={ipstr(srcaddr)}, dest={ipstr(destAddr)}, type={icmpType}, code={icmpCode}, checksum={checksum}&#34;)
-            # reply to pings (swap src and dest but keep rest of packet unchanged)
-            #pingback = p[:12]+p[16:20]+p[12:16]+p[20:]
-            # tap.write(pingback)
-        elif protocol == 0x11:  # UDP
-            srcport = readnet_u16(p, subheader)
-            destport = readnet_u16(p, subheader + 2)
-            if destport in udpBlacklist:
-                ignore = True
-                logging.log(
-                    LOG_TRACE, f&#34;ignoring blacklisted UDP port {destport}&#34;)
-            else:
-                logging.debug(
-                    f&#34;forwarding udp srcport={srcport}, destport={destport}&#34;)
-        elif protocol == 0x06:  # TCP
-            srcport = readnet_u16(p, subheader)
-            destport = readnet_u16(p, subheader + 2)
-            if destport in tcpBlacklist:
-                ignore = True
-                logging.log(LOG_TRACE, f&#34;ignoring blacklisted TCP port {destport}&#34;)
-            else:
-                logging.debug(f&#34;forwarding tcp srcport={srcport}, destport={destport}&#34;)
-        else:
-            logging.warning(f&#34;forwarding unexpected protocol 0x{protocol:02x}, &#34;\
-                             &#34;src={ipstr(srcaddr)}, dest={ipstr(destAddr)}&#34;)
-
-        return ignore
-
-    def __tunReader(self):
-        tap = self.tun
-        logging.debug(&#34;TUN reader running&#34;)
-        while True:
-            p = tap.read()
-            #logging.debug(f&#34;IP packet received on TUN interface, type={type(p)}&#34;)
-            destAddr = p[16:20]
-
-            if not self._shouldFilterPacket(p):
-                self.sendPacket(destAddr, p)
-
-    def _ipToNodeId(self, ipAddr):
-        # We only consider the last 16 bits of the nodenum for IP address matching
-        ipBits = ipAddr[2] * 256 + ipAddr[3]
-
-        if ipBits == 0xffff:
-            return &#34;^all&#34;
-
-        for node in self.iface.nodes.values():
-            nodeNum = node[&#34;num&#34;] &amp; 0xffff
-            # logging.debug(f&#34;Considering nodenum 0x{nodeNum:x} for ipBits 0x{ipBits:x}&#34;)
-            if (nodeNum) == ipBits:
-                return node[&#34;user&#34;][&#34;id&#34;]
-        return None
-
-    def _nodeNumToIp(self, nodeNum):
-        return f&#34;{self.subnetPrefix}.{(nodeNum &gt;&gt; 8) &amp; 0xff}.{nodeNum &amp; 0xff}&#34;
-
-    def sendPacket(self, destAddr, p):
-        &#34;&#34;&#34;Forward the provided IP packet into the mesh&#34;&#34;&#34;
-        nodeId = self._ipToNodeId(destAddr)
-        if nodeId is not None:
-            logging.debug(f&#34;Forwarding packet bytelen={len(p)} dest={ipstr(destAddr)}, destNode={nodeId}&#34;)
-            self.iface.sendData(
-                p, nodeId, portnums_pb2.IP_TUNNEL_APP, wantAck=False)
-        else:
-            logging.warning(f&#34;Dropping packet because no node found for destIP={ipstr(destAddr)}&#34;)
-
-    def close(self):
-        &#34;&#34;&#34;Close&#34;&#34;&#34;
-        self.tun.close()</code></pre>
-</details>
-<h3>Methods</h3>
-<dl>
-<dt id="meshtastic.tunnel.Tunnel.close"><code class="name flex">
-<span>def <span class="ident">close</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Close</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def close(self):
-    &#34;&#34;&#34;Close&#34;&#34;&#34;
-    self.tun.close()</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tunnel.Tunnel.onReceive"><code class="name flex">
-<span>def <span class="ident">onReceive</span></span>(<span>self, packet)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>onReceive</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def onReceive(self, packet):
-    &#34;&#34;&#34;onReceive&#34;&#34;&#34;
-    p = packet[&#34;decoded&#34;][&#34;payload&#34;]
-    if packet[&#34;from&#34;] == self.iface.myInfo.my_node_num:
-        logging.debug(&#34;Ignoring message we sent&#34;)
-    else:
-        logging.debug(
-            f&#34;Received mesh tunnel message type={type(p)} len={len(p)}&#34;)
-        # we don&#39;t really need to check for filtering here (sender should have checked),
-        # but this provides useful debug printing on types of packets received
-        if not self._shouldFilterPacket(p):
-            self.tun.write(p)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.tunnel.Tunnel.sendPacket"><code class="name flex">
-<span>def <span class="ident">sendPacket</span></span>(<span>self, destAddr, p)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Forward the provided IP packet into the mesh</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def sendPacket(self, destAddr, p):
-    &#34;&#34;&#34;Forward the provided IP packet into the mesh&#34;&#34;&#34;
-    nodeId = self._ipToNodeId(destAddr)
-    if nodeId is not None:
-        logging.debug(f&#34;Forwarding packet bytelen={len(p)} dest={ipstr(destAddr)}, destNode={nodeId}&#34;)
-        self.iface.sendData(
-            p, nodeId, portnums_pb2.IP_TUNNEL_APP, wantAck=False)
-    else:
-        logging.warning(f&#34;Dropping packet because no node found for destIP={ipstr(destAddr)}&#34;)</code></pre>
-</details>
-</dd>
-</dl>
-</dd>
-</dl>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul>
-<li><a href="#note-python-pytuntap-was-too-buggy">Note python-pytuntap was too buggy</a></li>
-<li><a href="#using-pip3-install-pytap2">using pip3 install pytap2</a></li>
-<li><a href="#make-sure-to-sudo-setcap-cap_net_admineip-usrbinpython38-so-python-can-access-tun-device-without-being-root">make sure to "sudo setcap cap_net_admin+eip /usr/bin/python3.8" so python can access tun device without being root</a></li>
-<li><a href="#sudo-ip-tuntap-del-mode-tun-tun0">sudo ip tuntap del mode tun tun0</a></li>
-<li><a href="#sudo-binrunsh-port-devttyusb0-setch-shortfast">sudo bin/run.sh &ndash;port /dev/ttyUSB0 &ndash;setch-shortfast</a></li>
-<li><a href="#sudo-binrunsh-port-devttyusb0-tunnel-debug">sudo bin/run.sh &ndash;port /dev/ttyUSB0 &ndash;tunnel &ndash;debug</a></li>
-<li><a href="#ssh-y-root19216810151-or-dietpi-default-password-p">ssh -Y root@192.168.10.151 (or dietpi), default password p</a></li>
-<li><a href="#ncat-e-bincat-k-u-l-1235">ncat -e /bin/cat -k -u -l 1235</a></li>
-<li><a href="#ncat-u-1011564152-1235">ncat -u 10.115.64.152 1235</a></li>
-<li><a href="#ping-c-1-w-20-1011564152">ping -c 1 -W 20 10.115.64.152</a></li>
-<li><a href="#ping-i-30-w-30-1011564152">ping -i 30 -W 30 10.115.64.152</a></li>
-<li><a href="#fixme-use-a-more-optimal-mtu">FIXME: use a more optimal MTU</a></li>
-</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.tunnel.tcpBlacklist" href="#meshtastic.tunnel.tcpBlacklist">tcpBlacklist</a></code></li>
-<li><code><a title="meshtastic.tunnel.tunnelInstance" href="#meshtastic.tunnel.tunnelInstance">tunnelInstance</a></code></li>
-<li><code><a title="meshtastic.tunnel.udpBlacklist" href="#meshtastic.tunnel.udpBlacklist">udpBlacklist</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="meshtastic.tunnel.hexstr" href="#meshtastic.tunnel.hexstr">hexstr</a></code></li>
-<li><code><a title="meshtastic.tunnel.ipstr" href="#meshtastic.tunnel.ipstr">ipstr</a></code></li>
-<li><code><a title="meshtastic.tunnel.onTunnelReceive" href="#meshtastic.tunnel.onTunnelReceive">onTunnelReceive</a></code></li>
-<li><code><a title="meshtastic.tunnel.readnet_u16" href="#meshtastic.tunnel.readnet_u16">readnet_u16</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="meshtastic.tunnel.Tunnel" href="#meshtastic.tunnel.Tunnel">Tunnel</a></code></h4>
-<ul class="">
-<li><code><a title="meshtastic.tunnel.Tunnel.close" href="#meshtastic.tunnel.Tunnel.close">close</a></code></li>
-<li><code><a title="meshtastic.tunnel.Tunnel.onReceive" href="#meshtastic.tunnel.Tunnel.onReceive">onReceive</a></code></li>
-<li><code><a title="meshtastic.tunnel.Tunnel.sendPacket" href="#meshtastic.tunnel.Tunnel.sendPacket">sendPacket</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>

docs/meshtastic/util.html

@@ -1,688 +0,0 @@
-<!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.util API documentation</title>
-<meta name="description" content="Utility functions." />
-<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.util</code></h1>
-</header>
-<section id="section-intro">
-<p>Utility functions.</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Utility functions.
-&#34;&#34;&#34;
-import traceback
-from queue import Queue
-import os
-import sys
-import time
-import platform
-import logging
-import threading
-import serial
-import serial.tools.list_ports
-import pkg_resources
-
-&#34;&#34;&#34;Some devices such as a seger jlink we never want to accidentally open&#34;&#34;&#34;
-blacklistVids = dict.fromkeys([0x1366])
-
-
-def quoteBooleans(a_string):
-    &#34;&#34;&#34;Quote booleans
-        given a string that contains &#34;: true&#34;, replace with &#34;: &#39;true&#39;&#34; (or false)
-    &#34;&#34;&#34;
-    tmp = a_string.replace(&#34;: true&#34;, &#34;: &#39;true&#39;&#34;)
-    tmp = tmp.replace(&#34;: false&#34;, &#34;: &#39;false&#39;&#34;)
-    return tmp
-
-def genPSK256():
-    &#34;&#34;&#34;Generate a random preshared key&#34;&#34;&#34;
-    return os.urandom(32)
-
-
-def fromPSK(valstr):
-    &#34;&#34;&#34;A special version of fromStr that assumes the user is trying to set a PSK.
-    In that case we also allow &#34;none&#34;, &#34;default&#34; or &#34;random&#34; (to have python generate one), or simpleN
-    &#34;&#34;&#34;
-    if valstr == &#34;random&#34;:
-        return genPSK256()
-    elif valstr == &#34;none&#34;:
-        return bytes([0])  # Use the &#39;no encryption&#39; PSK
-    elif valstr == &#34;default&#34;:
-        return bytes([1])  # Use default channel psk
-    elif valstr.startswith(&#34;simple&#34;):
-        # Use one of the single byte encodings
-        return bytes([int(valstr[6:]) + 1])
-    else:
-        return fromStr(valstr)
-
-
-def fromStr(valstr):
-    &#34;&#34;&#34;Try to parse as int, float or bool (and fallback to a string as last resort)
-
-    Returns: an int, bool, float, str or byte array (for strings of hex digits)
-
-    Args:
-        valstr (string): A user provided string
-    &#34;&#34;&#34;
-    if len(valstr) == 0:  # Treat an emptystring as an empty bytes
-        val = bytes()
-    elif valstr.startswith(&#39;0x&#39;):
-        # if needed convert to string with asBytes.decode(&#39;utf-8&#39;)
-        val = bytes.fromhex(valstr[2:])
-    elif valstr.lower() in {&#34;t&#34;, &#34;true&#34;, &#34;yes&#34;}:
-        val = True
-    elif valstr.lower() in {&#34;f&#34;, &#34;false&#34;, &#34;no&#34;}:
-        val = False
-    else:
-        try:
-            val = int(valstr)
-        except ValueError:
-            try:
-                val = float(valstr)
-            except ValueError:
-                val = valstr  # Not a float or an int, assume string
-    return val
-
-
-def pskToString(psk: bytes):
-    &#34;&#34;&#34;Given an array of PSK bytes, decode them into a human readable (but privacy protecting) string&#34;&#34;&#34;
-    if len(psk) == 0:
-        return &#34;unencrypted&#34;
-    elif len(psk) == 1:
-        b = psk[0]
-        if b == 0:
-            return &#34;unencrypted&#34;
-        elif b == 1:
-            return &#34;default&#34;
-        else:
-            return f&#34;simple{b - 1}&#34;
-    else:
-        return &#34;secret&#34;
-
-
-def stripnl(s):
-    &#34;&#34;&#34;Remove newlines from a string (and remove extra whitespace)&#34;&#34;&#34;
-    s = str(s).replace(&#34;\n&#34;, &#34; &#34;)
-    return &#39; &#39;.join(s.split())
-
-
-def fixme(message):
-    &#34;&#34;&#34;Raise an exception for things that needs to be fixed&#34;&#34;&#34;
-    raise Exception(f&#34;FIXME: {message}&#34;)
-
-
-def catchAndIgnore(reason, closure):
-    &#34;&#34;&#34;Call a closure but if it throws an exception print it and continue&#34;&#34;&#34;
-    try:
-        closure()
-    except BaseException as ex:
-        logging.error(f&#34;Exception thrown in {reason}: {ex}&#34;)
-
-
-def findPorts():
-    &#34;&#34;&#34;Find all ports that might have meshtastic devices
-
-    Returns:
-        list -- a list of device paths
-    &#34;&#34;&#34;
-    l = list(map(lambda port: port.device,
-                 filter(lambda port: port.vid is not None and port.vid not in blacklistVids,
-                        serial.tools.list_ports.comports())))
-    l.sort()
-    return l
-
-
-class dotdict(dict):
-    &#34;&#34;&#34;dot.notation access to dictionary attributes&#34;&#34;&#34;
-    __getattr__ = dict.get
-    __setattr__ = dict.__setitem__
-    __delattr__ = dict.__delitem__
-
-
-class Timeout:
-    &#34;&#34;&#34;Timeout class&#34;&#34;&#34;
-    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
-
-
-class DeferredExecution():
-    &#34;&#34;&#34;A thread that accepts closures to run, and runs them as they are received&#34;&#34;&#34;
-
-    def __init__(self, name=None):
-        self.queue = Queue()
-        self.thread = threading.Thread(target=self._run, args=(), name=name)
-        self.thread.daemon = True
-        self.thread.start()
-
-    def queueWork(self, runnable):
-        &#34;&#34;&#34; Queue up the work&#34;&#34;&#34;
-        self.queue.put(runnable)
-
-    def _run(self):
-        while True:
-            try:
-                o = self.queue.get()
-                o()
-            except:
-                logging.error(
-                    f&#34;Unexpected error in deferred execution {sys.exc_info()[0]}&#34;)
-                print(traceback.format_exc())
-
-
-def our_exit(message, return_value = 1):
-    &#34;&#34;&#34;Print the message and return a value.
-       return_value defaults to 1 (non-successful)
-    &#34;&#34;&#34;
-    print(message)
-    sys.exit(return_value)
-
-
-def support_info():
-    &#34;&#34;&#34;Print out info that helps troubleshooting of the cli.&#34;&#34;&#34;
-    print(&#39;&#39;)
-    print(&#39;If having issues with meshtastic cli or python library&#39;)
-    print(&#39;or wish to make feature requests, visit:&#39;)
-    print(&#39;https://github.com/meshtastic/Meshtastic-python/issues&#39;)
-    print(&#39;When adding an issue, be sure to include the following info:&#39;)
-    print(&#39; System: {0}&#39;.format(platform.system()))
-    print(&#39;   Platform: {0}&#39;.format(platform.platform()))
-    print(&#39;   Release: {0}&#39;.format(platform.uname().release))
-    print(&#39;   Machine: {0}&#39;.format(platform.uname().machine))
-    print(&#39;   Encoding (stdin): {0}&#39;.format(sys.stdin.encoding))
-    print(&#39;   Encoding (stdout): {0}&#39;.format(sys.stdout.encoding))
-    print(&#39; meshtastic: v{0}&#39;.format(pkg_resources.require(&#39;meshtastic&#39;)[0].version))
-    print(&#39; Executable: {0}&#39;.format(sys.argv[0]))
-    print(&#39; Python: {0} {1} {2}&#39;.format(platform.python_version(),
-          platform.python_implementation(), platform.python_compiler()))
-    print(&#39;&#39;)
-    print(&#39;Please add the output from the command: meshtastic --info&#39;)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="meshtastic.util.catchAndIgnore"><code class="name flex">
-<span>def <span class="ident">catchAndIgnore</span></span>(<span>reason, closure)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Call a closure but if it throws an exception print it and continue</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def catchAndIgnore(reason, closure):
-    &#34;&#34;&#34;Call a closure but if it throws an exception print it and continue&#34;&#34;&#34;
-    try:
-        closure()
-    except BaseException as ex:
-        logging.error(f&#34;Exception thrown in {reason}: {ex}&#34;)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.util.findPorts"><code class="name flex">
-<span>def <span class="ident">findPorts</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Find all ports that might have meshtastic devices</p>
-<h2 id="returns">Returns</h2>
-<p>list &ndash; a list of device paths</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def findPorts():
-    &#34;&#34;&#34;Find all ports that might have meshtastic devices
-
-    Returns:
-        list -- a list of device paths
-    &#34;&#34;&#34;
-    l = list(map(lambda port: port.device,
-                 filter(lambda port: port.vid is not None and port.vid not in blacklistVids,
-                        serial.tools.list_ports.comports())))
-    l.sort()
-    return l</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.util.fixme"><code class="name flex">
-<span>def <span class="ident">fixme</span></span>(<span>message)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Raise an exception for things that needs to be fixed</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def fixme(message):
-    &#34;&#34;&#34;Raise an exception for things that needs to be fixed&#34;&#34;&#34;
-    raise Exception(f&#34;FIXME: {message}&#34;)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.util.fromPSK"><code class="name flex">
-<span>def <span class="ident">fromPSK</span></span>(<span>valstr)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>A special version of fromStr that assumes the user is trying to set a PSK.
-In that case we also allow "none", "default" or "random" (to have python generate one), or simpleN</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def fromPSK(valstr):
-    &#34;&#34;&#34;A special version of fromStr that assumes the user is trying to set a PSK.
-    In that case we also allow &#34;none&#34;, &#34;default&#34; or &#34;random&#34; (to have python generate one), or simpleN
-    &#34;&#34;&#34;
-    if valstr == &#34;random&#34;:
-        return genPSK256()
-    elif valstr == &#34;none&#34;:
-        return bytes([0])  # Use the &#39;no encryption&#39; PSK
-    elif valstr == &#34;default&#34;:
-        return bytes([1])  # Use default channel psk
-    elif valstr.startswith(&#34;simple&#34;):
-        # Use one of the single byte encodings
-        return bytes([int(valstr[6:]) + 1])
-    else:
-        return fromStr(valstr)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.util.fromStr"><code class="name flex">
-<span>def <span class="ident">fromStr</span></span>(<span>valstr)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Try to parse as int, float or bool (and fallback to a string as last resort)</p>
-<p>Returns: an int, bool, float, str or byte array (for strings of hex digits)</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>valstr</code></strong> :&ensp;<code>string</code></dt>
-<dd>A user provided string</dd>
-</dl></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def fromStr(valstr):
-    &#34;&#34;&#34;Try to parse as int, float or bool (and fallback to a string as last resort)
-
-    Returns: an int, bool, float, str or byte array (for strings of hex digits)
-
-    Args:
-        valstr (string): A user provided string
-    &#34;&#34;&#34;
-    if len(valstr) == 0:  # Treat an emptystring as an empty bytes
-        val = bytes()
-    elif valstr.startswith(&#39;0x&#39;):
-        # if needed convert to string with asBytes.decode(&#39;utf-8&#39;)
-        val = bytes.fromhex(valstr[2:])
-    elif valstr.lower() in {&#34;t&#34;, &#34;true&#34;, &#34;yes&#34;}:
-        val = True
-    elif valstr.lower() in {&#34;f&#34;, &#34;false&#34;, &#34;no&#34;}:
-        val = False
-    else:
-        try:
-            val = int(valstr)
-        except ValueError:
-            try:
-                val = float(valstr)
-            except ValueError:
-                val = valstr  # Not a float or an int, assume string
-    return val</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.util.genPSK256"><code class="name flex">
-<span>def <span class="ident">genPSK256</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Generate a random preshared key</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def genPSK256():
-    &#34;&#34;&#34;Generate a random preshared key&#34;&#34;&#34;
-    return os.urandom(32)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.util.our_exit"><code class="name flex">
-<span>def <span class="ident">our_exit</span></span>(<span>message, return_value=1)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Print the message and return a value.
-return_value defaults to 1 (non-successful)</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def our_exit(message, return_value = 1):
-    &#34;&#34;&#34;Print the message and return a value.
-       return_value defaults to 1 (non-successful)
-    &#34;&#34;&#34;
-    print(message)
-    sys.exit(return_value)</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.util.pskToString"><code class="name flex">
-<span>def <span class="ident">pskToString</span></span>(<span>psk: bytes)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Given an array of PSK bytes, decode them into a human readable (but privacy protecting) string</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def pskToString(psk: bytes):
-    &#34;&#34;&#34;Given an array of PSK bytes, decode them into a human readable (but privacy protecting) string&#34;&#34;&#34;
-    if len(psk) == 0:
-        return &#34;unencrypted&#34;
-    elif len(psk) == 1:
-        b = psk[0]
-        if b == 0:
-            return &#34;unencrypted&#34;
-        elif b == 1:
-            return &#34;default&#34;
-        else:
-            return f&#34;simple{b - 1}&#34;
-    else:
-        return &#34;secret&#34;</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.util.quoteBooleans"><code class="name flex">
-<span>def <span class="ident">quoteBooleans</span></span>(<span>a_string)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Quote booleans
-given a string that contains ": true", replace with ": 'true'" (or false)</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def quoteBooleans(a_string):
-    &#34;&#34;&#34;Quote booleans
-        given a string that contains &#34;: true&#34;, replace with &#34;: &#39;true&#39;&#34; (or false)
-    &#34;&#34;&#34;
-    tmp = a_string.replace(&#34;: true&#34;, &#34;: &#39;true&#39;&#34;)
-    tmp = tmp.replace(&#34;: false&#34;, &#34;: &#39;false&#39;&#34;)
-    return tmp</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.util.stripnl"><code class="name flex">
-<span>def <span class="ident">stripnl</span></span>(<span>s)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Remove newlines from a string (and remove extra whitespace)</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def stripnl(s):
-    &#34;&#34;&#34;Remove newlines from a string (and remove extra whitespace)&#34;&#34;&#34;
-    s = str(s).replace(&#34;\n&#34;, &#34; &#34;)
-    return &#39; &#39;.join(s.split())</code></pre>
-</details>
-</dd>
-<dt id="meshtastic.util.support_info"><code class="name flex">
-<span>def <span class="ident">support_info</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Print out info that helps troubleshooting of the cli.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def support_info():
-    &#34;&#34;&#34;Print out info that helps troubleshooting of the cli.&#34;&#34;&#34;
-    print(&#39;&#39;)
-    print(&#39;If having issues with meshtastic cli or python library&#39;)
-    print(&#39;or wish to make feature requests, visit:&#39;)
-    print(&#39;https://github.com/meshtastic/Meshtastic-python/issues&#39;)
-    print(&#39;When adding an issue, be sure to include the following info:&#39;)
-    print(&#39; System: {0}&#39;.format(platform.system()))
-    print(&#39;   Platform: {0}&#39;.format(platform.platform()))
-    print(&#39;   Release: {0}&#39;.format(platform.uname().release))
-    print(&#39;   Machine: {0}&#39;.format(platform.uname().machine))
-    print(&#39;   Encoding (stdin): {0}&#39;.format(sys.stdin.encoding))
-    print(&#39;   Encoding (stdout): {0}&#39;.format(sys.stdout.encoding))
-    print(&#39; meshtastic: v{0}&#39;.format(pkg_resources.require(&#39;meshtastic&#39;)[0].version))
-    print(&#39; Executable: {0}&#39;.format(sys.argv[0]))
-    print(&#39; Python: {0} {1} {2}&#39;.format(platform.python_version(),
-          platform.python_implementation(), platform.python_compiler()))
-    print(&#39;&#39;)
-    print(&#39;Please add the output from the command: meshtastic --info&#39;)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="meshtastic.util.DeferredExecution"><code class="flex name class">
-<span>class <span class="ident">DeferredExecution</span></span>
-<span>(</span><span>name=None)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>A thread that accepts closures to run, and runs them as they are received</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class DeferredExecution():
-    &#34;&#34;&#34;A thread that accepts closures to run, and runs them as they are received&#34;&#34;&#34;
-
-    def __init__(self, name=None):
-        self.queue = Queue()
-        self.thread = threading.Thread(target=self._run, args=(), name=name)
-        self.thread.daemon = True
-        self.thread.start()
-
-    def queueWork(self, runnable):
-        &#34;&#34;&#34; Queue up the work&#34;&#34;&#34;
-        self.queue.put(runnable)
-
-    def _run(self):
-        while True:
-            try:
-                o = self.queue.get()
-                o()
-            except:
-                logging.error(
-                    f&#34;Unexpected error in deferred execution {sys.exc_info()[0]}&#34;)
-                print(traceback.format_exc())</code></pre>
-</details>
-<h3>Methods</h3>
-<dl>
-<dt id="meshtastic.util.DeferredExecution.queueWork"><code class="name flex">
-<span>def <span class="ident">queueWork</span></span>(<span>self, runnable)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Queue up the work</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def queueWork(self, runnable):
-    &#34;&#34;&#34; Queue up the work&#34;&#34;&#34;
-    self.queue.put(runnable)</code></pre>
-</details>
-</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"><p>Timeout class</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class Timeout:
-    &#34;&#34;&#34;Timeout class&#34;&#34;&#34;
-    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>
-</code></dt>
-<dd>
-<div class="desc"><p>dot.notation access to dictionary attributes</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class dotdict(dict):
-    &#34;&#34;&#34;dot.notation access to dictionary attributes&#34;&#34;&#34;
-    __getattr__ = dict.get
-    __setattr__ = dict.__setitem__
-    __delattr__ = dict.__delitem__</code></pre>
-</details>
-<h3>Ancestors</h3>
-<ul class="hlist">
-<li>builtins.dict</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-functions">Functions</a></h3>
-<ul class="two-column">
-<li><code><a title="meshtastic.util.catchAndIgnore" href="#meshtastic.util.catchAndIgnore">catchAndIgnore</a></code></li>
-<li><code><a title="meshtastic.util.findPorts" href="#meshtastic.util.findPorts">findPorts</a></code></li>
-<li><code><a title="meshtastic.util.fixme" href="#meshtastic.util.fixme">fixme</a></code></li>
-<li><code><a title="meshtastic.util.fromPSK" href="#meshtastic.util.fromPSK">fromPSK</a></code></li>
-<li><code><a title="meshtastic.util.fromStr" href="#meshtastic.util.fromStr">fromStr</a></code></li>
-<li><code><a title="meshtastic.util.genPSK256" href="#meshtastic.util.genPSK256">genPSK256</a></code></li>
-<li><code><a title="meshtastic.util.our_exit" href="#meshtastic.util.our_exit">our_exit</a></code></li>
-<li><code><a title="meshtastic.util.pskToString" href="#meshtastic.util.pskToString">pskToString</a></code></li>
-<li><code><a title="meshtastic.util.quoteBooleans" href="#meshtastic.util.quoteBooleans">quoteBooleans</a></code></li>
-<li><code><a title="meshtastic.util.stripnl" href="#meshtastic.util.stripnl">stripnl</a></code></li>
-<li><code><a title="meshtastic.util.support_info" href="#meshtastic.util.support_info">support_info</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="meshtastic.util.DeferredExecution" href="#meshtastic.util.DeferredExecution">DeferredExecution</a></code></h4>
-<ul class="">
-<li><code><a title="meshtastic.util.DeferredExecution.queueWork" href="#meshtastic.util.DeferredExecution.queueWork">queueWork</a></code></li>
-</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>
-</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>

exampleConfig.yaml

@@ -0,0 +1,16 @@
+# example config using camelCase keys
+owner: Bob TBeam
+ownerShort: BOB
+
+channelUrl: https://www.meshtastic.org/d/#CgUYAyIBAQ
+
+location:
+  lat: 35.88888
+  lon: -93.88888
+  alt: 304
+
+userPrefs:
+  region: 1
+  isAlwaysPowered: 'true'
+  screenOnSecs: 31536000
+  waitBluetoothSecs: 31536000

example_config.yaml

@@ -1,4 +1,6 @@
+# example configuration file with snake_case keys
 owner: Bob TBeam
+owner_short: BOB
 
 channel_url: https://www.meshtastic.org/d/#CgUYAyIBAQ
 
@@ -10,6 +12,6 @@ location:
 user_prefs:
   region: 1
   is_always_powered: 'true'
-  send_owner_interval: 2
   screen_on_secs: 31536000
   wait_bluetooth_secs: 31536000
+  location_share: 'LocEnabled'

examples/get_hw.py

@@ -0,0 +1,20 @@
+"""Simple program to demo how to use meshtastic library.
+   To run: python examples/get_hw.py
+"""
+
+import sys
+import meshtastic
+import meshtastic.serial_interface
+
+# simple arg check
+if len(sys.argv) != 1:
+    print(f"usage: {sys.argv[0]}")
+    print("Print the hardware model for the local node.")
+    sys.exit(3)
+
+iface = meshtastic.serial_interface.SerialInterface()
+if iface.nodes:
+    for n in iface.nodes.values():
+        if n['num'] == iface.myInfo.my_node_num:
+            print(n['user']['hwModel'])
+iface.close()

examples/info_example.py

@@ -0,0 +1,23 @@
+"""Simple program to demo how to use meshtastic library.
+   To run: python examples/info.py
+"""
+
+import meshtastic
+import meshtastic.serial_interface
+
+iface = meshtastic.serial_interface.SerialInterface()
+
+# call showInfo() just to ensure values are populated
+#info = iface.showInfo()
+
+if iface.myInfo:
+    #print(f'myInfo:{iface.myInfo}')
+    print(f'firmware_version:{iface.myInfo.firmware_version}')
+
+if iface.nodes:
+    for n in iface.nodes.values():
+        if n['num'] == iface.myInfo.my_node_num:
+            print(n['user']['hwModel'])
+            break
+
+iface.close()

examples/pub_sub_example.py

@@ -13,7 +13,7 @@ if len(sys.argv) < 2:
     print(f"usage: {sys.argv[0]} host")
     sys.exit(1)
 
-def onConnection(interface, topic=pub.AUTO_TOPIC):
+def onConnection(interface, topic=pub.AUTO_TOPIC): # pylint: disable=unused-argument
     """This is called when we (re)connect to the radio."""
     print(interface.myInfo)
     interface.close()

examples/pub_sub_example2.py

@@ -14,11 +14,11 @@ if len(sys.argv) < 2:
     print(f"usage: {sys.argv[0]} host")
     sys.exit(1)
 
-def onReceive(packet, interface):
+def onReceive(packet, interface): # pylint: disable=unused-argument
     """called when a packet arrives"""
     print(f"Received: {packet}")
 
-def onConnection(interface, topic=pub.AUTO_TOPIC):
+def onConnection(interface, topic=pub.AUTO_TOPIC): # pylint: disable=unused-argument
     """called when we (re)connect to the radio"""
     # defaults to broadcast, specify a destination ID if you wish
     interface.sendText("hello mesh")

examples/scan_for_devices.py

@@ -0,0 +1,24 @@
+"""Program to scan for hardware
+   To run: python examples/scan_for_devices.py
+"""
+
+import sys
+from meshtastic.util import detect_supported_devices, get_unique_vendor_ids, active_ports_on_supported_devices
+
+# simple arg check
+if len(sys.argv) != 1:
+    print(f"usage: {sys.argv[0]}")
+    print("Detect which device we might have.")
+    sys.exit(3)
+
+vids = get_unique_vendor_ids()
+print(f'Searching for all devices with these vendor ids {vids}')
+
+sds = detect_supported_devices()
+if len(sds) > 0:
+    print('Detected possible devices:')
+for d in sds:
+    print(f' name:{d.name}{d.version} firmware:{d.for_firmware}')
+
+ports = active_ports_on_supported_devices(sds)
+print(f'ports:{ports}')

examples/set_owner.py

@@ -0,0 +1,20 @@
+"""Simple program to demo how to use meshtastic library.
+   To run: python examples/set_owner.py Bobby 333
+"""
+
+import sys
+import meshtastic
+import meshtastic.serial_interface
+
+# simple arg check
+if len(sys.argv) < 2:
+    print(f"usage: {sys.argv[0]} long_name [short_name]")
+    sys.exit(3)
+
+iface = meshtastic.serial_interface.SerialInterface()
+long_name = sys.argv[1]
+short_name = None
+if len(sys.argv) > 2:
+    short_name = sys.argv[2]
+iface.localNode.setOwner(long_name, short_name)
+iface.close()

examples/show_ports.py

@@ -0,0 +1,6 @@
+"""Simple program to show serial ports.
+"""
+
+from meshtastic.util import findPorts
+
+print(findPorts())

examples/tcp_gps_example.py

@@ -0,0 +1,14 @@
+"""Demonstration of how to look up a radio's location via its LAN connection.
+   Before running, connect your machine to the same WiFi network as the radio.
+"""
+
+import meshtastic
+import meshtastic.tcp_interface
+
+radio_hostname = "meshtastic.local"  # Can also be an IP
+iface = meshtastic.tcp_interface.TCPInterface(radio_hostname)
+my_node_num = iface.myInfo.my_node_num
+pos = iface.nodesByNum[my_node_num]["position"]
+print (pos)
+
+iface.close()

info/mac/heltec.txt

@@ -0,0 +1,20 @@
+ioreg -p IOUSB > /tmp/d
+
+>   | +-o CP2102 USB to UART Bridge Controller@14400000  <class AppleUSBDevice, id 0x10005c048, registered, matched, active, busy 0 (9 ms), retain 12>
+
+
+system_profiler SPUSBDataType > /tmp/b
+
+37a38,50
+>         CP2102 USB to UART Bridge Controller:
+>
+>           Product ID: 0xea60
+>           Vendor ID: 0x10c4  (Silicon Laboratories, Inc.)
+>           Version: 1.00
+>           Serial Number: 0001
+>           Speed: Up to 12 Mb/s
+>           Manufacturer: Silicon Labs
+>           Location ID: 0x14400000 / 53
+>           Current Available (mA): 500
+>           Current Required (mA): 100
+>           Extra Operating Current (mA): 0

info/mac/rak11200.txt

@@ -0,0 +1,52 @@
+
+
+% ioreg -p IOUSB > /tmp/a
+# only a solid red light (pins GRND and BOOT0 jumpered)
+
+% ioreg -p IOUSB > /tmp/b
+# solid red light and solid green light
+
+% ioreg -p IOUSB > /tmp/c
+# nothing plugged in
+
+
+
+% diff /tmp/a /tmp/c
+13c13
+<   +-o AppleUSBXHCI Root Hub Simulation@14000000  <class AppleUSBRootHubDevice, id 0x100000589, registered, matched, active, busy 0 (15 ms), retain 11>
+---
+>   +-o AppleUSBXHCI Root Hub Simulation@14000000  <class AppleUSBRootHubDevice, id 0x100000589, registered, matched, active, busy 0 (15 ms), retain 10>
+18d17
+<     +-o USB Serial@14300000  <class AppleUSBDevice, id 0x100004ca4, registered, matched, active, busy 0 (10 ms), retain 12>
+
+
+% diff /tmp/b /tmp/c
+13c13
+<   +-o AppleUSBXHCI Root Hub Simulation@14000000  <class AppleUSBRootHubDevice, id 0x100000589, registered, matched, active, busy 0 (15 ms), retain 11>
+---
+>   +-o AppleUSBXHCI Root Hub Simulation@14000000  <class AppleUSBRootHubDevice, id 0x100000589, registered, matched, active, busy 0 (15 ms), retain 10>
+18d17
+<     +-o USB Serial@14300000  <class AppleUSBDevice, id 0x100004ce5, registered, matched, active, busy 0 (11 ms), retain 12>
+
+
+
+system_profiler SPUSBDataType > /tmp/d
+# red solid
+
+
+system_profiler SPUSBDataType > /tmp/e
+# nothing
+
+
+% diff /tmp/d /tmp/e
+38,48d37
+<         USB Serial:
+<
+<           Product ID: 0x7523
+<           Vendor ID: 0x1a86
+<           Version: 2.64
+<           Speed: Up to 12 Mb/s
+<           Location ID: 0x14300000 / 33
+<           Current Available (mA): 500
+<           Current Required (mA): 98
+<           Extra Operating Current (mA): 0

info/mac/rak4631_19003.txt

@@ -0,0 +1,68 @@
+
+
+>   | +-o WisCore RAK4631 Board@14400000  <class AppleUSBDevice, id 0x10005c158, registered, matched, active, busy 0 (18 ms), retain 14>
+
+
+/dev/cu.usbmodem14401
+
+% ls -al /dev/*modem*
+crw-rw-rw-  1 root  wheel  0x9000005 Jan 29 15:32 /dev/cu.usbmodem14401
+crw-rw-rw-  1 root  wheel  0x9000004 Jan 29 15:31 /dev/tty.usbmodem14401
+
+
+Note: On a Mac Air, output is:
+
+% system_profiler SPUSBDataType
+USB:
+    USB 3.1 Bus:
+      Host Controller Driver: AppleT8103USBXHCI
+    USB 3.1 Bus:
+      Host Controller Driver: AppleT8103USBXHCI
+        WisCore RAK4631 Board:
+          Product ID: 0x8029
+          Vendor ID: 0x239a
+          Version: 1.00
+          Serial Number: E6CF9502B1D410D8
+          Speed: Up to 12 Mb/s
+          Manufacturer: RAKwireless
+          Location ID: 0x01100000 / 2
+          Current Available (mA): 500
+          Current Required (mA): 100
+          Extra Operating Current (mA): 0
+
+However, in FTHR840BOOT mode, it shows this:
+
+% system_profiler SPUSBDataType
+USB:
+    USB 3.1 Bus:
+      Host Controller Driver: AppleT8103USBXHCI
+    USB 3.1 Bus:
+      Host Controller Driver: AppleT8103USBXHCI
+        Feather nRF52840 Express:
+          Product ID: 0x0029
+          Vendor ID: 0x239a
+          Version: 1.00
+          Serial Number: E6CF9502B1D410D8
+          Speed: Up to 12 Mb/s
+          Manufacturer: Adafruit Industries
+          Location ID: 0x01100000 / 1
+          Current Available (mA): 500
+          Current Required (mA): 100
+          Extra Operating Current (mA): 0
+          Media:
+            nRF UF2:
+              Capacity: 33.7 MB (33,690,112 bytes)
+              Removable Media: Yes
+              BSD Name: disk4
+              Logical Unit: 0
+              Partition Map Type: Unknown
+              S.M.A.R.T. status: Verified
+              USB Interface: 2
+
+
+$ cat /Volumes/FTHR840BOOT/INFO_UF2.TXT
+UF2 Bootloader 0.3.2-109-gd6b28e6-dirty lib/nrfx (v2.0.0) lib/tinyusb (0.6.0-272-g4e6aa0d8) lib/uf2 (heads/master)
+Model: Adafruit Feather nRF52840 Express
+Board-ID: nRF52840-Feather-revD
+SoftDevice: S140 version 6.1.1
+Date: Jun 16 2020

info/mac/rak4631_5005.txt

@@ -0,0 +1,18 @@
+
+no device plugged in
+% ioreg -p IOUSB > /tmp/a
+
+device plugged in, in "boot" mode
+% ioreg -p IOUSB > /tmp/b
+
+device plugged in, botted to Meshtastic firmware
+% ioreg -p IOUSB > /tmp/c
+
+(venv) sweet Meshtastic-python % diff /tmp/a /tmp/b (with most info removed)
+>   | +-o Feather nRF52840 Express@14400000  <class AppleUSBDevice, id 0x10005c0ff, registered, matched, active, busy 0 (22 ms), retain 16>
+
+diff /tmp/a /tmp/c (with most info removed)
+>   | +-o WisCore RAK4631 Board@14400000  <class AppleUSBDevice, id 0x10005c134, registered, matched, active, busy 0 (17 ms), retain 14>
+
+
+Meshtastic detected port on /dev/cu.usbmodem14401

info/mac/tbeam.txt

@@ -0,0 +1,21 @@
+
+meshtastic detected port: /dev/cu.usbmodem53230050571
+
+ioreg -p IOUSB > /tmp/c
+
+>   | +-o USB Single Serial@14400000  <class AppleUSBDevice, id 0x10005bff7, registered, matched, active, busy 0 (15 ms), retain 14>
+
+
+system_profiler SPUSBDataType > /tmp/a
+
+>         USB Single Serial:
+>
+>           Product ID: 0x55d4
+>           Vendor ID: 0x1a86
+>           Version: 4.43
+>           Serial Number: 5323005057
+>           Speed: Up to 12 Mb/s
+>           Location ID: 0x14400000 / 50
+>           Current Available (mA): 500
+>           Current Required (mA): 134
+>           Extra Operating Current (mA): 0

info/mac/techo.txt

@@ -0,0 +1,40 @@
+
+in boot mode:
+
+% mount
+<snip>
+/dev/disk122 on /Volumes/TECHOBOOT (msdos, local, nodev, nosuid, noowners)
+
+% ls -al /Volumes/TECHOBOOT
+total 3735
+drwxrwxrwx@ 1 bob         staff     2048 Feb  1 16:47 .
+drwxr-xr-x  5 root        wheel      160 Feb  1 16:47 ..
+drwxrwxrwx  1 bob         staff      512 Feb  1 16:47 .fseventsd
+-rwxrwxrwx  1 bob         staff  1908736 Oct 13 08:37 CURRENT.UF2
+-rwxrwxrwx  1 bob         staff      129 Oct 13 08:37 INDEX.HTM
+-rwxrwxrwx  1 bob         staff      237 Oct 13 08:37 INFO_UF2.TXT
+
+
+# nothing plugged in
+% ioreg -p IOUSB > /tmp/a
+# not boot mode
+% ioreg -p IOUSB > /tmp/b
+# bootmode
+% ioreg -p IOUSB > /tmp/c
+
+
+% diff /tmp/a /tmp/b
+<snip>
+>   | +-o TTGO_eink@14300000  <class AppleUSBDevice, id 0x100060fe4, registered, matched, active, busy 0 (18 ms), retain 14>
+
+% diff /tmp/a /tmp/c
+<snip>
+>   | +-o T-Echo v1@14300000  <class AppleUSBDevice, id 0x100061000, registered, matched, active, busy 0 (25 ms), retain 16>
+
+contents of: INFO_UF2.TXT
+
+UF2 Bootloader 0.6.1-2-g1224915 lib/nrfx (v2.0.0) lib/tinyusb (0.10.1-293-gaf8e5a90) lib/uf2 (remotes/origin/configupdate-9-gadbb8c7)
+Model: LilyGo T-Echo
+Board-ID: nRF52840-TEcho-v1
+SoftDevice: S140 version 6.1.1
+Date: Oct 13 2021

info/mac/tlora.txt

@@ -0,0 +1,16 @@
+diff of ioreg -p IOUSB
+
+>   | +-o USB Single Serial@14300000  <class AppleUSBDevice, id 0x10005bf0f, registered, matched, active, busy 0 (18 ms), retain 14>
+
+
+Diff of system_profiler SPUSBDataType
+<         USB Single Serial:
+<
+<           Product ID: 0x55d4
+<           Vendor ID: 0x1a86
+<           Version: 4.43
+<           Speed: Up to 12 Mb/s
+<           Location ID: 0x14300000 / 46
+<           Current Available (mA): 500
+<           Current Required (mA): 134
+<           Extra Operating Current (mA): 0

info/mac/tlora_2.1.6.txt

@@ -0,0 +1,85 @@
+lsusb
+
+Bus 001 Device 001: ID 0bda:2172 Realtek Semiconductor Corp. BillBoard Device  Serial: 00000000000000000
+Bus 000 Device 002: ID 2109:0817 VIA Labs, Inc. USB3.0 Hub  Serial: 000000000
+Bus 000 Device 003: ID 2109:0715 VIA Labs, Inc. VLI Product String  Serial: 000000075003
+Bus 000 Device 004: ID 0bda:0306 Realtek Semiconductor Corp. USB3.0-CRW  Serial: 60000719201300000
+Bus 000 Device 005: ID 2109:0817 VIA Labs, Inc. USB3.0 Hub  Serial: 000000000
+Bus 000 Device 001: ID 2109:2817 VIA Labs, Inc. USB2.0 Hub  Serial: 000000000
+Bus 000 Device 009: ID 1a86:55d4 1a86 USB Single Serial  Serial: 533C005215
+Bus 000 Device 006: ID 2109:2817 VIA Labs, Inc. USB2.0 Hub  Serial: 000000000
+Bus 000 Device 007: ID 2109:8817 VIA Labs, Inc. USB Billboard Device  Serial: 0000000000000001
+Bus 000 Device 008: ID 2109:8817 VIA Labs, Inc. USB Billboard Device  Serial: 0000000000000001
+Bus 002 Device 001: ID 1a40:0101 TERMINUS TECHNOLOGY INC. USB 2.0 Hub 
+Bus 002 Device 003: ID 0922:001f Dymo Corporation DYMO LabelWriter 4XL  Serial: 17032316350940
+Bus 002 Device 002: ID 046d:082d Logitech Inc. HD Pro Webcam C920  Serial: A21C905F
+Bus 000 Device 000: ID 0bda:2172 Realtek Semiconductor Corp. USB 3.1 Bus 
+Bus 000 Device 000: ID 2109:0817 VIA Labs, Inc. USB 3.1 Bus 
+Bus 000 Device 001: ID 1d6b:1100 Linux Foundation USB 3.0 Bus
+
+% lsusb -v (with parts snipped)
+
+        USB2.0 Hub             :
+
+          Product ID: 0x2817
+          Vendor ID: 0x2109  (VIA Labs, Inc.)
+          Version: 6.03
+          Serial Number: 000000000
+          Speed: Up to 480 Mb/s
+          Manufacturer: VIA Labs, Inc.
+          Location ID: 0x00100000 / 1
+          Current Available (mA): 500
+          Current Required (mA): 0
+          Extra Operating Current (mA): 0
+
+            USB Single Serial:
+
+              Product ID: 0x55d4
+              Vendor ID: 0x1a86
+              Version: 4.43
+              Serial Number: 533C005215
+              Speed: Up to 12 Mb/s
+              Location ID: 0x00140000 / 9
+              Current Available (mA): 500
+              Current Required (mA): 134
+              Extra Operating Current (mA): 0
+
+            USB2.0 Hub             :
+
+              Product ID: 0x2817
+              Vendor ID: 0x2109  (VIA Labs, Inc.)
+              Version: 6.03
+              Serial Number: 000000000
+              Speed: Up to 480 Mb/s
+              Manufacturer: VIA Labs, Inc.
+              Location ID: 0x00110000 / 6
+              Current Available (mA): 500
+              Current Required (mA): 0
+              Extra Operating Current (mA): 0
+
+                USB Billboard Device   :
+
+                  Product ID: 0x8817
+                  Vendor ID: 0x2109  (VIA Labs, Inc.)
+                  Version: 0.01
+                  Serial Number: 0000000000000001
+                  Speed: Up to 480 Mb/s
+                  Manufacturer: VIA Labs, Inc.
+                  Location ID: 0x00115000 / 7
+                  Current Available (mA): 500
+                  Current Required (mA): 100
+                  Extra Operating Current (mA): 0
+
+            USB Billboard Device   :
+
+              Product ID: 0x8817
+              Vendor ID: 0x2109  (VIA Labs, Inc.)
+              Version: 0.01
+              Serial Number: 0000000000000001
+              Speed: Up to 480 Mb/s
+              Manufacturer: VIA Labs, Inc.
+              Location ID: 0x00150000 / 8
+              Current Available (mA): 500
+              Current Required (mA): 100
+              Extra Operating Current (mA): 0
+

info/readme.txt

@@ -0,0 +1,3 @@
+Gathering OS-level info for devices.
+
+This info might be helpful for developers detecting info about devices.

info/ubuntu/diy.txt

@@ -0,0 +1,67 @@
+lsusb
+
+Bus 002 Device 001: ID 1d6b:0003 Linux Foundation 3.0 root hub
+Bus 001 Device 004: ID 10c4:ea60 Silicon Labs CP210x UART Bridge
+Bus 001 Device 003: ID 0bda:2838 Realtek Semiconductor Corp. RTL2838 DVB-T
+Bus 001 Device 002: ID 2109:3431 VIA Labs, Inc. Hub
+Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
+
+lsusb -d 10c4: -v
+
+Bus 001 Device 004: ID 10c4:ea60 Silicon Labs CP210x UART Bridge
+Couldn't open device, some information will be missing
+Device Descriptor:
+  bLength                18
+  bDescriptorType         1
+  bcdUSB               2.00
+  bDeviceClass            0 
+  bDeviceSubClass         0 
+  bDeviceProtocol         0 
+  bMaxPacketSize0        64
+  idVendor           0x10c4 Silicon Labs
+  idProduct          0xea60 CP210x UART Bridge
+  bcdDevice            1.00
+  iManufacturer           1 
+  iProduct                2 
+  iSerial                 3 
+  bNumConfigurations      1
+  Configuration Descriptor:
+    bLength                 9
+    bDescriptorType         2
+    wTotalLength       0x0020
+    bNumInterfaces          1
+    bConfigurationValue     1
+    iConfiguration          0 
+    bmAttributes         0x80
+      (Bus Powered)
+    MaxPower              100mA
+    Interface Descriptor:
+      bLength                 9
+      bDescriptorType         4
+      bInterfaceNumber        0
+      bAlternateSetting       0
+      bNumEndpoints           2
+      bInterfaceClass       255 Vendor Specific Class
+      bInterfaceSubClass      0 
+      bInterfaceProtocol      0 
+      iInterface              2 
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x01  EP 1 OUT
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x82  EP 2 IN
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0

info/ubuntu/heltec_v2.txt

@@ -0,0 +1,85 @@
+Run on Ubuntu 20
+
+Command:
+lsusb -d 10c4: -v
+
+Output:
+Bus 001 Device 091: ID 10c4:ea60 Silicon Labs CP210x UART Bridge
+Device Descriptor:
+  bLength                18
+  bDescriptorType         1
+  bcdUSB               1.10
+  bDeviceClass            0 
+  bDeviceSubClass         0 
+  bDeviceProtocol         0 
+  bMaxPacketSize0        64
+  idVendor           0x10c4 Silicon Labs
+  idProduct          0xea60 CP210x UART Bridge
+  bcdDevice            1.00
+  iManufacturer           1 
+  iProduct                2 
+  iSerial                 3 
+  bNumConfigurations      1
+  Configuration Descriptor:
+    bLength                 9
+    bDescriptorType         2
+    wTotalLength       0x0020
+    bNumInterfaces          1
+    bConfigurationValue     1
+    iConfiguration          0 
+    bmAttributes         0x80
+      (Bus Powered)
+    MaxPower              100mA
+    Interface Descriptor:
+      bLength                 9
+      bDescriptorType         4
+      bInterfaceNumber        0
+      bAlternateSetting       0
+      bNumEndpoints           2
+      bInterfaceClass       255 Vendor Specific Class
+      bInterfaceSubClass      0 
+      bInterfaceProtocol      0 
+      iInterface              2 
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x81  EP 1 IN
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x01  EP 1 OUT
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0
+
+
+Command:
+esptool.py chip_id
+
+Output:
+esptool.py v3.2
+Found 3 serial ports
+Serial port /dev/ttyUSB0
+Connecting....
+Detecting chip type... Unsupported detection protocol, switching and trying again...
+Connecting.....
+Detecting chip type... ESP32
+Chip is ESP32-D0WDQ6 (revision 1)
+Features: WiFi, BT, Dual Core, 240MHz, VRef calibration in efuse, Coding Scheme None
+Crystal is 40MHz
+MAC: 24:0a:c4:fc:be:f0
+Uploading stub...
+Running stub...
+Stub running...
+Warning: ESP32 has no Chip ID. Reading MAC instead.
+MAC: 24:0a:c4:fc:be:f0
+Hard resetting via RTS pin...

info/ubuntu/rak4631_19003.txt

@@ -0,0 +1,118 @@
+
+Note: Meshtastic firmware was installed when running these commands
+
+$ ls -al /dev/ttyACM*
+crw-rw---- 1 root dialout 166, 0 Jan 29 21:50 /dev/ttyACM0
+
+lsusb -d 239a: -v
+
+Bus 001 Device 097: ID 239a:8029
+Couldn't open device, some information will be missing
+Device Descriptor:
+  bLength                18
+  bDescriptorType         1
+  bcdUSB               2.00
+  bDeviceClass          239 Miscellaneous Device
+  bDeviceSubClass         2
+  bDeviceProtocol         1 Interface Association
+  bMaxPacketSize0        64
+  idVendor           0x239a
+  idProduct          0x8029
+  bcdDevice            1.00
+  iManufacturer           1
+  iProduct                2
+  iSerial                 3
+  bNumConfigurations      1
+  Configuration Descriptor:
+    bLength                 9
+    bDescriptorType         2
+    wTotalLength       0x004b
+    bNumInterfaces          2
+    bConfigurationValue     1
+    iConfiguration          0
+    bmAttributes         0xa0
+      (Bus Powered)
+      Remote Wakeup
+    MaxPower              100mA
+    Interface Association:
+      bLength                 8
+      bDescriptorType        11
+      bFirstInterface         0
+      bInterfaceCount         2
+      bFunctionClass          2 Communications
+      bFunctionSubClass       2 Abstract (modem)
+      bFunctionProtocol       0
+      iFunction               0
+    Interface Descriptor:
+      bLength                 9
+      bDescriptorType         4
+      bInterfaceNumber        0
+      bAlternateSetting       0
+      bNumEndpoints           1
+      bInterfaceClass         2 Communications
+      bInterfaceSubClass      2 Abstract (modem)
+      bInterfaceProtocol      0
+      iInterface              4
+      CDC Header:
+        bcdCDC               1.20
+      CDC Call Management:
+        bmCapabilities       0x00
+        bDataInterface          1
+      CDC ACM:
+        bmCapabilities       0x02
+          line coding and serial state
+      CDC Union:
+        bMasterInterface        0
+        bSlaveInterface         1
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x81  EP 1 IN
+        bmAttributes            3
+          Transfer Type            Interrupt
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0008  1x 8 bytes
+        bInterval              16
+    Interface Descriptor:
+      bLength                 9
+      bDescriptorType         4
+      bInterfaceNumber        1
+      bAlternateSetting       0
+      bNumEndpoints           2
+      bInterfaceClass        10 CDC Data
+      bInterfaceSubClass      0
+      bInterfaceProtocol      0
+      iInterface              0
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x01  EP 1 OUT
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x82  EP 2 IN
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0
+
+$ lsusb
+Bus 002 Device 005: ID 046d:c31c Logitech, Inc. Keyboard K120
+Bus 002 Device 002: ID 8087:8000 Intel Corp.
+Bus 002 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
+Bus 001 Device 097: ID 239a:8029
+Bus 001 Device 002: ID 8087:8008 Intel Corp.
+Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
+Bus 004 Device 001: ID 1d6b:0003 Linux Foundation 3.0 root hub
+Bus 003 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
+
+Note: esptool.py chip_id does not detect device

info/ubuntu/rak4631_5005.txt

@@ -0,0 +1,148 @@
+
+Note: Device has Meshtastic firmware installed.
+
+$ ls -al /dev/ttyACM*
+crw-rw---- 1 root dialout 166, 0 Jan 29 21:44 /dev/ttyACM0
+
+$ lsusb -d 239a: -v
+
+Bus 001 Device 098: ID 239a:0029
+Couldn't open device, some information will be missing
+Device Descriptor:
+  bLength                18
+  bDescriptorType         1
+  bcdUSB               2.00
+  bDeviceClass          239 Miscellaneous Device
+  bDeviceSubClass         2
+  bDeviceProtocol         1 Interface Association
+  bMaxPacketSize0        64
+  idVendor           0x239a
+  idProduct          0x0029
+  bcdDevice            1.00
+  iManufacturer           1
+  iProduct                2
+  iSerial                 3
+  bNumConfigurations      1
+  Configuration Descriptor:
+    bLength                 9
+    bDescriptorType         2
+    wTotalLength       0x0062
+    bNumInterfaces          3
+    bConfigurationValue     1
+    iConfiguration          0
+    bmAttributes         0xa0
+      (Bus Powered)
+      Remote Wakeup
+    MaxPower              100mA
+    Interface Association:
+      bLength                 8
+      bDescriptorType        11
+      bFirstInterface         0
+      bInterfaceCount         2
+      bFunctionClass          2 Communications
+      bFunctionSubClass       2 Abstract (modem)
+      bFunctionProtocol       0
+      iFunction               0
+    Interface Descriptor:
+      bLength                 9
+      bDescriptorType         4
+      bInterfaceNumber        0
+      bAlternateSetting       0
+      bNumEndpoints           1
+      bInterfaceClass         2 Communications
+      bInterfaceSubClass      2 Abstract (modem)
+      bInterfaceProtocol      0
+      iInterface              4
+      CDC Header:
+        bcdCDC               1.20
+      CDC Call Management:
+        bmCapabilities       0x00
+        bDataInterface          1
+      CDC ACM:
+        bmCapabilities       0x02
+          line coding and serial state
+      CDC Union:
+        bMasterInterface        0
+        bSlaveInterface         1
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x81  EP 1 IN
+        bmAttributes            3
+          Transfer Type            Interrupt
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0008  1x 8 bytes
+        bInterval              16
+    Interface Descriptor:
+      bLength                 9
+      bDescriptorType         4
+      bInterfaceNumber        1
+      bAlternateSetting       0
+      bNumEndpoints           2
+      bInterfaceClass        10 CDC Data
+      bInterfaceSubClass      0
+      bInterfaceProtocol      0
+      iInterface              0
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x02  EP 2 OUT
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x82  EP 2 IN
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0
+    Interface Descriptor:
+      bLength                 9
+      bDescriptorType         4
+      bInterfaceNumber        2
+      bAlternateSetting       0
+      bNumEndpoints           2
+      bInterfaceClass         8 Mass Storage
+      bInterfaceSubClass      6 SCSI
+      bInterfaceProtocol     80 Bulk-Only
+      iInterface              5
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x03  EP 3 OUT
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x83  EP 3 IN
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0
+
+$ lsusb
+Bus 002 Device 005: ID 046d:c31c Logitech, Inc. Keyboard K120
+Bus 002 Device 002: ID 8087:8000 Intel Corp.
+Bus 002 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
+Bus 001 Device 098: ID 239a:0029
+Bus 001 Device 002: ID 8087:8008 Intel Corp.
+Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
+Bus 004 Device 001: ID 1d6b:0003 Linux Foundation 3.0 root hub
+Bus 003 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
+
+Note: esptool.py chip_id does not detect device

info/ubuntu/readme.txt

@@ -0,0 +1 @@
+info run on ubuntu

info/ubuntu/tbeam.txt

@@ -0,0 +1,94 @@
+Run on Ubuntu 20
+
+Command:
+ lsusb -d 1a86: -v
+
+Output:
+Bus 001 Device 096: ID 1a86:55d4 QinHeng Electronics 
+Device Descriptor:
+  bLength                18
+  bDescriptorType         1
+  bcdUSB               1.10
+  bDeviceClass            2 Communications
+  bDeviceSubClass         0 
+  bDeviceProtocol         0 
+  bMaxPacketSize0         8
+  idVendor           0x1a86 QinHeng Electronics
+  idProduct          0x55d4 
+  bcdDevice            4.43
+  iManufacturer           0 
+  iProduct                2 
+  iSerial                 3 
+  bNumConfigurations      1
+  Configuration Descriptor:
+    bLength                 9
+    bDescriptorType         2
+    wTotalLength       0x0043
+    bNumInterfaces          2
+    bConfigurationValue     1
+    iConfiguration          0 
+    bmAttributes         0xa0
+      (Bus Powered)
+      Remote Wakeup
+    MaxPower              134mA
+    Interface Descriptor:
+      bLength                 9
+      bDescriptorType         4
+      bInterfaceNumber        0
+      bAlternateSetting       0
+      bNumEndpoints           1
+      bInterfaceClass         2 Communications
+      bInterfaceSubClass      2 Abstract (modem)
+      bInterfaceProtocol      1 AT-commands (v.25ter)
+      iInterface              0 
+      CDC Header:
+        bcdCDC               1.10
+      CDC Call Management:
+        bmCapabilities       0x00
+        bDataInterface          1
+      CDC ACM:
+        bmCapabilities       0x02
+          line coding and serial state
+      CDC Union:
+        bMasterInterface        0
+        bSlaveInterface         1 
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x83  EP 3 IN
+        bmAttributes            3
+          Transfer Type            Interrupt
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0010  1x 16 bytes
+        bInterval               1
+    Interface Descriptor:
+      bLength                 9
+      bDescriptorType         4
+      bInterfaceNumber        1
+      bAlternateSetting       0
+      bNumEndpoints           2
+      bInterfaceClass        10 CDC Data
+      bInterfaceSubClass      0 
+      bInterfaceProtocol      0 
+      iInterface              0 
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x02  EP 2 OUT
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0020  1x 32 bytes
+        bInterval               0
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x82  EP 2 IN
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0

info/ubuntu/techo.txt

@@ -0,0 +1,141 @@
+
+$ lsusb
+Bus 002 Device 005: ID 046d:c31c Logitech, Inc. Keyboard K120
+Bus 002 Device 002: ID 8087:8000 Intel Corp.
+Bus 002 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
+Bus 001 Device 107: ID 239a:0029
+Bus 001 Device 002: ID 8087:8008 Intel Corp.
+Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
+Bus 004 Device 001: ID 1d6b:0003 Linux Foundation 3.0 root hub
+Bus 003 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
+
+$ lsusb -d 239a: -v
+
+Bus 001 Device 107: ID 239a:0029
+Couldn't open device, some information will be missing
+Device Descriptor:
+  bLength                18
+  bDescriptorType         1
+  bcdUSB               2.00
+  bDeviceClass          239 Miscellaneous Device
+  bDeviceSubClass         2
+  bDeviceProtocol         1 Interface Association
+  bMaxPacketSize0        64
+  idVendor           0x239a
+  idProduct          0x0029
+  bcdDevice            1.00
+  iManufacturer           1
+  iProduct                2
+  iSerial                 3
+  bNumConfigurations      1
+  Configuration Descriptor:
+    bLength                 9
+    bDescriptorType         2
+    wTotalLength       0x0062
+    bNumInterfaces          3
+    bConfigurationValue     1
+    iConfiguration          0
+    bmAttributes         0xa0
+      (Bus Powered)
+      Remote Wakeup
+    MaxPower              100mA
+    Interface Association:
+      bLength                 8
+      bDescriptorType        11
+      bFirstInterface         0
+      bInterfaceCount         2
+      bFunctionClass          2 Communications
+      bFunctionSubClass       2 Abstract (modem)
+      bFunctionProtocol       0
+      iFunction               0
+    Interface Descriptor:
+      bLength                 9
+      bDescriptorType         4
+      bInterfaceNumber        0
+      bAlternateSetting       0
+      bNumEndpoints           1
+      bInterfaceClass         2 Communications
+      bInterfaceSubClass      2 Abstract (modem)
+      bInterfaceProtocol      0
+      iInterface              4
+      CDC Header:
+        bcdCDC               1.20
+      CDC Call Management:
+        bmCapabilities       0x00
+        bDataInterface          1
+      CDC ACM:
+        bmCapabilities       0x02
+          line coding and serial state
+      CDC Union:
+        bMasterInterface        0
+        bSlaveInterface         1
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x81  EP 1 IN
+        bmAttributes            3
+          Transfer Type            Interrupt
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0008  1x 8 bytes
+        bInterval              16
+    Interface Descriptor:
+      bLength                 9
+      bDescriptorType         4
+      bInterfaceNumber        1
+      bAlternateSetting       0
+      bNumEndpoints           2
+      bInterfaceClass        10 CDC Data
+      bInterfaceSubClass      0
+      bInterfaceProtocol      0
+      iInterface              0
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x02  EP 2 OUT
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x82  EP 2 IN
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0
+    Interface Descriptor:
+      bLength                 9
+      bDescriptorType         4
+      bInterfaceNumber        2
+      bAlternateSetting       0
+      bNumEndpoints           2
+      bInterfaceClass         8 Mass Storage
+      bInterfaceSubClass      6 SCSI
+      bInterfaceProtocol     80 Bulk-Only
+      iInterface              5
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x03  EP 3 OUT
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x83  EP 3 IN
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0

info/ubuntu/tlora.txt

@@ -0,0 +1,107 @@
+
+Run on Ubuntu 20
+
+Note: Device has Meshtastic firmware installed
+
+
+$ lsusb
+Bus 002 Device 005: ID 046d:c31c Logitech, Inc. Keyboard K120
+Bus 002 Device 002: ID 8087:8000 Intel Corp.
+Bus 002 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
+Bus 001 Device 099: ID 1a86:55d4 QinHeng Electronics
+Bus 001 Device 002: ID 8087:8008 Intel Corp.
+Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
+Bus 004 Device 001: ID 1d6b:0003 Linux Foundation 3.0 root hub
+Bus 003 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
+
+$ lsusb -d 1a86: -v
+
+Bus 001 Device 099: ID 1a86:55d4 QinHeng Electronics
+Couldn't open device, some information will be missing
+Device Descriptor:
+  bLength                18
+  bDescriptorType         1
+  bcdUSB               1.10
+  bDeviceClass            2 Communications
+  bDeviceSubClass         0
+  bDeviceProtocol         0
+  bMaxPacketSize0         8
+  idVendor           0x1a86 QinHeng Electronics
+  idProduct          0x55d4
+  bcdDevice            4.43
+  iManufacturer           0
+  iProduct                2
+  iSerial                 0
+  bNumConfigurations      1
+  Configuration Descriptor:
+    bLength                 9
+    bDescriptorType         2
+    wTotalLength       0x0043
+    bNumInterfaces          2
+    bConfigurationValue     1
+    iConfiguration          0
+    bmAttributes         0xa0
+      (Bus Powered)
+      Remote Wakeup
+    MaxPower              134mA
+    Interface Descriptor:
+      bLength                 9
+      bDescriptorType         4
+      bInterfaceNumber        0
+      bAlternateSetting       0
+      bNumEndpoints           1
+      bInterfaceClass         2 Communications
+      bInterfaceSubClass      2 Abstract (modem)
+      bInterfaceProtocol      1 AT-commands (v.25ter)
+      iInterface              0
+      CDC Header:
+        bcdCDC               1.10
+      CDC Call Management:
+        bmCapabilities       0x00
+        bDataInterface          1
+      CDC ACM:
+        bmCapabilities       0x02
+          line coding and serial state
+      CDC Union:
+        bMasterInterface        0
+        bSlaveInterface         1
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x83  EP 3 IN
+        bmAttributes            3
+          Transfer Type            Interrupt
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0010  1x 16 bytes
+        bInterval               1
+    Interface Descriptor:
+      bLength                 9
+      bDescriptorType         4
+      bInterfaceNumber        1
+      bAlternateSetting       0
+      bNumEndpoints           2
+      bInterfaceClass        10 CDC Data
+      bInterfaceSubClass      0
+      bInterfaceProtocol      0
+      iInterface              0
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x02  EP 2 OUT
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0020  1x 32 bytes
+        bInterval               0
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x82  EP 2 IN
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0

info/windows/heltec.txt

@@ -0,0 +1,106 @@
+Run from Windows 10
+
+Might work... (nope)
+ Get-PnpDevice -Class 'USB' -PresentOnly | Format-List
+
+
+> Get-PnpDevice -PresentOnly | Format-List > b
+> Compare-Object (get-content a) (Get-Content b)
+
+InputObject                                                                                              SideIndicator
+-----------                                                                                              -------------
+Caption                     : CP2102 USB to UART Bridge Controller                                       <=
+Description                 : CP2102 USB to UART Bridge Controller                                       <=
+Name                        : CP2102 USB to UART Bridge Controller                                       <=
+Status                      : Error                                                                      <=
+ConfigManagerErrorCode      : CM_PROB_FAILED_INSTALL                                                     <=
+DeviceID                    : USB\VID_10C4&PID_EA60\0001                                                 <=
+PNPDeviceID                 : USB\VID_10C4&PID_EA60\0001                                                 <=
+CompatibleID                : {USB\Class_FF&SubClass_00&Prot_00, USB\Class_FF&SubClass_00, USB\Class_FF} <=
+HardwareID                  : {USB\VID_10C4&PID_EA60&REV_0100, USB\VID_10C4&PID_EA60}                    <=
+FriendlyName                : CP2102 USB to UART Bridge Controller                                       <=
+InstanceId                  : USB\VID_10C4&PID_EA60\0001                                                 <=
+Problem                     : CM_PROB_FAILED_INSTALL                                                     <=
+ClassGuid                   :                                                                            <=
+Manufacturer                :                                                                            <=
+PNPClass                    :                                                                            <=
+Class                       :                                                                            <=
+Service                     :                                                                            <=
+InstallDate                 :                                                                            <=
+Availability                :                                                                            <=
+ConfigManagerUserConfig     : False                                                                      <=
+CreationClassName           : Win32_PnPEntity                                                            <=
+ErrorCleared                :                                                                            <=
+ErrorDescription            :                                                                            <=
+LastErrorCode               :                                                                            <=
+PowerManagementCapabilities :                                                                            <=
+PowerManagementSupported    :                                                                            <=
+StatusInfo                  :                                                                            <=
+SystemCreationClassName     : Win32_ComputerSystem                                                       <=
+SystemName                  : DESKTOP-FRFQN8H                                                            <=
+Present                     : True                                                                       <=
+PSComputerName              :                                                                            <=
+ProblemDescription          :                                                                            <=
+                                                                                                         <=
+
+> Get-PnpDevice -DeviceID 'USB\VID_10C4&PID_EA60\0001'
+
+Status     Class           FriendlyName                                                                     InstanceId
+------     -----           ------------                                                                     ----------
+Error                      CP2102 USB to UART Bridge Controller                                             USB\VID_...
+
+
+> Get-PnpDevice -PresentOnly -DeviceID 'USB\VID_10C4&PID_EA60\0001'
+Get-PnpDevice : No matching Win32_PnPEntity objects found by CIM query for instances of the ROOT\cimv2\Win32_PnPEntity
+class on the  CIM server: SELECT * FROM Win32_PnPEntity  WHERE ((DeviceId LIKE 'USB\\VID[_]10C4&PID[_]EA60\\0001'))
+AND ((Present = TRUE)). Verify query parameters and retry.
+At line:1 char:1
++ Get-PnpDevice -PresentOnly -DeviceID 'USB\VID_10C4&PID_EA60\0001'
++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    + CategoryInfo          : ObjectNotFound: (Win32_PnPEntity:String) [Get-PnpDevice], CimJobException
+    + FullyQualifiedErrorId : CmdletizationQuery_NotFound,Get-PnpDevice
+
+> Get-PnpDevice -PresentOnly -DeviceID 'USB\VID_10C4&PID_EA60\0001'
+
+Status     Class           FriendlyName                                                                     InstanceId
+------     -----           ------------                                                                     ----------
+Error                      CP2102 USB to UART Bridge Controller                                             USB\VID_...
+
+
+
+If need to install driver
+Get-PnpDevice -DeviceID 'USB\VID_10C4&PID_EA60\0001' | Format-List
+
+
+Caption                     : CP2102 USB to UART Bridge Controller
+Description                 : CP2102 USB to UART Bridge Controller
+InstallDate                 :
+Name                        : CP2102 USB to UART Bridge Controller
+Status                      : Error
+Availability                :
+ConfigManagerErrorCode      : CM_PROB_FAILED_INSTALL
+ConfigManagerUserConfig     : False
+CreationClassName           : Win32_PnPEntity
+DeviceID                    : USB\VID_10C4&PID_EA60\0001
+ErrorCleared                :
+ErrorDescription            :
+LastErrorCode               :
+PNPDeviceID                 : USB\VID_10C4&PID_EA60\0001
+PowerManagementCapabilities :
+PowerManagementSupported    :
+StatusInfo                  :
+SystemCreationClassName     : Win32_ComputerSystem
+SystemName                  : DESKTOP-FRFQN8H
+ClassGuid                   :
+CompatibleID                : {USB\Class_FF&SubClass_00&Prot_00, USB\Class_FF&SubClass_00, USB\Class_FF}
+HardwareID                  : {USB\VID_10C4&PID_EA60&REV_0100, USB\VID_10C4&PID_EA60}
+Manufacturer                :
+PNPClass                    :
+Present                     : True
+Service                     :
+PSComputerName              :
+Class                       :
+FriendlyName                : CP2102 USB to UART Bridge Controller
+InstanceId                  : USB\VID_10C4&PID_EA60\0001
+Problem                     : CM_PROB_FAILED_INSTALL
+ProblemDescription          :

info/windows/rak4631_19003.txt

@@ -0,0 +1,78 @@
+Run from Windows 10
+
+> Get-PnpDevice -PresentOnly | Format-List >a
+> Get-PnpDevice -PresentOnly | Format-List >b
+> Compare-Object (get-content a) (Get-Content b)
+
+InputObject                                                                                                        Side
+                                                                                                                   Indi
+                                                                                                                   cato
+                                                                                                                   r
+-----------                                                                                                        ----
+Caption                     : USB Serial Device (COM4)                                                             =>
+Description                 : USB Serial Device                                                                    =>
+Name                        : USB Serial Device (COM4)                                                             =>
+DeviceID                    : USB\VID_239A&PID_8029&MI_00\6&E8876D1&0&0000                                         =>
+PNPDeviceID                 : USB\VID_239A&PID_8029&MI_00\6&E8876D1&0&0000                                         =>
+ClassGuid                   : {4d36e978-e325-11ce-bfc1-08002be10318}                                               =>
+CompatibleID                : {USB\Class_02&SubClass_02&Prot_00, USB\Class_02&SubClass_02, USB\Class_02}           =>
+HardwareID                  : {USB\VID_239A&PID_8029&REV_0100&MI_00, USB\VID_239A&PID_8029&MI_00}                  =>
+PNPClass                    : Ports                                                                                =>
+Service                     : usbser                                                                               =>
+Class                       : Ports                                                                                =>
+FriendlyName                : USB Serial Device (COM4)                                                             =>
+InstanceId                  : USB\VID_239A&PID_8029&MI_00\6&E8876D1&0&0000                                         =>
+Caption                     : USB Composite Device                                                                 =>
+Description                 : USB Composite Device                                                                 =>
+Name                        : USB Composite Device                                                                 =>
+DeviceID                    : USB\VID_239A&PID_8029\E6CF9502B1D410D8                                               =>
+PNPDeviceID                 : USB\VID_239A&PID_8029\E6CF9502B1D410D8                                               =>
+ClassGuid                   : {36fc9e60-c465-11cf-8056-444553540000}                                               =>
+CompatibleID                : {USB\DevClass_00&SubClass_00&Prot_00, USB\DevClass_00&SubClass_00, USB\DevClass_00,  =>
+                              USB\COMPOSITE}                                                                       =>
+HardwareID                  : {USB\VID_239A&PID_8029&REV_0100, USB\VID_239A&PID_8029}                              =>
+Manufacturer                : (Standard USB Host Controller)                                                       =>
+PNPClass                    : USB                                                                                  =>
+Service                     : usbccgp                                                                              =>
+Class                       : USB                                                                                  =>
+FriendlyName                : USB Composite Device                                                                 =>
+InstanceId                  : USB\VID_239A&PID_8029\E6CF9502B1D410D8                                               =>
+InstallDate                 :                                                                                      =>
+Status                      : OK                                                                                   =>
+Availability                :                                                                                      =>
+ConfigManagerErrorCode      : CM_PROB_NONE                                                                         =>
+ConfigManagerUserConfig     : False                                                                                =>
+CreationClassName           : Win32_PnPEntity                                                                      =>
+ErrorCleared                :                                                                                      =>
+ErrorDescription            :                                                                                      =>
+LastErrorCode               :                                                                                      =>
+PowerManagementCapabilities :                                                                                      =>
+PowerManagementSupported    :                                                                                      =>
+StatusInfo                  :                                                                                      =>
+SystemCreationClassName     : Win32_ComputerSystem                                                                 =>
+SystemName                  : DESKTOP-FRFQN8H                                                                      =>
+Present                     : True                                                                                 =>
+PSComputerName              :                                                                                      =>
+Problem                     : CM_PROB_NONE                                                                         =>
+ProblemDescription          :                                                                                      =>
+InstallDate                 :                                                                                      =>
+Status                      : OK                                                                                   =>
+Availability                :                                                                                      =>
+ConfigManagerErrorCode      : CM_PROB_NONE                                                                         =>
+ConfigManagerUserConfig     : False                                                                                =>
+CreationClassName           : Win32_PnPEntity                                                                      =>
+ErrorCleared                :                                                                                      =>
+ErrorDescription            :                                                                                      =>
+LastErrorCode               :                                                                                      =>
+PowerManagementCapabilities :                                                                                      =>
+PowerManagementSupported    :                                                                                      =>
+StatusInfo                  :                                                                                      =>
+SystemCreationClassName     : Win32_ComputerSystem                                                                 =>
+SystemName                  : DESKTOP-FRFQN8H                                                                      =>
+Manufacturer                : Microsoft                                                                            =>
+Present                     : True                                                                                 =>
+PSComputerName              :                                                                                      =>
+Problem                     : CM_PROB_NONE                                                                         =>
+ProblemDescription          :                                                                                      =>
+                                                                                                                   =>
+                                                                                                                   =>

info/windows/rak4631_5005.txt

@@ -0,0 +1,254 @@
+Run from Windows 10
+
+> Get-PnpDevice -PresentOnly | Format-List >a
+> Get-PnpDevice -PresentOnly | Format-List >b
+> Compare-Object (get-content a) (Get-Content b)
+
+In "boot" mode:
+
+InputObject
+-----------
+Caption                     : FTHR840BOOT
+Description                 : nRF UF2
+Name                        : FTHR840BOOT
+DeviceID                    : SWD\WPDBUSENUM\_??_USBSTOR#DISK&VEN_ADAFRUIT&PROD_NRF_UF2&REV_1.0#7&27E1626&0&D121BD1C90B
+                              93EA2&0#{53F56307-B6BF-11D0-94F2-00A0C91EFB8B}
+PNPDeviceID                 : SWD\WPDBUSENUM\_??_USBSTOR#DISK&VEN_ADAFRUIT&PROD_NRF_UF2&REV_1.0#7&27E1626&0&D121BD1C90B
+                              93EA2&0#{53F56307-B6BF-11D0-94F2-00A0C91EFB8B}
+ClassGuid                   : {eec5ad98-8080-425f-922a-dabf3de3f69a}
+CompatibleID                : {wpdbusenum\fs, SWD\Generic}
+Manufacturer                : Adafruit
+PNPClass                    : WPD
+Service                     : WUDFWpdFs
+Class                       : WPD
+FriendlyName                : FTHR840BOOT
+InstanceId                  : SWD\WPDBUSENUM\_??_USBSTOR#DISK&VEN_ADAFRUIT&PROD_NRF_UF2&REV_1.0#7&27E1626&0&D121BD1C90B
+                              93EA2&0#{53F56307-B6BF-11D0-94F2-00A0C91EFB8B}
+DeviceID                    : STORAGE\VOLUME\_??_USBSTOR#DISK&VEN_ADAFRUIT&PROD_NRF_UF2&REV_1.0#7&27E1626&0&D121BD1C90B
+                              93EA2&0#{53F56307-B6BF-11D0-94F2-00A0C91EFB8B}
+PNPDeviceID                 : STORAGE\VOLUME\_??_USBSTOR#DISK&VEN_ADAFRUIT&PROD_NRF_UF2&REV_1.0#7&27E1626&0&D121BD1C90B
+                              93EA2&0#{53F56307-B6BF-11D0-94F2-00A0C91EFB8B}
+InstanceId                  : STORAGE\VOLUME\_??_USBSTOR#DISK&VEN_ADAFRUIT&PROD_NRF_UF2&REV_1.0#7&27E1626&0&D121BD1C90B
+                              93EA2&0#{53F56307-B6BF-11D0-94F2-00A0C91EFB8B}
+Caption                     : USB Mass Storage Device
+Description                 : USB Mass Storage Device
+Name                        : USB Mass Storage Device
+DeviceID                    : USB\VID_239A&PID_0029&MI_02\6&175793A&0&0002
+PNPDeviceID                 : USB\VID_239A&PID_0029&MI_02\6&175793A&0&0002
+CompatibleID                : {USB\Class_08&SubClass_06&Prot_50, USB\Class_08&SubClass_06, USB\Class_08}
+HardwareID                  : {USB\VID_239A&PID_0029&REV_0100&MI_02, USB\VID_239A&PID_0029&MI_02}
+Manufacturer                : Compatible USB storage device
+Service                     : USBSTOR
+FriendlyName                : USB Mass Storage Device
+InstanceId                  : USB\VID_239A&PID_0029&MI_02\6&175793A&0&0002
+Caption                     : USB Serial Device (COM5)
+Description                 : USB Serial Device
+Name                        : USB Serial Device (COM5)
+DeviceID                    : USB\VID_239A&PID_0029&MI_00\6&175793A&0&0000
+PNPDeviceID                 : USB\VID_239A&PID_0029&MI_00\6&175793A&0&0000
+ClassGuid                   : {4d36e978-e325-11ce-bfc1-08002be10318}
+CompatibleID                : {USB\Class_02&SubClass_02&Prot_00, USB\Class_02&SubClass_02, USB\Class_02}
+HardwareID                  : {USB\VID_239A&PID_0029&REV_0100&MI_00, USB\VID_239A&PID_0029&MI_00}
+PNPClass                    : Ports
+Service                     : usbser
+Class                       : Ports
+FriendlyName                : USB Serial Device (COM5)
+InstanceId                  : USB\VID_239A&PID_0029&MI_00\6&175793A&0&0000
+DeviceID                    : USB\VID_239A&PID_0029\D121BD1C90B93EA2
+PNPDeviceID                 : USB\VID_239A&PID_0029\D121BD1C90B93EA2
+ClassGuid                   : {36fc9e60-c465-11cf-8056-444553540000}
+HardwareID                  : {USB\VID_239A&PID_0029&REV_0100, USB\VID_239A&PID_0029}
+PNPClass                    : USB
+Class                       : USB
+InstanceId                  : USB\VID_239A&PID_0029\D121BD1C90B93EA2
+Caption                     : USB Composite Device
+Description                 : USB Composite Device
+Name                        : USB Composite Device
+ClassGuid                   : {36fc9e60-c465-11cf-8056-444553540000}
+CompatibleID                : {USB\DevClass_00&SubClass_00&Prot_00, USB\DevClass_00&SubClass_00, USB\DevClass_00,
+                              USB\COMPOSITE}
+Manufacturer                : (Standard USB Host Controller)
+PNPClass                    : USB
+Service                     : usbccgp
+Class                       : USB
+FriendlyName                : USB Composite Device
+Caption                     : Volume
+Description                 : Volume
+Name                        : Volume
+ClassGuid                   : {71a27cdd-812a-11d0-bec7-08002be2092f}
+HardwareID                  : {STORAGE\Volume}
+PNPClass                    : Volume
+Service                     : volume
+Class                       : Volume
+FriendlyName                : Volume
+HardwareID                  :
+Caption                     : Adafruit nRF UF2 USB Device
+Name                        : Adafruit nRF UF2 USB Device
+DeviceID                    : USBSTOR\DISK&VEN_ADAFRUIT&PROD_NRF_UF2&REV_1.0\7&27E1626&0&D121BD1C90B93EA2&0
+PNPDeviceID                 : USBSTOR\DISK&VEN_ADAFRUIT&PROD_NRF_UF2&REV_1.0\7&27E1626&0&D121BD1C90B93EA2&0
+CompatibleID                : {USBSTOR\Disk, USBSTOR\RAW, GenDisk}
+HardwareID                  : {USBSTOR\DiskAdafruitnRF_UF2_________1.0_, USBSTOR\DiskAdafruitnRF_UF2_________,
+                              USBSTOR\DiskAdafruit, USBSTOR\AdafruitnRF_UF2_________1...}
+FriendlyName                : Adafruit nRF UF2 USB Device
+InstanceId                  : USBSTOR\DISK&VEN_ADAFRUIT&PROD_NRF_UF2&REV_1.0\7&27E1626&0&D121BD1C90B93EA2&0
+Description                 : Disk drive
+ClassGuid                   : {4d36e967-e325-11ce-bfc1-08002be10318}
+Manufacturer                : (Standard disk drives)
+PNPClass                    : DiskDrive
+Service                     : disk
+Class                       : DiskDrive
+CompatibleID                :
+InstallDate                 :
+Status                      : OK
+Availability                :
+ConfigManagerErrorCode      : CM_PROB_NONE
+ConfigManagerUserConfig     : False
+CreationClassName           : Win32_PnPEntity
+ErrorCleared                :
+ErrorDescription            :
+LastErrorCode               :
+PowerManagementCapabilities :
+PowerManagementSupported    :
+StatusInfo                  :
+SystemCreationClassName     : Win32_ComputerSystem
+SystemName                  : DESKTOP-FRFQN8H
+Present                     : True
+PSComputerName              :
+Problem                     : CM_PROB_NONE
+ProblemDescription          :
+InstallDate                 :
+Status                      : OK
+Availability                :
+ConfigManagerErrorCode      : CM_PROB_NONE
+ConfigManagerUserConfig     : False
+CreationClassName           : Win32_PnPEntity
+ErrorCleared                :
+ErrorDescription            :
+LastErrorCode               :
+PowerManagementCapabilities :
+PowerManagementSupported    :
+StatusInfo                  :
+SystemCreationClassName     : Win32_ComputerSystem
+SystemName                  : DESKTOP-FRFQN8H
+Present                     : True
+PSComputerName              :
+Problem                     : CM_PROB_NONE
+ProblemDescription          :
+InstallDate                 :
+Status                      : OK
+Availability                :
+ConfigManagerErrorCode      : CM_PROB_NONE
+ConfigManagerUserConfig     : False
+CreationClassName           : Win32_PnPEntity
+ErrorCleared                :
+ErrorDescription            :
+LastErrorCode               :
+PowerManagementCapabilities :
+PowerManagementSupported    :
+StatusInfo                  :
+SystemCreationClassName     : Win32_ComputerSystem
+SystemName                  : DESKTOP-FRFQN8H
+Present                     : True
+PSComputerName              :
+Problem                     : CM_PROB_NONE
+ProblemDescription          :
+
+InstallDate                 :
+Status                      : OK
+Availability                :
+ConfigManagerErrorCode      : CM_PROB_NONE
+ConfigManagerUserConfig     : False
+CreationClassName           : Win32_PnPEntity
+ErrorCleared                :
+ErrorDescription            :
+LastErrorCode               :
+PowerManagementCapabilities :
+PowerManagementSupported    :
+StatusInfo                  :
+SystemCreationClassName     : Win32_ComputerSystem
+SystemName                  : DESKTOP-FRFQN8H
+Manufacturer                : Microsoft
+Present                     : True
+PSComputerName              :
+Problem                     : CM_PROB_NONE
+ProblemDescription          :
+
+
+
+When you press the RST to load Meshtastic:
+
+> Get-PnpDevice -PresentOnly | Format-List >b
+> Compare-Object (get-content a) (Get-Content b)
+
+InputObject                                                                                                        Side
+                                                                                                                   Indi
+                                                                                                                   cato
+                                                                                                                   r
+-----------                                                                                                        ----
+DeviceID                    : USB\VID_239A&PID_8029\D121BD1C90B93EA2                                               =>
+PNPDeviceID                 : USB\VID_239A&PID_8029\D121BD1C90B93EA2                                               =>
+HardwareID                  : {USB\VID_239A&PID_8029&REV_0100, USB\VID_239A&PID_8029}                              =>
+InstanceId                  : USB\VID_239A&PID_8029\D121BD1C90B93EA2                                               =>
+Caption                     : USB Composite Device                                                                 =>
+Description                 : USB Composite Device                                                                 =>
+Name                        : USB Composite Device                                                                 =>
+ClassGuid                   : {36fc9e60-c465-11cf-8056-444553540000}                                               =>
+CompatibleID                : {USB\DevClass_00&SubClass_00&Prot_00, USB\DevClass_00&SubClass_00, USB\DevClass_00,  =>
+                              USB\COMPOSITE}                                                                       =>
+Manufacturer                : (Standard USB Host Controller)                                                       =>
+PNPClass                    : USB                                                                                  =>
+Service                     : usbccgp                                                                              =>
+Class                       : USB                                                                                  =>
+FriendlyName                : USB Composite Device                                                                 =>
+Caption                     : USB Serial Device (COM6)                                                             =>
+Description                 : USB Serial Device                                                                    =>
+Name                        : USB Serial Device (COM6)                                                             =>
+DeviceID                    : USB\VID_239A&PID_8029&MI_00\6&39B279E2&0&0000                                        =>
+PNPDeviceID                 : USB\VID_239A&PID_8029&MI_00\6&39B279E2&0&0000                                        =>
+ClassGuid                   : {4d36e978-e325-11ce-bfc1-08002be10318}                                               =>
+CompatibleID                : {USB\Class_02&SubClass_02&Prot_00, USB\Class_02&SubClass_02, USB\Class_02}           =>
+HardwareID                  : {USB\VID_239A&PID_8029&REV_0100&MI_00, USB\VID_239A&PID_8029&MI_00}                  =>
+PNPClass                    : Ports                                                                                =>
+Service                     : usbser                                                                               =>
+Class                       : Ports                                                                                =>
+FriendlyName                : USB Serial Device (COM6)                                                             =>
+InstanceId                  : USB\VID_239A&PID_8029&MI_00\6&39B279E2&0&0000                                        =>
+InstallDate                 :                                                                                      =>
+Status                      : OK                                                                                   =>
+Availability                :                                                                                      =>
+ConfigManagerErrorCode      : CM_PROB_NONE                                                                         =>
+ConfigManagerUserConfig     : False                                                                                =>
+CreationClassName           : Win32_PnPEntity                                                                      =>
+ErrorCleared                :                                                                                      =>
+ErrorDescription            :                                                                                      =>
+LastErrorCode               :                                                                                      =>
+PowerManagementCapabilities :                                                                                      =>
+PowerManagementSupported    :                                                                                      =>
+StatusInfo                  :                                                                                      =>
+SystemCreationClassName     : Win32_ComputerSystem                                                                 =>
+SystemName                  : DESKTOP-FRFQN8H                                                                      =>
+Present                     : True                                                                                 =>
+PSComputerName              :                                                                                      =>
+Problem                     : CM_PROB_NONE                                                                         =>
+ProblemDescription          :                                                                                      =>
+InstallDate                 :                                                                                      =>
+Status                      : OK                                                                                   =>
+Availability                :                                                                                      =>
+ConfigManagerErrorCode      : CM_PROB_NONE                                                                         =>
+ConfigManagerUserConfig     : False                                                                                =>
+CreationClassName           : Win32_PnPEntity                                                                      =>
+ErrorCleared                :                                                                                      =>
+ErrorDescription            :                                                                                      =>
+LastErrorCode               :                                                                                      =>
+PowerManagementCapabilities :                                                                                      =>
+PowerManagementSupported    :                                                                                      =>
+StatusInfo                  :                                                                                      =>
+SystemCreationClassName     : Win32_ComputerSystem                                                                 =>
+SystemName                  : DESKTOP-FRFQN8H                                                                      =>
+Manufacturer                : Microsoft                                                                            =>
+Present                     : True                                                                                 =>
+PSComputerName              :                                                                                      =>
+Problem                     : CM_PROB_NONE                                                                         =>
+ProblemDescription          :                                                                                      =>
+                                                                                                                   =>
+

info/windows/tbeam.txt

@@ -0,0 +1,42 @@
+Run from Windows 10
+
+> Get-PnpDevice -PresentOnly | Format-List >a
+> Get-PnpDevice -PresentOnly | Format-List >b
+> Compare-Object (get-content a) (Get-Content b)
+
+InputObject                                                                                              SideIndicator
+-----------                                                                                              -------------
+Caption                     : USB-Enhanced-SERIAL CH9102 (COM7)                                          =>
+Description                 : USB-Enhanced-SERIAL CH9102                                                 =>
+Name                        : USB-Enhanced-SERIAL CH9102 (COM7)                                          =>
+DeviceID                    : USB\VID_1A86&PID_55D4\5323005057                                           =>
+PNPDeviceID                 : USB\VID_1A86&PID_55D4\5323005057                                           =>
+ClassGuid                   : {4d36e978-e325-11ce-bfc1-08002be10318}                                     =>
+CompatibleID                : {USB\Class_02&SubClass_02&Prot_01, USB\Class_02&SubClass_02, USB\Class_02} =>
+HardwareID                  : {USB\VID_1A86&PID_55D4&REV_0443, USB\VID_1A86&PID_55D4}                    =>
+Manufacturer                : wch.cn                                                                     =>
+PNPClass                    : Ports                                                                      =>
+Service                     : CH343SER_A64                                                               =>
+Class                       : Ports                                                                      =>
+FriendlyName                : USB-Enhanced-SERIAL CH9102 (COM7)                                          =>
+InstanceId                  : USB\VID_1A86&PID_55D4\5323005057                                           =>
+InstallDate                 :                                                                            =>
+Status                      : OK                                                                         =>
+Availability                :                                                                            =>
+ConfigManagerErrorCode      : CM_PROB_NONE                                                               =>
+ConfigManagerUserConfig     : False                                                                      =>
+CreationClassName           : Win32_PnPEntity                                                            =>
+ErrorCleared                :                                                                            =>
+ErrorDescription            :                                                                            =>
+LastErrorCode               :                                                                            =>
+PowerManagementCapabilities :                                                                            =>
+PowerManagementSupported    :                                                                            =>
+StatusInfo                  :                                                                            =>
+SystemCreationClassName     : Win32_ComputerSystem                                                       =>
+SystemName                  : DESKTOP-FRFQN8H                                                            =>
+Present                     : True                                                                       =>
+PSComputerName              :                                                                            =>
+Problem                     : CM_PROB_NONE                                                               =>
+ProblemDescription          :                                                                            =>
+                                                                                                         =>
+

info/windows/techo.txt

@@ -0,0 +1,302 @@
+PS > Get-PnpDevice -PresentOnly | Format-List >a
+PS > Get-PnpDevice -PresentOnly | Format-List >b
+PS > Compare-Object (get-content a) (get-content b)
+
+
+Note: Not in boot mode
+
+InputObject                                                                                                        Side
+                                                                                                                   Indi
+                                                                                                                   cato
+                                                                                                                   r
+-----------                                                                                                        ----
+DeviceID                    : USB\VID_239A&PID_4405\D02012062C578951                                               =>
+PNPDeviceID                 : USB\VID_239A&PID_4405\D02012062C578951                                               =>
+HardwareID                  : {USB\VID_239A&PID_4405&REV_0100, USB\VID_239A&PID_4405}                              =>
+InstanceId                  : USB\VID_239A&PID_4405\D02012062C578951                                               =>
+Caption                     : USB Composite Device                                                                 =>
+Description                 : USB Composite Device                                                                 =>
+Name                        : USB Composite Device                                                                 =>
+ClassGuid                   : {36fc9e60-c465-11cf-8056-444553540000}                                               =>
+CompatibleID                : {USB\DevClass_00&SubClass_00&Prot_00, USB\DevClass_00&SubClass_00, USB\DevClass_00,  =>
+                              USB\COMPOSITE}                                                                       =>
+Manufacturer                : (Standard USB Host Controller)                                                       =>
+PNPClass                    : USB                                                                                  =>
+Service                     : usbccgp                                                                              =>
+Class                       : USB                                                                                  =>
+FriendlyName                : USB Composite Device                                                                 =>
+Caption                     : USB Serial Device (COM10)                                                            =>
+Description                 : USB Serial Device                                                                    =>
+Name                        : USB Serial Device (COM10)                                                            =>
+DeviceID                    : USB\VID_239A&PID_4405&MI_00\6&1B68A3E6&0&0000                                        =>
+PNPDeviceID                 : USB\VID_239A&PID_4405&MI_00\6&1B68A3E6&0&0000                                        =>
+ClassGuid                   : {4d36e978-e325-11ce-bfc1-08002be10318}                                               =>
+CompatibleID                : {USB\Class_02&SubClass_02&Prot_00, USB\Class_02&SubClass_02, USB\Class_02}           =>
+HardwareID                  : {USB\VID_239A&PID_4405&REV_0100&MI_00, USB\VID_239A&PID_4405&MI_00}                  =>
+PNPClass                    : Ports                                                                                =>
+Service                     : usbser                                                                               =>
+Class                       : Ports                                                                                =>
+FriendlyName                : USB Serial Device (COM10)                                                            =>
+InstanceId                  : USB\VID_239A&PID_4405&MI_00\6&1B68A3E6&0&0000                                        =>
+InstallDate                 :                                                                                      =>
+Status                      : OK                                                                                   =>
+Availability                :                                                                                      =>
+ConfigManagerErrorCode      : CM_PROB_NONE                                                                         =>
+ConfigManagerUserConfig     : False                                                                                =>
+CreationClassName           : Win32_PnPEntity                                                                      =>
+ErrorCleared                :                                                                                      =>
+ErrorDescription            :                                                                                      =>
+LastErrorCode               :                                                                                      =>
+PowerManagementCapabilities :                                                                                      =>
+PowerManagementSupported    :                                                                                      =>
+StatusInfo                  :                                                                                      =>
+SystemCreationClassName     : Win32_ComputerSystem                                                                 =>
+SystemName                  : DESKTOP-FRFQN8H                                                                      =>
+Present                     : True                                                                                 =>
+PSComputerName              :                                                                                      =>
+Problem                     : CM_PROB_NONE                                                                         =>
+ProblemDescription          :                                                                                      =>
+InstallDate                 :                                                                                      =>
+Status                      : OK                                                                                   =>
+Availability                :                                                                                      =>
+ConfigManagerErrorCode      : CM_PROB_NONE                                                                         =>
+ConfigManagerUserConfig     : False                                                                                =>
+CreationClassName           : Win32_PnPEntity                                                                      =>
+ErrorCleared                :                                                                                      =>
+ErrorDescription            :                                                                                      =>
+LastErrorCode               :                                                                                      =>
+PowerManagementCapabilities :                                                                                      =>
+PowerManagementSupported    :                                                                                      =>
+StatusInfo                  :                                                                                      =>
+SystemCreationClassName     : Win32_ComputerSystem                                                                 =>
+SystemName                  : DESKTOP-FRFQN8H                                                                      =>
+Manufacturer                : Microsoft                                                                            =>
+Present                     : True                                                                                 =>
+PSComputerName              :                                                                                      =>
+Problem                     : CM_PROB_NONE                                                                         =>
+ProblemDescription          :                                                                                      =>
+                                                                                                                   =>
+
+in boot mode
+
+PS > Get-PnpDevice -PresentOnly | Format-List >c
+PS > Compare-Object (get-content a) (get-content c)
+
+InputObject
+-----------
+Caption                     : Adafruit nRF UF2 USB Device
+Name                        : Adafruit nRF UF2 USB Device
+DeviceID                    : USBSTOR\DISK&VEN_ADAFRUIT&PROD_NRF_UF2&REV_1.0\7&10304CB2&0&D02012062C578951&0
+PNPDeviceID                 : USBSTOR\DISK&VEN_ADAFRUIT&PROD_NRF_UF2&REV_1.0\7&10304CB2&0&D02012062C578951&0
+CompatibleID                : {USBSTOR\Disk, USBSTOR\RAW, GenDisk}
+HardwareID                  : {USBSTOR\DiskAdafruitnRF_UF2_________1.0_, USBSTOR\DiskAdafruitnRF_UF2_________,
+                              USBSTOR\DiskAdafruit, USBSTOR\AdafruitnRF_UF2_________1...}
+FriendlyName                : Adafruit nRF UF2 USB Device
+InstanceId                  : USBSTOR\DISK&VEN_ADAFRUIT&PROD_NRF_UF2&REV_1.0\7&10304CB2&0&D02012062C578951&0
+Caption                     : USB Mass Storage Device
+Description                 : USB Mass Storage Device
+Name                        : USB Mass Storage Device
+DeviceID                    : USB\VID_239A&PID_0029&MI_02\6&2AE8D65&0&0002
+PNPDeviceID                 : USB\VID_239A&PID_0029&MI_02\6&2AE8D65&0&0002
+CompatibleID                : {USB\Class_08&SubClass_06&Prot_50, USB\Class_08&SubClass_06, USB\Class_08}
+HardwareID                  : {USB\VID_239A&PID_0029&REV_0100&MI_02, USB\VID_239A&PID_0029&MI_02}
+Manufacturer                : Compatible USB storage device
+Service                     : USBSTOR
+FriendlyName                : USB Mass Storage Device
+InstanceId                  : USB\VID_239A&PID_0029&MI_02\6&2AE8D65&0&0002
+Caption                     : USB Serial Device (COM11)
+Description                 : USB Serial Device
+Name                        : USB Serial Device (COM11)
+DeviceID                    : USB\VID_239A&PID_0029&MI_00\6&2AE8D65&0&0000
+PNPDeviceID                 : USB\VID_239A&PID_0029&MI_00\6&2AE8D65&0&0000
+ClassGuid                   : {4d36e978-e325-11ce-bfc1-08002be10318}
+CompatibleID                : {USB\Class_02&SubClass_02&Prot_00, USB\Class_02&SubClass_02, USB\Class_02}
+HardwareID                  : {USB\VID_239A&PID_0029&REV_0100&MI_00, USB\VID_239A&PID_0029&MI_00}
+PNPClass                    : Ports
+Service                     : usbser
+Class                       : Ports
+FriendlyName                : USB Serial Device (COM11)
+InstanceId                  : USB\VID_239A&PID_0029&MI_00\6&2AE8D65&0&0000
+ClassGuid                   : {36fc9e60-c465-11cf-8056-444553540000}
+PNPClass                    : USB
+Class                       : USB
+Caption                     : USB Composite Device
+Description                 : USB Composite Device
+Name                        : USB Composite Device
+DeviceID                    : USB\VID_239A&PID_0029\D02012062C578951
+PNPDeviceID                 : USB\VID_239A&PID_0029\D02012062C578951
+ClassGuid                   : {36fc9e60-c465-11cf-8056-444553540000}
+CompatibleID                : {USB\DevClass_00&SubClass_00&Prot_00, USB\DevClass_00&SubClass_00, USB\DevClass_00,
+                              USB\COMPOSITE}
+HardwareID                  : {USB\VID_239A&PID_0029&REV_0100, USB\VID_239A&PID_0029}
+Manufacturer                : (Standard USB Host Controller)
+PNPClass                    : USB
+Service                     : usbccgp
+Class                       : USB
+FriendlyName                : USB Composite Device
+InstanceId                  : USB\VID_239A&PID_0029\D02012062C578951
+DeviceID                    : STORAGE\VOLUME\_??_USBSTOR#DISK&VEN_ADAFRUIT&PROD_NRF_UF2&REV_1.0#7&10304CB2&0&D02012062C
+                              578951&0#{53F56307-B6BF-11D0-94F2-00A0C91EFB8B}
+PNPDeviceID                 : STORAGE\VOLUME\_??_USBSTOR#DISK&VEN_ADAFRUIT&PROD_NRF_UF2&REV_1.0#7&10304CB2&0&D02012062C
+                              578951&0#{53F56307-B6BF-11D0-94F2-00A0C91EFB8B}
+InstanceId                  : STORAGE\VOLUME\_??_USBSTOR#DISK&VEN_ADAFRUIT&PROD_NRF_UF2&REV_1.0#7&10304CB2&0&D02012062C
+                              578951&0#{53F56307-B6BF-11D0-94F2-00A0C91EFB8B}
+Caption                     : Volume
+Description                 : Volume
+Name                        : Volume
+ClassGuid                   : {71a27cdd-812a-11d0-bec7-08002be2092f}
+HardwareID                  : {STORAGE\Volume}
+PNPClass                    : Volume
+Service                     : volume
+Class                       : Volume
+FriendlyName                : Volume
+Description                 : Disk drive
+ClassGuid                   : {4d36e967-e325-11ce-bfc1-08002be10318}
+Manufacturer                : (Standard disk drives)
+PNPClass                    : DiskDrive
+Service                     : disk
+Class                       : DiskDrive
+Caption                     : TECHOBOOT
+Description                 : nRF UF2
+Name                        : TECHOBOOT
+DeviceID                    : SWD\WPDBUSENUM\_??_USBSTOR#DISK&VEN_ADAFRUIT&PROD_NRF_UF2&REV_1.0#7&10304CB2&0&D02012062C
+                              578951&0#{53F56307-B6BF-11D0-94F2-00A0C91EFB8B}
+PNPDeviceID                 : SWD\WPDBUSENUM\_??_USBSTOR#DISK&VEN_ADAFRUIT&PROD_NRF_UF2&REV_1.0#7&10304CB2&0&D02012062C
+                              578951&0#{53F56307-B6BF-11D0-94F2-00A0C91EFB8B}
+ClassGuid                   : {eec5ad98-8080-425f-922a-dabf3de3f69a}
+CompatibleID                : {wpdbusenum\fs, SWD\Generic}
+HardwareID                  :
+Manufacturer                : Adafruit
+PNPClass                    : WPD
+Service                     : WUDFWpdFs
+Class                       : WPD
+FriendlyName                : TECHOBOOT
+InstanceId                  : SWD\WPDBUSENUM\_??_USBSTOR#DISK&VEN_ADAFRUIT&PROD_NRF_UF2&REV_1.0#7&10304CB2&0&D02012062C
+                              578951&0#{53F56307-B6BF-11D0-94F2-00A0C91EFB8B}
+CompatibleID                :
+InstallDate                 :
+Status                      : OK
+Availability                :
+ConfigManagerErrorCode      : CM_PROB_NONE
+ConfigManagerUserConfig     : False
+CreationClassName           : Win32_PnPEntity
+ErrorCleared                :
+ErrorDescription            :
+LastErrorCode               :
+PowerManagementCapabilities :
+PowerManagementSupported    :
+StatusInfo                  :
+SystemCreationClassName     : Win32_ComputerSystem
+SystemName                  : DESKTOP-FRFQN8H
+Present                     : True
+PSComputerName              :
+Problem                     : CM_PROB_NONE
+ProblemDescription          :
+InstallDate                 :
+Status                      : OK
+Availability                :
+ConfigManagerErrorCode      : CM_PROB_NONE
+ConfigManagerUserConfig     : False
+CreationClassName           : Win32_PnPEntity
+ErrorCleared                :
+ErrorDescription            :
+LastErrorCode               :
+PowerManagementCapabilities :
+PowerManagementSupported    :
+StatusInfo                  :
+SystemCreationClassName     : Win32_ComputerSystem
+SystemName                  : DESKTOP-FRFQN8H
+Present                     : True
+PSComputerName              :
+Problem                     : CM_PROB_NONE
+ProblemDescription          :
+InstallDate                 :
+Status                      : OK
+Availability                :
+ConfigManagerErrorCode      : CM_PROB_NONE
+ConfigManagerUserConfig     : False
+CreationClassName           : Win32_PnPEntity
+ErrorCleared                :
+ErrorDescription            :
+LastErrorCode               :
+PowerManagementCapabilities :
+PowerManagementSupported    :
+StatusInfo                  :
+SystemCreationClassName     : Win32_ComputerSystem
+SystemName                  : DESKTOP-FRFQN8H
+Present                     : True
+PSComputerName              :
+Problem                     : CM_PROB_NONE
+ProblemDescription          :
+
+InstallDate                 :
+Status                      : OK
+Availability                :
+ConfigManagerErrorCode      : CM_PROB_NONE
+ConfigManagerUserConfig     : False
+CreationClassName           : Win32_PnPEntity
+ErrorCleared                :
+ErrorDescription            :
+LastErrorCode               :
+PowerManagementCapabilities :
+PowerManagementSupported    :
+StatusInfo                  :
+SystemCreationClassName     : Win32_ComputerSystem
+SystemName                  : DESKTOP-FRFQN8H
+Manufacturer                : Microsoft
+Present                     : True
+PSComputerName              :
+Problem                     : CM_PROB_NONE
+ProblemDescription          :
+
+InstallDate                 :
+Status                      : OK
+Availability                :
+ConfigManagerErrorCode      : CM_PROB_NONE
+ConfigManagerUserConfig     : False
+CreationClassName           : Win32_PnPEntity
+ErrorCleared                :
+ErrorDescription            :
+LastErrorCode               :
+PowerManagementCapabilities :
+PowerManagementSupported    :
+StatusInfo                  :
+SystemCreationClassName     : Win32_ComputerSystem
+SystemName                  : DESKTOP-FRFQN8H
+Present                     : True
+PSComputerName              :
+Problem                     : CM_PROB_NONE
+ProblemDescription          :
+
+InstallDate                 :
+Status                      : OK
+Availability                :
+ConfigManagerErrorCode      : CM_PROB_NONE
+ConfigManagerUserConfig     : False
+CreationClassName           : Win32_PnPEntity
+ErrorCleared                :
+ErrorDescription            :
+LastErrorCode               :
+PowerManagementCapabilities :
+PowerManagementSupported    :
+StatusInfo                  :
+SystemCreationClassName     : Win32_ComputerSystem
+SystemName                  : DESKTOP-FRFQN8H
+Manufacturer                : Microsoft
+Present                     : True
+PSComputerName              :
+Problem                     : CM_PROB_NONE
+ProblemDescription          :
+
+
+
+
+
+PS > Get-Volume
+
+DriveLetter FriendlyName FileSystemType DriveType HealthStatus OperationalStatus SizeRemaining     Size
+----------- ------------ -------------- --------- ------------ ----------------- -------------     ----
+            Recovery     NTFS           Fixed     Healthy      OK                    301.99 MB   854 MB
+C                        NTFS           Fixed     Healthy      OK                      22.3 GB 56.67 GB
+D           TECHOBOOT    FAT            Removable Healthy      OK                     30.05 MB 31.88 MB
+

info/windows/tlora.txt

@@ -0,0 +1,41 @@
+Run from Windows 10
+
+PS > Get-PnpDevice -PresentOnly | Format-List > a
+PS > Get-PnpDevice -PresentOnly | Format-List > b
+PS > Compare-Object (get-content a) (Get-Content b)
+
+InputObject                                                                                              SideIndicator
+-----------                                                                                              -------------
+Caption                     : USB-Enhanced-SERIAL CH9102 (COM3)                                          <=
+Description                 : USB-Enhanced-SERIAL CH9102                                                 <=
+Name                        : USB-Enhanced-SERIAL CH9102 (COM3)                                          <=
+DeviceID                    : USB\VID_1A86&PID_55D4\5&27435A1F&0&1                                       <=
+PNPDeviceID                 : USB\VID_1A86&PID_55D4\5&27435A1F&0&1                                       <=
+ClassGuid                   : {4d36e978-e325-11ce-bfc1-08002be10318}                                     <=
+CompatibleID                : {USB\Class_02&SubClass_02&Prot_01, USB\Class_02&SubClass_02, USB\Class_02} <=
+HardwareID                  : {USB\VID_1A86&PID_55D4&REV_0443, USB\VID_1A86&PID_55D4}                    <=
+Manufacturer                : wch.cn                                                                     <=
+PNPClass                    : Ports                                                                      <=
+Service                     : CH343SER_A64                                                               <=
+Class                       : Ports                                                                      <=
+FriendlyName                : USB-Enhanced-SERIAL CH9102 (COM3)                                          <=
+InstanceId                  : USB\VID_1A86&PID_55D4\5&27435A1F&0&1                                       <=
+InstallDate                 :                                                                            <=
+Status                      : OK                                                                         <=
+Availability                :                                                                            <=
+ConfigManagerErrorCode      : CM_PROB_NONE                                                               <=
+ConfigManagerUserConfig     : False                                                                      <=
+CreationClassName           : Win32_PnPEntity                                                            <=
+ErrorCleared                :                                                                            <=
+ErrorDescription            :                                                                            <=
+LastErrorCode               :                                                                            <=
+PowerManagementCapabilities :                                                                            <=
+PowerManagementSupported    :                                                                            <=
+StatusInfo                  :                                                                            <=
+SystemCreationClassName     : Win32_ComputerSystem                                                       <=
+SystemName                  : DESKTOP-FRFQN8H                                                            <=
+Present                     : True                                                                       <=
+PSComputerName              :                                                                            <=
+Problem                     : CM_PROB_NONE                                                               <=
+ProblemDescription          :                                                                            <=
+                                                                                                         <=

info/windows/tlora_v1.txt

@@ -0,0 +1,71 @@
+InputObject                                                                                              SideIn
+                                                                                                         dicato
+                                                                                                         r     
+-----------                                                                                              ------
+Caption                     : Silicon Labs CP210x USB to UART Bridge (COM5)                              =>    
+Description                 : Silicon Labs CP210x USB to UART Bridge                                     =>    
+Name                        : Silicon Labs CP210x USB to UART Bridge (COM5)                              =>    
+DeviceID                    : USB\VID_10C4&PID_EA60\0001                                                 =>    
+PNPDeviceID                 : USB\VID_10C4&PID_EA60\0001                                                 =>    
+HardwareID                  : {USB\VID_10C4&PID_EA60&REV_0100, USB\VID_10C4&PID_EA60}                    =>    
+Manufacturer                : Silicon Laboratories                                                       =>    
+Service                     : silabser                                                                   =>    
+FriendlyName                : Silicon Labs CP210x USB to UART Bridge (COM5)                              =>    
+InstanceId                  : USB\VID_10C4&PID_EA60\0001                                                 =>    
+CompatibleID                : {USB\Class_ff&SubClass_00&Prot_00, USB\Class_ff&SubClass_00, USB\Class_ff} =>    
+ClassGuid                   : {4d36e978-e325-11ce-bfc1-08002be10318}                                     =>    
+PNPClass                    : Ports                                                                      =>    
+Class                       : Ports                                                                      =>    
+InstallDate                 :                                                                            =>    
+Status                      : OK                                                                         =>    
+Availability                :                                                                            =>    
+ConfigManagerErrorCode      : CM_PROB_NONE                                                               =>    
+ConfigManagerUserConfig     : False                                                                      =>    
+CreationClassName           : Win32_PnPEntity                                                            =>    
+ErrorCleared                :                                                                            =>    
+ErrorDescription            :                                                                            =>    
+LastErrorCode               :                                                                            =>    
+PowerManagementCapabilities :                                                                            =>    
+PowerManagementSupported    :                                                                            =>    
+StatusInfo                  :                                                                            =>    
+SystemCreationClassName     : Win32_ComputerSystem                                                       =>    
+SystemName                  : MTI-ATPLT1                                                                 =>    
+Present                     : True                                                                       =>    
+PSComputerName              :                                                                            =>    
+Problem                     : CM_PROB_NONE                                                               =>    
+ProblemDescription          :                                                                            =>    
+Caption                     : Microsoft Serial Mouse                                                     =>    
+Description                 : Microsoft Serial Mouse                                                     =>    
+InstallDate                 :                                                                            =>    
+Name                        : Microsoft Serial Mouse                                                     =>    
+Status                      : Error                                                                      =>    
+Availability                :                                                                            =>    
+ConfigManagerErrorCode      : CM_PROB_FAILED_START                                                       =>    
+ConfigManagerUserConfig     : False                                                                      =>    
+CreationClassName           : Win32_PnPEntity                                                            =>    
+DeviceID                    : SILABENM\MOUSE\C&1EBF522&0&0000                                            =>    
+ErrorCleared                :                                                                            =>    
+ErrorDescription            :                                                                            =>    
+LastErrorCode               :                                                                            =>    
+PNPDeviceID                 : SILABENM\MOUSE\C&1EBF522&0&0000                                            =>    
+PowerManagementCapabilities :                                                                            =>    
+PowerManagementSupported    :                                                                            =>    
+StatusInfo                  :                                                                            =>    
+SystemCreationClassName     : Win32_ComputerSystem                                                       =>    
+SystemName                  : MTI-ATPLT1                                                                 =>    
+ClassGuid                   : {4d36e96f-e325-11ce-bfc1-08002be10318}                                     =>    
+CompatibleID                : {SERIAL_MOUSE}                                                             =>    
+HardwareID                  : {*PNP0F01}                                                                 =>    
+Manufacturer                : Microsoft                                                                  =>    
+PNPClass                    : Mouse                                                                      =>    
+Present                     : True                                                                       =>    
+Service                     : sermouse                                                                   =>    
+PSComputerName              :                                                                            =>    
+Class                       : Mouse                                                                      =>    
+FriendlyName                : Microsoft Serial Mouse                                                     =>    
+InstanceId                  : SILABENM\MOUSE\C&1EBF522&0&0000                                            =>    
+Problem                     : CM_PROB_FAILED_START                                                       =>    
+ProblemDescription          :                                                                            =>    
+                                                                                                         =>    
+                                                                                                         =>    
+

meshtastic/__init__.py

@@ -72,14 +72,16 @@ from typing import *
 import serial
 import timeago
 import google.protobuf.json_format
-import pygatt
 from pubsub import pub
 from dotmap import DotMap
 from tabulate import tabulate
 from google.protobuf.json_format import MessageToJson
-from .util import fixme, catchAndIgnore, stripnl, DeferredExecution, Timeout
-from .node import Node
-from . import mesh_pb2, portnums_pb2, apponly_pb2, admin_pb2, environmental_measurement_pb2, remote_hardware_pb2, channel_pb2, radioconfig_pb2, util
+from meshtastic.util import fixme, catchAndIgnore, stripnl, DeferredExecution, Timeout
+from meshtastic.node import Node
+from meshtastic import (mesh_pb2, portnums_pb2, apponly_pb2, admin_pb2,
+                        telemetry_pb2, remote_hardware_pb2,
+                        channel_pb2, radioconfig_pb2, util)
+
 
 # Note: To follow PEP224, comments should be after the module variable.
 
@@ -92,7 +94,7 @@ BROADCAST_NUM = 0xffffffff
 BROADCAST_ADDR = "^all"
 """A special ID that means broadcast"""
 
-OUR_APP_VERSION = 20200
+OUR_APP_VERSION = 20300
 """The numeric buildnumber (shared with android apps) specifying the
    level of device code we are guaranteed to understand
 
@@ -127,6 +129,7 @@ def _onTextReceive(iface, asDict):
     #
     # Usually btw this problem is caused by apps sending binary data but setting the payload type to
     # text.
+    logging.debug(f'in _onTextReceive() asDict:{asDict}')
     try:
         asBytes = asDict["decoded"]["payload"]
         asDict["decoded"]["text"] = asBytes.decode("utf-8")
@@ -137,22 +140,30 @@ def _onTextReceive(iface, asDict):
 
 def _onPositionReceive(iface, asDict):
     """Special auto parsing for received messages"""
-    p = asDict["decoded"]["position"]
-    iface._fixupPosition(p)
-    # update node DB as needed
-    iface._getOrCreateByNum(asDict["from"])["position"] = p
+    logging.debug(f'in _onPositionReceive() asDict:{asDict}')
+    if 'decoded' in asDict:
+        if 'position' in asDict['decoded'] and 'from' in asDict:
+            p = asDict["decoded"]["position"]
+            logging.debug(f'p:{p}')
+            p = iface._fixupPosition(p)
+            logging.debug(f'after fixup p:{p}')
+            # update node DB as needed
+            iface._getOrCreateByNum(asDict["from"])["position"] = p
 
 
 def _onNodeInfoReceive(iface, asDict):
     """Special auto parsing for received messages"""
-    p = asDict["decoded"]["user"]
-    # decode user protobufs and update nodedb, provide decoded version as "position" in the published msg
-    # update node DB as needed
-    n = iface._getOrCreateByNum(asDict["from"])
-    n["user"] = p
-    # We now have a node ID, make sure it is uptodate in that table
-    iface.nodes[p["id"]] = n
-    _receiveInfoUpdate(iface, asDict)
+    logging.debug(f'in _onNodeInfoReceive() asDict:{asDict}')
+    if 'decoded' in asDict:
+        if 'user' in asDict['decoded'] and 'from' in asDict:
+            p = asDict["decoded"]["user"]
+            # decode user protobufs and update nodedb, provide decoded version as "position" in the published msg
+            # update node DB as needed
+            n = iface._getOrCreateByNum(asDict["from"])
+            n["user"] = p
+            # We now have a node ID, make sure it is uptodate in that table
+            iface.nodes[p["id"]] = n
+            _receiveInfoUpdate(iface, asDict)
 
 
 def _receiveInfoUpdate(iface, asDict):
@@ -170,7 +181,6 @@ protocols = {
     portnums_pb2.PortNum.NODEINFO_APP: KnownProtocol("user", mesh_pb2.User, _onNodeInfoReceive),
     portnums_pb2.PortNum.ADMIN_APP: KnownProtocol("admin", admin_pb2.AdminMessage),
     portnums_pb2.PortNum.ROUTING_APP: KnownProtocol("routing", mesh_pb2.Routing),
-    portnums_pb2.PortNum.ENVIRONMENTAL_MEASUREMENT_APP: KnownProtocol("environmental", environmental_measurement_pb2.EnvironmentalMeasurement),
-    portnums_pb2.PortNum.REMOTE_HARDWARE_APP: KnownProtocol(
-        "remotehw", remote_hardware_pb2.HardwareMessage)
+    portnums_pb2.PortNum.TELEMETRY_APP: KnownProtocol("telemetry", telemetry_pb2.Telemetry),
+    portnums_pb2.PortNum.REMOTE_HARDWARE_APP: KnownProtocol("remotehw", remote_hardware_pb2.HardwareMessage)
 }

meshtastic/__main__.py

@@ -5,6 +5,7 @@
 import argparse
 import platform
 import logging
+import os
 import sys
 import time
 import yaml
@@ -13,13 +14,11 @@ import pyqrcode
 import pkg_resources
 import meshtastic.util
 import meshtastic.test
-from . import remote_hardware
-from . import portnums_pb2, channel_pb2, radioconfig_pb2
-from .globals import Globals
-
-
-have_tunnel = platform.system() == 'Linux'
-"""We only import the tunnel code if we are on a platform that can run it. """
+from meshtastic import remote_hardware
+from meshtastic.ble_interface import BLEInterface
+from meshtastic import portnums_pb2, channel_pb2, radioconfig_pb2
+from meshtastic.globals import Globals
+from meshtastic.__init__ import BROADCAST_ADDR
 
 def onReceive(packet, interface):
     """Callback invoked when a packet arrives"""
@@ -40,15 +39,15 @@ def onReceive(packet, interface):
                 rxSnr = packet['rxSnr']
                 hopLimit = packet['hopLimit']
                 print(f"message: {msg}")
-                reply = "got msg \'{}\' with rxSnr: {} and hopLimit: {}".format(msg, rxSnr, hopLimit)
+                reply = f"got msg \'{msg}\' with rxSnr: {rxSnr} and hopLimit: {hopLimit}"
                 print("Sending reply: ", reply)
                 interface.sendText(reply)
 
     except Exception as ex:
-        print(ex)
+        print(f'Warning: There is no field {ex} in the packet.')
 
 
-def onConnection(interface, topic=pub.AUTO_TOPIC):
+def onConnection(interface, topic=pub.AUTO_TOPIC): # pylint: disable=W0613
     """Callback invoked when we connect/disconnect from a radio"""
     print(f"Connection changed: {topic.getName()}")
 
@@ -56,48 +55,73 @@ def onConnection(interface, topic=pub.AUTO_TOPIC):
 def getPref(attributes, name):
     """Get a channel or preferences value"""
 
+    camel_name = meshtastic.util.snake_to_camel(name)
+    # Note: protobufs has the keys in snake_case, so snake internally
+    snake_name = meshtastic.util.camel_to_snake(name)
+    logging.debug(f'snake_name:{snake_name} camel_name:{camel_name}')
+    logging.debug(f'use camel:{Globals.getInstance().get_camel_case()}')
+
     objDesc = attributes.DESCRIPTOR
-    field = objDesc.fields_by_name.get(name)
+    field = objDesc.fields_by_name.get(snake_name)
     if not field:
-        print(f"{attributes.__class__.__name__} does not have an attribute called {name}, so you can not get it.")
+        if Globals.getInstance().get_camel_case():
+            print(f"{attributes.__class__.__name__} does not have an attribute called {camel_name}, so you can not get it.")
+        else:
+            print(f"{attributes.__class__.__name__} does not have an attribute called {snake_name}, so you can not get it.")
         print(f"Choices in sorted order are:")
         names = []
         for f in objDesc.fields:
-            names.append(f'{f.name}')
+            tmp_name = f'{f.name}'
+            if Globals.getInstance().get_camel_case():
+                tmp_name = meshtastic.util.snake_to_camel(tmp_name)
+            names.append(tmp_name)
         for temp_name in sorted(names):
             print(f"    {temp_name}")
         return
 
-    # okay - try to read the value
-    try:
-        try:
-            val = getattr(attributes, name)
-        except TypeError:
-            # The getter didn't like our arg type guess try again as a string
-            val = getattr(attributes, name)
+    # read the value
+    val = getattr(attributes, snake_name)
 
-        # succeeded!
-        print(f"{name}: {str(val)}")
-    except Exception as ex:
-        print(f"Can't get {name} due to {ex}")
+    if Globals.getInstance().get_camel_case():
+        print(f"{camel_name}: {str(val)}")
+        logging.debug(f"{camel_name}: {str(val)}")
+    else:
+        print(f"{snake_name}: {str(val)}")
+        logging.debug(f"{snake_name}: {str(val)}")
 
 
 def setPref(attributes, name, valStr):
     """Set a channel or preferences value"""
 
+    snake_name = meshtastic.util.camel_to_snake(name)
+    camel_name = meshtastic.util.snake_to_camel(name)
+    logging.debug(f'snake_name:{snake_name}')
+    logging.debug(f'camel_name:{camel_name}')
+
     objDesc = attributes.DESCRIPTOR
-    field = objDesc.fields_by_name.get(name)
+    field = objDesc.fields_by_name.get(snake_name)
     if not field:
-        print(f"{attributes.__class__.__name__} does not have an attribute called {name}, so you can not set it.")
+        if Globals.getInstance().get_camel_case():
+            print(f"{attributes.__class__.__name__} does not have an attribute called {camel_name}, so you can not set it.")
+        else:
+            print(f"{attributes.__class__.__name__} does not have an attribute called {snake_name}, so you can not set it.")
         print(f"Choices in sorted order are:")
         names = []
         for f in objDesc.fields:
-            names.append(f'{f.name}')
+            tmp_name = f'{f.name}'
+            if Globals.getInstance().get_camel_case():
+                tmp_name = meshtastic.util.snake_to_camel(tmp_name)
+            names.append(tmp_name)
         for temp_name in sorted(names):
             print(f"    {temp_name}")
         return
 
     val = meshtastic.util.fromStr(valStr)
+    logging.debug(f'valStr:{valStr} val:{val}')
+
+    if snake_name == 'wifi_password' and len(valStr) < 8:
+        print(f"Warning: wifi_password must be 8 or more characters.")
+        return
 
     enumType = field.enum_type
     # pylint: disable=C0123
@@ -107,27 +131,39 @@ def setPref(attributes, name, valStr):
         if e:
             val = e.number
         else:
-            print(f"{name} does not have an enum called {val}, so you can not set it.")
+            if Globals.getInstance().get_camel_case():
+                print(f"{camel_name} does not have an enum called {val}, so you can not set it.")
+            else:
+                print(f"{snake_name} does not have an enum called {val}, so you can not set it.")
             print(f"Choices in sorted order are:")
             names = []
             for f in enumType.values:
+                # Note: We must use the value of the enum (regardless if camel or snake case)
                 names.append(f'{f.name}')
             for temp_name in sorted(names):
                 print(f"    {temp_name}")
             return
 
-    # okay - try to read the value
-    try:
+    # note: 'ignore_incoming' is a repeating field
+    if snake_name != 'ignore_incoming':
         try:
-            setattr(attributes, name, val)
+            setattr(attributes, snake_name, val)
         except TypeError:
             # The setter didn't like our arg type guess try again as a string
-            setattr(attributes, name, valStr)
+            setattr(attributes, snake_name, valStr)
+    else:
+        if val == 0:
+            # clear values
+            print("Clearing ignore_incoming list")
+            del attributes.ignore_incoming[:]
+        else:
+            print(f"Adding '{val}' to the ignore_incoming list")
+            attributes.ignore_incoming.extend([val])
 
-        # succeeded!
-        print(f"Set {name} to {valStr}")
-    except Exception as ex:
-        print(f"Can't set {name} due to {ex}")
+    if Globals.getInstance().get_camel_case():
+        print(f"Set {camel_name} to {valStr}")
+    else:
+        print(f"Set {snake_name} to {valStr}")
 
 
 def onConnected(interface):
@@ -137,15 +173,9 @@ def onConnected(interface):
         our_globals = Globals.getInstance()
         args = our_globals.get_args()
 
-        print("Connected to radio")
-
-        def getNode():
-            """This operation could be expensive, so we try to cache the results"""
-            targetNode = our_globals.get_target_node()
-            if not targetNode:
-                targetNode = interface.getNode(args.destOrLocal)
-                our_globals.set_target_node(targetNode)
-            return targetNode
+        # do not print this line if we are exporting the config
+        if not args.export_config:
+            print("Connected to radio")
 
         if args.setlat or args.setlon or args.setalt:
             closeNow = True
@@ -178,12 +208,23 @@ def onConnected(interface):
         if args.set_owner:
             closeNow = True
             print(f"Setting device owner to {args.set_owner}")
-            getNode().setOwner(args.set_owner)
+            interface.getNode(args.dest).setOwner(args.set_owner)
+
+        if args.set_owner_short:
+            closeNow = True
+            print(f"Setting device owner short to {args.set_owner_short}")
+            interface.getNode(args.dest).setOwner(long_name=None, short_name=args.set_owner_short)
+
+        # TODO: add to export-config and configure
+        if args.set_canned_message:
+            closeNow = True
+            print(f"Setting canned plugin message to {args.set_canned_message}")
+            interface.getNode(args.dest).set_canned_message(args.set_canned_message)
 
         if args.pos_fields:
             # If --pos-fields invoked with args, set position fields
             closeNow = True
-            prefs = getNode().radioConfig.preferences
+            prefs = interface.getNode(args.dest).radioConfig.preferences
             allFields = 0
 
             try:
@@ -198,14 +239,14 @@ def onConnected(interface):
 
             else:
                 print(f"Setting position fields to {allFields}")
-                setPref(prefs, 'position_flags', ('%d' % allFields))
+                setPref(prefs, 'position_flags', f'{allFields:d}')
                 print("Writing modified preferences to device")
-                getNode().writeConfig()
+                interface.getNode(args.dest).writeConfig()
 
         elif args.pos_fields is not None:
             # If --pos-fields invoked without args, read and display current value
             closeNow = True
-            prefs = getNode().radioConfig.preferences
+            prefs = interface.getNode(args.dest).radioConfig.preferences
 
             fieldNames = []
             for bit in radioconfig_pb2.PositionFlags.values():
@@ -224,81 +265,88 @@ def onConnected(interface):
                 print(sorted(meshtastic.mesh_pb2.Team.keys()))
             else:
                 print(f"Setting team to {meshtastic.mesh_pb2.Team.Name(v_team)}")
-                getNode().setOwner(team=v_team)
+                interface.getNode(args.dest).setOwner(team=v_team)
 
         if args.set_ham:
             closeNow = True
             print(f"Setting Ham ID to {args.set_ham} and turning off encryption")
-            getNode().setOwner(args.set_ham, is_licensed=True)
+            interface.getNode(args.dest).setOwner(args.set_ham, is_licensed=True)
             # Must turn off encryption on primary channel
-            getNode().turnOffEncryptionOnPrimaryChannel()
+            interface.getNode(args.dest).turnOffEncryptionOnPrimaryChannel()
 
         if args.reboot:
             closeNow = True
-            getNode().reboot()
+            interface.getNode(args.dest).reboot()
+
+        if args.shutdown:
+            closeNow = True
+            interface.getNode(args.dest).shutdown()
 
         if args.sendtext:
             closeNow = True
             channelIndex = 0
             if args.ch_index is not None:
                 channelIndex = int(args.ch_index)
-            ch = getNode().getChannelByChannelIndex(channelIndex)
+            ch = interface.localNode.getChannelByChannelIndex(channelIndex)
+            logging.debug(f'ch:{ch}')
             if ch and ch.role != channel_pb2.Channel.Role.DISABLED:
-                print(f"Sending text message {args.sendtext} to {args.destOrAll} on channelIndex:{channelIndex}")
-                interface.sendText(args.sendtext, args.destOrAll, wantAck=True, channelIndex=channelIndex)
+                print(f"Sending text message {args.sendtext} to {args.dest} on channelIndex:{channelIndex}")
+                interface.sendText(args.sendtext, args.dest, wantAck=True, channelIndex=channelIndex)
             else:
                 meshtastic.util.our_exit(f"Warning: {channelIndex} is not a valid channel. Channel must not be DISABLED.")
 
         if args.sendping:
             payload = str.encode("test string")
-            print(f"Sending ping message to {args.destOrAll}")
-            interface.sendData(payload, args.destOrAll, portNum=portnums_pb2.PortNum.REPLY_APP,
+            print(f"Sending ping message to {args.dest}")
+            interface.sendData(payload, args.dest, portNum=portnums_pb2.PortNum.REPLY_APP,
                                wantAck=True, wantResponse=True)
 
         if args.gpio_wrb or args.gpio_rd or args.gpio_watch:
-            rhc = remote_hardware.RemoteHardwareClient(interface)
+            if args.dest == BROADCAST_ADDR:
+                meshtastic.util.our_exit("Warning: Must use a destination node ID.")
+            else:
+                rhc = remote_hardware.RemoteHardwareClient(interface)
 
-            if args.gpio_wrb:
-                bitmask = 0
-                bitval = 0
-                for wrpair in (args.gpio_wrb or []):
-                    bitmask |= 1 << int(wrpair[0])
-                    bitval |= int(wrpair[1]) << int(wrpair[0])
-                print(f"Writing GPIO mask 0x{bitmask:x} with value 0x{bitval:x} to {args.dest}")
-                rhc.writeGPIOs(args.dest, bitmask, bitval)
-                closeNow = True
+                if args.gpio_wrb:
+                    bitmask = 0
+                    bitval = 0
+                    for wrpair in (args.gpio_wrb or []):
+                        bitmask |= 1 << int(wrpair[0])
+                        bitval |= int(wrpair[1]) << int(wrpair[0])
+                    print(f"Writing GPIO mask 0x{bitmask:x} with value 0x{bitval:x} to {args.dest}")
+                    rhc.writeGPIOs(args.dest, bitmask, bitval)
+                    closeNow = True
 
-            if args.gpio_rd:
-                bitmask = int(args.gpio_rd, 16)
-                print(f"Reading GPIO mask 0x{bitmask:x} from {args.dest}")
-                interface.mask = bitmask
-                rhc.readGPIOs(args.dest, bitmask, None)
-                if not interface.noProto:
+                if args.gpio_rd:
+                    bitmask = int(args.gpio_rd, 16)
+                    print(f"Reading GPIO mask 0x{bitmask:x} from {args.dest}")
+                    interface.mask = bitmask
+                    rhc.readGPIOs(args.dest, bitmask, None)
                     # wait up to X seconds for a response
                     for _ in range(10):
                         time.sleep(1)
                         if interface.gotResponse:
                             break
-                logging.debug(f'end of gpio_rd')
+                    logging.debug(f'end of gpio_rd')
 
-            if args.gpio_watch:
-                bitmask = int(args.gpio_watch, 16)
-                print(f"Watching GPIO mask 0x{bitmask:x} from {args.dest}. Press ctrl-c to exit")
-                while True:
-                    rhc.watchGPIOs(args.dest, bitmask)
-                    time.sleep(1)
+                if args.gpio_watch:
+                    bitmask = int(args.gpio_watch, 16)
+                    print(f"Watching GPIO mask 0x{bitmask:x} from {args.dest}. Press ctrl-c to exit")
+                    while True:
+                        rhc.watchGPIOs(args.dest, bitmask)
+                        time.sleep(1)
 
         # handle settings
         if args.set:
             closeNow = True
-            prefs = getNode().radioConfig.preferences
+            prefs = interface.getNode(args.dest).radioConfig.preferences
 
             # Handle the int/float/bool arguments
             for pref in args.set:
                 setPref(prefs, pref[0], pref[1])
 
             print("Writing modified preferences to device")
-            getNode().writeConfig()
+            interface.getNode(args.dest).writeConfig()
 
         if args.configure:
             with open(args.configure[0], encoding='utf8') as file:
@@ -307,11 +355,23 @@ def onConnected(interface):
 
                 if 'owner' in configuration:
                     print(f"Setting device owner to {configuration['owner']}")
-                    getNode().setOwner(configuration['owner'])
+                    interface.getNode(args.dest).setOwner(configuration['owner'])
+
+                if 'owner_short' in configuration:
+                    print(f"Setting device owner short to {configuration['owner_short']}")
+                    interface.getNode(args.dest).setOwner(long_name=None, short_name=configuration['owner_short'])
+
+                if 'ownerShort' in configuration:
+                    print(f"Setting device owner short to {configuration['ownerShort']}")
+                    interface.getNode(args.dest).setOwner(long_name=None, short_name=configuration['ownerShort'])
 
                 if 'channel_url' in configuration:
                     print("Setting channel url to", configuration['channel_url'])
-                    getNode().setURL(configuration['channel_url'])
+                    interface.getNode(args.dest).setURL(configuration['channel_url'])
+
+                if 'channelUrl' in configuration:
+                    print("Setting channel url to", configuration['channelUrl'])
+                    interface.getNode(args.dest).setURL(configuration['channelUrl'])
 
                 if 'location' in configuration:
                     alt = 0
@@ -336,11 +396,18 @@ def onConnected(interface):
                     interface.localNode.writeConfig()
 
                 if 'user_prefs' in configuration:
-                    prefs = getNode().radioConfig.preferences
+                    prefs = interface.getNode(args.dest).radioConfig.preferences
                     for pref in configuration['user_prefs']:
                         setPref(prefs, pref, str(configuration['user_prefs'][pref]))
                     print("Writing modified preferences to device")
-                    getNode().writeConfig()
+                    interface.getNode(args.dest).writeConfig()
+
+                if 'userPrefs' in configuration:
+                    prefs = interface.getNode(args.dest).radioConfig.preferences
+                    for pref in configuration['userPrefs']:
+                        setPref(prefs, pref, str(configuration['userPrefs'][pref]))
+                    print("Writing modified preferences to device")
+                    interface.getNode(args.dest).writeConfig()
 
         if args.export_config:
             # export the configuration (the opposite of '--configure')
@@ -349,7 +416,7 @@ def onConnected(interface):
 
         if args.seturl:
             closeNow = True
-            getNode().setURL(args.seturl)
+            interface.getNode(args.dest).setURL(args.seturl)
 
         # handle changing channels
 
@@ -357,7 +424,7 @@ def onConnected(interface):
             closeNow = True
             if len(args.ch_add) > 10:
                 meshtastic.util.our_exit("Warning: Channel name must be shorter. Channel not added.")
-            n = getNode()
+            n = interface.getNode(args.dest)
             ch = n.getChannelByName(args.ch_add)
             if ch:
                 meshtastic.util.our_exit(f"Warning: This node already has a '{args.ch_add}' channel. No changes were made.")
@@ -385,10 +452,10 @@ def onConnected(interface):
                     meshtastic.util.our_exit("Warning: Cannot delete primary channel.", 1)
                 else:
                     print(f"Deleting channel {channelIndex}")
-                    ch = getNode().deleteChannel(channelIndex)
+                    ch = interface.getNode(args.dest).deleteChannel(channelIndex)
 
-        ch_changes = [args.ch_longslow, args.ch_longfast,
-                      args.ch_mediumslow, args.ch_mediumfast,
+        ch_changes = [args.ch_vlongslow, args.ch_longslow, args.ch_longfast,
+                      args.ch_midslow, args.ch_midfast,
                       args.ch_shortslow, args.ch_shortfast]
         any_primary_channel_changes = any(x for x in ch_changes)
         if args.ch_set or any_primary_channel_changes or args.ch_enable or args.ch_disable:
@@ -401,7 +468,7 @@ def onConnected(interface):
                     channelIndex = 0
                 else:
                     meshtastic.util.our_exit("Warning: Need to specify '--ch-index'.", 1)
-            ch = getNode().channels[channelIndex]
+            ch = interface.getNode(args.dest).channels[channelIndex]
 
             if any_primary_channel_changes or args.ch_enable or args.ch_disable:
 
@@ -429,23 +496,26 @@ def onConnected(interface):
                     ch.settings.CopyFrom(chs)
 
                 # handle the simple channel set commands
+                if args.ch_vlongslow:
+                    setSimpleChannel(channel_pb2.ChannelSettings.ModemConfig.VLongSlow)
+
                 if args.ch_longslow:
-                    setSimpleChannel(channel_pb2.ChannelSettings.ModemConfig.Bw125Cr48Sf4096)
+                    setSimpleChannel(channel_pb2.ChannelSettings.ModemConfig.LongSlow)
 
                 if args.ch_longfast:
-                    setSimpleChannel(channel_pb2.ChannelSettings.ModemConfig.Bw31_25Cr48Sf512)
+                    setSimpleChannel(channel_pb2.ChannelSettings.ModemConfig.LongFast)
 
-                if args.ch_mediumslow:
-                    setSimpleChannel(channel_pb2.ChannelSettings.ModemConfig.Bw250Cr46Sf2048)
+                if args.ch_midslow:
+                    setSimpleChannel(channel_pb2.ChannelSettings.ModemConfig.MidSlow)
 
-                if args.ch_mediumfast:
-                    setSimpleChannel(channel_pb2.ChannelSettings.ModemConfig.Bw250Cr47Sf1024)
+                if args.ch_midfast:
+                    setSimpleChannel(channel_pb2.ChannelSettings.ModemConfig.MidFast)
 
                 if args.ch_shortslow:
-                    setSimpleChannel(channel_pb2.ChannelSettings.ModemConfig.Bw125Cr45Sf128)
+                    setSimpleChannel(channel_pb2.ChannelSettings.ModemConfig.ShortSlow)
 
                 if args.ch_shortfast:
-                    setSimpleChannel(channel_pb2.ChannelSettings.ModemConfig.Bw500Cr45Sf128)
+                    setSimpleChannel(channel_pb2.ChannelSettings.ModemConfig.ShortFast)
 
             # Handle the channel settings
             for pref in (args.ch_set or []):
@@ -462,21 +532,27 @@ def onConnected(interface):
                 ch.role = channel_pb2.Channel.Role.DISABLED
 
             print(f"Writing modified channels to device")
-            getNode().writeChannel(channelIndex)
+            interface.getNode(args.dest).writeChannel(channelIndex)
+
+        if args.get_canned_message:
+            closeNow = True
+            print("")
+            interface.getNode(args.dest).get_canned_message()
 
         if args.info:
             print("")
-            if not args.dest:  # If we aren't trying to talk to our local node, don't show it
+            # If we aren't trying to talk to our local node, don't show it
+            if args.dest == BROADCAST_ADDR:
                 interface.showInfo()
 
             print("")
-            getNode().showInfo()
+            interface.getNode(args.dest).showInfo()
             closeNow = True  # FIXME, for now we leave the link up while talking to remote nodes
             print("")
 
         if args.get:
             closeNow = True
-            prefs = getNode().radioConfig.preferences
+            prefs = interface.getNode(args.dest).radioConfig.preferences
 
             # Handle the int/float/bool arguments
             for pref in args.get:
@@ -495,12 +571,16 @@ def onConnected(interface):
             qr = pyqrcode.create(url)
             print(qr.terminal())
 
+        have_tunnel = platform.system() == 'Linux'
         if have_tunnel and args.tunnel:
             # pylint: disable=C0415
             from . import tunnel
             # Even if others said we could close, stay open if the user asked for a tunnel
             closeNow = False
-            tunnel.Tunnel(interface, subnet=args.tunnel_net)
+            if interface.noProto:
+                logging.warning(f"Not starting Tunnel - disabled by noProto")
+            else:
+                tunnel.Tunnel(interface, subnet=args.tunnel_net)
 
         # if the user didn't ask for serial debugging output, we might want to exit after we've done our operation
         if (not args.seriallog) and closeNow:
@@ -530,6 +610,7 @@ def subscribe():
 def export_config(interface):
     """used in--export-config"""
     owner = interface.getLongName()
+    owner_short = interface.getShortName()
     channel_url = interface.localNode.getURL()
     myinfo = interface.getMyNodeInfo()
     pos = myinfo.get('position')
@@ -544,8 +625,13 @@ def export_config(interface):
     config = "# start of Meshtastic configure yaml\n"
     if owner:
         config += f"owner: {owner}\n\n"
+    if owner_short:
+        config += f"owner_short: {owner_short}\n\n"
     if channel_url:
-        config += f"channel_url: {channel_url}\n\n"
+        if Globals.getInstance().get_camel_case():
+            config += f"channelUrl: {channel_url}\n\n"
+        else:
+            config += f"channel_url: {channel_url}\n\n"
     if lat or lon or alt:
         config += "location:\n"
         if lat:
@@ -558,9 +644,16 @@ def export_config(interface):
     preferences = f'{interface.localNode.radioConfig.preferences}'
     prefs = preferences.splitlines()
     if prefs:
-        config += "user_prefs:\n"
+        if Globals.getInstance().get_camel_case():
+            config += "userPrefs:\n"
+        else:
+            config += "user_prefs:\n"
         for pref in prefs:
-            config += f"  {meshtastic.util.quoteBooleans(pref)}\n"
+            if Globals.getInstance().get_camel_case():
+                # Note: This may not work if the value has '_'
+                config += f"  {meshtastic.util.snake_to_camel(meshtastic.util.quoteBooleans(pref))}\n"
+            else:
+                config += f"  {meshtastic.util.quoteBooleans(pref)}\n"
     print(config)
     return config
 
@@ -586,13 +679,8 @@ def common():
             channelIndex = int(args.ch_index)
             our_globals.set_channel_index(channelIndex)
 
-        # Some commands require dest to be set, so we now use destOrAll/destOrLocal for more lenient commands
         if not args.dest:
-            args.destOrAll = "^all"
-            args.destOrLocal = "^local"
-        else:
-            args.destOrAll = args.dest
-            args.destOrLocal = args.dest  # FIXME, temp hack for debugging remove
+            args.dest = BROADCAST_ADDR
 
         if not args.seriallog:
             if args.noproto:
@@ -627,20 +715,26 @@ def common():
 
             subscribe()
             if args.ble:
-                client = meshtastic.ble_interface.BLEInterface(args.ble, debugOut=logfile, noProto=args.noproto)
+                client = BLEInterface(args.ble, debugOut=logfile, noProto=args.noproto)
             elif args.host:
-                client = meshtastic.tcp_interface.TCPInterface(
-                    args.host, debugOut=logfile, noProto=args.noproto)
+                client = meshtastic.tcp_interface.TCPInterface(args.host, debugOut=logfile, noProto=args.noproto)
             else:
-                client = meshtastic.serial_interface.SerialInterface(
-                    args.port, debugOut=logfile, noProto=args.noproto)
+                try:
+                    client = meshtastic.serial_interface.SerialInterface(args.port, debugOut=logfile, noProto=args.noproto)
+                except PermissionError as ex:
+                    username = os.getlogin()
+                    message = "Permission Error:\n"
+                    message += "  Need to add yourself to the 'dialout' group by running:\n"
+                    message += f"     sudo usermod -a -G dialout {username}\n"
+                    message += "  After running that command, log out and re-login for it to take effect.\n"
+                    message += f"Error was:{ex}"
+                    meshtastic.util.our_exit(message)
 
             # We assume client is fully connected now
             onConnected(client)
-            #if logfile:
-                #logfile.close()
 
-            if args.noproto or (have_tunnel and args.tunnel):  # loop until someone presses ctrlc
+            have_tunnel = platform.system() == 'Linux'
+            if args.noproto or args.reply or (have_tunnel and args.tunnel):  # loop until someone presses ctrlc
                 while True:
                     time.sleep(1000)
 
@@ -681,6 +775,9 @@ def initParser():
     parser.add_argument("--info", help="Read and display the radio config information",
                         action="store_true")
 
+    parser.add_argument("--get-canned-message", help="Show the canned message plugin message",
+                        action="store_true")
+
     parser.add_argument("--nodes", help="Print Node List in a pretty formatted table",
                         action="store_true")
 
@@ -688,10 +785,12 @@ def initParser():
                         action="store_true")
 
     parser.add_argument(
-        "--get", help="Get a preferences field. Use an invalid field such as '0' to get a list of all fields.", nargs=1, action='append')
+        "--get", help=("Get a preferences field. Use an invalid field such as '0' to get a list of all fields."
+                       " Can use either snake_case or camelCase format. (ex: 'ls_secs' or 'lsSecs')"),
+                       nargs=1, action='append')
 
     parser.add_argument(
-        "--set", help="Set a preferences field", nargs=2, action='append')
+        "--set", help="Set a preferences field. Can use either snake_case or camelCase format. (ex: 'ls_secs' or 'lsSecs')", nargs=2, action='append')
 
     parser.add_argument(
         "--seturl", help="Set a channel URL", action="store")
@@ -713,7 +812,15 @@ def initParser():
         "--ch-disable", help="Disable the specified channel", action="store_true", dest="ch_disable", default=False)
 
     parser.add_argument(
-        "--ch-set", help="Set a channel parameter", nargs=2, action='append')
+        "--ch-set", help=("Set a channel parameter. To see channel settings available:'--ch-set all all --ch-index 0'. "
+                          "Can set the 'psk' using this command. To disable encryption on primary channel:'--ch-set psk none --ch-index 0'. "
+                          "To set encryption with a new random key on second channel:'--ch-set psk random --ch-index 1'. "
+                          "To set encryption back to the default:'--ch-set default --ch-index 0'. To set encryption with your "
+                          "own key: '--ch-set psk 0x1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b --ch-index 0'."),
+                          nargs=2, action='append')
+
+    parser.add_argument(
+        "--ch-vlongslow", help="Change to the very long-range and slow channel", action='store_true')
 
     parser.add_argument(
         "--ch-longslow", help="Change to the long-range and slow channel", action='store_true')
@@ -722,10 +829,10 @@ def initParser():
         "--ch-longfast", help="Change to the long-range and fast channel", action='store_true')
 
     parser.add_argument(
-        "--ch-mediumslow", help="Change to the medium-range and slow channel", action='store_true')
+        "--ch-midslow", help="Change to the mid-range and slow channel", action='store_true')
 
     parser.add_argument(
-        "--ch-mediumfast", help="Change to the medium-range and fast channel", action='store_true')
+        "--ch-midfast", help="Change to the mid-range and fast channel", action='store_true')
 
     parser.add_argument(
         "--ch-shortslow", help="Change to the short-range and slow channel", action='store_true')
@@ -733,10 +840,15 @@ def initParser():
     parser.add_argument(
         "--ch-shortfast", help="Change to the short-range and fast channel", action='store_true')
 
-
     parser.add_argument(
         "--set-owner", help="Set device owner name", action="store")
 
+    parser.add_argument(
+        "--set-canned-message", help="Set the canned messages plugin message (up to 1000 characters).", action="store")
+
+    parser.add_argument(
+        "--set-owner-short", help="Set device owner short name", action="store")
+
     parser.add_argument(
         "--set-team", help="Set team affiliation (an invalid team will list valid values)", action="store")
 
@@ -755,6 +867,9 @@ def initParser():
     parser.add_argument(
         "--reboot", help="Tell the destination node to reboot", action="store_true")
 
+    parser.add_argument(
+        "--shutdown", help="Tell the destination node to shutdown", action="store_true")
+
     parser.add_argument(
         "--reply", help="Reply to received messages",
         action="store_true")
@@ -805,16 +920,18 @@ def initParser():
     parser.add_argument('--unset-router', dest='deprecated',
                         action='store_false', help='Deprecated, use "--set is_router false" instead')
 
+    have_tunnel = platform.system() == 'Linux'
     if have_tunnel:
-        parser.add_argument('--tunnel',
-                            action='store_true', help="Create a TUN tunnel device for forwarding IP packets over the mesh")
-        parser.add_argument(
-            "--subnet", dest='tunnel_net', help="Sets the local-end subnet address for the TUN IP bridge", default=None)
+        parser.add_argument('--tunnel', action='store_true',
+                            help="Create a TUN tunnel device for forwarding IP packets over the mesh")
+        parser.add_argument("--subnet", dest='tunnel_net',
+                            help="Sets the local-end subnet address for the TUN IP bridge. (ex: 10.115' which is the default)",
+                            default=None)
 
     parser.set_defaults(deprecated=None)
 
-    parser.add_argument('--version', action='version',
-                        version=f"{pkg_resources.require('meshtastic')[0].version}")
+    the_version = pkg_resources.get_distribution("meshtastic").version
+    parser.add_argument('--version', action='version', version=f"{the_version}")
 
     parser.add_argument(
         "--support", action='store_true', help="Show support info (useful when troubleshooting an issue)")

meshtastic/admin_pb2.py

@@ -12,8 +12,8 @@ _sym_db = _symbol_database.Default()
 
 
 from . import channel_pb2 as channel__pb2
-from . import radioconfig_pb2 as radioconfig__pb2
 from . import mesh_pb2 as mesh__pb2
+from . import radioconfig_pb2 as radioconfig__pb2
 
 
 DESCRIPTOR = _descriptor.FileDescriptor(
@@ -21,9 +21,9 @@ DESCRIPTOR = _descriptor.FileDescriptor(
   package='',
   syntax='proto3',
   serialized_options=b'\n\023com.geeksville.meshB\013AdminProtosH\003Z!github.com/meshtastic/gomeshproto',
-  serialized_pb=b'\n\x0b\x61\x64min.proto\x1a\rchannel.proto\x1a\x11radioconfig.proto\x1a\nmesh.proto\"\xbd\x03\n\x0c\x41\x64minMessage\x12!\n\tset_radio\x18\x01 \x01(\x0b\x32\x0c.RadioConfigH\x00\x12\x1a\n\tset_owner\x18\x02 \x01(\x0b\x32\x05.UserH\x00\x12\x1f\n\x0bset_channel\x18\x03 \x01(\x0b\x32\x08.ChannelH\x00\x12\x1b\n\x11get_radio_request\x18\x04 \x01(\x08H\x00\x12*\n\x12get_radio_response\x18\x05 \x01(\x0b\x32\x0c.RadioConfigH\x00\x12\x1d\n\x13get_channel_request\x18\x06 \x01(\rH\x00\x12(\n\x14get_channel_response\x18\x07 \x01(\x0b\x32\x08.ChannelH\x00\x12\x1b\n\x11get_owner_request\x18\x08 \x01(\x08H\x00\x12#\n\x12get_owner_response\x18\t \x01(\x0b\x32\x05.UserH\x00\x12\x1d\n\x13\x63onfirm_set_channel\x18  \x01(\x08H\x00\x12\x1b\n\x11\x63onfirm_set_radio\x18! \x01(\x08H\x00\x12\x18\n\x0e\x65xit_simulator\x18\" \x01(\x08H\x00\x12\x18\n\x0ereboot_seconds\x18# \x01(\x05H\x00\x42\t\n\x07variantBG\n\x13\x63om.geeksville.meshB\x0b\x41\x64minProtosH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3'
+  serialized_pb=b'\n\x0b\x61\x64min.proto\x1a\rchannel.proto\x1a\nmesh.proto\x1a\x11radioconfig.proto\"\xa1\x08\n\x0c\x41\x64minMessage\x12!\n\tset_radio\x18\x01 \x01(\x0b\x32\x0c.RadioConfigH\x00\x12\x1a\n\tset_owner\x18\x02 \x01(\x0b\x32\x05.UserH\x00\x12\x1f\n\x0bset_channel\x18\x03 \x01(\x0b\x32\x08.ChannelH\x00\x12\x1b\n\x11get_radio_request\x18\x04 \x01(\x08H\x00\x12*\n\x12get_radio_response\x18\x05 \x01(\x0b\x32\x0c.RadioConfigH\x00\x12\x1d\n\x13get_channel_request\x18\x06 \x01(\rH\x00\x12(\n\x14get_channel_response\x18\x07 \x01(\x0b\x32\x08.ChannelH\x00\x12\x1b\n\x11get_owner_request\x18\x08 \x01(\x08H\x00\x12#\n\x12get_owner_response\x18\t \x01(\x0b\x32\x05.UserH\x00\x12\x1d\n\x13\x63onfirm_set_channel\x18  \x01(\x08H\x00\x12\x1b\n\x11\x63onfirm_set_radio\x18! \x01(\x08H\x00\x12\x18\n\x0e\x65xit_simulator\x18\" \x01(\x08H\x00\x12\x18\n\x0ereboot_seconds\x18# \x01(\x05H\x00\x12\x31\n\'get_canned_message_module_part1_request\x18$ \x01(\x08H\x00\x12\x32\n(get_canned_message_module_part1_response\x18% \x01(\tH\x00\x12\x31\n\'get_canned_message_module_part2_request\x18& \x01(\x08H\x00\x12\x32\n(get_canned_message_module_part2_response\x18\' \x01(\tH\x00\x12\x31\n\'get_canned_message_module_part3_request\x18( \x01(\x08H\x00\x12\x32\n(get_canned_message_module_part3_response\x18) \x01(\tH\x00\x12\x31\n\'get_canned_message_module_part4_request\x18* \x01(\x08H\x00\x12\x32\n(get_canned_message_module_part4_response\x18+ \x01(\tH\x00\x12)\n\x1fset_canned_message_module_part1\x18, \x01(\tH\x00\x12)\n\x1fset_canned_message_module_part2\x18- \x01(\tH\x00\x12)\n\x1fset_canned_message_module_part3\x18. \x01(\tH\x00\x12)\n\x1fset_canned_message_module_part4\x18/ \x01(\tH\x00\x12\x1a\n\x10shutdown_seconds\x18\x33 \x01(\x05H\x00\x42\t\n\x07variantBG\n\x13\x63om.geeksville.meshB\x0b\x41\x64minProtosH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3'
   ,
-  dependencies=[channel__pb2.DESCRIPTOR,radioconfig__pb2.DESCRIPTOR,mesh__pb2.DESCRIPTOR,])
+  dependencies=[channel__pb2.DESCRIPTOR,mesh__pb2.DESCRIPTOR,radioconfig__pb2.DESCRIPTOR,])
 
 
 
@@ -126,6 +126,97 @@ _ADMINMESSAGE = _descriptor.Descriptor(
       message_type=None, enum_type=None, containing_type=None,
       is_extension=False, extension_scope=None,
       serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='get_canned_message_module_part1_request', full_name='AdminMessage.get_canned_message_module_part1_request', index=13,
+      number=36, type=8, cpp_type=7, label=1,
+      has_default_value=False, default_value=False,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='get_canned_message_module_part1_response', full_name='AdminMessage.get_canned_message_module_part1_response', index=14,
+      number=37, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='get_canned_message_module_part2_request', full_name='AdminMessage.get_canned_message_module_part2_request', index=15,
+      number=38, type=8, cpp_type=7, label=1,
+      has_default_value=False, default_value=False,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='get_canned_message_module_part2_response', full_name='AdminMessage.get_canned_message_module_part2_response', index=16,
+      number=39, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='get_canned_message_module_part3_request', full_name='AdminMessage.get_canned_message_module_part3_request', index=17,
+      number=40, type=8, cpp_type=7, label=1,
+      has_default_value=False, default_value=False,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='get_canned_message_module_part3_response', full_name='AdminMessage.get_canned_message_module_part3_response', index=18,
+      number=41, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='get_canned_message_module_part4_request', full_name='AdminMessage.get_canned_message_module_part4_request', index=19,
+      number=42, type=8, cpp_type=7, label=1,
+      has_default_value=False, default_value=False,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='get_canned_message_module_part4_response', full_name='AdminMessage.get_canned_message_module_part4_response', index=20,
+      number=43, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='set_canned_message_module_part1', full_name='AdminMessage.set_canned_message_module_part1', index=21,
+      number=44, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='set_canned_message_module_part2', full_name='AdminMessage.set_canned_message_module_part2', index=22,
+      number=45, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='set_canned_message_module_part3', full_name='AdminMessage.set_canned_message_module_part3', index=23,
+      number=46, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='set_canned_message_module_part4', full_name='AdminMessage.set_canned_message_module_part4', index=24,
+      number=47, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='shutdown_seconds', full_name='AdminMessage.shutdown_seconds', index=25,
+      number=51, type=5, cpp_type=1, label=1,
+      has_default_value=False, default_value=0,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
   ],
   extensions=[
   ],
@@ -142,7 +233,7 @@ _ADMINMESSAGE = _descriptor.Descriptor(
       index=0, containing_type=None, fields=[]),
   ],
   serialized_start=62,
-  serialized_end=507,
+  serialized_end=1119,
 )
 
 _ADMINMESSAGE.fields_by_name['set_radio'].message_type = radioconfig__pb2._RADIOCONFIG
@@ -190,6 +281,45 @@ _ADMINMESSAGE.fields_by_name['exit_simulator'].containing_oneof = _ADMINMESSAGE.
 _ADMINMESSAGE.oneofs_by_name['variant'].fields.append(
   _ADMINMESSAGE.fields_by_name['reboot_seconds'])
 _ADMINMESSAGE.fields_by_name['reboot_seconds'].containing_oneof = _ADMINMESSAGE.oneofs_by_name['variant']
+_ADMINMESSAGE.oneofs_by_name['variant'].fields.append(
+  _ADMINMESSAGE.fields_by_name['get_canned_message_module_part1_request'])
+_ADMINMESSAGE.fields_by_name['get_canned_message_module_part1_request'].containing_oneof = _ADMINMESSAGE.oneofs_by_name['variant']
+_ADMINMESSAGE.oneofs_by_name['variant'].fields.append(
+  _ADMINMESSAGE.fields_by_name['get_canned_message_module_part1_response'])
+_ADMINMESSAGE.fields_by_name['get_canned_message_module_part1_response'].containing_oneof = _ADMINMESSAGE.oneofs_by_name['variant']
+_ADMINMESSAGE.oneofs_by_name['variant'].fields.append(
+  _ADMINMESSAGE.fields_by_name['get_canned_message_module_part2_request'])
+_ADMINMESSAGE.fields_by_name['get_canned_message_module_part2_request'].containing_oneof = _ADMINMESSAGE.oneofs_by_name['variant']
+_ADMINMESSAGE.oneofs_by_name['variant'].fields.append(
+  _ADMINMESSAGE.fields_by_name['get_canned_message_module_part2_response'])
+_ADMINMESSAGE.fields_by_name['get_canned_message_module_part2_response'].containing_oneof = _ADMINMESSAGE.oneofs_by_name['variant']
+_ADMINMESSAGE.oneofs_by_name['variant'].fields.append(
+  _ADMINMESSAGE.fields_by_name['get_canned_message_module_part3_request'])
+_ADMINMESSAGE.fields_by_name['get_canned_message_module_part3_request'].containing_oneof = _ADMINMESSAGE.oneofs_by_name['variant']
+_ADMINMESSAGE.oneofs_by_name['variant'].fields.append(
+  _ADMINMESSAGE.fields_by_name['get_canned_message_module_part3_response'])
+_ADMINMESSAGE.fields_by_name['get_canned_message_module_part3_response'].containing_oneof = _ADMINMESSAGE.oneofs_by_name['variant']
+_ADMINMESSAGE.oneofs_by_name['variant'].fields.append(
+  _ADMINMESSAGE.fields_by_name['get_canned_message_module_part4_request'])
+_ADMINMESSAGE.fields_by_name['get_canned_message_module_part4_request'].containing_oneof = _ADMINMESSAGE.oneofs_by_name['variant']
+_ADMINMESSAGE.oneofs_by_name['variant'].fields.append(
+  _ADMINMESSAGE.fields_by_name['get_canned_message_module_part4_response'])
+_ADMINMESSAGE.fields_by_name['get_canned_message_module_part4_response'].containing_oneof = _ADMINMESSAGE.oneofs_by_name['variant']
+_ADMINMESSAGE.oneofs_by_name['variant'].fields.append(
+  _ADMINMESSAGE.fields_by_name['set_canned_message_module_part1'])
+_ADMINMESSAGE.fields_by_name['set_canned_message_module_part1'].containing_oneof = _ADMINMESSAGE.oneofs_by_name['variant']
+_ADMINMESSAGE.oneofs_by_name['variant'].fields.append(
+  _ADMINMESSAGE.fields_by_name['set_canned_message_module_part2'])
+_ADMINMESSAGE.fields_by_name['set_canned_message_module_part2'].containing_oneof = _ADMINMESSAGE.oneofs_by_name['variant']
+_ADMINMESSAGE.oneofs_by_name['variant'].fields.append(
+  _ADMINMESSAGE.fields_by_name['set_canned_message_module_part3'])
+_ADMINMESSAGE.fields_by_name['set_canned_message_module_part3'].containing_oneof = _ADMINMESSAGE.oneofs_by_name['variant']
+_ADMINMESSAGE.oneofs_by_name['variant'].fields.append(
+  _ADMINMESSAGE.fields_by_name['set_canned_message_module_part4'])
+_ADMINMESSAGE.fields_by_name['set_canned_message_module_part4'].containing_oneof = _ADMINMESSAGE.oneofs_by_name['variant']
+_ADMINMESSAGE.oneofs_by_name['variant'].fields.append(
+  _ADMINMESSAGE.fields_by_name['shutdown_seconds'])
+_ADMINMESSAGE.fields_by_name['shutdown_seconds'].containing_oneof = _ADMINMESSAGE.oneofs_by_name['variant']
 DESCRIPTOR.message_types_by_name['AdminMessage'] = _ADMINMESSAGE
 _sym_db.RegisterFileDescriptor(DESCRIPTOR)
 

meshtastic/ble_interface.py

@@ -1,10 +1,16 @@
 """Bluetooth interface
 """
 import logging
-import pygatt
+import platform
+
+from meshtastic.mesh_interface import MeshInterface
+from meshtastic.util import our_exit
+
+if platform.system() == 'Linux':
+    # pylint: disable=E0401
+    import pygatt
 
 
-from .mesh_interface import MeshInterface
 
 # Our standard BLE characteristics
 TORADIO_UUID = "f75c76d2-129e-4dad-a1dd-7866124401e7"
@@ -16,6 +22,8 @@ class BLEInterface(MeshInterface):
     """A not quite ready - FIXME - BLE interface to devices"""
 
     def __init__(self, address, noProto=False, debugOut=None):
+        if platform.system() != 'Linux':
+            our_exit("Linux is the only platform with experimental BLE support.", 1)
         self.address = address
         if not noProto:
             self.adapter = pygatt.GATTToolBackend()  # BGAPIBackend()
@@ -31,7 +39,7 @@ class BLEInterface(MeshInterface):
 
         self._readFromRadio()  # read the initial responses
 
-        def handle_data(handle, data):
+        def handle_data(handle, data): # pylint: disable=W0613
             self._handleFromRadio(data)
 
         if self.device:

meshtastic/cannedmessages_pb2.py

@@ -0,0 +1,90 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: cannedmessages.proto
+
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from google.protobuf import reflection as _reflection
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor.FileDescriptor(
+  name='cannedmessages.proto',
+  package='',
+  syntax='proto3',
+  serialized_options=b'\n\023com.geeksville.meshB\031CannedMessageConfigProtosH\003Z!github.com/meshtastic/gomeshproto',
+  serialized_pb=b'\n\x14\x63\x61nnedmessages.proto\"w\n\x19\x43\x61nnedMessageModuleConfig\x12\x15\n\rmessagesPart1\x18\x0b \x01(\t\x12\x15\n\rmessagesPart2\x18\x0c \x01(\t\x12\x15\n\rmessagesPart3\x18\r \x01(\t\x12\x15\n\rmessagesPart4\x18\x0e \x01(\tBU\n\x13\x63om.geeksville.meshB\x19\x43\x61nnedMessageConfigProtosH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3'
+)
+
+
+
+
+_CANNEDMESSAGEMODULECONFIG = _descriptor.Descriptor(
+  name='CannedMessageModuleConfig',
+  full_name='CannedMessageModuleConfig',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='messagesPart1', full_name='CannedMessageModuleConfig.messagesPart1', index=0,
+      number=11, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='messagesPart2', full_name='CannedMessageModuleConfig.messagesPart2', index=1,
+      number=12, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='messagesPart3', full_name='CannedMessageModuleConfig.messagesPart3', index=2,
+      number=13, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='messagesPart4', full_name='CannedMessageModuleConfig.messagesPart4', index=3,
+      number=14, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=24,
+  serialized_end=143,
+)
+
+DESCRIPTOR.message_types_by_name['CannedMessageModuleConfig'] = _CANNEDMESSAGEMODULECONFIG
+_sym_db.RegisterFileDescriptor(DESCRIPTOR)
+
+CannedMessageModuleConfig = _reflection.GeneratedProtocolMessageType('CannedMessageModuleConfig', (_message.Message,), {
+  'DESCRIPTOR' : _CANNEDMESSAGEMODULECONFIG,
+  '__module__' : 'cannedmessages_pb2'
+  # @@protoc_insertion_point(class_scope:CannedMessageModuleConfig)
+  })
+_sym_db.RegisterMessage(CannedMessageModuleConfig)
+
+
+DESCRIPTOR._options = None
+# @@protoc_insertion_point(module_scope)

meshtastic/channel_pb2.py

@@ -18,7 +18,7 @@ DESCRIPTOR = _descriptor.FileDescriptor(
   package='',
   syntax='proto3',
   serialized_options=b'\n\023com.geeksville.meshB\rChannelProtosH\003Z!github.com/meshtastic/gomeshproto',
-  serialized_pb=b'\n\rchannel.proto\"\x91\x03\n\x0f\x43hannelSettings\x12\x10\n\x08tx_power\x18\x01 \x01(\x05\x12\x32\n\x0cmodem_config\x18\x03 \x01(\x0e\x32\x1c.ChannelSettings.ModemConfig\x12\x11\n\tbandwidth\x18\x06 \x01(\r\x12\x15\n\rspread_factor\x18\x07 \x01(\r\x12\x13\n\x0b\x63oding_rate\x18\x08 \x01(\r\x12\x13\n\x0b\x63hannel_num\x18\t \x01(\r\x12\x0b\n\x03psk\x18\x04 \x01(\x0c\x12\x0c\n\x04name\x18\x05 \x01(\t\x12\n\n\x02id\x18\n \x01(\x07\x12\x16\n\x0euplink_enabled\x18\x10 \x01(\x08\x12\x18\n\x10\x64ownlink_enabled\x18\x11 \x01(\x08\"\x8a\x01\n\x0bModemConfig\x12\x12\n\x0e\x42w125Cr45Sf128\x10\x00\x12\x12\n\x0e\x42w500Cr45Sf128\x10\x01\x12\x14\n\x10\x42w31_25Cr48Sf512\x10\x02\x12\x13\n\x0f\x42w125Cr48Sf4096\x10\x03\x12\x13\n\x0f\x42w250Cr46Sf2048\x10\x04\x12\x13\n\x0f\x42w250Cr47Sf1024\x10\x05\"\x8b\x01\n\x07\x43hannel\x12\r\n\x05index\x18\x01 \x01(\x05\x12\"\n\x08settings\x18\x02 \x01(\x0b\x32\x10.ChannelSettings\x12\x1b\n\x04role\x18\x03 \x01(\x0e\x32\r.Channel.Role\"0\n\x04Role\x12\x0c\n\x08\x44ISABLED\x10\x00\x12\x0b\n\x07PRIMARY\x10\x01\x12\r\n\tSECONDARY\x10\x02\x42I\n\x13\x63om.geeksville.meshB\rChannelProtosH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3'
+  serialized_pb=b'\n\rchannel.proto\"\xf6\x02\n\x0f\x43hannelSettings\x12\x10\n\x08tx_power\x18\x01 \x01(\x05\x12\x32\n\x0cmodem_config\x18\x03 \x01(\x0e\x32\x1c.ChannelSettings.ModemConfig\x12\x11\n\tbandwidth\x18\x06 \x01(\r\x12\x15\n\rspread_factor\x18\x07 \x01(\r\x12\x13\n\x0b\x63oding_rate\x18\x08 \x01(\r\x12\x13\n\x0b\x63hannel_num\x18\t \x01(\r\x12\x0b\n\x03psk\x18\x04 \x01(\x0c\x12\x0c\n\x04name\x18\x05 \x01(\t\x12\n\n\x02id\x18\n \x01(\x07\x12\x16\n\x0euplink_enabled\x18\x10 \x01(\x08\x12\x18\n\x10\x64ownlink_enabled\x18\x11 \x01(\x08\"p\n\x0bModemConfig\x12\r\n\tVLongSlow\x10\x00\x12\x0c\n\x08LongSlow\x10\x01\x12\x0c\n\x08LongFast\x10\x02\x12\x0b\n\x07MidSlow\x10\x03\x12\x0b\n\x07MidFast\x10\x04\x12\r\n\tShortSlow\x10\x05\x12\r\n\tShortFast\x10\x06\"\x8b\x01\n\x07\x43hannel\x12\r\n\x05index\x18\x01 \x01(\x05\x12\"\n\x08settings\x18\x02 \x01(\x0b\x32\x10.ChannelSettings\x12\x1b\n\x04role\x18\x03 \x01(\x0e\x32\r.Channel.Role\"0\n\x04Role\x12\x0c\n\x08\x44ISABLED\x10\x00\x12\x0b\n\x07PRIMARY\x10\x01\x12\r\n\tSECONDARY\x10\x02\x42I\n\x13\x63om.geeksville.meshB\rChannelProtosH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3'
 )
 
 
@@ -30,34 +30,38 @@ _CHANNELSETTINGS_MODEMCONFIG = _descriptor.EnumDescriptor(
   file=DESCRIPTOR,
   values=[
     _descriptor.EnumValueDescriptor(
-      name='Bw125Cr45Sf128', index=0, number=0,
+      name='VLongSlow', index=0, number=0,
       serialized_options=None,
       type=None),
     _descriptor.EnumValueDescriptor(
-      name='Bw500Cr45Sf128', index=1, number=1,
+      name='LongSlow', index=1, number=1,
       serialized_options=None,
       type=None),
     _descriptor.EnumValueDescriptor(
-      name='Bw31_25Cr48Sf512', index=2, number=2,
+      name='LongFast', index=2, number=2,
       serialized_options=None,
       type=None),
     _descriptor.EnumValueDescriptor(
-      name='Bw125Cr48Sf4096', index=3, number=3,
+      name='MidSlow', index=3, number=3,
       serialized_options=None,
       type=None),
     _descriptor.EnumValueDescriptor(
-      name='Bw250Cr46Sf2048', index=4, number=4,
+      name='MidFast', index=4, number=4,
       serialized_options=None,
       type=None),
     _descriptor.EnumValueDescriptor(
-      name='Bw250Cr47Sf1024', index=5, number=5,
+      name='ShortSlow', index=5, number=5,
+      serialized_options=None,
+      type=None),
+    _descriptor.EnumValueDescriptor(
+      name='ShortFast', index=6, number=6,
       serialized_options=None,
       type=None),
   ],
   containing_type=None,
   serialized_options=None,
-  serialized_start=281,
-  serialized_end=419,
+  serialized_start=280,
+  serialized_end=392,
 )
 _sym_db.RegisterEnumDescriptor(_CHANNELSETTINGS_MODEMCONFIG)
 
@@ -82,8 +86,8 @@ _CHANNEL_ROLE = _descriptor.EnumDescriptor(
   ],
   containing_type=None,
   serialized_options=None,
-  serialized_start=513,
-  serialized_end=561,
+  serialized_start=486,
+  serialized_end=534,
 )
 _sym_db.RegisterEnumDescriptor(_CHANNEL_ROLE)
 
@@ -186,7 +190,7 @@ _CHANNELSETTINGS = _descriptor.Descriptor(
   oneofs=[
   ],
   serialized_start=18,
-  serialized_end=419,
+  serialized_end=392,
 )
 
 
@@ -231,8 +235,8 @@ _CHANNEL = _descriptor.Descriptor(
   extension_ranges=[],
   oneofs=[
   ],
-  serialized_start=422,
-  serialized_end=561,
+  serialized_start=395,
+  serialized_end=534,
 )
 
 _CHANNELSETTINGS.fields_by_name['modem_config'].enum_type = _CHANNELSETTINGS_MODEMCONFIG

meshtastic/deviceonly_pb2.py

@@ -2,6 +2,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: deviceonly.proto
 
+from google.protobuf.internal import enum_type_wrapper
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import message as _message
 from google.protobuf import reflection as _reflection
@@ -13,7 +14,6 @@ _sym_db = _symbol_database.Default()
 
 from . import channel_pb2 as channel__pb2
 from . import mesh_pb2 as mesh__pb2
-from . import radioconfig_pb2 as radioconfig__pb2
 
 
 DESCRIPTOR = _descriptor.FileDescriptor(
@@ -21,72 +21,41 @@ DESCRIPTOR = _descriptor.FileDescriptor(
   package='',
   syntax='proto3',
   serialized_options=b'\n\023com.geeksville.meshB\nDeviceOnlyH\003Z!github.com/meshtastic/gomeshproto',
-  serialized_pb=b'\n\x10\x64\x65viceonly.proto\x1a\rchannel.proto\x1a\nmesh.proto\x1a\x11radioconfig.proto\"\x80\x01\n\x11LegacyRadioConfig\x12\x39\n\x0bpreferences\x18\x01 \x01(\x0b\x32$.LegacyRadioConfig.LegacyPreferences\x1a\x30\n\x11LegacyPreferences\x12\x1b\n\x06region\x18\x0f \x01(\x0e\x32\x0b.RegionCode\"\x8f\x02\n\x0b\x44\x65viceState\x12\'\n\x0blegacyRadio\x18\x01 \x01(\x0b\x32\x12.LegacyRadioConfig\x12\x1c\n\x07my_node\x18\x02 \x01(\x0b\x32\x0b.MyNodeInfo\x12\x14\n\x05owner\x18\x03 \x01(\x0b\x32\x05.User\x12\x1a\n\x07node_db\x18\x04 \x03(\x0b\x32\t.NodeInfo\x12\"\n\rreceive_queue\x18\x05 \x03(\x0b\x32\x0b.MeshPacket\x12\x0f\n\x07version\x18\x08 \x01(\r\x12$\n\x0frx_text_message\x18\x07 \x01(\x0b\x32\x0b.MeshPacket\x12\x0f\n\x07no_save\x18\t \x01(\x08\x12\x15\n\rdid_gps_reset\x18\x0b \x01(\x08J\x04\x08\x0c\x10\r\")\n\x0b\x43hannelFile\x12\x1a\n\x08\x63hannels\x18\x01 \x03(\x0b\x32\x08.ChannelBF\n\x13\x63om.geeksville.meshB\nDeviceOnlyH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3'
+  serialized_pb=b'\n\x10\x64\x65viceonly.proto\x1a\rchannel.proto\x1a\nmesh.proto\"\xe6\x01\n\x0b\x44\x65viceState\x12\x1c\n\x07my_node\x18\x02 \x01(\x0b\x32\x0b.MyNodeInfo\x12\x14\n\x05owner\x18\x03 \x01(\x0b\x32\x05.User\x12\x1a\n\x07node_db\x18\x04 \x03(\x0b\x32\t.NodeInfo\x12\"\n\rreceive_queue\x18\x05 \x03(\x0b\x32\x0b.MeshPacket\x12\x0f\n\x07version\x18\x08 \x01(\r\x12$\n\x0frx_text_message\x18\x07 \x01(\x0b\x32\x0b.MeshPacket\x12\x0f\n\x07no_save\x18\t \x01(\x08\x12\x15\n\rdid_gps_reset\x18\x0b \x01(\x08J\x04\x08\x0c\x10\r\")\n\x0b\x43hannelFile\x12\x1a\n\x08\x63hannels\x18\x01 \x03(\x0b\x32\x08.Channel\"\x84\x01\n\x08OEMStore\x12\x16\n\x0eoem_icon_width\x18\x01 \x01(\r\x12\x17\n\x0foem_icon_height\x18\x02 \x01(\r\x12\x15\n\roem_icon_bits\x18\x03 \x01(\x0c\x12\x1e\n\x08oem_font\x18\x04 \x01(\x0e\x32\x0c.ScreenFonts\x12\x10\n\x08oem_text\x18\x05 \x01(\t*>\n\x0bScreenFonts\x12\x0e\n\nFONT_SMALL\x10\x00\x12\x0f\n\x0b\x46ONT_MEDIUM\x10\x01\x12\x0e\n\nFONT_LARGE\x10\x02\x42\x46\n\x13\x63om.geeksville.meshB\nDeviceOnlyH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3'
   ,
-  dependencies=[channel__pb2.DESCRIPTOR,mesh__pb2.DESCRIPTOR,radioconfig__pb2.DESCRIPTOR,])
+  dependencies=[channel__pb2.DESCRIPTOR,mesh__pb2.DESCRIPTOR,])
 
-
-
-
-_LEGACYRADIOCONFIG_LEGACYPREFERENCES = _descriptor.Descriptor(
-  name='LegacyPreferences',
-  full_name='LegacyRadioConfig.LegacyPreferences',
+_SCREENFONTS = _descriptor.EnumDescriptor(
+  name='ScreenFonts',
+  full_name='ScreenFonts',
   filename=None,
   file=DESCRIPTOR,
+  values=[
+    _descriptor.EnumValueDescriptor(
+      name='FONT_SMALL', index=0, number=0,
+      serialized_options=None,
+      type=None),
+    _descriptor.EnumValueDescriptor(
+      name='FONT_MEDIUM', index=1, number=1,
+      serialized_options=None,
+      type=None),
+    _descriptor.EnumValueDescriptor(
+      name='FONT_LARGE', index=2, number=2,
+      serialized_options=None,
+      type=None),
+  ],
   containing_type=None,
-  fields=[
-    _descriptor.FieldDescriptor(
-      name='region', full_name='LegacyRadioConfig.LegacyPreferences.region', index=0,
-      number=15, type=14, cpp_type=8, label=1,
-      has_default_value=False, default_value=0,
-      message_type=None, enum_type=None, containing_type=None,
-      is_extension=False, extension_scope=None,
-      serialized_options=None, file=DESCRIPTOR),
-  ],
-  extensions=[
-  ],
-  nested_types=[],
-  enum_types=[
-  ],
   serialized_options=None,
-  is_extendable=False,
-  syntax='proto3',
-  extension_ranges=[],
-  oneofs=[
-  ],
-  serialized_start=147,
-  serialized_end=195,
+  serialized_start=458,
+  serialized_end=520,
 )
+_sym_db.RegisterEnumDescriptor(_SCREENFONTS)
+
+ScreenFonts = enum_type_wrapper.EnumTypeWrapper(_SCREENFONTS)
+FONT_SMALL = 0
+FONT_MEDIUM = 1
+FONT_LARGE = 2
 
-_LEGACYRADIOCONFIG = _descriptor.Descriptor(
-  name='LegacyRadioConfig',
-  full_name='LegacyRadioConfig',
-  filename=None,
-  file=DESCRIPTOR,
-  containing_type=None,
-  fields=[
-    _descriptor.FieldDescriptor(
-      name='preferences', full_name='LegacyRadioConfig.preferences', index=0,
-      number=1, type=11, cpp_type=10, label=1,
-      has_default_value=False, default_value=None,
-      message_type=None, enum_type=None, containing_type=None,
-      is_extension=False, extension_scope=None,
-      serialized_options=None, file=DESCRIPTOR),
-  ],
-  extensions=[
-  ],
-  nested_types=[_LEGACYRADIOCONFIG_LEGACYPREFERENCES, ],
-  enum_types=[
-  ],
-  serialized_options=None,
-  is_extendable=False,
-  syntax='proto3',
-  extension_ranges=[],
-  oneofs=[
-  ],
-  serialized_start=67,
-  serialized_end=195,
-)
 
 
 _DEVICESTATE = _descriptor.Descriptor(
@@ -97,63 +66,56 @@ _DEVICESTATE = _descriptor.Descriptor(
   containing_type=None,
   fields=[
     _descriptor.FieldDescriptor(
-      name='legacyRadio', full_name='DeviceState.legacyRadio', index=0,
-      number=1, type=11, cpp_type=10, label=1,
-      has_default_value=False, default_value=None,
-      message_type=None, enum_type=None, containing_type=None,
-      is_extension=False, extension_scope=None,
-      serialized_options=None, file=DESCRIPTOR),
-    _descriptor.FieldDescriptor(
-      name='my_node', full_name='DeviceState.my_node', index=1,
+      name='my_node', full_name='DeviceState.my_node', index=0,
       number=2, type=11, cpp_type=10, label=1,
       has_default_value=False, default_value=None,
       message_type=None, enum_type=None, containing_type=None,
       is_extension=False, extension_scope=None,
       serialized_options=None, file=DESCRIPTOR),
     _descriptor.FieldDescriptor(
-      name='owner', full_name='DeviceState.owner', index=2,
+      name='owner', full_name='DeviceState.owner', index=1,
       number=3, type=11, cpp_type=10, label=1,
       has_default_value=False, default_value=None,
       message_type=None, enum_type=None, containing_type=None,
       is_extension=False, extension_scope=None,
       serialized_options=None, file=DESCRIPTOR),
     _descriptor.FieldDescriptor(
-      name='node_db', full_name='DeviceState.node_db', index=3,
+      name='node_db', full_name='DeviceState.node_db', index=2,
       number=4, type=11, cpp_type=10, label=3,
       has_default_value=False, default_value=[],
       message_type=None, enum_type=None, containing_type=None,
       is_extension=False, extension_scope=None,
       serialized_options=None, file=DESCRIPTOR),
     _descriptor.FieldDescriptor(
-      name='receive_queue', full_name='DeviceState.receive_queue', index=4,
+      name='receive_queue', full_name='DeviceState.receive_queue', index=3,
       number=5, type=11, cpp_type=10, label=3,
       has_default_value=False, default_value=[],
       message_type=None, enum_type=None, containing_type=None,
       is_extension=False, extension_scope=None,
       serialized_options=None, file=DESCRIPTOR),
     _descriptor.FieldDescriptor(
-      name='version', full_name='DeviceState.version', index=5,
+      name='version', full_name='DeviceState.version', index=4,
       number=8, type=13, cpp_type=3, label=1,
       has_default_value=False, default_value=0,
       message_type=None, enum_type=None, containing_type=None,
       is_extension=False, extension_scope=None,
       serialized_options=None, file=DESCRIPTOR),
     _descriptor.FieldDescriptor(
-      name='rx_text_message', full_name='DeviceState.rx_text_message', index=6,
+      name='rx_text_message', full_name='DeviceState.rx_text_message', index=5,
       number=7, type=11, cpp_type=10, label=1,
       has_default_value=False, default_value=None,
       message_type=None, enum_type=None, containing_type=None,
       is_extension=False, extension_scope=None,
       serialized_options=None, file=DESCRIPTOR),
     _descriptor.FieldDescriptor(
-      name='no_save', full_name='DeviceState.no_save', index=7,
+      name='no_save', full_name='DeviceState.no_save', index=6,
       number=9, type=8, cpp_type=7, label=1,
       has_default_value=False, default_value=False,
       message_type=None, enum_type=None, containing_type=None,
       is_extension=False, extension_scope=None,
       serialized_options=None, file=DESCRIPTOR),
     _descriptor.FieldDescriptor(
-      name='did_gps_reset', full_name='DeviceState.did_gps_reset', index=8,
+      name='did_gps_reset', full_name='DeviceState.did_gps_reset', index=7,
       number=11, type=8, cpp_type=7, label=1,
       has_default_value=False, default_value=False,
       message_type=None, enum_type=None, containing_type=None,
@@ -171,8 +133,8 @@ _DEVICESTATE = _descriptor.Descriptor(
   extension_ranges=[],
   oneofs=[
   ],
-  serialized_start=198,
-  serialized_end=469,
+  serialized_start=48,
+  serialized_end=278,
 )
 
 
@@ -202,40 +164,82 @@ _CHANNELFILE = _descriptor.Descriptor(
   extension_ranges=[],
   oneofs=[
   ],
-  serialized_start=471,
-  serialized_end=512,
+  serialized_start=280,
+  serialized_end=321,
+)
+
+
+_OEMSTORE = _descriptor.Descriptor(
+  name='OEMStore',
+  full_name='OEMStore',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='oem_icon_width', full_name='OEMStore.oem_icon_width', index=0,
+      number=1, type=13, cpp_type=3, label=1,
+      has_default_value=False, default_value=0,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='oem_icon_height', full_name='OEMStore.oem_icon_height', index=1,
+      number=2, type=13, cpp_type=3, label=1,
+      has_default_value=False, default_value=0,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='oem_icon_bits', full_name='OEMStore.oem_icon_bits', index=2,
+      number=3, type=12, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"",
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='oem_font', full_name='OEMStore.oem_font', index=3,
+      number=4, type=14, cpp_type=8, label=1,
+      has_default_value=False, default_value=0,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+    _descriptor.FieldDescriptor(
+      name='oem_text', full_name='OEMStore.oem_text', index=4,
+      number=5, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=324,
+  serialized_end=456,
 )
 
-_LEGACYRADIOCONFIG_LEGACYPREFERENCES.fields_by_name['region'].enum_type = radioconfig__pb2._REGIONCODE
-_LEGACYRADIOCONFIG_LEGACYPREFERENCES.containing_type = _LEGACYRADIOCONFIG
-_LEGACYRADIOCONFIG.fields_by_name['preferences'].message_type = _LEGACYRADIOCONFIG_LEGACYPREFERENCES
-_DEVICESTATE.fields_by_name['legacyRadio'].message_type = _LEGACYRADIOCONFIG
 _DEVICESTATE.fields_by_name['my_node'].message_type = mesh__pb2._MYNODEINFO
 _DEVICESTATE.fields_by_name['owner'].message_type = mesh__pb2._USER
 _DEVICESTATE.fields_by_name['node_db'].message_type = mesh__pb2._NODEINFO
 _DEVICESTATE.fields_by_name['receive_queue'].message_type = mesh__pb2._MESHPACKET
 _DEVICESTATE.fields_by_name['rx_text_message'].message_type = mesh__pb2._MESHPACKET
 _CHANNELFILE.fields_by_name['channels'].message_type = channel__pb2._CHANNEL
-DESCRIPTOR.message_types_by_name['LegacyRadioConfig'] = _LEGACYRADIOCONFIG
+_OEMSTORE.fields_by_name['oem_font'].enum_type = _SCREENFONTS
 DESCRIPTOR.message_types_by_name['DeviceState'] = _DEVICESTATE
 DESCRIPTOR.message_types_by_name['ChannelFile'] = _CHANNELFILE
+DESCRIPTOR.message_types_by_name['OEMStore'] = _OEMSTORE
+DESCRIPTOR.enum_types_by_name['ScreenFonts'] = _SCREENFONTS
 _sym_db.RegisterFileDescriptor(DESCRIPTOR)
 
-LegacyRadioConfig = _reflection.GeneratedProtocolMessageType('LegacyRadioConfig', (_message.Message,), {
-
-  'LegacyPreferences' : _reflection.GeneratedProtocolMessageType('LegacyPreferences', (_message.Message,), {
-    'DESCRIPTOR' : _LEGACYRADIOCONFIG_LEGACYPREFERENCES,
-    '__module__' : 'deviceonly_pb2'
-    # @@protoc_insertion_point(class_scope:LegacyRadioConfig.LegacyPreferences)
-    })
-  ,
-  'DESCRIPTOR' : _LEGACYRADIOCONFIG,
-  '__module__' : 'deviceonly_pb2'
-  # @@protoc_insertion_point(class_scope:LegacyRadioConfig)
-  })
-_sym_db.RegisterMessage(LegacyRadioConfig)
-_sym_db.RegisterMessage(LegacyRadioConfig.LegacyPreferences)
-
 DeviceState = _reflection.GeneratedProtocolMessageType('DeviceState', (_message.Message,), {
   'DESCRIPTOR' : _DEVICESTATE,
   '__module__' : 'deviceonly_pb2'
@@ -250,6 +254,13 @@ ChannelFile = _reflection.GeneratedProtocolMessageType('ChannelFile', (_message.
   })
 _sym_db.RegisterMessage(ChannelFile)
 
+OEMStore = _reflection.GeneratedProtocolMessageType('OEMStore', (_message.Message,), {
+  'DESCRIPTOR' : _OEMSTORE,
+  '__module__' : 'deviceonly_pb2'
+  # @@protoc_insertion_point(class_scope:OEMStore)
+  })
+_sym_db.RegisterMessage(OEMStore)
+
 
 DESCRIPTOR._options = None
 # @@protoc_insertion_point(module_scope)

meshtastic/environmental_measurement_pb2.py

@@ -1,83 +0,0 @@
-# -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: environmental_measurement.proto
-
-from google.protobuf import descriptor as _descriptor
-from google.protobuf import message as _message
-from google.protobuf import reflection as _reflection
-from google.protobuf import symbol_database as _symbol_database
-# @@protoc_insertion_point(imports)
-
-_sym_db = _symbol_database.Default()
-
-
-
-
-DESCRIPTOR = _descriptor.FileDescriptor(
-  name='environmental_measurement.proto',
-  package='',
-  syntax='proto3',
-  serialized_options=b'Z!github.com/meshtastic/gomeshproto',
-  serialized_pb=b'\n\x1f\x65nvironmental_measurement.proto\"g\n\x18\x45nvironmentalMeasurement\x12\x13\n\x0btemperature\x18\x01 \x01(\x02\x12\x19\n\x11relative_humidity\x18\x02 \x01(\x02\x12\x1b\n\x13\x62\x61rometric_pressure\x18\x03 \x01(\x02\x42#Z!github.com/meshtastic/gomeshprotob\x06proto3'
-)
-
-
-
-
-_ENVIRONMENTALMEASUREMENT = _descriptor.Descriptor(
-  name='EnvironmentalMeasurement',
-  full_name='EnvironmentalMeasurement',
-  filename=None,
-  file=DESCRIPTOR,
-  containing_type=None,
-  fields=[
-    _descriptor.FieldDescriptor(
-      name='temperature', full_name='EnvironmentalMeasurement.temperature', index=0,
-      number=1, type=2, cpp_type=6, label=1,
-      has_default_value=False, default_value=float(0),
-      message_type=None, enum_type=None, containing_type=None,
-      is_extension=False, extension_scope=None,
-      serialized_options=None, file=DESCRIPTOR),
-    _descriptor.FieldDescriptor(
-      name='relative_humidity', full_name='EnvironmentalMeasurement.relative_humidity', index=1,
-      number=2, type=2, cpp_type=6, label=1,
-      has_default_value=False, default_value=float(0),
-      message_type=None, enum_type=None, containing_type=None,
-      is_extension=False, extension_scope=None,
-      serialized_options=None, file=DESCRIPTOR),
-    _descriptor.FieldDescriptor(
-      name='barometric_pressure', full_name='EnvironmentalMeasurement.barometric_pressure', index=2,
-      number=3, type=2, cpp_type=6, label=1,
-      has_default_value=False, default_value=float(0),
-      message_type=None, enum_type=None, containing_type=None,
-      is_extension=False, extension_scope=None,
-      serialized_options=None, file=DESCRIPTOR),
-  ],
-  extensions=[
-  ],
-  nested_types=[],
-  enum_types=[
-  ],
-  serialized_options=None,
-  is_extendable=False,
-  syntax='proto3',
-  extension_ranges=[],
-  oneofs=[
-  ],
-  serialized_start=35,
-  serialized_end=138,
-)
-
-DESCRIPTOR.message_types_by_name['EnvironmentalMeasurement'] = _ENVIRONMENTALMEASUREMENT
-_sym_db.RegisterFileDescriptor(DESCRIPTOR)
-
-EnvironmentalMeasurement = _reflection.GeneratedProtocolMessageType('EnvironmentalMeasurement', (_message.Message,), {
-  'DESCRIPTOR' : _ENVIRONMENTALMEASUREMENT,
-  '__module__' : 'environmental_measurement_pb2'
-  # @@protoc_insertion_point(class_scope:EnvironmentalMeasurement)
-  })
-_sym_db.RegisterMessage(EnvironmentalMeasurement)
-
-
-DESCRIPTOR._options = None
-# @@protoc_insertion_point(module_scope)

meshtastic/globals.py

@@ -27,16 +27,21 @@ class Globals:
             Globals.__instance = self
         self.args = None
         self.parser = None
-        self.target_node = None
         self.channel_index = None
         self.logfile = None
+        self.tunnelInstance = None
+        # TODO: to migrate to camel_case for v1.3 change this value to True
+        self.camel_case = False
 
     def reset(self):
         """Reset all of our globals. If you add a member, add it to this method, too."""
         self.args = None
         self.parser = None
-        self.target_node = None
         self.channel_index = None
+        self.logfile = None
+        self.tunnelInstance = None
+        # TODO: to migrate to camel_case for v1.3 change this value to True
+        self.camel_case = False
 
     # setters
     def set_args(self, args):
@@ -47,10 +52,6 @@ class Globals:
         """Set the parser"""
         self.parser = parser
 
-    def set_target_node(self, target_node):
-        """Set the target_node"""
-        self.target_node = target_node
-
     def set_channel_index(self, channel_index):
         """Set the channel_index"""
         self.channel_index = channel_index
@@ -59,6 +60,14 @@ class Globals:
         """Set the logfile"""
         self.logfile = logfile
 
+    def set_tunnelInstance(self, tunnelInstance):
+        """Set the tunnelInstance"""
+        self.tunnelInstance = tunnelInstance
+
+    def set_camel_case(self):
+        """Force using camelCase for things like prefs/set/set"""
+        self.camel_case = True
+
     # getters
     def get_args(self):
         """Get args"""
@@ -68,10 +77,6 @@ class Globals:
         """Get parser"""
         return self.parser
 
-    def get_target_node(self):
-        """Get target_node"""
-        return self.target_node
-
     def get_channel_index(self):
         """Get channel_index"""
         return self.channel_index
@@ -79,3 +84,11 @@ class Globals:
     def get_logfile(self):
         """Get logfile"""
         return self.logfile
+
+    def get_tunnelInstance(self):
+        """Get tunnelInstance"""
+        return self.tunnelInstance
+
+    def get_camel_case(self):
+        """Get whether or not to use camelCase"""
+        return self.camel_case

meshtastic/mesh_interface.py

@@ -17,9 +17,9 @@ from google.protobuf.json_format import MessageToJson
 
 
 import meshtastic.node
-from . import portnums_pb2, mesh_pb2
-from .util import stripnl, Timeout, our_exit
-from .__init__ import LOCAL_ADDR, BROADCAST_NUM, BROADCAST_ADDR, ResponseHandler, publishingThread, OUR_APP_VERSION, protocols
+from meshtastic import portnums_pb2, mesh_pb2
+from meshtastic.util import stripnl, Timeout, our_exit, remove_keys_from_dict, convert_mac_addr
+from meshtastic.__init__ import LOCAL_ADDR, BROADCAST_NUM, BROADCAST_ADDR, ResponseHandler, publishingThread, OUR_APP_VERSION, protocols
 
 class MeshInterface:
     """Interface class for meshtastic devices
@@ -68,13 +68,12 @@ class MeshInterface:
 
     def __exit__(self, exc_type, exc_value, traceback):
         if exc_type is not None and exc_value is not None:
-            logging.error(
-                f'An exception of type {exc_type} with value {exc_value} has occurred')
+            logging.error(f'An exception of type {exc_type} with value {exc_value} has occurred')
         if traceback is not None:
             logging.error(f'Traceback: {traceback}')
         self.close()
 
-    def showInfo(self, file=sys.stdout):
+    def showInfo(self, file=sys.stdout): # pylint: disable=W0613
         """Show human readable summary about this object"""
         owner = f"Owner: {self.getLongName()} ({self.getShortName()})"
         myinfo = ''
@@ -84,12 +83,24 @@ class MeshInterface:
         nodes = ""
         if self.nodes:
             for n in self.nodes.values():
-                nodes = nodes + f"  {stripnl(n)}"
+                # when the TBeam is first booted, it sometimes shows the raw data
+                # so, we will just remove any raw keys
+                keys_to_remove = ('raw', 'decoded', 'payload')
+                n2 = remove_keys_from_dict(keys_to_remove, n)
+
+                # if we have 'macaddr', re-format it
+                if 'macaddr' in n2['user']:
+                    val = n2['user']['macaddr']
+                    # decode the base64 value
+                    addr = convert_mac_addr(val)
+                    n2['user']['macaddr'] = addr
+
+                nodes = nodes + f"  {stripnl(n2)}"
         infos = owner + myinfo + mesh + nodes
         print(infos)
         return infos
 
-    def showNodes(self, includeSelf=True, file=sys.stdout):
+    def showNodes(self, includeSelf=True, file=sys.stdout): # pylint: disable=W0613
         """Show table summary of nodes in mesh"""
         def formatFloat(value, precision=2, unit=''):
             """Format a float value with precsion."""
@@ -148,7 +159,7 @@ class MeshInterface:
 
     def getNode(self, nodeId):
         """Return a node object which contains device settings and channel info"""
-        if nodeId == LOCAL_ADDR:
+        if nodeId in (LOCAL_ADDR, BROADCAST_ADDR):
             return self.localNode
         else:
             n = meshtastic.node.Node(self, nodeId)
@@ -243,11 +254,12 @@ class MeshInterface:
         meshPacket.decoded.payload = data
         meshPacket.decoded.portnum = portNum
         meshPacket.decoded.want_response = wantResponse
+        meshPacket.id = self._generatePacketId()
 
+        if onResponse is not None:
+            self._addResponseHandler(meshPacket.id, onResponse)
         p = self._sendPacket(meshPacket, destinationId,
                              wantAck=wantAck, hopLimit=hopLimit)
-        if onResponse is not None:
-            self._addResponseHandler(p.id, onResponse)
         return p
 
     def sendPosition(self, latitude=0.0, longitude=0.0, altitude=0, timeSec=0,
@@ -382,11 +394,11 @@ class MeshInterface:
             return user.get('shortName', None)
         return None
 
-    def _waitConnected(self):
+    def _waitConnected(self, timeout=15.0):
         """Block until the initial node db download is complete, or timeout
         and raise an exception"""
         if not self.noProto:
-            if not self.isConnected.wait(15.0):  # timeout after x seconds
+            if not self.isConnected.wait(timeout):  # timeout after x seconds
                 raise Exception("Timed out waiting for connection completion")
 
         # If we failed while connecting, raise the connection to the client
@@ -404,8 +416,7 @@ class MeshInterface:
     def _disconnected(self):
         """Called by subclasses to tell clients this interface has disconnected"""
         self.isConnected.clear()
-        publishingThread.queueWork(lambda: pub.sendMessage(
-            "meshtastic.connection.lost", interface=self))
+        publishingThread.queueWork(lambda: pub.sendMessage("meshtastic.connection.lost", interface=self))
 
     def _startHeartbeat(self):
         """We need to send a heartbeat message to the device every X seconds"""
@@ -431,8 +442,7 @@ class MeshInterface:
         if not self.isConnected.is_set():
             self.isConnected.set()
             self._startHeartbeat()
-            publishingThread.queueWork(lambda: pub.sendMessage(
-                "meshtastic.connection.established", interface=self))
+            publishingThread.queueWork(lambda: pub.sendMessage("meshtastic.connection.established", interface=self))
 
     def _startConfig(self):
         """Start device packets flowing"""
@@ -504,7 +514,8 @@ class MeshInterface:
         elif fromRadio.HasField("node_info"):
             node = asDict["nodeInfo"]
             try:
-                self._fixupPosition(node["position"])
+                newpos = self._fixupPosition(node["position"])
+                node["position"] = newpos
             except:
                 logging.debug("Node without position")
 
@@ -536,12 +547,14 @@ class MeshInterface:
         """Convert integer lat/lon into floats
 
         Arguments:
-            position {Position dictionary} -- object ot fix up
+            position {Position dictionary} -- object to fix up
+        Returns the position with the updated keys
         """
         if "latitudeI" in position:
             position["latitude"] = position["latitudeI"] * 1e-7
         if "longitudeI" in position:
             position["longitude"] = position["longitudeI"] * 1e-7
+        return position
 
     def _nodeNumToId(self, num):
         """Map a node node number to a node ID
@@ -619,11 +632,13 @@ class MeshInterface:
         # asObj = DotMap(asDict)
         topic = "meshtastic.receive"  # Generic unknown packet type
 
-        decoded = asDict["decoded"]
-        # The default MessageToDict converts byte arrays into base64 strings.
-        # We don't want that - it messes up data payload.  So slam in the correct
-        # byte array.
-        decoded["payload"] = meshPacket.decoded.payload
+        decoded = None
+        if 'decoded' in asDict:
+            decoded = asDict["decoded"]
+            # The default MessageToDict converts byte arrays into base64 strings.
+            # We don't want that - it messes up data payload.  So slam in the correct
+            # byte array.
+            decoded["payload"] = meshPacket.decoded.payload
 
         # UNKNOWN_APP is the default protobuf portnum value, and therefore if not
         # set it will not be populated at all to make API usage easier, set

meshtastic/node.py

@@ -3,11 +3,10 @@
 
 import logging
 import base64
+import time
 from google.protobuf.json_format import MessageToJson
-from . import portnums_pb2, apponly_pb2, admin_pb2, channel_pb2
-from .util import pskToString, stripnl, Timeout, our_exit, fromPSK
-
-
+from meshtastic import portnums_pb2, apponly_pb2, admin_pb2, channel_pb2
+from meshtastic.util import pskToString, stripnl, Timeout, our_exit, fromPSK
 
 
 class Node:
@@ -26,6 +25,15 @@ class Node:
         self.partialChannels = None
         self.noProto = noProto
 
+        self.cannedPluginMessage = None
+
+        self.cannedPluginMessagePart1 = None
+        self.cannedPluginMessagePart2 = None
+        self.cannedPluginMessagePart3 = None
+        self.cannedPluginMessagePart4 = None
+
+        self.gotResponse = None
+
     def showChannels(self):
         """Show human readable description of our channels."""
         print("Channels:")
@@ -58,6 +66,14 @@ class Node:
         self.channels = None
         self.partialChannels = []  # We keep our channels in a temp array until finished
 
+        # Note: We do not get the canned plugin message, unless get_canned_message() is called
+        self.cannedPluginMessage = None
+
+        self.cannedPluginMessagePart1 = None
+        self.cannedPluginMessagePart2 = None
+        self.cannedPluginMessagePart3 = None
+        self.cannedPluginMessagePart4 = None
+
         self._requestSettings()
 
     def turnOffEncryptionOnPrimaryChannel(self):
@@ -66,9 +82,9 @@ class Node:
         print("Writing modified channels to device")
         self.writeChannel(0)
 
-    def waitForConfig(self):
+    def waitForConfig(self, attribute='channels'):
         """Block until radio config is received. Returns True if config has been received."""
-        return self._timeout.waitForSet(self, attrs=('radioConfig', 'channels'))
+        return self._timeout.waitForSet(self, attrs=('radioConfig', attribute))
 
     def writeConfig(self):
         """Write the current (edited) radioConfig to the device"""
@@ -239,7 +255,7 @@ class Node:
         """Handle the response packet for requesting settings _requestSettings()"""
         logging.debug(f'onResponseRequestSetting() p:{p}')
         errorFound = False
-        if 'routing' in p["decoded"]:
+        if "routing" in p["decoded"]:
             if p["decoded"]["routing"]["errorReason"] != "NONE":
                 errorFound = True
                 print(f'Error on response: {p["decoded"]["routing"]["errorReason"]}')
@@ -257,6 +273,7 @@ class Node:
         p = admin_pb2.AdminMessage()
         p.get_radio_request = True
 
+        # TODO: should we check that localNode has an 'admin' channel?
         # Show progress message for super slow operations
         if self != self.iface.localNode:
             print("Requesting preferences from remote node.")
@@ -269,6 +286,156 @@ class Node:
 
         return self._sendAdmin(p, wantResponse=True, onResponse=self.onResponseRequestSettings)
 
+    def onResponseRequestCannedMessagePluginMessagePart1(self, p):
+        """Handle the response packet for requesting canned message plugin message part 1"""
+        logging.debug(f'onResponseRequestCannedMessagePluginMessagePart1() p:{p}')
+        errorFound = False
+        if "routing" in p["decoded"]:
+            if p["decoded"]["routing"]["errorReason"] != "NONE":
+                errorFound = True
+                print(f'Error on response: {p["decoded"]["routing"]["errorReason"]}')
+        if errorFound is False:
+            if "decoded" in p:
+                if "admin" in p["decoded"]:
+                    if "raw" in p["decoded"]["admin"]:
+                        self.cannedPluginMessagePart1 = p["decoded"]["admin"]["raw"].get_canned_message_module_part1_response
+                        logging.debug(f'self.cannedPluginMessagePart1:{self.cannedPluginMessagePart1}')
+                        self.gotResponse = True
+
+    def onResponseRequestCannedMessagePluginMessagePart2(self, p):
+        """Handle the response packet for requesting canned message plugin message part 2"""
+        logging.debug(f'onResponseRequestCannedMessagePluginMessagePart2() p:{p}')
+        errorFound = False
+        if "routing" in p["decoded"]:
+            if p["decoded"]["routing"]["errorReason"] != "NONE":
+                errorFound = True
+                print(f'Error on response: {p["decoded"]["routing"]["errorReason"]}')
+        if errorFound is False:
+            if "decoded" in p:
+                if "admin" in p["decoded"]:
+                    if "raw" in p["decoded"]["admin"]:
+                        self.cannedPluginMessagePart2 = p["decoded"]["admin"]["raw"].get_canned_message_module_part2_response
+                        logging.debug(f'self.cannedPluginMessagePart2:{self.cannedPluginMessagePart2}')
+                        self.gotResponse = True
+
+    def onResponseRequestCannedMessagePluginMessagePart3(self, p):
+        """Handle the response packet for requesting canned message plugin message part 3"""
+        logging.debug(f'onResponseRequestCannedMessagePluginMessagePart3() p:{p}')
+        errorFound = False
+        if "routing" in p["decoded"]:
+            if p["decoded"]["routing"]["errorReason"] != "NONE":
+                errorFound = True
+                print(f'Error on response: {p["decoded"]["routing"]["errorReason"]}')
+        if errorFound is False:
+            if "decoded" in p:
+                if "admin" in p["decoded"]:
+                    if "raw" in p["decoded"]["admin"]:
+                        self.cannedPluginMessagePart3 = p["decoded"]["admin"]["raw"].get_canned_message_module_part3_response
+                        logging.debug(f'self.cannedPluginMessagePart3:{self.cannedPluginMessagePart3}')
+                        self.gotResponse = True
+
+    def onResponseRequestCannedMessagePluginMessagePart4(self, p):
+        """Handle the response packet for requesting canned message plugin message part 4"""
+        logging.debug(f'onResponseRequestCannedMessagePluginMessagePart4() p:{p}')
+        errorFound = False
+        if "routing" in p["decoded"]:
+            if p["decoded"]["routing"]["errorReason"] != "NONE":
+                errorFound = True
+                print(f'Error on response: {p["decoded"]["routing"]["errorReason"]}')
+        if errorFound is False:
+            if "decoded" in p:
+                if "admin" in p["decoded"]:
+                    if "raw" in p["decoded"]["admin"]:
+                        self.cannedPluginMessagePart4 = p["decoded"]["admin"]["raw"].get_canned_message_module_part4_response
+                        logging.debug(f'self.cannedPluginMessagePart4:{self.cannedPluginMessagePart4}')
+                        self.gotResponse = True
+
+    def get_canned_message(self):
+        """Get the canned message string. Concatenate all pieces together and return a single string."""
+        logging.debug(f'in get_canned_message()')
+        if not self.cannedPluginMessage:
+
+            p1 = admin_pb2.AdminMessage()
+            p1.get_canned_message_module_part1_request = True
+            self.gotResponse = False
+            self._sendAdmin(p1, wantResponse=True, onResponse=self.onResponseRequestCannedMessagePluginMessagePart1)
+            while self.gotResponse is False:
+                time.sleep(0.1)
+
+            p2 = admin_pb2.AdminMessage()
+            p2.get_canned_message_module_part2_request = True
+            self.gotResponse = False
+            self._sendAdmin(p2, wantResponse=True, onResponse=self.onResponseRequestCannedMessagePluginMessagePart2)
+            while self.gotResponse is False:
+                time.sleep(0.1)
+
+            p3 = admin_pb2.AdminMessage()
+            p3.get_canned_message_module_part3_request = True
+            self.gotResponse = False
+            self._sendAdmin(p3, wantResponse=True, onResponse=self.onResponseRequestCannedMessagePluginMessagePart3)
+            while self.gotResponse is False:
+                time.sleep(0.1)
+
+            p4 = admin_pb2.AdminMessage()
+            p4.get_canned_message_module_part4_request = True
+            self.gotResponse = False
+            self._sendAdmin(p4, wantResponse=True, onResponse=self.onResponseRequestCannedMessagePluginMessagePart4)
+            while self.gotResponse is False:
+                time.sleep(0.1)
+
+            # TODO: This feels wrong to have a sleep here. Is there a way to ensure that
+            # all requests are complete? Perhaps change to a while loop any parts are None... maybe?
+            time.sleep(3)
+
+            logging.debug(f'self.cannedPluginMessagePart1:{self.cannedPluginMessagePart1}')
+            logging.debug(f'self.cannedPluginMessagePart2:{self.cannedPluginMessagePart2}')
+            logging.debug(f'self.cannedPluginMessagePart3:{self.cannedPluginMessagePart3}')
+            logging.debug(f'self.cannedPluginMessagePart4:{self.cannedPluginMessagePart4}')
+
+            self.cannedPluginMessage = ""
+            if self.cannedPluginMessagePart1:
+                self.cannedPluginMessage += self.cannedPluginMessagePart1
+            if self.cannedPluginMessagePart2:
+                self.cannedPluginMessage += self.cannedPluginMessagePart2
+            if self.cannedPluginMessagePart3:
+                self.cannedPluginMessage += self.cannedPluginMessagePart3
+            if self.cannedPluginMessagePart4:
+                self.cannedPluginMessage += self.cannedPluginMessagePart4
+
+        print(f'canned_plugin_message:{self.cannedPluginMessage}')
+        logging.debug(f'canned_plugin_message:{self.cannedPluginMessage}')
+        return self.cannedPluginMessage
+
+    def set_canned_message(self, message):
+        """Set the canned message. Split into parts of 200 chars each."""
+
+        if len(message) > 800:
+            our_exit("Warning: The canned message must be less than 800 characters.")
+
+        # split into chunks
+        chunks = []
+        chunks_size = 200
+        for i in range(0, len(message), chunks_size):
+            chunks.append(message[i: i + chunks_size])
+
+        # for each chunk, send a message to set the values
+        #for i in range(0, len(chunks)):
+        for i, chunk in enumerate(chunks):
+            p = admin_pb2.AdminMessage()
+
+            # TODO: should be a way to improve this
+            if i == 0:
+                p.set_canned_message_module_part1 = chunk
+            elif i == 1:
+                p.set_canned_message_module_part2 = chunk
+            elif i == 2:
+                p.set_canned_message_module_part3 = chunk
+            elif i == 3:
+                p.set_canned_message_module_part4 = chunk
+
+            logging.debug(f"Setting canned message '{chunk}' part {i+1}")
+            self._sendAdmin(p)
+
     def exitSimulator(self):
         """Tell a simulator node to exit (this message
            is ignored for other nodes)"""
@@ -286,6 +453,14 @@ class Node:
 
         return self._sendAdmin(p)
 
+    def shutdown(self, secs: int = 10):
+        """Tell the node to shutdown."""
+        p = admin_pb2.AdminMessage()
+        p.shutdown_seconds = secs
+        logging.info(f"Telling node to shutdown in {secs} seconds")
+
+        return self._sendAdmin(p)
+
     def _fixupChannels(self):
         """Fixup indexes and add disabled channels as needed"""
 

meshtastic/portnums_pb2.py

@@ -19,7 +19,7 @@ DESCRIPTOR = _descriptor.FileDescriptor(
   package='',
   syntax='proto3',
   serialized_options=b'\n\023com.geeksville.meshB\010PortnumsH\003Z!github.com/meshtastic/gomeshproto',
-  serialized_pb=b'\n\x0eportnums.proto*\xcb\x02\n\x07PortNum\x12\x0f\n\x0bUNKNOWN_APP\x10\x00\x12\x14\n\x10TEXT_MESSAGE_APP\x10\x01\x12\x17\n\x13REMOTE_HARDWARE_APP\x10\x02\x12\x10\n\x0cPOSITION_APP\x10\x03\x12\x10\n\x0cNODEINFO_APP\x10\x04\x12\x0f\n\x0bROUTING_APP\x10\x05\x12\r\n\tADMIN_APP\x10\x06\x12\r\n\tREPLY_APP\x10 \x12\x11\n\rIP_TUNNEL_APP\x10!\x12\x0e\n\nSERIAL_APP\x10@\x12\x15\n\x11STORE_FORWARD_APP\x10\x41\x12\x12\n\x0eRANGE_TEST_APP\x10\x42\x12!\n\x1d\x45NVIRONMENTAL_MEASUREMENT_APP\x10\x43\x12\x0b\n\x07ZPS_APP\x10\x44\x12\x10\n\x0bPRIVATE_APP\x10\x80\x02\x12\x13\n\x0e\x41TAK_FORWARDER\x10\x81\x02\x12\x08\n\x03MAX\x10\xff\x03\x42\x44\n\x13\x63om.geeksville.meshB\x08PortnumsH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3'
+  serialized_pb=b'\n\x0eportnums.proto*\xbb\x02\n\x07PortNum\x12\x0f\n\x0bUNKNOWN_APP\x10\x00\x12\x14\n\x10TEXT_MESSAGE_APP\x10\x01\x12\x17\n\x13REMOTE_HARDWARE_APP\x10\x02\x12\x10\n\x0cPOSITION_APP\x10\x03\x12\x10\n\x0cNODEINFO_APP\x10\x04\x12\x0f\n\x0bROUTING_APP\x10\x05\x12\r\n\tADMIN_APP\x10\x06\x12\r\n\tREPLY_APP\x10 \x12\x11\n\rIP_TUNNEL_APP\x10!\x12\x0e\n\nSERIAL_APP\x10@\x12\x15\n\x11STORE_FORWARD_APP\x10\x41\x12\x12\n\x0eRANGE_TEST_APP\x10\x42\x12\x11\n\rTELEMETRY_APP\x10\x43\x12\x0b\n\x07ZPS_APP\x10\x44\x12\x10\n\x0bPRIVATE_APP\x10\x80\x02\x12\x13\n\x0e\x41TAK_FORWARDER\x10\x81\x02\x12\x08\n\x03MAX\x10\xff\x03\x42\x44\n\x13\x63om.geeksville.meshB\x08PortnumsH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3'
 )
 
 _PORTNUM = _descriptor.EnumDescriptor(
@@ -77,7 +77,7 @@ _PORTNUM = _descriptor.EnumDescriptor(
       serialized_options=None,
       type=None),
     _descriptor.EnumValueDescriptor(
-      name='ENVIRONMENTAL_MEASUREMENT_APP', index=12, number=67,
+      name='TELEMETRY_APP', index=12, number=67,
       serialized_options=None,
       type=None),
     _descriptor.EnumValueDescriptor(
@@ -100,7 +100,7 @@ _PORTNUM = _descriptor.EnumDescriptor(
   containing_type=None,
   serialized_options=None,
   serialized_start=19,
-  serialized_end=350,
+  serialized_end=334,
 )
 _sym_db.RegisterEnumDescriptor(_PORTNUM)
 
@@ -117,7 +117,7 @@ IP_TUNNEL_APP = 33
 SERIAL_APP = 64
 STORE_FORWARD_APP = 65
 RANGE_TEST_APP = 66
-ENVIRONMENTAL_MEASUREMENT_APP = 67
+TELEMETRY_APP = 67
 ZPS_APP = 68
 PRIVATE_APP = 256
 ATAK_FORWARDER = 257