mirror of
https://github.com/hassio-addons/addon-zwave2mqtt.git
synced 2025-05-03 19:01:35 +00:00
✨ Initial add-on code
This commit is contained in:
parent
094f5519aa
commit
ed8ada17f3
45 changed files with 1495 additions and 0 deletions
19
.editorconfig
Executable file
19
.editorconfig
Executable file
|
@ -0,0 +1,19 @@
|
|||
root = true
|
||||
|
||||
[*]
|
||||
charset = utf-8
|
||||
end_of_line = lf
|
||||
indent_style = space
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
ident_size = 4
|
||||
|
||||
[*.md]
|
||||
ident_size = 2
|
||||
trim_trailing_whitespace = false
|
||||
|
||||
[*.json]
|
||||
ident_size = 2
|
||||
|
||||
[{.gitignore,.gitkeep,.editorconfig}]
|
||||
ident_size = 2
|
4
.github/CODEOWNERS
vendored
Normal file
4
.github/CODEOWNERS
vendored
Normal file
|
@ -0,0 +1,4 @@
|
|||
# Require maintainer's :+1: for changes to the .github/ repo-config files
|
||||
# mainly due to https://github.com/probot/settings privilege escalation
|
||||
.github/* @frenck
|
||||
.gitlab-ci.yml @frenck
|
20
.github/ISSUE_TEMPLATE.md
vendored
Executable file
20
.github/ISSUE_TEMPLATE.md
vendored
Executable file
|
@ -0,0 +1,20 @@
|
|||
# Problem/Motivation
|
||||
|
||||
> (Why the issue was filed)
|
||||
|
||||
## Expected behavior
|
||||
|
||||
> (What you expected to happen)
|
||||
|
||||
## Actual behavior
|
||||
|
||||
> (What actually happened)
|
||||
|
||||
## Steps to reproduce
|
||||
|
||||
> (How can someone else make/see it happen)
|
||||
|
||||
## Proposed changes
|
||||
|
||||
> (If you have a proposed change, workaround or fix,
|
||||
> describe the rationale behind it)
|
9
.github/PULL_REQUEST_TEMPLATE.md
vendored
Executable file
9
.github/PULL_REQUEST_TEMPLATE.md
vendored
Executable file
|
@ -0,0 +1,9 @@
|
|||
# Proposed Changes
|
||||
|
||||
> (Describe the changes and rationale behind them)
|
||||
|
||||
## Related Issues
|
||||
|
||||
> ([Github link][autolink-references] to related issues or pull requests)
|
||||
|
||||
[autolink-references]: https://help.github.com/articles/autolinked-references-and-urls/
|
2
.github/autolabeler.yml
vendored
Normal file
2
.github/autolabeler.yml
vendored
Normal file
|
@ -0,0 +1,2 @@
|
|||
---
|
||||
"Type: Documentation": ["*.md", "*.j2"]
|
50
.github/config.yml
vendored
Normal file
50
.github/config.yml
vendored
Normal file
|
@ -0,0 +1,50 @@
|
|||
---
|
||||
# Configuration for request-info - https://github.com/behaviorbot/request-info
|
||||
|
||||
# *OPTIONAL* Comment to reply with
|
||||
# Can be either a string :
|
||||
requestInfoReplyComment:
|
||||
- "We would appreciate it if you could provide us with more info about this issue/pr!"
|
||||
- "Hmmm... That issue/PR is kinda low on text. Could you please provide some more content?"
|
||||
|
||||
# *OPTIONAL* default titles to check against for lack of descriptiveness
|
||||
# MUST BE ALL LOWERCASE
|
||||
requestInfoDefaultTitles: []
|
||||
|
||||
# *OPTIONAL* Label to be added to Issues and Pull Requests with insufficient information given
|
||||
requestInfoLabelToAdd: "Incomplete"
|
||||
|
||||
# *OPTIONAL* Require Pull Requests to contain more information than what is provided in the PR template
|
||||
# Will fail if the pull request's body is equal to the provided template
|
||||
checkPullRequestTemplate: true
|
||||
|
||||
# *OPTIONAL* Only warn about insufficient information on these events type
|
||||
# Keys must be lowercase. Valid values are 'issue' and 'pullRequest'
|
||||
requestInfoOn:
|
||||
pullRequest: true
|
||||
issue: true
|
||||
|
||||
# *OPTIONAL* Add a list of people whose Issues/PRs will not be commented on
|
||||
# keys must be GitHub usernames
|
||||
requestInfoUserstoExclude: []
|
||||
|
||||
# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
|
||||
|
||||
# Comment to be posted to on first time issues
|
||||
newIssueWelcomeComment: >
|
||||
:wave: Thanks for opening your first issue here!
|
||||
If you're reporting a :bug: bug, please make sure you include steps to reproduce it.
|
||||
Also, logs, error messages and information about your hardware might be usefull.
|
||||
|
||||
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
|
||||
|
||||
# Comment to be posted to on PRs from first time contributors in your repository
|
||||
newPRWelcomeComment: >
|
||||
:sparkling_heart: Thanks for opening this pull request! :sparkling_heart:
|
||||
If your PR gets accepted and merged in, we will invite you to the project :tada:
|
||||
|
||||
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
|
||||
|
||||
# Comment to be posted to on pull requests merged by a first time user
|
||||
firstPRMergeComment: >
|
||||
Congrats on merging your first pull request! :tada::tada::tada:
|
10
.github/invite-contributors.yml
vendored
Normal file
10
.github/invite-contributors.yml
vendored
Normal file
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
# If true, this will add new contributors as outside collaborators
|
||||
# to the repo their PR was merged in. Team name is ignored if this
|
||||
# flag is set to true.
|
||||
isOutside: false
|
||||
|
||||
# Specify team name to add new contributors to a specific team
|
||||
# within your organization.
|
||||
# Use team name or team-name-slug
|
||||
team: Contributors
|
20
.github/lock.yml
vendored
Normal file
20
.github/lock.yml
vendored
Normal file
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
# Configuration for lock-threads - https://github.com/dessant/lock-threads
|
||||
# Number of days of inactivity before a closed issue or pull request is locked
|
||||
daysUntilLock: 30
|
||||
|
||||
# Comment to post before locking. Set to `false` to disable
|
||||
lockComment: >
|
||||
This thread has been automatically locked because it has not had recent
|
||||
activity. Please open a new issue for related bugs and link to relevant
|
||||
comments in this thread.
|
||||
|
||||
# Issues or pull requests with these labels will not be locked
|
||||
# exemptLabels:
|
||||
# - no-locking
|
||||
|
||||
# Limit to only `issues` or `pulls`
|
||||
# only: issues
|
||||
|
||||
# Add a label when locking. Set to `false` to disable
|
||||
lockLabel: false
|
20
.github/move.yml
vendored
Normal file
20
.github/move.yml
vendored
Normal file
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
# Delete the command comment when it contains no other content
|
||||
deleteCommand: true
|
||||
|
||||
# Close the source issue after moving
|
||||
closeSourceIssue: true
|
||||
|
||||
# Lock the source issue after moving
|
||||
lockSourceIssue: true
|
||||
|
||||
# Mention issue and comment authors
|
||||
mentionAuthors: true
|
||||
|
||||
# Preserve mentions in the issue content
|
||||
keepContentMentions: false
|
||||
|
||||
# Set custom aliases for targets
|
||||
# aliases:
|
||||
# r: repo
|
||||
# or: owner/repo
|
13
.github/no-response.yml
vendored
Normal file
13
.github/no-response.yml
vendored
Normal file
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
# Configuration for probot-no-response - https://github.com/probot/no-response
|
||||
# Number of days of inactivity before an Issue is closed for lack of response
|
||||
daysUntilClose: 14
|
||||
# Label requiring a response
|
||||
responseRequiredLabel: "Status: Awaiting response"
|
||||
# Comment to post when closing an Issue for lack of response. Set to `false` to disable
|
||||
closeComment: >
|
||||
This issue has been automatically closed because there has been no response
|
||||
to our request for more information from the original author. With only the
|
||||
information that is currently in the issue, we don't have enough information
|
||||
to take action. Please reach out if you have or find the answers we need so
|
||||
that we can investigate further.
|
14
.github/potential-duplicates.yml
vendored
Normal file
14
.github/potential-duplicates.yml
vendored
Normal file
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
# Label name and color to set, when potential duplicates are detected
|
||||
issueLabel: "Potential duplicate"
|
||||
labelColor: e6e6e6
|
||||
|
||||
# If similarity is higher than this threshold, issue will be marked as duplicate
|
||||
threshold: 0.70
|
||||
|
||||
# Comment to post when potential duplicates are detected
|
||||
referenceComment: >
|
||||
Potential duplicates found:
|
||||
{{#issues}}
|
||||
- [#{{ number }}] {{ title }} ({{ accuracy }}%)
|
||||
{{/issues}}
|
150
.github/settings.yml
vendored
Normal file
150
.github/settings.yml
vendored
Normal file
|
@ -0,0 +1,150 @@
|
|||
---
|
||||
repository:
|
||||
description: "Z-Wave to MQTT - Community Hass.io Add-on for Home Assistant"
|
||||
homepage: https://addons.community
|
||||
topics: z-wave, zwave, openzwave, ozw, mqtt, gatewat, iot, hassio-addons, hassio, hass, home-assistant, homeassistant
|
||||
private: false
|
||||
has_issues: true
|
||||
has_projects: false
|
||||
has_wiki: false
|
||||
has_downloads: false
|
||||
default_branch: master
|
||||
allow_squash_merge: true
|
||||
allow_merge_commit: false
|
||||
allow_rebase_merge: true
|
||||
labels:
|
||||
# Priority labels
|
||||
- name: "Priority: Critical"
|
||||
color: ee0701
|
||||
description: "This should be dealt with ASAP. Not fixing this issue would be a serious error."
|
||||
- name: "Priority: High"
|
||||
color: b60205
|
||||
description: "After critical issues are fixed, these should be dealt with before any further issues."
|
||||
- name: "Priority: Medium"
|
||||
color: 0e8a16
|
||||
description: "This issue may be useful, and needs some attention."
|
||||
- name: "Priority: Low"
|
||||
color: e4ea8a
|
||||
description: "Nice addition, maybe... someday..."
|
||||
|
||||
# Type labels
|
||||
- name: "Type: Bug"
|
||||
color: ee0701
|
||||
description: "Inconsistencies or issues which will cause a problem for users or implementors."
|
||||
- name: "Type: Documentation"
|
||||
color: 0052cc
|
||||
description: "Solely about the documentation of the project."
|
||||
- name: "Type: Enhancement"
|
||||
color: 1d76db
|
||||
description: "Enhancement of the code, not introducing new features."
|
||||
- name: "Type: Feature"
|
||||
color: 0e8a16
|
||||
description: "New features or options."
|
||||
- name: "Type: Support"
|
||||
color: 5319e7
|
||||
description: "Marks an issue as an support ticket."
|
||||
- name: "Type: Discussion"
|
||||
color: d4c5f9
|
||||
description: "Marks an issue as an generic discussion ticket."
|
||||
- name: "Type: Maintaince"
|
||||
color: 2af79e
|
||||
description: "Generic maintaince tasks, e.g., package updates."
|
||||
|
||||
# Additional markers
|
||||
- name: "Security"
|
||||
color: ee0701
|
||||
description: "Marks an security issues that needs to be resolved asap."
|
||||
- name: "Idea"
|
||||
color: fef2c0
|
||||
description: "Marks an idea, which might be excepted and implemented."
|
||||
- name: "Incomplete"
|
||||
color: fef2c0
|
||||
description: "Marks an PR or issue that is missing information."
|
||||
- name: "Pull request"
|
||||
color: fbca04
|
||||
description: "There is an PR opened for this issue."
|
||||
- name: "Accepted"
|
||||
color: c2e0c6
|
||||
description: "This issue or PR has been accepted."
|
||||
- name: "Declined"
|
||||
color: f9d0c4
|
||||
description: "This issue or PR has been declined."
|
||||
- name: "Potential duplicate"
|
||||
color: e6e6e6
|
||||
description: "This issue has been automatically marked as a potential duplicate."
|
||||
|
||||
# Ongoing Status labels
|
||||
- name: "Status: Triage"
|
||||
color: fbca04
|
||||
description: "This issue needs to be triaged."
|
||||
- name: "Status: On hold"
|
||||
color: cccccc
|
||||
description: "Issue or PR that has been placed on hold for now."
|
||||
- name: "Status: In progress"
|
||||
color: fbca04
|
||||
description: "Issue is currently being resolved by a developer."
|
||||
- name: "Status: Stale"
|
||||
color: fef2c0
|
||||
description: "There has not been activity on this issue or PR for quite some time."
|
||||
- name: "Status: Awaiting response"
|
||||
color: fef2c0
|
||||
description: "Issue or PR awaits response from the creator."
|
||||
- name: "Status: Blocked"
|
||||
color: fef2c0
|
||||
description: "Progress on this issue is currently not possible."
|
||||
|
||||
# Closing status labels
|
||||
- name: "Closed: Known limitation"
|
||||
color: e6e6e6
|
||||
description: "Issue is closed, it is a known limitation."
|
||||
- name: "Closed: Expected behavior"
|
||||
color: e6e6e6
|
||||
description: "Issues is closed, it is expected behavior."
|
||||
- name: "Closed: Duplicate"
|
||||
color: e6e6e6
|
||||
description: "Issue is closed, duplicate of an existing issue."
|
||||
- name: "Closed: Invalid"
|
||||
color: e6e6e6
|
||||
description: "Issue is closed, marked as not a valid issue (e.g., an user error)."
|
||||
- name: "Closed: Wrong repository"
|
||||
color: e6e6e6
|
||||
description: "Issue is closed, was created in the wrong repository."
|
||||
- name: "Closed: Won't Fix"
|
||||
color: e6e6e6
|
||||
description: "Issue is closed, it won't be fixed."
|
||||
- name: "Closed: Done"
|
||||
color: c2e0c6
|
||||
description: "Issue closed, work on this issue has been marked complete."
|
||||
|
||||
# Others
|
||||
- name: "Beginner Friendly"
|
||||
color: 0e8a16
|
||||
description: "Good first issue for people wanting to contribute to the project."
|
||||
- name: "Help wanted"
|
||||
color: 0e8a16
|
||||
description: "We need some extra helping hands or expertise in order to resolve this."
|
||||
- name: "Hacktoberfest"
|
||||
description: "Issues/PRs are participating in the Hacktoberfest"
|
||||
color: fbca04
|
||||
|
||||
branches:
|
||||
- name: master
|
||||
protection:
|
||||
required_pull_request_reviews:
|
||||
# required_approving_review_count: 1
|
||||
dismiss_stale_reviews: true
|
||||
require_code_owner_reviews: true
|
||||
dismissal_restrictions:
|
||||
users: []
|
||||
teams:
|
||||
- Admins
|
||||
- Masters
|
||||
required_status_checks:
|
||||
strict: false
|
||||
contexts: []
|
||||
enforce_admins: false
|
||||
restrictions:
|
||||
users: []
|
||||
teams:
|
||||
- Admins
|
||||
- Masters
|
61
.github/stale.yml
vendored
Normal file
61
.github/stale.yml
vendored
Normal file
|
@ -0,0 +1,61 @@
|
|||
---
|
||||
# Configuration for probot-stale - https://github.com/probot/stale
|
||||
|
||||
# Number of days of inactivity before an Issue or Pull Request becomes stale
|
||||
daysUntilStale: 60
|
||||
|
||||
# Number of days of inactivity before a stale Issue or Pull Request is closed.
|
||||
# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
|
||||
daysUntilClose: 7
|
||||
|
||||
# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
|
||||
exemptLabels:
|
||||
- "Status: On hold"
|
||||
- "Status: In progress"
|
||||
- "Status: Awaiting response"
|
||||
- "Status: Blocked"
|
||||
- "Idea"
|
||||
- "Security"
|
||||
|
||||
# Set to true to ignore issues in a project (defaults to false)
|
||||
exemptProjects: false
|
||||
|
||||
# Set to true to ignore issues in a milestone (defaults to false)
|
||||
exemptMilestones: false
|
||||
|
||||
# Label to use when marking as stale
|
||||
staleLabel: "Status: Stale"
|
||||
|
||||
# Comment to post when marking as stale. Set to `false` to disable
|
||||
markComment: >
|
||||
This issue has been automatically marked as stale because it has not had
|
||||
recent activity. It will be closed if no further activity occurs. Thank you
|
||||
for your contributions.
|
||||
|
||||
# Comment to post when removing the stale label.
|
||||
# unmarkComment: >
|
||||
# Your comment here.
|
||||
unmarkComment: false
|
||||
|
||||
# Comment to post when closing a stale Issue or Pull Request.
|
||||
# closeComment: >
|
||||
# Your comment here.
|
||||
closeComment: false
|
||||
|
||||
# Limit the number of actions per hour, from 1-30. Default is 30
|
||||
limitPerRun: 30
|
||||
|
||||
# Limit to only `issues` or `pulls`
|
||||
only: issues
|
||||
|
||||
# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls':
|
||||
# pulls:
|
||||
# daysUntilStale: 30
|
||||
# markComment: >
|
||||
# This pull request has been automatically marked as stale because it has not had
|
||||
# recent activity. It will be closed if no further activity occurs. Thank you
|
||||
# for your contributions.
|
||||
|
||||
# issues:
|
||||
# exemptLabels:
|
||||
# - confirmed
|
22
.github/support.yml
vendored
Normal file
22
.github/support.yml
vendored
Normal file
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
# Configuration for support-requests - https://github.com/dessant/support-requests
|
||||
|
||||
# Label used to mark issues as support requests
|
||||
supportLabel: "Type: Support"
|
||||
|
||||
# Comment to post on issues marked as support requests. Add a link
|
||||
# to a support page, or set to `false` to disable
|
||||
supportComment: >
|
||||
:wave: We use the issue tracker exclusively for bug reports and feature requests.
|
||||
However, this issue appears to be a support request. Please use our
|
||||
support channels to get help with the project.
|
||||
|
||||
Head over to the
|
||||
[Home Assistant community forum](https://community.home-assistant.io/?u=frenck)
|
||||
or join our [Discord](https://discord.me/hassioaddons) chat.
|
||||
|
||||
# Close issues marked as support requests
|
||||
close: true
|
||||
|
||||
# Lock issues marked as support requests
|
||||
lock: false
|
0
.gitignore
vendored
Normal file
0
.gitignore
vendored
Normal file
15
.gitlab-ci.yml
Normal file
15
.gitlab-ci.yml
Normal file
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
include: https://raw.githubusercontent.com/hassio-addons/organization/master/gitlabci/addon.yml
|
||||
|
||||
variables:
|
||||
ADDON_GITHUB_REPO: "hassio-addons/addon-zwave2mqtt"
|
||||
ADDON_SLUG: "zwave2mqtt"
|
||||
ADDON_TARGET: "zwave2mqtt"
|
||||
|
||||
ADDON_LEGACY_TAGS: "true"
|
||||
|
||||
ADDON_AARCH64_BASE: "hassioaddons/base-aarch64:3.1.0"
|
||||
ADDON_AMD64_BASE: "hassioaddons/base-amd64:3.1.0"
|
||||
ADDON_ARMHF_BASE: "hassioaddons/base-armhf:3.1.0"
|
||||
ADDON_ARMV7_BASE: "hassioaddons/base-armv7:3.1.0"
|
||||
ADDON_I386_BASE: "hassioaddons/base-i386:3.1.0"
|
1
.mdlrc
Normal file
1
.mdlrc
Normal file
|
@ -0,0 +1 @@
|
|||
rules "~MD024"
|
66
.yamllint
Normal file
66
.yamllint
Normal file
|
@ -0,0 +1,66 @@
|
|||
---
|
||||
rules:
|
||||
braces:
|
||||
level: error
|
||||
min-spaces-inside: 0
|
||||
max-spaces-inside: 1
|
||||
min-spaces-inside-empty: -1
|
||||
max-spaces-inside-empty: -1
|
||||
brackets:
|
||||
level: error
|
||||
min-spaces-inside: 0
|
||||
max-spaces-inside: 0
|
||||
min-spaces-inside-empty: -1
|
||||
max-spaces-inside-empty: -1
|
||||
colons:
|
||||
level: error
|
||||
max-spaces-before: 0
|
||||
max-spaces-after: 1
|
||||
commas:
|
||||
level: error
|
||||
max-spaces-before: 0
|
||||
min-spaces-after: 1
|
||||
max-spaces-after: 1
|
||||
comments:
|
||||
level: error
|
||||
require-starting-space: true
|
||||
min-spaces-from-content: 2
|
||||
comments-indentation:
|
||||
level: error
|
||||
document-end:
|
||||
level: error
|
||||
present: false
|
||||
document-start:
|
||||
level: error
|
||||
present: true
|
||||
empty-lines:
|
||||
level: error
|
||||
max: 1
|
||||
max-start: 0
|
||||
max-end: 1
|
||||
hyphens:
|
||||
level: error
|
||||
max-spaces-after: 1
|
||||
indentation:
|
||||
level: error
|
||||
spaces: 2
|
||||
indent-sequences: true
|
||||
check-multi-line-strings: false
|
||||
key-duplicates:
|
||||
level: error
|
||||
line-length:
|
||||
ignore: |
|
||||
.github/support.yml
|
||||
level: warning
|
||||
max: 120
|
||||
allow-non-breakable-words: true
|
||||
allow-non-breakable-inline-mappings: true
|
||||
new-line-at-end-of-file:
|
||||
level: error
|
||||
new-lines:
|
||||
level: error
|
||||
type: unix
|
||||
trailing-spaces:
|
||||
level: error
|
||||
truthy:
|
||||
level: error
|
74
CODE_OF_CONDUCT.md
Normal file
74
CODE_OF_CONDUCT.md
Normal file
|
@ -0,0 +1,74 @@
|
|||
# Code of conduct
|
||||
|
||||
## Our pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, gender identity and expression, level of experience,
|
||||
nationality, personal appearance, race, religion, or sexual identity and
|
||||
orientation.
|
||||
|
||||
## Our standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
|
||||
- Using welcoming and inclusive language
|
||||
- Being respectful of differing viewpoints and experiences
|
||||
- Gracefully accepting constructive criticism
|
||||
- Focusing on what is best for the community
|
||||
- Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
- The use of sexualized language or imagery and unwelcome sexual attention
|
||||
or advances
|
||||
- Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
- Public or private harassment
|
||||
- Publishing others' private information, such as a physical or
|
||||
electronic address, without explicit permission
|
||||
- Other conduct which could reasonably be considered inappropriate
|
||||
in a professional setting
|
||||
|
||||
## Our responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community. Examples of
|
||||
representing a project or community include using an official project e-mail
|
||||
address, posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project lead at frenck@addons.community. All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is deemed necessary and appropriate to the circumstances. The project lead is
|
||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||
faith may face temporary or permanent repercussions as determined by other
|
||||
members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
|
||||
|
||||
[homepage]: http://contributor-covenant.org
|
||||
[version]: http://contributor-covenant.org/version/1/4/
|
29
CONTRIBUTING.md
Normal file
29
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,29 @@
|
|||
# Contributing
|
||||
|
||||
When contributing to this repository, please first discuss the change you wish
|
||||
to make via issue, email, or any other method with the owners of this repository
|
||||
before making a change.
|
||||
|
||||
Please note we have a code of conduct, please follow it in all your interactions
|
||||
with the project.
|
||||
|
||||
## Issues and feature requests
|
||||
|
||||
You've found a bug in the source code, a mistake in the documentation or maybe
|
||||
you'd like a new feature? You can help us by submitting an issue to our
|
||||
[GitHub Repository][github]. Before you create an issue, make sure you search
|
||||
the archive, maybe your question was already answered.
|
||||
|
||||
Even better: You could submit a pull request with a fix / new feature!
|
||||
|
||||
## Pull request process
|
||||
|
||||
1. Search our repository for open or closed [pull requests][prs] that relates
|
||||
to your submission. You don't want to duplicate effort.
|
||||
|
||||
1. You may merge the pull request in once you have the sign-off of two other
|
||||
developers, or if you do not have permission to do that, you may request
|
||||
the second reviewer to merge it for you.
|
||||
|
||||
[github]: https://github.com/hassio-addons/addon-zwave2mqtt/issues
|
||||
[prs]: https://github.com/hassio-addons/addon-zwave2mqtt/pulls
|
21
LICENSE.md
Normal file
21
LICENSE.md
Normal file
|
@ -0,0 +1,21 @@
|
|||
# MIT License
|
||||
|
||||
Copyright (c) 2019 Franck Nijhof
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
249
README.md
Normal file
249
README.md
Normal file
|
@ -0,0 +1,249 @@
|
|||
# Community Hass.io Add-ons: Z-Wave to MQTT
|
||||
|
||||
[![GitHub Release][releases-shield]][releases]
|
||||
![Project Stage][project-stage-shield]
|
||||
[![License][license-shield]](LICENSE.md)
|
||||
|
||||
![Supports armhf Architecture][armhf-shield]
|
||||
![Supports armv7 Architecture][armv7-shield]
|
||||
![Supports aarch64 Architecture][aarch64-shield]
|
||||
![Supports amd64 Architecture][amd64-shield]
|
||||
![Supports i386 Architecture][i386-shield]
|
||||
|
||||
[![GitLab CI][gitlabci-shield]][gitlabci]
|
||||
![Project Maintenance][maintenance-shield]
|
||||
[![GitHub Activity][commits-shield]][commits]
|
||||
|
||||
[![Discord][discord-shield]][discord]
|
||||
[![Community Forum][forum-shield]][forum]
|
||||
|
||||
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
|
||||
|
||||
[![Support my work on Patreon][patreon-shield]][patreon]
|
||||
|
||||
Fully configurable Z-Wave to MQTT gateway and control panel.
|
||||
|
||||
## About
|
||||
|
||||
The Z-Wave to MQTT add-on allows you to decouple your Z-Wave network from
|
||||
your Home Assistant instance by leveraging your MQTT broker. It ships with
|
||||
a web-based control panel, allowing you to configure every aspect of your
|
||||
Z-Wave network and how they are published in MQTT.
|
||||
|
||||
Some advantages and use-cases for this are:
|
||||
|
||||
- Your Z-Wave network will keep running between Home Assistant restarts.
|
||||
- You can directly use things like Node-RED with your Z-Wave network, while
|
||||
it is available for Home Assistant at the same time.
|
||||
- Allow [ESPHome.io][esphome] based ESP devices to directly respond or work
|
||||
with your Z-Wave network.
|
||||
|
||||
## Installation
|
||||
|
||||
The installation of this add-on is pretty straightforward and not different in
|
||||
comparison to installing any other Hass.io add-on.
|
||||
|
||||
1. [Add our Hass.io add-ons repository][repository] to your Hass.io instance.
|
||||
2. Install the "Z-Wave to MQTT" add-on.
|
||||
3. Start the "Z-Wave to MQTT" add-on
|
||||
4. Check the logs of the "Z-Wave to MQTT" add-on to see if everything went well.
|
||||
5. Click the "OPEN WEB UI" button.
|
||||
6. Enjoy the add-on!
|
||||
|
||||
**NOTE**: Do not add this repository to Hass.io, please use:
|
||||
`https://github.com/hassio-addons/repository`.
|
||||
|
||||
## Configuration
|
||||
|
||||
**Note**: _Remember to restart the add-on when the configuration is changed._
|
||||
|
||||
Example add-on configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"log_level": "info",
|
||||
"ssl": true,
|
||||
"certfile": "fullchain.pem",
|
||||
"keyfile": "privkey.pem"
|
||||
}
|
||||
```
|
||||
|
||||
**Note**: _This is just an example, don't copy and paste it! Create your own!_
|
||||
|
||||
### Option: `log_level`
|
||||
|
||||
The `log_level` option controls the level of log output by the addon and can
|
||||
be changed to be more or less verbose, which might be useful when you are
|
||||
dealing with an unknown issue. Possible values are:
|
||||
|
||||
- `trace`: Show every detail, like all called internal functions.
|
||||
- `debug`: Shows detailed debug information.
|
||||
- `info`: Normal (usually) interesting events.
|
||||
- `warning`: Exceptional occurrences that are not errors.
|
||||
- `error`: Runtime errors that do not require immediate action.
|
||||
- `fatal`: Something went terribly wrong. Add-on becomes unusable.
|
||||
|
||||
Please note that each level automatically includes log messages from a
|
||||
more severe level, e.g., `debug` also shows `info` messages. By default,
|
||||
the `log_level` is set to `info`, which is the recommended setting unless
|
||||
you are troubleshooting.
|
||||
|
||||
### Option: `ssl`
|
||||
|
||||
Enables/Disables SSL on the control panel. Set it `true` to enable it,
|
||||
`false` otherwise.
|
||||
|
||||
### Option: `certfile`
|
||||
|
||||
The certificate file to use for SSL.
|
||||
|
||||
**Note**: _The file MUST be stored in `/ssl/`, which is default for Hass.io._
|
||||
|
||||
### Option: `keyfile`
|
||||
|
||||
The private key file to use for SSL.
|
||||
|
||||
**Note**: _The file MUST be stored in `/ssl/`, which is default for Hass.io._
|
||||
|
||||
### Option: `leave_front_door_open`
|
||||
|
||||
Adding this option to the add-on configuration allows you to disable
|
||||
authentication on the add-on by setting it to `true` and leaving the
|
||||
username and password empty.
|
||||
|
||||
**Note**: _We STRONGLY suggest, not to use this, even if this add-on is
|
||||
only exposed to your internal network. USE AT YOUR OWN RISK!_
|
||||
|
||||
## Embedding into Home Assistant
|
||||
|
||||
It is possible to embed the Z-Wave to MQTT control panel web interface directly
|
||||
into Home Assistant, allowing you to access it through the Home Assistant
|
||||
frontend.
|
||||
|
||||
Home Assistant provides the `panel_iframe` component, for these purposes.
|
||||
|
||||
Example configuration:
|
||||
|
||||
```yaml
|
||||
panel_iframe:
|
||||
zwave2mqtt:
|
||||
title: Z-Wave to MQTT
|
||||
icon: mdi:z-wave
|
||||
url: http://addres.to.your.hass.io:8091
|
||||
```
|
||||
|
||||
## Known issues and limitations
|
||||
|
||||
- This add-on is currently unable to support Hass.io Ingress. This is due to
|
||||
technical limitations of the zwave2mqtt control panel web interface.
|
||||
|
||||
## Changelog & Releases
|
||||
|
||||
This repository keeps a change log using [GitHub's releases][releases]
|
||||
functionality. The format of the log is based on
|
||||
[Keep a Changelog][keepchangelog].
|
||||
|
||||
Releases are based on [Semantic Versioning][semver], and use the format
|
||||
of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented
|
||||
based on the following:
|
||||
|
||||
- ``MAJOR``: Incompatible or major changes.
|
||||
- ``MINOR``: Backwards-compatible new features and enhancements.
|
||||
- ``PATCH``: Backwards-compatible bugfixes and package updates.
|
||||
|
||||
## Support
|
||||
|
||||
Got questions?
|
||||
|
||||
You have several options to get them answered:
|
||||
|
||||
- The [Community Hass.io Add-ons Discord chat server][discord] for add-on
|
||||
support and feature requests.
|
||||
- The [Home Assistant Discord chat server][discord-ha] for general Home
|
||||
Assistant discussions and questions.
|
||||
- The Home Assistant [Community Forum][forum].
|
||||
- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]
|
||||
|
||||
You could also [open an issue here][issue] GitHub.
|
||||
|
||||
## Contributing
|
||||
|
||||
This is an active open-source project. We are always open to people who want to
|
||||
use the code or contribute to it.
|
||||
|
||||
We have set up a separate document containing our
|
||||
[contribution guidelines](CONTRIBUTING.md).
|
||||
|
||||
Thank you for being involved! :heart_eyes:
|
||||
|
||||
## Authors & contributors
|
||||
|
||||
The original setup of this repository is by [Franck Nijhof][frenck].
|
||||
|
||||
For a full list of all authors and contributors,
|
||||
check [the contributor's page][contributors].
|
||||
|
||||
## We have got some Hass.io add-ons for you
|
||||
|
||||
Want some more functionality to your Hass.io Home Assistant instance?
|
||||
|
||||
We have created multiple add-ons for Hass.io. For a full list, check out
|
||||
our [GitHub Repository][repository].
|
||||
|
||||
## License
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2019 Franck Nijhof
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
|
||||
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
|
||||
[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
|
||||
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
|
||||
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg
|
||||
[buymeacoffee]: https://www.buymeacoffee.com/frenck
|
||||
[commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/addon-zwave2mqtt.svg
|
||||
[commits]: https://github.com/hassio-addons/addon-zwave2mqtt/commits/master
|
||||
[contributors]: https://github.com/hassio-addons/addon-zwave2mqtt/graphs/contributors
|
||||
[discord-ha]: https://discord.gg/c5DvZ4e
|
||||
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
||||
[discord]: https://discord.me/hassioaddons
|
||||
[dockerhub]: https://hub.docker.com/r/hassioaddons/zwave2mqtt
|
||||
[esphome]: https://esphome.io/components/mqtt.html#on-message-trigger
|
||||
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
||||
[forum]: https://community.home-assistant.io/?u=frenck
|
||||
[frenck]: https://github.com/frenck
|
||||
[gitlabci-shield]: https://gitlab.com/hassio-addons/addon-zwave2mqtt/badges/master/pipeline.svg
|
||||
[gitlabci]: https://gitlab.com/hassio-addons/addon-zwave2mqtt/pipelines
|
||||
[home-assistant]: https://home-assistant.io
|
||||
[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
|
||||
[issue]: https://github.com/hassio-addons/addon-zwave2mqtt/issues
|
||||
[keepchangelog]: http://keepachangelog.com/en/1.0.0/
|
||||
[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-zwave2mqtt.svg
|
||||
[maintenance-shield]: https://img.shields.io/maintenance/yes/2019.svg
|
||||
[patreon-shield]: https://www.frenck.nl/images/patreon.png
|
||||
[patreon]: https://www.patreon.com/
|
||||
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
|
||||
[reddit]: https://reddit.com/r/homeassistant
|
||||
[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-zwave2mqtt.svg
|
||||
[releases]: https://github.com/hassio-addons/addon-zwave2mqtt/releases
|
||||
[repository]: https://github.com/hassio-addons/repository
|
||||
[semver]: http://semver.org/spec/v2.0.0.htm
|
11
renovate.json
Normal file
11
renovate.json
Normal file
|
@ -0,0 +1,11 @@
|
|||
{
|
||||
"extends": [
|
||||
"config:base"
|
||||
],
|
||||
"commitMessageAction": "Updates",
|
||||
"commitMessageTopic": "{{depName}}",
|
||||
"commitMessagePrefix": ":arrow_up:",
|
||||
"labels": [
|
||||
"Type: Maintaince"
|
||||
]
|
||||
}
|
83
zwave2mqtt/.README.j2
Normal file
83
zwave2mqtt/.README.j2
Normal file
|
@ -0,0 +1,83 @@
|
|||
# Community Hass.io Add-ons: Z-Wave to MQTT
|
||||
|
||||
[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]
|
||||
|
||||
[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum]
|
||||
|
||||
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
|
||||
|
||||
[![Support my work on Patreon][patreon-shield]][patreon]
|
||||
|
||||
Fully configurable Z-Wave to MQTT gateway and control panel.
|
||||
|
||||
## About
|
||||
|
||||
The Z-Wave to MQTT add-on allows you to decouple your Z-Wave network from
|
||||
your Home Assistant instance by leveraging your MQTT broker. It ships with
|
||||
a web-based control panel, allowing you to configure every aspect of your
|
||||
Z-Wave network and how they are published in MQTT.
|
||||
|
||||
Some advantages and use-cases for this are:
|
||||
|
||||
- Your Z-Wave network will keep running between Home Assistant restarts.
|
||||
- You can directly use things like Node-RED with your Z-Wave network, while
|
||||
it is available for Home Assistant at the same time.
|
||||
- Allow [ESPHome.io][esphome] based ESP devices to directly respond or work
|
||||
with your Z-Wave network.
|
||||
|
||||
[Click here for the full documentation][docs]
|
||||
|
||||
{% if channel == "edge" %}
|
||||
## WARNING! THIS IS AN EDGE VERSION!
|
||||
|
||||
This Hass.io Add-ons repository contains edge builds of add-ons. Edge builds
|
||||
add-ons are based upon the latest development version.
|
||||
|
||||
- They may not work at all.
|
||||
- They might stop working at any time.
|
||||
- They could have a negative impact on your system.
|
||||
|
||||
This repository was created for:
|
||||
|
||||
- Anybody willing to test.
|
||||
- Anybody interested in trying out upcoming add-ons or add-on features.
|
||||
- Developers.
|
||||
|
||||
If you are more interested in stable releases of our add-ons:
|
||||
|
||||
<https://github.com/hassio-addons/repository>
|
||||
|
||||
{% endif %}
|
||||
{% if channel == "beta" %}
|
||||
## WARNING! THIS IS A BETA VERSION!
|
||||
|
||||
This Hass.io Add-ons repository contains beta releases of add-ons.
|
||||
|
||||
- They might stop working at any time.
|
||||
- They could have a negative impact on your system.
|
||||
|
||||
This repository was created for:
|
||||
|
||||
- Anybody willing to test.
|
||||
- Anybody interested in trying out upcoming add-ons or add-on features.
|
||||
|
||||
If you are more interested in stable releases of our add-ons:
|
||||
|
||||
<https://github.com/hassio-addons/repository>
|
||||
|
||||
{% endif %}
|
||||
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg
|
||||
[buymeacoffee]: https://www.buymeacoffee.com/frenck
|
||||
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
||||
[discord]: https://discord.me/hassioaddons
|
||||
[docs]: {{ repo }}/blob/{{ version }}/README.md
|
||||
[esphome]: https://esphome.io/components/mqtt.html#on-message-trigger
|
||||
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
||||
[forum]: https://community.home-assistant.io/?u=frenck
|
||||
[maintenance-shield]: https://img.shields.io/maintenance/yes/2019.svg
|
||||
[patreon-shield]: https://www.frenck.nl/images/patreon.png
|
||||
[patreon]: https://www.patreon.com/frenck
|
||||
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
|
||||
[release-shield]: https://img.shields.io/badge/version-{{ version }}-blue.svg
|
||||
[release]: {{ repo }}/tree/{{ version }}
|
||||
[screenshot]: https://github.com/hassio-addons/addon-zwave2mqtt/raw/master/images/screenshot.gif
|
98
zwave2mqtt/Dockerfile
Executable file
98
zwave2mqtt/Dockerfile
Executable file
|
@ -0,0 +1,98 @@
|
|||
ARG BUILD_FROM=hassioaddons/base:3.1.0
|
||||
# hadolint ignore=DL3006
|
||||
FROM ${BUILD_FROM}
|
||||
|
||||
# Set shell
|
||||
SHELL ["/bin/bash", "-o", "pipefail", "-c"]
|
||||
|
||||
# Setup base
|
||||
# hadolint ignore=DL3003
|
||||
RUN \
|
||||
apk add --no-cache --virtual .build-dependencies \
|
||||
build-base=0.5-r1 \
|
||||
git=2.20.1-r0 \
|
||||
linux-headers=4.18.13-r1 \
|
||||
npm=10.14.2-r0 \
|
||||
openzwave-dev=1.4.164-r4 \
|
||||
python2-dev=2.7.16-r1 \
|
||||
yarn=1.12.3-r0 \
|
||||
\
|
||||
&& apk add --no-cache \
|
||||
eudev=3.2.7-r0 \
|
||||
libusb=1.0.22-r0 \
|
||||
lua-resty-http=0.13-r0 \
|
||||
nginx-mod-http-lua=1.14.2-r1 \
|
||||
nginx=1.14.2-r1 \
|
||||
nodejs=10.14.2-r0 \
|
||||
openssl=1.1.1b-r1 \
|
||||
openzwave=1.4.164-r4 \
|
||||
\
|
||||
&& curl -J -L -o /tmp/openzwave-db.tar.gz \
|
||||
"https://github.com/OpenZWave/open-zwave/archive/3d6374c831998595744cc34ef862a80ee51973c9.tar.gz" \
|
||||
&& mkdir /tmp/db \
|
||||
&& tar zxvf \
|
||||
/tmp/openzwave-db.tar.gz \
|
||||
--strip 1 -C /tmp/db \
|
||||
\
|
||||
&& mkdir /usr/etc \
|
||||
&& mv /tmp/db/config /usr/etc/openzwave \
|
||||
\
|
||||
&& curl -J -L -o /tmp/zwave2mqtt.tar.gz \
|
||||
"https://github.com/OpenZWave/Zwave2Mqtt/archive/1.0.0.tar.gz" \
|
||||
&& tar zxvf \
|
||||
/tmp/zwave2mqtt.tar.gz \
|
||||
--strip 1 -C /opt \
|
||||
\
|
||||
&& cd /opt \
|
||||
&& npm config set unsafe-perm \
|
||||
&& npm install \
|
||||
&& npm run build \
|
||||
&& npm prune --production \
|
||||
\
|
||||
&& yarn global add modclean \
|
||||
&& modclean \
|
||||
--path /opt \
|
||||
--no-progress \
|
||||
--keep-empty \
|
||||
--run \
|
||||
&& yarn global remove modclean \
|
||||
&& yarn cache clean \
|
||||
\
|
||||
&& apk del --purge .build-dependencies \
|
||||
\
|
||||
&& rm -f -r \
|
||||
/etc/nginx \
|
||||
/etc/openzwave \
|
||||
/root/.node-gyp \
|
||||
/root/.npm \
|
||||
/tmp/.[!.]* \
|
||||
/tmp/* \
|
||||
/usr/lib/node_modules \
|
||||
/usr/local/share/.cache
|
||||
|
||||
# Copy root filesystem
|
||||
COPY rootfs /
|
||||
|
||||
# Build arguments
|
||||
ARG BUILD_ARCH
|
||||
ARG BUILD_DATE
|
||||
ARG BUILD_REF
|
||||
ARG BUILD_VERSION
|
||||
|
||||
# Labels
|
||||
LABEL \
|
||||
io.hass.name="Z-Wave to MQTT" \
|
||||
io.hass.description="Fully configurable Z-Wave to MQTT gateway and control panel." \
|
||||
io.hass.arch="${BUILD_ARCH}" \
|
||||
io.hass.type="addon" \
|
||||
io.hass.version=${BUILD_VERSION} \
|
||||
maintainer="Franck Nijhof <frenck@addons.community>" \
|
||||
org.label-schema.description="Fully configurable Z-Wave to MQTT gateway and control panel." \
|
||||
org.label-schema.build-date=${BUILD_DATE} \
|
||||
org.label-schema.name="Z-Wave to MQTT" \
|
||||
org.label-schema.schema-version="1.0" \
|
||||
org.label-schema.url="https://community.home-assistant.io/?u=frenck" \
|
||||
org.label-schema.usage="https://github.com/hassio-addons/addon-zwave2mqtt/tree/master/README.md" \
|
||||
org.label-schema.vcs-ref=${BUILD_REF} \
|
||||
org.label-schema.vcs-url="https://github.com/hassio-addons/addon-zwave2mqtt" \
|
||||
org.label-schema.vendor="Community Hass.io Add-ons"
|
10
zwave2mqtt/build.json
Normal file
10
zwave2mqtt/build.json
Normal file
|
@ -0,0 +1,10 @@
|
|||
{
|
||||
"build_from": {
|
||||
"aarch64": "hassioaddons/base-aarch64:3.1.0",
|
||||
"amd64": "hassioaddons/base-amd64:3.1.0",
|
||||
"armhf": "hassioaddons/base-armhf:3.1.0",
|
||||
"armv7": "hassioaddons/base-armv7:3.1.0",
|
||||
"i386": "hassioaddons/base-i386:3.1.0"
|
||||
},
|
||||
"args": {}
|
||||
}
|
44
zwave2mqtt/config.json
Executable file
44
zwave2mqtt/config.json
Executable file
|
@ -0,0 +1,44 @@
|
|||
{
|
||||
"name": "Z-Wave to MQTT",
|
||||
"version": "dev",
|
||||
"slug": "zwave2mqtt",
|
||||
"description": "Fully configurable Z-Wave to MQTT gateway and control panel",
|
||||
"url": "https://github.com/hassio-addons/addon-zwave2mqtt",
|
||||
"webui": "http://[HOST]:[PORT:8091]",
|
||||
"startup": "system",
|
||||
"arch": [
|
||||
"aarch64",
|
||||
"amd64",
|
||||
"armhf",
|
||||
"armv7",
|
||||
"i386"
|
||||
],
|
||||
"ports": {
|
||||
"8091/tcp": 8091
|
||||
},
|
||||
"ports_description": {
|
||||
"8091/tcp": "Z-Wave to MQTT Control Panel"
|
||||
},
|
||||
"boot": "auto",
|
||||
"auth_api": true,
|
||||
"hassio_api": true,
|
||||
"hassio_role": "default",
|
||||
"auto_uart": true,
|
||||
"map": [
|
||||
"config:rw",
|
||||
"share:rw",
|
||||
"ssl:rw"
|
||||
],
|
||||
"options": {
|
||||
"ssl": true,
|
||||
"certfile": "fullchain.pem",
|
||||
"keyfile": "privkey.pem"
|
||||
},
|
||||
"schema": {
|
||||
"log_level": "match(^(trace|debug|info|notice|warning|error|fatal)$)?",
|
||||
"ssl": "bool",
|
||||
"certfile": "str",
|
||||
"keyfile": "str",
|
||||
"leave_front_door_open": "bool?"
|
||||
}
|
||||
}
|
21
zwave2mqtt/rootfs/etc/cont-init.d/nginx.sh
Normal file
21
zwave2mqtt/rootfs/etc/cont-init.d/nginx.sh
Normal file
|
@ -0,0 +1,21 @@
|
|||
#!/usr/bin/with-contenv bashio
|
||||
# ==============================================================================
|
||||
# Community Hass.io Add-ons: Z-Wave to MQTT
|
||||
# Configures NGINX for use with this add-on.
|
||||
# ==============================================================================
|
||||
declare certfile
|
||||
declare keyfile
|
||||
|
||||
bashio::config.require.ssl
|
||||
|
||||
if bashio::config.true 'ssl'; then
|
||||
certfile=$(bashio::config 'certfile')
|
||||
keyfile=$(bashio::config 'keyfile')
|
||||
|
||||
mv /etc/nginx/servers/direct-ssl.disabled /etc/nginx/servers/direct.conf
|
||||
sed -i "s/%%certfile%%/${certfile}/g" /etc/nginx/servers/direct.conf
|
||||
sed -i "s/%%keyfile%%/${keyfile}/g" /etc/nginx/servers/direct.conf
|
||||
|
||||
else
|
||||
mv /etc/nginx/servers/direct.disabled /etc/nginx/servers/direct.conf
|
||||
fi
|
9
zwave2mqtt/rootfs/etc/cont-init.d/zwave2mqtt.sh
Normal file
9
zwave2mqtt/rootfs/etc/cont-init.d/zwave2mqtt.sh
Normal file
|
@ -0,0 +1,9 @@
|
|||
#!/usr/bin/with-contenv bashio
|
||||
# ==============================================================================
|
||||
# Community Hass.io Add-ons: Z-Wave to MQTT
|
||||
# Lorem ipsum
|
||||
# ==============================================================================
|
||||
|
||||
# Ensure store is persistent
|
||||
rm -f -r /opt/store
|
||||
ln -s /data /opt/store
|
96
zwave2mqtt/rootfs/etc/nginx/includes/mime.types
Normal file
96
zwave2mqtt/rootfs/etc/nginx/includes/mime.types
Normal file
|
@ -0,0 +1,96 @@
|
|||
types {
|
||||
text/html html htm shtml;
|
||||
text/css css;
|
||||
text/xml xml;
|
||||
image/gif gif;
|
||||
image/jpeg jpeg jpg;
|
||||
application/javascript js;
|
||||
application/atom+xml atom;
|
||||
application/rss+xml rss;
|
||||
|
||||
text/mathml mml;
|
||||
text/plain txt;
|
||||
text/vnd.sun.j2me.app-descriptor jad;
|
||||
text/vnd.wap.wml wml;
|
||||
text/x-component htc;
|
||||
|
||||
image/png png;
|
||||
image/svg+xml svg svgz;
|
||||
image/tiff tif tiff;
|
||||
image/vnd.wap.wbmp wbmp;
|
||||
image/webp webp;
|
||||
image/x-icon ico;
|
||||
image/x-jng jng;
|
||||
image/x-ms-bmp bmp;
|
||||
|
||||
font/woff woff;
|
||||
font/woff2 woff2;
|
||||
|
||||
application/java-archive jar war ear;
|
||||
application/json json;
|
||||
application/mac-binhex40 hqx;
|
||||
application/msword doc;
|
||||
application/pdf pdf;
|
||||
application/postscript ps eps ai;
|
||||
application/rtf rtf;
|
||||
application/vnd.apple.mpegurl m3u8;
|
||||
application/vnd.google-earth.kml+xml kml;
|
||||
application/vnd.google-earth.kmz kmz;
|
||||
application/vnd.ms-excel xls;
|
||||
application/vnd.ms-fontobject eot;
|
||||
application/vnd.ms-powerpoint ppt;
|
||||
application/vnd.oasis.opendocument.graphics odg;
|
||||
application/vnd.oasis.opendocument.presentation odp;
|
||||
application/vnd.oasis.opendocument.spreadsheet ods;
|
||||
application/vnd.oasis.opendocument.text odt;
|
||||
application/vnd.openxmlformats-officedocument.presentationml.presentation
|
||||
pptx;
|
||||
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
|
||||
xlsx;
|
||||
application/vnd.openxmlformats-officedocument.wordprocessingml.document
|
||||
docx;
|
||||
application/vnd.wap.wmlc wmlc;
|
||||
application/x-7z-compressed 7z;
|
||||
application/x-cocoa cco;
|
||||
application/x-java-archive-diff jardiff;
|
||||
application/x-java-jnlp-file jnlp;
|
||||
application/x-makeself run;
|
||||
application/x-perl pl pm;
|
||||
application/x-pilot prc pdb;
|
||||
application/x-rar-compressed rar;
|
||||
application/x-redhat-package-manager rpm;
|
||||
application/x-sea sea;
|
||||
application/x-shockwave-flash swf;
|
||||
application/x-stuffit sit;
|
||||
application/x-tcl tcl tk;
|
||||
application/x-x509-ca-cert der pem crt;
|
||||
application/x-xpinstall xpi;
|
||||
application/xhtml+xml xhtml;
|
||||
application/xspf+xml xspf;
|
||||
application/zip zip;
|
||||
|
||||
application/octet-stream bin exe dll;
|
||||
application/octet-stream deb;
|
||||
application/octet-stream dmg;
|
||||
application/octet-stream iso img;
|
||||
application/octet-stream msi msp msm;
|
||||
|
||||
audio/midi mid midi kar;
|
||||
audio/mpeg mp3;
|
||||
audio/ogg ogg;
|
||||
audio/x-m4a m4a;
|
||||
audio/x-realaudio ra;
|
||||
|
||||
video/3gpp 3gpp 3gp;
|
||||
video/mp2t ts;
|
||||
video/mp4 mp4;
|
||||
video/mpeg mpeg mpg;
|
||||
video/quicktime mov;
|
||||
video/webm webm;
|
||||
video/x-flv flv;
|
||||
video/x-m4v m4v;
|
||||
video/x-mng mng;
|
||||
video/x-ms-asf asx asf;
|
||||
video/x-ms-wmv wmv;
|
||||
video/x-msvideo avi;
|
||||
}
|
15
zwave2mqtt/rootfs/etc/nginx/includes/proxy_params.conf
Normal file
15
zwave2mqtt/rootfs/etc/nginx/includes/proxy_params.conf
Normal file
|
@ -0,0 +1,15 @@
|
|||
proxy_http_version 1.1;
|
||||
proxy_ignore_client_abort off;
|
||||
proxy_read_timeout 86400s;
|
||||
proxy_redirect off;
|
||||
proxy_send_timeout 86400s;
|
||||
proxy_max_temp_file_size 0;
|
||||
|
||||
proxy_set_header Accept-Encoding "";
|
||||
proxy_set_header Connection $connection_upgrade;
|
||||
proxy_set_header Host $http_host;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
proxy_set_header X-NginX-Proxy true;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
1
zwave2mqtt/rootfs/etc/nginx/includes/resolver.conf
Normal file
1
zwave2mqtt/rootfs/etc/nginx/includes/resolver.conf
Normal file
|
@ -0,0 +1 @@
|
|||
resolver 172.30.32.2;
|
6
zwave2mqtt/rootfs/etc/nginx/includes/server_params.conf
Normal file
6
zwave2mqtt/rootfs/etc/nginx/includes/server_params.conf
Normal file
|
@ -0,0 +1,6 @@
|
|||
root /dev/null;
|
||||
server_name $hostname;
|
||||
|
||||
add_header X-Content-Type-Options nosniff;
|
||||
add_header X-XSS-Protection "1; mode=block";
|
||||
add_header X-Robots-Tag none;
|
9
zwave2mqtt/rootfs/etc/nginx/includes/ssl_params.conf
Normal file
9
zwave2mqtt/rootfs/etc/nginx/includes/ssl_params.conf
Normal file
|
@ -0,0 +1,9 @@
|
|||
ssl_protocols TLSv1.2;
|
||||
ssl_prefer_server_ciphers on;
|
||||
ssl_ciphers ECDHE-RSA-AES256-GCM-SHA512:DHE-RSA-AES256-GCM-SHA512:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:DHE-RSA-AES256-SHA;
|
||||
ssl_ecdh_curve secp384r1;
|
||||
ssl_session_timeout 10m;
|
||||
ssl_session_cache shared:SSL:10m;
|
||||
ssl_session_tickets off;
|
||||
ssl_stapling on;
|
||||
ssl_stapling_verify on;
|
3
zwave2mqtt/rootfs/etc/nginx/includes/upstream.conf
Normal file
3
zwave2mqtt/rootfs/etc/nginx/includes/upstream.conf
Normal file
|
@ -0,0 +1,3 @@
|
|||
upstream backend {
|
||||
server 127.0.0.1:44920;
|
||||
}
|
83
zwave2mqtt/rootfs/etc/nginx/lua/ha-auth.lua
Normal file
83
zwave2mqtt/rootfs/etc/nginx/lua/ha-auth.lua
Normal file
|
@ -0,0 +1,83 @@
|
|||
local http = require "resty.http"
|
||||
local auths = ngx.shared.auths
|
||||
|
||||
function authenticate()
|
||||
|
||||
--- Test Authentication header is set and with a value
|
||||
local header = ngx.req.get_headers()['Authorization']
|
||||
if header == nil or header:find(" ") == nil then
|
||||
return false
|
||||
end
|
||||
|
||||
local divider = header:find(' ')
|
||||
if header:sub(0, divider-1) ~= 'Basic' then
|
||||
return false
|
||||
end
|
||||
|
||||
local auth = ngx.decode_base64(header:sub(divider+1))
|
||||
if auth == nil or auth:find(':') == nil then
|
||||
return false
|
||||
end
|
||||
|
||||
divider = auth:find(':')
|
||||
local username = auth:sub(0, divider-1)
|
||||
local password = auth:sub(divider+1)
|
||||
|
||||
--- Check if authentication is cached
|
||||
if auths:get(username) == password then
|
||||
ngx.log(ngx.DEBUG, "Authenticated user against Home Assistant (cache).")
|
||||
return true
|
||||
end
|
||||
|
||||
--- HTTP request against Hassio API
|
||||
local httpc = http.new()
|
||||
local res, err = httpc:request_uri("http://hassio/auth", {
|
||||
method = "POST",
|
||||
body = ngx.encode_args({["username"]=username, ["password"]=password}),
|
||||
headers = {
|
||||
["Content-Type"] = "application/x-www-form-urlencoded",
|
||||
["X-HASSIO-KEY"] = os.getenv("HASSIO_TOKEN"),
|
||||
},
|
||||
keepalive_timeout = 60,
|
||||
keepalive_pool = 10
|
||||
})
|
||||
|
||||
--- Error during API request
|
||||
if err then
|
||||
ngx.log(ngx.WARN, "Error during Hassio user authentication.", err)
|
||||
return false
|
||||
end
|
||||
|
||||
--- No result? Something went wrong...
|
||||
if not res then
|
||||
ngx.log(ngx.WARN, "Error during Hassio user authentication.")
|
||||
return false
|
||||
end
|
||||
|
||||
--- Valid response, the username/password is valid
|
||||
if res.status == 200 then
|
||||
ngx.log(ngx.INFO, "Authenticated user against Home Assistant.")
|
||||
auths:set(username, password, 60)
|
||||
return true
|
||||
end
|
||||
|
||||
--- Whatever the response is, it is invalid
|
||||
ngx.log(ngx.WARN, "Authentication against Home Assistant failed!")
|
||||
return false
|
||||
end
|
||||
|
||||
-- Only authenticate if its not disabled
|
||||
if not os.getenv('DISABLE_HA_AUTHENTICATION') then
|
||||
|
||||
--- Try to authenticate against HA
|
||||
local authenticated = authenticate()
|
||||
|
||||
--- If authentication failed, throw a basic auth
|
||||
if not authenticated then
|
||||
ngx.header.content_type = 'text/plain'
|
||||
ngx.header.www_authenticate = 'Basic realm="Home Assistant"'
|
||||
ngx.status = ngx.HTTP_UNAUTHORIZED
|
||||
ngx.say('401 Access Denied')
|
||||
ngx.exit(ngx.HTTP_UNAUTHORIZED)
|
||||
end
|
||||
end
|
1
zwave2mqtt/rootfs/etc/nginx/modules/ndk_http.conf
Normal file
1
zwave2mqtt/rootfs/etc/nginx/modules/ndk_http.conf
Normal file
|
@ -0,0 +1 @@
|
|||
load_module "/usr/lib/nginx/modules/ndk_http_module.so";
|
1
zwave2mqtt/rootfs/etc/nginx/modules/ngx_http_lua.conf
Normal file
1
zwave2mqtt/rootfs/etc/nginx/modules/ngx_http_lua.conf
Normal file
|
@ -0,0 +1 @@
|
|||
load_module "/usr/lib/nginx/modules/ngx_http_lua_module.so";
|
59
zwave2mqtt/rootfs/etc/nginx/nginx.conf
Normal file
59
zwave2mqtt/rootfs/etc/nginx/nginx.conf
Normal file
|
@ -0,0 +1,59 @@
|
|||
# Run nginx in foreground.
|
||||
daemon off;
|
||||
|
||||
# This is run inside Docker.
|
||||
user root;
|
||||
|
||||
# Pid storage location.
|
||||
pid /var/run/nginx.pid;
|
||||
|
||||
# Set number of worker processes.
|
||||
worker_processes 1;
|
||||
|
||||
# Enables the use of JIT for regular expressions to speed-up their processing.
|
||||
pcre_jit on;
|
||||
|
||||
# Write error log to Hass.io add-on log.
|
||||
error_log /proc/1/fd/1 error;
|
||||
|
||||
# Load allowed environment vars
|
||||
env HASSIO_TOKEN;
|
||||
env DISABLE_HA_AUTHENTICATION;
|
||||
|
||||
# Load dynamic modules.
|
||||
include /etc/nginx/modules/*.conf;
|
||||
|
||||
# Max num of simultaneous connections by a worker process.
|
||||
events {
|
||||
worker_connections 512;
|
||||
}
|
||||
|
||||
http {
|
||||
include /etc/nginx/includes/mime.types;
|
||||
|
||||
log_format hassio '[$time_local] $status '
|
||||
'$http_x_forwarded_for($remote_addr) '
|
||||
'$request ($http_user_agent)';
|
||||
|
||||
access_log /proc/1/fd/1 hassio;
|
||||
client_max_body_size 4G;
|
||||
default_type application/octet-stream;
|
||||
gzip on;
|
||||
keepalive_timeout 65;
|
||||
lua_load_resty_core off;
|
||||
lua_shared_dict auths 16k;
|
||||
sendfile on;
|
||||
server_tokens off;
|
||||
tcp_nodelay on;
|
||||
tcp_nopush on;
|
||||
|
||||
map $http_upgrade $connection_upgrade {
|
||||
default upgrade;
|
||||
'' close;
|
||||
}
|
||||
|
||||
include /etc/nginx/includes/resolver.conf;
|
||||
include /etc/nginx/includes/upstream.conf;
|
||||
|
||||
include /etc/nginx/servers/*.conf;
|
||||
}
|
16
zwave2mqtt/rootfs/etc/nginx/servers/direct-ssl.disabled
Normal file
16
zwave2mqtt/rootfs/etc/nginx/servers/direct-ssl.disabled
Normal file
|
@ -0,0 +1,16 @@
|
|||
server {
|
||||
listen 8091 default_server ssl http2;
|
||||
|
||||
include /etc/nginx/includes/server_params.conf;
|
||||
include /etc/nginx/includes/ssl_params.conf;
|
||||
include /etc/nginx/includes/proxy_params.conf;
|
||||
|
||||
ssl on;
|
||||
ssl_certificate /ssl/%%certfile%%;
|
||||
ssl_certificate_key /ssl/%%keyfile%%;
|
||||
|
||||
location / {
|
||||
access_by_lua_file /etc/nginx/lua/ha-auth.lua;
|
||||
proxy_pass http://backend;
|
||||
}
|
||||
}
|
11
zwave2mqtt/rootfs/etc/nginx/servers/direct.disabled
Normal file
11
zwave2mqtt/rootfs/etc/nginx/servers/direct.disabled
Normal file
|
@ -0,0 +1,11 @@
|
|||
server {
|
||||
listen 8091 default_server;
|
||||
|
||||
include /etc/nginx/includes/server_params.conf;
|
||||
include /etc/nginx/includes/proxy_params.conf;
|
||||
|
||||
location / {
|
||||
access_by_lua_file /etc/nginx/lua/ha-auth.lua;
|
||||
proxy_pass http://backend;
|
||||
}
|
||||
}
|
9
zwave2mqtt/rootfs/etc/services.d/nginx/finish
Normal file
9
zwave2mqtt/rootfs/etc/services.d/nginx/finish
Normal file
|
@ -0,0 +1,9 @@
|
|||
#!/usr/bin/execlineb -S0
|
||||
# ==============================================================================
|
||||
# Community Hass.io Add-ons: Z-Wave to MQTT
|
||||
# Take down the S6 supervision tree when Nginx fails
|
||||
# ==============================================================================
|
||||
if -n { s6-test $# -ne 0 }
|
||||
if -n { s6-test ${1} -eq 256 }
|
||||
|
||||
s6-svscanctl -t /var/run/s6/services
|
17
zwave2mqtt/rootfs/etc/services.d/nginx/run
Normal file
17
zwave2mqtt/rootfs/etc/services.d/nginx/run
Normal file
|
@ -0,0 +1,17 @@
|
|||
#!/usr/bin/with-contenv bashio
|
||||
# ==============================================================================
|
||||
# Community Hass.io Add-ons: Z-Wave to MQTT
|
||||
# Runs the Nginx daemon
|
||||
# ==============================================================================
|
||||
|
||||
# Wait for zwave2mqtt to be available
|
||||
bashio::net.wait_for 44920
|
||||
|
||||
bashio::log.info "Starting NGinx..."
|
||||
|
||||
# Disable HA Authentication if front door is open
|
||||
if bashio::config.true 'leave_front_door_open'; then
|
||||
export DISABLE_HA_AUTHENTICATION=true
|
||||
fi
|
||||
|
||||
exec nginx
|
9
zwave2mqtt/rootfs/etc/services.d/zwave2mqtt/finish
Normal file
9
zwave2mqtt/rootfs/etc/services.d/zwave2mqtt/finish
Normal file
|
@ -0,0 +1,9 @@
|
|||
#!/usr/bin/execlineb -S0
|
||||
# ==============================================================================
|
||||
# Community Hass.io Add-ons: Z-Wave to MQTT
|
||||
# Take down the S6 supervision tree when zwave2mqtt fails
|
||||
# ==============================================================================
|
||||
if -n { s6-test $# -ne 0 }
|
||||
if -n { s6-test ${1} -eq 256 }
|
||||
|
||||
s6-svscanctl -t /var/run/s6/services
|
14
zwave2mqtt/rootfs/etc/services.d/zwave2mqtt/run
Executable file
14
zwave2mqtt/rootfs/etc/services.d/zwave2mqtt/run
Executable file
|
@ -0,0 +1,14 @@
|
|||
#!/usr/bin/with-contenv bashio
|
||||
# ==============================================================================
|
||||
# Community Hass.io Add-ons: Z-Wave to MQTT
|
||||
# Starts zwave2mqtt
|
||||
# ==============================================================================
|
||||
bashio::log.info "Starting the Z-Wave to MQTT..."
|
||||
|
||||
export NODE_ENV=production
|
||||
export PORT=44920
|
||||
|
||||
cd /opt/ \
|
||||
|| bashio::exit.nok "Could not change directory to application"
|
||||
|
||||
exec node bin/www
|
Loading…
Add table
Add a link
Reference in a new issue