Skip to content

A Homebridge plugin that integrates Bluetooth devices communicating via the BTHome protocol into Apple HomeKit.

License

Notifications You must be signed in to change notification settings

byonchev/homebridge-bthome

Repository files navigation

homebridge-bthome

Homebridge plugin for integrating BTHome devices into HomeKit

npm verified-by-homebridge

Overview

homebridge-bthome enables seamless integration of Bluetooth devices that communicate using the BTHome data format into your HomeKit setup.

It works locally — no gateways or cloud services are required. The plugin connects directly to supported devices.

Prerequisites

To utilize this plugin, ensure that:

  • Your Homebridge setup includes Bluetooth hardware.
  • The necessary drivers for your Bluetooth hardware are installed and functioning correctly.

Configuration

This plugin does not automatically add all discovered BTHome devices. Each device must be manually configured.

Required Fields:

  • Device MAC Address: The unique MAC address of the device must be specified.
  • Encryption Key (if applicable): If the device payload is encrypted, you must provide the encryption key. Note that the plugin does not share or store this key outside the configuration file.

Supported Sensor Types

  • Air Quality (PM2.5, PM10 and VOC)
  • Battery Level
  • Push Button
  • Carbon Dioxide Levels
  • Carbon Monoxide Detection
  • Contact Detection
  • Relative Humidity
  • Illuminance
  • Motion Detection
  • Occupancy Detection
  • Smoke Detection
  • Temperature

Supported Devices

Device Support status Tested
Shelly BLU H&T ✔️ ✔️
Shelly BLU Motion ✔️ ✔️
Shelly BLU Door/Window ✔️ ✔️
Shelly BLU Button ✔️
Shelly BLU Wall Switch ✔️
Shelly BLU RC Button ✔️
Shelly BLU TRV Partial support*

If you own some of the untested devices and the plugin works for you, please let me know so I can update its status.

Notes:

  • * Partial support: The BTHome protocol is one-way (read-only), which means Homebridge can only receive data from these devices. If a device requires additional features that depend on sending data back (e.g., configuration changes, control commands, switching modes), those functions will not be available while using this plugin.

Supported Features

Feature Support Status
Encryption ✔️
Multiple Sensor Readings of Same Type ✔️
Multiple Bluetooth Devices*
EVE Services & Characteristics Planned
Fakegato Planned

Notes:

  • * Multiple Bluetooth Devices: If your setup includes multiple Bluetooth devices, the plugin will default to using the first available device.

Contributing

We welcome contributions! If you would like to contribute, please create an issue first, detailing the feature or functionality you intend to implement and the device you are working with.

Pull requests are encouraged and appreciated!

About

A Homebridge plugin that integrates Bluetooth devices communicating via the BTHome protocol into Apple HomeKit.

Topics

Resources

License

Stars

Watchers

Forks