homebridge-lanternic 0.1.1 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +11 -8
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,12 +1,17 @@
1
1
  # Homebridge LanternIC
2
2
 
3
- Homebridge plugin for BLE RGBIC/RGBWIC light strips controlled by the Magic Lantern app.
3
+ [![npm version](https://img.shields.io/npm/v/homebridge-lanternic.svg)](https://www.npmjs.com/package/homebridge-lanternic)
4
+ [![npm downloads](https://img.shields.io/npm/dm/homebridge-lanternic.svg)](https://www.npmjs.com/package/homebridge-lanternic)
5
+ [![CI](https://github.com/Gibsonmb71/homebridge-lanternic/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Gibsonmb71/homebridge-lanternic/actions/workflows/ci.yml)
6
+ [![Node.js](https://img.shields.io/node/v/homebridge-lanternic.svg)](https://www.npmjs.com/package/homebridge-lanternic)
7
+ [![Homebridge](https://img.shields.io/badge/homebridge-1.8%20%7C%202.x-blue.svg)](https://homebridge.io/)
8
+ [![License](https://img.shields.io/npm/l/homebridge-lanternic.svg)](LICENSE)
4
9
 
5
- The goal is a reliable local-only bridge for the common unbranded Magic Lantern strips and lamps. These devices are usually BLE lights, not Magic Home Wi-Fi devices, so this plugin talks directly to the BLE service used by the Magic Lantern app.
10
+ Homebridge plugin for BLE RGBIC/RGBWIC light strips controlled by the Magic Lantern app.
6
11
 
7
12
  ## Status
8
13
 
9
- LanternIC is a hardware-tested pre-release plugin. It is designed for production-style Homebridge use, with the important caveat that these unbranded Magic Lantern BLE strips ship with multiple firmware variants.
14
+ These unbranded Magic Lantern BLE strips ship with multiple firmware variants so it's hard to ensure compatibility for all strips.
10
15
 
11
16
  - HomeKit Lightbulb service
12
17
  - On/off with RGB-black fallback plus optional native Magic Lantern power frames
@@ -18,11 +23,11 @@ LanternIC is a hardware-tested pre-release plugin. It is designed for production
18
23
  - Command-builder tests for the known Magic Lantern frames
19
24
  - Package smoke tests against Homebridge 1 and 2 on Node.js 22 and 24 in CI
20
25
 
21
- Effects, segment control, RGBW white-channel behavior, and startup scenes are deliberately left out until more real devices are tested.
26
+ Effects and segment control are not supported as there is no good way to expose them in Apple Home.
22
27
 
23
28
  ## Install
24
29
 
25
- Once published to npm, install it like any other Homebridge plugin:
30
+ Install it like any other Homebridge plugin:
26
31
 
27
32
  ```sh
28
33
  sudo npm install -g homebridge-lanternic
@@ -213,7 +218,7 @@ The core frames available here are:
213
218
  - Effect speed: `7e0402xxffffff00ef`, where `xx` is 0-100 decimal encoded as one byte
214
219
  - Basic effect: `7e0503xx06ffff00ef`
215
220
 
216
- These protocol notes come from Home Assistant community reverse-engineering reports and BLE packet examples:
221
+ > These Magic Lantern BLE frame notes are based on packet-captures from [@kassabov](https://github.com/kassabov) in Home Assistant Core issue [#145934](https://github.com/home-assistant/core/issues/145934). (thanks!)
217
222
 
218
223
  - Home Assistant Core issue: <https://github.com/home-assistant/core/issues/145934>
219
224
  - Home Assistant community thread: <https://community.home-assistant.io/t/new-integration-for-ble-magic-lantern/454055>
@@ -233,8 +238,6 @@ The command builders are isolated so we can add variants if your strip uses a sl
233
238
 
234
239
  ## Reliability Choices
235
240
 
236
- This plugin avoids the usual BLE plugin failure pattern of overlapping scans, overlapping writes, and stale connections:
237
-
238
241
  - All BLE operations are serialized through a single manager queue.
239
242
  - Every characteristic write has a timeout and is retried with exponential backoff.
240
243
  - Failed writes force a disconnect and rediscovery.
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "homebridge-lanternic",
3
3
  "displayName": "LanternIC",
4
4
  "type": "module",
5
- "version": "0.1.1",
5
+ "version": "0.1.3",
6
6
  "description": "Homebridge plugin for BLE RGBIC/RGBWIC light strips controlled by the Magic Lantern app.",
7
7
  "author": "Gibson Bell",
8
8
  "license": "MIT",