Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
advlib - npm Package Compare versions
Comparing version 1.1.5 to 1.2.0
@@ -8,3 +8,3 @@ { | ||
| }, | ||
| "description": "Library for Decoding Wireless Advertising Packets. We believe in an open Internet of Things.", | ||
| "description": "Open source, protocol-agnostic library for decoding ambient wireless packets. We believe in an open Internet of Things.", | ||
| "keywords": [ | ||
@@ -22,3 +22,3 @@ "reelyActive", | ||
| ], | ||
| "version": "1.1.5", | ||
| "version": "1.2.0", | ||
| "engines": { | ||
@@ -25,0 +25,0 @@ "node": ">=6.0.0" |
| advlib | ||
| ====== | ||
| Library for wireless advertising packet decoding. __advlib__ is protocol-agnostic and currently supports the following _processor_ modules: | ||
| - [advlib-ble](https://github.com/reelyactive/advlib-ble) for Bluetooth Low Energy | ||
| - [advlib-epc-tds](https://github.com/reelyactive/advlib-epc-tds) for RAIN RFID (Electronic Product Code Tag Data Standard) | ||
| - [advlib-esp](https://github.com/reelyactive/advlib-esp) for the EnOcean Wireless Standard (via the EnOcean Serial Protocol) | ||
| __advlib__ is a library for decoding ambient wireless packets into web-standard JSON with a vendor/technology/application-agnostic set of properties. | ||
| and the following _interpreter_ modules: | ||
| - [advlib-interoperable](https://github.com/reelyactive/advlib-interoperable) for [InteroperaBLE identifiers](https://reelyactive.github.io/diy/best-practices-ble-identifiers/#part04). | ||
|  | ||
| The _purpose_ of __advlib__ is to extract all potentially relevant information from ambient data packets and to organise this information in a consistent manner, regardless of the radio protocol. | ||
| __advlib__ is a lightweight [Node.js package](https://www.npmjs.com/package/advlib) that can run on resource-constrained edge devices as well as on powerful cloud servers and anything in between. It is included in reelyActive's [Pareto Anywhere](https://www.reelyactive.com/pareto/anywhere/) open source middleware suite with its complementary _processor_ and _interpreter_ modules. | ||
| The _objective_ of __advlib__ v1.x is to support and to make accessible the broadest array of use cases by being highly modular and by facilitating contributions to its continuous development. | ||
| __advlib__ is a lightweight [Node.js package](https://www.npmjs.com/package/advlib) that can run on resource-constrained edge devices as well as on powerful cloud servers and anything in between. It is a key element in [Pareto Anywhere](https://www.reelyactive.com/pareto/anywhere/) open source software of the [reelyActive technology platform](https://www.reelyactive.com/technology/). | ||
| Processor modules | ||
| ----------------- | ||
| __advlib__ is protocol-agnostic and currently supports the following _processor_ modules: | ||
| - [advlib-ble](https://github.com/reelyactive/advlib-ble) for Bluetooth Low Energy | ||
| - [advlib-epc-tds](https://github.com/reelyactive/advlib-epc-tds) for RAIN RFID (Electronic Product Code Tag Data Standard) | ||
| - [advlib-esp](https://github.com/reelyactive/advlib-esp) for the EnOcean Wireless Standard (via the EnOcean Serial Protocol) | ||
| Installation | ||
| ------------ | ||
| npm install advlib | ||
| Interpreter modules | ||
| ------------------- | ||
| __advlib__ currently supports the following _interpreter_ module: | ||
| - [advlib-interoperable](https://github.com/reelyactive/advlib-interoperable) for [InteroperaBLE identifiers](https://reelyactive.github.io/interoperable-identifier/). | ||
| Hello advlib | ||
| ------------ | ||
| For example, process several raw packets received from a beacon by selecting Bluetooth Low Energy as the processor ([advlib-ble](https://github.com/reelyactive/advlib-ble)) and including any relevant processor and interpreter libraries (don't forget to first install these using npm). | ||
| Hello advlib! | ||
| ------------- | ||
| For example, process several raw packets received from a beacon by selecting Bluetooth Low Energy as the processor ([advlib-ble](https://github.com/reelyactive/advlib-ble)) and including any relevant processor and interpreter libraries. | ||
| ```javascript | ||
@@ -50,3 +52,3 @@ const advlib = require('advlib'); | ||
| Packets will be combined, in order of precedence, into a single JSON: | ||
| Paste the code above into a decoder.js file. From the same folder, install package dependencies with the commands `npm install advlib`, `npm install advlib-ble`, ..., `npm install advlib-interoperable`. Then run the code with the command `node decoder.js` and observe the packets combined, in order of precedence, into a single JSON: | ||
@@ -103,3 +105,22 @@ ```javascript | ||
| See the [reelyActive Developer's Cheatsheet](https://reelyactive.github.io/diy/cheatsheet/) for more details about the standard properties above which are considered to be dynamic ambient (dynamb) data. | ||
|  | ||
| What's in a name? | ||
| ----------------- | ||
| The name __advlib__, which is derived from "advertising library", sounds like _ad-lib_, hinting at the fact that decoding [ambient data](https://www.reelyactive.com/ambient-data/) is often improvised, especially when little or no documentation is available! | ||
| The function of __advlib__ is not unlike the Babel fish in Hitchiker's Guide to the Galaxy: _"if you stick a Babel fish in your ear you can instantly understand anything said to you in any form of language."_ Hence, the Babel fish would make an obvious choice of mascot. | ||
| Why then did we choose the cuneiform symbol 𒄩 (KU<sub>6</sub>) as the __advlib__ mascot? _Something's fishy..._ | ||
| Let's _ad-lib_ shall we? The Babel fish is likely a reference to the [Tower of Babel](https://en.wikipedia.org//wiki/Tower_of_Babel) which itself is a parable meant to explain why the world's peoples speak different languages. The tower may well have existed in ancient Babylon where the Sumerian/Akkadian languages were spoken. [Cuneiform](https://en.wikipedia.org/wiki/Cuneiform), the earliest known writing system, was originally developed to write the Sumerian language. And 𒄩 is the [Sumerian cuneiform symbol for fish](https://en.wiktionary.org/wiki/%F0%92%84%A9#Sumerian). So 𒄩 can arguably be _decoded_ as Babel fish: the obvious choice of mascot indeed! | ||
| Does that seem like a completely implausable decoding of a cryptic message? Well that's exactly what __advlib__ development often seemed like over the years! | ||
| Project History | ||
@@ -132,3 +153,3 @@ --------------- | ||
| Copyright (c) 2015-2022 [reelyActive](https://www.reelyactive.com) | ||
| Copyright (c) 2015-2023 [reelyActive](https://www.reelyactive.com) | ||
@@ -135,0 +156,0 @@ 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: |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by7.07%
28417
- Number of lines in readme file
- increased by14.69%
164
No dependency changes