Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thomasleveil/bluetooth-beacon-mqtt-exporter
a nodejs service publishing Bluetooth BLE beacons' advertisements on a mqtt topic
https://github.com/thomasleveil/bluetooth-beacon-mqtt-exporter
beacon ble bluetooth-low-energy docker-image iot mqtt
Last synced: about 1 month ago
JSON representation
a nodejs service publishing Bluetooth BLE beacons' advertisements on a mqtt topic
- Host: GitHub
- URL: https://github.com/thomasleveil/bluetooth-beacon-mqtt-exporter
- Owner: thomasleveil
- Created: 2018-12-23T00:33:27.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-02T15:35:25.000Z (almost 6 years ago)
- Last Synced: 2024-11-01T22:47:27.460Z (about 2 months ago)
- Topics: beacon, ble, bluetooth-low-energy, docker-image, iot, mqtt
- Language: JavaScript
- Homepage: https://hub.docker.com/r/tomdesinto/bluetooth-beacon-mqtt-exporter
- Size: 30.3 KB
- Stars: 4
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Documentation][badge-doc]][doc] [![npm version][badge-npm]][npm] [![Docker Hub][badge-docker-hub]][hub] [](https://microbadger.com/images/tomdesinto/bluetooth-beacon-mqtt-exporter "Get your own image badge on microbadger.com") [![Dockerfile][badge-dockerfile]][dockerfile] [![][badge-github]][github]
----
bluetooth-beacon-mqtt-exporter
==============================
This is a service running on node v8 publishing Bluetooth BLE beacons advertisements on a mqtt topic.
The original intent is to make available to node-RED temperature readings from Estimote beacons ; but this will work with any beacon advertisement supported by the [node-beacon-scanner](https://github.com/futomi/node-beacon-scanner) module.
Dependencies
------------
```sh
sudo apt-get install bluetooth
```
and the bluetooth-beacon-mqtt-exporter command must be run as `root`.
Install
-------
```sh
npm install bluetooth-beacon-mqtt-exporter
```
Run
---
```sh
sudo bluetooth-beacon-mqtt-exporter
```
Configuration
-------------
Configuration is provided throught environment variables:
```sh
MQTT_BROKER=mqtt://127.0.0.1 # url of a mqtt broker. For accepted protocols, refer to https://github.com/mqttjs/MQTT.js#connect
MQTT_TOPIC=beacon # mqtt topic beacon' advertisements will be published to
MQTT_RECONNECT_DELAY=5000 # in case of a mqtt disconnection, will wait this amount of milliseconds before retrying to connect
LOG_PACKETS=no # yes/on/true/1 to log every advertisement package to the console
```
Docker image for Raspberry pi
-----------------------------
A Docker image for arm is published on the Docker Hub: [tomdesinto/bluetooth-beacon-mqtt-exporter][hub]
```sh
sudo apt-get install bluetooth
sudo service bluetooth start
docker run -d \
--net=host \
--privileged \
-e MQTT_BROKER=mqtt://127.0.0.1 \
-e MQTT_TOPIC=beacon \
-e LOG_PACKETS=yes \
tomdesinto/bluetooth-beacon-mqtt-exporter:rpi
```
### docker-compose.yml
```yaml
version: "3"
services:
beaconmqtt:
image: tomdesinto/bluetooth-beacon-mqtt-exporter:rpi
network_mode: host
privileged: true
environment:
MQTT_BROKER: mqtt://127.0.0.1
MQTT_TOPIC: beacon
MQTT_RECONNECT_DELAY: 5000
LOG_PACKETS: "yes"
```
Hack
----
### Install dependencies
```
sudo apt-get install bluetooth bluez libbluetooth-dev libudev-dev
```
### Run the services
```
sudo service bluetooth start
sudo MQTT_BROKER=mqtt://127.0.0.1 MQTT_TOPIC=beacon npm run start
```
[doc]: https://github.com/thomasleveil/bluetooth-beacon-mqtt-exporter#readme
[hub]: https://hub.docker.com/r/tomdesinto/bluetooth-beacon-mqtt-exporter
[npm]: https://www.npmjs.com/package/bluetooth-beacon-mqtt-exporter
[github]: https://github.com/thomasleveil/bluetooth-beacon-mqtt-exporter
[dockerfile]: https://github.com/thomasleveil/bluetooth-beacon-mqtt-exporter/blob/master/Dockerfile
[badge-doc]: https://img.shields.io/badge/-documentation-blue.svg
[badge-npm]: https://badge.fury.io/js/bluetooth-beacon-mqtt-exporter.svg
[badge-github]: https://img.shields.io/badge/-Github-gray.svg?logo=github&style=social
[badge-docker-hub]: https://img.shields.io/badge/Docker%20image-rpi-blue.svg?logo=docker
[badge-dockerfile]: https://img.shields.io/badge/-Dockerfile-blue.svg?logo=docker