mirror of
https://github.com/mtan93/hass-addons.git
synced 2026-03-08 05:31:54 +00:00
123
This commit is contained in:
1
addon-example-main/.github/CODEOWNERS
vendored
Normal file
1
addon-example-main/.github/CODEOWNERS
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
.github/* @frenck
|
||||||
133
addon-example-main/.github/CODE_OF_CONDUCT.md
vendored
Normal file
133
addon-example-main/.github/CODE_OF_CONDUCT.md
vendored
Normal file
@@ -0,0 +1,133 @@
|
|||||||
|
# Contributor Covenant Code of Conduct
|
||||||
|
|
||||||
|
## Our Pledge
|
||||||
|
|
||||||
|
We as members, contributors, and leaders pledge to make participation in our
|
||||||
|
community a harassment-free experience for everyone, regardless of age, body
|
||||||
|
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||||
|
identity and expression, level of experience, education, socio-economic status,
|
||||||
|
nationality, personal appearance, race, religion, or sexual identity
|
||||||
|
and orientation.
|
||||||
|
|
||||||
|
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||||
|
diverse, inclusive, and healthy community.
|
||||||
|
|
||||||
|
## Our Standards
|
||||||
|
|
||||||
|
Examples of behavior that contributes to a positive environment for our
|
||||||
|
community include:
|
||||||
|
|
||||||
|
- Demonstrating empathy and kindness toward other people
|
||||||
|
- Being respectful of differing opinions, viewpoints, and experiences
|
||||||
|
- Giving and gracefully accepting constructive feedback
|
||||||
|
- Accepting responsibility and apologizing to those affected by our mistakes,
|
||||||
|
and learning from the experience
|
||||||
|
- Focusing on what is best not just for us as individuals, but for the
|
||||||
|
overall community
|
||||||
|
|
||||||
|
Examples of unacceptable behavior include:
|
||||||
|
|
||||||
|
- The use of sexualized language or imagery, and sexual attention or
|
||||||
|
advances of any kind
|
||||||
|
- Trolling, insulting or derogatory comments, and personal or political attacks
|
||||||
|
- Public or private harassment
|
||||||
|
- Publishing others' private information, such as a physical or email
|
||||||
|
address, without their explicit permission
|
||||||
|
- Other conduct which could reasonably be considered inappropriate in a
|
||||||
|
professional setting
|
||||||
|
|
||||||
|
## Enforcement Responsibilities
|
||||||
|
|
||||||
|
Community leaders are responsible for clarifying and enforcing our standards of
|
||||||
|
acceptable behavior and will take appropriate and fair corrective action in
|
||||||
|
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||||
|
or harmful.
|
||||||
|
|
||||||
|
Community leaders 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, and will communicate reasons for moderation
|
||||||
|
decisions when appropriate.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This Code of Conduct applies within all community spaces, and also applies when
|
||||||
|
an individual is officially representing the community in public spaces.
|
||||||
|
Examples of representing our community include using an official e-mail address,
|
||||||
|
posting via an official social media account, or acting as an appointed
|
||||||
|
representative at an online or offline event.
|
||||||
|
|
||||||
|
## Enforcement
|
||||||
|
|
||||||
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
|
reported to the community leaders responsible for enforcement at
|
||||||
|
frenck@frenck.dev.
|
||||||
|
|
||||||
|
All complaints will be reviewed and investigated promptly and fairly.
|
||||||
|
|
||||||
|
All community leaders are obligated to respect the privacy and security of the
|
||||||
|
reporter of any incident.
|
||||||
|
|
||||||
|
## Enforcement Guidelines
|
||||||
|
|
||||||
|
Community leaders will follow these Community Impact Guidelines in determining
|
||||||
|
the consequences for any action they deem in violation of this Code of Conduct:
|
||||||
|
|
||||||
|
### 1. Correction
|
||||||
|
|
||||||
|
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||||
|
unprofessional or unwelcome in the community.
|
||||||
|
|
||||||
|
**Consequence**: A private, written warning from community leaders, providing
|
||||||
|
clarity around the nature of the violation and an explanation of why the
|
||||||
|
behavior was inappropriate. A public apology may be requested.
|
||||||
|
|
||||||
|
### 2. Warning
|
||||||
|
|
||||||
|
**Community Impact**: A violation through a single incident or series
|
||||||
|
of actions.
|
||||||
|
|
||||||
|
**Consequence**: A warning with consequences for continued behavior. No
|
||||||
|
interaction with the people involved, including unsolicited interaction with
|
||||||
|
those enforcing the Code of Conduct, for a specified period of time. This
|
||||||
|
includes avoiding interactions in community spaces as well as external channels
|
||||||
|
like social media. Violating these terms may lead to a temporary or
|
||||||
|
permanent ban.
|
||||||
|
|
||||||
|
### 3. Temporary Ban
|
||||||
|
|
||||||
|
**Community Impact**: A serious violation of community standards, including
|
||||||
|
sustained inappropriate behavior.
|
||||||
|
|
||||||
|
**Consequence**: A temporary ban from any sort of interaction or public
|
||||||
|
communication with the community for a specified period of time. No public or
|
||||||
|
private interaction with the people involved, including unsolicited interaction
|
||||||
|
with those enforcing the Code of Conduct, is allowed during this period.
|
||||||
|
Violating these terms may lead to a permanent ban.
|
||||||
|
|
||||||
|
### 4. Permanent Ban
|
||||||
|
|
||||||
|
**Community Impact**: Demonstrating a pattern of violation of community
|
||||||
|
standards, including sustained inappropriate behavior, harassment of an
|
||||||
|
individual, or aggression toward or disparagement of classes of individuals.
|
||||||
|
|
||||||
|
**Consequence**: A permanent ban from any sort of public interaction within
|
||||||
|
the community.
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||||
|
version 2.0, available at
|
||||||
|
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
|
||||||
|
|
||||||
|
Community Impact Guidelines were inspired by
|
||||||
|
[Mozilla's code of conduct enforcement ladder][mozilla coc].
|
||||||
|
|
||||||
|
For answers to common questions about this code of conduct, see the FAQ at
|
||||||
|
[https://www.contributor-covenant.org/faq][faq]. Translations are available
|
||||||
|
at [https://www.contributor-covenant.org/translations][translations].
|
||||||
|
|
||||||
|
[homepage]: https://www.contributor-covenant.org
|
||||||
|
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
|
||||||
|
[mozilla coc]: https://github.com/mozilla/diversity
|
||||||
|
[faq]: https://www.contributor-covenant.org/faq
|
||||||
|
[translations]: https://www.contributor-covenant.org/translations
|
||||||
29
addon-example-main/.github/CONTRIBUTING.md
vendored
Normal file
29
addon-example-main/.github/CONTRIBUTING.md
vendored
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-example/issues
|
||||||
|
[prs]: https://github.com/hassio-addons/addon-example/pulls
|
||||||
4
addon-example-main/.github/FUNDING.yml
vendored
Normal file
4
addon-example-main/.github/FUNDING.yml
vendored
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
github: frenck
|
||||||
|
patreon: frenck
|
||||||
|
custom: https://frenck.dev/donate/
|
||||||
20
addon-example-main/.github/ISSUE_TEMPLATE.md
vendored
Executable file
20
addon-example-main/.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
addon-example-main/.github/PULL_REQUEST_TEMPLATE.md
vendored
Executable file
9
addon-example-main/.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/
|
||||||
1839
addon-example-main/.github/SECURITY.md
vendored
Normal file
1839
addon-example-main/.github/SECURITY.md
vendored
Normal file
File diff suppressed because it is too large
Load Diff
8
addon-example-main/.github/dependabot.yaml
vendored
Normal file
8
addon-example-main/.github/dependabot.yaml
vendored
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
---
|
||||||
|
version: 2
|
||||||
|
updates:
|
||||||
|
- package-ecosystem: "github-actions"
|
||||||
|
directory: "/"
|
||||||
|
schedule:
|
||||||
|
interval: daily
|
||||||
|
time: "06:00"
|
||||||
18
addon-example-main/.github/workflows/ci.yaml
vendored
Normal file
18
addon-example-main/.github/workflows/ci.yaml
vendored
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
---
|
||||||
|
name: CI
|
||||||
|
|
||||||
|
# yamllint disable-line rule:truthy
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
pull_request:
|
||||||
|
types:
|
||||||
|
- opened
|
||||||
|
- reopened
|
||||||
|
- synchronize
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
workflows:
|
||||||
|
uses: hassio-addons/workflows/.github/workflows/addon-ci.yaml@main
|
||||||
|
secrets:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
20
addon-example-main/.github/workflows/deploy.yaml
vendored
Normal file
20
addon-example-main/.github/workflows/deploy.yaml
vendored
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
name: Deploy
|
||||||
|
|
||||||
|
# yamllint disable-line rule:truthy
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types:
|
||||||
|
- published
|
||||||
|
workflow_run:
|
||||||
|
workflows: ["CI"]
|
||||||
|
branches: [main]
|
||||||
|
types:
|
||||||
|
- completed
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
workflows:
|
||||||
|
uses: hassio-addons/workflows/.github/workflows/addon-deploy.yaml@main
|
||||||
|
secrets:
|
||||||
|
DISPATCH_TOKEN: ${{ secrets.DISPATCH_TOKEN }}
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
14
addon-example-main/.github/workflows/labels.yaml
vendored
Normal file
14
addon-example-main/.github/workflows/labels.yaml
vendored
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
---
|
||||||
|
name: Sync labels
|
||||||
|
|
||||||
|
# yamllint disable-line rule:truthy
|
||||||
|
on:
|
||||||
|
schedule:
|
||||||
|
- cron: "34 5 * * *"
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
workflows:
|
||||||
|
uses: hassio-addons/workflows/.github/workflows/labels.yaml@main
|
||||||
|
secrets:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
14
addon-example-main/.github/workflows/lock.yaml
vendored
Normal file
14
addon-example-main/.github/workflows/lock.yaml
vendored
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
---
|
||||||
|
name: Lock
|
||||||
|
|
||||||
|
# yamllint disable-line rule:truthy
|
||||||
|
on:
|
||||||
|
schedule:
|
||||||
|
- cron: "0 9 * * *"
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
workflows:
|
||||||
|
uses: hassio-addons/workflows/.github/workflows/lock.yaml@main
|
||||||
|
secrets:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
17
addon-example-main/.github/workflows/pr-labels.yaml
vendored
Normal file
17
addon-example-main/.github/workflows/pr-labels.yaml
vendored
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
---
|
||||||
|
name: PR Labels
|
||||||
|
|
||||||
|
# yamllint disable-line rule:truthy
|
||||||
|
on:
|
||||||
|
pull_request_target:
|
||||||
|
types:
|
||||||
|
- opened
|
||||||
|
- labeled
|
||||||
|
- unlabeled
|
||||||
|
- synchronize
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
workflows:
|
||||||
|
uses: hassio-addons/workflows/.github/workflows/pr-labels.yaml@main
|
||||||
|
secrets:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
14
addon-example-main/.github/workflows/release-drafter.yaml
vendored
Normal file
14
addon-example-main/.github/workflows/release-drafter.yaml
vendored
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
---
|
||||||
|
name: Release Drafter
|
||||||
|
|
||||||
|
# yamllint disable-line rule:truthy
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
workflows:
|
||||||
|
uses: hassio-addons/workflows/.github/workflows/release-drafter.yaml@main
|
||||||
|
secrets:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
14
addon-example-main/.github/workflows/stale.yaml
vendored
Normal file
14
addon-example-main/.github/workflows/stale.yaml
vendored
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
---
|
||||||
|
name: Stale
|
||||||
|
|
||||||
|
# yamllint disable-line rule:truthy
|
||||||
|
on:
|
||||||
|
schedule:
|
||||||
|
- cron: "0 8 * * *"
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
workflows:
|
||||||
|
uses: hassio-addons/workflows/.github/workflows/stale.yaml@main
|
||||||
|
secrets:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
1
addon-example-main/.mdlrc
Normal file
1
addon-example-main/.mdlrc
Normal file
@@ -0,0 +1 @@
|
|||||||
|
rules "~MD024"
|
||||||
64
addon-example-main/.yamllint
Normal file
64
addon-example-main/.yamllint
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
---
|
||||||
|
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:
|
||||||
|
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
|
||||||
21
addon-example-main/LICENSE.md
Normal file
21
addon-example-main/LICENSE.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2017-2021 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.
|
||||||
136
addon-example-main/README.md
Normal file
136
addon-example-main/README.md
Normal file
@@ -0,0 +1,136 @@
|
|||||||
|
# Home Assistant Community Add-on: Example
|
||||||
|
|
||||||
|
[![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]
|
||||||
|
|
||||||
|
[![Github Actions][github-actions-shield]][github-actions]
|
||||||
|
![Project Maintenance][maintenance-shield]
|
||||||
|
[![GitHub Activity][commits-shield]][commits]
|
||||||
|
|
||||||
|
[![Discord][discord-shield]][discord]
|
||||||
|
[![Community Forum][forum-shield]][forum]
|
||||||
|
|
||||||
|
[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors]
|
||||||
|
|
||||||
|
[![Support Frenck on Patreon][patreon-shield]][patreon]
|
||||||
|
|
||||||
|
Example add-on by Community Home Assistant add-ons.
|
||||||
|
|
||||||
|
## About
|
||||||
|
|
||||||
|
This is an example add-on for Home Assistant. When started, it displays a
|
||||||
|
random quote every 5 seconds.
|
||||||
|
|
||||||
|
It shows off several features and structures like:
|
||||||
|
|
||||||
|
- Full blown GitHub repository.
|
||||||
|
- General Dockerfile structure and setup.
|
||||||
|
- The use of the `config.json` and `build.json` files.
|
||||||
|
- General structure on how to use S6 overlay with services.
|
||||||
|
- Basic usage of Bashio.
|
||||||
|
- Continuous integration and deployment using GitHub Actions.
|
||||||
|
- Deployment to the GitHub Container registry.
|
||||||
|
- Small use of the Bash function library in our base images.
|
||||||
|
- The use of Docker label schema.
|
||||||
|
|
||||||
|
[:books: Read the full add-on documentation][docs]
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
Got questions?
|
||||||
|
|
||||||
|
You have several options to get them answered:
|
||||||
|
|
||||||
|
- The [Home Assistant Community 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](.github/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 Home Assistant add-ons for you
|
||||||
|
|
||||||
|
Want some more functionality to your Home Assistant instance?
|
||||||
|
|
||||||
|
We have created multiple add-ons for Home Assistant. For a full list, check out
|
||||||
|
our [GitHub Repository][repository].
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2017-2021 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
|
||||||
|
[commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/addon-example.svg
|
||||||
|
[commits]: https://github.com/hassio-addons/addon-example/commits/main
|
||||||
|
[contributors]: https://github.com/hassio-addons/addon-example/graphs/contributors
|
||||||
|
[discord-ha]: https://discord.gg/c5DvZ4e
|
||||||
|
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
||||||
|
[discord]: https://discord.me/hassioaddons
|
||||||
|
[docs]: https://github.com/hassio-addons/addon-example/blob/main/example/DOCS.md
|
||||||
|
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
||||||
|
[forum]: https://community.home-assistant.io/t/repository-community-hass-io-add-ons/24705?u=frenck
|
||||||
|
[frenck]: https://github.com/frenck
|
||||||
|
[github-actions-shield]: https://github.com/hassio-addons/addon-example/workflows/CI/badge.svg
|
||||||
|
[github-actions]: https://github.com/hassio-addons/addon-example/actions
|
||||||
|
[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png
|
||||||
|
[github-sponsors]: https://github.com/sponsors/frenck
|
||||||
|
[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
|
||||||
|
[issue]: https://github.com/hassio-addons/addon-example/issues
|
||||||
|
[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-example.svg
|
||||||
|
[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg
|
||||||
|
[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
|
||||||
|
[patreon]: https://www.patreon.com/frenck
|
||||||
|
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
|
||||||
|
[reddit]: https://reddit.com/r/homeassistant
|
||||||
|
[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-example.svg
|
||||||
|
[releases]: https://github.com/hassio-addons/addon-example/releases
|
||||||
|
[repository]: https://github.com/hassio-addons/repository
|
||||||
80
addon-example-main/example/.README.j2
Normal file
80
addon-example-main/example/.README.j2
Normal file
@@ -0,0 +1,80 @@
|
|||||||
|
# Home Assistant Community Add-on: Example
|
||||||
|
|
||||||
|
[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]
|
||||||
|
|
||||||
|
[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum]
|
||||||
|
|
||||||
|
[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors]
|
||||||
|
|
||||||
|
[![Support Frenck on Patreon][patreon-shield]][patreon]
|
||||||
|
|
||||||
|
Example add-on by Community Home Assistant add-ons.
|
||||||
|
|
||||||
|
## About
|
||||||
|
|
||||||
|
This is an example add-on for Home Assistant. When started, it displays a
|
||||||
|
random quote every 5 seconds.
|
||||||
|
|
||||||
|
It shows off several features and structures like:
|
||||||
|
|
||||||
|
- Full blown GitHub repository.
|
||||||
|
- General Dockerfile structure and setup.
|
||||||
|
- The use of the `config.json` and `build.json` files.
|
||||||
|
- General shell scripting structure (`run.sh`).
|
||||||
|
- Quality assurance using CodeClimate.
|
||||||
|
- Continuous integration and deployment using GitLab.
|
||||||
|
- Usage of the Community Home Assistant Add-ons build environment.
|
||||||
|
- Small use of the Bash function library in our base images.
|
||||||
|
- The use of Docker label schema.
|
||||||
|
|
||||||
|
{% if channel == "edge" %}
|
||||||
|
## WARNING! THIS IS AN EDGE VERSION!
|
||||||
|
|
||||||
|
This Home Assistant 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 Home Assistant 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 %}
|
||||||
|
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
||||||
|
[discord]: https://discord.me/hassioaddons
|
||||||
|
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
||||||
|
[forum]: https://community.home-assistant.io?u=frenck
|
||||||
|
[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png
|
||||||
|
[github-sponsors]: https://github.com/sponsors/frenck
|
||||||
|
[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg
|
||||||
|
[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
|
||||||
|
[patreon]: https://www.patreon.com/frenck
|
||||||
|
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
|
||||||
|
[release-shield]: https://img.shields.io/badge/version-{{ version }}-blue.svg
|
||||||
|
[release]: {{ repo }}/tree/{{ version }}
|
||||||
132
addon-example-main/example/DOCS.md
Normal file
132
addon-example-main/example/DOCS.md
Normal file
@@ -0,0 +1,132 @@
|
|||||||
|
# Home Assistant Community Add-on: Example
|
||||||
|
|
||||||
|
This is an example add-on for Home Assistant. When started, it displays a
|
||||||
|
random quote every 5 seconds.
|
||||||
|
|
||||||
|
It shows off several features and structures like:
|
||||||
|
|
||||||
|
- Full blown GitHub repository.
|
||||||
|
- General Dockerfile structure and setup.
|
||||||
|
- The use of the `config.yaml` and `build.yaml` files.
|
||||||
|
- General shell scripting structure (`run.sh`).
|
||||||
|
- Quality assurance using CodeClimate.
|
||||||
|
- Continuous integration and deployment using GitLab.
|
||||||
|
- Usage of the Community Home Assistant Add-ons build environment.
|
||||||
|
- Small use of the Bash function library in our base images.
|
||||||
|
- The use of Docker label schema.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
The installation of this add-on is pretty straightforward and not different in
|
||||||
|
comparison to installing any other Home Assistant add-on.
|
||||||
|
|
||||||
|
1. Search for the "Example" add-on in the Supervisor add-on store and install it.
|
||||||
|
1. Start the "Example" add-on.
|
||||||
|
1. Check the logs of the "Example" add-on to see it in action.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
Eventought this add-on is just an example add-on, it does come with some
|
||||||
|
configuration options to play around with.
|
||||||
|
|
||||||
|
**Note**: _Remember to restart the add-on when the configuration is changed._
|
||||||
|
|
||||||
|
Example add-on configuration:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
log_level: info
|
||||||
|
seconds_between_quotes: 5
|
||||||
|
```
|
||||||
|
|
||||||
|
### Option: `log_level`
|
||||||
|
|
||||||
|
The `log_level` option controls the level of log output by the add-on 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: `seconds_between_quotes`
|
||||||
|
|
||||||
|
Sets the number of seconds between the output of each quote. The value
|
||||||
|
must be between `1` and `120` seconds. This value is set to `5` seconds by
|
||||||
|
default.
|
||||||
|
|
||||||
|
## Changelog & Releases
|
||||||
|
|
||||||
|
This repository keeps a change log using [GitHub's releases][releases]
|
||||||
|
functionality.
|
||||||
|
|
||||||
|
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 [Home Assistant Community 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.
|
||||||
|
|
||||||
|
## 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].
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2017-2021 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.
|
||||||
|
|
||||||
|
[contributors]: https://github.com/hassio-addons/addon-example/graphs/contributors
|
||||||
|
[discord-ha]: https://discord.gg/c5DvZ4e
|
||||||
|
[discord]: https://discord.me/hassioaddons
|
||||||
|
[forum]: https://community.home-assistant.io/t/repository-community-hass-io-add-ons/24705?u=frenck
|
||||||
|
[frenck]: https://github.com/frenck
|
||||||
|
[issue]: https://github.com/hassio-addons/addon-example/issues
|
||||||
|
[reddit]: https://reddit.com/r/homeassistant
|
||||||
|
[releases]: https://github.com/hassio-addons/addon-example/releases
|
||||||
|
[semver]: http://semver.org/spec/v2.0.0.html
|
||||||
40
addon-example-main/example/Dockerfile
Normal file
40
addon-example-main/example/Dockerfile
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
ARG BUILD_FROM=ghcr.io/hassio-addons/base/amd64:10.2.0
|
||||||
|
# hadolint ignore=DL3006
|
||||||
|
FROM ${BUILD_FROM}
|
||||||
|
|
||||||
|
# Copy root filesystem
|
||||||
|
COPY rootfs /
|
||||||
|
|
||||||
|
# Setup base
|
||||||
|
RUN apk add --no-cache \
|
||||||
|
coreutils=8.32-r2 \
|
||||||
|
wget=1.21.1-r1
|
||||||
|
|
||||||
|
# Build arguments
|
||||||
|
ARG BUILD_ARCH
|
||||||
|
ARG BUILD_DATE
|
||||||
|
ARG BUILD_DESCRIPTION
|
||||||
|
ARG BUILD_NAME
|
||||||
|
ARG BUILD_REF
|
||||||
|
ARG BUILD_REPOSITORY
|
||||||
|
ARG BUILD_VERSION
|
||||||
|
|
||||||
|
# Labels
|
||||||
|
LABEL \
|
||||||
|
io.hass.name="${BUILD_NAME}" \
|
||||||
|
io.hass.description="${BUILD_DESCRIPTION}" \
|
||||||
|
io.hass.arch="${BUILD_ARCH}" \
|
||||||
|
io.hass.type="addon" \
|
||||||
|
io.hass.version=${BUILD_VERSION} \
|
||||||
|
maintainer="Franck Nijhof <frenck@addons.community>" \
|
||||||
|
org.opencontainers.image.title="${BUILD_NAME}" \
|
||||||
|
org.opencontainers.image.description="${BUILD_DESCRIPTION}" \
|
||||||
|
org.opencontainers.image.vendor="Home Assistant Community Add-ons" \
|
||||||
|
org.opencontainers.image.authors="Franck Nijhof <frenck@addons.community>" \
|
||||||
|
org.opencontainers.image.licenses="MIT" \
|
||||||
|
org.opencontainers.image.url="https://addons.community" \
|
||||||
|
org.opencontainers.image.source="https://github.com/${BUILD_REPOSITORY}" \
|
||||||
|
org.opencontainers.image.documentation="https://github.com/${BUILD_REPOSITORY}/blob/main/README.md" \
|
||||||
|
org.opencontainers.image.created=${BUILD_DATE} \
|
||||||
|
org.opencontainers.image.revision=${BUILD_REF} \
|
||||||
|
org.opencontainers.image.version=${BUILD_VERSION}
|
||||||
7
addon-example-main/example/build.yaml
Normal file
7
addon-example-main/example/build.yaml
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
build_from:
|
||||||
|
aarch64: ghcr.io/hassio-addons/base/aarch64:10.2.0
|
||||||
|
amd64: ghcr.io/hassio-addons/base/amd64:10.2.0
|
||||||
|
armhf: ghcr.io/hassio-addons/base/armhf:10.2.0
|
||||||
|
armv7: ghcr.io/hassio-addons/base/armv7:10.2.0
|
||||||
|
i386: ghcr.io/hassio-addons/base/i386:10.2.0
|
||||||
19
addon-example-main/example/config.yaml
Normal file
19
addon-example-main/example/config.yaml
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
---
|
||||||
|
name: Example
|
||||||
|
version: dev
|
||||||
|
slug: example
|
||||||
|
description: Example add-on by Community Home Assistant Add-ons
|
||||||
|
url: https://github.com/hassio-addons/addon-example
|
||||||
|
init: false
|
||||||
|
arch:
|
||||||
|
- aarch64
|
||||||
|
- amd64
|
||||||
|
- armhf
|
||||||
|
- armv7
|
||||||
|
- i386
|
||||||
|
options:
|
||||||
|
log_level: info
|
||||||
|
seconds_between_quotes: 5
|
||||||
|
schema:
|
||||||
|
log_level: list(trace|debug|info|notice|warning|error|fatal)
|
||||||
|
seconds_between_quotes: int(1,120)
|
||||||
BIN
addon-example-main/example/icon.png
Normal file
BIN
addon-example-main/example/icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.9 KiB |
BIN
addon-example-main/example/logo.png
Normal file
BIN
addon-example-main/example/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 130 KiB |
@@ -0,0 +1,8 @@
|
|||||||
|
#!/usr/bin/execlineb -S0
|
||||||
|
# ==============================================================================
|
||||||
|
# Home Assistant Community Add-on: Example
|
||||||
|
# ==============================================================================
|
||||||
|
if -n { s6-test $# -ne 0 }
|
||||||
|
if -n { s6-test ${1} -eq 256 }
|
||||||
|
|
||||||
|
s6-svscanctl -t /var/run/s6/services
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
#!/usr/bin/with-contenv bashio
|
||||||
|
# ==============================================================================
|
||||||
|
# Home Assistant Community Add-on: Example
|
||||||
|
# Runs example1 script
|
||||||
|
# ==============================================================================
|
||||||
|
|
||||||
|
|
||||||
|
bashio::log.info "Starting Example1..."
|
||||||
|
|
||||||
|
exec /usr/bin/example1.sh
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
#!/usr/bin/execlineb -S0
|
||||||
|
# ==============================================================================
|
||||||
|
# Home Assistant Community Add-on: Example
|
||||||
|
# ==============================================================================
|
||||||
|
if -n { s6-test $# -ne 0 }
|
||||||
|
if -n { s6-test ${1} -eq 256 }
|
||||||
|
|
||||||
|
s6-svscanctl -t /var/run/s6/services
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
#!/usr/bin/with-contenv bashio
|
||||||
|
# ==============================================================================
|
||||||
|
# Home Assistant Community Add-on: Example
|
||||||
|
# Runs example2 script
|
||||||
|
# ==============================================================================
|
||||||
|
|
||||||
|
|
||||||
|
bashio::log.info "Starting Example2..."
|
||||||
|
|
||||||
|
exec /usr/bin/example2.sh
|
||||||
115
addon-example-main/example/rootfs/usr/bin/example1.sh
Executable file
115
addon-example-main/example/rootfs/usr/bin/example1.sh
Executable file
@@ -0,0 +1,115 @@
|
|||||||
|
#!/usr/bin/with-contenv bashio
|
||||||
|
# ==============================================================================
|
||||||
|
# Home Assistant Community Add-on: Example
|
||||||
|
#
|
||||||
|
# Example add-on for Home Assistant.
|
||||||
|
# This add-on displays a random quote every X seconds.
|
||||||
|
# ==============================================================================
|
||||||
|
|
||||||
|
# ------------------------------------------------------------------------------
|
||||||
|
# Get a random quote from quotationspage.com
|
||||||
|
#
|
||||||
|
# Arguments:
|
||||||
|
# None
|
||||||
|
# Returns:
|
||||||
|
# String with the quote
|
||||||
|
# ------------------------------------------------------------------------------
|
||||||
|
get_quote_online() {
|
||||||
|
local number
|
||||||
|
local html
|
||||||
|
local quote
|
||||||
|
|
||||||
|
bashio::log.trace "${FUNCNAME[0]}"
|
||||||
|
|
||||||
|
number=$(( ( RANDOM % 999 ) + 1 ))
|
||||||
|
html=$(wget -q -O - "http://www.quotationspage.com/quote/${number}.html")
|
||||||
|
|
||||||
|
quote=$(grep -e "<dt>" -e "</dd>" <<< "${html}" \
|
||||||
|
| awk -F'[<>]' '{
|
||||||
|
if($2 ~ /dt/)
|
||||||
|
{ print $3 }
|
||||||
|
else if($4 ~ /b/)
|
||||||
|
{ print "-- " $7 " n(" $19 ")"}
|
||||||
|
}'
|
||||||
|
)
|
||||||
|
|
||||||
|
echo "${quote}"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ------------------------------------------------------------------------------
|
||||||
|
# Get a random quote from a prefined set of quotes
|
||||||
|
#
|
||||||
|
# Arguments:
|
||||||
|
# None
|
||||||
|
# Returns:
|
||||||
|
# String with the quote
|
||||||
|
# ------------------------------------------------------------------------------
|
||||||
|
get_quote_offline() {
|
||||||
|
local -i number
|
||||||
|
local -a quotes
|
||||||
|
|
||||||
|
bashio::log.trace "${FUNCNAME[0]}"
|
||||||
|
|
||||||
|
quotes+=("Ever tried. Ever failed. No matter. Try Again. Fail again. Fail better.\\n -Samuel Beckett")
|
||||||
|
quotes+=("Never give up, for that is just the place and time that the tide will turn.\\n -Harriet Beecher Stowe")
|
||||||
|
quotes+=("Our greatest weakness lies in giving up. The most certain way to succeed is always to try just one more time.\\n -Thomas A. Edison")
|
||||||
|
quotes+=("Life isn't about getting and having, it's about giving and being.\\n -Kevin Kruse")
|
||||||
|
quotes+=("Strive not to be a success, but rather to be of value.\\n -Albert Einstein")
|
||||||
|
quotes+=("You miss 100% of the shots you don't take.\\n -Wayne Gretzky")
|
||||||
|
quotes+=("People who are unable to motivate themselves must be content with mediocrity, no matter how impressive their other talents. \\n -Andrew Carnegie")
|
||||||
|
quotes+=("Design is not just what it looks like and feels like. Design is how it works.\\n -Steve Jobs")
|
||||||
|
quotes+=("Only those who dare to fail greatly can ever achieve greatly.\\n -Robert F. Kennedy")
|
||||||
|
quotes+=("All our dreams can come true, if we have the courage to pursue them.\\n -Walt Disney")
|
||||||
|
quotes+=("Success consists of going from failure to failure without loss of enthusiasm.\\n -Winston Churchill")
|
||||||
|
|
||||||
|
number=$(( ( RANDOM % 11 ) + 1 ))
|
||||||
|
echo "${quotes[$number]}"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ------------------------------------------------------------------------------
|
||||||
|
# Displays a random quote
|
||||||
|
#
|
||||||
|
# Arguments:
|
||||||
|
# None
|
||||||
|
# Returns:
|
||||||
|
# String with the quote
|
||||||
|
# -----------------------------------------------------------------------------
|
||||||
|
display_quote() {
|
||||||
|
local quote
|
||||||
|
local timestamp
|
||||||
|
|
||||||
|
bashio::log.trace "${FUNCNAME[0]}"
|
||||||
|
|
||||||
|
if wget -q --spider http://www.quotationspage.com; then
|
||||||
|
quote=$(get_quote_online)
|
||||||
|
else
|
||||||
|
bashio::log.notice \
|
||||||
|
'Could not connect to quotationspage.com, using an offline quote'
|
||||||
|
quote=$(get_quote_offline)
|
||||||
|
fi
|
||||||
|
|
||||||
|
# shellcheck disable=SC2001
|
||||||
|
quote=$(sed 's/n()//g' <<< "${quote}" | xargs -0 echo | fmt -40)
|
||||||
|
timestamp=$(date +"%T")
|
||||||
|
|
||||||
|
bashio::log.info "Random quote loaded @ ${timestamp}"
|
||||||
|
echo -e "${quote}"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ==============================================================================
|
||||||
|
# RUN LOGIC
|
||||||
|
# ------------------------------------------------------------------------------
|
||||||
|
main() {
|
||||||
|
local sleep
|
||||||
|
|
||||||
|
bashio::log.trace "${FUNCNAME[0]}"
|
||||||
|
|
||||||
|
sleep=$(bashio::config 'seconds_between_quotes')
|
||||||
|
bashio::log.info "Seconds between each quotes is set to: ${sleep}"
|
||||||
|
|
||||||
|
while true; do
|
||||||
|
display_quote
|
||||||
|
sleep "${sleep}"
|
||||||
|
done
|
||||||
|
}
|
||||||
|
main "$@"
|
||||||
15
addon-example-main/example/rootfs/usr/bin/example2.sh
Executable file
15
addon-example-main/example/rootfs/usr/bin/example2.sh
Executable file
@@ -0,0 +1,15 @@
|
|||||||
|
#!/usr/bin/with-contenv bashio
|
||||||
|
# ==============================================================================
|
||||||
|
# Home Assistant Community Add-on: Example
|
||||||
|
#
|
||||||
|
# Example add-on for Home Assistant.
|
||||||
|
# ------------------------------------------------------------------------------
|
||||||
|
main() {
|
||||||
|
bashio::log.trace "${FUNCNAME[0]}"
|
||||||
|
|
||||||
|
while true; do
|
||||||
|
echo "Second Script Output"
|
||||||
|
sleep 10
|
||||||
|
done
|
||||||
|
}
|
||||||
|
main "$@"
|
||||||
10
addon-example-main/example/translations/en.yaml
Normal file
10
addon-example-main/example/translations/en.yaml
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
configuration:
|
||||||
|
log_level:
|
||||||
|
name: Log level
|
||||||
|
description: The amount of logging the add-on should do.
|
||||||
|
seconds_between_quotes:
|
||||||
|
name: Seconds between quotes
|
||||||
|
description: >-
|
||||||
|
The number of seconds the add-on waits until showing a new quote in the
|
||||||
|
add-on log.
|
||||||
BIN
unifi-cam-proxy-main/.DS_Store
vendored
Normal file
BIN
unifi-cam-proxy-main/.DS_Store
vendored
Normal file
Binary file not shown.
1
unifi-cam-proxy-main/.github/CODEOWNERS
vendored
Normal file
1
unifi-cam-proxy-main/.github/CODEOWNERS
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
.github/* @frenck
|
||||||
133
unifi-cam-proxy-main/.github/CODE_OF_CONDUCT.md
vendored
Normal file
133
unifi-cam-proxy-main/.github/CODE_OF_CONDUCT.md
vendored
Normal file
@@ -0,0 +1,133 @@
|
|||||||
|
# Contributor Covenant Code of Conduct
|
||||||
|
|
||||||
|
## Our Pledge
|
||||||
|
|
||||||
|
We as members, contributors, and leaders pledge to make participation in our
|
||||||
|
community a harassment-free experience for everyone, regardless of age, body
|
||||||
|
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||||
|
identity and expression, level of experience, education, socio-economic status,
|
||||||
|
nationality, personal appearance, race, religion, or sexual identity
|
||||||
|
and orientation.
|
||||||
|
|
||||||
|
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||||
|
diverse, inclusive, and healthy community.
|
||||||
|
|
||||||
|
## Our Standards
|
||||||
|
|
||||||
|
Examples of behavior that contributes to a positive environment for our
|
||||||
|
community include:
|
||||||
|
|
||||||
|
- Demonstrating empathy and kindness toward other people
|
||||||
|
- Being respectful of differing opinions, viewpoints, and experiences
|
||||||
|
- Giving and gracefully accepting constructive feedback
|
||||||
|
- Accepting responsibility and apologizing to those affected by our mistakes,
|
||||||
|
and learning from the experience
|
||||||
|
- Focusing on what is best not just for us as individuals, but for the
|
||||||
|
overall community
|
||||||
|
|
||||||
|
Examples of unacceptable behavior include:
|
||||||
|
|
||||||
|
- The use of sexualized language or imagery, and sexual attention or
|
||||||
|
advances of any kind
|
||||||
|
- Trolling, insulting or derogatory comments, and personal or political attacks
|
||||||
|
- Public or private harassment
|
||||||
|
- Publishing others' private information, such as a physical or email
|
||||||
|
address, without their explicit permission
|
||||||
|
- Other conduct which could reasonably be considered inappropriate in a
|
||||||
|
professional setting
|
||||||
|
|
||||||
|
## Enforcement Responsibilities
|
||||||
|
|
||||||
|
Community leaders are responsible for clarifying and enforcing our standards of
|
||||||
|
acceptable behavior and will take appropriate and fair corrective action in
|
||||||
|
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||||
|
or harmful.
|
||||||
|
|
||||||
|
Community leaders 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, and will communicate reasons for moderation
|
||||||
|
decisions when appropriate.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This Code of Conduct applies within all community spaces, and also applies when
|
||||||
|
an individual is officially representing the community in public spaces.
|
||||||
|
Examples of representing our community include using an official e-mail address,
|
||||||
|
posting via an official social media account, or acting as an appointed
|
||||||
|
representative at an online or offline event.
|
||||||
|
|
||||||
|
## Enforcement
|
||||||
|
|
||||||
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
|
reported to the community leaders responsible for enforcement at
|
||||||
|
frenck@frenck.dev.
|
||||||
|
|
||||||
|
All complaints will be reviewed and investigated promptly and fairly.
|
||||||
|
|
||||||
|
All community leaders are obligated to respect the privacy and security of the
|
||||||
|
reporter of any incident.
|
||||||
|
|
||||||
|
## Enforcement Guidelines
|
||||||
|
|
||||||
|
Community leaders will follow these Community Impact Guidelines in determining
|
||||||
|
the consequences for any action they deem in violation of this Code of Conduct:
|
||||||
|
|
||||||
|
### 1. Correction
|
||||||
|
|
||||||
|
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||||
|
unprofessional or unwelcome in the community.
|
||||||
|
|
||||||
|
**Consequence**: A private, written warning from community leaders, providing
|
||||||
|
clarity around the nature of the violation and an explanation of why the
|
||||||
|
behavior was inappropriate. A public apology may be requested.
|
||||||
|
|
||||||
|
### 2. Warning
|
||||||
|
|
||||||
|
**Community Impact**: A violation through a single incident or series
|
||||||
|
of actions.
|
||||||
|
|
||||||
|
**Consequence**: A warning with consequences for continued behavior. No
|
||||||
|
interaction with the people involved, including unsolicited interaction with
|
||||||
|
those enforcing the Code of Conduct, for a specified period of time. This
|
||||||
|
includes avoiding interactions in community spaces as well as external channels
|
||||||
|
like social media. Violating these terms may lead to a temporary or
|
||||||
|
permanent ban.
|
||||||
|
|
||||||
|
### 3. Temporary Ban
|
||||||
|
|
||||||
|
**Community Impact**: A serious violation of community standards, including
|
||||||
|
sustained inappropriate behavior.
|
||||||
|
|
||||||
|
**Consequence**: A temporary ban from any sort of interaction or public
|
||||||
|
communication with the community for a specified period of time. No public or
|
||||||
|
private interaction with the people involved, including unsolicited interaction
|
||||||
|
with those enforcing the Code of Conduct, is allowed during this period.
|
||||||
|
Violating these terms may lead to a permanent ban.
|
||||||
|
|
||||||
|
### 4. Permanent Ban
|
||||||
|
|
||||||
|
**Community Impact**: Demonstrating a pattern of violation of community
|
||||||
|
standards, including sustained inappropriate behavior, harassment of an
|
||||||
|
individual, or aggression toward or disparagement of classes of individuals.
|
||||||
|
|
||||||
|
**Consequence**: A permanent ban from any sort of public interaction within
|
||||||
|
the community.
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||||
|
version 2.0, available at
|
||||||
|
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
|
||||||
|
|
||||||
|
Community Impact Guidelines were inspired by
|
||||||
|
[Mozilla's code of conduct enforcement ladder][mozilla coc].
|
||||||
|
|
||||||
|
For answers to common questions about this code of conduct, see the FAQ at
|
||||||
|
[https://www.contributor-covenant.org/faq][faq]. Translations are available
|
||||||
|
at [https://www.contributor-covenant.org/translations][translations].
|
||||||
|
|
||||||
|
[homepage]: https://www.contributor-covenant.org
|
||||||
|
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
|
||||||
|
[mozilla coc]: https://github.com/mozilla/diversity
|
||||||
|
[faq]: https://www.contributor-covenant.org/faq
|
||||||
|
[translations]: https://www.contributor-covenant.org/translations
|
||||||
29
unifi-cam-proxy-main/.github/CONTRIBUTING.md
vendored
Normal file
29
unifi-cam-proxy-main/.github/CONTRIBUTING.md
vendored
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-example/issues
|
||||||
|
[prs]: https://github.com/hassio-addons/addon-example/pulls
|
||||||
4
unifi-cam-proxy-main/.github/FUNDING.yml
vendored
Normal file
4
unifi-cam-proxy-main/.github/FUNDING.yml
vendored
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
github: frenck
|
||||||
|
patreon: frenck
|
||||||
|
custom: https://frenck.dev/donate/
|
||||||
20
unifi-cam-proxy-main/.github/ISSUE_TEMPLATE.md
vendored
Executable file
20
unifi-cam-proxy-main/.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
unifi-cam-proxy-main/.github/PULL_REQUEST_TEMPLATE.md
vendored
Executable file
9
unifi-cam-proxy-main/.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/
|
||||||
1839
unifi-cam-proxy-main/.github/SECURITY.md
vendored
Normal file
1839
unifi-cam-proxy-main/.github/SECURITY.md
vendored
Normal file
File diff suppressed because it is too large
Load Diff
8
unifi-cam-proxy-main/.github/dependabot.yaml
vendored
Normal file
8
unifi-cam-proxy-main/.github/dependabot.yaml
vendored
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
---
|
||||||
|
version: 2
|
||||||
|
updates:
|
||||||
|
- package-ecosystem: "github-actions"
|
||||||
|
directory: "/"
|
||||||
|
schedule:
|
||||||
|
interval: daily
|
||||||
|
time: "06:00"
|
||||||
18
unifi-cam-proxy-main/.github/workflows/ci.yaml
vendored
Normal file
18
unifi-cam-proxy-main/.github/workflows/ci.yaml
vendored
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
---
|
||||||
|
name: CI
|
||||||
|
|
||||||
|
# yamllint disable-line rule:truthy
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
pull_request:
|
||||||
|
types:
|
||||||
|
- opened
|
||||||
|
- reopened
|
||||||
|
- synchronize
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
workflows:
|
||||||
|
uses: hassio-addons/workflows/.github/workflows/addon-ci.yaml@main
|
||||||
|
secrets:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
20
unifi-cam-proxy-main/.github/workflows/deploy.yaml
vendored
Normal file
20
unifi-cam-proxy-main/.github/workflows/deploy.yaml
vendored
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
name: Deploy
|
||||||
|
|
||||||
|
# yamllint disable-line rule:truthy
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types:
|
||||||
|
- published
|
||||||
|
workflow_run:
|
||||||
|
workflows: ["CI"]
|
||||||
|
branches: [main]
|
||||||
|
types:
|
||||||
|
- completed
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
workflows:
|
||||||
|
uses: hassio-addons/workflows/.github/workflows/addon-deploy.yaml@main
|
||||||
|
secrets:
|
||||||
|
DISPATCH_TOKEN: ${{ secrets.DISPATCH_TOKEN }}
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
14
unifi-cam-proxy-main/.github/workflows/labels.yaml
vendored
Normal file
14
unifi-cam-proxy-main/.github/workflows/labels.yaml
vendored
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
---
|
||||||
|
name: Sync labels
|
||||||
|
|
||||||
|
# yamllint disable-line rule:truthy
|
||||||
|
on:
|
||||||
|
schedule:
|
||||||
|
- cron: "34 5 * * *"
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
workflows:
|
||||||
|
uses: hassio-addons/workflows/.github/workflows/labels.yaml@main
|
||||||
|
secrets:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
14
unifi-cam-proxy-main/.github/workflows/lock.yaml
vendored
Normal file
14
unifi-cam-proxy-main/.github/workflows/lock.yaml
vendored
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
---
|
||||||
|
name: Lock
|
||||||
|
|
||||||
|
# yamllint disable-line rule:truthy
|
||||||
|
on:
|
||||||
|
schedule:
|
||||||
|
- cron: "0 9 * * *"
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
workflows:
|
||||||
|
uses: hassio-addons/workflows/.github/workflows/lock.yaml@main
|
||||||
|
secrets:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
17
unifi-cam-proxy-main/.github/workflows/pr-labels.yaml
vendored
Normal file
17
unifi-cam-proxy-main/.github/workflows/pr-labels.yaml
vendored
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
---
|
||||||
|
name: PR Labels
|
||||||
|
|
||||||
|
# yamllint disable-line rule:truthy
|
||||||
|
on:
|
||||||
|
pull_request_target:
|
||||||
|
types:
|
||||||
|
- opened
|
||||||
|
- labeled
|
||||||
|
- unlabeled
|
||||||
|
- synchronize
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
workflows:
|
||||||
|
uses: hassio-addons/workflows/.github/workflows/pr-labels.yaml@main
|
||||||
|
secrets:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
14
unifi-cam-proxy-main/.github/workflows/release-drafter.yaml
vendored
Normal file
14
unifi-cam-proxy-main/.github/workflows/release-drafter.yaml
vendored
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
---
|
||||||
|
name: Release Drafter
|
||||||
|
|
||||||
|
# yamllint disable-line rule:truthy
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
workflows:
|
||||||
|
uses: hassio-addons/workflows/.github/workflows/release-drafter.yaml@main
|
||||||
|
secrets:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
14
unifi-cam-proxy-main/.github/workflows/stale.yaml
vendored
Normal file
14
unifi-cam-proxy-main/.github/workflows/stale.yaml
vendored
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
---
|
||||||
|
name: Stale
|
||||||
|
|
||||||
|
# yamllint disable-line rule:truthy
|
||||||
|
on:
|
||||||
|
schedule:
|
||||||
|
- cron: "0 8 * * *"
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
workflows:
|
||||||
|
uses: hassio-addons/workflows/.github/workflows/stale.yaml@main
|
||||||
|
secrets:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
1
unifi-cam-proxy-main/.mdlrc
Normal file
1
unifi-cam-proxy-main/.mdlrc
Normal file
@@ -0,0 +1 @@
|
|||||||
|
rules "~MD024"
|
||||||
64
unifi-cam-proxy-main/.yamllint
Normal file
64
unifi-cam-proxy-main/.yamllint
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
---
|
||||||
|
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:
|
||||||
|
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
|
||||||
21
unifi-cam-proxy-main/LICENSE.md
Normal file
21
unifi-cam-proxy-main/LICENSE.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2017-2021 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.
|
||||||
136
unifi-cam-proxy-main/README.md
Normal file
136
unifi-cam-proxy-main/README.md
Normal file
@@ -0,0 +1,136 @@
|
|||||||
|
# Home Assistant Community Add-on: Example
|
||||||
|
|
||||||
|
[![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]
|
||||||
|
|
||||||
|
[![Github Actions][github-actions-shield]][github-actions]
|
||||||
|
![Project Maintenance][maintenance-shield]
|
||||||
|
[![GitHub Activity][commits-shield]][commits]
|
||||||
|
|
||||||
|
[![Discord][discord-shield]][discord]
|
||||||
|
[![Community Forum][forum-shield]][forum]
|
||||||
|
|
||||||
|
[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors]
|
||||||
|
|
||||||
|
[![Support Frenck on Patreon][patreon-shield]][patreon]
|
||||||
|
|
||||||
|
Example add-on by Community Home Assistant add-ons.
|
||||||
|
|
||||||
|
## About
|
||||||
|
|
||||||
|
This is an example add-on for Home Assistant. When started, it displays a
|
||||||
|
random quote every 5 seconds.
|
||||||
|
|
||||||
|
It shows off several features and structures like:
|
||||||
|
|
||||||
|
- Full blown GitHub repository.
|
||||||
|
- General Dockerfile structure and setup.
|
||||||
|
- The use of the `config.json` and `build.json` files.
|
||||||
|
- General structure on how to use S6 overlay with services.
|
||||||
|
- Basic usage of Bashio.
|
||||||
|
- Continuous integration and deployment using GitHub Actions.
|
||||||
|
- Deployment to the GitHub Container registry.
|
||||||
|
- Small use of the Bash function library in our base images.
|
||||||
|
- The use of Docker label schema.
|
||||||
|
|
||||||
|
[:books: Read the full add-on documentation][docs]
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
Got questions?
|
||||||
|
|
||||||
|
You have several options to get them answered:
|
||||||
|
|
||||||
|
- The [Home Assistant Community 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](.github/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 Home Assistant add-ons for you
|
||||||
|
|
||||||
|
Want some more functionality to your Home Assistant instance?
|
||||||
|
|
||||||
|
We have created multiple add-ons for Home Assistant. For a full list, check out
|
||||||
|
our [GitHub Repository][repository].
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2017-2021 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
|
||||||
|
[commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/addon-example.svg
|
||||||
|
[commits]: https://github.com/hassio-addons/addon-example/commits/main
|
||||||
|
[contributors]: https://github.com/hassio-addons/addon-example/graphs/contributors
|
||||||
|
[discord-ha]: https://discord.gg/c5DvZ4e
|
||||||
|
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
||||||
|
[discord]: https://discord.me/hassioaddons
|
||||||
|
[docs]: https://github.com/hassio-addons/addon-example/blob/main/example/DOCS.md
|
||||||
|
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
||||||
|
[forum]: https://community.home-assistant.io/t/repository-community-hass-io-add-ons/24705?u=frenck
|
||||||
|
[frenck]: https://github.com/frenck
|
||||||
|
[github-actions-shield]: https://github.com/hassio-addons/addon-example/workflows/CI/badge.svg
|
||||||
|
[github-actions]: https://github.com/hassio-addons/addon-example/actions
|
||||||
|
[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png
|
||||||
|
[github-sponsors]: https://github.com/sponsors/frenck
|
||||||
|
[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
|
||||||
|
[issue]: https://github.com/hassio-addons/addon-example/issues
|
||||||
|
[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-example.svg
|
||||||
|
[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg
|
||||||
|
[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
|
||||||
|
[patreon]: https://www.patreon.com/frenck
|
||||||
|
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
|
||||||
|
[reddit]: https://reddit.com/r/homeassistant
|
||||||
|
[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-example.svg
|
||||||
|
[releases]: https://github.com/hassio-addons/addon-example/releases
|
||||||
|
[repository]: https://github.com/hassio-addons/repository
|
||||||
BIN
unifi-cam-proxy-main/unifi-cam-proxy/.DS_Store
vendored
Normal file
BIN
unifi-cam-proxy-main/unifi-cam-proxy/.DS_Store
vendored
Normal file
Binary file not shown.
80
unifi-cam-proxy-main/unifi-cam-proxy/.README.j2
Normal file
80
unifi-cam-proxy-main/unifi-cam-proxy/.README.j2
Normal file
@@ -0,0 +1,80 @@
|
|||||||
|
# Home Assistant Community Add-on: Example
|
||||||
|
|
||||||
|
[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]
|
||||||
|
|
||||||
|
[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum]
|
||||||
|
|
||||||
|
[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors]
|
||||||
|
|
||||||
|
[![Support Frenck on Patreon][patreon-shield]][patreon]
|
||||||
|
|
||||||
|
Example add-on by Community Home Assistant add-ons.
|
||||||
|
|
||||||
|
## About
|
||||||
|
|
||||||
|
This is an example add-on for Home Assistant. When started, it displays a
|
||||||
|
random quote every 5 seconds.
|
||||||
|
|
||||||
|
It shows off several features and structures like:
|
||||||
|
|
||||||
|
- Full blown GitHub repository.
|
||||||
|
- General Dockerfile structure and setup.
|
||||||
|
- The use of the `config.json` and `build.json` files.
|
||||||
|
- General shell scripting structure (`run.sh`).
|
||||||
|
- Quality assurance using CodeClimate.
|
||||||
|
- Continuous integration and deployment using GitLab.
|
||||||
|
- Usage of the Community Home Assistant Add-ons build environment.
|
||||||
|
- Small use of the Bash function library in our base images.
|
||||||
|
- The use of Docker label schema.
|
||||||
|
|
||||||
|
{% if channel == "edge" %}
|
||||||
|
## WARNING! THIS IS AN EDGE VERSION!
|
||||||
|
|
||||||
|
This Home Assistant 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 Home Assistant 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 %}
|
||||||
|
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
||||||
|
[discord]: https://discord.me/hassioaddons
|
||||||
|
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
||||||
|
[forum]: https://community.home-assistant.io?u=frenck
|
||||||
|
[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png
|
||||||
|
[github-sponsors]: https://github.com/sponsors/frenck
|
||||||
|
[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg
|
||||||
|
[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
|
||||||
|
[patreon]: https://www.patreon.com/frenck
|
||||||
|
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
|
||||||
|
[release-shield]: https://img.shields.io/badge/version-{{ version }}-blue.svg
|
||||||
|
[release]: {{ repo }}/tree/{{ version }}
|
||||||
119
unifi-cam-proxy-main/unifi-cam-proxy/DOCS.md
Normal file
119
unifi-cam-proxy-main/unifi-cam-proxy/DOCS.md
Normal file
@@ -0,0 +1,119 @@
|
|||||||
|
# Home Assistant Community Add-on: Example
|
||||||
|
|
||||||
|
This is a work in progress
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
The installation of this add-on is pretty straightforward and not different in
|
||||||
|
comparison to installing any other Home Assistant add-on.
|
||||||
|
|
||||||
|
1. Search for the "Example" add-on in the Supervisor add-on store and install it.
|
||||||
|
1. Start the "Example" add-on.
|
||||||
|
1. Check the logs of the "Example" add-on to see it in action.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
Eventought this add-on is just an example add-on, it does come with some
|
||||||
|
configuration options to play around with.
|
||||||
|
|
||||||
|
**Note**: _Remember to restart the add-on when the configuration is changed._
|
||||||
|
|
||||||
|
Example add-on configuration:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
log_level: info
|
||||||
|
seconds_between_quotes: 5
|
||||||
|
```
|
||||||
|
|
||||||
|
### Option: `log_level`
|
||||||
|
|
||||||
|
The `log_level` option controls the level of log output by the add-on 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: `seconds_between_quotes`
|
||||||
|
|
||||||
|
Sets the number of seconds between the output of each quote. The value
|
||||||
|
must be between `1` and `120` seconds. This value is set to `5` seconds by
|
||||||
|
default.
|
||||||
|
|
||||||
|
## Changelog & Releases
|
||||||
|
|
||||||
|
This repository keeps a change log using [GitHub's releases][releases]
|
||||||
|
functionality.
|
||||||
|
|
||||||
|
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 [Home Assistant Community 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.
|
||||||
|
|
||||||
|
## 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].
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2017-2021 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.
|
||||||
|
|
||||||
|
[contributors]: https://github.com/hassio-addons/addon-example/graphs/contributors
|
||||||
|
[discord-ha]: https://discord.gg/c5DvZ4e
|
||||||
|
[discord]: https://discord.me/hassioaddons
|
||||||
|
[forum]: https://community.home-assistant.io/t/repository-community-hass-io-add-ons/24705?u=frenck
|
||||||
|
[frenck]: https://github.com/frenck
|
||||||
|
[issue]: https://github.com/hassio-addons/addon-example/issues
|
||||||
|
[reddit]: https://reddit.com/r/homeassistant
|
||||||
|
[releases]: https://github.com/hassio-addons/addon-example/releases
|
||||||
|
[semver]: http://semver.org/spec/v2.0.0.html
|
||||||
15
unifi-cam-proxy-main/unifi-cam-proxy/Dockerfile
Normal file
15
unifi-cam-proxy-main/unifi-cam-proxy/Dockerfile
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
FROM python:3.7
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
RUN apt-get -y update && apt-get install -y \
|
||||||
|
ffmpeg \
|
||||||
|
netcat-openbsd
|
||||||
|
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
RUN pip install .
|
||||||
|
|
||||||
|
COPY ./docker/entrypoint.sh /
|
||||||
|
|
||||||
|
ENTRYPOINT ["/entrypoint.sh"]
|
||||||
|
CMD ["unifi-cam-proxy"]
|
||||||
7
unifi-cam-proxy-main/unifi-cam-proxy/build.yaml
Normal file
7
unifi-cam-proxy-main/unifi-cam-proxy/build.yaml
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
build_from:
|
||||||
|
aarch64: ghcr.io/hassio-addons/base/aarch64:10.2.0
|
||||||
|
amd64: ghcr.io/hassio-addons/base/amd64:10.2.0
|
||||||
|
armhf: ghcr.io/hassio-addons/base/armhf:10.2.0
|
||||||
|
armv7: ghcr.io/hassio-addons/base/armv7:10.2.0
|
||||||
|
i386: ghcr.io/hassio-addons/base/i386:10.2.0
|
||||||
19
unifi-cam-proxy-main/unifi-cam-proxy/config.yaml
Normal file
19
unifi-cam-proxy-main/unifi-cam-proxy/config.yaml
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
---
|
||||||
|
name: Unifi Cam Proxy
|
||||||
|
version: 1.0
|
||||||
|
slug: unifi-cam-proxy
|
||||||
|
description: Testing version of unifi-cam-proxy.
|
||||||
|
url: https://github.com/mtan93/hass-addons/unifi-cam-proxy
|
||||||
|
init: false
|
||||||
|
arch:
|
||||||
|
- aarch64
|
||||||
|
- amd64
|
||||||
|
- armhf
|
||||||
|
- armv7
|
||||||
|
- i386
|
||||||
|
options:
|
||||||
|
log_level: info
|
||||||
|
seconds_between_quotes: 5
|
||||||
|
schema:
|
||||||
|
log_level: list(trace|debug|info|notice|warning|error|fatal)
|
||||||
|
seconds_between_quotes: int(1,120)
|
||||||
BIN
unifi-cam-proxy-main/unifi-cam-proxy/icon.png
Normal file
BIN
unifi-cam-proxy-main/unifi-cam-proxy/icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.9 KiB |
BIN
unifi-cam-proxy-main/unifi-cam-proxy/logo.png
Normal file
BIN
unifi-cam-proxy-main/unifi-cam-proxy/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 130 KiB |
@@ -0,0 +1,8 @@
|
|||||||
|
#!/usr/bin/execlineb -S0
|
||||||
|
# ==============================================================================
|
||||||
|
# Home Assistant Community Add-on: Example
|
||||||
|
# ==============================================================================
|
||||||
|
if -n { s6-test $# -ne 0 }
|
||||||
|
if -n { s6-test ${1} -eq 256 }
|
||||||
|
|
||||||
|
s6-svscanctl -t /var/run/s6/services
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
#!/usr/bin/with-contenv bashio
|
||||||
|
# ==============================================================================
|
||||||
|
# Home Assistant Community Add-on: Example
|
||||||
|
# Runs example1 script
|
||||||
|
# ==============================================================================
|
||||||
|
|
||||||
|
|
||||||
|
bashio::log.info "Starting Example1..."
|
||||||
|
|
||||||
|
exec /usr/bin/example1.sh
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
#!/usr/bin/execlineb -S0
|
||||||
|
# ==============================================================================
|
||||||
|
# Home Assistant Community Add-on: Example
|
||||||
|
# ==============================================================================
|
||||||
|
if -n { s6-test $# -ne 0 }
|
||||||
|
if -n { s6-test ${1} -eq 256 }
|
||||||
|
|
||||||
|
s6-svscanctl -t /var/run/s6/services
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
#!/usr/bin/with-contenv bashio
|
||||||
|
# ==============================================================================
|
||||||
|
# Home Assistant Community Add-on: Example
|
||||||
|
# Runs example2 script
|
||||||
|
# ==============================================================================
|
||||||
|
|
||||||
|
|
||||||
|
bashio::log.info "Starting Example2..."
|
||||||
|
|
||||||
|
exec /usr/bin/example2.sh
|
||||||
115
unifi-cam-proxy-main/unifi-cam-proxy/rootfs/usr/bin/example1.sh
Executable file
115
unifi-cam-proxy-main/unifi-cam-proxy/rootfs/usr/bin/example1.sh
Executable file
@@ -0,0 +1,115 @@
|
|||||||
|
#!/usr/bin/with-contenv bashio
|
||||||
|
# ==============================================================================
|
||||||
|
# Home Assistant Community Add-on: Example
|
||||||
|
#
|
||||||
|
# Example add-on for Home Assistant.
|
||||||
|
# This add-on displays a random quote every X seconds.
|
||||||
|
# ==============================================================================
|
||||||
|
|
||||||
|
# ------------------------------------------------------------------------------
|
||||||
|
# Get a random quote from quotationspage.com
|
||||||
|
#
|
||||||
|
# Arguments:
|
||||||
|
# None
|
||||||
|
# Returns:
|
||||||
|
# String with the quote
|
||||||
|
# ------------------------------------------------------------------------------
|
||||||
|
get_quote_online() {
|
||||||
|
local number
|
||||||
|
local html
|
||||||
|
local quote
|
||||||
|
|
||||||
|
bashio::log.trace "${FUNCNAME[0]}"
|
||||||
|
|
||||||
|
number=$(( ( RANDOM % 999 ) + 1 ))
|
||||||
|
html=$(wget -q -O - "http://www.quotationspage.com/quote/${number}.html")
|
||||||
|
|
||||||
|
quote=$(grep -e "<dt>" -e "</dd>" <<< "${html}" \
|
||||||
|
| awk -F'[<>]' '{
|
||||||
|
if($2 ~ /dt/)
|
||||||
|
{ print $3 }
|
||||||
|
else if($4 ~ /b/)
|
||||||
|
{ print "-- " $7 " n(" $19 ")"}
|
||||||
|
}'
|
||||||
|
)
|
||||||
|
|
||||||
|
echo "${quote}"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ------------------------------------------------------------------------------
|
||||||
|
# Get a random quote from a prefined set of quotes
|
||||||
|
#
|
||||||
|
# Arguments:
|
||||||
|
# None
|
||||||
|
# Returns:
|
||||||
|
# String with the quote
|
||||||
|
# ------------------------------------------------------------------------------
|
||||||
|
get_quote_offline() {
|
||||||
|
local -i number
|
||||||
|
local -a quotes
|
||||||
|
|
||||||
|
bashio::log.trace "${FUNCNAME[0]}"
|
||||||
|
|
||||||
|
quotes+=("Ever tried. Ever failed. No matter. Try Again. Fail again. Fail better.\\n -Samuel Beckett")
|
||||||
|
quotes+=("Never give up, for that is just the place and time that the tide will turn.\\n -Harriet Beecher Stowe")
|
||||||
|
quotes+=("Our greatest weakness lies in giving up. The most certain way to succeed is always to try just one more time.\\n -Thomas A. Edison")
|
||||||
|
quotes+=("Life isn't about getting and having, it's about giving and being.\\n -Kevin Kruse")
|
||||||
|
quotes+=("Strive not to be a success, but rather to be of value.\\n -Albert Einstein")
|
||||||
|
quotes+=("You miss 100% of the shots you don't take.\\n -Wayne Gretzky")
|
||||||
|
quotes+=("People who are unable to motivate themselves must be content with mediocrity, no matter how impressive their other talents. \\n -Andrew Carnegie")
|
||||||
|
quotes+=("Design is not just what it looks like and feels like. Design is how it works.\\n -Steve Jobs")
|
||||||
|
quotes+=("Only those who dare to fail greatly can ever achieve greatly.\\n -Robert F. Kennedy")
|
||||||
|
quotes+=("All our dreams can come true, if we have the courage to pursue them.\\n -Walt Disney")
|
||||||
|
quotes+=("Success consists of going from failure to failure without loss of enthusiasm.\\n -Winston Churchill")
|
||||||
|
|
||||||
|
number=$(( ( RANDOM % 11 ) + 1 ))
|
||||||
|
echo "${quotes[$number]}"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ------------------------------------------------------------------------------
|
||||||
|
# Displays a random quote
|
||||||
|
#
|
||||||
|
# Arguments:
|
||||||
|
# None
|
||||||
|
# Returns:
|
||||||
|
# String with the quote
|
||||||
|
# -----------------------------------------------------------------------------
|
||||||
|
display_quote() {
|
||||||
|
local quote
|
||||||
|
local timestamp
|
||||||
|
|
||||||
|
bashio::log.trace "${FUNCNAME[0]}"
|
||||||
|
|
||||||
|
if wget -q --spider http://www.quotationspage.com; then
|
||||||
|
quote=$(get_quote_online)
|
||||||
|
else
|
||||||
|
bashio::log.notice \
|
||||||
|
'Could not connect to quotationspage.com, using an offline quote'
|
||||||
|
quote=$(get_quote_offline)
|
||||||
|
fi
|
||||||
|
|
||||||
|
# shellcheck disable=SC2001
|
||||||
|
quote=$(sed 's/n()//g' <<< "${quote}" | xargs -0 echo | fmt -40)
|
||||||
|
timestamp=$(date +"%T")
|
||||||
|
|
||||||
|
bashio::log.info "Random quote loaded @ ${timestamp}"
|
||||||
|
echo -e "${quote}"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ==============================================================================
|
||||||
|
# RUN LOGIC
|
||||||
|
# ------------------------------------------------------------------------------
|
||||||
|
main() {
|
||||||
|
local sleep
|
||||||
|
|
||||||
|
bashio::log.trace "${FUNCNAME[0]}"
|
||||||
|
|
||||||
|
sleep=$(bashio::config 'seconds_between_quotes')
|
||||||
|
bashio::log.info "Seconds between each quotes is set to: ${sleep}"
|
||||||
|
|
||||||
|
while true; do
|
||||||
|
display_quote
|
||||||
|
sleep "${sleep}"
|
||||||
|
done
|
||||||
|
}
|
||||||
|
main "$@"
|
||||||
15
unifi-cam-proxy-main/unifi-cam-proxy/rootfs/usr/bin/example2.sh
Executable file
15
unifi-cam-proxy-main/unifi-cam-proxy/rootfs/usr/bin/example2.sh
Executable file
@@ -0,0 +1,15 @@
|
|||||||
|
#!/usr/bin/with-contenv bashio
|
||||||
|
# ==============================================================================
|
||||||
|
# Home Assistant Community Add-on: Example
|
||||||
|
#
|
||||||
|
# Example add-on for Home Assistant.
|
||||||
|
# ------------------------------------------------------------------------------
|
||||||
|
main() {
|
||||||
|
bashio::log.trace "${FUNCNAME[0]}"
|
||||||
|
|
||||||
|
while true; do
|
||||||
|
echo "Second Script Output"
|
||||||
|
sleep 10
|
||||||
|
done
|
||||||
|
}
|
||||||
|
main "$@"
|
||||||
10
unifi-cam-proxy-main/unifi-cam-proxy/translations/en.yaml
Normal file
10
unifi-cam-proxy-main/unifi-cam-proxy/translations/en.yaml
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
configuration:
|
||||||
|
log_level:
|
||||||
|
name: Log level
|
||||||
|
description: The amount of logging the add-on should do.
|
||||||
|
seconds_between_quotes:
|
||||||
|
name: Seconds between quotes
|
||||||
|
description: >-
|
||||||
|
The number of seconds the add-on waits until showing a new quote in the
|
||||||
|
add-on log.
|
||||||
Reference in New Issue
Block a user