homebridge-securitysystem 7.2.1-beta.3 → 7.3.0

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 (6) hide show
  1. package/.github/workflows/update-version.yml +1 -1
  2. package/README.md +1 -3
  3. package/config.schema.json +58 -11
  4. package/package.json +1 -1
  5. package/src/index.js +2 -5
  6. package/src/utils/options.js +0 -5
package/.github/workflows/update-version.yml CHANGED
@@ -41,7 +41,7 @@ jobs:
41
41
  version: ${{ steps.generate-tag-name.outputs.tag-name }}
42
42
 
43
43
  - name: Create pull request
44
- uses: peter-evans/create-pull-request@v4
44
+ uses: peter-evans/create-pull-request@v5
45
45
  with:
46
46
  branch: version/${{ steps.generate-tag-name.outputs.tag-name }}
47
47
  commit-message: ${{ steps.generate-tag-name.outputs.tag-name }}
package/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  Homebridge plugin that creates a security system accessory that can be triggered by HomeKit sensors.
8
8
 
9
- [❤️ One-time donation](https://paypal.me/miguelripoll23)
9
+ [❤️ One-time donation](https://www.paypal.com/donate/?hosted_button_id=CQTHU44XTXK2L)
10
10
 
11
11
  ## Installation
12
12
 
@@ -14,8 +14,6 @@ If you already have [Homebridge](https://github.com/homebridge/homebridge) insta
14
14
 
15
15
  `npm i -g --unsafe-perm homebridge-securitysystem`
16
16
 
17
- During accessory setup, when asked the name of the accessories tap the close button on the upper right to exit setup and use the accessory names provided by the plugin.
18
-
19
17
  ## Demo
20
18
 
21
19
  <div align="left">
package/config.schema.json CHANGED
@@ -2,25 +2,28 @@
2
2
  "pluginAlias": "security-system",
3
3
  "pluginType": "accessory",
4
4
  "headerDisplay": "Create a security system accessory that can be triggered by HomeKit sensors.",
5
- "footerDisplay": "[Need help?](https://github.com/MiguelRipoll23/homebridge-securitysystem/issues) | [Donate](https://paypal.me/miguelripoll23)",
5
+ "footerDisplay": "[Need help?](https://github.com/MiguelRipoll23/homebridge-securitysystem/issues) | [Donate](https://www.paypal.com/donate/?hosted_button_id=CQTHU44XTXK2L)",
6
6
  "schema": {
7
7
  "title": "Security System",
8
8
  "type": "object",
9
9
  "properties": {
10
10
  "name": {
11
11
  "title": "Name",
12
+ "description": "",
12
13
  "type": "string",
13
14
  "default": "Security System",
14
15
  "required": true
15
16
  },
16
17
  "serial_number": {
17
18
  "title": "Serial Number",
19
+ "description": "",
18
20
  "type": "string",
19
21
  "default": "S3CUR1TYSYST3M",
20
22
  "required": true
21
23
  },
22
24
  "default_mode": {
23
25
  "title": "Default Mode",
26
+ "description": "",
24
27
  "type": "string",
25
28
  "default": "Off",
26
29
  "required": true,
@@ -28,6 +31,7 @@
28
31
  },
29
32
  "arm_seconds": {
30
33
  "title": "Arming Delay Seconds",
34
+ "description": "",
31
35
  "type": "integer",
32
36
  "default": 0,
33
37
  "required": false,
@@ -35,6 +39,7 @@
35
39
  },
36
40
  "trigger_seconds": {
37
41
  "title": "Trigger Delay Seconds",
42
+ "description": "",
38
43
  "type": "integer",
39
44
  "default": 0,
40
45
  "required": false,
@@ -42,6 +47,7 @@
42
47
  },
43
48
  "reset_minutes": {
44
49
  "title": "Reset Delay Minutes",
50
+ "description": "",
45
51
  "type": "integer",
46
52
  "default": 10,
47
53
  "required": false,
@@ -68,86 +74,93 @@
68
74
  "default": false,
69
75
  "required": false
70
76
  },
71
- "security_system_name": {
72
- "title": "Security System Name",
73
- "type": "string",
74
- "default": "Security System",
75
- "required": false
76
- },
77
77
  "trip_switch_name": {
78
78
  "title": "Trip Switch Name",
79
+ "description": "",
79
80
  "type": "string",
80
81
  "default": "Trip",
81
82
  "required": false
82
83
  },
83
84
  "trip_home_switch_name": {
84
85
  "title": "Trip Home Switch Name",
86
+ "description": "",
85
87
  "type": "string",
86
88
  "default": "Trip Home",
87
89
  "required": false
88
90
  },
89
91
  "trip_away_switch_name": {
90
92
  "title": "Trip Away Switch Name",
93
+ "description": "",
91
94
  "type": "string",
92
95
  "default": "Trip Away",
93
96
  "required": false
94
97
  },
95
98
  "trip_night_switch_name": {
96
99
  "title": "Trip Night Switch Name",
100
+ "description": "",
97
101
  "type": "string",
98
102
  "default": "Trip Night",
99
103
  "required": false
100
104
  },
101
105
  "trip_override_switch_name": {
102
106
  "title": "Trip Override Switch Name",
107
+ "description": "",
103
108
  "type": "string",
104
109
  "default": "Trip Override",
105
110
  "required": false
106
111
  },
107
112
  "log_directory": {
108
113
  "title": "Log Directory Path",
114
+ "description": "",
109
115
  "type": "string",
110
116
  "required": false,
111
117
  "placeholder": "/home/user/logs"
112
118
  },
113
119
  "home_arm_seconds": {
114
120
  "title": "Home Arming Delay Seconds",
121
+ "description": "",
115
122
  "type": "integer",
116
123
  "required": false,
117
124
  "minimum": 0
118
125
  },
119
126
  "night_arm_seconds": {
120
127
  "title": "Night Arming Delay Seconds",
128
+ "description": "",
121
129
  "type": "integer",
122
130
  "required": false,
123
131
  "minimum": 0
124
132
  },
125
133
  "away_arm_seconds": {
126
134
  "title": "Away Arming Delay Seconds",
135
+ "description": "",
127
136
  "type": "integer",
128
137
  "required": false,
129
138
  "minimum": 0
130
139
  },
131
140
  "home_trigger_seconds": {
132
141
  "title": "Home Trigger Delay Seconds",
142
+ "description": "",
133
143
  "type": "integer",
134
144
  "required": false,
135
145
  "minimum": 0
136
146
  },
137
147
  "night_trigger_seconds": {
138
148
  "title": "Night Trigger Delay Seconds",
149
+ "description": "",
139
150
  "type": "integer",
140
151
  "required": false,
141
152
  "minimum": 0
142
153
  },
143
154
  "away_trigger_seconds": {
144
155
  "title": "Away Trigger Delay Seconds",
156
+ "description": "",
145
157
  "type": "integer",
146
158
  "required": false,
147
159
  "minimum": 0
148
160
  },
149
161
  "away_extended_trigger_seconds": {
150
162
  "title": "Away Extended Delay Trigger Seconds",
163
+ "description": "",
151
164
  "type": "integer",
152
165
  "required": false,
153
166
  "minimum": 0
@@ -175,6 +188,7 @@
175
188
  },
176
189
  "double_knock_seconds": {
177
190
  "title": "Time Window Seconds",
191
+ "description": "",
178
192
  "type": "integer",
179
193
  "default": 90,
180
194
  "required": false,
@@ -182,24 +196,28 @@
182
196
  },
183
197
  "home_double_knock_seconds": {
184
198
  "title": "Home Double-Knock Seconds",
199
+ "description": "",
185
200
  "type": "integer",
186
201
  "required": false,
187
202
  "minimum": 0
188
203
  },
189
204
  "away_double_knock_seconds": {
190
205
  "title": "Away Double-Knock Seconds",
206
+ "description": "",
191
207
  "type": "integer",
192
208
  "required": false,
193
209
  "minimum": 0
194
210
  },
195
211
  "night_double_knock_seconds": {
196
212
  "title": "Night Double-Knock Seconds",
213
+ "description": "",
197
214
  "type": "integer",
198
215
  "required": false,
199
216
  "minimum": 0
200
217
  },
201
218
  "double_knock_modes": {
202
219
  "title": "Double-Knock Modes",
220
+ "description": "",
203
221
  "type": "array",
204
222
  "default": ["Away"],
205
223
  "required": false,
@@ -212,6 +230,7 @@
212
230
  },
213
231
  "disabled_modes": {
214
232
  "title": "Disabled Modes",
233
+ "description": "",
215
234
  "type": "array",
216
235
  "required": false,
217
236
  "items": {
@@ -230,6 +249,7 @@
230
249
  },
231
250
  "tripped_sensor_seconds": {
232
251
  "title": "Tripped Sensor Seconds",
252
+ "description": "",
233
253
  "type": "integer",
234
254
  "default": 5,
235
255
  "required": false,
@@ -244,6 +264,7 @@
244
264
  },
245
265
  "siren_sensor_seconds": {
246
266
  "title": "Triggered Sensor Seconds",
267
+ "description": "",
247
268
  "type": "integer",
248
269
  "default": 5,
249
270
  "required": false,
@@ -286,6 +307,7 @@
286
307
  },
287
308
  "pause_minutes": {
288
309
  "title": "Pause Minutes",
310
+ "description": "",
289
311
  "type": "integer",
290
312
  "default": 0,
291
313
  "required": false,
@@ -342,6 +364,7 @@
342
364
  },
343
365
  "audio_language": {
344
366
  "title": "Audio Language",
367
+ "description": "",
345
368
  "type": "string",
346
369
  "default": "en-US",
347
370
  "required": false,
@@ -349,6 +372,7 @@
349
372
  },
350
373
  "audio_extra_variables": {
351
374
  "title": "Audio Extra Variables",
375
+ "description": "Add extra environment variables to the ffplay command that will be executed",
352
376
  "type": "array",
353
377
  "items": {
354
378
  "title": "Environment Variable",
@@ -366,8 +390,7 @@
366
390
  }
367
391
  }
368
392
  },
369
- "required": true,
370
- "description": "Add extra environment variables to the ffplay command that will be executed"
393
+ "required": true
371
394
  },
372
395
  "audio_path": {
373
396
  "title": "Custom Audio Path",
@@ -378,6 +401,7 @@
378
401
  },
379
402
  "audio_volume": {
380
403
  "title": "Audio Volume",
404
+ "description": "",
381
405
  "type": "string",
382
406
  "required": false,
383
407
  "default": 100,
@@ -385,18 +409,21 @@
385
409
  },
386
410
  "audio_arming_looped": {
387
411
  "title": "Loop Arming Sound",
412
+ "description": "",
388
413
  "type": "boolean",
389
414
  "default": false,
390
415
  "required": false
391
416
  },
392
417
  "audio_alert_looped": {
393
- "title": "Loop Warning Sound",
418
+ "title": "Loop Tripped Sound",
419
+ "description": "",
394
420
  "type": "boolean",
395
421
  "default": false,
396
422
  "required": false
397
423
  },
398
424
  "server_port": {
399
425
  "title": "Listening Port",
426
+ "description": "",
400
427
  "type": "integer",
401
428
  "required": false,
402
429
  "minimum": 0,
@@ -412,6 +439,7 @@
412
439
  },
413
440
  "webhook_url": {
414
441
  "title": "Base URL",
442
+ "description": "",
415
443
  "type": "string",
416
444
  "required": false,
417
445
  "format": "uri",
@@ -419,120 +447,140 @@
419
447
  },
420
448
  "webhook_target_home": {
421
449
  "title": "Target Mode: Home",
450
+ "description": "",
422
451
  "type": "string",
423
452
  "required": false,
424
453
  "placeholder": "/target/home"
425
454
  },
426
455
  "webhook_target_away": {
427
456
  "title": "Target Mode: Away",
457
+ "description": "",
428
458
  "type": "string",
429
459
  "required": false,
430
460
  "placeholder": "/target/away"
431
461
  },
432
462
  "webhook_target_night": {
433
463
  "title": "Target Mode: Night",
464
+ "description": "",
434
465
  "type": "string",
435
466
  "required": false,
436
467
  "placeholder": "/target/night"
437
468
  },
438
469
  "webhook_target_off": {
439
470
  "title": "Target Mode: Off",
471
+ "description": "",
440
472
  "type": "string",
441
473
  "required": false,
442
474
  "placeholder": "/target/off"
443
475
  },
444
476
  "webhook_current_home": {
445
477
  "title": "Current Mode: Home",
478
+ "description": "",
446
479
  "type": "string",
447
480
  "required": false,
448
481
  "placeholder": "/current/home"
449
482
  },
450
483
  "webhook_current_away": {
451
484
  "title": "Current Mode: Away",
485
+ "description": "",
452
486
  "type": "string",
453
487
  "required": false,
454
488
  "placeholder": "/current/away"
455
489
  },
456
490
  "webhook_current_night": {
457
491
  "title": "Current Mode: Night",
492
+ "description": "",
458
493
  "type": "string",
459
494
  "required": false,
460
495
  "placeholder": "/current/night"
461
496
  },
462
497
  "webhook_current_off": {
463
498
  "title": "Current Mode: Off",
499
+ "description": "",
464
500
  "type": "string",
465
501
  "required": false,
466
502
  "placeholder": "/current/off"
467
503
  },
468
504
  "webhook_current_warning": {
469
505
  "title": "Current Event: Warning",
506
+ "description": "",
470
507
  "type": "string",
471
508
  "required": false,
472
509
  "placeholder": "/current/warning"
473
510
  },
474
511
  "webhook_current_triggered": {
475
512
  "title": "Current Mode: Triggered",
513
+ "description": "",
476
514
  "type": "string",
477
515
  "required": false,
478
516
  "placeholder": "/current/triggered"
479
517
  },
480
518
  "command_target_home": {
481
519
  "title": "Target Mode: Home",
520
+ "description": "",
482
521
  "type": "string",
483
522
  "required": false,
484
523
  "placeholder": "echo target home"
485
524
  },
486
525
  "command_target_away": {
487
526
  "title": "Target Mode: Away",
527
+ "description": "",
488
528
  "type": "string",
489
529
  "required": false,
490
530
  "placeholder": "echo target away"
491
531
  },
492
532
  "command_target_off": {
493
533
  "title": "Target Mode: Off",
534
+ "description": "",
494
535
  "type": "string",
495
536
  "required": false,
496
537
  "placeholder": "echo target off"
497
538
  },
498
539
  "command_target_night": {
499
540
  "title": "Target Mode: Night",
541
+ "description": "",
500
542
  "type": "string",
501
543
  "required": false,
502
544
  "placeholder": "echo target night"
503
545
  },
504
546
  "command_current_home": {
505
547
  "title": "Current Mode: Home",
548
+ "description": "",
506
549
  "type": "string",
507
550
  "required": false,
508
551
  "placeholder": "echo current home"
509
552
  },
510
553
  "command_current_away": {
511
554
  "title": "Current Mode: Away",
555
+ "description": "",
512
556
  "type": "string",
513
557
  "required": false,
514
558
  "placeholder": "echo current away"
515
559
  },
516
560
  "command_current_night": {
517
561
  "title": "Current Mode: Night",
562
+ "description": "",
518
563
  "type": "string",
519
564
  "required": false,
520
565
  "placeholder": "echo current night"
521
566
  },
522
567
  "command_current_off": {
523
568
  "title": "Current Mode: Off",
569
+ "description": "",
524
570
  "type": "string",
525
571
  "required": false,
526
572
  "placeholder": "echo current off"
527
573
  },
528
574
  "command_current_warning": {
529
575
  "title": "Current Event: Warning",
576
+ "description": "",
530
577
  "type": "string",
531
578
  "required": false,
532
579
  "placeholder": "echo current warning"
533
580
  },
534
581
  "command_current_triggered": {
535
582
  "title": "Current Mode: Triggered",
583
+ "description": "",
536
584
  "type": "string",
537
585
  "required": false,
538
586
  "placeholder": "echo current triggered"
@@ -559,7 +607,6 @@
559
607
  "expandable": true,
560
608
  "expanded": false,
561
609
  "items": [
562
- "security_system_name",
563
610
  "trip_switch_name",
564
611
  "trip_home_switch_name",
565
612
  "trip_away_switch_name",
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "homebridge-securitysystem",
3
3
  "displayName": "Homebridge Security System",
4
- "version": "7.2.1-beta.3",
4
+ "version": "7.3.0",
5
5
  "description": "Homebridge plugin that creates a security system accessory that can be triggered by HomeKit sensors.",
6
6
  "main": "src/index.js",
7
7
  "scripts": {
package/src/index.js CHANGED
@@ -135,7 +135,7 @@ function SecuritySystem(log, config) {
135
135
  }
136
136
 
137
137
  // Security system
138
- this.service = new Service.SecuritySystem(options.securitySystemName);
138
+ this.service = new Service.SecuritySystem(options.name);
139
139
  this.availableTargetStates = this.getAvailableTargetStates();
140
140
 
141
141
  this.service.getCharacteristic(
@@ -145,10 +145,7 @@ function SecuritySystem(log, config) {
145
145
  this.service.addCharacteristic(Characteristic.ConfiguredName);
146
146
 
147
147
  this.service
148
- .setCharacteristic(
149
- Characteristic.ConfiguredName,
150
- options.securitySystemName
151
- )
148
+ .setCharacteristic(Characteristic.ConfiguredName, options.name)
152
149
  .getCharacteristic(Characteristic.SecuritySystemTargetState)
153
150
  .setProps({ validValues: this.availableTargetStates })
154
151
  .on("get", this.getTargetState.bind(this))
package/src/utils/options.js CHANGED
@@ -17,7 +17,6 @@ const options = {
17
17
  options.testMode = config.test_mode;
18
18
 
19
19
  // Names
20
- options.securitySystemName = config.security_system_name;
21
20
  options.tripSwitchName = config.trip_switch_name;
22
21
  options.tripHomeSwitchName = config.trip_home_switch_name;
23
22
  options.tripAwaySwitchName = config.trip_away_switch_name;
@@ -174,10 +173,6 @@ const options = {
174
173
  options.resetMinutes = 10;
175
174
  }
176
175
 
177
- if (options.isValueSet(options.securitySystemName) === false) {
178
- options.securitySystemName = "Security System";
179
- }
180
-
181
176
  if (options.isValueSet(options.tripSwitchName) === false) {
182
177
  options.tripSwitchName = "Trip";
183
178
  }