Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/reelyactive/barnacles-mqtt

Distribute ambient IoT sensor data from Pareto Anywhere open source middleware via MQTT. We believe in an open Internet of Things.
https://github.com/reelyactive/barnacles-mqtt

dynamb iot mqtt pareto-anywhere raddec spatem

Last synced: 5 days ago
JSON representation

Distribute ambient IoT sensor data from Pareto Anywhere open source middleware via MQTT. We believe in an open Internet of Things.

Host: GitHub
URL: https://github.com/reelyactive/barnacles-mqtt
Owner: reelyactive
License: mit
Created: 2024-12-27T20:12:54.000Z (6 days ago)
Default Branch: master
Last Pushed: 2024-12-27T22:58:42.000Z (6 days ago)
Last Synced: 2024-12-27T23:38:07.944Z (6 days ago)
Topics: dynamb, iot, mqtt, pareto-anywhere, raddec, spatem
Language: JavaScript
Homepage: https://www.reelyactive.com/pareto/anywhere/
Size: 44.9 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        barnacles-mqtt

==============

__barnacles-mqtt__ distributes ambient IoT sensor data via MQTT.

![Overview of barnacles-mqtt](https://reelyactive.github.io/barnacles-mqtt/images/overview.png)

__barnacles-mqtt__ ingests a real-time stream of _raddec_ & _dynamb_ objects from [barnacles](https://github.com/reelyactive/barnacles/) and/or _spatem_ objects from [chimps](https://github.com/reelyactive/chimps/) which it publishes via MQTT.  It couples seamlessly with reelyActive's [Pareto Anywhere](https://www.reelyactive.com/pareto/anywhere/) open source IoT middleware.

__barnacles-mqtt__ is a lightweight [Node.js package](https://www.npmjs.com/package/barnacles-mqtt) that can run on resource-constrained edge devices as well as on powerful cloud servers and anything in between.

Topics

------

__barnacles-mqtt__ observes the following topic hierarchy which matches the `/devices` API of [barterer](https://github.com/reelyactive/barterer/), with an optional prefix:

- "paretoanywhere" (or `topicPrefix`: see [Options](#Options))

- "devices"

- [deviceId]

- [deviceIdType]

- raddec / dynamb / spatem

For instance, a _dynamb_ associated with a Bluetooth Low Energy device having the public address `001122334455` would be published to `paretoanywhere/devices/001122334455/2/dynamb`

The MQTT single-level wildcard (+) can be used to subscribe to all event types for a given device, for example: `paretoanywhere/devices/001122334455/2/+`

The MQTT multi-level wildcard (#) can be used to subscribe to all events from all devices, for example: `paretoanywhere/#`

Options

-------

__barnacles-mqtt__ supports the following options:

| Property      | Default            | Description                       | 

|:--------------|:-------------------|:----------------------------------|

| client        | null               | Optional instantiated MQTT client |

| url           | "mqtt://localhost" | Local MQTT broker                 |

| clientOptions | {}                 | See [mqtt.Client(, options)](https://github.com/mqttjs/MQTT.js?tab=readme-ov-file#client) |

| topicPrefix   | "paretoanywhere"   | Precedes /devices/...             |

| printErrors   | false              | Print MQTT errors?                |

__barnacles-mqtt__ will use any existing MQTT client provided via the `client` option, else it will instantiate its own, observing any `url` and `clientOptions` properties.

Contributing

------------

Discover [how to contribute](CONTRIBUTING.md) to this open source project which upholds a standard [code of conduct](CODE_OF_CONDUCT.md).

Security

--------

Consult our [security policy](SECURITY.md) for best practices using this open source software and to report vulnerabilities.

License

-------

MIT License

Copyright (c) 2024 [reelyActive](https://www.reelyactive.com)

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.