From bf967fc9ebadb093dc7134fc0df1ac9db86b3ef3 Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Sat, 2 Mar 2024 12:09:25 -0700 Subject: [PATCH] --noproto usage example --- docs/software/python-cli/usage.mdx | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/software/python-cli/usage.mdx b/docs/software/python-cli/usage.mdx index 65a765af..e7758507 100644 --- a/docs/software/python-cli/usage.mdx +++ b/docs/software/python-cli/usage.mdx @@ -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). ::: +## 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. + +```shell title="Example Usage" +user@host: meshtastic --noproto +# You should see a result 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 You can get a list of user preferences by running '--get' with an invalid attribute such as 'all'.