Skip to content

Commit b350b9e

Browse files
committed
Update the main module docstring to be a bit more accurate, at least
1 parent dc112f2 commit b350b9e

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

meshtastic/__init__.py

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
"""
2-
# an API for Meshtastic devices
2+
# A library for the Meshtastic Client API
33
4-
Primary class: SerialInterface
4+
Primary interfaces: SerialInterface, TCPInterface, BLEInterface
55
Install with pip: "[pip3 install meshtastic](https://pypi.org/project/meshtastic/)"
66
Source code on [github](https://github.com/meshtastic/python)
77
8-
properties of SerialInterface:
8+
notable properties of interface classes:
99
10-
- localConfig - Current radio configuration and device settings, if you write to this the new settings will be applied to
11-
the device.
1210
- nodes - The database of received nodes. Includes always up-to-date location and username information for each
1311
node in the mesh. This is a read-only datastructure.
1412
- nodesByNum - like "nodes" but keyed by nodeNum instead of nodeId
15-
- myInfo - Contains read-only information about the local radio device (software version, hardware version, etc)
13+
- myInfo & metadata - Contain read-only information about the local radio device (software version, hardware version, etc)
14+
- localNode - Pointer to a node object for the local node
15+
16+
notable properties of nodes:
17+
- localConfig - Current radio settings, can be written to the radio with the `writeConfig` method.
18+
- moduleConfig - Current module settings, can be written to the radio with the `writeConfig` method.
19+
- channels - The node's channels, keyed by index.
1620
1721
# Published PubSub topics
1822

0 commit comments

Comments
 (0)