Initial commit
This commit is contained in:
Lars Strojny
GitHub
commit
dd4a135022
21 changed files with 7523 additions and 0 deletions
38
.eslintrc
Normal file
38
.eslintrc
Normal file
|
|
@ -0,0 +1,38 @@
|
||||||
|
{
|
||||||
|
"parser": "@typescript-eslint/parser",
|
||||||
|
"extends": [
|
||||||
|
"eslint:recommended",
|
||||||
|
"plugin:@typescript-eslint/eslint-recommended",
|
||||||
|
"plugin:@typescript-eslint/recommended" // uses the recommended rules from the @typescript-eslint/eslint-plugin
|
||||||
|
],
|
||||||
|
"parserOptions": {
|
||||||
|
"ecmaVersion": 2018,
|
||||||
|
"sourceType": "module"
|
||||||
|
},
|
||||||
|
"ignorePatterns": [
|
||||||
|
"dist"
|
||||||
|
],
|
||||||
|
"rules": {
|
||||||
|
"quotes": ["warn", "single"],
|
||||||
|
"indent": ["warn", 2, { "SwitchCase": 1 }],
|
||||||
|
"semi": ["off"],
|
||||||
|
"comma-dangle": ["warn", "always-multiline"],
|
||||||
|
"dot-notation": "off",
|
||||||
|
"eqeqeq": "warn",
|
||||||
|
"curly": ["warn", "all"],
|
||||||
|
"brace-style": ["warn"],
|
||||||
|
"prefer-arrow-callback": ["warn"],
|
||||||
|
"max-len": ["warn", 140],
|
||||||
|
"no-console": ["warn"], // use the provided Homebridge log method instead
|
||||||
|
"no-non-null-assertion": ["off"],
|
||||||
|
"comma-spacing": ["error"],
|
||||||
|
"no-multi-spaces": ["warn", { "ignoreEOLComments": true }],
|
||||||
|
"no-trailing-spaces": ["warn"],
|
||||||
|
"lines-between-class-members": ["warn", "always", {"exceptAfterSingleLine": true}],
|
||||||
|
"@typescript-eslint/explicit-function-return-type": "off",
|
||||||
|
"@typescript-eslint/no-non-null-assertion": "off",
|
||||||
|
"@typescript-eslint/explicit-module-boundary-types": "off",
|
||||||
|
"@typescript-eslint/semi": ["warn"],
|
||||||
|
"@typescript-eslint/member-delimiter-style": ["warn"]
|
||||||
|
}
|
||||||
|
}
|
||||||
44
.github/ISSUE_TEMPLATE/bug-report.md
vendored
Normal file
44
.github/ISSUE_TEMPLATE/bug-report.md
vendored
Normal file
|
|
@ -0,0 +1,44 @@
|
||||||
|
---
|
||||||
|
name: Bug Report
|
||||||
|
about: Create a report to help us improve
|
||||||
|
title: ''
|
||||||
|
labels: bug
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<!-- You must use the issue template below when submitting a bug -->
|
||||||
|
|
||||||
|
**Describe The Bug:**
|
||||||
|
<!-- A clear and concise description of what the bug is. -->
|
||||||
|
|
||||||
|
**To Reproduce:**
|
||||||
|
<!-- Steps to reproduce the behavior. -->
|
||||||
|
|
||||||
|
**Expected behavior:**
|
||||||
|
<!-- A clear and concise description of what you expected to happen. -->
|
||||||
|
|
||||||
|
**Logs:**
|
||||||
|
|
||||||
|
```
|
||||||
|
Show the Homebridge logs here, remove any sensitive information.
|
||||||
|
```
|
||||||
|
|
||||||
|
**Plugin Config:**
|
||||||
|
|
||||||
|
```json
|
||||||
|
Show your Homebridge config.json here, remove any sensitive information.
|
||||||
|
```
|
||||||
|
|
||||||
|
**Screenshots:**
|
||||||
|
<!-- If applicable, add screenshots to help explain your problem. -->
|
||||||
|
|
||||||
|
**Environment:**
|
||||||
|
|
||||||
|
* **Plugin Version**:
|
||||||
|
* **Homebridge Version**: <!-- homebridge -V -->
|
||||||
|
* **Node.js Version**: <!-- node -v -->
|
||||||
|
* **NPM Version**: <!-- npm -v -->
|
||||||
|
* **Operating System**: <!-- Raspbian / Ubuntu / Debian / Windows / macOS / Docker / hb-service -->
|
||||||
|
|
||||||
|
<!-- Click the "Preview" tab before you submit to ensure the formatting is correct. -->
|
||||||
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
|
@ -0,0 +1,5 @@
|
||||||
|
# blank_issues_enabled: false
|
||||||
|
# contact_links:
|
||||||
|
# - name: Homebridge Discord Community
|
||||||
|
# url: https://discord.gg/kqNCe2D
|
||||||
|
# about: Ask your questions in the #YOUR_CHANNEL_HERE channel
|
||||||
23
.github/ISSUE_TEMPLATE/feature-request.md
vendored
Normal file
23
.github/ISSUE_TEMPLATE/feature-request.md
vendored
Normal file
|
|
@ -0,0 +1,23 @@
|
||||||
|
---
|
||||||
|
name: Feature Request
|
||||||
|
about: Suggest an idea for this project
|
||||||
|
title: ''
|
||||||
|
labels: enhancement
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Is your feature request related to a problem? Please describe:**
|
||||||
|
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
|
||||||
|
|
||||||
|
**Describe the solution you'd like:**
|
||||||
|
<!-- A clear and concise description of what you want to happen. -->
|
||||||
|
|
||||||
|
**Describe alternatives you've considered:**
|
||||||
|
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
|
||||||
|
|
||||||
|
**Additional context:**
|
||||||
|
<!-- Add any other context or screenshots about the feature request here. -->
|
||||||
|
|
||||||
|
|
||||||
|
<!-- Click the "Preview" tab before you submit to ensure the formatting is correct. -->
|
||||||
38
.github/ISSUE_TEMPLATE/support-request.md
vendored
Normal file
38
.github/ISSUE_TEMPLATE/support-request.md
vendored
Normal file
|
|
@ -0,0 +1,38 @@
|
||||||
|
---
|
||||||
|
name: Support Request
|
||||||
|
about: Need help?
|
||||||
|
title: ''
|
||||||
|
labels: question
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<!-- You must use the issue template below when submitting a support request -->
|
||||||
|
|
||||||
|
**Describe Your Problem:**
|
||||||
|
<!-- A clear and concise description of what problem you are trying to solve. -->
|
||||||
|
|
||||||
|
**Logs:**
|
||||||
|
|
||||||
|
```
|
||||||
|
Show the Homebridge logs here, remove any sensitive information.
|
||||||
|
```
|
||||||
|
|
||||||
|
**Plugin Config:**
|
||||||
|
|
||||||
|
```json
|
||||||
|
Show your Homebridge config.json here, remove any sensitive information.
|
||||||
|
```
|
||||||
|
|
||||||
|
**Screenshots:**
|
||||||
|
<!-- If applicable, add screenshots to help explain your problem. -->
|
||||||
|
|
||||||
|
**Environment:**
|
||||||
|
|
||||||
|
* **Plugin Version**:
|
||||||
|
* **Homebridge Version**: <!-- homebridge -V -->
|
||||||
|
* **Node.js Version**: <!-- node -v -->
|
||||||
|
* **NPM Version**: <!-- npm -v -->
|
||||||
|
* **Operating System**: <!-- Raspbian / Ubuntu / Debian / Windows / macOS / Docker / hb-service -->
|
||||||
|
|
||||||
|
<!-- Click the "Preview" tab before you submit to ensure the formatting is correct. -->
|
||||||
31
.github/workflows/build.yml
vendored
Normal file
31
.github/workflows/build.yml
vendored
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
name: Build and Lint
|
||||||
|
|
||||||
|
on: [push, pull_request]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
# the Node.js versions to build on
|
||||||
|
node-version: [12.x, 13.x, 14.x, 15.x, 16.x]
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Use Node.js ${{ matrix.node-version }}
|
||||||
|
uses: actions/setup-node@v2
|
||||||
|
with:
|
||||||
|
node-version: ${{ matrix.node-version }}
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm install
|
||||||
|
|
||||||
|
- name: Lint the project
|
||||||
|
run: npm run lint
|
||||||
|
|
||||||
|
- name: Build the project
|
||||||
|
run: npm run build
|
||||||
|
env:
|
||||||
|
CI: true
|
||||||
120
.gitignore
vendored
Normal file
120
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,120 @@
|
||||||
|
# Ignore compiled code
|
||||||
|
dist
|
||||||
|
|
||||||
|
# ------------- Defaults ------------- #
|
||||||
|
|
||||||
|
# Logs
|
||||||
|
logs
|
||||||
|
*.log
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
lerna-debug.log*
|
||||||
|
|
||||||
|
# Diagnostic reports (https://nodejs.org/api/report.html)
|
||||||
|
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
|
||||||
|
|
||||||
|
# Runtime data
|
||||||
|
pids
|
||||||
|
*.pid
|
||||||
|
*.seed
|
||||||
|
*.pid.lock
|
||||||
|
|
||||||
|
# Directory for instrumented libs generated by jscoverage/JSCover
|
||||||
|
lib-cov
|
||||||
|
|
||||||
|
# Coverage directory used by tools like istanbul
|
||||||
|
coverage
|
||||||
|
*.lcov
|
||||||
|
|
||||||
|
# nyc test coverage
|
||||||
|
.nyc_output
|
||||||
|
|
||||||
|
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
|
||||||
|
.grunt
|
||||||
|
|
||||||
|
# Bower dependency directory (https://bower.io/)
|
||||||
|
bower_components
|
||||||
|
|
||||||
|
# node-waf configuration
|
||||||
|
.lock-wscript
|
||||||
|
|
||||||
|
# Compiled binary addons (https://nodejs.org/api/addons.html)
|
||||||
|
build/Release
|
||||||
|
|
||||||
|
# Dependency directories
|
||||||
|
node_modules/
|
||||||
|
jspm_packages/
|
||||||
|
|
||||||
|
# Snowpack dependency directory (https://snowpack.dev/)
|
||||||
|
web_modules/
|
||||||
|
|
||||||
|
# TypeScript cache
|
||||||
|
*.tsbuildinfo
|
||||||
|
|
||||||
|
# Optional npm cache directory
|
||||||
|
.npm
|
||||||
|
|
||||||
|
# Optional eslint cache
|
||||||
|
.eslintcache
|
||||||
|
|
||||||
|
# Microbundle cache
|
||||||
|
.rpt2_cache/
|
||||||
|
.rts2_cache_cjs/
|
||||||
|
.rts2_cache_es/
|
||||||
|
.rts2_cache_umd/
|
||||||
|
|
||||||
|
# Optional REPL history
|
||||||
|
.node_repl_history
|
||||||
|
|
||||||
|
# Output of 'npm pack'
|
||||||
|
*.tgz
|
||||||
|
|
||||||
|
# Yarn Integrity file
|
||||||
|
.yarn-integrity
|
||||||
|
|
||||||
|
# dotenv environment variables file
|
||||||
|
.env
|
||||||
|
.env.test
|
||||||
|
|
||||||
|
# parcel-bundler cache (https://parceljs.org/)
|
||||||
|
.cache
|
||||||
|
.parcel-cache
|
||||||
|
|
||||||
|
# Next.js build output
|
||||||
|
.next
|
||||||
|
|
||||||
|
# Nuxt.js build / generate output
|
||||||
|
.nuxt
|
||||||
|
dist
|
||||||
|
|
||||||
|
# Gatsby files
|
||||||
|
.cache/
|
||||||
|
# Comment in the public line in if your project uses Gatsby and not Next.js
|
||||||
|
# https://nextjs.org/blog/next-9-1#public-directory-support
|
||||||
|
# public
|
||||||
|
|
||||||
|
# vuepress build output
|
||||||
|
.vuepress/dist
|
||||||
|
|
||||||
|
# Serverless directories
|
||||||
|
.serverless/
|
||||||
|
|
||||||
|
# FuseBox cache
|
||||||
|
.fusebox/
|
||||||
|
|
||||||
|
# DynamoDB Local files
|
||||||
|
.dynamodb/
|
||||||
|
|
||||||
|
# TernJS port file
|
||||||
|
.tern-port
|
||||||
|
|
||||||
|
# Stores VSCode versions used for testing VSCode extensions
|
||||||
|
.vscode-test
|
||||||
|
|
||||||
|
# yarn v2
|
||||||
|
|
||||||
|
.yarn/cache
|
||||||
|
.yarn/unplugged
|
||||||
|
.yarn/build-state.yml
|
||||||
|
.pnp.*
|
||||||
134
.npmignore
Normal file
134
.npmignore
Normal file
|
|
@ -0,0 +1,134 @@
|
||||||
|
# Ignore source code
|
||||||
|
src
|
||||||
|
|
||||||
|
# ------------- Defaults ------------- #
|
||||||
|
|
||||||
|
# gitHub actions
|
||||||
|
.github
|
||||||
|
|
||||||
|
# eslint
|
||||||
|
.eslintrc
|
||||||
|
|
||||||
|
# typescript
|
||||||
|
tsconfig.json
|
||||||
|
|
||||||
|
# vscode
|
||||||
|
.vscode
|
||||||
|
|
||||||
|
# nodemon
|
||||||
|
nodemon.json
|
||||||
|
|
||||||
|
# Logs
|
||||||
|
logs
|
||||||
|
*.log
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
lerna-debug.log*
|
||||||
|
|
||||||
|
# Diagnostic reports (https://nodejs.org/api/report.html)
|
||||||
|
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
|
||||||
|
|
||||||
|
# Runtime data
|
||||||
|
pids
|
||||||
|
*.pid
|
||||||
|
*.seed
|
||||||
|
*.pid.lock
|
||||||
|
|
||||||
|
# Directory for instrumented libs generated by jscoverage/JSCover
|
||||||
|
lib-cov
|
||||||
|
|
||||||
|
# Coverage directory used by tools like istanbul
|
||||||
|
coverage
|
||||||
|
*.lcov
|
||||||
|
|
||||||
|
# nyc test coverage
|
||||||
|
.nyc_output
|
||||||
|
|
||||||
|
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
|
||||||
|
.grunt
|
||||||
|
|
||||||
|
# Bower dependency directory (https://bower.io/)
|
||||||
|
bower_components
|
||||||
|
|
||||||
|
# node-waf configuration
|
||||||
|
.lock-wscript
|
||||||
|
|
||||||
|
# Compiled binary addons (https://nodejs.org/api/addons.html)
|
||||||
|
build/Release
|
||||||
|
|
||||||
|
# Dependency directories
|
||||||
|
node_modules/
|
||||||
|
jspm_packages/
|
||||||
|
|
||||||
|
# Snowpack dependency directory (https://snowpack.dev/)
|
||||||
|
web_modules/
|
||||||
|
|
||||||
|
# TypeScript cache
|
||||||
|
*.tsbuildinfo
|
||||||
|
|
||||||
|
# Optional npm cache directory
|
||||||
|
.npm
|
||||||
|
|
||||||
|
# Optional eslint cache
|
||||||
|
.eslintcache
|
||||||
|
|
||||||
|
# Microbundle cache
|
||||||
|
.rpt2_cache/
|
||||||
|
.rts2_cache_cjs/
|
||||||
|
.rts2_cache_es/
|
||||||
|
.rts2_cache_umd/
|
||||||
|
|
||||||
|
# Optional REPL history
|
||||||
|
.node_repl_history
|
||||||
|
|
||||||
|
# Output of 'npm pack'
|
||||||
|
*.tgz
|
||||||
|
|
||||||
|
# Yarn Integrity file
|
||||||
|
.yarn-integrity
|
||||||
|
|
||||||
|
# dotenv environment variables file
|
||||||
|
.env
|
||||||
|
.env.test
|
||||||
|
|
||||||
|
# parcel-bundler cache (https://parceljs.org/)
|
||||||
|
.cache
|
||||||
|
.parcel-cache
|
||||||
|
|
||||||
|
# Next.js build output
|
||||||
|
.next
|
||||||
|
|
||||||
|
# Nuxt.js build / generate output
|
||||||
|
.nuxt
|
||||||
|
|
||||||
|
# Gatsby files
|
||||||
|
.cache/
|
||||||
|
# Comment in the public line in if your project uses Gatsby and not Next.js
|
||||||
|
# https://nextjs.org/blog/next-9-1#public-directory-support
|
||||||
|
# public
|
||||||
|
|
||||||
|
# vuepress build output
|
||||||
|
.vuepress/dist
|
||||||
|
|
||||||
|
# Serverless directories
|
||||||
|
.serverless/
|
||||||
|
|
||||||
|
# FuseBox cache
|
||||||
|
.fusebox/
|
||||||
|
|
||||||
|
# DynamoDB Local files
|
||||||
|
.dynamodb/
|
||||||
|
|
||||||
|
# TernJS port file
|
||||||
|
.tern-port
|
||||||
|
|
||||||
|
# Stores VSCode versions used for testing VSCode extensions
|
||||||
|
.vscode-test
|
||||||
|
|
||||||
|
# yarn v2
|
||||||
|
|
||||||
|
.yarn/cache
|
||||||
|
.yarn/unplugged
|
||||||
|
.yarn/build-state.yml
|
||||||
|
.pnp.*
|
||||||
5
.vscode/extensions.json
vendored
Normal file
5
.vscode/extensions.json
vendored
Normal file
|
|
@ -0,0 +1,5 @@
|
||||||
|
{
|
||||||
|
"recommendations": [
|
||||||
|
"dbaeumer.vscode-eslint"
|
||||||
|
]
|
||||||
|
}
|
||||||
8
.vscode/settings.json
vendored
Normal file
8
.vscode/settings.json
vendored
Normal file
|
|
@ -0,0 +1,8 @@
|
||||||
|
{
|
||||||
|
"files.eol": "\n",
|
||||||
|
"editor.codeActionsOnSave": {
|
||||||
|
"source.fixAll.eslint": true
|
||||||
|
},
|
||||||
|
"editor.rulers": [ 140 ],
|
||||||
|
"eslint.enable": true
|
||||||
|
}
|
||||||
176
LICENSE
Normal file
176
LICENSE
Normal file
|
|
@ -0,0 +1,176 @@
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
169
README.md
Normal file
169
README.md
Normal file
|
|
@ -0,0 +1,169 @@
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
|
||||||
|
<img src="https://github.com/homebridge/branding/raw/master/logos/homebridge-wordmark-logo-vertical.png" width="150">
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
# Homebridge Platform Plugin Template
|
||||||
|
|
||||||
|
This is a template Homebridge platform plugin and can be used as a base to help you get started developing your own plugin.
|
||||||
|
|
||||||
|
This template should be used in conjunction with the [developer documentation](https://developers.homebridge.io/). A full list of all supported service types, and their characteristics is available on this site.
|
||||||
|
|
||||||
|
## Clone As Template
|
||||||
|
|
||||||
|
Click the link below to create a new GitHub Repository using this template, or click the *Use This Template* button above.
|
||||||
|
|
||||||
|
<span align="center">
|
||||||
|
|
||||||
|
### [Create New Repository From Template](https://github.com/homebridge/homebridge-plugin-template/generate)
|
||||||
|
|
||||||
|
</span>
|
||||||
|
|
||||||
|
## Setup Development Environment
|
||||||
|
|
||||||
|
To develop Homebridge plugins you must have Node.js 12 or later installed, and a modern code editor such as [VS Code](https://code.visualstudio.com/). This plugin template uses [TypeScript](https://www.typescriptlang.org/) to make development easier and comes with pre-configured settings for [VS Code](https://code.visualstudio.com/) and ESLint. If you are using VS Code install these extensions:
|
||||||
|
|
||||||
|
* [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
||||||
|
|
||||||
|
## Install Development Dependencies
|
||||||
|
|
||||||
|
Using a terminal, navigate to the project folder and run this command to install the development dependencies:
|
||||||
|
|
||||||
|
```
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
## Update package.json
|
||||||
|
|
||||||
|
Open the [`package.json`](./package.json) and change the following attributes:
|
||||||
|
|
||||||
|
* `name` - this should be prefixed with `homebridge-` or `@username/homebridge-` and contain no spaces or special characters apart from a dashes
|
||||||
|
* `displayName` - this is the "nice" name displayed in the Homebridge UI
|
||||||
|
* `repository.url` - Link to your GitHub repo
|
||||||
|
* `bugs.url` - Link to your GitHub repo issues page
|
||||||
|
|
||||||
|
When you are ready to publish the plugin you should set `private` to false, or remove the attribute entirely.
|
||||||
|
|
||||||
|
## Update Plugin Defaults
|
||||||
|
|
||||||
|
Open the [`src/settings.ts`](./src/settings.ts) file and change the default values:
|
||||||
|
|
||||||
|
* `PLATFORM_NAME` - Set this to be the name of your platform. This is the name of the platform that users will use to register the plugin in the Homebridge `config.json`.
|
||||||
|
* `PLUGIN_NAME` - Set this to be the same name you set in the [`package.json`](./package.json) file.
|
||||||
|
|
||||||
|
Open the [`config.schema.json`](./config.schema.json) file and change the following attribute:
|
||||||
|
|
||||||
|
* `pluginAlias` - set this to match the `PLATFORM_NAME` you defined in the previous step.
|
||||||
|
|
||||||
|
## Build Plugin
|
||||||
|
|
||||||
|
TypeScript needs to be compiled into JavaScript before it can run. The following command will compile the contents of your [`src`](./src) directory and put the resulting code into the `dist` folder.
|
||||||
|
|
||||||
|
```
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
## Link To Homebridge
|
||||||
|
|
||||||
|
Run this command so your global install of Homebridge can discover the plugin in your development environment:
|
||||||
|
|
||||||
|
```
|
||||||
|
npm link
|
||||||
|
```
|
||||||
|
|
||||||
|
You can now start Homebridge, use the `-D` flag so you can see debug log messages in your plugin:
|
||||||
|
|
||||||
|
```
|
||||||
|
homebridge -D
|
||||||
|
```
|
||||||
|
|
||||||
|
## Watch For Changes and Build Automatically
|
||||||
|
|
||||||
|
If you want to have your code compile automatically as you make changes, and restart Homebridge automatically between changes, you first need to add your plugin as a platform in `~/.homebridge/config.json`:
|
||||||
|
```
|
||||||
|
{
|
||||||
|
...
|
||||||
|
"platforms": [
|
||||||
|
{
|
||||||
|
"name": "Config",
|
||||||
|
"port": 8581,
|
||||||
|
"platform": "config"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "<PLUGIN_NAME>",
|
||||||
|
//... any other options, as listed in config.schema.json ...
|
||||||
|
"platform": "<PLATFORM_NAME>"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
and then you can run:
|
||||||
|
|
||||||
|
```
|
||||||
|
npm run watch
|
||||||
|
```
|
||||||
|
|
||||||
|
This will launch an instance of Homebridge in debug mode which will restart every time you make a change to the source code. It will load the config stored in the default location under `~/.homebridge`. You may need to stop other running instances of Homebridge while using this command to prevent conflicts. You can adjust the Homebridge startup command in the [`nodemon.json`](./nodemon.json) file.
|
||||||
|
|
||||||
|
## Customise Plugin
|
||||||
|
|
||||||
|
You can now start customising the plugin template to suit your requirements.
|
||||||
|
|
||||||
|
* [`src/platform.ts`](./src/platform.ts) - this is where your device setup and discovery should go.
|
||||||
|
* [`src/platformAccessory.ts`](./src/platformAccessory.ts) - this is where your accessory control logic should go, you can rename or create multiple instances of this file for each accessory type you need to implement as part of your platform plugin. You can refer to the [developer documentation](https://developers.homebridge.io/) to see what characteristics you need to implement for each service type.
|
||||||
|
* [`config.schema.json`](./config.schema.json) - update the config schema to match the config you expect from the user. See the [Plugin Config Schema Documentation](https://developers.homebridge.io/#/config-schema).
|
||||||
|
|
||||||
|
## Versioning Your Plugin
|
||||||
|
|
||||||
|
Given a version number `MAJOR`.`MINOR`.`PATCH`, such as `1.4.3`, increment the:
|
||||||
|
|
||||||
|
1. **MAJOR** version when you make breaking changes to your plugin,
|
||||||
|
2. **MINOR** version when you add functionality in a backwards compatible manner, and
|
||||||
|
3. **PATCH** version when you make backwards compatible bug fixes.
|
||||||
|
|
||||||
|
You can use the `npm version` command to help you with this:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# major update / breaking changes
|
||||||
|
npm version major
|
||||||
|
|
||||||
|
# minor update / new features
|
||||||
|
npm version update
|
||||||
|
|
||||||
|
# patch / bugfixes
|
||||||
|
npm version patch
|
||||||
|
```
|
||||||
|
|
||||||
|
## Publish Package
|
||||||
|
|
||||||
|
When you are ready to publish your plugin to [npm](https://www.npmjs.com/), make sure you have removed the `private` attribute from the [`package.json`](./package.json) file then run:
|
||||||
|
|
||||||
|
```
|
||||||
|
npm publish
|
||||||
|
```
|
||||||
|
|
||||||
|
If you are publishing a scoped plugin, i.e. `@username/homebridge-xxx` you will need to add `--access=public` to command the first time you publish.
|
||||||
|
|
||||||
|
#### Publishing Beta Versions
|
||||||
|
|
||||||
|
You can publish *beta* versions of your plugin for other users to test before you release it to everyone.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# create a new pre-release version (eg. 2.1.0-beta.1)
|
||||||
|
npm version prepatch --preid beta
|
||||||
|
|
||||||
|
# publish to @beta
|
||||||
|
npm publish --tag=beta
|
||||||
|
```
|
||||||
|
|
||||||
|
Users can then install the *beta* version by appending `@beta` to the install command, for example:
|
||||||
|
|
||||||
|
```
|
||||||
|
sudo npm install -g homebridge-example-plugin@beta
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
16
config.schema.json
Normal file
16
config.schema.json
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
{
|
||||||
|
"pluginAlias": "ExampleHomebridgePlugin",
|
||||||
|
"pluginType": "platform",
|
||||||
|
"singular": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"name": {
|
||||||
|
"title": "Name",
|
||||||
|
"type": "string",
|
||||||
|
"required": true,
|
||||||
|
"default": "Example Dynamic Platform"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
12
nodemon.json
Normal file
12
nodemon.json
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
{
|
||||||
|
"watch": [
|
||||||
|
"src"
|
||||||
|
],
|
||||||
|
"ext": "ts",
|
||||||
|
"ignore": [],
|
||||||
|
"exec": "tsc && homebridge -I -D",
|
||||||
|
"signal": "SIGTERM",
|
||||||
|
"env": {
|
||||||
|
"NODE_OPTIONS": "--trace-warnings"
|
||||||
|
}
|
||||||
|
}
|
||||||
6360
package-lock.json
generated
Normal file
6360
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load diff
41
package.json
Normal file
41
package.json
Normal file
|
|
@ -0,0 +1,41 @@
|
||||||
|
{
|
||||||
|
"private": true,
|
||||||
|
"displayName": "Plugin Name",
|
||||||
|
"name": "homebridge-plugin-name",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"description": "A short description about what your plugin does.",
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://github.com/USERNAME/GITHUB_PROJECT_NAME.git"
|
||||||
|
},
|
||||||
|
"bugs": {
|
||||||
|
"url": "https://github.com/USERNAME/GITHUB_PROJECT_NAME/issues"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=14.18.1",
|
||||||
|
"homebridge": ">=1.3.5"
|
||||||
|
},
|
||||||
|
"main": "dist/index.js",
|
||||||
|
"scripts": {
|
||||||
|
"lint": "eslint src/**.ts --max-warnings=0",
|
||||||
|
"watch": "npm run build && npm link && nodemon",
|
||||||
|
"build": "rimraf ./dist && tsc",
|
||||||
|
"prepublishOnly": "npm run lint && npm run build"
|
||||||
|
},
|
||||||
|
"keywords": [
|
||||||
|
"homebridge-plugin"
|
||||||
|
],
|
||||||
|
"dependencies": {},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/node": "^16.10.9",
|
||||||
|
"@typescript-eslint/eslint-plugin": "^5.0.0",
|
||||||
|
"@typescript-eslint/parser": "^5.0.0",
|
||||||
|
"eslint": "^8.0.1",
|
||||||
|
"homebridge": "^1.3.5",
|
||||||
|
"nodemon": "^2.0.13",
|
||||||
|
"rimraf": "^3.0.2",
|
||||||
|
"ts-node": "^10.3.0",
|
||||||
|
"typescript": "^4.4.4"
|
||||||
|
}
|
||||||
|
}
|
||||||
11
src/index.ts
Normal file
11
src/index.ts
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
import { API } from 'homebridge';
|
||||||
|
|
||||||
|
import { PLATFORM_NAME } from './settings';
|
||||||
|
import { ExampleHomebridgePlatform } from './platform';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method registers the platform with Homebridge
|
||||||
|
*/
|
||||||
|
export = (api: API) => {
|
||||||
|
api.registerPlatform(PLATFORM_NAME, ExampleHomebridgePlatform);
|
||||||
|
};
|
||||||
116
src/platform.ts
Normal file
116
src/platform.ts
Normal file
|
|
@ -0,0 +1,116 @@
|
||||||
|
import { API, DynamicPlatformPlugin, Logger, PlatformAccessory, PlatformConfig, Service, Characteristic } from 'homebridge';
|
||||||
|
|
||||||
|
import { PLATFORM_NAME, PLUGIN_NAME } from './settings';
|
||||||
|
import { ExamplePlatformAccessory } from './platformAccessory';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* HomebridgePlatform
|
||||||
|
* This class is the main constructor for your plugin, this is where you should
|
||||||
|
* parse the user config and discover/register accessories with Homebridge.
|
||||||
|
*/
|
||||||
|
export class ExampleHomebridgePlatform implements DynamicPlatformPlugin {
|
||||||
|
public readonly Service: typeof Service = this.api.hap.Service;
|
||||||
|
public readonly Characteristic: typeof Characteristic = this.api.hap.Characteristic;
|
||||||
|
|
||||||
|
// this is used to track restored cached accessories
|
||||||
|
public readonly accessories: PlatformAccessory[] = [];
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
public readonly log: Logger,
|
||||||
|
public readonly config: PlatformConfig,
|
||||||
|
public readonly api: API,
|
||||||
|
) {
|
||||||
|
this.log.debug('Finished initializing platform:', this.config.name);
|
||||||
|
|
||||||
|
// When this event is fired it means Homebridge has restored all cached accessories from disk.
|
||||||
|
// Dynamic Platform plugins should only register new accessories after this event was fired,
|
||||||
|
// in order to ensure they weren't added to homebridge already. This event can also be used
|
||||||
|
// to start discovery of new accessories.
|
||||||
|
this.api.on('didFinishLaunching', () => {
|
||||||
|
log.debug('Executed didFinishLaunching callback');
|
||||||
|
// run the method to discover / register your devices as accessories
|
||||||
|
this.discoverDevices();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This function is invoked when homebridge restores cached accessories from disk at startup.
|
||||||
|
* It should be used to setup event handlers for characteristics and update respective values.
|
||||||
|
*/
|
||||||
|
configureAccessory(accessory: PlatformAccessory) {
|
||||||
|
this.log.info('Loading accessory from cache:', accessory.displayName);
|
||||||
|
|
||||||
|
// add the restored accessory to the accessories cache so we can track if it has already been registered
|
||||||
|
this.accessories.push(accessory);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This is an example method showing how to register discovered accessories.
|
||||||
|
* Accessories must only be registered once, previously created accessories
|
||||||
|
* must not be registered again to prevent "duplicate UUID" errors.
|
||||||
|
*/
|
||||||
|
discoverDevices() {
|
||||||
|
|
||||||
|
// EXAMPLE ONLY
|
||||||
|
// A real plugin you would discover accessories from the local network, cloud services
|
||||||
|
// or a user-defined array in the platform config.
|
||||||
|
const exampleDevices = [
|
||||||
|
{
|
||||||
|
exampleUniqueId: 'ABCD',
|
||||||
|
exampleDisplayName: 'Bedroom',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
exampleUniqueId: 'EFGH',
|
||||||
|
exampleDisplayName: 'Kitchen',
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
// loop over the discovered devices and register each one if it has not already been registered
|
||||||
|
for (const device of exampleDevices) {
|
||||||
|
|
||||||
|
// generate a unique id for the accessory this should be generated from
|
||||||
|
// something globally unique, but constant, for example, the device serial
|
||||||
|
// number or MAC address
|
||||||
|
const uuid = this.api.hap.uuid.generate(device.exampleUniqueId);
|
||||||
|
|
||||||
|
// see if an accessory with the same uuid has already been registered and restored from
|
||||||
|
// the cached devices we stored in the `configureAccessory` method above
|
||||||
|
const existingAccessory = this.accessories.find(accessory => accessory.UUID === uuid);
|
||||||
|
|
||||||
|
if (existingAccessory) {
|
||||||
|
// the accessory already exists
|
||||||
|
this.log.info('Restoring existing accessory from cache:', existingAccessory.displayName);
|
||||||
|
|
||||||
|
// if you need to update the accessory.context then you should run `api.updatePlatformAccessories`. eg.:
|
||||||
|
// existingAccessory.context.device = device;
|
||||||
|
// this.api.updatePlatformAccessories([existingAccessory]);
|
||||||
|
|
||||||
|
// create the accessory handler for the restored accessory
|
||||||
|
// this is imported from `platformAccessory.ts`
|
||||||
|
new ExamplePlatformAccessory(this, existingAccessory);
|
||||||
|
|
||||||
|
// it is possible to remove platform accessories at any time using `api.unregisterPlatformAccessories`, eg.:
|
||||||
|
// remove platform accessories when no longer present
|
||||||
|
// this.api.unregisterPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, [existingAccessory]);
|
||||||
|
// this.log.info('Removing existing accessory from cache:', existingAccessory.displayName);
|
||||||
|
} else {
|
||||||
|
// the accessory does not yet exist, so we need to create it
|
||||||
|
this.log.info('Adding new accessory:', device.exampleDisplayName);
|
||||||
|
|
||||||
|
// create a new accessory
|
||||||
|
const accessory = new this.api.platformAccessory(device.exampleDisplayName, uuid);
|
||||||
|
|
||||||
|
// store a copy of the device object in the `accessory.context`
|
||||||
|
// the `context` property can be used to store any data about the accessory you may need
|
||||||
|
accessory.context.device = device;
|
||||||
|
|
||||||
|
// create the accessory handler for the newly create accessory
|
||||||
|
// this is imported from `platformAccessory.ts`
|
||||||
|
new ExamplePlatformAccessory(this, accessory);
|
||||||
|
|
||||||
|
// link the accessory to your platform
|
||||||
|
this.api.registerPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, [accessory]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
141
src/platformAccessory.ts
Normal file
141
src/platformAccessory.ts
Normal file
|
|
@ -0,0 +1,141 @@
|
||||||
|
import { Service, PlatformAccessory, CharacteristicValue } from 'homebridge';
|
||||||
|
|
||||||
|
import { ExampleHomebridgePlatform } from './platform';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Platform Accessory
|
||||||
|
* An instance of this class is created for each accessory your platform registers
|
||||||
|
* Each accessory may expose multiple services of different service types.
|
||||||
|
*/
|
||||||
|
export class ExamplePlatformAccessory {
|
||||||
|
private service: Service;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* These are just used to create a working example
|
||||||
|
* You should implement your own code to track the state of your accessory
|
||||||
|
*/
|
||||||
|
private exampleStates = {
|
||||||
|
On: false,
|
||||||
|
Brightness: 100,
|
||||||
|
};
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
private readonly platform: ExampleHomebridgePlatform,
|
||||||
|
private readonly accessory: PlatformAccessory,
|
||||||
|
) {
|
||||||
|
|
||||||
|
// set accessory information
|
||||||
|
this.accessory.getService(this.platform.Service.AccessoryInformation)!
|
||||||
|
.setCharacteristic(this.platform.Characteristic.Manufacturer, 'Default-Manufacturer')
|
||||||
|
.setCharacteristic(this.platform.Characteristic.Model, 'Default-Model')
|
||||||
|
.setCharacteristic(this.platform.Characteristic.SerialNumber, 'Default-Serial');
|
||||||
|
|
||||||
|
// get the LightBulb service if it exists, otherwise create a new LightBulb service
|
||||||
|
// you can create multiple services for each accessory
|
||||||
|
this.service = this.accessory.getService(this.platform.Service.Lightbulb) || this.accessory.addService(this.platform.Service.Lightbulb);
|
||||||
|
|
||||||
|
// set the service name, this is what is displayed as the default name on the Home app
|
||||||
|
// in this example we are using the name we stored in the `accessory.context` in the `discoverDevices` method.
|
||||||
|
this.service.setCharacteristic(this.platform.Characteristic.Name, accessory.context.device.exampleDisplayName);
|
||||||
|
|
||||||
|
// each service must implement at-minimum the "required characteristics" for the given service type
|
||||||
|
// see https://developers.homebridge.io/#/service/Lightbulb
|
||||||
|
|
||||||
|
// register handlers for the On/Off Characteristic
|
||||||
|
this.service.getCharacteristic(this.platform.Characteristic.On)
|
||||||
|
.onSet(this.setOn.bind(this)) // SET - bind to the `setOn` method below
|
||||||
|
.onGet(this.getOn.bind(this)); // GET - bind to the `getOn` method below
|
||||||
|
|
||||||
|
// register handlers for the Brightness Characteristic
|
||||||
|
this.service.getCharacteristic(this.platform.Characteristic.Brightness)
|
||||||
|
.onSet(this.setBrightness.bind(this)); // SET - bind to the 'setBrightness` method below
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creating multiple services of the same type.
|
||||||
|
*
|
||||||
|
* To avoid "Cannot add a Service with the same UUID another Service without also defining a unique 'subtype' property." error,
|
||||||
|
* when creating multiple services of the same type, you need to use the following syntax to specify a name and subtype id:
|
||||||
|
* this.accessory.getService('NAME') || this.accessory.addService(this.platform.Service.Lightbulb, 'NAME', 'USER_DEFINED_SUBTYPE_ID');
|
||||||
|
*
|
||||||
|
* The USER_DEFINED_SUBTYPE must be unique to the platform accessory (if you platform exposes multiple accessories, each accessory
|
||||||
|
* can use the same sub type id.)
|
||||||
|
*/
|
||||||
|
|
||||||
|
// Example: add two "motion sensor" services to the accessory
|
||||||
|
const motionSensorOneService = this.accessory.getService('Motion Sensor One Name') ||
|
||||||
|
this.accessory.addService(this.platform.Service.MotionSensor, 'Motion Sensor One Name', 'YourUniqueIdentifier-1');
|
||||||
|
|
||||||
|
const motionSensorTwoService = this.accessory.getService('Motion Sensor Two Name') ||
|
||||||
|
this.accessory.addService(this.platform.Service.MotionSensor, 'Motion Sensor Two Name', 'YourUniqueIdentifier-2');
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Updating characteristics values asynchronously.
|
||||||
|
*
|
||||||
|
* Example showing how to update the state of a Characteristic asynchronously instead
|
||||||
|
* of using the `on('get')` handlers.
|
||||||
|
* Here we change update the motion sensor trigger states on and off every 10 seconds
|
||||||
|
* the `updateCharacteristic` method.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
let motionDetected = false;
|
||||||
|
setInterval(() => {
|
||||||
|
// EXAMPLE - inverse the trigger
|
||||||
|
motionDetected = !motionDetected;
|
||||||
|
|
||||||
|
// push the new value to HomeKit
|
||||||
|
motionSensorOneService.updateCharacteristic(this.platform.Characteristic.MotionDetected, motionDetected);
|
||||||
|
motionSensorTwoService.updateCharacteristic(this.platform.Characteristic.MotionDetected, !motionDetected);
|
||||||
|
|
||||||
|
this.platform.log.debug('Triggering motionSensorOneService:', motionDetected);
|
||||||
|
this.platform.log.debug('Triggering motionSensorTwoService:', !motionDetected);
|
||||||
|
}, 10000);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle "SET" requests from HomeKit
|
||||||
|
* These are sent when the user changes the state of an accessory, for example, turning on a Light bulb.
|
||||||
|
*/
|
||||||
|
async setOn(value: CharacteristicValue) {
|
||||||
|
// implement your own code to turn your device on/off
|
||||||
|
this.exampleStates.On = value as boolean;
|
||||||
|
|
||||||
|
this.platform.log.debug('Set Characteristic On ->', value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle the "GET" requests from HomeKit
|
||||||
|
* These are sent when HomeKit wants to know the current state of the accessory, for example, checking if a Light bulb is on.
|
||||||
|
*
|
||||||
|
* GET requests should return as fast as possbile. A long delay here will result in
|
||||||
|
* HomeKit being unresponsive and a bad user experience in general.
|
||||||
|
*
|
||||||
|
* If your device takes time to respond you should update the status of your device
|
||||||
|
* asynchronously instead using the `updateCharacteristic` method instead.
|
||||||
|
|
||||||
|
* @example
|
||||||
|
* this.service.updateCharacteristic(this.platform.Characteristic.On, true)
|
||||||
|
*/
|
||||||
|
async getOn(): Promise<CharacteristicValue> {
|
||||||
|
// implement your own code to check if the device is on
|
||||||
|
const isOn = this.exampleStates.On;
|
||||||
|
|
||||||
|
this.platform.log.debug('Get Characteristic On ->', isOn);
|
||||||
|
|
||||||
|
// if you need to return an error to show the device as "Not Responding" in the Home app:
|
||||||
|
// throw new this.platform.api.hap.HapStatusError(this.platform.api.hap.HAPStatus.SERVICE_COMMUNICATION_FAILURE);
|
||||||
|
|
||||||
|
return isOn;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle "SET" requests from HomeKit
|
||||||
|
* These are sent when the user changes the state of an accessory, for example, changing the Brightness
|
||||||
|
*/
|
||||||
|
async setBrightness(value: CharacteristicValue) {
|
||||||
|
// implement your own code to set the brightness
|
||||||
|
this.exampleStates.Brightness = value as number;
|
||||||
|
|
||||||
|
this.platform.log.debug('Set Characteristic Brightness -> ', value);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
9
src/settings.ts
Normal file
9
src/settings.ts
Normal file
|
|
@ -0,0 +1,9 @@
|
||||||
|
/**
|
||||||
|
* This is the name of the platform that users will use to register the plugin in the Homebridge config.json
|
||||||
|
*/
|
||||||
|
export const PLATFORM_NAME = 'ExampleHomebridgePlugin';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This must match the name of your plugin as defined the package.json
|
||||||
|
*/
|
||||||
|
export const PLUGIN_NAME = 'homebridge-plugin-name';
|
||||||
26
tsconfig.json
Normal file
26
tsconfig.json
Normal file
|
|
@ -0,0 +1,26 @@
|
||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"target": "ES2018", // ~node10
|
||||||
|
"module": "commonjs",
|
||||||
|
"lib": [
|
||||||
|
"es2015",
|
||||||
|
"es2016",
|
||||||
|
"es2017",
|
||||||
|
"es2018"
|
||||||
|
],
|
||||||
|
"declaration": true,
|
||||||
|
"declarationMap": true,
|
||||||
|
"sourceMap": true,
|
||||||
|
"outDir": "./dist",
|
||||||
|
"rootDir": "./src",
|
||||||
|
"strict": true,
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"noImplicitAny": false
|
||||||
|
},
|
||||||
|
"include": [
|
||||||
|
"src/"
|
||||||
|
],
|
||||||
|
"exclude": [
|
||||||
|
"**/*.spec.ts"
|
||||||
|
]
|
||||||
|
}
|
||||||
Loading…
Reference in a new issue