Skip to content

Commit c38d489

Browse files
committed
Update readme ahead of new release
1 parent 5b21ef8 commit c38d489

File tree

2 files changed

+16
-14
lines changed

2 files changed

+16
-14
lines changed

README.md

+15-13
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,30 @@
11
# LEDnetWF_ble
22

3-
Home Assistant custom integration for LEDnetWF devices which are not supported on the official LEDBLE integration. WIP
3+
Home Assistant custom integration for LEDnetWF devices which use the Zengge Android or iPhone app. WIP
4+
5+
## Important note for upgraders
6+
7+
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
8+
new metadata to be discovered at the setup phase. This may not be present on existing devices.
9+
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.
410

511
## Supported devices
612

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

915
- Zengge LEDnetWF
1016
- YBCRG-RGBWW
1117
- Magic Hue
1218
- Bluetooth full colors selfie ring light
1319

20+
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.
21+
1422
## Supported Features
1523

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

3442
### HACS
3543

36-
- Navigate to HACS from the side bar in Home Assistant
37-
- Click "Integrations"
38-
- Click the three dots in the top right corner
39-
- Click Custom Repositories
40-
- Paste [Github URL](https://github.com/raulgbcr/lednetwf_ble) to this repo in to the Repository box
41-
- Choose Integration from the Category
42-
- Click Add
43-
- You may need to restart Home Assistant
44+
This integration is now available from within HACS.
45+
46+
Search for "LEDnetWF BLE" and click install. You will also get notified of future upgrades.
4447

4548
### Config
4649

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

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

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

5961
Thanks!

custom_components/lednetwf_ble/models/model_0x56.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
LOGGER = logging.getLogger(__name__)
66

77
import colorsys
8-
from homeassistant.components.light import (
8+
from homeassistant.components.light import ( # type: ignore
99
ColorMode,
1010
EFFECT_OFF
1111
)

0 commit comments

Comments
 (0)