homebridge-securitysystem 7.2.1 → 7.4.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 (26) hide show
  1. package/.eslintrc.js +16 -16
  2. package/.github/FUNDING.yml +2 -2
  3. package/.github/ISSUE_TEMPLATE/bug_report.yml +46 -46
  4. package/.github/ISSUE_TEMPLATE/feature-request.yml +17 -17
  5. package/.github/ISSUE_TEMPLATE/questions-answers.yml +40 -40
  6. package/.github/dependabot.yml +19 -19
  7. package/.github/release.yml +36 -36
  8. package/.github/workflows/codeql.yml +76 -76
  9. package/.github/workflows/create-release.yml +82 -0
  10. package/.github/workflows/{update-version.yml → create-version.yml} +52 -52
  11. package/.github/workflows/dependency-review.yml +24 -24
  12. package/.github/workflows/install-package.yml +29 -29
  13. package/.github/workflows/stale.yml +26 -26
  14. package/.vscode/settings.json +12 -11
  15. package/CODE_OF_CONDUCT.md +128 -128
  16. package/CONTRIBUTING.md +5 -5
  17. package/LICENSE +21 -21
  18. package/README.md +47 -49
  19. package/SECURITY.md +12 -12
  20. package/config.schema.json +835 -756
  21. package/package.json +52 -52
  22. package/sounds/README +22 -22
  23. package/src/index.js +2418 -2396
  24. package/src/utils/options.js +368 -352
  25. package/.github/workflows/new-tag.yml +0 -39
  26. package/.github/workflows/publish-package.yml +0 -51
package/README.md CHANGED
@@ -1,49 +1,47 @@
1
- # homebridge-securitysystem
2
-
3
- [![npm version](https://badgen.net/npm/v/homebridge-securitysystem)](https://www.npmjs.com/package/homebridge-securitysystem)
4
- [![npm downloads](https://badgen.net/npm/dt/homebridge-securitysystem)](https://www.npmjs.com/package/homebridge-securitysystem)
5
- [![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
6
-
7
- Homebridge plugin that creates a security system accessory that can be triggered by HomeKit sensors.
8
-
9
- [❤️ One-time donation](https://paypal.me/miguelripoll23)
10
-
11
- ## Installation
12
-
13
- If you already have [Homebridge](https://github.com/homebridge/homebridge) installed, execute the following command:
14
-
15
- `npm i -g --unsafe-perm homebridge-securitysystem`
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
- ## Demo
20
-
21
- <div align="left">
22
- <img align="right" width="205" height="445" src="./.github/demo.jpg">
23
- <p>Want to know how it looks like? It's pretty customizable, you can configure it to show as many switches as you like.</p>
24
- <p>What you are seeing at your right is <b>the friendliest</b> configuration that you can start with, each <code>Trip</code> switch that you see can only trip the security system if the mode is set on the security system. This allows you to create logic-less automations from the very Home app that comes already installed on iOS.</p>
25
- <p>There are also <code>Mode</code> switches which let you run automations that interact with your accessories when a mode is changed or set modes bypassing HomeKit confirmation dialogs.</p>
26
- <p>A web server, webhooks or even shell commands are available to integrate the security system with other devices or services plus a plenty of more settings to make this plugin your own DIY security system.</p>
27
- <p>Homebridge / HOOBS UI is recommended to configure the plugin, for additional help please check the <a href="https://github.com/MiguelRipoll23/homebridge-securitysystem/wiki">Wiki</a> page.</p>
28
- </div>
29
-
30
- ## Automations
31
-
32
- Using the `Home` app is recommended for regular users, for more advanced users the `Eve` or a similar app will let you make use of the custom options that the security system itself exposes.
33
-
34
- Here are some examples of automations that can be created:
35
-
36
- | Trigger | Actions |
37
- | ------------------------ | ----------------------------- |
38
- | Motion is Detected | Turn on `Trip Night` |
39
- | Door is Opened | Turn on `Trip Away` |
40
- | NFC Tag is Detected (1) | Set Security system to `Home` |
41
- | Security System Triggers | Play Audio (2) |
42
-
43
- (1) Shortcuts app is required to create this automation.
44
-
45
- (2) AirPlay 2 speaker and Apple Music subscription are required.
46
-
47
- ## Contributions
48
-
49
- Pull requests are welcome.
1
+ # homebridge-securitysystem
2
+
3
+ [![npm version](https://badgen.net/npm/v/homebridge-securitysystem)](https://www.npmjs.com/package/homebridge-securitysystem)
4
+ [![npm downloads](https://badgen.net/npm/dt/homebridge-securitysystem)](https://www.npmjs.com/package/homebridge-securitysystem)
5
+ [![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
6
+
7
+ Homebridge plugin that creates a security system accessory that can be triggered by HomeKit sensors.
8
+
9
+ [❤️ One-time donation](https://www.paypal.com/donate/?hosted_button_id=CQTHU44XTXK2L)
10
+
11
+ ## Installation
12
+
13
+ If you already have [Homebridge](https://github.com/homebridge/homebridge) installed, execute the following command:
14
+
15
+ `npm i -g --unsafe-perm homebridge-securitysystem`
16
+
17
+ ## Demo
18
+
19
+ <div align="left">
20
+ <img align="right" width="205" height="445" src="./.github/demo.jpg">
21
+ <p>Want to know how it looks like? It's pretty customizable, you can configure it to show as many switches as you like.</p>
22
+ <p>What you are seeing at your right is <b>the friendliest</b> configuration that you can start with, each <code>Trip</code> switch that you see can only trip the security system if the mode is set on the security system. This allows you to create logic-less automations from the very Home app that comes already installed on iOS.</p>
23
+ <p>There are also <code>Mode</code> switches which let you run automations that interact with your accessories when a mode is changed or set modes bypassing HomeKit confirmation dialogs.</p>
24
+ <p>A web server, webhooks or even shell commands are available to integrate the security system with other devices or services plus a plenty of more settings to make this plugin your own DIY security system.</p>
25
+ <p>Homebridge / HOOBS UI is recommended to configure the plugin, for additional help please check the <a href="https://github.com/MiguelRipoll23/homebridge-securitysystem/wiki">Wiki</a> page.</p>
26
+ </div>
27
+
28
+ ## Automations
29
+
30
+ Using the `Home` app is recommended for regular users, for more advanced users the `Eve` or a similar app will let you make use of the custom options that the security system itself exposes.
31
+
32
+ Here are some examples of automations that can be created:
33
+
34
+ | Trigger | Actions |
35
+ | ------------------------ | ----------------------------- |
36
+ | Motion is Detected | Turn on `Trip Night` |
37
+ | Door is Opened | Turn on `Trip Away` |
38
+ | NFC Tag is Detected (1) | Set Security system to `Home` |
39
+ | Security System Triggers | Play Audio (2) |
40
+
41
+ (1) Shortcuts app is required to create this automation.
42
+
43
+ (2) AirPlay 2 speaker and Apple Music subscription are required.
44
+
45
+ ## Contributions
46
+
47
+ Pull requests are welcome.
package/SECURITY.md CHANGED
@@ -1,12 +1,12 @@
1
- # Security Policy
2
-
3
- ## Supported Versions
4
-
5
- | Version | Supported |
6
- | --------- | ------------------ |
7
- | 6.x.x | :white_check_mark: |
8
- | < 6.x.x | :x: |
9
-
10
- ## Reporting a Vulnerability
11
-
12
- Please report any findings using GitHub.
1
+ # Security Policy
2
+
3
+ ## Supported Versions
4
+
5
+ | Version | Supported |
6
+ | --------- | ------------------ |
7
+ | 6.x.x | :white_check_mark: |
8
+ | < 6.x.x | :x: |
9
+
10
+ ## Reporting a Vulnerability
11
+
12
+ Please report any findings using GitHub.