140 lines
5.3 KiB
Markdown
140 lines
5.3 KiB
Markdown
|
# 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. Click the Home Assistant My button below to open the add-on on your Home
|
||
|
|
Assistant instance.
|
||
|
|
|
||
|
|
[![Open this add-on in your Home Assistant instance.][addon-badge]][addon]
|
||
|
|
|
||
|
|
1. Click the "Install" button to install the add-on.
|
||
|
|
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-2024 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.
|
||
|
|
|
||
|
|
[addon-badge]: https://my.home-assistant.io/badges/supervisor_addon.svg
|
||
|
|
[addon]: https://my.home-assistant.io/redirect/supervisor_addon/?addon=a0d7b954_example&repository_url=https%3A%2F%2Fgithub.com%2Fhassio-addons%2Frepository
|
||
|
|
[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
|