Presence detection server for Happy Bubbles Bluetooth beacon-based presence detection system.
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.
The installation of this add-on is pretty straightforward and not different in comparison to installing any other Hass.io add-on.
- Add our Hass.io add-ons repository to your Hass.io instance.
- Install the "Happy Bubbles" add-on.
- Start the "Happy Bubbles" add-on
- Check the logs of the "Happy Bubbles" add-on to see if everything went well.
NOTE: Do not add this repository to Hass.io, please use:
https://github.com/hassio-addons/repository.
Note: Remember to restart the add-on when the configuration is changed.
Example add-on configuration:
{
"log_level": "info",
"ssl": false,
"certfile": "fullchain.pem",
"keyfile": "privkey.pem",
"ipv6": false,
"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!
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.
Enables/Disables SSL (HTTPS) on the web interface.
Set it true to enable it, false otherwise.
The certificate file to use for SSL.
Note: The file MUST be stored in /ssl/, which is the default for Hass.io
The private key file to use for SSL.
Note: The file MUST be stored in /ssl/, which is the default for Hass.io
Set this option to false to disable IPv6 support.
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
The port to connect to on the MQTT server, which normally is 1883.
The MQTT client ID of the Happy Bubbles presence server.
The username to use when connecting to the MQTT server.
Note: Leave empty in case no username is needed
The password to use when connecting to the MQTT server.
Note: Leave empty in case no password is needed
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 component, for these purposes.
Example configuration:
panel_iframe:
happybubbles:
title: Happy Bubbles
icon: mdi:bluetooth
url: http://addres.to.your.hass.io:5555This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.
Releases are based on Semantic Versioning, 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.
Got questions?
You have several options to get them answered:
- The Home Assistant Community Forum, we have a dedicated topic on that forum regarding this add-on.
- The Home Assistant Discord Chat Server for general Home Assistant discussions and questions.
- Join the Reddit subreddit in /r/homeassistant
You could also open an issue here GitHub.
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.
Thank you for being involved! 😍
The original setup of this repository is by Franck Nijhof.
For a full list of all authors and contributors, check the contributor's page.
Want some more functionality to your Hass.io Home Assistant instance?
We have created multiple add-ons for Hass.io. For a full list, check out our GitHub Repository.
MIT License
Copyright (c) 2018 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.