Skip to main content

Bridges MQTT topics to a pseudo-terminal device

Project description

mqtty

mqtty bridges MQTT topics to either your local terminal or a pseudoterminal (PTY), letting you interact with serial-style streams over MQTT.

This is useful for debugging, automation, or tunneling serial communication through a networked MQTT broker.

Usage

mqtty mqtt://<host>/<topic> [--pts-only]

By default, mqtty runs in bidirectional terminal mode:

  • bytes from stdin are published to .../device_serial_input
  • bytes from .../device_serial_output are written to stdout
  • if stdin is a TTY, it is placed into raw mode while mqtty is running
  • type Ctrl-A Ctrl-X to exit, matching picocom's default exit sequence
  • type Ctrl-A Ctrl-A to send a literal Ctrl-A

Use --pts-only if you only want a PTY device:

  • --pts-only, -p: Print the path to the PTS device and keep it open without attaching local stdin/stdout. Useful for tools or scripts that want to use the virtual serial port.

The <topic> segment of the URI is used as the base path for MQTT messages:

  • .../device_serial_input receives bytes from local input and sends them to the device
  • .../device_serial_output carries device output back to your terminal or PTY

Example

mqtty mqtt://broker.local/mydevice

This connects your terminal directly to mydevice/device_serial_input and mydevice/device_serial_output.

To expose a PTY instead:

mqtty mqtt://broker.local/mydevice --pts-only

This prints the local PTY path and keeps it bridged to the same MQTT topics until interrupted.

License

MIT

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

mqtty-0.1.2.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

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

mqtty-0.1.2-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file mqtty-0.1.2.tar.gz.

File metadata

  • Download URL: mqtty-0.1.2.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mqtty-0.1.2.tar.gz
Algorithm Hash digest
SHA256 4126853484250d415ed107b5b2880474bba307c95cb731673cff29e65879ab55
MD5 482408e28a219b38fd0aebc98ea9be36
BLAKE2b-256 ee422bc27abc8c85a6d1db822fa2c49abb23d78eb90c19c77ca18ddeb6ccf202

See more details on using hashes here.

Provenance

The following attestation bundles were made for mqtty-0.1.2.tar.gz:

Publisher: release.yml on embeddedTS/mqtty

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

File details

Details for the file mqtty-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: mqtty-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mqtty-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4031ae2ed1d712729a33b138290429fc552346cd7e1020e1cbf273b71c8d2bd1
MD5 ae7618f839902056a86fc0f080f2eb3a
BLAKE2b-256 cec4d19770410552267c54e5205ed9c5808562d2555697d0a2aba0012004c4e8

See more details on using hashes here.

Provenance

The following attestation bundles were made for mqtty-0.1.2-py3-none-any.whl:

Publisher: release.yml on embeddedTS/mqtty

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