diff --git a/README.md b/README.md index c55dd971..fbb89390 100644 --- a/README.md +++ b/README.md @@ -910,10 +910,10 @@ SOFTWARE. [grocy-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [grocy-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [grocy-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-happy-bubbles]: https://github.com/hassio-addons/addon-happy-bubbles/tree/v3.1.1 -[addon-doc-happy-bubbles]: https://github.com/hassio-addons/addon-happy-bubbles/blob/v3.1.1/README.md +[addon-happy-bubbles]: https://github.com/hassio-addons/addon-happy-bubbles/tree/v3.1.2 +[addon-doc-happy-bubbles]: https://github.com/hassio-addons/addon-happy-bubbles/blob/v3.1.2/README.md [happy-bubbles-issue]: https://github.com/hassio-addons/addon-happy-bubbles/issues -[happy-bubbles-version-shield]: https://img.shields.io/badge/version-v3.1.1-blue.svg +[happy-bubbles-version-shield]: https://img.shields.io/badge/version-v3.1.2-blue.svg [happy-bubbles-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/happy-bubbles-armhf.svg [happy-bubbles-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [happy-bubbles-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/happy-bubbles/CHANGELOG.md b/happy-bubbles/CHANGELOG.md index 5f9c1e40..7398faf2 100644 --- a/happy-bubbles/CHANGELOG.md +++ b/happy-bubbles/CHANGELOG.md @@ -4,11 +4,11 @@ This is a general maintenance release. ### 🔨 Changes -- :arrow_up: Upgrades add-on base image to v7.0.5 -- :arrow_up: Upgrades unzip to 6.0-r6 -- :hammer: Disable Docker init +- ⬆ Upgrades add-on base image to v7.2.0 +- 🔨 Implement OCI image specification on labels +- ✏ Split add-on documentation -[changelog]: https://github.com/hassio-addons/addon-happy-bubbles/compare/v3.1.0...v3.1.1 +[changelog]: https://github.com/hassio-addons/addon-happy-bubbles/compare/v3.1.1...v3.1.2 Questions? Join our Discord server! https://discord.me/hassioaddons Enjoying my add-ons? Consider supporting my work: diff --git a/happy-bubbles/DOCS.md b/happy-bubbles/DOCS.md new file mode 100644 index 00000000..e5f9d49f --- /dev/null +++ b/happy-bubbles/DOCS.md @@ -0,0 +1,201 @@ +# Home Assistant Community Add-on: Happy Bubbles + +This add-on is a server that subscribes to MQTT topics that the "Happy Bubbles" +Bluetooth Beacon Presence Detectors publish to. It checks to see which of the +detectors found the strongest signal for a particular beacon, and then lets +you access that info either over an API, or a web interface. + +It is designed to be used as a home-automation presence detection system. +If you install the detectors through-out a home and family members carry +beacons around the house, you can program your home automation hubs to +take certain actions depending on who entered or left certain rooms. + +This add-on also publishes changes in location to a particular topic. +So you can program your hub to listen for these and make the desired changes +as they happen, to not have to keep polling it. + +## 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 “Happy Bubbles” add-on in the Hass.io 166 add-on store + and install it. +1. Start the "Happy Bubbles" add-on +1. Check the logs of the "Happy Bubbles" add-on to see if everything went well. + +## Configuration + +**Note**: _Remember to restart the add-on when the configuration is changed._ + +Example add-on configuration: + +```yaml +log_level: info +ssl: false +certfile: fullchain.pem +keyfile: privkey.pem +mqtt_host: homeassistant +mqtt_port: 1883 +mqtt_client_id: happy_bubbles +mqtt_username: happybubbles +mqtt_password: dontworrybehappy + +``` + +**Note**: _This is just an example, don't copy and past it! Create your own!_ + +### Option: `log_level` + +The `log_level` option controls the level of log output by the addon and can +be changed to be more or less verbose, which might be useful when you are +dealing with an unknown issue. Possible values are: + +- `trace`: Show every detail, like all called internal functions. +- `debug`: Shows detailed debug information. +- `info`: Normal (usually) interesting events. +- `warning`: Exceptional occurrences that are not errors. +- `error`: Runtime errors that do not require immediate action. +- `fatal`: Something went terribly wrong. Add-on becomes unusable. + +Please note that each level automatically includes log messages from a +more severe level, e.g., `debug` also shows `info` messages. By default, +the `log_level` is set to `info`, which is the recommended setting unless +you are troubleshooting. + +### Option: `ssl` + +Enables/Disables SSL (HTTPS) on the web interface. +Set it `true` to enable it, `false` otherwise. + +**Note**: _The SSL settings only apply to direct access and has no effect +on the Ingress service._ + +### Option: `certfile` + +The certificate file to use for SSL. + +**Note**: _The file MUST be stored in `/ssl/`, which is the default_ + +### Option: `keyfile` + +The private key file to use for SSL. + +**Note**: _The file MUST be stored in `/ssl/`, which is the default_ + +### Option: `mqtt_host` + +The hostname or IP of the MQTT server to connect to. + +**Note**: _If you are using the core MQTT add-on, `homeassistant` should work +out of the box._ + +### Option: `mqtt_port` + +The port to connect to on the MQTT server, which normally is `1883`. + +### Option: `mqtt_client_id` + +The MQTT client ID of the Happy Bubbles presence server. + +**Note**: _This option support secrets, e.g., `!secret client_id`._ + +### Option: `mqtt_username` + +The username to use when connecting to the MQTT server. + +**Note**: _This option support secrets, e.g., `!secret mqtt_username`._ + +### Option: `mqtt_password` + +The password to use when connecting to the MQTT server. + +**Note**: _This option support secrets, e.g., `!secret mqtt_password`._ + +## Embedding into Home Assistant + +It is possible to embed the Happy Bubbles interface directly into +Home Assistant, allowing you to access it through the Home Assistant frontend. + +Home Assistant provides the `panel_iframe` integration, for these purposes. + +Example configuration: + +```yaml +panel_iframe: + happybubbles: + title: Happy Bubbles + icon: mdi:bluetooth + url: http://addres.to.your.hass.io:5555 +``` + +## Changelog & Releases + +This repository keeps a change log using [GitHub's releases][releases] +functionality. The format of the log is based on +[Keep a Changelog][keepchangelog]. + +Releases are based on [Semantic Versioning][semver], and use the format +of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented +based on the following: + +- ``MAJOR``: Incompatible or major changes. +- ``MINOR``: Backwards-compatible new features and enhancements. +- ``PATCH``: Backwards-compatible bugfixes and package updates. + +## Support + +Got questions? + +You have several options to get them answered: + +- The [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) 2018-2020 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-happy-bubbles/graphs/contributors +[discord-ha]: https://discord.gg/c5DvZ4e +[discord]: https://discord.me/hassioaddons +[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-happy-bubbles/53511?u=frenck +[frenck]: https://github.com/frenck +[issue]: https://github.com/hassio-addons/addon-happy-bubbles/issues +[keepchangelog]: http://keepachangelog.com/en/1.0.0/ +[reddit]: https://reddit.com/r/homeassistant +[releases]: https://github.com/hassio-addons/addon-happy-bubbles/releases +[semver]: http://semver.org/spec/v2.0.0.htm diff --git a/happy-bubbles/README.md b/happy-bubbles/README.md index 8359b390..8417d51f 100644 --- a/happy-bubbles/README.md +++ b/happy-bubbles/README.md @@ -27,11 +27,8 @@ This add-on also publishes changes in location to a particular topic. So you can program your hub to listen for these and make the desired changes as they happen, to not have to keep polling it. -[Click here for the full documentation][docs] - [discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord]: https://discord.me/hassioaddons -[docs]: https://github.com/hassio-addons/addon-happy-bubbles/blob/v3.1.1/README.md [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-happy-bubbles/53511?u=frenck [github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png @@ -40,5 +37,5 @@ as they happen, to not have to keep polling it. [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-v3.1.1-blue.svg -[release]: https://github.com/hassio-addons/addon-happy-bubbles/tree/v3.1.1 \ No newline at end of file +[release-shield]: https://img.shields.io/badge/version-v3.1.2-blue.svg +[release]: https://github.com/hassio-addons/addon-happy-bubbles/tree/v3.1.2 \ No newline at end of file diff --git a/happy-bubbles/config.json b/happy-bubbles/config.json index bfa239cf..ea0bb9eb 100644 --- a/happy-bubbles/config.json +++ b/happy-bubbles/config.json @@ -1,6 +1,6 @@ { "name": "Happy Bubbles", - "version": "3.1.1", + "version": "3.1.2", "slug": "happy-bubbles", "description": "Presence detection server for Happy Bubbles Bluetooth beacon-based presence detection system.", "url": "https://github.com/hassio-addons/addon-happy-bubbles",