Getting Started

Twinleaf sensors and instruments use free, open-source software. Choose the tools that match how you want to work:

• Twinleaf App — the shortest path to viewing, plotting, recording, and configuring a device on macOS, iPad, or iPhone. No coding required.
• twinleaf-rust — command-line tools for connecting to devices, monitoring live data, changing settings, logging, and firmware upgrades. Install below or view the source on GitHub.
• twinleaf-python — a Python package for custom data collection, automation, and analysis. Install and use it in the walkthrough or view the source on GitHub.

Install the command-line tools

The twinleaf-rust package installs one command, tio, with subcommands for device discovery, monitoring, settings, logging, and upgrades.

Install Rust with rustup if cargo --version is not available. Then install or update the Twinleaf tools:

cargo install twinleaf-tools

To include HDF5 export support:

cargo install twinleaf-tools --features hdf5

Confirm the installation:

tio --version

If tio is not found, open a new terminal. On Windows, you may also need to add %USERPROFILE%\.cargo\bin to your PATH. On Debian or Ubuntu, an installation error may require:

sudo apt install build-essential libudev-dev libssl-dev

Versions before 2.0 installed separate commands such as tio-proxy, tio-monitor, and tio-tool. Current versions use subcommands such as tio list, tio monitor, tio rpc, and tio log.

Connect to a device

Follow the device-to-data walkthrough to connect a device, identify whether its sensor is at /0 or /0/0, view live data, change settings, and create a log.

These guides cover Twinleaf devices shipped in 2025 or later. If your device is older—or you are unsure—email its serial number to contact@twinleaf.com. We will identify the correct software.