From b397d84eac16f852c02f14da9856a602e196841e Mon Sep 17 00:00:00 2001 From: Sean Kilgore Date: Sun, 6 Oct 2024 14:52:02 -0700 Subject: [PATCH] docs: --noproto needs a physical connection (#1489) * docs: --noproto needs a physical connection * docs: --noproto caveats without admonitions * docs: --noproto caveats using consistent language --- docs/software/python-cli/index.mdx | 2 +- docs/software/python-cli/usage.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/software/python-cli/index.mdx b/docs/software/python-cli/index.mdx index ea4137de..2ee2a3e9 100644 --- a/docs/software/python-cli/index.mdx +++ b/docs/software/python-cli/index.mdx @@ -541,7 +541,7 @@ meshtastic --ble-scan ### --noproto -Don't start the API, just function as a dumb serial terminal. Probably not very helpful from the command line. Used more for testing/internal needs. +Don't start the API, just function as a dumb serial terminal. Useful for debugging because it doesn't count as a client. Depends on a physically cabled serial connection. It will connect but not display information over a network (--host) or Bluetooth (--ble) connection. ```shell title="Usage" meshtastic --noproto diff --git a/docs/software/python-cli/usage.mdx b/docs/software/python-cli/usage.mdx index 3c286c90..1fe64131 100644 --- a/docs/software/python-cli/usage.mdx +++ b/docs/software/python-cli/usage.mdx @@ -14,7 +14,7 @@ The `meshtastic` command is not run within python but is a script run from your ## 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. +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. Depends on a physically cabled serial connection. It will connect but not display information over a network (--host) or Bluetooth (--ble) connection. ```shellsession title="Example Usage" user@host % meshtastic --noproto