Files
bt-mqtt-gateway/README.md
T
2018-05-08 18:37:59 +02:00

1.9 KiB

bt-mqtt-gateway

Python script which creates a Bluetooth to MQTT gateway. Includes example config for a Bluetooth thermostat.

Supported devices

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
pip3
python3-serial

Installing

Clone repo

git clone https://github.com/zewelor/bt-mqtt-gateway.git

Install requirements

pip install -r requirements.txt

Copy and customize config file

cp config.yaml.example config.yaml

Run

./gateway.py

Deployment

This project includes an example Systemd service unit. In order to use it, copy bt-mqtt-gateway.service to /etc/systemd/system/. Edit the new file to use the correct absolute script paths and enable/start it.

sudo systemctl enable bt-mqtt-gateway
sudo systemctl start bt-mqtt-gateway

Built With

  • Python - The high-level programming language for general-purpose programming

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details