-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
63 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |