"threshold" parameter to the device to set the limit in
second when the device is considered away. The default value is 180 seconds.Redmond RK-G2xxS series (type: redmond_rk_g200)
The default key that is used is "ffffffffffffffff"
and can be omitted in the config.
In some cases kettles don't accept it. Just use another
key in the config file for the device:
"key": "16 random hex numbers"
Mi Kettle (type: mikettle)
Use correct product_id for your kettle:
131275 (default)1116Redmond RMC-M225S, RMC-M227S (type: redmond_rmc_m200)
Notes about the key parameter you can read above for the Redmond kettles. Other RMC multi-cookers may need adjustments for the list of available programs, it depends on the device panel.
Generic AM43 (type: am43)
Manufacturer can be A-OK, Zemismart, etc.
Soma Shades (type: soma_shades)
Ensto EPHBEBT10PR, EPHBEBT15PR (type: ensto_thermostat)
These devices require manual pairing.
After the device is paired on the host device, see the logs for the key and
put it to the config.
The adapter uses holiday mode to control temperature as thermostat. You cannot use this feature in the official app while ble2mqtt is working.
LifeControl MCLH-09 (type: mclh09)
optionally, polling interval can be configured with interval parameter in seconds
Xiaomi Mi Flora (type: miflora)
optionally, polling interval can be configured with interval parameter in seconds
By default, a device works in the passive mode without connection by
listening to advertisement packets from a device.
To use connection to the device provide "passive": false parameter.
Supported devices in passive mode:
Some devices (e.g. Ensto heaters) require paired connection to work with it. You need to pair the device with linux machine before using it.
Find out MAC addresses of your devices. Put the device in pairing mode if it is supported.
Open console and run bluetoothctl command. It is a command line tool to work with BLE devices.
Wait for the prompt
[bluetooth]#
Print a command to enable scanning. Linux must know the device is present before pairing.
[bluetooth]# scan on
Wait for MAC address of the device appears in the list of found devices. Print a pairing command (replace MAC address to the one from your device)
[bluetooth]# pair 90:fd:00:00:00:01
On successful pairing you'll see a message:
[CHG] Device 90:FD:00:00:00:01 Paired: yes
Pairing successful
You can proceed with the next configuration steps now.
If using SELinux and you are experience issues, see README.md.
Use this software at your own risk.
Default config should be located in /etc/ble2mqtt.json or
can be overridden with BLE2MQTT_CONFIG environment variable.
Example run command:
BLE2MQTT_CONFIG=./ble2mqtt.json ble2mqtt
The configuration file is a JSON with the following content:
{
"mqtt_host": "localhost",
"mqtt_port": 1883,
"mqtt_user": "",
"mqtt_password": "",
"log_level": "INFO",
"devices": [
{
"address": "11:22:33:aa:cc:aa",
"type": "presence"
},
{
"address": "11:22:33:aa:bb:cc",
"type": "redmond_rk_g200",
"key": "ffffffffffffffff"
},
{
"address": "11:22:33:aa:bb:c0",
"type": "redmond_rmc_m200",
"key": "ffffffffffffffff"
},
{
"address": "11:22:33:aa:bb:c1",
"type": "ensto_thermostat",
"# see logs after pairing and put the key to config": "",
"key": "00112233"
},
{
"address": "11:22:33:aa:bb:cd",
"type": "mikettle",
"product_id": 275
},
{
"address": "11:22:33:aa:bb:de",
"type": "am43"
},
{
"address": "11:22:33:aa:bb:dd",
"type": "xiaomihtv1",
"interval": 60
},
{
"address": "11:22:34:aa:bb:dd",
"type": "xiaomihtv1",
"passive": false
},
{
"address": "11:22:33:aa:bb:ee",
"type": "xiaomilywsd"
},
{
"address": "11:22:33:aa:bb:ff",
"type": "xiaomilywsd_atc",
"interval": 60
},
{
"address": "11:22:33:aa:aa:aa",
"type": "atomfast"
},
{
"address": "11:22:33:aa:aa:bb",
"type": "voltage_bm2"
},
{
"address": "11:22:33:aa:aa:bc",
"type": "mclh09",
"interval": 600
},
{
"address": "11:22:33:aa:aa:bd",
"type": "miflora",
"interval": 500
},
{
"address": "11:22:33:aa:aa:be",
"type": "ruuvitag",
"interval": 60
},
{
"address": "11:22:33:aa:aa:0a",
"type": "roidmi_cleaner"
}
]
}
You can omit a line, then default value will be used.
Extra configuration parameters:
"base_topic"- the default value is 'ble2mqtt'"mqtt_prefix"- a prefix to distinguish ble devices from other instances and
programs. The default value is 'b2m_'."hci_adapter" - an adapter to use. The default value is "hci0"Devices accept friendly_name parameter to replace mac address in device
names for Home Assistant.
Put the following content to the unit file /etc/systemd/system/ble2mqtt.service
[Unit]
Description=ble2mqtt bridge
[Service]
Type=Simple
ExecStart=/usr/local/bin/ble2mqtt
User=ble2mqtt
Group=ble2mqtt
Wants=bluetooth.target
[Install]
WantedBy=multi-user.target
The user and group should match the owner and group of the configuration file /etc/ble2mqtt.json.
Afterwards you simply have to enable and start the service:
sudo systemctl daemon-reload
sudo systemctl enable ble2mqtt
sudo systemctl start ble2mqtt
Create the configuration file in /etc/ble2mqtt.json and append your devices.
Execute the following commands in the terminal:
opkg update
opkg install python3-ble2mqtt
/etc/init.d/ble2mqtt enable
/etc/init.d/ble2mqtt start
Execute the following commands in the terminal:
opkg update
opkg install python3-pip python3-asyncio
pip3 install "bleak>=0.11.0"
pip3 install -U ble2mqtt
Create the configuration file in /etc/ble2mqtt.json and append your devices.
Bluetooth must be turned on.
hciconfig hci0 up
Run the service in background
ble2mqtt 2> /tmp/ble2mqtt.log &
Add a service script to start:
cat <<EOF > /etc/init.d/ble2mqtt
#!/bin/sh /etc/rc.common
START=98
USE_PROCD=1
start_service()
{
procd_open_instance
procd_set_param env BLE2MQTT_CONFIG=/etc/ble2mqtt.json
procd_set_param command /usr/bin/ble2mqtt
procd_set_param stdout 1
procd_set_param stderr 1
procd_close_instance
}
EOF
chmod +x /etc/init.d/ble2mqtt
/etc/init.d/ble2mqtt enable
/etc/init.d/ble2mqtt start
Due to small CPU power and increasing number of messages from bluetoothd it is recommended to do several workarounds:
bluetoothd daily and restart ble2mqtt several times a day to
reduce increasing CPU usage.
Put the following lines to the /etc/crontabs/root10 0,7,17 * * * /etc/init.d/ble2mqtt restart
1 4,14 * * * /etc/init.d/bluetoothd restart
Build the image as:
podman build -t ble2mqtt:dev .
Start the container and share the config file and DBus for Bluetooth connectivity:
podman run \
-d \
--net=host \
-v $PWD/ble2mqtt.json.sample:/etc/ble2mqtt.json:z \
-v /var/run/dbus:/var/run/dbus:z \
ble2mqtt:dev
Instead of sharing /var/run/dbus, you can export DBUS_SYSTEM_BUS_ADDRESS.
NOTE: --net=host is required as it needs to use the bluetooth interface
NOTE: podman is the same as docker
ATTENTION: Make sure
bluezis not running (or not intalled) on your host.
Build the image as:
docker build -t ble2mqtt:dev .
Start the container and share the config file:
docker run \
-d \
--net=host \
--cap-add=NET_ADMIN \
-v $PWD/ble2mqtt.json.sample:/etc/ble2mqtt.json:ro \
ble2mqtt:dev
Docker compose:
version: '3.7'
services:
ble2mqtt:
image: ble2mqtt:dev
build: ./ble2mqtt
hostname: ble2mqtt
restart: always
environment:
- TZ=Asia/Yekaterinburg
volumes:
- ./ble2mqtt/ble2mqtt.json:/etc/ble2mqtt.json:ro
network_mode: host
cap_add:
- NET_ADMIN
You do not need sharing /var/run/dbus, because dbus will start in the container.
NOTE: --net=host and --cap-add=NET_ADMIN is required as it needs to use and control the bluetooth interface
FAQs
BLE to MQTT bridge
We found that ble2mqtt demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.