Skip to content

Commit

Permalink
Update readme ahead of new release
Browse files Browse the repository at this point in the history
  • Loading branch information
8none1 committed Jan 25, 2025
1 parent 5b21ef8 commit c38d489
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 14 deletions.
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,30 @@
# LEDnetWF_ble

Home Assistant custom integration for LEDnetWF devices which are not supported on the official LEDBLE integration. WIP
Home Assistant custom integration for LEDnetWF devices which use the Zengge Android or iPhone app. WIP

## Important note for upgraders

If, after upgrading, your devices suddenly don't work, please delete them via the UI and re-add them again. There are a number of new features which require
new metadata to be discovered at the setup phase. This may not be present on existing devices.
If this doesn't work you can roll back to a previous release via HACS, and please log an issue with the details of your problem.

## Supported devices

This have only been tested with Zengge LEDnetWF devices, may also be known as:
This integration supports various models of Zengge LEDnetWF devices, which may also be known as:

- Zengge LEDnetWF
- YBCRG-RGBWW
- Magic Hue
- Bluetooth full colors selfie ring light

New devices using the Zengge platform are being released all the time. We support as many of these as we can. If you have a device which isn't supported, please log an issue and we will work with you to try and add support.

## Supported Features

- Automatic discovery of supported devices
- On/Off
- White / Color temperature mode
- RGB mode (With included turn off circle effect)
- RGB mode
- Brightness
- Effects
- Live status updates from remote control (once connected)
Expand All @@ -33,14 +41,9 @@ Clone this repository into `config/` Home Assistant folder.

### HACS

- Navigate to HACS from the side bar in Home Assistant
- Click "Integrations"
- Click the three dots in the top right corner
- Click Custom Repositories
- Paste [Github URL](https://github.com/raulgbcr/lednetwf_ble) to this repo in to the Repository box
- Choose Integration from the Category
- Click Add
- You may need to restart Home Assistant
This integration is now available from within HACS.

Search for "LEDnetWF BLE" and click install. You will also get notified of future upgrades.

### Config

Expand All @@ -52,8 +55,7 @@ After setting up, you can config two parameters Settings -> Integrations -> LEDn

This integration is possible thanks to the work of this incredible people!

- https://github.com/8none1/zengge_lednetwf for reverse engineering and decoding the protocol used by the BLE controller!
- https://github.com/dave-code-ruiz/elkbledom for most of the base code adapted to this integration.
- https://github.com/dave-code-ruiz/elkbledom for most of the base Home Assistant integration code adapted for this integration.
- https://openclipart.org/detail/185270/light-bulb-icon for the original icon.

Thanks!
2 changes: 1 addition & 1 deletion custom_components/lednetwf_ble/models/model_0x56.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
LOGGER = logging.getLogger(__name__)

import colorsys
from homeassistant.components.light import (
from homeassistant.components.light import ( # type: ignore
ColorMode,
EFFECT_OFF
)
Expand Down

0 comments on commit c38d489

Please sign in to comment.