1
0
Fork 0
loranto/README.md

43 lines
947 B
Markdown

# loranto
A simple tool to send messages into [FreakWAN](https://github.com/antirez/freakwan)
over Bluetooth low energy.
**This project is in pre-alpha please use the [python implementation](https://pypi.org/project/freakble/)
instead.**
The name of the project is the italian word for [Loranthus](https://en.wikipedia.org/wiki/Loranthus).
## Installation
### From source
To build the latest version of `loranto` clone the repository and run:
```
cargo build --release
```
During development you want to build in debug mode with just:
```
cargo build
```
## Usage
```console
Usage: loranto [OPTIONS] [COMMAND]
Commands:
scan Scan to find Bluetooth LE devices
send Send messages to a device
repl Start a REPL with the device
help Print this message or the help of the given subcommand(s)
Options:
--adapter <ADAPTER> [default: hci0]
-h, --help Print help
-V, --version Print version
```