https://github.com/kirbo/ruuvitag-parser
This is a mirror repository. Please contribute here: https://gitlab.com/kirbo/ruuvitag-parser
https://github.com/kirbo/ruuvitag-parser
parser ruuvitag ruuvitag-sensor typescript
Last synced: 19 days ago
JSON representation
This is a mirror repository. Please contribute here: https://gitlab.com/kirbo/ruuvitag-parser
- Host: GitHub
- URL: https://github.com/kirbo/ruuvitag-parser
- Owner: Kirbo
- License: mit
- Created: 2021-09-10T09:19:49.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T12:48:07.000Z (over 3 years ago)
- Last Synced: 2025-03-02T01:31:02.200Z (over 1 year ago)
- Topics: parser, ruuvitag, ruuvitag-sensor, typescript
- Language: TypeScript
- Homepage:
- Size: 351 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING
- License: LICENSE
Awesome Lists containing this project
README
# RuuviTag Parser
This repository is heavily influenced/inspired by [pakastin/node-ruuvitag](https://github.com/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:
```typescript
import { parseData } from 'ruuvitag-parser'
const jsonData = parseData(dataFromRuuvitag)
```
### Parse Dataformat v2 and v4
Just to parse the data, use like this:
```typescript
import { parseUrl } from 'ruuvitag-parser'
const jsonData = parseUrl(dataFromRuuvitag)
```
### Parse Eddystone URL
```typescript
import { parseEddystone } from 'ruuvitag-parser'
const url = parseEddystone(eddystoneUrlBuffer)
```
Few examples can be found from [integration tests](https://gitlab.com/kirbo/ruuvitag-parser/-/blob/master/tests/ruuvitag-parser.integration.test.ts):
- [Import `parseData`](https://gitlab.com/kirbo/ruuvitag-parser/-/blob/master/tests/ruuvitag-parser.integration.test.ts#L1)
- [Parse v2 data](https://gitlab.com/kirbo/ruuvitag-parser/-/blob/master/tests/ruuvitag-parser.integration.test.ts#L129)
- [Parse v3 data](https://gitlab.com/kirbo/ruuvitag-parser/-/blob/master/tests/ruuvitag-parser.integration.test.ts#L144)
- [Parse v3 data](https://gitlab.com/kirbo/ruuvitag-parser/-/blob/master/tests/ruuvitag-parser.integration.test.ts#L171)
- [Parse v5 data](https://gitlab.com/kirbo/ruuvitag-parser/-/blob/master/tests/ruuvitag-parser.integration.test.ts#L192)
- [Parse MQTT message](https://gitlab.com/kirbo/ruuvitag-parser/-/blob/master/tests/ruuvitag-parser.integration.test.ts#L233)
- [Parse Eddystone URL](https://gitlab.com/kirbo/ruuvitag-parser/-/blob/master/tests/ruuvitag-parser.integration.test.ts#L281)
## Contribute
This repository is being developed in [GitLab](https://gitlab.com/kirbo/ruuvitag-parser).
CI/CD Pipeline can be [found here](https://gitlab.com/kirbo/ruuvitag-parser/-/pipelines).
CI/CD Pipeline uses [go-semantic-release](https://github.com/go-semantic-release/semantic-release) for automated
releases. Because of this, developers should follow [these instructions](https://www.conventionalcommits.org/en/v1.0.0/#examples)
for commit message formatting.
The commits are being analyzed with [this extension](https://github.com/go-semantic-release/commit-analyzer-cz#how-the-commit-messages-are-analyzed)
and it requires developers to format commit messages in certain way.
Read more about:
- [Semantic Versioning (SemVer)](https://semver.org/#semantic-versioning-200)
- [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary)
### Cheat Sheets
- [Kapeli.com](https://kapeli.com/cheat_sheets/Conventional_Commits.docset/Contents/Resources/Documents/index)
- [cheatography.com](https://cheatography.com/albelop/cheat-sheets/conventional-commits/)
- [megamorf.gitlab.io](https://megamorf.gitlab.io/cheat-sheets/conventional-commits/)
The [GitHub repository](https://github.com/kirbo/ruuvitag-parser) is only a mirror from GitLab.
Please make Merge Requests in [GitLab](https://gitlab.com/kirbo/ruuvitag-parser/-/merge_requests).
## Releases / Changes
Releases and "changelogs" can be [found here](https://gitlab.com/kirbo/ruuvitag-parser/-/tags).
Each releases description contains the changes that the version includes, e.g.: [v0.2.14](https://gitlab.com/kirbo/ruuvitag-parser/-/tags/v0.2.14).
## Links
- [GitLab repository](https://gitlab.com/kirbo/ruuvitag-parser) - this is where the development happens.
- [GitHub repository](https://github.com/kirbo/ruuvitag-parser) - this is only mirroring the GitLab repository.
- [npm package](https://www.npmjs.com/package/ruuvitag-parser) - 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.