advlib-interoperable

Interpreter of InteroperaBLE identifiers. advlib-interoperable can be used standalone or, more commonly, as an interpreter module of the protocol-agnostic advlib library.

Installation

npm install advlib-interoperable

Hello advlib-interoperable!

const interpreter = require('advlib-interoperable');

let packet = {
    deviceIds: [ "496f49445554462d3332/00000001f989" ]
};
interpreter.interpret(packet);

console.log(packet);

Which should yield the following console output:

{ deviceIds: [ "496f49445554462d3332/00000001f989" ],
  unicodeCodePoints: [ 129417 ] }

Supported Entity UUIDs (non-URI)

advlib-interoperable supports the following Entity UUIDs which have specific interpretations other than conversion to a URI:

| Entity UUID | Interpretation | |:-------------------------------------|:-------------------| | 496f4944-434f-4445-b73e-5554462d3332 | Unicode Code Point | | 496f4944-434f-4445-b73e-446972416374 | DirAct | | 496f4944-434f-4445-b73e-427574746f6e | Button | | 496f4944-434f-4445-b73e-4d6f74696f63 | Motion | | 496f4944-434f-4445-b73e-425553616665 | BlueUp Safety |

The Entity UUIDs above can be represented in elided UUID format by removing the 48-bit sequence -434f-4445-b73e- as explained here.

Supported Entity UUIDs (URI)

advlib-interoperable supports the following Entity UUIDs which have specific interpretations regarding conversion to a URI:

| Entity UUID | URI Interpretation | |:-------------------------------------|:-------------------| | 496f4944-434f-4445-b73e-2e2f2e6d7033 | file:/xxxxxxx.mp3 |

The Entity UUIDs above can be represented in elided UUID format by removing the 48-bit sequence -434f-4445-b73e- as explained here.

Contributing

Discover how to contribute to this open source project which upholds a standard code of conduct.

Security

Consult our security policy for best practices using this open source software and to report vulnerabilities.

License

MIT License

Copyright (c) 2021-2023 reelyActive

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.