From b350b9eab9add15b903b5d64b75c6d13ee2088ed Mon Sep 17 00:00:00 2001 From: Ian McEwen Date: Sat, 1 Jun 2024 23:03:56 -0700 Subject: [PATCH] Update the main module docstring to be a bit more accurate, at least --- meshtastic/__init__.py | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/meshtastic/__init__.py b/meshtastic/__init__.py index f74e84a..29dca98 100644 --- a/meshtastic/__init__.py +++ b/meshtastic/__init__.py @@ -1,18 +1,22 @@ """ -# an API for Meshtastic devices +# A library for the Meshtastic Client API -Primary class: SerialInterface +Primary interfaces: SerialInterface, TCPInterface, BLEInterface Install with pip: "[pip3 install meshtastic](https://pypi.org/project/meshtastic/)" Source code on [github](https://github.com/meshtastic/python) -properties of SerialInterface: +notable properties of interface classes: -- localConfig - 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 "nodes" but keyed by nodeNum instead of nodeId -- myInfo - Contains read-only information about the local radio device (software version, hardware version, etc) +- myInfo & metadata - Contain read-only information about the local radio device (software version, hardware version, etc) +- localNode - Pointer to a node object for the local node + +notable properties of nodes: +- localConfig - Current radio settings, can be written to the radio with the `writeConfig` method. +- moduleConfig - Current module settings, can be written to the radio with the `writeConfig` method. +- channels - The node's channels, keyed by index. # Published PubSub topics