Skip to content

Commit

Permalink
Change version to 1.0.0
Browse files Browse the repository at this point in the history
Also update README and add fields required for crates.io
  • Loading branch information
tkornack committed Nov 20, 2024
1 parent d262de0 commit f93c403
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 15 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright © 2022 Twinleaf LLC
Copyright © 2022-2024 Twinleaf LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
31 changes: 21 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,29 @@
# Twinleaf I/O Tool in Rust
# Twinleaf I/O Tools in Rust

This tool connects to a Twinleaf sensor attached to a serial port. The primary tool is the proxy, which makes the sensor available via ethernet:
This repository contains a set of tools that are useful for working with Twinleaf quantum sensors and accessories.

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

when there are more than one serial port available, it is necessary to specify the port
tio-proxy --auto

[linux]> tio-tool proxy -r /dev/ttyACM0
[macOS]> tio-tool proxy -r /dev/cu.usbserialXXXXXX
[wsl1] > tio-tool proxy -r COM3
When there are more than one serial port available, it is necessary to specify the port

There is also a simple RPC function:
[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.

tio-tool rpc "dev.name"

## Installation

Expand All @@ -25,7 +36,7 @@ Now build:

cargo build --release

The tool can be run as follows:
The resulting tools can be found in the target directory:

cd target/release
./tio-tool
Expand Down
7 changes: 4 additions & 3 deletions twinleaf-tools/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
[package]
name = "twinleaf-tools"
version = "0.1.0"
version = "1.0.0"
edition = "2021"
license = "MIT"
description = "Tools for the Twinleaf I/O protocol for reading data from Twinleaf quantum sensors."
homepage = "https://twinleaf.com"
repository = "https://github.com/twinleaf/twinleaf-rust"
readme = "README.md"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
chrono = "0.4.38"
crossbeam = "0.8.4"
Expand Down
6 changes: 5 additions & 1 deletion twinleaf/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
[package]
name = "twinleaf"
version = "0.1.0"
version = "1.0.0"
edition = "2021"
license = "MIT"
readme = "README.md"
description = "Library for working with the Twinleaf I/O protocol and Twinleaf quantum sensors."
homepage = "https://twinleaf.com"
repository = "https://github.com/twinleaf/twinleaf-rust"
readme = "README.md"

[dependencies]
crossbeam = "0.8.4"
Expand Down

0 comments on commit f93c403

Please sign in to comment.