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

docs: --noproto needs a physical connection (#1489)
Some checks failed
CI / quality (push) Has been cancelled
Details
CI / build (push) Has been cancelled
Details

Browse source 
* docs: --noproto needs a physical connection

* docs: --noproto caveats without admonitions

* docs: --noproto caveats using consistent language
This commit is contained in:
Sean Kilgore 2024-10-06 14:52:02 -07:00 committed by GitHub
parent a027093965
commit b397d84eac
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/software/python-cli/index.mdx
View file

@ -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

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

@ -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