Skip to content

Commit

Permalink
Add readme to each sub-project
Browse files Browse the repository at this point in the history
  • Loading branch information
tkornack committed Nov 20, 2024
1 parent edc7ab4 commit 56b4614
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 0 deletions.
53 changes: 53 additions & 0 deletions twinleaf-tools/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Twinleaf I/O Tools in Rust

This repository contains a set of tools that are useful for working with Twinleaf quantum sensors and accessories.

The primary tool is the proxy, which makes the device available via ethernet:

tio-proxy --auto

When there are more than one serial port available, it is necessary to specify the port

[linux]> tio-proxy -r /dev/ttyACM0
[macOS]> tio-proxy -r /dev/cu.usbserialXXXXXX
[wsl1] > tio-proxy -r COM3

With the proxy running, a set of tools can be used on the data stream.

Logging data:

tio-tool log

Issuing commands:

tio-tool rpc dev.name

And a variety of additional useful functions.


## Installation

On macOS and linux, there is a dependency on libudev; to install it use:

sudo apt install libudev-dev # debian linux
brew install libudev # macOS homebrew

Now build:

cargo build --release

The resulting tools can be found in the target directory:

cd target/release
./tio-tool

## Cross compilation

The tools can be compiled for other platforms by first adding those platform targets:

rustup target add x86_64-pc-windows-gnu
rustup toolchain install stable-x86_64-pc-windows-gnu

And then building for the new target:

cargo build --target x86_64-pc-windows-gnu
10 changes: 10 additions & 0 deletions twinleaf/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Twinleaf I/O Library in Rust

Library support for writing applications that work with Twinleaf quantum sensors and the Twinleaf I/O protocol.

## Installation

On macOS and linux, there is a dependency on libudev; to install it use:

sudo apt install libudev-dev # debian linux
brew install libudev # macOS homebrew

0 comments on commit 56b4614

Please sign in to comment.