Merge branch 'master' into node-favorites

Author: dandrzejewski

.github/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing to Meshtastic Python
+
+## Development resources
+- [API Documentation](https://python.meshtastic.org/)
+- [Meshtastic Python Development](https://meshtastic.org/docs/development/python/)
+- [Building Meshtastic Python](https://meshtastic.org/docs/development/python/building/)
+- [Using the Meshtastic Python Library](https://meshtastic.org/docs/development/python/library/)
+
+## How to check your code (pytest/pylint) before a PR
+- [Pre-requisites](https://meshtastic.org/docs/development/python/building/#pre-requisites)
+- also execute `poetry install --all-extras --with dev,powermon` for all optional dependencies
+- check your code with github ci actions locally
+    - You need to have act installed. You can get it at https://nektosact.com/ 
+    - on linux: `act -P ubuntu-latest=-self-hosted --matrix "python-version:3.12"`
+    - on windows:
+      - linux checks (linux docker): `act --matrix "python-version:3.12"`
+      - windows checks (windows host): `act -P ubuntu-latest=-self-hosted --matrix "python-version:3.12"`
+- or run all locally:
+    - run `poetry run pylint meshtastic examples/ --ignore-patterns ".*_pb2.pyi?$"`
+    - run `poetry run mypy meshtastic/`
+    - run `poetry run pytest`
+    - more commands see [CI workflow](https://github.com/meshtastic/python/blob/master/.github/workflows/ci.yml)

.github/meshtastic_logo.png

@@ -17,4 +17,5 @@ examples/__pycache__
 meshtastic.spec
 .hypothesis/
 coverage.xml
-.ipynb_checkpoints
+.ipynb_checkpoints
+.cursor/

.gitignore

@@ -4,6 +4,7 @@
   // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
+
     {
       "name": "meshtastic BLE",
       "type": "debugpy",
@@ -261,7 +262,14 @@
       "module": "meshtastic",
       "justMyCode": true,
       "args": ["--nodes", "--show-fields", "AKA,Pubkey,Role,Role,Role,Latitude,Latitude,deviceMetrics.voltage"]
-    }
-
+    },
+    {
+      "name": "meshtastic --export-config",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--export-config", "config.json"]
+    },
   ]
 }

.vscode/launch.json

@@ -1,4 +1,10 @@
-# Meshtastic Python
+<div align="center" markdown="1">
+
+<img src=".github/meshtastic_logo.png" alt="Meshtastic Logo" width="80"/>
+
+  <h1 align="center"> Meshtastic Python
+</h1>
+  <p style="font-size:15px;" align="center">A Python library and client for use with Meshtastic devices. </p>
 
 [![codecov](https://codecov.io/gh/meshtastic/python/branch/master/graph/badge.svg?token=TIWPJL73KV)](https://codecov.io/gh/meshtastic/python)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/meshtastic)
@@ -7,17 +13,20 @@
 [![Fiscal Contributors](https://opencollective.com/meshtastic/tiers/badge.svg?label=Fiscal%20Contributors&color=deeppink)](https://opencollective.com/meshtastic/)
 ![GPL-3.0](https://img.shields.io/badge/License-GPL%20v3-blue.svg)
 
+</div>
+
+<div align="center">
+	<a href="https://meshtastic.org/docs/software/python/cli/installation">Getting Started Guide</a>
+	-
+	<a href="https://python.meshtastic.org">API Documentation</a>
+</div>
+
 ## Overview
 
-A Python client for use with Meshtastic 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.
 
-**[Getting Started Guide](https://meshtastic.org/docs/software/python/cli/installation)**
-
-**[API Documentation](https://python.meshtastic.org)**
-
 ## Call for Contributors
 
 This library and CLI has gone without a consistent maintainer for a while, and there's many improvements that could be made. We're all volunteers here and help is extremely appreciated, whether in implementing your own needs or helping maintain the library and CLI in general.

LICENSES/GPL-3.0-only.txt LICENSE.mdLICENSES/GPL-3.0-only.txt renamed to LICENSE.md

@@ -6,6 +6,12 @@ set -e
 #gsed -i 's/import "\//import ".\//g' ./protobufs/meshtastic/*
 #gsed -i 's/package meshtastic;//g' ./protobufs/meshtastic/*
 
+POETRYDIR=$(poetry env info --path)
+
+if [[ -z "${POETRYDIR}" ]]; then
+	poetry install
+fi
+
 # protoc looks for mypy plugin in the python path
 source $(poetry env info --path)/bin/activate
 
@@ -22,6 +28,7 @@ OUTDIR=${TMPDIR}/out
 PYIDIR=${TMPDIR}/out
 mkdir -p "${OUTDIR}" "${INDIR}" "${PYIDIR}"
 cp ./protobufs/meshtastic/*.proto "${INDIR}"
+cp ./protobufs/nanopb.proto "${INDIR}"
 
 # OS-X sed is apparently a little different and expects an arg for -i
 if [[ $OSTYPE == 'darwin'* ]]; then
@@ -36,6 +43,8 @@ $SEDCMD 's/^package meshtastic;/package meshtastic.protobuf;/' "${INDIR}/"*.prot
 # fix the imports to match
 $SEDCMD 's/^import "meshtastic\//import "meshtastic\/protobuf\//' "${INDIR}/"*.proto
 
+$SEDCMD 's/^import "nanopb.proto"/import "meshtastic\/protobuf\/nanopb.proto"/' "${INDIR}/"*.proto
+
 # Generate the python files
 ./nanopb-0.4.8/generator-bin/protoc -I=$TMPDIR/in --python_out "${OUTDIR}" "--mypy_out=${PYIDIR}" $INDIR/*.proto
 

README.md

@@ -4,6 +4,9 @@ owner_short: BOB
 
 channel_url: https://www.meshtastic.org/e/#CgMSAQESCDgBQANIAVAe
 
+canned_messages: Hi|Bye|Yes|No|Ok
+ringtone: 24:d=32,o=5,b=565:f6,p,f6,4p,p,f6,p,f6,2p,p,b6,p,b6,p,b6,p,b6,p,b,p,b,p,b,p,b,p,b,p,b,p,b,p,b,1p.,2p.,p
+
 location:
   lat: 35.88888
   lon: -93.88888

bin/regen-protobufs.sh

@@ -25,6 +25,7 @@
 parser_create.add_argument('id', help="id of the waypoint")
 parser_create.add_argument('name', help="name of the waypoint")
 parser_create.add_argument('description', help="description of the waypoint")
+parser_create.add_argument('icon', help="icon of the waypoint")
 parser_create.add_argument('expire', help="expiration date of the waypoint as interpreted by datetime.fromisoformat")
 parser_create.add_argument('latitude', help="latitude of the waypoint")
 parser_create.add_argument('longitude', help="longitude of the waypoint")
@@ -44,6 +45,7 @@
             waypoint_id=int(args.id),
             name=args.name,
             description=args.description,
+            icon=args.icon,
             expire=int(datetime.datetime.fromisoformat(args.expire).timestamp()),
             latitude=float(args.latitude),
             longitude=float(args.longitude),

example_config.yaml

@@ -35,6 +35,7 @@
 - `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...)
 - `meshtastic.log.line(line)` - a raw unparsed log line from the radio
+- `meshtastic.clientNotification(notification, interface) - a ClientNotification sent from the radio
 
 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
@@ -128,6 +129,7 @@ def onConnection(interface, topic=pub.AUTO_TOPIC): # called when we (re)connect
 
 publishingThread = DeferredExecution("publishing")
 
+logger = logging.getLogger(__name__)
 
 class ResponseHandler(NamedTuple):
     """A pending response callback, waiting for a response to one of our messages"""
@@ -159,31 +161,31 @@ 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}")
+    logger.debug(f"in _onTextReceive() asDict:{asDict}")
     try:
         asBytes = asDict["decoded"]["payload"]
         asDict["decoded"]["text"] = asBytes.decode("utf-8")
     except Exception as ex:
-        logging.error(f"Malformatted utf8 in text message: {ex}")
+        logger.error(f"Malformatted utf8 in text message: {ex}")
     _receiveInfoUpdate(iface, asDict)
 
 
 def _onPositionReceive(iface, asDict):
     """Special auto parsing for received messages"""
-    logging.debug(f"in _onPositionReceive() asDict:{asDict}")
+    logger.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}")
+            logger.debug(f"p:{p}")
             p = iface._fixupPosition(p)
-            logging.debug(f"after fixup p:{p}")
+            logger.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"""
-    logging.debug(f"in _onNodeInfoReceive() asDict:{asDict}")
+    logger.debug(f"in _onNodeInfoReceive() asDict:{asDict}")
     if "decoded" in asDict:
         if "user" in asDict["decoded"] and "from" in asDict:
             p = asDict["decoded"]["user"]
@@ -197,7 +199,7 @@ def _onNodeInfoReceive(iface, asDict):
 
 def _onTelemetryReceive(iface, asDict):
     """Automatically update device metrics on received packets"""
-    logging.debug(f"in _onTelemetryReceive() asDict:{asDict}")
+    logger.debug(f"in _onTelemetryReceive() asDict:{asDict}")
     if "from" not in asDict:
         return
 
@@ -221,7 +223,7 @@ def _onTelemetryReceive(iface, asDict):
     updateObj = telemetry.get(toUpdate)
     newMetrics = node.get(toUpdate, {})
     newMetrics.update(updateObj)
-    logging.debug(f"updating {toUpdate} metrics for {asDict['from']} to {newMetrics}")
+    logger.debug(f"updating {toUpdate} metrics for {asDict['from']} to {newMetrics}")
     node[toUpdate] = newMetrics
 
 def _receiveInfoUpdate(iface, asDict):
@@ -233,7 +235,7 @@ def _receiveInfoUpdate(iface, asDict):
 
 def _onAdminReceive(iface, asDict):
     """Special auto parsing for received messages"""
-    logging.debug(f"in _onAdminReceive() asDict:{asDict}")
+    logger.debug(f"in _onAdminReceive() asDict:{asDict}")
     if "decoded" in asDict and "from" in asDict and "admin" in asDict["decoded"]:
         adminMessage = asDict["decoded"]["admin"]["raw"]
         iface._getOrCreateByNum(asDict["from"])["adminSessionPassKey"] = adminMessage.session_passkey