kirbo/ruuvitag-parser

This is a mirror repository. Please contribute here: https://gitlab.com/kirbo/ruuvitag-parser

RuuviTag Parser

This repository is heavily influenced/inspired by pakastin/node-ruuvitag, which I also took as a base and did some heavy refactoring, as well as converting the old JavaScript files into TypeScript.

!! This repository is still a work in progress !!

This module only handles the parsing. It wont scan the sensors or any other shenanigans.

Usage examples

Parse Dataformat v3 and v5

Just to parse the data, use like this:

import { parseData } from 'ruuvitag-parser'

const jsonData = parseData(dataFromRuuvitag)

Parse Dataformat v2 and v4

Just to parse the data, use like this:

import { parseUrl } from 'ruuvitag-parser'

const jsonData = parseUrl(dataFromRuuvitag)

Parse Eddystone URL

import { parseEddystone } from 'ruuvitag-parser'

const url = parseEddystone(eddystoneUrlBuffer)

Few examples can be found from integration tests:

• Import parseData
• Parse v2 data
• Parse v3 data
• Parse v3 data
• Parse v5 data
• Parse MQTT message
• Parse Eddystone URL

Contribute

This repository is being developed in GitLab. CI/CD Pipeline can be found here.

CI/CD Pipeline uses go-semantic-release for automated releases. Because of this, developers should follow these instructions for commit message formatting.

The commits are being analyzed with this extension and it requires developers to format commit messages in certain way.

Read more about:

• Semantic Versioning (SemVer)
• Conventional Commits

Cheat Sheets

• Kapeli.com
• cheatography.com
• megamorf.gitlab.io

The GitHub repository is only a mirror from GitLab. Please make Merge Requests in GitLab.

Releases / Changes

Releases and "changelogs" can be found here. Each releases description contains the changes that the version includes, e.g.: v0.2.14.

Links

• GitLab repository - this is where the development happens.
• GitHub repository - this is only mirroring the GitLab repository.
• npm package - published npm package.

License

MIT License

Copyright (c) 2021 Kimmo Saari

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.