Skip to main content

python-dashio

PyPI Python Tests Discord

A Python library that connects your project to the Dash IoT app, over your local network (TCP), from anywhere through the Dash server (MQTT), or over Bluetooth LE on Linux. You create controls in Python (dials, knobs, sliders, buttons, text boxes, time graphs, maps, event logs...), give them values, and handle what the app sends back. Lay them out from your code, or design the layout in the app itself. There's no app or web code to write.

  • TCP on your local network, the Dash server, and Bluetooth LE on Linux (experimental), separately or together.
  • Layouts for phones, fold out phones and tablets, designed in the app or built in Python.
  • Notifications to your phone, through the Dash server.
  • Provisioning from the app: the device name, WiFi, Dash server login, and your own settings in the app's provisioning menu.
  • History for time graphs, event logs and maps, kept in sqlite and uploaded to the Dash server, for devices that are only online now and then.

It's the Python counterpart of the Arduino DashIO libraries, and speaks the same protocol. It's also the quickest way to prototype a device and design its layout before writing firmware.

A knob turned in the Dash app: the message goes through the TCPConnection and ZMQ to the Device thread and your callback, and the dial update goes back out over TCP and through the Dash server

The Dash app

Apple Android

TCP and BLE are free. To reach your device from anywhere, create an account on dashio.io. More at dashio.io, and on Discord.

The Dash app on a phone The Dash app on a tablet

Requirements

Python 3.11 or later.

pip3 install dashio

pip installs the other dependencies. For Bluetooth LE on Linux, pip3 install dashio[ble]. To work on the library, clone it and pip3 install -e ..

Quick start

A knob that moves a dial, on your local network. This is Examples/ex03.py:

# Examples/ex03.py
import dashio
import time

device = dashio.Device("aDeviceType", "aDeviceID", "aDeviceName")
tcp_con = dashio.TCPConnection()
tcp_con.add_device(device)
first_dial_control = dashio.Dial("dial1", control_position=dashio.ControlPosition(0.24, 0.36, 0.54, 0.26))
device.add_control(first_dial_control)

dv = dashio.DeviceView("aView", "A Dial")
dv.add_control(first_dial_control)
device.add_control(dv)


def knob_event_handler(msg):
    first_dial_control.dial_value = float(msg[3])


aknob = dashio.Knob("aKNB", control_position=dashio.ControlPosition(0.24, 0.14, 0.54, 0.26))
aknob.add_receive_message_callback(knob_event_handler)
dv.add_control(aknob)
device.add_control(aknob)

while True:
    time.sleep(1)

Run it, then add the device in the Dash app: it's found on the local network. Turn the knob, and the dial follows. Getting started goes on from here.

How you develop with it

  1. Create the controls in Python, with IDs of up to 8 characters, and run the device over TCP.
  2. Design the layout in the Dash app, and export it. Or build it in Python with generate_cfg64().
  3. Load the layout into the device, with cfg_dict or add_cfg64(), and handle the app's messages in the controls' callbacks.
  4. Change the layout later. The device identifies its layout by a hash, so the app fetches the new one by itself.
  5. Connect to the Dash server to reach the device from anywhere, send notifications and keep history.

The same layout works on Arduino firmware with controls of the same types and IDs. docs/layouts.md covers each step.

Documentation

Getting started From a dial on your phone to a device you can reach from anywhere
Layouts Designing, generating and loading layouts; Menus and the provisioning menu
Controls Every control: its settings, its values, and what its callbacks receive
The Device Controls, provisioning from the app, reset, the clock
Connections The Dash server, TCP, Bluetooth LE and ZMQ
Storing history Time graph, event log and map history, on the device and the Dash server
Exporting data dashio_data_exporter: history from the Dash server, as text or CSV
Examples ex01–ex06 from the docs; greenhouse, server_monitor and intermittent_connection.py are complete applications

Command line utilities

The library installs three commands. Run any of them with -h for its options.

Command
c64_decode layout.c64 Decodes a CFG64 layout, e.g. one exported from the Dash app, to JSON
c64_encode layout.json Encodes a JSON layout to CFG64, optionally formatted for C or Python code with -f
dashio_data_exporter -u USERNAME -p PASSWORD -d DEVICE_ID -c CONTROL_ID Exports time graph or event log history from the Dash server (docs)

For Claude Code users

skills/python-dashio is a Claude Code skill that teaches Claude how to use this library, and how to make layouts for Arduino and zephyr-dashio firmware: copy or link it into your project's .claude/skills/ directory.

Working on the library

CLAUDE.md describes the code, and how to run the tests and lint.

License

MIT, see LICENSE.

Metadata

Release files for dashio 3.16.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dashio 3.16.0
File Size Uploaded Provenance Actions
dashio-3.16.0.tar.gz 210.3 kB With provenance Details for dashio-3.16.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for dashio 3.16.0
File Interpreter ABI Platform Actions
dashio-3.16.0-py3-none-any.whl Python 3 none any Details for dashio-3.16.0-py3-none-any.whl

Total release size: 515.0 kB

Release files / dashio-3.16.0.tar.gz

Download URL dashio-3.16.0.tar.gz
Size 210.3 kB
Tags Source
SHA-256 checksum
How to use checksums
d46460f44aea5b97c79dd3fdca1ad5527558c6b6def2863a55ee6a7db1d35779
BLAKE2b-256 checksum
How to use checksums
2a62e05c75422919e35a691fa60ffe97b374d43ceaa1c25fb7fb4eb951a9d791
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 18, 2026.

Transparency log

Release files / dashio-3.16.0-py3-none-any.whl

Download URL dashio-3.16.0-py3-none-any.whl
Size 304.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
60f70ec075f771e1e0613646cb50c8aa0d9fed7fad4eba6159fd99a9eb27dbb5
BLAKE2b-256 checksum
How to use checksums
4a6d790ec4a9d33a0ebd06946bdfe94b053f0fa0450f67f2c2d1de1e46f2d010
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 18, 2026.

Transparency log

Security for dashio 3.16.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for dashio-3.16.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 18, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

3.16.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page