Skip to content

Commit

Permalink
docs: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vsternbach authored Nov 5, 2023
1 parent 610b1d5 commit dfb9b89
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# Homebridge Yeelight BLE

This is a Homebridge plugin that allows controlling Yeelight bluetooth lamps Candela and Bedside Lamp (although tested only with Candela).
This is a Homebridge plugin to control Yeelight bluetooth lamps Candela and Bedside Lamp (although tested only with Candela).

## Setup

This plugin requires installation of a python library [yeelightble](https://github.com/vsternbach/yeelightble) that handles all the bluetooth communication with devices and listens for control commands/publishes lamp state through WebSocket.
This plugin requires installation of a python library [yeelightble](https://github.com/vsternbach/yeelightble) that handles all the bluetooth communication with devices and listens for control commands and publishes lamp state through WebSocket.

It's supposed to run on RPI and was not tested on other platforms.

## Native Solution

I've also tried implementing this library [natively](https://github.com/vsternbach/homebridge-yeelight-ble/tree/native) in javascript using [node-ble](https://github.com/chrvadala/node-ble) library, but from my testing, it's just not stable enough, seems that node-ble or dbus-next it relies on are buggy and leaking on event listeners, if someone's willing to debug and make it stable PRs are welcome!

0 comments on commit dfb9b89

Please sign in to comment.