@west7014/lifx-lan 1.0.2

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 (5) hide show
  1. package/LICENSE +373 -0
  2. package/README.md +143 -0
  3. package/index.d.ts +111 -0
  4. package/index.js +619 -0
  5. package/package.json +49 -0
package/LICENSE ADDED
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at https://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
package/README.md ADDED
@@ -0,0 +1,143 @@
1
+ # lifx-lan
2
+
3
+ Control LIFX lights directly over your local network using the [LIFX LAN protocol](https://lan.developer.lifx.com/). No cloud required for most features.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install lifx-lan axios
9
+ ```
10
+
11
+ If you want to load your LIFX auth token from a `.env` file rather than hard-coding it:
12
+
13
+ ```bash
14
+ npm install dotenv@16.4.5
15
+ ```
16
+
17
+ ## Quick Start
18
+
19
+ ```js
20
+ const LifxLAN = require('lifx-lan');
21
+
22
+ const light = new LifxLAN('192.168.1.42');
23
+
24
+ light.on();
25
+ light.setColorHex(0xff6600);
26
+ light.setBrightnessPercent(80);
27
+ light.off(2000); // fade out over 2 seconds
28
+ ```
29
+
30
+ ## Authentication
31
+
32
+ Some features (effects, fetching light metadata) use the [LIFX HTTP API](https://api.developer.lifx.com/) and require a personal access token from [cloud.lifx.com](https://cloud.lifx.com).
33
+
34
+ **Option A — hard-code it:**
35
+ ```js
36
+ const AUTH = 'your-lifx-token-here';
37
+ await light.setEffect('flame', AUTH);
38
+ ```
39
+
40
+ **Option B — load from `.env` (requires `dotenv@16.4.5`):**
41
+ ```
42
+ # .env
43
+ LIFX_TOKEN=your-lifx-token-here
44
+ ```
45
+ ```js
46
+ require('dotenv').config();
47
+ const AUTH = process.env.LIFX_TOKEN;
48
+ await light.setEffect('flame', AUTH);
49
+ ```
50
+
51
+ All LAN-only methods (`on`, `off`, `setColor*`, `setBrightness*`, `setZones*`, `setTile*`) work without any token.
52
+
53
+ ## API
54
+
55
+ ### Constructor
56
+
57
+ ```js
58
+ new LifxLAN(ip, port = 56700)
59
+ ```
60
+
61
+ ### Power
62
+
63
+ | Method | Description |
64
+ |---|---|
65
+ | `on(duration?)` | Turn light on |
66
+ | `off(duration?)` | Turn light off |
67
+ | `setPower(level, duration?)` | Raw power — `0` = off, `65535` = on |
68
+
69
+ ### Color
70
+
71
+ | Method | Description |
72
+ |---|---|
73
+ | `setColor(hue, sat, bri, kelvin?, duration?)` | Set HSBK values directly (all 0–65535) |
74
+ | `setColorRGB(r, g, b, kelvin?, duration?)` | Set color from RGB (0–255 each) |
75
+ | `setColorHex(hex, kelvin?, duration?)` | Set color from hex e.g. `0xff6600` |
76
+
77
+ ### Brightness
78
+
79
+ | Method | Description |
80
+ |---|---|
81
+ | `setBrightness(value, duration?)` | `0.0–1.0` or `0–65535` |
82
+ | `setBrightnessPercent(percent, duration?)` | `0–100` |
83
+ | `fadeBrightness(target, seconds)` | Smooth fade to brightness value |
84
+ | `fadeBrightnessPercent(percent, seconds)` | Smooth fade to brightness percent |
85
+
86
+ ### Zones (multi-zone strips)
87
+
88
+ | Method | Description |
89
+ |---|---|
90
+ | `setZones(start, end, h, s, b, kelvin?, duration?, apply?)` | Set zone range by HSBK |
91
+ | `setZonesHex(start, end, hex, kelvin?, duration?, apply?)` | Set zone range by hex color |
92
+
93
+ ### Tile / Matrix (LIFX Ceiling)
94
+
95
+ | Method | Description |
96
+ |---|---|
97
+ | `setTileState64(index, colors, duration?, x?, y?, width?)` | Set full 8×8 grid with an array of 64 HSBK objects |
98
+ | `setTileSolid(index, h, s, b, kelvin?, duration?)` | Fill a tile with a solid HSBK color |
99
+ | `setTileSolidHex(index, hex, kelvin?, duration?)` | Fill a tile with a solid hex color |
100
+
101
+ ### LIFX Ceiling — High-Level API
102
+
103
+ The ceiling has an 8×8 grid: 6 rows of 8 downlight zones, with uplight strips on the top and bottom edges.
104
+
105
+ | Method | Description |
106
+ |---|---|
107
+ | `setAll(colors, kelvin?, duration?, mode?)` | Set entire ceiling — downlight + uplight |
108
+ | `setDownlight(colors, kelvin?, duration?, mode?)` | Set downlight zones only |
109
+ | `setUplight(color, kelvin?, duration?)` | Set uplight strips only |
110
+ | `setZonesCustom(zoneColors, kelvin?, duration?)` | Set all 8 zones individually — array of 8 hex colors |
111
+
112
+ `mode` can be `'solid'` (default), `'gradient'`, or `'palette'`. For `gradient` and `palette`, pass an array of hex colors.
113
+
114
+ ### HTTP API (requires auth token)
115
+
116
+ | Method | Description |
117
+ |---|---|
118
+ | `getLightData(auth)` | Fetch light metadata from the LIFX cloud API |
119
+ | `setEffect(fxName, auth, options?)` | Start an effect: `'pulse'`, `'breathe'`, `'move'`, `'morph'`, `'flame'` |
120
+ | `stopEffect(auth)` | Stop any running effect |
121
+
122
+ ### Utilities
123
+
124
+ | Method | Description |
125
+ |---|---|
126
+ | `rgbToHsbk(r, g, b, kelvin?)` | Convert RGB to a LIFX HSBK object |
127
+ | `close()` | Close the underlying UDP socket |
128
+
129
+ ### Duration
130
+
131
+ All `duration` parameters are in **milliseconds** unless the method name says `seconds` (e.g. `fadeBrightness`).
132
+
133
+ ## TypeScript
134
+
135
+ Type declarations are included. No additional setup required.
136
+
137
+ ```ts
138
+ import LifxLAN, { HSBK, EffectName } from 'lifx-lan';
139
+ ```
140
+
141
+ ## License
142
+
143
+ See [LICENSE](./LICENSE).
package/index.d.ts ADDED
@@ -0,0 +1,111 @@
1
+ interface HSBK {
2
+ hue: number;
3
+ saturation: number;
4
+ brightness: number;
5
+ kelvin: number;
6
+ }
7
+ interface LightData {
8
+ id: string;
9
+ label: string;
10
+ connected: boolean;
11
+ power: 'on' | 'off';
12
+ color: {
13
+ hue: number;
14
+ saturation: number;
15
+ kelvin: number;
16
+ };
17
+ brightness: number;
18
+ group: {
19
+ id: string;
20
+ name: string;
21
+ };
22
+ location: {
23
+ id: string;
24
+ name: string;
25
+ };
26
+ [key: string]: unknown;
27
+ }
28
+ type EffectName = 'pulse' | 'breathe' | 'move' | 'morph' | 'flame';
29
+ type DisplayMode = 'solid' | 'gradient' | 'palette';
30
+ type MoveDirection = 'forward' | 'backward';
31
+ interface PulseEffectOptions {
32
+ color?: string;
33
+ from_color?: string | null;
34
+ period?: number;
35
+ cycles?: number;
36
+ persist?: boolean;
37
+ power_on?: boolean;
38
+ peak?: number;
39
+ }
40
+ interface BreatheEffectOptions extends PulseEffectOptions {
41
+ }
42
+ interface MoveEffectOptions {
43
+ direction?: MoveDirection;
44
+ period?: number;
45
+ cycles?: number;
46
+ power_on?: boolean;
47
+ }
48
+ interface MorphEffectOptions {
49
+ period?: number;
50
+ duration?: number | null;
51
+ palette?: string[];
52
+ power_on?: boolean;
53
+ }
54
+ interface FlameEffectOptions {
55
+ period?: number;
56
+ duration?: number | null;
57
+ power_on?: boolean;
58
+ }
59
+ type EffectOptions = PulseEffectOptions | BreatheEffectOptions | MoveEffectOptions | MorphEffectOptions | FlameEffectOptions;
60
+ declare class LifxLAN {
61
+ private readonly ip;
62
+ private readonly port;
63
+ private readonly socket;
64
+ private readonly source;
65
+ private sequence;
66
+ constructor(ip: string, port?: number);
67
+ private buildHeader;
68
+ private send;
69
+ rgbToHsbk(r: number, g: number, b: number, kelvin?: number): HSBK;
70
+ private hexToHSBK;
71
+ setPower(level: number, duration?: number): void;
72
+ on(duration?: number): void;
73
+ off(duration?: number): void;
74
+ setColor(hue: number, saturation: number, brightness: number, kelvin?: number, duration?: number): void;
75
+ setColorRGB(r: number, g: number, b: number, kelvin?: number, duration?: number): void;
76
+ setColorHex(hex: number, kelvin?: number, duration?: number): void;
77
+ /**
78
+ * Set brightness without changing the current hue/saturation.
79
+ * @param brightness - Value from 0.0–1.0 or 0–65535
80
+ */
81
+ setBrightness(brightness: number, duration?: number): void;
82
+ /** @param percent - 0–100 */
83
+ setBrightnessPercent(percent: number, duration?: number): void;
84
+ fadeBrightness(targetBrightness: number, seconds: number): void;
85
+ fadeBrightnessPercent(targetPercent: number, seconds: number): void;
86
+ setZones(startZone: number, endZone: number, hue: number, saturation: number, brightness: number, kelvin?: number, duration?: number, apply?: number): void;
87
+ setZonesHex(startZone: number, endZone: number, hex: number, kelvin?: number, duration?: number, apply?: number): void;
88
+ setTileState64(tileIndex: number, colors: HSBK[], duration?: number, x?: number, y?: number, width?: number): void;
89
+ setTileSolid(tileIndex: number, hue: number, saturation: number, brightness: number, kelvin?: number, duration?: number): void;
90
+ setTileSolidHex(tileIndex: number, hex: number, kelvin?: number, duration?: number): void;
91
+ /**
92
+ * Grid layout for LIFX Ceiling (8×8):
93
+ * Row 0: [off,off, up, up, up, up,off,off] ← uplight top
94
+ * Rows 1–6: [z1,z2,z3,z4,z5,z6,z7,z8] ← downlight zones
95
+ * Row 7: [off,off, up, up, up, up,off,off] ← uplight bottom
96
+ */
97
+ private createCeilingGrid;
98
+ private createHorizontalGradient;
99
+ private createPalettePattern;
100
+ setAll(colors: number | number[], kelvin?: number, duration?: number, mode?: DisplayMode): void;
101
+ setDownlight(colors: number | number[], kelvin?: number, duration?: number, mode?: DisplayMode): void;
102
+ setUplight(color: number | number[], kelvin?: number, duration?: number): void;
103
+ /** @param zoneColors - Array of 8 hex colors, one per zone (left→right) */
104
+ setZonesCustom(zoneColors: number[], kelvin?: number, duration?: number): void;
105
+ getLightData(auth: string): Promise<LightData>;
106
+ setEffect(fxName: EffectName, auth: string, options?: EffectOptions): Promise<unknown>;
107
+ stopEffect(auth: string): Promise<unknown>;
108
+ close(): void;
109
+ }
110
+
111
+ export { type BreatheEffectOptions, type DisplayMode, type EffectName, type EffectOptions, type FlameEffectOptions, type HSBK, LifxLAN, type LightData, type MorphEffectOptions, type MoveDirection, type MoveEffectOptions, type PulseEffectOptions, LifxLAN as default };
package/index.js ADDED
@@ -0,0 +1,619 @@
1
+ const dgram = require('dgram');
2
+ const axios = require('axios');
3
+
4
+ class LifxLAN {
5
+ constructor(ip, port = 56700) {
6
+ this.ip = ip;
7
+ this.port = port;
8
+ this.socket = dgram.createSocket('udp4');
9
+ this.source = Math.floor(Math.random() * 0xFFFFFFFF); // Random source ID
10
+ this.sequence = 0;
11
+ }
12
+
13
+ // Build LIFX protocol header
14
+ buildHeader(messageType, size = 36, target = '000000000000', ackRequired = false, resRequired = false) {
15
+ const header = Buffer.alloc(36);
16
+
17
+ // Frame
18
+ header.writeUInt16LE(size, 0); // Size
19
+ header.writeUInt16LE(0x3400, 2); // Protocol (0x3400 = 1024 with tagged, addressable, protocol bits)
20
+ header.writeUInt32LE(this.source, 4); // Source
21
+
22
+ // Frame address
23
+ const targetBytes = Buffer.from(target, 'hex');
24
+ targetBytes.copy(header, 8); // Target (8 bytes)
25
+ header.fill(0, 16, 22); // Reserved
26
+ header.writeUInt8((resRequired ? 0x01 : 0x00) | (ackRequired ? 0x02 : 0x00), 22); // Ack/Res flags
27
+ header.writeUInt8(this.sequence++, 23); // Sequence
28
+
29
+ // Protocol header
30
+ header.fill(0, 24, 32); // Reserved
31
+ header.writeUInt16LE(messageType, 32); // Message type
32
+ header.fill(0, 34, 36); // Reserved
33
+
34
+ return header;
35
+ }
36
+
37
+ // Convert RGB to HSBK for LIFX
38
+ rgbToHsbk(r, g, b, kelvin = 3500) {
39
+ r /= 255;
40
+ g /= 255;
41
+ b /= 255;
42
+
43
+ const max = Math.max(r, g, b);
44
+ const min = Math.min(r, g, b);
45
+ const delta = max - min;
46
+
47
+ let h = 0;
48
+ let s = max === 0 ? 0 : delta / max;
49
+ let br = max;
50
+
51
+ if (delta !== 0) {
52
+ if (max === r) {
53
+ h = ((g - b) / delta + (g < b ? 6 : 0)) / 6;
54
+ } else if (max === g) {
55
+ h = ((b - r) / delta + 2) / 6;
56
+ } else {
57
+ h = ((r - g) / delta + 4) / 6;
58
+ }
59
+ }
60
+
61
+ return {
62
+ hue: Math.round(h * 65535), // 0-65535
63
+ saturation: Math.round(s * 65535), // 0-65535
64
+ brightness: Math.round(br * 65535),// 0-65535
65
+ kelvin: kelvin // 2500-9000
66
+ };
67
+ }
68
+
69
+ // Set light color (message type 102)
70
+ setColor(hue, saturation, brightness, kelvin = 3500, duration = 0) {
71
+ const header = this.buildHeader(102, 49);
72
+ const payload = Buffer.alloc(13);
73
+
74
+ payload.writeUInt8(0, 0); // Reserved
75
+ payload.writeUInt16LE(hue, 1);
76
+ payload.writeUInt16LE(saturation, 3);
77
+ payload.writeUInt16LE(brightness, 5);
78
+ payload.writeUInt16LE(kelvin, 7);
79
+ payload.writeUInt32LE(duration, 9); // Duration in milliseconds
80
+
81
+ const packet = Buffer.concat([header, payload]);
82
+
83
+ this.socket.send(packet, 0, packet.length, this.port, this.ip, (err) => {
84
+ if (err) console.error('Error sending packet:', err);
85
+ else console.log(`Color set to H:${hue} S:${saturation} B:${brightness} K:${kelvin}`);
86
+ });
87
+ }
88
+
89
+ // Set light color from RGB
90
+ setColorRGB(r, g, b, kelvin = 3500, duration = 0) {
91
+ const hsbk = this.rgbToHsbk(r, g, b, kelvin);
92
+ this.setColor(hsbk.hue, hsbk.saturation, hsbk.brightness, hsbk.kelvin, duration);
93
+ }
94
+
95
+ // Set light color from hex (0xRRGGBB)
96
+ setColorHex(hex, kelvin = 3500, duration = 0) {
97
+ const r = (hex >> 16) & 0xFF;
98
+ const g = (hex >> 8) & 0xFF;
99
+ const b = hex & 0xFF;
100
+ this.setColorRGB(r, g, b, kelvin, duration);
101
+ }
102
+
103
+ // Set power state (message type 117)
104
+ setPower(level, duration = 0) {
105
+ const header = this.buildHeader(117, 42);
106
+ const payload = Buffer.alloc(6);
107
+
108
+ payload.writeUInt16LE(level, 0); // 0 = off, 65535 = on
109
+ payload.writeUInt32LE(duration, 2); // Duration in milliseconds
110
+
111
+ const packet = Buffer.concat([header, payload]);
112
+
113
+ this.socket.send(packet, 0, packet.length, this.port, this.ip, (err) => {
114
+ if (err) console.error('Error sending packet:', err);
115
+ else console.log(`Power set to ${level > 0 ? 'ON' : 'OFF'}`);
116
+ });
117
+ }
118
+
119
+ // Turn light on
120
+ on(duration = 0) {
121
+ this.setPower(65535, duration);
122
+ }
123
+
124
+ // Turn light off
125
+ off(duration = 0) {
126
+ this.setPower(0, duration);
127
+ }
128
+
129
+ // Set brightness (0.0 to 1.0 or 0 to 65535)
130
+ // This adjusts brightness without changing color
131
+ setBrightness(brightness, duration = 0) {
132
+ // Normalize brightness to 0-65535 range
133
+ const brightnessValue = brightness <= 1 ? Math.round(brightness * 65535) : brightness;
134
+
135
+ // Use SetLightPower with level for instant brightness change
136
+ // Or use SetColor with duration for smooth transition
137
+ // We'll use message type 102 (SetColor) with reserved byte 0x01 to maintain current color
138
+ const header = this.buildHeader(102, 49);
139
+ const payload = Buffer.alloc(13);
140
+
141
+ payload.writeUInt8(0x01, 0); // Reserved = 0x01 means "use current hue/saturation"
142
+ payload.writeUInt16LE(0, 1); // Hue (ignored when reserved = 0x01)
143
+ payload.writeUInt16LE(0, 3); // Saturation (ignored when reserved = 0x01)
144
+ payload.writeUInt16LE(brightnessValue, 5); // Brightness
145
+ payload.writeUInt16LE(0, 7); // Kelvin (0 means use current)
146
+ payload.writeUInt32LE(duration, 9); // Duration in milliseconds
147
+
148
+ const packet = Buffer.concat([header, payload]);
149
+
150
+ this.socket.send(packet, 0, packet.length, this.port, this.ip, (err) => {
151
+ if (err) console.error('Error sending packet:', err);
152
+ else console.log(`Brightness set to ${Math.round((brightnessValue/65535)*100)}% over ${duration}ms`);
153
+ });
154
+ }
155
+
156
+ // Convenience method: Set brightness as percentage (0-100)
157
+ setBrightnessPercent(percent, duration = 0) {
158
+ const brightness = Math.max(0, Math.min(100, percent)) / 100;
159
+ this.setBrightness(brightness, duration);
160
+ }
161
+
162
+ // Fade brightness over time (in seconds)
163
+ fadeBrightness(targetBrightness, seconds) {
164
+ const duration = seconds * 1000; // Convert to milliseconds
165
+ this.setBrightness(targetBrightness, duration);
166
+ }
167
+
168
+ // Fade brightness as percentage over time (in seconds)
169
+ fadeBrightnessPercent(targetPercent, seconds) {
170
+ const brightness = Math.max(0, Math.min(100, targetPercent)) / 100;
171
+ const duration = seconds * 1000;
172
+ this.setBrightness(brightness, duration);
173
+ }
174
+
175
+ // Set zones for multi-zone lights (message type 501)
176
+ setZones(startZone, endZone, hue, saturation, brightness, kelvin = 3500, duration = 0, apply = 1) {
177
+ const header = this.buildHeader(501, 49);
178
+ const payload = Buffer.alloc(15);
179
+
180
+ payload.writeUInt8(startZone, 0);
181
+ payload.writeUInt8(endZone, 1);
182
+ payload.writeUInt16LE(hue, 2);
183
+ payload.writeUInt16LE(saturation, 4);
184
+ payload.writeUInt16LE(brightness, 6);
185
+ payload.writeUInt16LE(kelvin, 8);
186
+ payload.writeUInt32LE(duration, 10);
187
+ payload.writeUInt8(apply, 14); // 0 = NO_APPLY, 1 = APPLY, 2 = APPLY_ONLY
188
+
189
+ const packet = Buffer.concat([header, payload]);
190
+
191
+ this.socket.send(packet, 0, packet.length, this.port, this.ip, (err) => {
192
+ if (err) console.error('Error sending packet:', err);
193
+ else console.log(`Zones ${startZone}-${endZone} set`);
194
+ });
195
+ }
196
+
197
+ // Set zones with hex color
198
+ setZonesHex(startZone, endZone, hex, kelvin = 3500, duration = 0, apply = 1) {
199
+ const r = (hex >> 16) & 0xFF;
200
+ const g = (hex >> 8) & 0xFF;
201
+ const b = hex & 0xFF;
202
+ const hsbk = this.rgbToHsbk(r, g, b, kelvin);
203
+ this.setZones(startZone, endZone, hsbk.hue, hsbk.saturation, hsbk.brightness, kelvin, duration, apply);
204
+ }
205
+
206
+ // Set tile state for matrix devices (message type 715)
207
+ // tileIndex: which tile/segment (0-based)
208
+ // colors: array of 64 HSBK objects for 8x8 grid
209
+ setTileState64(tileIndex, colors, duration = 0, x = 0, y = 0, width = 8) {
210
+ // Payload structure:
211
+ // tile_index: 1, length: 1, reserved: 1, x: 1, y: 1, width: 1, duration: 4 = 10 bytes
212
+ // colors: 64 * 8 bytes = 512 bytes
213
+ // Total: 522 bytes
214
+ const payloadSize = 10 + (64 * 8); // 522 bytes
215
+ const totalSize = 36 + payloadSize; // 558 bytes total
216
+ const header = this.buildHeader(715, totalSize);
217
+ const payload = Buffer.alloc(payloadSize);
218
+
219
+ payload.writeUInt8(tileIndex, 0);
220
+ payload.writeUInt8(1, 1); // Length (1 tile)
221
+ payload.writeUInt8(0, 2); // Reserved
222
+ payload.writeUInt8(x, 3); // X position
223
+ payload.writeUInt8(y, 4); // Y position
224
+ payload.writeUInt8(width, 5); // Width
225
+ payload.writeUInt32LE(duration, 6); // Duration at offset 6-9
226
+
227
+ // Write 64 colors (8x8 grid) starting at offset 10
228
+ for (let i = 0; i < 64; i++) {
229
+ const offset = 10 + (i * 8);
230
+ const color = colors[i] || { hue: 0, saturation: 0, brightness: 0, kelvin: 3500 };
231
+ payload.writeUInt16LE(color.hue, offset);
232
+ payload.writeUInt16LE(color.saturation, offset + 2);
233
+ payload.writeUInt16LE(color.brightness, offset + 4);
234
+ payload.writeUInt16LE(color.kelvin, offset + 6);
235
+ }
236
+
237
+ const packet = Buffer.concat([header, payload]);
238
+
239
+ this.socket.send(packet, 0, packet.length, this.port, this.ip, (err) => {
240
+ if (err) console.error('Error sending packet:', err);
241
+ else console.log(`Tile ${tileIndex} state set`);
242
+ });
243
+ }
244
+
245
+ // Helper: Set a single tile to one color
246
+ setTileSolid(tileIndex, hue, saturation, brightness, kelvin = 3500, duration = 0) {
247
+ const color = { hue, saturation, brightness, kelvin };
248
+ const colors = new Array(64).fill(color);
249
+ this.setTileState64(tileIndex, colors, duration);
250
+ }
251
+
252
+ // Helper: Set a single tile to one hex color
253
+ setTileSolidHex(tileIndex, hex, kelvin = 3500, duration = 0) {
254
+ const r = (hex >> 16) & 0xFF;
255
+ const g = (hex >> 8) & 0xFF;
256
+ const b = hex & 0xFF;
257
+ const hsbk = this.rgbToHsbk(r, g, b, kelvin);
258
+ this.setTileSolid(tileIndex, hsbk.hue, hsbk.saturation, hsbk.brightness, kelvin, duration);
259
+ }
260
+
261
+ // LIFX Ceiling specific methods
262
+ // The ceiling has an 8x8 grid where zones are arranged as shown in your app
263
+
264
+ // Set all zones (downlight + uplight)
265
+ setAll(colors, kelvin = 3500, duration = 0, mode = 'solid') {
266
+ // Mode can be: 'solid', 'gradient', 'blend', 'palette'
267
+ if (mode === 'solid') {
268
+ // Single color for everything
269
+ const color = Array.isArray(colors) ? colors[0] : colors;
270
+ this.setColorHex(color, kelvin, duration);
271
+ } else if (mode === 'gradient') {
272
+ // Gradient across entire light
273
+ const colorArray = Array.isArray(colors) ? colors : [colors];
274
+ const gridColors = this.createHorizontalGradient(colorArray, colorArray[0], kelvin);
275
+ this.setTileState64(0, gridColors, duration);
276
+ } else if (mode === 'palette') {
277
+ // Palette pattern across entire light
278
+ const colorArray = Array.isArray(colors) ? colors : [colors];
279
+ const gridColors = this.createPalettePattern(colorArray, colorArray, kelvin);
280
+ this.setTileState64(0, gridColors, duration);
281
+ }
282
+ }
283
+
284
+ // Set downlight only (all 8 zones in the middle rows)
285
+ setDownlight(colors, kelvin = 3500, duration = 0, mode = 'solid') {
286
+ const colorArray = Array.isArray(colors) ? colors : [colors];
287
+
288
+ if (mode === 'solid') {
289
+ // Set all downlight zones to the same color
290
+ const gridColors = this.createCeilingGrid(colorArray[0], null, colorArray);
291
+ this.setTileState64(0, gridColors, duration);
292
+ } else {
293
+ // Apply pattern to downlight zones
294
+ const gridColors = this.createCeilingGridPattern(colorArray, null, mode, kelvin);
295
+ this.setTileState64(0, gridColors, duration);
296
+ }
297
+ }
298
+
299
+ // Set uplight only (top and bottom rows with null edges)
300
+ setUplight(color, kelvin = 3500, duration = 0, mode = 'solid') {
301
+ const colorArray = Array.isArray(color) ? color : [color];
302
+
303
+ if (mode === 'solid') {
304
+ const gridColors = this.createCeilingGrid(null, colorArray[0], null);
305
+ this.setTileState64(0, gridColors, duration);
306
+ } else {
307
+ // Palette mode for uplight
308
+ const gridColors = this.createCeilingGridPattern(null, colorArray, mode, kelvin);
309
+ this.setTileState64(0, gridColors, duration);
310
+ }
311
+ }
312
+
313
+ // Set specific zones (1-8, left to right)
314
+ // zoneColors: array of 8 hex colors, one for each zone
315
+ setZonesCustom(zoneColors, kelvin = 3500, duration = 0) {
316
+ const gridColors = this.createCeilingGrid(null, null, zoneColors, kelvin);
317
+ this.setTileState64(0, gridColors, duration);
318
+ }
319
+
320
+ // Helper: Create the 8x8 grid for LIFX Ceiling
321
+ // Layout: [null,null,1,2,3,4,null,null] (uplight top)
322
+ // [1,2,3,4,5,6,7,8] (zones x6)
323
+ // [null,null,1,2,3,4,null,null] (uplight bottom)
324
+ createCeilingGrid(downlightColor = null, uplightColor = null, zoneColors = null, kelvin = 3500) {
325
+ const grid = [];
326
+ const black = { hue: 0, saturation: 0, brightness: 0, kelvin };
327
+
328
+ // Convert hex colors to HSBK
329
+ const getHSBK = (hex) => {
330
+ if (hex === null || hex === undefined) return black;
331
+ const r = (hex >> 16) & 0xFF;
332
+ const g = (hex >> 8) & 0xFF;
333
+ const b = hex & 0xFF;
334
+ return this.rgbToHsbk(r, g, b, kelvin);
335
+ };
336
+
337
+ // Row 0: Uplight top [null,null,1,2,3,4,null,null]
338
+ for (let i = 0; i < 8; i++) {
339
+ if (i < 2 || i > 5) {
340
+ grid.push(black);
341
+ } else {
342
+ grid.push(uplightColor !== null ? getHSBK(uplightColor) : black);
343
+ }
344
+ }
345
+
346
+ // Rows 1-6: Downlight zones [1,2,3,4,5,6,7,8]
347
+ for (let row = 1; row <= 6; row++) {
348
+ for (let zone = 0; zone < 8; zone++) {
349
+ if (zoneColors && Array.isArray(zoneColors)) {
350
+ grid.push(getHSBK(zoneColors[zone]));
351
+ } else if (downlightColor !== null) {
352
+ grid.push(getHSBK(downlightColor));
353
+ } else {
354
+ grid.push(black);
355
+ }
356
+ }
357
+ }
358
+
359
+ // Row 7: Uplight bottom [null,null,1,2,3,4,null,null]
360
+ for (let i = 0; i < 8; i++) {
361
+ if (i < 2 || i > 5) {
362
+ grid.push(black);
363
+ } else {
364
+ grid.push(uplightColor !== null ? getHSBK(uplightColor) : black);
365
+ }
366
+ }
367
+
368
+ return grid;
369
+ }
370
+
371
+ // Helper: Create gradient/blend/palette patterns
372
+ createCeilingGridPattern(downlightColors, uplightColors, mode, kelvin = 3500) {
373
+ const grid = [];
374
+ const black = { hue: 0, saturation: 0, brightness: 0, kelvin };
375
+
376
+ const getHSBK = (hex) => {
377
+ if (hex === null || hex === undefined) return black;
378
+ const r = (hex >> 16) & 0xFF;
379
+ const g = (hex >> 8) & 0xFF;
380
+ const b = hex & 0xFF;
381
+ return this.rgbToHsbk(r, g, b, kelvin);
382
+ };
383
+
384
+ // For now, implementing basic gradient/palette
385
+ // You can expand this based on how the app implements these modes
386
+
387
+ if (mode === 'gradient' && downlightColors && downlightColors.length >= 2) {
388
+ // Horizontal gradient across zones
389
+ return this.createHorizontalGradient(downlightColors, uplightColors, kelvin);
390
+ } else if (mode === 'palette' && downlightColors) {
391
+ // Distribute palette colors across zones
392
+ return this.createPalettePattern(downlightColors, uplightColors, kelvin);
393
+ }
394
+
395
+ // Default to solid
396
+ return this.createCeilingGrid(
397
+ downlightColors ? downlightColors[0] : null,
398
+ uplightColors ? uplightColors[0] : null,
399
+ null,
400
+ kelvin
401
+ );
402
+ }
403
+
404
+ // Create horizontal gradient
405
+ createHorizontalGradient(colors, uplightColor = null, kelvin = 3500) {
406
+ const grid = [];
407
+ const black = { hue: 0, saturation: 0, brightness: 0, kelvin };
408
+
409
+ const getHSBK = (hex) => {
410
+ if (hex === null || hex === undefined) return black;
411
+ const r = (hex >> 16) & 0xFF;
412
+ const g = (hex >> 8) & 0xFF;
413
+ const b = hex & 0xFF;
414
+ return this.rgbToHsbk(r, g, b, kelvin);
415
+ };
416
+
417
+ const uplightHSBK = uplightColor ? getHSBK(uplightColor) : black;
418
+
419
+ // Row 0: Uplight
420
+ for (let i = 0; i < 8; i++) {
421
+ grid.push(i < 2 || i > 5 ? black : uplightHSBK);
422
+ }
423
+
424
+ // Rows 1-6: Gradient across 8 zones
425
+ for (let row = 1; row <= 6; row++) {
426
+ for (let zone = 0; zone < 8; zone++) {
427
+ // Interpolate between colors based on zone position
428
+ const colorIndex = Math.floor((zone / 7) * (colors.length - 1));
429
+ const nextIndex = Math.min(colorIndex + 1, colors.length - 1);
430
+ const t = ((zone / 7) * (colors.length - 1)) - colorIndex;
431
+
432
+ const c1 = getHSBK(colors[colorIndex]);
433
+ const c2 = getHSBK(colors[nextIndex]);
434
+
435
+ // Linear interpolation
436
+ grid.push({
437
+ hue: Math.round(c1.hue + (c2.hue - c1.hue) * t),
438
+ saturation: Math.round(c1.saturation + (c2.saturation - c1.saturation) * t),
439
+ brightness: Math.round(c1.brightness + (c2.brightness - c1.brightness) * t),
440
+ kelvin
441
+ });
442
+ }
443
+ }
444
+
445
+ // Row 7: Uplight
446
+ for (let i = 0; i < 8; i++) {
447
+ grid.push(i < 2 || i > 5 ? black : uplightHSBK);
448
+ }
449
+
450
+ return grid;
451
+ }
452
+
453
+ // Create palette pattern (distribute colors across zones)
454
+ createPalettePattern(colors, uplightColors = null, kelvin = 3500) {
455
+ const grid = [];
456
+ const black = { hue: 0, saturation: 0, brightness: 0, kelvin };
457
+
458
+ const getHSBK = (hex) => {
459
+ if (hex === null || hex === undefined) return black;
460
+ const r = (hex >> 16) & 0xFF;
461
+ const g = (hex >> 8) & 0xFF;
462
+ const b = hex & 0xFF;
463
+ return this.rgbToHsbk(r, g, b, kelvin);
464
+ };
465
+
466
+ const uplightHSBK = uplightColors && uplightColors.length > 0 ? getHSBK(uplightColors[0]) : black;
467
+
468
+ // Row 0: Uplight
469
+ for (let i = 0; i < 8; i++) {
470
+ grid.push(i < 2 || i > 5 ? black : uplightHSBK);
471
+ }
472
+
473
+ // Rows 1-6: Palette distributed across zones
474
+ for (let row = 1; row <= 6; row++) {
475
+ for (let zone = 0; zone < 8; zone++) {
476
+ const colorIndex = zone % colors.length;
477
+ grid.push(getHSBK(colors[colorIndex]));
478
+ }
479
+ }
480
+
481
+ // Row 7: Uplight
482
+ for (let i = 0; i < 8; i++) {
483
+ grid.push(i < 2 || i > 5 ? black : uplightHSBK);
484
+ }
485
+
486
+ return grid;
487
+ }
488
+
489
+ // Web API Methods - Require authentication token
490
+
491
+ // Get light data from LIFX HTTP API
492
+ async getLightData(auth) {
493
+ const options = {
494
+ method: 'GET',
495
+ url: 'https://api.lifx.com/v1/lights',
496
+ headers: {
497
+ accept: 'application/json',
498
+ Authorization: `Bearer ${auth}`
499
+ }
500
+ };
501
+
502
+ try {
503
+ const response = await axios.request(options);
504
+ // Find the light matching this IP address
505
+ const light = response.data.find(l =>
506
+ l.group && l.group.id && this.ip
507
+ ) || response.data[0];
508
+
509
+ return light;
510
+ } catch (error) {
511
+ console.error('Error fetching light data:', error.response ? error.response.data : error.message);
512
+ throw error;
513
+ }
514
+ }
515
+
516
+ // Set effect using LIFX HTTP API
517
+ // Available effects: pulse, breathe, move, morph, flame
518
+ async setEffect(fxName, auth, options = {}) {
519
+ try {
520
+ // First get the light ID
521
+ const lightData = await this.getLightData(auth);
522
+ const lightId = lightData.id;
523
+
524
+ // Default options for each effect
525
+ const defaultOptions = {
526
+ pulse: {
527
+ color: 'blue',
528
+ from_color: null,
529
+ period: 1,
530
+ cycles: 5,
531
+ persist: false,
532
+ power_on: true,
533
+ peak: 0.5
534
+ },
535
+ breathe: {
536
+ color: 'blue',
537
+ from_color: null,
538
+ period: 1,
539
+ cycles: 5,
540
+ persist: false,
541
+ power_on: true,
542
+ peak: 0.5
543
+ },
544
+ move: {
545
+ direction: 'forward',
546
+ period: 1,
547
+ cycles: 5,
548
+ power_on: true
549
+ },
550
+ morph: {
551
+ period: 5,
552
+ duration: null,
553
+ palette: ['red', 'green', 'blue'],
554
+ power_on: true
555
+ },
556
+ flame: {
557
+ period: 5,
558
+ duration: null,
559
+ power_on: true
560
+ }
561
+ };
562
+
563
+ // Merge user options with defaults
564
+ const effectOptions = {
565
+ ...defaultOptions[fxName],
566
+ ...options
567
+ };
568
+
569
+ const requestOptions = {
570
+ method: 'POST',
571
+ url: `https://api.lifx.com/v1/lights/${lightId}/effects/${fxName}`,
572
+ headers: {
573
+ accept: 'application/json',
574
+ Authorization: `Bearer ${auth}`,
575
+ 'content-type': 'application/json'
576
+ },
577
+ data: effectOptions
578
+ };
579
+
580
+ const response = await axios.request(requestOptions);
581
+ console.log(`Effect '${fxName}' applied successfully`);
582
+ return response.data;
583
+ } catch (error) {
584
+ console.error('Error applying effect:', error.response ? error.response.data : error.message);
585
+ throw error;
586
+ }
587
+ }
588
+
589
+ // Stop any running effect
590
+ async stopEffect(auth) {
591
+ try {
592
+ const lightData = await this.getLightData(auth);
593
+ const lightId = lightData.id;
594
+
595
+ const options = {
596
+ method: 'POST',
597
+ url: `https://api.lifx.com/v1/lights/${lightId}/effects/off`,
598
+ headers: {
599
+ accept: 'application/json',
600
+ Authorization: `Bearer ${auth}`
601
+ }
602
+ };
603
+
604
+ const response = await axios.request(options);
605
+ console.log('Effect stopped');
606
+ return response.data;
607
+ } catch (error) {
608
+ console.error('Error stopping effect:', error.response ? error.response.data : error.message);
609
+ throw error;
610
+ }
611
+ }
612
+
613
+ // Close socket
614
+ close() {
615
+ this.socket.close();
616
+ }
617
+ }
618
+
619
+ module.exports = LifxLAN;
package/package.json ADDED
@@ -0,0 +1,49 @@
1
+ {
2
+ "name": "@west7014/lifx-lan",
3
+ "version": "1.0.2",
4
+ "description": "a simple package that aims to bring all available features to LIFX devices over LAN with some API-based features as well",
5
+ "keywords": [
6
+ "lifx",
7
+ "lan",
8
+ "smart-light",
9
+ "iot",
10
+ "home-automation"
11
+ ],
12
+ "author": {
13
+ "email": "west701497@gmail.com",
14
+ "name": "Katt",
15
+ "url": "https://github.com/thatWest7014"
16
+ },
17
+ "contributors": [
18
+ "simplyKit (https://github.com/simplyKit)"
19
+ ],
20
+ "files": [
21
+ "./index.js",
22
+ "./index.d.ts",
23
+ "LICENSE",
24
+ "./README.md"
25
+ ],
26
+ "license": "MIT",
27
+ "repository": {
28
+ "type": "git",
29
+ "url": "git+https://github.com/thatWest7014/LIFX-LAN-Client-Node.git"
30
+ },
31
+ "type": "commonjs",
32
+ "main": "./index.js",
33
+ "types": "./index.d.ts",
34
+ "scripts": {
35
+ "test": "echo \"Error: no test specified\" && exit 1"
36
+ },
37
+ "peerDependencies": {
38
+ "axios": ">=1.0.0",
39
+ "dotenv": "16.4.5"
40
+ },
41
+ "peerDependenciesMeta": {
42
+ "dotenv": {
43
+ "optional": true
44
+ }
45
+ },
46
+ "engines": {
47
+ "node": ">=18"
48
+ }
49
+ }