Common Java utility library for RuuviTag related things, ie. RuuviTag raw data parsing
Clone or download
Latest commit 0b3b334 Jan 13, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Merge pull request #2 from ssalonen/polishing Jan 13, 2019
.gitignore Javadoc for getters Jan 13, 2019
LICENSE
README.md Initial commit Jan 6, 2019
pom.xml Added tests Jan 13, 2019

README.md

RuuviTag Common

ruuvitag-common is a library of utilities to work with RuuviTags, main purpose is providing parsers for parsing raw data from RuuviTags

WARNING: This library is currently being developed, breaking changes will most likely happen in the near future, additionally the current code is UNTESTED, blindly refactored out of RuuviCollector

That being said, comments, suggestions and other contributions are more than welcome. :)

TODO: decide best proper/best naming convention TODO: general refactoring and cleanup TODO: check javadoc and comments TODO: write proper documentation TODO: write tests TODO: publish to maven central to avoid needing to build the library locally

How to use

  1. Clone this repository
  2. Build and install the library locally: mvn clean install
  3. Add the dependency to your project:
<dependency>
    <groupId>fi.tkgwf.ruuvi</groupId>
    <artifactId>ruuvi-common</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</dependency>
  1. Use the library in your code:
import fi.tkgwf.ruuvi.common.bean.RuuviMeasurement;
import fi.tkgwf.ruuvi.common.parser.DataFormatParser;
import fi.tkgwf.ruuvi.common.parser.impl.AnyDataFormatParser;

public class Example {

    public void showTemperature() {
        DataFormatParser parser = new AnyDataFormatParser();
        byte[] rawData = getRawDataFromSomewhere();
        RuuviMeasurement measurement = parser.parse(rawData);
        System.out.println("Temperature is " + measurement.getTemperature());
    }
}