Skip to main content

This Python curses client for Meshtastic is a terminal-based client designed to manage device settings, enable mesh chat communication, and handle configuration backups and restores.

Project description

Contact - A Console UI for Meshtastic

Powered by Meshtastic.org

Install with:

pip install contact

This Python curses client for Meshtastic is a terminal-based client designed to manage device settings, enable mesh chat communication, and handle configuration backups and restores.

Contact - Main UI Screenshot



The settings dialogue can be accessed within the client or may be run standalone to configure your node by launching contact --settings or contact -c

Screenshot 2025-04-08 at 6 10 06 PM

Message Persistence

All messages will saved in a SQLite DB and restored upon relaunch of the app. You may delete client.db if you wish to erase all stored messages and node data. If multiple nodes are used, each will independently store data in the database, but the data will not be shared or viewable between nodes.

Client Configuration

By navigating to Settings -> App Settings, you may customize your UI's icons, colors, and more!

Commands

  • ↑→↓← = Navigate around the UI.
  • ENTER = Send a message typed in the Input Window, or with the Node List highlighted, select a node to DM
  • ` = Open the Settings dialogue
  • CTRL + p = Hide/show a log of raw received packets.
  • CTRL + t = With the Node List highlighted, send a traceroute to the selected node
  • CTRL + d = With the Channel List hightlighted, archive a chat to reduce UI clutter. Messages will be saved in the db and repopulate if you send or receive a DM from this user.
  • ESC = Exit out of the Settings Dialogue, or Quit the application if settings are not displayed.

Search

  • Press CTRL + / while the nodes or channels window is highlighted to start search
  • Type text to search as you type, first matching item will be selected, starting at current selected index
  • Press Tab to find next match starting from the current index - search wraps around if necessary
  • Press Esc or Enter to exit search mode

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, will default to localhost if no host is passed.
  • --ble, -b: The BLE device MAC address or name to connect to.
  • --settings, --set, --control, -c: Launch directly into the settings.

If no connection arguments are specified, the client will attempt a serial connection and then a TCP connection to localhost.

Example Usage

contact --port /dev/ttyUSB0
contact --host 192.168.1.1
contact --ble BlAddressOfDevice

To quickly connect to localhost, use:

contact -t

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

contact-1.3.9.tar.gz (64.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

contact-1.3.9-py3-none-any.whl (74.3 kB view details)

Uploaded Python 3

File details

Details for the file contact-1.3.9.tar.gz.

File metadata

  • Download URL: contact-1.3.9.tar.gz
  • Upload date:
  • Size: 64.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for contact-1.3.9.tar.gz
Algorithm Hash digest
SHA256 89ae880ae29a4c151dd0a1f4328a08ad7a2acba1efeaa8d55d92b2e67741b557
MD5 57fbacefe9cf713566949d49684e4d59
BLAKE2b-256 37b260e152331bdfaf628f18349b28297bfcc281ebe547e5a1e70eb6d157be83

See more details on using hashes here.

Provenance

The following attestation bundles were made for contact-1.3.9.tar.gz:

Publisher: release.yaml on pdxlocations/contact

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file contact-1.3.9-py3-none-any.whl.

File metadata

  • Download URL: contact-1.3.9-py3-none-any.whl
  • Upload date:
  • Size: 74.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for contact-1.3.9-py3-none-any.whl
Algorithm Hash digest
SHA256 d5ef64b65897648378a8d52bd201195ddedc8da358b2a3963f405324fbabe7f4
MD5 3fcf7ba6a4c9ced15751debe4b5286f4
BLAKE2b-256 cb1bf443d659416ebe7efe0ec297838b1d5620af573899355c74e37359c1af59

See more details on using hashes here.

Provenance

The following attestation bundles were made for contact-1.3.9-py3-none-any.whl:

Publisher: release.yaml on pdxlocations/contact

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page