barnacles-mqtt distributes ambient IoT sensor data via MQTT.
barnacles-mqtt ingests a real-time stream of raddec & dynamb objects from barnacles and/or spatem objects from chimps which it publishes via MQTT. It couples seamlessly with reelyActive's Pareto Anywhere open source IoT middleware.
barnacles-mqtt is a lightweight Node.js package that can run on resource-constrained edge devices as well as on powerful cloud servers and anything in between.
barnacles-mqtt observes the following topic hierarchy which matches the /devices API of barterer, with an optional prefix:
- "paretoanywhere" (or
topicPrefix: see 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/#
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) |
| 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.
Discover how to contribute to this open source project which upholds a standard code of conduct.
Consult our security policy for best practices using this open source software and to report vulnerabilities.
MIT License
Copyright (c) 2024 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.