mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-02-02 08:42:11 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #1078 from rcarteraz/update-python-cli

Browse source 
Python CLI --noproto usage example
This commit is contained in:
rcarteraz 2024-03-03 09:48:55 -07:00 committed by GitHub
parent 8756a2c648 7be2f9d357
commit dcd523f0e2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/software/python-cli/usage.mdx
View file

@ -12,6 +12,23 @@ This section covers using the "meshtastic" command line executable, which displa
The `meshtastic` command is not run within python but is a script run from your operating system shell prompt. When you type "meshtastic" and the prompt is unable to find the command in Windows, check that the python "scripts" directory [is in your path](https://datatofish.com/add-python-to-windows-path). The `meshtastic` command is not run within python but is a script run from your operating system shell prompt. When you type "meshtastic" and the prompt is unable to find the command in Windows, check that the python "scripts" directory [is in your path](https://datatofish.com/add-python-to-windows-path).
::: :::
## Viewing Serial Output
The `--noproto` command in the Meshtastic Python CLI is used to disable the API and function merely as a "dumb serial terminal." This mode of operation allows both the API and device functionalities to remain accessible for regular use, while simultaneously providing a window into the raw serial output. This feature can be particularly useful for debugging, development, or understanding the low-level communication between devices.
```shellsession title="Example Usage"
user@host % meshtastic --noproto
# You should see results similar to this:
WARNING file:mesh_interface.py _sendToRadio line:681 Not sending packet because protocol use is disabled by noProto
Connected to radio
WARNING file:mesh_interface.py _sendPacket line:531 Not sending packet because protocol use is disabled by noProto
INFO | 18:38:04 711 [DeviceTelemetryModule] (Sending): air_util_tx=0.116361, channel_utilization=1.916667, battery_level=101, voltage=4.171000
DEBUG | 18:38:04 711 [DeviceTelemetryModule] updateTelemetry LOCAL
DEBUG | 18:38:04 711 [DeviceTelemetryModule] Node status update: 2 online, 4 total
INFO | 18:38:04 711 [DeviceTelemetryModule] Sending packet to phone
INFO | 18:38:04 711 Telling client we have new packets 28
```
## Getting a list of User Preferences ## Getting a list of User Preferences
You can get a list of user preferences by running '--get' with an invalid attribute such as 'all'. You can get a list of user preferences by running '--get' with an invalid attribute such as 'all'.

3
docusaurus.config.js
View file

@ -102,6 +102,9 @@ const config = {
}, },
}, },
}, },
prism: {
additionalLanguages: ["shell-session", "bash"],
},
}, },
plugins: [ plugins: [
() => { () => {