# ruuvi-sensor-protocol-rs [![Crates.io](https://img.shields.io/crates/v/ruuvi-sensor-protocol.svg)](https://crates.io/crates/ruuvi-sensor-protocol) [![Docs.rs](https://docs.rs/ruuvi-sensor-protocol/badge.svg)](https://docs.rs/ruuvi-sensor-protocol) [![Crates.io](https://img.shields.io/crates/l/ruuvi-sensor-protocol.svg)](https://crates.io/crates/ruuvi-sensor-protocol)

Ruuvi sensor protocol parser implementation

## Requirements
- Rust `>= 1.60`
  - This crate can be compiled without `std` by disabling default features

## Crate Features
- `std` (default) enables features that depend on `std` crate
- `gateway` adds parsers for Ruuvi Gateway payload formats, adds `hex`, `serde` and `serde_json` dependencies and requires `alloc` crate from the standard library

## Documentation
Docs are available online at
[docs.rs](https://docs.rs/ruuvi-sensor-protocol). They can be built
from source with `cargo doc`. Examples are included in the docs.

## Changes

### `0.6.1`
- Build documentation with all features for docs.rs

### `0.6.0`
- Requires 2021 Edition (Rust `>= 1.60`)
- Support for parsing Ruuvi Gateway MQTT message payloads
  - It is disabled by default, but can be enabled with `gateway` feature

### `0.5.0`
- Requires Rust `>= 1.48`
- Adds `Clone` trait for `SensorValues` and `ParseError`
- Use `AsRef<[u8]>` as type bound for value in `from_manufacturer_specific_data`

### `0.4.1`
- Corrected `ZERO_CELSIUS_IN_MILLIKELVINS` constant

### `0.4.0`
- Requires Rust `>= 1.34`
- Add support for [data format 5 (RAWv2)](https://docs.ruuvi.com/communication/bluetooth-advertisements/data-format-5-rawv2).

### `0.3.0`
- Requires 2018 Edition (Rust `>= 1.31`)
- Adds option to compile without `std` create

## License
This project is licensed under [MIT license](LICENSE).