Elvio Sebastianelli
345b200113
* Worker for ble devices scanning
Added a worker that scan for ble devices and notify, by mqtt, presence of mac addresses and rssi.
Configuration section example:
....
workers:
blescanmulti:
args:
devices:
nut: xx:xx:xx:xx:xx:xx
ionic: xx:xx:xx:xx:xx:xx
topic_prefix: blescan
update_interval: 60
...
* Update README.md
blescanmulti worker added
* Update config.yaml.example
Added configuration section for blescanmulti worker
* Converted blescanmulti.py indentation to 2 spaces
* changed mqtt message syntax
* Update README.md
Added contributor repos url
* Update .gitignore
Removed .vscode/
* Delete settings.json
* Changes by pull request review 11/01/2019
On branch master
modified: workers/blescanmulti.py
bt-mqtt-gateway
A simple Python script which provides a Bluetooth to MQTT gateway, easily extensible via custom workers.
See Wiki for more information.
Features
- Highly extensible via custom workers
- Data publication via MQTT
- Configurable topic and payload
- MQTT authentication support
- Systemd service
- Reliable and intuitive
- Tested on Raspberry Pi Zero W
Supported devices
- EQ3 Bluetooth smart thermostat via python-eq3bt
- Xiaomi Mi Scale
- Linak Desk via linak_bt_desk
- MySensors
- Xiaomi Mi Flora plant sensor via miflora
- Xiaomi Aqara thermometer via mithermometer
- Bluetooth Low Power devices (BLE)
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisites
python3>= 3.5pip3
Installation
On a modern Linux system, just a few steps are needed to get the gateway working. The following example shows the installation under Debian/Raspbian:
sudo apt-get install git python3 python3-pip bluetooth bluez
git clone https://github.com/zewelor/bt-mqtt-gateway.git
cd bt-mqtt-gateway
sudo pip3 install -r requirements.txt
Configuration
All worker configuration is done in the file config.yaml.
This file needs to be created first:
cp config.yaml.example config.yaml
vim config.yaml
./gateway.py
Attention: You need to add at least one worker to your configuration. Scan for available Bluetooth devices in your proximity with the command:
sudo hcitool lescan
Execution
A test run is as easy as:
sudo ./gateway.py
Debug output can be displayed using the -d argument:
sudo ./gateway.py -d
Deployment
Continuous background execution can be done using the example Systemd service unit provided.
sudo cp bt-mqtt-gateway.service /etc/systemd/system/
sudo vim /etc/systemd/system/bt-mqtt-gateway.service
sudo systemctl daemon-reload
sudo systemctl start bt-mqtt-gateway
sudo systemctl status bt-mqtt-gateway
sudo systemctl enable bt-mqtt-gateway
Attention:
You need to define the absolute path of gateway.py in bt-mqtt-gateway.service.
Custom worker development
Built With
- Python - The high-level programming language for general-purpose programming
Authors
- zewelor - Initial work
- bbbenji - Minor contributions
- elviosebastianelli - BLEscanmulti
- jumping2000 - BLEscan
License
This project is licensed under the MIT License - see the LICENSE.md file for details