Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lautis/ruuvitag-listener
Listen to RuuviTag measurements and output in Telegraf compatible format
https://github.com/lautis/ruuvitag-listener
ruuvi ruuvitag
Last synced: 21 days ago
JSON representation
Listen to RuuviTag measurements and output in Telegraf compatible format
- Host: GitHub
- URL: https://github.com/lautis/ruuvitag-listener
- Owner: lautis
- License: mit
- Created: 2018-12-16T17:18:52.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-28T12:40:46.000Z (3 months ago)
- Last Synced: 2024-09-28T18:37:45.563Z (about 2 months ago)
- Topics: ruuvi, ruuvitag
- Language: Rust
- Size: 166 KB
- Stars: 31
- Watchers: 3
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# RuuviTag Listener
A command-line client to listen to [RuuviTag](https://ruuvi.com) sensor measurements over Bluetooth LE and output as [InfluxDB line protocol](https://docs.influxdata.com/influxdb/v1.7/write_protocols/line_protocol_reference/).
The output can be used in e.g. [Telegraf Execd Input](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/execd). For an example setup, check out [examples/telegraf](./examples/telegraf/README.md).
## Requirements
* RuuviTag Bluetooth sensor
* Linux with BlueZ Bluetooth stack
## Installation
Download binary from [releases](https://github.com/lautis/ruuvitag-listener/releases) to your $PATH. Then, set file capabilities to allow access to Bluetooth with
```sh
sudo setcap 'cap_net_raw,cap_net_admin+eip' `which ruuvitag-listener`
```
Alternatively, install ruuvitag-listener using any of the following package managers:
| Distribution | Repository | Instructions |
| ------------- | ----------- | ------------------------------------------------------------------------ |
| *Any* | [Crates.io] | `cargo install ruuvitag-listener --locked` (note: does not run `setcap`) |
| Arch Linux | [AUR] | `yay -S ruuvitag-listener` or `yay -S ruuvitag-listener-bin` |
[AUR]: https://aur.archlinux.org/packages/ruuvitag-listener
[Crates.io]: https://crates.io/crates/ruuvitag-listener
## Usage
```sh
ruuvitag-listener
```
Running `ruuvitag-listener` will output measurements to STDOUT until interrupted.
Example output:
```
ruuvi_measurement,name=F7:2A:60:0D:6E:1E acceleration_x=-0.055,acceleration_y=-0.032,acceleration_z=0.998,battery_potential=3.007,humidity=19.5,pressure=101.481,temperature=19.63 1546681652675044272
ruuvi_measurement,name=F1:FC:AA:80:4E:59 acceleration_x=0.005,acceleration_y=0.015,acceleration_z=1.036,battery_potential=2.989,humidity=17.5,pressure=101.536,temperature=21.97 1546681653451240083
ruuvi_measurement,name=F1:FC:AA:80:4E:59 acceleration_x=0.002,acceleration_y=0.017,acceleration_z=1.032,battery_potential=2.977,humidity=17.5,pressure=101.536,temperature=21.97 1546681654458923308
ruuvi_measurement,name=F7:2A:60:0D:6E:1E acceleration_x=-0.052,acceleration_y=-0.032,acceleration_z=1,battery_potential=3.013,humidity=19.5,pressure=101.481,temperature=19.63 1546681655691300729
```
You can also define the InfluxDB measurement name or aliases using command line arguments. For example
```sh
ruuvitag-listener --influxdb-measurement=ruuvi --alias F1:FC:AA:80:4E:59=Indoor --alias F7:2A:60:0D:6E:1E=Outdoor
```
```
ruuvi,name=Indoor acceleration_x=0,acceleration_y=0.017,acceleration_z=1.027,battery_potential=2.989,humidity=17.5,pressure=101.54,temperature=21.97 1546681957964524841
ruuvi,name=Outdoor acceleration_x=-0.054,acceleration_y=-0.032,acceleration_z=1.005,battery_potential=3.013,humidity=83.5,pressure=101.487,temperature=-5.63 1546681958085455294
```
All options can be listed with `ruuvitag-listener --help`.
## Development
Use [cargo](https://doc.rust-lang.org/stable/cargo/) to build the project to target/debug directory:
```sh
cargo build
```
Tests can be run with
```sh
cargo test
```
## License
MIT