iobroker.zigbee 1.6.16 → 1.6.17

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 (53) hide show
  1. package/.eslintignore +1 -1
  2. package/.eslintrc.json +36 -36
  3. package/.github/FUNDING.yml +3 -3
  4. package/.github/stale.yml +13 -13
  5. package/.github/workflows/test-and-release.yml +151 -151
  6. package/.travis/wiki.sh +27 -27
  7. package/LICENSE +21 -21
  8. package/README.md +425 -424
  9. package/admin/adapter-settings.js +244 -244
  10. package/admin/admin.js +2926 -2926
  11. package/admin/img/philips_hue_lom001.png +0 -0
  12. package/admin/index.html +159 -159
  13. package/admin/index_m.html +1161 -1158
  14. package/admin/moment.min.js +1 -1
  15. package/admin/shuffle.min.js +2 -2
  16. package/admin/tab_m.html +944 -944
  17. package/admin/vis-network.min.js +26 -26
  18. package/admin/words.js +109 -108
  19. package/docs/de/readme.md +27 -27
  20. package/docs/en/readme.md +30 -30
  21. package/docs/flashing_via_arduino_(en).md +110 -110
  22. package/docs/ru/readme.md +28 -28
  23. package/docs/tutorial/groups-1.png +0 -0
  24. package/docs/tutorial/groups-2.png +0 -0
  25. package/docs/tutorial/tab-dev-1.png +0 -0
  26. package/io-package.json +367 -355
  27. package/lib/backup.js +132 -132
  28. package/lib/binding.js +325 -325
  29. package/lib/colors.js +460 -460
  30. package/lib/commands.js +501 -501
  31. package/lib/developer.js +148 -148
  32. package/lib/devices.js +3145 -3144
  33. package/lib/exclude.js +168 -168
  34. package/lib/exposes.js +803 -795
  35. package/lib/groups.js +342 -342
  36. package/lib/json.js +60 -60
  37. package/lib/networkmap.js +56 -56
  38. package/lib/ota.js +179 -179
  39. package/lib/rgb.js +255 -255
  40. package/lib/seriallist.js +37 -37
  41. package/lib/states.js +6416 -6407
  42. package/lib/statescontroller.js +627 -627
  43. package/lib/tools.js +54 -54
  44. package/lib/utils.js +151 -151
  45. package/lib/zbBaseExtension.js +36 -32
  46. package/lib/zbDelayedAction.js +152 -152
  47. package/lib/zbDeviceAvailability.js +321 -318
  48. package/lib/zbDeviceConfigure.js +152 -152
  49. package/lib/zbDeviceEvent.js +49 -49
  50. package/lib/zigbeecontroller.js +946 -946
  51. package/main.js +42 -3
  52. package/package.json +77 -77
  53. package/support/docgen.js +93 -93
package/lib/exposes.js CHANGED
@@ -1,795 +1,803 @@
1
- 'use strict';
2
-
3
- const zigbeeHerdsmanConverters = require('zigbee-herdsman-converters');
4
- const statesDefs = require(__dirname + '/states.js').states;
5
- const rgb = require(__dirname + '/rgb.js');
6
- const utils = require(__dirname + '/utils.js');
7
- const colors = require(__dirname + '/colors.js');
8
- const ea = zigbeeHerdsmanConverters.exposes.access;
9
-
10
- function genState(expose, role, name, desc) {
11
- let state;
12
- const readable = (expose.access & ea.STATE) > 0;
13
- const writable = (expose.access & ea.SET) > 0;
14
- const stname = (name || expose.property);
15
- if (typeof stname !== 'string') return;
16
- const stateId = stname.replace(/\*/g, '');
17
- const stateName = (desc || expose.description || expose.name);
18
- const propName = expose.property;
19
- switch (expose.type) {
20
- case 'binary':
21
- state = {
22
- id: stateId,
23
- prop: propName,
24
- name: stateName,
25
- icon: undefined,
26
- role: role || 'state',
27
- write: writable,
28
- read: true,
29
- type: 'boolean',
30
- };
31
- if (readable) {
32
- state.getter = payload => (payload[propName] === (expose.value_on || 'ON'));
33
- }
34
- else {
35
- state.getter = payload => ( undefined);
36
- }
37
- if (writable) {
38
- state.setter = (value) => (value) ? (expose.value_on || 'ON') : ((expose.value_off != undefined) ? expose.value_off : 'OFF');
39
- state.setattr = expose.name;
40
- }
41
- if (expose.endpoint) {
42
- state.epname = expose.endpoint;
43
- }
44
- break;
45
-
46
- case 'numeric':
47
- state = {
48
- id: stateId,
49
- prop: propName,
50
- name: stateName,
51
- icon: undefined,
52
- role: role || 'state',
53
- write: writable,
54
- read: true,
55
- type: 'number',
56
- min: expose.value_min || 0,
57
- max: expose.value_max,
58
- unit: expose.unit,
59
- };
60
- if (expose.endpoint) {
61
- state.epname = expose.endpoint;
62
- }
63
- break;
64
-
65
- case 'enum':
66
- state = {
67
- id: stateId,
68
- prop: propName,
69
- name: stateName,
70
- icon: undefined,
71
- role: role || 'state',
72
- write: writable,
73
- read: true,
74
- type: 'string',
75
- states: expose.values.map((item) => `${item}:${item}`).join(';'),
76
- };
77
- if (expose.endpoint) {
78
- state.epname = expose.endpoint;
79
- state.setattr = expose.name;
80
- }
81
- break;
82
-
83
- case 'text':
84
- state = {
85
- id: stateId,
86
- prop: propName,
87
- name: stateName,
88
- icon: undefined,
89
- role: role || 'state',
90
- write: writable,
91
- read: true,
92
- type: 'string',
93
- };
94
- if (expose.endpoint) {
95
- state.epname = expose.endpoint;
96
- }
97
- break;
98
-
99
- default:
100
- break;
101
- }
102
-
103
- return state;
104
- }
105
-
106
-
107
-
108
- function createFromExposes(model, def) {
109
- const states = [];
110
- // make the different (set and get) part of state is updatable if different exposes is used for get and set
111
- // as example:
112
- // ...
113
- // exposes.binary('some_option', ea.STATE, true, false).withDescription('Some Option'),
114
- // exposes.composite('options', 'options')
115
- // .withDescription('Some composite Options')
116
- // .withFeature(exposes.binary('some_option', ea.SET, true, false).withDescription('Some Option'))
117
- //in this case one state - `some_option` has two different exposes for set an get, we have to combine it ...
118
- //
119
-
120
- function pushToStates(state, access) {
121
- if (state === undefined) {
122
- return 0;
123
- }
124
- if (access === undefined) access = ea.ALL;
125
- state.readable = (access & ea.STATE) > 0;
126
- state.writable = (access & ea.SET) > 0;
127
- const stateExists = states.findIndex( (element, index, array) => (element.id === state.id ));
128
- if (stateExists < 0 ) {
129
- state.write = state.writable;
130
- if (! state.writable) {
131
- if ( state.hasOwnProperty('setter') ) {
132
- delete state.setter;
133
- }
134
- if ( state.hasOwnProperty('setattr') ) {
135
- delete state.setattr;
136
- }
137
- }
138
- if (! state.readable) {
139
- if (state.hasOwnProperty('getter') ) {
140
- //to awid some worning on unprocessed data
141
- state.getter = payload => ( undefined );
142
- }
143
- }
144
- return states.push(state);
145
- }
146
- else {
147
- if ( (state.readable) && (! states[stateExists].readable ) ) {
148
- states[stateExists].read = state.read;
149
- // as state is readable, it can't be button or event
150
- if (states[stateExists].role === 'button') {
151
- states[stateExists].role = state.role;
152
- }
153
- if (states[stateExists].hasOwnProperty('isEvent')) {
154
- delete states[stateExists].isEvent;
155
- }
156
- // we have to use the getter from "new" state
157
- if ( state.hasOwnProperty('getter') ) {
158
- states[stateExists].getter = state.getter;
159
- }
160
- // trying to remove the `prop` property, as main key for get and set,
161
- // as it can be different in new and old states, and leave only:
162
- // setattr for old and id for new
163
- if (( state.hasOwnProperty('prop') ) && (state.prop === state.id)) {
164
- if ( states[stateExists].hasOwnProperty('prop') ) {
165
- if (states[stateExists].prop !== states[stateExists].id) {
166
- if (! states[stateExists].hasOwnProperty('setattr')) {
167
- states[stateExists].setattr = states[stateExists].prop;
168
- }
169
- }
170
- delete states[stateExists].prop;
171
- }
172
- }
173
- else if ( state.hasOwnProperty('prop') ) {
174
- states[stateExists].prop = state.prop;
175
- }
176
- states[stateExists].readable = true;
177
- }
178
- if ( (state.writable) && (! states[stateExists].writable ) ) {
179
- states[stateExists].write = state.writable;
180
- // use new state `setter`
181
- if ( state.hasOwnProperty('setter') ) {
182
- states[stateExists].setter = state.setter;
183
- }
184
- // use new state `setterOpt`
185
- if ( state.hasOwnProperty('setterOpt') ) {
186
- states[stateExists].setterOpt = state.setterOpt;
187
- }
188
- // use new state `inOptions`
189
- if ( state.hasOwnProperty('inOptions') ) {
190
- states[stateExists].inOptions = state.inOptions;
191
- }
192
- // as we have new state, responsible for set, we have to use new `isOption`
193
- // or remove it
194
- if (((! state.hasOwnProperty('isOption') ) || (state.isOptions === false))
195
- && (states[stateExists].hasOwnProperty('isOption'))) {
196
- delete states[stateExists].isOption;
197
- }
198
- else {
199
- states[stateExists].isOption = state.isOption;
200
- }
201
- // use new `setattr` or `prop` as `setattr`
202
- if ( state.hasOwnProperty('setattr') ) {
203
- states[stateExists].setattr = state.setattr;
204
- }
205
- else if ( state.hasOwnProperty('prop') ) {
206
- states[stateExists].setattr = state.prop;
207
- }
208
- // remove `prop` equal to if, due to prop is uses as key in set and get
209
- if ( states[stateExists].prop === states[stateExists].id) {
210
- delete states[stateExists].prop;
211
- }
212
- if ( state.hasOwnProperty('epname') ) {
213
- states[stateExists].epname = state.epname;
214
- }
215
- states[stateExists].writable = true;
216
- }
217
- return states.length;
218
- }
219
- }
220
- const icon = utils.getDeviceIcon(def);
221
- for (const expose of def.exposes) {
222
- let state;
223
-
224
- switch (expose.type) {
225
- case 'light':
226
- for (const prop of expose.features) {
227
- switch (prop.name) {
228
- case 'state': {
229
- const stateNameS = expose.endpoint ? `state_${expose.endpoint}` : 'state';
230
- pushToStates({
231
- id: stateNameS,
232
- name: `Switch state ${expose.endpoint ? expose.endpoint : ''}`.trim(),
233
- icon: undefined,
234
- role: 'switch',
235
- write: true,
236
- read: true,
237
- type: 'boolean',
238
- getter: (payload) => (payload[stateNameS] === (prop.value_on || 'ON')),
239
- setter: (value) => (value) ? prop.value_on || 'ON' : ((prop.value_off != undefined) ? prop.value_off : 'OFF'),
240
- epname: expose.endpoint,
241
- setattr: 'state',
242
- }, prop.access);
243
- break;
244
- }
245
- case 'brightness': {
246
- const stateNameB = expose.endpoint ? `brightness_${expose.endpoint}` : 'brightness';
247
- pushToStates({
248
- id: stateNameB,
249
- name: `Brightness ${expose.endpoint ? expose.endpoint : ''}`.trim(),
250
- icon: undefined,
251
- role: 'level.dimmer',
252
- write: true,
253
- read: true,
254
- type: 'number',
255
- min: 0, // ignore expose.value_min
256
- max: 100, // ignore expose.value_max
257
- inOptions: true,
258
- getter: payload => {
259
- return utils.bulbLevelToAdapterLevel(payload[stateNameB]);
260
- },
261
- setter: (value) => {
262
- return utils.adapterLevelToBulbLevel(value);
263
- },
264
- setterOpt: (value, options) => {
265
- const hasTransitionTime = options && options.hasOwnProperty('transition_time');
266
- const transitionTime = hasTransitionTime ? options.transition_time : 0;
267
- const preparedOptions = {...options, transition: transitionTime};
268
- preparedOptions.brightness = utils.adapterLevelToBulbLevel(value);
269
- return preparedOptions;
270
- },
271
- readResponse: (resp) => {
272
- const respObj = resp[0];
273
- if (respObj.status === 0 && respObj.attrData != undefined) {
274
- return utils.bulbLevelToAdapterLevel(respObj.attrData);
275
- }
276
- },
277
- epname: expose.endpoint,
278
- setattr: 'brightness',
279
- }, prop.access);
280
- pushToStates(statesDefs.brightness_move, prop.access);
281
- break;
282
- }
283
- case 'color_temp': {
284
- const stateNameT = expose.endpoint ? `colortemp_${expose.endpoint}` : 'colortemp';
285
- pushToStates({
286
- id: stateNameT,
287
- prop: expose.endpoint ? `color_temp_${expose.endpoint}` : 'color_temp',
288
- name: `Color temperature ${expose.endpoint ? expose.endpoint : ''}`.trim(),
289
- icon: undefined,
290
- role: 'level.color.temperature',
291
- write: true,
292
- read: true,
293
- type: 'number',
294
- min: expose.value_min,
295
- max: expose.value_max,
296
- setter: (value) => {
297
- return utils.toMired(value);
298
- },
299
- setterOpt: (value, options) => {
300
- const hasTransitionTime = options && options.hasOwnProperty('transition_time');
301
- const transitionTime = hasTransitionTime ? options.transition_time : 0;
302
- return {...options, transition: transitionTime};
303
- },
304
- epname: expose.endpoint,
305
- }, prop.access);
306
- pushToStates(statesDefs.colortemp_move, prop.access);
307
- break;
308
- }
309
- case 'color_xy': {
310
- const stateNameC = expose.endpoint ? `color_${expose.endpoint}` : 'color';
311
- pushToStates({
312
- id: stateNameC,
313
- prop: expose.endpoint ? `color_${expose.endpoint}` : 'color',
314
- name: `Color ${expose.endpoint ? expose.endpoint : ''}`.trim(),
315
- icon: undefined,
316
- role: 'level.color.rgb',
317
- write: true,
318
- read: true,
319
- type: 'string',
320
- setter: (value) => {
321
- // convert RGB to XY for set
322
- /*
323
- const result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(value);
324
- let xy = [0, 0];
325
- if (result) {
326
- const r = parseInt(result[1], 16),
327
- g = parseInt(result[2], 16),
328
- b = parseInt(result[3], 16);
329
- xy = rgb.rgb_to_cie(r, g, b);
330
- }
331
- return {
332
- x: xy[0],
333
- y: xy[1]
334
- };
335
- */
336
- let xy = [0, 0];
337
- const rgbcolor = colors.ParseColor(value);
338
-
339
- xy = rgb.rgb_to_cie(rgbcolor.r, rgbcolor.g, rgbcolor.b);
340
- return {
341
- x: xy[0],
342
- y: xy[1]
343
- };
344
-
345
- },
346
- setterOpt: (value, options) => {
347
- const hasTransitionTime = options && options.hasOwnProperty('transition_time');
348
- const transitionTime = hasTransitionTime ? options.transition_time : 0;
349
- return {...options, transition: transitionTime};
350
- },
351
- getter: payload => {
352
- if (payload.color && payload.color.hasOwnProperty('x') && payload.color.hasOwnProperty('y')) {
353
- const colorval = rgb.cie_to_rgb(payload.color.x, payload.color.y);
354
- return '#' + utils.decimalToHex(colorval[0]) + utils.decimalToHex(colorval[1]) + utils.decimalToHex(colorval[2]);
355
- } else {
356
- return undefined;
357
- }
358
- },
359
- epname: expose.endpoint,
360
- setattr: 'color',
361
- }, prop.access);
362
- break;
363
- }
364
- case 'color_hs': {
365
- const stateNameH = expose.endpoint ? `color_${expose.endpoint}` : 'color';
366
- pushToStates({
367
- id: stateNameH,
368
- prop: expose.endpoint ? `color_${expose.endpoint}` : 'color',
369
- name: `Color ${expose.endpoint ? expose.endpoint : ''}`.trim(),
370
- icon: undefined,
371
- role: 'level.color.rgb',
372
- write: true,
373
- read: true,
374
- type: 'string',
375
- setter: (value) => {
376
- const _rgb = colors.ParseColor(value);
377
- const hsv = rgb.rgbToHSV(_rgb.r, _rgb.g, _rgb.b, true);
378
- return {
379
- hue: Math.min(Math.max(hsv.h,1),359),
380
- saturation: hsv.s,
381
- // brightness: Math.floor(hsv.v * 2.55),
382
-
383
- };
384
- },
385
- setterOpt: (value, options) => {
386
- const hasTransitionTime = options && options.hasOwnProperty('transition_time');
387
- const transitionTime = hasTransitionTime ? options.transition_time : 0;
388
- return {...options, transition: transitionTime};
389
- },
390
- epname: expose.endpoint,
391
- setattr: 'color',
392
- }, prop.access);
393
- pushToStates({
394
- id: expose.endpoint ? `hue_${expose.endpoint}` : 'hue',
395
- prop: expose.endpoint ? `color_${expose.endpoint}` : 'color',
396
- name: `Hue ${expose.endpoint ? expose.endpoint : ''}`.trim(),
397
- icon: undefined,
398
- role: 'level.color.hue',
399
- write: true,
400
- read: false,
401
- type: 'number',
402
- min: 0,
403
- max: 360,
404
- inOptions: true,
405
- setter: (value, options) => {
406
- return {
407
- hue: value,
408
- saturation: options.saturation,
409
- };
410
- },
411
- setterOpt: (value, options) => {
412
- const hasTransitionTime = options && options.hasOwnProperty('transition_time');
413
- const transitionTime = hasTransitionTime ? options.transition_time : 0;
414
- const hasHueCalibrationTable = options && options.hasOwnProperty('hue_calibration');
415
- if (hasHueCalibrationTable)
416
- try {
417
- return {...options, transition: transitionTime, hue_correction: JSON.parse(options.hue_calibration)};
418
- }
419
- catch {
420
- const hue_correction_table = [];
421
- options.hue_calibration.split(',').forEach(element => {
422
- const match = /([0-9]+):([0-9]+)/.exec(element);
423
- if (match && match.length ==3)
424
- hue_correction_table.push({ in: Number(match[1]), out: Number(match[2])});
425
- });
426
- if (hue_correction_table.length > 0)
427
- return {...options, transition: transitionTime, hue_correction: hue_correction_table};
428
- }
429
- return {...options, transition: transitionTime};
430
- },
431
-
432
- }, prop.access);
433
- pushToStates({
434
- id: expose.endpoint ? `saturation_${expose.endpoint}` : 'saturation',
435
- prop: expose.endpoint ? `color_${expose.endpoint}` : 'color',
436
- name: `Saturation ${expose.endpoint ? expose.endpoint : ''}`.trim(),
437
- icon: undefined,
438
- role: 'level.color.saturation',
439
- write: true,
440
- read: false,
441
- type: 'number',
442
- min: 0,
443
- max: 100,
444
- inOptions: true,
445
- setter: (value, options) => {
446
- return {
447
- hue: options.hue,
448
- saturation: value,
449
- };
450
- },
451
- setterOpt: (value, options) => {
452
- const hasTransitionTime = options && options.hasOwnProperty('transition_time');
453
- const transitionTime = hasTransitionTime ? options.transition_time : 0;
454
- const hasHueCalibrationTable = options && options.hasOwnProperty('hue_calibration');
455
- if (hasHueCalibrationTable)
456
- try {
457
- return {...options, transition: transitionTime, hue_correction: JSON.parse(options.hue_calibration)};
458
- }
459
- catch {
460
- const hue_correction_table = [];
461
- options.hue_calibration.split(',').forEach(element => {
462
- const match = /([0-9]+):([0-9]+)/.exec(element);
463
- if (match && match.length ==3)
464
- hue_correction_table.push({ in: Number(match[1]), out: Number(match[2])});
465
- });
466
- if (hue_correction_table.length > 0)
467
- return {...options, transition: transitionTime, hue_correction: hue_correction_table};
468
- }
469
- return {...options, transition: transitionTime};
470
- },
471
-
472
- }, prop.access);
473
- pushToStates(statesDefs.hue_move, prop.access);
474
- pushToStates(statesDefs.saturation_move, prop.access);
475
- pushToStates({
476
- id: 'hue_calibration',
477
- prop: 'color',
478
- name: 'Hue color calibration table',
479
- icon: undefined,
480
- role: 'table',
481
- write: true,
482
- read: false,
483
- type: 'string',
484
- inOptions: true,
485
- setter: (value, options) => {
486
- return {
487
- hue: options.hue,
488
- saturation: options.saturation,
489
- };
490
- },
491
- setterOpt: (value, options) => {
492
- const hasTransitionTime = options && options.hasOwnProperty('transition_time');
493
- const transitionTime = hasTransitionTime ? options.transition_time : 0;
494
- const hasHueCalibrationTable = options && options.hasOwnProperty('hue_calibration');
495
- if (hasHueCalibrationTable)
496
- try {
497
- return {...options, transition: transitionTime, hue_correction: JSON.parse(options.hue_calibration)};
498
- }
499
- catch {
500
- const hue_correction_table = [];
501
- options.hue_calibration.split(',').forEach(element => {
502
- const match = /([0-9]+):([0-9]+)/.exec(element);
503
- if (match && match.length ==3)
504
- hue_correction_table.push({ in: Number(match[1]), out: Number(match[2])});
505
- });
506
- if (hue_correction_table.length > 0)
507
- return {...options, transition: transitionTime, hue_correction: hue_correction_table};
508
- }
509
- return {...options, transition: transitionTime};
510
- },
511
-
512
- }, prop.access);
513
- break;
514
- }
515
- default:
516
- pushToStates(genState(prop), prop.access);
517
- break;
518
- }
519
- }
520
- pushToStates(statesDefs.transition_time, ea.STATE_SET);
521
- break;
522
-
523
- case 'switch':
524
- for (const prop of expose.features) {
525
- switch (prop.name) {
526
- case 'state':
527
- pushToStates(genState(prop, 'switch'), prop.access);
528
- break;
529
- default:
530
- pushToStates(genState(prop), prop.access);
531
- break;
532
- }
533
- }
534
- break;
535
-
536
- case 'numeric':
537
- if (expose.endpoint) {
538
- state = genState(expose);
539
- } else {
540
- switch (expose.name) {
541
- case 'linkquality':
542
- state = undefined;
543
- break;
544
-
545
- case 'battery':
546
- state = statesDefs.battery;
547
- break;
548
-
549
- case 'voltage':
550
- state = statesDefs.plug_voltage;
551
- break;
552
-
553
- case 'temperature':
554
- state = statesDefs.temperature;
555
- break;
556
-
557
- case 'humidity':
558
- state = statesDefs.humidity;
559
- break;
560
-
561
- case 'pressure':
562
- state = statesDefs.pressure;
563
- break;
564
-
565
- case 'illuminance':
566
- state = statesDefs.illuminance_raw;
567
- break;
568
-
569
- case 'illuminance_lux':
570
- state = statesDefs.illuminance;
571
- break;
572
-
573
- case 'power':
574
- state = statesDefs.load_power;
575
- break;
576
-
577
- default:
578
- state = genState(expose);
579
- break;
580
- }
581
- }
582
- if (state) pushToStates(state, expose.access);
583
- break;
584
-
585
- case 'enum':
586
- switch (expose.name) {
587
- case 'action': {
588
- if (!Array.isArray(expose.values)) break;
589
- const hasHold = expose.values.find((actionName) => actionName.includes('hold'));
590
- const hasRelease = expose.values.find((actionName) => actionName.includes('release'));
591
- for (const actionName of expose.values) {
592
- // is release state ? - skip
593
- if (hasHold && hasRelease && actionName.includes('release')) continue;
594
- // is hold state ?
595
- if (hasHold && hasRelease && actionName.includes('hold')) {
596
- const releaseActionName = actionName.replace('hold', 'release');
597
- state = {
598
- id: actionName.replace(/\*/g, ''),
599
- prop: 'action',
600
- name: actionName,
601
- icon: undefined,
602
- role: 'button',
603
- write: false,
604
- read: true,
605
- type: 'boolean',
606
- getter: payload => (payload.action === actionName) ? true : (payload.action === releaseActionName) ? false : undefined,
607
- };
608
- } else {
609
- state = {
610
- id: actionName.replace(/\*/g, ''),
611
- prop: 'action',
612
- name: actionName,
613
- icon: undefined,
614
- role: 'button',
615
- write: false,
616
- read: true,
617
- type: 'boolean',
618
- getter: payload => (payload.action === actionName) ? true : undefined,
619
- isEvent: true,
620
- };
621
- }
622
- pushToStates(state, expose.access);
623
- }
624
- state = null;
625
- break;
626
- }
627
- default:
628
- state = genState(expose);
629
- break;
630
- }
631
- if (state) pushToStates(state, expose.access);
632
- break;
633
-
634
- case 'binary':
635
- if (expose.endpoint) {
636
- state = genState(expose);
637
- } else {
638
- switch (expose.name) {
639
- case 'contact':
640
- state = statesDefs.contact;
641
- pushToStates(statesDefs.opened, ea.STATE);
642
- break;
643
-
644
- case 'battery_low':
645
- state = statesDefs.heiman_batt_low;
646
- break;
647
-
648
- case 'tamper':
649
- state = statesDefs.tamper;
650
- break;
651
-
652
- case 'water_leak':
653
- state = statesDefs.water_detected;
654
- break;
655
-
656
- case 'lock':
657
- state = statesDefs.child_lock;
658
- break;
659
-
660
- case 'occupancy':
661
- state = statesDefs.occupancy;
662
- break;
663
-
664
- default:
665
- state = genState(expose);
666
- break;
667
- }
668
- }
669
- if (state) pushToStates(state, expose.access);
670
- break;
671
-
672
- case 'text':
673
- state = genState(expose);
674
- pushToStates(state, expose.access);
675
- break;
676
-
677
- case 'lock':
678
- case 'fan':
679
- case 'cover':
680
- for (const prop of expose.features) {
681
- switch (prop.name) {
682
- case 'state':
683
- pushToStates(genState(prop, 'switch'), prop.access);
684
- break;
685
- default:
686
- pushToStates(genState(prop), prop.access);
687
- break;
688
- }
689
- }
690
- break;
691
-
692
- case 'climate':
693
- for (const prop of expose.features) {
694
- switch (prop.name) {
695
- case 'away_mode':
696
- pushToStates(statesDefs.climate_away_mode, prop.access);
697
- break;
698
- case 'system_mode':
699
- pushToStates(statesDefs.climate_system_mode, prop.access);
700
- break;
701
- case 'running_mode':
702
- pushToStates(statesDefs.climate_running_mode, prop.access);
703
- break;
704
- default:
705
- pushToStates(genState(prop), prop.access);
706
- break;
707
- }
708
- }
709
- break;
710
-
711
- case 'composite':
712
- for (const prop of expose.features) {
713
- const st = genState(prop);
714
- st.prop = expose.property;
715
- st.inOptions = true;
716
- // I'm not fully sure, as it really needed, but
717
- st.setterOpt = (value, options) => {
718
- const result = {};
719
- options[prop.property] = value;
720
- result[expose.property] = options;
721
- return result;
722
- };
723
- // if we have a composite expose, the value have to be an object {expose.property : {prop.property: value}}
724
- if (prop.access & ea.SET) {
725
- st.setter = (value, options) => {
726
- const result = {};
727
- options[prop.property] = value;
728
- result[expose.property] = options;
729
- return result;
730
- };
731
- st.setattr = expose.property;
732
- };
733
- // if we have a composite expose, the payload will be an object {expose.property : {prop.property: value}}
734
- if (prop.access & ea.STATE) {
735
- st.getter = payload => {
736
- if ( (payload.hasOwnProperty(expose.property)) && (payload[expose.property] !== null) && payload[expose.property].hasOwnProperty(prop.property)) {
737
- return !isNaN(payload[expose.property][prop.property]) ? payload[expose.property][prop.property] : undefined
738
- }
739
- else {
740
- return undefined;
741
- }
742
- };
743
- }
744
- else {
745
- st.getter = payload => { return undefined };
746
- }
747
- ;
748
- pushToStates(st, prop.access);
749
- }
750
- break;
751
- default:
752
- console.log(`Unhandled expose type ${expose.type} for device ${model}`);
753
- }
754
- }
755
- const newDev = {
756
- models: [model],
757
- icon: icon,
758
- states: states,
759
- exposed: true,
760
- };
761
- // make the function code printable in log
762
- //console.log(`Created mapping for device ${model}: ${JSON.stringify(newDev, function(key, value) {
763
- // if (typeof value === 'function') {return value.toString() } else { return value } }, ' ')}`);
764
- return newDev;
765
- }
766
-
767
- function applyExposes(mappedDevices, byModel, allExcludesObj) {
768
- // for exlude search
769
- const allExcludesStr = JSON.stringify(allExcludesObj);
770
- // create or update device from exposes
771
- for (const deviceDef of zigbeeHerdsmanConverters.definitions) {
772
- const strippedModel = (deviceDef.model) ? deviceDef.model.replace(/\0.*$/g, '').trim() : '';
773
- // check if device is mapped
774
- const existsMap = byModel.get(strippedModel);
775
-
776
- if ((deviceDef.hasOwnProperty('exposes') && (!existsMap || !existsMap.hasOwnProperty('states'))) || allExcludesStr.indexOf(strippedModel) > 0) {
777
- try {
778
- const newDevice = createFromExposes(strippedModel, deviceDef);
779
- if (!existsMap) {
780
- mappedDevices.push(newDevice);
781
- byModel.set(strippedModel, newDevice);
782
- } else {
783
- existsMap.states = newDevice.states;
784
- existsMap.exposed = true;
785
- }
786
- } catch (e) {
787
- console.log(`Wrong expose devicedefinition ${deviceDef.vendor} ${deviceDef.model}` );
788
- }
789
- }
790
- }
791
- }
792
-
793
- module.exports = {
794
- applyExposes: applyExposes,
795
- };
1
+ 'use strict';
2
+
3
+ const zigbeeHerdsmanConverters = require('zigbee-herdsman-converters');
4
+ const statesDefs = require(__dirname + '/states.js').states;
5
+ const rgb = require(__dirname + '/rgb.js');
6
+ const utils = require(__dirname + '/utils.js');
7
+ const colors = require(__dirname + '/colors.js');
8
+ const ea = zigbeeHerdsmanConverters.exposes.access;
9
+
10
+ function genState(expose, role, name, desc) {
11
+ let state;
12
+ const readable = (expose.access & ea.STATE) > 0;
13
+ const writable = (expose.access & ea.SET) > 0;
14
+ const stname = (name || expose.property);
15
+ if (typeof stname !== 'string') return;
16
+ const stateId = stname.replace(/\*/g, '');
17
+ const stateName = (desc || expose.description || expose.name);
18
+ const propName = expose.property;
19
+ switch (expose.type) {
20
+ case 'binary':
21
+ state = {
22
+ id: stateId,
23
+ prop: propName,
24
+ name: stateName,
25
+ icon: undefined,
26
+ role: role || 'state',
27
+ write: writable,
28
+ read: true,
29
+ type: 'boolean',
30
+ };
31
+ if (readable) {
32
+ state.getter = payload => (payload[propName] === (expose.value_on || 'ON'));
33
+ }
34
+ else {
35
+ state.getter = payload => ( undefined);
36
+ }
37
+ if (writable) {
38
+ state.setter = (value) => (value) ? (expose.value_on || 'ON') : ((expose.value_off != undefined) ? expose.value_off : 'OFF');
39
+ state.setattr = expose.name;
40
+ }
41
+ if (expose.endpoint) {
42
+ state.epname = expose.endpoint;
43
+ }
44
+ break;
45
+
46
+ case 'numeric':
47
+ state = {
48
+ id: stateId,
49
+ prop: propName,
50
+ name: stateName,
51
+ icon: undefined,
52
+ role: role || 'state',
53
+ write: writable,
54
+ read: true,
55
+ type: 'number',
56
+ min: expose.value_min || 0,
57
+ max: expose.value_max,
58
+ unit: expose.unit,
59
+ };
60
+ if (expose.endpoint) {
61
+ state.epname = expose.endpoint;
62
+ }
63
+ break;
64
+
65
+ case 'enum':
66
+ state = {
67
+ id: stateId,
68
+ prop: propName,
69
+ name: stateName,
70
+ icon: undefined,
71
+ role: role || 'state',
72
+ write: writable,
73
+ read: true,
74
+ type: 'string',
75
+ states: expose.values.map((item) => `${item}:${item}`).join(';'),
76
+ };
77
+ if (expose.endpoint) {
78
+ state.epname = expose.endpoint;
79
+ state.setattr = expose.name;
80
+ }
81
+ break;
82
+
83
+ case 'text':
84
+ state = {
85
+ id: stateId,
86
+ prop: propName,
87
+ name: stateName,
88
+ icon: undefined,
89
+ role: role || 'state',
90
+ write: writable,
91
+ read: true,
92
+ type: 'string',
93
+ };
94
+ if (expose.endpoint) {
95
+ state.epname = expose.endpoint;
96
+ }
97
+ break;
98
+
99
+ default:
100
+ break;
101
+ }
102
+
103
+ return state;
104
+ }
105
+
106
+
107
+
108
+ function createFromExposes(model, def) {
109
+ const states = [];
110
+ // make the different (set and get) part of state is updatable if different exposes is used for get and set
111
+ // as example:
112
+ // ...
113
+ // exposes.binary('some_option', ea.STATE, true, false).withDescription('Some Option'),
114
+ // exposes.composite('options', 'options')
115
+ // .withDescription('Some composite Options')
116
+ // .withFeature(exposes.binary('some_option', ea.SET, true, false).withDescription('Some Option'))
117
+ //in this case one state - `some_option` has two different exposes for set an get, we have to combine it ...
118
+ //
119
+
120
+ function pushToStates(state, access) {
121
+ if (state === undefined) {
122
+ return 0;
123
+ }
124
+ if (access === undefined) access = ea.ALL;
125
+ state.readable = (access & ea.STATE) > 0;
126
+ state.writable = (access & ea.SET) > 0;
127
+ const stateExists = states.findIndex( (element, index, array) => (element.id === state.id ));
128
+ if (stateExists < 0 ) {
129
+ state.write = state.writable;
130
+ if (! state.writable) {
131
+ if ( state.hasOwnProperty('setter') ) {
132
+ delete state.setter;
133
+ }
134
+ if ( state.hasOwnProperty('setattr') ) {
135
+ delete state.setattr;
136
+ }
137
+ }
138
+ if (! state.readable) {
139
+ if (state.hasOwnProperty('getter') ) {
140
+ //to awid some worning on unprocessed data
141
+ state.getter = payload => ( undefined );
142
+ }
143
+ }
144
+ return states.push(state);
145
+ }
146
+ else {
147
+ if ( (state.readable) && (! states[stateExists].readable ) ) {
148
+ states[stateExists].read = state.read;
149
+ // as state is readable, it can't be button or event
150
+ if (states[stateExists].role === 'button') {
151
+ states[stateExists].role = state.role;
152
+ }
153
+ if (states[stateExists].hasOwnProperty('isEvent')) {
154
+ delete states[stateExists].isEvent;
155
+ }
156
+ // we have to use the getter from "new" state
157
+ if ( state.hasOwnProperty('getter') ) {
158
+ states[stateExists].getter = state.getter;
159
+ }
160
+ // trying to remove the `prop` property, as main key for get and set,
161
+ // as it can be different in new and old states, and leave only:
162
+ // setattr for old and id for new
163
+ if (( state.hasOwnProperty('prop') ) && (state.prop === state.id)) {
164
+ if ( states[stateExists].hasOwnProperty('prop') ) {
165
+ if (states[stateExists].prop !== states[stateExists].id) {
166
+ if (! states[stateExists].hasOwnProperty('setattr')) {
167
+ states[stateExists].setattr = states[stateExists].prop;
168
+ }
169
+ }
170
+ delete states[stateExists].prop;
171
+ }
172
+ }
173
+ else if ( state.hasOwnProperty('prop') ) {
174
+ states[stateExists].prop = state.prop;
175
+ }
176
+ states[stateExists].readable = true;
177
+ }
178
+ if ( (state.writable) && (! states[stateExists].writable ) ) {
179
+ states[stateExists].write = state.writable;
180
+ // use new state `setter`
181
+ if ( state.hasOwnProperty('setter') ) {
182
+ states[stateExists].setter = state.setter;
183
+ }
184
+ // use new state `setterOpt`
185
+ if ( state.hasOwnProperty('setterOpt') ) {
186
+ states[stateExists].setterOpt = state.setterOpt;
187
+ }
188
+ // use new state `inOptions`
189
+ if ( state.hasOwnProperty('inOptions') ) {
190
+ states[stateExists].inOptions = state.inOptions;
191
+ }
192
+ // as we have new state, responsible for set, we have to use new `isOption`
193
+ // or remove it
194
+ if (((! state.hasOwnProperty('isOption') ) || (state.isOptions === false))
195
+ && (states[stateExists].hasOwnProperty('isOption'))) {
196
+ delete states[stateExists].isOption;
197
+ }
198
+ else {
199
+ states[stateExists].isOption = state.isOption;
200
+ }
201
+ // use new `setattr` or `prop` as `setattr`
202
+ if ( state.hasOwnProperty('setattr') ) {
203
+ states[stateExists].setattr = state.setattr;
204
+ }
205
+ else if ( state.hasOwnProperty('prop') ) {
206
+ states[stateExists].setattr = state.prop;
207
+ }
208
+ // remove `prop` equal to if, due to prop is uses as key in set and get
209
+ if ( states[stateExists].prop === states[stateExists].id) {
210
+ delete states[stateExists].prop;
211
+ }
212
+ if ( state.hasOwnProperty('epname') ) {
213
+ states[stateExists].epname = state.epname;
214
+ }
215
+ states[stateExists].writable = true;
216
+ }
217
+ return states.length;
218
+ }
219
+ }
220
+ const icon = utils.getDeviceIcon(def);
221
+ for (const expose of def.exposes) {
222
+ let state;
223
+
224
+ switch (expose.type) {
225
+ case 'light':
226
+ for (const prop of expose.features) {
227
+ switch (prop.name) {
228
+ case 'state': {
229
+ const stateNameS = expose.endpoint ? `state_${expose.endpoint}` : 'state';
230
+ pushToStates({
231
+ id: stateNameS,
232
+ name: `Switch state ${expose.endpoint ? expose.endpoint : ''}`.trim(),
233
+ icon: undefined,
234
+ role: 'switch',
235
+ write: true,
236
+ read: true,
237
+ type: 'boolean',
238
+ getter: (payload) => (payload[stateNameS] === (prop.value_on || 'ON')),
239
+ setter: (value) => (value) ? prop.value_on || 'ON' : ((prop.value_off != undefined) ? prop.value_off : 'OFF'),
240
+ epname: expose.endpoint,
241
+ setattr: 'state',
242
+ }, prop.access);
243
+ break;
244
+ }
245
+ case 'brightness': {
246
+ const stateNameB = expose.endpoint ? `brightness_${expose.endpoint}` : 'brightness';
247
+ pushToStates({
248
+ id: stateNameB,
249
+ name: `Brightness ${expose.endpoint ? expose.endpoint : ''}`.trim(),
250
+ icon: undefined,
251
+ role: 'level.dimmer',
252
+ write: true,
253
+ read: true,
254
+ type: 'number',
255
+ min: 0, // ignore expose.value_min
256
+ max: 100, // ignore expose.value_max
257
+ inOptions: true,
258
+ getter: payload => {
259
+ return utils.bulbLevelToAdapterLevel(payload[stateNameB]);
260
+ },
261
+ setter: (value) => {
262
+ return utils.adapterLevelToBulbLevel(value);
263
+ },
264
+ setterOpt: (value, options) => {
265
+ const hasTransitionTime = options && options.hasOwnProperty('transition_time');
266
+ const transitionTime = hasTransitionTime ? options.transition_time : 0;
267
+ const preparedOptions = {...options, transition: transitionTime};
268
+ preparedOptions.brightness = utils.adapterLevelToBulbLevel(value);
269
+ return preparedOptions;
270
+ },
271
+ readResponse: (resp) => {
272
+ const respObj = resp[0];
273
+ if (respObj.status === 0 && respObj.attrData != undefined) {
274
+ return utils.bulbLevelToAdapterLevel(respObj.attrData);
275
+ }
276
+ },
277
+ epname: expose.endpoint,
278
+ setattr: 'brightness',
279
+ }, prop.access);
280
+ pushToStates(statesDefs.brightness_move, prop.access);
281
+ break;
282
+ }
283
+ case 'color_temp': {
284
+ const stateNameT = expose.endpoint ? `colortemp_${expose.endpoint}` : 'colortemp';
285
+ pushToStates({
286
+ id: stateNameT,
287
+ prop: expose.endpoint ? `color_temp_${expose.endpoint}` : 'color_temp',
288
+ name: `Color temperature ${expose.endpoint ? expose.endpoint : ''}`.trim(),
289
+ icon: undefined,
290
+ role: 'level.color.temperature',
291
+ write: true,
292
+ read: true,
293
+ type: 'number',
294
+ min: expose.value_min,
295
+ max: expose.value_max,
296
+ setter: (value) => {
297
+ return utils.toMired(value);
298
+ },
299
+ setterOpt: (value, options) => {
300
+ const hasTransitionTime = options && options.hasOwnProperty('transition_time');
301
+ const transitionTime = hasTransitionTime ? options.transition_time : 0;
302
+ return {...options, transition: transitionTime};
303
+ },
304
+ epname: expose.endpoint,
305
+ setattr: 'color_temp',
306
+ }, prop.access);
307
+ pushToStates(statesDefs.colortemp_move, prop.access);
308
+ break;
309
+ }
310
+ case 'color_xy': {
311
+ const stateNameC = expose.endpoint ? `color_${expose.endpoint}` : 'color';
312
+ pushToStates({
313
+ id: stateNameC,
314
+ prop: expose.endpoint ? `color_${expose.endpoint}` : 'color',
315
+ name: `Color ${expose.endpoint ? expose.endpoint : ''}`.trim(),
316
+ icon: undefined,
317
+ role: 'level.color.rgb',
318
+ write: true,
319
+ read: true,
320
+ type: 'string',
321
+ setter: (value) => {
322
+ // convert RGB to XY for set
323
+ /*
324
+ const result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(value);
325
+ let xy = [0, 0];
326
+ if (result) {
327
+ const r = parseInt(result[1], 16),
328
+ g = parseInt(result[2], 16),
329
+ b = parseInt(result[3], 16);
330
+ xy = rgb.rgb_to_cie(r, g, b);
331
+ }
332
+ return {
333
+ x: xy[0],
334
+ y: xy[1]
335
+ };
336
+ */
337
+ let xy = [0, 0];
338
+ const rgbcolor = colors.ParseColor(value);
339
+
340
+ xy = rgb.rgb_to_cie(rgbcolor.r, rgbcolor.g, rgbcolor.b);
341
+ return {
342
+ x: xy[0],
343
+ y: xy[1]
344
+ };
345
+
346
+ },
347
+ setterOpt: (value, options) => {
348
+ const hasTransitionTime = options && options.hasOwnProperty('transition_time');
349
+ const transitionTime = hasTransitionTime ? options.transition_time : 0;
350
+ return {...options, transition: transitionTime};
351
+ },
352
+ getter: payload => {
353
+ if (payload.color && payload.color.hasOwnProperty('x') && payload.color.hasOwnProperty('y')) {
354
+ const colorval = rgb.cie_to_rgb(payload.color.x, payload.color.y);
355
+ return '#' + utils.decimalToHex(colorval[0]) + utils.decimalToHex(colorval[1]) + utils.decimalToHex(colorval[2]);
356
+ } else {
357
+ return undefined;
358
+ }
359
+ },
360
+ epname: expose.endpoint,
361
+ setattr: 'color',
362
+ }, prop.access);
363
+ break;
364
+ }
365
+ case 'color_hs': {
366
+ const stateNameH = expose.endpoint ? `color_${expose.endpoint}` : 'color';
367
+ pushToStates({
368
+ id: stateNameH,
369
+ prop: expose.endpoint ? `color_${expose.endpoint}` : 'color',
370
+ name: `Color ${expose.endpoint ? expose.endpoint : ''}`.trim(),
371
+ icon: undefined,
372
+ role: 'level.color.rgb',
373
+ write: true,
374
+ read: true,
375
+ type: 'string',
376
+ setter: (value) => {
377
+ const _rgb = colors.ParseColor(value);
378
+ const hsv = rgb.rgbToHSV(_rgb.r, _rgb.g, _rgb.b, true);
379
+ return {
380
+ hue: Math.min(Math.max(hsv.h,1),359),
381
+ saturation: hsv.s,
382
+ // brightness: Math.floor(hsv.v * 2.55),
383
+
384
+ };
385
+ },
386
+ setterOpt: (value, options) => {
387
+ const hasTransitionTime = options && options.hasOwnProperty('transition_time');
388
+ const transitionTime = hasTransitionTime ? options.transition_time : 0;
389
+ return {...options, transition: transitionTime};
390
+ },
391
+ epname: expose.endpoint,
392
+ setattr: 'color',
393
+ }, prop.access);
394
+ pushToStates({
395
+ id: expose.endpoint ? `hue_${expose.endpoint}` : 'hue',
396
+ prop: expose.endpoint ? `color_${expose.endpoint}` : 'color',
397
+ name: `Hue ${expose.endpoint ? expose.endpoint : ''}`.trim(),
398
+ icon: undefined,
399
+ role: 'level.color.hue',
400
+ write: true,
401
+ read: false,
402
+ type: 'number',
403
+ min: 0,
404
+ max: 360,
405
+ inOptions: true,
406
+ setter: (value, options) => {
407
+ return {
408
+ hue: value,
409
+ saturation: options.saturation,
410
+ };
411
+ },
412
+ setterOpt: (value, options) => {
413
+ const hasTransitionTime = options && options.hasOwnProperty('transition_time');
414
+ const transitionTime = hasTransitionTime ? options.transition_time : 0;
415
+ const hasHueCalibrationTable = options && options.hasOwnProperty('hue_calibration');
416
+ if (hasHueCalibrationTable)
417
+ try {
418
+ return {...options, transition: transitionTime, hue_correction: JSON.parse(options.hue_calibration)};
419
+ }
420
+ catch {
421
+ const hue_correction_table = [];
422
+ options.hue_calibration.split(',').forEach(element => {
423
+ const match = /([0-9]+):([0-9]+)/.exec(element);
424
+ if (match && match.length ==3)
425
+ hue_correction_table.push({ in: Number(match[1]), out: Number(match[2])});
426
+ });
427
+ if (hue_correction_table.length > 0)
428
+ return {...options, transition: transitionTime, hue_correction: hue_correction_table};
429
+ }
430
+ return {...options, transition: transitionTime};
431
+ },
432
+
433
+ }, prop.access);
434
+ pushToStates({
435
+ id: expose.endpoint ? `saturation_${expose.endpoint}` : 'saturation',
436
+ prop: expose.endpoint ? `color_${expose.endpoint}` : 'color',
437
+ name: `Saturation ${expose.endpoint ? expose.endpoint : ''}`.trim(),
438
+ icon: undefined,
439
+ role: 'level.color.saturation',
440
+ write: true,
441
+ read: false,
442
+ type: 'number',
443
+ min: 0,
444
+ max: 100,
445
+ inOptions: true,
446
+ setter: (value, options) => {
447
+ return {
448
+ hue: options.hue,
449
+ saturation: value,
450
+ };
451
+ },
452
+ setterOpt: (value, options) => {
453
+ const hasTransitionTime = options && options.hasOwnProperty('transition_time');
454
+ const transitionTime = hasTransitionTime ? options.transition_time : 0;
455
+ const hasHueCalibrationTable = options && options.hasOwnProperty('hue_calibration');
456
+ if (hasHueCalibrationTable)
457
+ try {
458
+ return {...options, transition: transitionTime, hue_correction: JSON.parse(options.hue_calibration)};
459
+ }
460
+ catch {
461
+ const hue_correction_table = [];
462
+ options.hue_calibration.split(',').forEach(element => {
463
+ const match = /([0-9]+):([0-9]+)/.exec(element);
464
+ if (match && match.length ==3)
465
+ hue_correction_table.push({ in: Number(match[1]), out: Number(match[2])});
466
+ });
467
+ if (hue_correction_table.length > 0)
468
+ return {...options, transition: transitionTime, hue_correction: hue_correction_table};
469
+ }
470
+ return {...options, transition: transitionTime};
471
+ },
472
+
473
+ }, prop.access);
474
+ pushToStates(statesDefs.hue_move, prop.access);
475
+ pushToStates(statesDefs.saturation_move, prop.access);
476
+ pushToStates({
477
+ id: 'hue_calibration',
478
+ prop: 'color',
479
+ name: 'Hue color calibration table',
480
+ icon: undefined,
481
+ role: 'table',
482
+ write: true,
483
+ read: false,
484
+ type: 'string',
485
+ inOptions: true,
486
+ setter: (value, options) => {
487
+ return {
488
+ hue: options.hue,
489
+ saturation: options.saturation,
490
+ };
491
+ },
492
+ setterOpt: (value, options) => {
493
+ const hasTransitionTime = options && options.hasOwnProperty('transition_time');
494
+ const transitionTime = hasTransitionTime ? options.transition_time : 0;
495
+ const hasHueCalibrationTable = options && options.hasOwnProperty('hue_calibration');
496
+ if (hasHueCalibrationTable)
497
+ try {
498
+ return {...options, transition: transitionTime, hue_correction: JSON.parse(options.hue_calibration)};
499
+ }
500
+ catch {
501
+ const hue_correction_table = [];
502
+ options.hue_calibration.split(',').forEach(element => {
503
+ const match = /([0-9]+):([0-9]+)/.exec(element);
504
+ if (match && match.length ==3)
505
+ hue_correction_table.push({ in: Number(match[1]), out: Number(match[2])});
506
+ });
507
+ if (hue_correction_table.length > 0)
508
+ return {...options, transition: transitionTime, hue_correction: hue_correction_table};
509
+ }
510
+ return {...options, transition: transitionTime};
511
+ },
512
+
513
+ }, prop.access);
514
+ break;
515
+ }
516
+ default:
517
+ pushToStates(genState(prop), prop.access);
518
+ break;
519
+ }
520
+ }
521
+ pushToStates(statesDefs.transition_time, ea.STATE_SET);
522
+ break;
523
+
524
+ case 'switch':
525
+ for (const prop of expose.features) {
526
+ switch (prop.name) {
527
+ case 'state':
528
+ pushToStates(genState(prop, 'switch'), prop.access);
529
+ break;
530
+ default:
531
+ pushToStates(genState(prop), prop.access);
532
+ break;
533
+ }
534
+ }
535
+ break;
536
+
537
+ case 'numeric':
538
+ if (expose.endpoint) {
539
+ state = genState(expose);
540
+ } else {
541
+ switch (expose.name) {
542
+ case 'linkquality':
543
+ state = undefined;
544
+ break;
545
+
546
+ case 'battery':
547
+ state = statesDefs.battery;
548
+ break;
549
+
550
+ case 'voltage':
551
+ state = statesDefs.plug_voltage;
552
+ break;
553
+
554
+ case 'temperature':
555
+ state = statesDefs.temperature;
556
+ break;
557
+
558
+ case 'humidity':
559
+ state = statesDefs.humidity;
560
+ break;
561
+
562
+ case 'pressure':
563
+ state = statesDefs.pressure;
564
+ break;
565
+
566
+ case 'illuminance':
567
+ state = statesDefs.illuminance_raw;
568
+ break;
569
+
570
+ case 'illuminance_lux':
571
+ state = statesDefs.illuminance;
572
+ break;
573
+
574
+ case 'power':
575
+ state = statesDefs.load_power;
576
+ break;
577
+
578
+ default:
579
+ state = genState(expose);
580
+ break;
581
+ }
582
+ }
583
+ if (state) pushToStates(state, expose.access);
584
+ break;
585
+
586
+ case 'enum':
587
+ switch (expose.name) {
588
+ case 'action': {
589
+
590
+ // Ansatz:
591
+
592
+ // Action aufspalten in 2 Blöcke:
593
+ // Action (bekommt text ausser hold und release, auto reset nach 250 ms)
594
+ // Hold: wird gesetzt bei hold, gelöscht bei passendem Release
595
+
596
+ if (!Array.isArray(expose.values)) break;
597
+ const hasHold = expose.values.find((actionName) => actionName.includes('hold'));
598
+ const hasRelease = expose.values.find((actionName) => actionName.includes('release'));
599
+ for (const actionName of expose.values) {
600
+ // is release state ? - skip
601
+ if (hasHold && hasRelease && actionName.includes('release')) continue;
602
+ // is hold state ?
603
+ if (hasHold && hasRelease && actionName.includes('hold')) {
604
+ const releaseActionName = actionName.replace('hold', 'release');
605
+ state = {
606
+ id: actionName.replace(/\*/g, ''),
607
+ prop: 'action',
608
+ name: actionName,
609
+ icon: undefined,
610
+ role: 'button',
611
+ write: false,
612
+ read: true,
613
+ type: 'boolean',
614
+ getter: payload => (payload.action === actionName) ? true : (payload.action === releaseActionName) ? false : undefined,
615
+ };
616
+ } else {
617
+ state = {
618
+ id: actionName.replace(/\*/g, ''),
619
+ prop: 'action',
620
+ name: actionName,
621
+ icon: undefined,
622
+ role: 'button',
623
+ write: false,
624
+ read: true,
625
+ type: 'boolean',
626
+ getter: payload => (payload.action === actionName) ? true : undefined,
627
+ isEvent: true,
628
+ };
629
+ }
630
+ pushToStates(state, expose.access);
631
+ }
632
+ state = null;
633
+ break;
634
+ }
635
+ default:
636
+ state = genState(expose);
637
+ break;
638
+ }
639
+ if (state) pushToStates(state, expose.access);
640
+ break;
641
+
642
+ case 'binary':
643
+ if (expose.endpoint) {
644
+ state = genState(expose);
645
+ } else {
646
+ switch (expose.name) {
647
+ case 'contact':
648
+ state = statesDefs.contact;
649
+ pushToStates(statesDefs.opened, ea.STATE);
650
+ break;
651
+
652
+ case 'battery_low':
653
+ state = statesDefs.heiman_batt_low;
654
+ break;
655
+
656
+ case 'tamper':
657
+ state = statesDefs.tamper;
658
+ break;
659
+
660
+ case 'water_leak':
661
+ state = statesDefs.water_detected;
662
+ break;
663
+
664
+ case 'lock':
665
+ state = statesDefs.child_lock;
666
+ break;
667
+
668
+ case 'occupancy':
669
+ state = statesDefs.occupancy;
670
+ break;
671
+
672
+ default:
673
+ state = genState(expose);
674
+ break;
675
+ }
676
+ }
677
+ if (state) pushToStates(state, expose.access);
678
+ break;
679
+
680
+ case 'text':
681
+ state = genState(expose);
682
+ pushToStates(state, expose.access);
683
+ break;
684
+
685
+ case 'lock':
686
+ case 'fan':
687
+ case 'cover':
688
+ for (const prop of expose.features) {
689
+ switch (prop.name) {
690
+ case 'state':
691
+ pushToStates(genState(prop, 'switch'), prop.access);
692
+ break;
693
+ default:
694
+ pushToStates(genState(prop), prop.access);
695
+ break;
696
+ }
697
+ }
698
+ break;
699
+
700
+ case 'climate':
701
+ for (const prop of expose.features) {
702
+ switch (prop.name) {
703
+ case 'away_mode':
704
+ pushToStates(statesDefs.climate_away_mode, prop.access);
705
+ break;
706
+ case 'system_mode':
707
+ pushToStates(statesDefs.climate_system_mode, prop.access);
708
+ break;
709
+ case 'running_mode':
710
+ pushToStates(statesDefs.climate_running_mode, prop.access);
711
+ break;
712
+ default:
713
+ pushToStates(genState(prop), prop.access);
714
+ break;
715
+ }
716
+ }
717
+ break;
718
+
719
+ case 'composite':
720
+ for (const prop of expose.features) {
721
+ const st = genState(prop);
722
+ st.prop = expose.property;
723
+ st.inOptions = true;
724
+ // I'm not fully sure, as it really needed, but
725
+ st.setterOpt = (value, options) => {
726
+ const result = {};
727
+ options[prop.property] = value;
728
+ result[expose.property] = options;
729
+ return result;
730
+ };
731
+ // if we have a composite expose, the value have to be an object {expose.property : {prop.property: value}}
732
+ if (prop.access & ea.SET) {
733
+ st.setter = (value, options) => {
734
+ const result = {};
735
+ options[prop.property] = value;
736
+ result[expose.property] = options;
737
+ return result;
738
+ };
739
+ st.setattr = expose.property;
740
+ };
741
+ // if we have a composite expose, the payload will be an object {expose.property : {prop.property: value}}
742
+ if (prop.access & ea.STATE) {
743
+ st.getter = payload => {
744
+ if ( (payload.hasOwnProperty(expose.property)) && (payload[expose.property] !== null) && payload[expose.property].hasOwnProperty(prop.property)) {
745
+ return !isNaN(payload[expose.property][prop.property]) ? payload[expose.property][prop.property] : undefined
746
+ }
747
+ else {
748
+ return undefined;
749
+ }
750
+ };
751
+ }
752
+ else {
753
+ st.getter = payload => { return undefined };
754
+ }
755
+ ;
756
+ pushToStates(st, prop.access);
757
+ }
758
+ break;
759
+ default:
760
+ console.log(`Unhandled expose type ${expose.type} for device ${model}`);
761
+ }
762
+ }
763
+ const newDev = {
764
+ models: [model],
765
+ icon: icon,
766
+ states: states,
767
+ exposed: true,
768
+ };
769
+ // make the function code printable in log
770
+ //console.log(`Created mapping for device ${model}: ${JSON.stringify(newDev, function(key, value) {
771
+ // if (typeof value === 'function') {return value.toString() } else { return value } }, ' ')}`);
772
+ return newDev;
773
+ }
774
+
775
+ function applyExposes(mappedDevices, byModel, allExcludesObj) {
776
+ // for exlude search
777
+ const allExcludesStr = JSON.stringify(allExcludesObj);
778
+ // create or update device from exposes
779
+ for (const deviceDef of zigbeeHerdsmanConverters.definitions) {
780
+ const strippedModel = (deviceDef.model) ? deviceDef.model.replace(/\0.*$/g, '').trim() : '';
781
+ // check if device is mapped
782
+ const existsMap = byModel.get(strippedModel);
783
+
784
+ if ((deviceDef.hasOwnProperty('exposes') && (!existsMap || !existsMap.hasOwnProperty('states'))) || allExcludesStr.indexOf(strippedModel) > 0) {
785
+ try {
786
+ const newDevice = createFromExposes(strippedModel, deviceDef);
787
+ if (!existsMap) {
788
+ mappedDevices.push(newDevice);
789
+ byModel.set(strippedModel, newDevice);
790
+ } else {
791
+ existsMap.states = newDevice.states;
792
+ existsMap.exposed = true;
793
+ }
794
+ } catch (e) {
795
+ console.log(`Wrong expose devicedefinition ${deviceDef.vendor} ${deviceDef.model}` );
796
+ }
797
+ }
798
+ }
799
+ }
800
+
801
+ module.exports = {
802
+ applyExposes: applyExposes,
803
+ };