2022-04-21 20:40:52 +02:00
# Exporter for the MightyOhm Geiger Counter [![status-badge](https://ci.onders.org/api/badges/finga/mightyohm-gc-exporter/status.svg)](https://ci.onders.org/finga/mightyohm-gc-exporter)
A Prometheus exporter for the [MightyOhm Geiger Counter ](https://mightyohm.com/blog/products/geiger-counter/ ).
## Build
2022-04-24 18:14:26 +02:00
Cargo, the Rust package manager, is used to build this project.
2022-04-21 20:40:52 +02:00
### Same architecture as system
2022-04-24 18:14:26 +02:00
Compile it for the same architecture as the build system:
2022-04-21 20:40:52 +02:00
```sh
cargo build --release
```
2022-04-24 18:14:26 +02:00
### Cross-compile for amd64 (recent RaspberryPi)
Cross-compile it for the amd64 architecture:
2022-04-21 20:40:52 +02:00
```sh
PKG_CONFIG_SYSROOT_DIR=/usr/aarch64-linux-gnu cargo build --target aarch64-unknown-linux-gnu --release
```
2022-04-24 18:14:26 +02:00
## Debian
To build a package for Debian, Raspbian, and so on,
[`cargo-deb` ](https://crates.io/crates/cargo-deb ) can be used.
The package comes with an automatically started and enabled systemd
service unit which can be configured via
`/etc/default/mightyohm-gc-exporter` .
### Same architecture as system
Build a `deb` package for the same architecture as the build system:
```sh
cargo deb
```
### Cross-compile for amd64 (recent RaspberryPi)
Build a `deb` package for the amd64 architecture:
```sh
PKG_CONFIG_SYSROOT_DIR=/usr/aarch64-linux-gnu cargo deb --target aarch64-unknown-linux-gnu
```
## Usage
```
USAGE:
mightyohm-gc-exporter [OPTIONS]
OPTIONS:
-a, --address < ADDRESS > The IPv4 or IPv6 address where the metrics are served
[default: 127.0.0.1]
-b, --baud-rate < BAUD_RATE > The baudrate of the serial connection [default: 9600]
-h, --help Print help information
-p, --port < PORT > The port where the metrics are served [default: 9111]
-s, --serial-port < SERIAL_PORT > The port of the serial device, usually in '/dev/...'
[default: /dev/serial0]
-t, --timeout < TIMEOUT > Timeout of the serial connection in ms [default: 1000]
-V, --version Print version information
```