iarv/contact
1
0
Fork 1
mirror of https://github.com/pdxlocations/contact.git synced 2026-03-28 17:12:35 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add connection arguments to the Readme

Browse Source
This commit is contained in:
Nicholas Maloney
2025-01-12 22:17:28 -05:00
parent ae00211365
commit 4ded7d7ad8
1 changed files with 22 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -1,4 +1,4 @@
Command line client using the curses library, powered by Meshtastic.org
Python based command line client using the curses library, powered by Meshtastic.org
<img width="846" alt="Screenshot_2024-03-29_at_4 00 29_PM" src="https://github.com/pdxlocations/meshtastic-curses-client/assets/117498748/e99533b7-5c0c-463d-8d5f-6e3cccaeced7">
@@ -7,3 +7,24 @@ Command line client using the curses library, powered by Meshtastic.org
Settings can be accessed within the client or can be run standalone
<img width="509" alt="Screenshot 2024-04-15 at 3 39 12 PM" src="https://github.com/pdxlocations/meshtastic-curses-client/assets/117498748/37bc57db-fe2d-4ba4-adc8-679b4cb642f9">
## Arguments
You can pass the following arguments to the client:
### Connection Arguments
Optional arguments to specify a device to connect to and how.
- `--port`, `--serial`, `-s`: The port to connect to via serial, e.g. `/dev/ttyUSB0`.
- `--host`, `--tcp`, `-t`: The hostname or IP address to connect to using TCP.
- `--ble`, `-b`: The BLE device MAC address or name to connect to.
If no connection arguments are specified, the client will attempt a serial connection and then a TCP connection to localhost.
### Example Usage
```sh
python main.py --port /dev/ttyUSB0
python main.py --host 192.168.1.1
python main.py --ble BlAddressOfDevice