Skip to content

Commit 93ac54e

Browse files
mrjackyliangmrjackyliang
committed
Gateway and panel documentation
### UPDATED - Document device gateways will no longer track "Broadband Connection Status", "Cellular Connection Status", and "Cellular Signal Strength" due to unnecessary frequent updates. - Document security panels will no longer track "Emergency Keys" due to unnecessary frequent updates. v3.2.10
1 parent 66e84c5 commit 93ac54e

File tree

4 files changed

+14
-220
lines changed

4 files changed

+14
-220
lines changed

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "homebridge-adt-pulse",
33
"displayName": "Homebridge ADT Pulse",
4-
"version": "3.2.9",
4+
"version": "3.2.10",
55
"description": "Homebridge security system platform for ADT Pulse",
66
"main": "./build/index.js",
77
"exports": "./build/index.js",

‎src/lib/items.ts

Lines changed: 13 additions & 203 deletions
Original file line numberDiff line numberDiff line change
@@ -352,11 +352,8 @@ export const collectionSensorActions: CollectionSensorActions = [
352352
*/
353353
export const deviceGateways: DeviceGateways = [
354354
{
355-
description: 'ADT Pulse Gateway iHub-3001 / HW 3.4 / BL 1.3 / Broadband Active',
355+
description: 'ADT Pulse Gateway iHub-3001 / HW 3.4 / BL 1.3 / Broadband',
356356
gateway: {
357-
broadbandConnectionStatus: 'Active',
358-
cellularConnectionStatus: 'N/A',
359-
cellularSignalStrength: 'N/A',
360357
firmwareVersion: '24.0.0-9',
361358
hardwareVersion: 'HW=3.4, BL=ICONTROL_CFE 1.3, PL=24.0.0-9, SKU=0YUC0500MY5',
362359
manufacturer: 'ADT Pulse Gateway',
@@ -365,37 +362,8 @@ export const deviceGateways: DeviceGateways = [
365362
},
366363
},
367364
{
368-
description: 'ADT Pulse Gateway iHub-3001 / HW 3.4 / BL 1.3 / Broadband Unavailable',
365+
description: 'ADT Pulse Gateway iHub-3001 / HW 3.4 / BL 1.4 / Broadband',
369366
gateway: {
370-
broadbandConnectionStatus: 'Unavailable',
371-
cellularConnectionStatus: 'N/A',
372-
cellularSignalStrength: 'N/A',
373-
firmwareVersion: '24.0.0-9',
374-
hardwareVersion: 'HW=3.4, BL=ICONTROL_CFE 1.3, PL=24.0.0-9, SKU=0YUC0500MY5',
375-
manufacturer: 'ADT Pulse Gateway',
376-
model: 'iHub-3001',
377-
primaryConnectionType: 'Broadband',
378-
},
379-
},
380-
{
381-
description: 'ADT Pulse Gateway iHub-3001 / HW 3.4 / BL 1.4 / Broadband Active',
382-
gateway: {
383-
broadbandConnectionStatus: 'Active',
384-
cellularConnectionStatus: 'N/A',
385-
cellularSignalStrength: 'N/A',
386-
firmwareVersion: '24.0.0-9',
387-
hardwareVersion: 'HW=3.4, BL=ICONTROL_CFE 1.4, PL=24.0.0-9, SKU=0YUC0500MY5',
388-
manufacturer: 'ADT Pulse Gateway',
389-
model: 'iHub-3001',
390-
primaryConnectionType: 'Broadband',
391-
},
392-
},
393-
{
394-
description: 'ADT Pulse Gateway iHub-3001 / HW 3.4 / BL 1.4 / Broadband Unavailable',
395-
gateway: {
396-
broadbandConnectionStatus: 'Unavailable',
397-
cellularConnectionStatus: 'N/A',
398-
cellularSignalStrength: 'N/A',
399367
firmwareVersion: '24.0.0-9',
400368
hardwareVersion: 'HW=3.4, BL=ICONTROL_CFE 1.4, PL=24.0.0-9, SKU=0YUC0500MY5',
401369
manufacturer: 'ADT Pulse Gateway',
@@ -404,24 +372,8 @@ export const deviceGateways: DeviceGateways = [
404372
},
405373
},
406374
{
407-
description: 'ADT Pulse Gateway PGZNG1 / HW 1 / Broadband Active',
408-
gateway: {
409-
broadbandConnectionStatus: 'Active',
410-
cellularConnectionStatus: 'N/A',
411-
cellularSignalStrength: 'N/A',
412-
firmwareVersion: '24.0.0-9',
413-
hardwareVersion: 'HW=1, BL=1.1.9, PL=9.4.0.32.5, SKU=PGZNG1-1ADNAS',
414-
manufacturer: 'ADT Pulse Gateway',
415-
model: 'PGZNG1',
416-
primaryConnectionType: 'Broadband',
417-
},
418-
},
419-
{
420-
description: 'ADT Pulse Gateway PGZNG1 / HW 1 / Broadband Unavailable',
375+
description: 'ADT Pulse Gateway PGZNG1 / HW 1 / Broadband',
421376
gateway: {
422-
broadbandConnectionStatus: 'Unavailable',
423-
cellularConnectionStatus: 'N/A',
424-
cellularSignalStrength: 'N/A',
425377
firmwareVersion: '24.0.0-9',
426378
hardwareVersion: 'HW=1, BL=1.1.9, PL=9.4.0.32.5, SKU=PGZNG1-1ADNAS',
427379
manufacturer: 'ADT Pulse Gateway',
@@ -430,24 +382,8 @@ export const deviceGateways: DeviceGateways = [
430382
},
431383
},
432384
{
433-
description: 'ADT Pulse Gateway PGZNG1 / HW 2 / Broadband Active',
434-
gateway: {
435-
broadbandConnectionStatus: 'Active',
436-
cellularConnectionStatus: 'N/A',
437-
cellularSignalStrength: 'N/A',
438-
firmwareVersion: '24.0.0-9',
439-
hardwareVersion: 'HW=2, BL=1.1.9, PL=9.4.0.32.5, SKU=PGZNG1-1ADNAS',
440-
manufacturer: 'ADT Pulse Gateway',
441-
model: 'PGZNG1',
442-
primaryConnectionType: 'Broadband',
443-
},
444-
},
445-
{
446-
description: 'ADT Pulse Gateway PGZNG1 / HW 2 / Broadband Unavailable',
385+
description: 'ADT Pulse Gateway PGZNG1 / HW 2 / Broadband',
447386
gateway: {
448-
broadbandConnectionStatus: 'Unavailable',
449-
cellularConnectionStatus: 'N/A',
450-
cellularSignalStrength: 'N/A',
451387
firmwareVersion: '24.0.0-9',
452388
hardwareVersion: 'HW=2, BL=1.1.9, PL=9.4.0.32.5, SKU=PGZNG1-1ADNAS',
453389
manufacturer: 'ADT Pulse Gateway',
@@ -456,24 +392,8 @@ export const deviceGateways: DeviceGateways = [
456392
},
457393
},
458394
{
459-
description: 'ADT TSSC Lifestyle Module / HW 1 / Broadband Active',
460-
gateway: {
461-
broadbandConnectionStatus: 'Active',
462-
cellularConnectionStatus: 'N/A',
463-
cellularSignalStrength: 'N/A',
464-
firmwareVersion: '24.0.0-9',
465-
hardwareVersion: 'HW=0001, BL=UBOOT 2009.08-svn99, PL=5.5.0-5, SKU=TSSC-NA-NONE-01',
466-
manufacturer: 'ADT',
467-
model: 'TSSC Lifestyle Module',
468-
primaryConnectionType: 'Broadband',
469-
},
470-
},
471-
{
472-
description: 'ADT TSSC Lifestyle Module / HW 1 / Broadband Unavailable',
395+
description: 'ADT TSSC Lifestyle Module / HW 1 / Broadband',
473396
gateway: {
474-
broadbandConnectionStatus: 'Unavailable',
475-
cellularConnectionStatus: 'N/A',
476-
cellularSignalStrength: 'N/A',
477397
firmwareVersion: '24.0.0-9',
478398
hardwareVersion: 'HW=0001, BL=UBOOT 2009.08-svn99, PL=5.5.0-5, SKU=TSSC-NA-NONE-01',
479399
manufacturer: 'ADT',
@@ -482,24 +402,8 @@ export const deviceGateways: DeviceGateways = [
482402
},
483403
},
484404
{
485-
description: 'ADT TSSC Lifestyle Module / HW 2 / Broadband Active',
486-
gateway: {
487-
broadbandConnectionStatus: 'Active',
488-
cellularConnectionStatus: 'N/A',
489-
cellularSignalStrength: 'N/A',
490-
firmwareVersion: '24.0.0-9',
491-
hardwareVersion: 'HW=0002, BL=UBOOT 2009.08-svn99, PL=5.5.0-5, SKU=TSSC-NA-NONE-01',
492-
manufacturer: 'ADT',
493-
model: 'TSSC Lifestyle Module',
494-
primaryConnectionType: 'Broadband',
495-
},
496-
},
497-
{
498-
description: 'ADT TSSC Lifestyle Module / HW 2 / Broadband Unavailable',
405+
description: 'ADT TSSC Lifestyle Module / HW 2 / Broadband',
499406
gateway: {
500-
broadbandConnectionStatus: 'Unavailable',
501-
cellularConnectionStatus: 'N/A',
502-
cellularSignalStrength: 'N/A',
503407
firmwareVersion: '24.0.0-9',
504408
hardwareVersion: 'HW=0002, BL=UBOOT 2009.08-svn99, PL=5.5.0-5, SKU=TSSC-NA-NONE-01',
505409
manufacturer: 'ADT',
@@ -508,11 +412,8 @@ export const deviceGateways: DeviceGateways = [
508412
},
509413
},
510414
{
511-
description: 'Compact SMA Protocol Gateway / HW 2 / Broadband Active',
415+
description: 'Compact SMA Protocol Gateway / HW 2 / Broadband',
512416
gateway: {
513-
broadbandConnectionStatus: 'Active',
514-
cellularConnectionStatus: 'N/A',
515-
cellularSignalStrength: 'N/A',
516417
firmwareVersion: '27.0.0-140',
517418
hardwareVersion: 'HW=02_CSMAP, BL=NA, PL=27.0.0-140',
518419
manufacturer: null,
@@ -521,63 +422,18 @@ export const deviceGateways: DeviceGateways = [
521422
},
522423
},
523424
{
524-
description: 'Compact SMA Protocol Gateway / HW 2 / Broadband Unavailable',
425+
description: 'Compact SMA Protocol Gateway / HW 2 / Cellular',
525426
gateway: {
526-
broadbandConnectionStatus: 'Unavailable',
527-
cellularConnectionStatus: 'N/A',
528-
cellularSignalStrength: 'N/A',
529427
firmwareVersion: '27.0.0-140',
530428
hardwareVersion: 'HW=02_CSMAP, BL=NA, PL=27.0.0-140',
531429
manufacturer: null,
532430
model: 'Compact SMA Protocol Gateway',
533-
primaryConnectionType: 'Broadband',
534-
},
535-
},
536-
{
537-
description: 'Compact SMA Protocol Gateway / HW 2 / Cellular Active',
538-
gateway: {
539-
broadbandConnectionStatus: null,
540-
cellularConnectionStatus: 'Active',
541-
cellularSignalStrength: 'N/A',
542-
firmwareVersion: '27.0.0-140',
543-
hardwareVersion: 'HW=02_CSMAP, BL=NA, PL=27.0.0-140',
544-
manufacturer: null,
545-
model: 'Compact SMA Protocol Gateway',
546-
primaryConnectionType: 'Cellular',
547-
},
548-
},
549-
{
550-
description: 'Compact SMA Protocol Gateway / HW 2 / Cellular Unavailable',
551-
gateway: {
552-
broadbandConnectionStatus: null,
553-
cellularConnectionStatus: 'Unavailable',
554-
cellularSignalStrength: 'N/A',
555-
firmwareVersion: '27.0.0-140',
556-
hardwareVersion: 'HW=02_CSMAP, BL=NA, PL=27.0.0-140',
557-
manufacturer: null,
558-
model: 'Compact SMA Protocol Gateway',
559-
primaryConnectionType: 'Cellular',
560-
},
561-
},
562-
{
563-
description: 'Lynx/QuickConnect Cellular-Only Gateway / HW 2 / Cellular Active',
564-
gateway: {
565-
broadbandConnectionStatus: null,
566-
cellularConnectionStatus: 'Active',
567-
cellularSignalStrength: 'N/A',
568-
firmwareVersion: '27.0.0-140',
569-
hardwareVersion: 'HW=02_Lynx, BL=ICONTROL_CFE 1.0, PL=27.0.0-140',
570-
manufacturer: null,
571-
model: 'Lynx/QuickConnect Cellular-Only Gateway',
572431
primaryConnectionType: 'Cellular',
573432
},
574433
},
575434
{
576-
description: 'Lynx/QuickConnect Cellular-Only Gateway / HW 2 / Cellular Unavailable',
435+
description: 'Lynx/QuickConnect Cellular-Only Gateway / HW 2 / Cellular',
577436
gateway: {
578-
broadbandConnectionStatus: null,
579-
cellularConnectionStatus: 'Unavailable',
580-
cellularSignalStrength: 'N/A',
581437
firmwareVersion: '27.0.0-140',
582438
hardwareVersion: 'HW=02_Lynx, BL=ICONTROL_CFE 1.0, PL=27.0.0-140',
583439
manufacturer: null,
@@ -594,89 +450,43 @@ export const deviceGateways: DeviceGateways = [
594450
*/
595451
export const deviceSecurityPanels: DeviceSecurityPanels = [
596452
{
597-
description: 'ADT Safewatch Pro 3000/3000CN - Emergency Keys FA 95/APA 99',
453+
description: 'ADT Safewatch Pro 3000/3000CN',
598454
panel: {
599-
emergencyKeys: 'Button: Fire Alarm (Zone 95) Button: Audible Panic Alarm (Zone 99)',
600455
manufacturerProvider: 'ADT',
601456
typeModel: 'Security Panel - Safewatch Pro 3000/3000CN',
602457
},
603458
},
604459
{
605-
description: 'ADT Safewatch Pro 3000/3000CN - Emergency Keys FA 95/PE 96/APA 99',
460+
description: 'ADT TSSC Life Safety Module',
606461
panel: {
607-
emergencyKeys: 'Button: Fire Alarm (Zone 95) Button: Personal Emergency (Zone 96) Button: Audible Panic Alarm (Zone 99)',
608-
manufacturerProvider: 'ADT',
609-
typeModel: 'Security Panel - Safewatch Pro 3000/3000CN',
610-
},
611-
},
612-
{
613-
description: 'ADT TSSC Life Safety Module - Emergency Keys FA 95/APA 99',
614-
panel: {
615-
emergencyKeys: 'Button: Fire Alarm (Zone 995) Button: Audible Panic Alarm (Zone 999)',
616-
manufacturerProvider: 'ADT',
617-
typeModel: 'TSSC Life Safety Module',
618-
},
619-
},
620-
{
621-
description: 'ADT TSSC Life Safety Module - Emergency Keys FA 95/PE 96/APA 99',
622-
panel: {
623-
emergencyKeys: 'Button: Fire Alarm (Zone 995) Button: Personal Emergency (Zone 996) Button: Audible Panic Alarm (Zone 999)',
624462
manufacturerProvider: 'ADT',
625463
typeModel: 'TSSC Life Safety Module',
626464
},
627465
},
628466
{
629-
description: 'Ademco LYNX/ADT QuickConnect - Emergency Keys FA 95/APA 99',
630-
panel: {
631-
emergencyKeys: 'Button: Fire Alarm (Zone 95) Button: Audible Panic Alarm (Zone 99)',
632-
manufacturerProvider: null,
633-
typeModel: 'Security Panel - LYNX/QuickConnect',
634-
},
635-
},
636-
{
637-
description: 'Ademco LYNX/ADT QuickConnect - Emergency Keys FA 95/PE 96/PE 99',
638-
panel: {
639-
emergencyKeys: 'Button: Fire Alarm (Zone 95) Button: Personal Emergency (Zone 96) Button: Personal Emergency (Zone 99)',
640-
manufacturerProvider: null,
641-
typeModel: 'Security Panel - LYNX/QuickConnect',
642-
},
643-
},
644-
{
645-
description: 'Ademco LYNX/ADT QuickConnect - Emergency Keys FA 95/PE 96/APA 99',
646-
panel: {
647-
emergencyKeys: 'Button: Fire Alarm (Zone 95) Button: Personal Emergency (Zone 96) Button: Audible Panic Alarm (Zone 99)',
648-
manufacturerProvider: null,
649-
typeModel: 'Security Panel - LYNX/QuickConnect',
650-
},
651-
},
652-
{
653-
description: 'Ademco LYNX/ADT QuickConnect - Emergency Keys PE 95/FA 96/APA 99',
467+
description: 'Ademco LYNX/ADT QuickConnect',
654468
panel: {
655-
emergencyKeys: 'Button: Personal Emergency (Zone 95) Button: Fire Alarm (Zone 96) Button: Audible Panic Alarm (Zone 99)',
656469
manufacturerProvider: null,
657470
typeModel: 'Security Panel - LYNX/QuickConnect',
658471
},
659472
},
660473
{
661474
description: 'DSC Impassa SCW9057',
662475
panel: {
663-
emergencyKeys: null,
664476
manufacturerProvider: 'DSC',
665477
typeModel: 'Security Panel - Impassa SCW9057',
666478
},
667479
},
668480
{
669481
description: 'GE Security Concord 4',
670482
panel: {
671-
emergencyKeys: null,
672483
manufacturerProvider: 'GE Security',
673484
typeModel: 'Security Panel - Concord 4',
674485
},
675486
},
676487
{
677-
description: 'Honeywell Security Vista-20PSIA - Emergency Keys PE 95/FA 96/APA 99',
488+
description: 'Honeywell Security Vista-20PSIA',
678489
panel: {
679-
emergencyKeys: 'Button: Personal Emergency (Zone 95) Button: Fire Alarm (Zone 96) Button: Audible Panic Alarm (Zone 99)',
680490
manufacturerProvider: 'Honeywell Security',
681491
typeModel: 'Security Panel - Vista-20PSIA',
682492
},

‎src/lib/utility.ts

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1101,9 +1101,6 @@ export function isUnknownDoSubmitHandlerCollection(handlers: IsUnknownDoSubmitHa
11011101
*/
11021102
export function isUnknownGatewayDevice(gateway: IsUnknownGatewayDeviceGateway): IsUnknownGatewayDeviceReturns {
11031103
const currentGateway = {
1104-
broadbandConnectionStatus: _.get(gateway, ['Broadband Connection Status:', 0], null),
1105-
cellularConnectionStatus: _.get(gateway, ['Cellular Connection Status:', 0], null),
1106-
cellularSignalStrength: _.get(gateway, ['Cellular Signal Strength:', 0], null),
11071104
firmwareVersion: _.get(gateway, ['Firmware Version:', 0], null),
11081105
hardwareVersion: _.get(gateway, ['Hardware Version:', 0], null),
11091106
manufacturer: _.get(gateway, ['Manufacturer:', 0], null),
@@ -1148,7 +1145,6 @@ export function isUnknownOrbSecurityButtonCollection(buttons: IsUnknownOrbSecuri
11481145
*/
11491146
export function isUnknownPanelDevice(panel: IsUnknownPanelDevicePanel): IsUnknownPanelDeviceReturns {
11501147
const currentPanel = {
1151-
emergencyKeys: _.get(panel, ['Emergency Keys:', 0], null),
11521148
manufacturerProvider: _.get(panel, ['Manufacturer/Provider:', 0], null),
11531149
typeModel: _.get(panel, ['Type/Model:', 0], null),
11541150
};

‎src/types/index.d.ts

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1413,12 +1413,6 @@ export type DetectPlatformUnknownSensorsActionReturns = Promise<boolean>;
14131413
*/
14141414
export type DeviceGatewayDescription = string;
14151415

1416-
export type DeviceGatewayGatewayBroadbandConnectionStatus = string | null;
1417-
1418-
export type DeviceGatewayGatewayCellularConnectionStatus = string | null;
1419-
1420-
export type DeviceGatewayGatewayCellularSignalStrength = string | null;
1421-
14221416
export type DeviceGatewayGatewayFirmwareVersion = string | null;
14231417

14241418
export type DeviceGatewayGatewayHardwareVersion = string | null;
@@ -1430,9 +1424,6 @@ export type DeviceGatewayGatewayModel = string | null;
14301424
export type DeviceGatewayGatewayPrimaryConnectionType = string | null;
14311425

14321426
export type DeviceGatewayGateway = {
1433-
broadbandConnectionStatus: DeviceGatewayGatewayBroadbandConnectionStatus;
1434-
cellularConnectionStatus: DeviceGatewayGatewayCellularConnectionStatus;
1435-
cellularSignalStrength: DeviceGatewayGatewayCellularSignalStrength;
14361427
firmwareVersion: DeviceGatewayGatewayFirmwareVersion;
14371428
hardwareVersion: DeviceGatewayGatewayHardwareVersion;
14381429
manufacturer: DeviceGatewayGatewayManufacturer;
@@ -1454,14 +1445,11 @@ export type DeviceGateways = DeviceGateway[];
14541445
*/
14551446
export type DeviceSecurityPanelDescription = string;
14561447

1457-
export type DeviceSecurityPanelPanelEmergencyKeys = string | null;
1458-
14591448
export type DeviceSecurityPanelPanelManufacturerProvider = string | null;
14601449

14611450
export type DeviceSecurityPanelPanelTypeModel = string | null;
14621451

14631452
export type DeviceSecurityPanelPanel = {
1464-
emergencyKeys: DeviceSecurityPanelPanelEmergencyKeys;
14651453
manufacturerProvider: DeviceSecurityPanelPanelManufacturerProvider;
14661454
typeModel: DeviceSecurityPanelPanelTypeModel;
14671455
};

0 commit comments

Comments
 (0)