|
1 | 1 | """ |
2 | | -# an API for Meshtastic devices |
| 2 | +# A library for the Meshtastic Client API |
3 | 3 |
|
4 | | -Primary class: SerialInterface |
| 4 | +Primary interfaces: SerialInterface, TCPInterface, BLEInterface |
5 | 5 | Install with pip: "[pip3 install meshtastic](https://pypi.org/project/meshtastic/)" |
6 | 6 | Source code on [github](https://github.com/meshtastic/python) |
7 | 7 |
|
8 | | -properties of SerialInterface: |
| 8 | +notable properties of interface classes: |
9 | 9 |
|
10 | | -- localConfig - Current radio configuration and device settings, if you write to this the new settings will be applied to |
11 | | -the device. |
12 | 10 | - nodes - The database of received nodes. Includes always up-to-date location and username information for each |
13 | 11 | node in the mesh. This is a read-only datastructure. |
14 | 12 | - 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. |
16 | 20 |
|
17 | 21 | # Published PubSub topics |
18 | 22 |
|
|
0 commit comments