Limych / addon-presence-monitor

Hassio Add-on. Passive Bluetooth presence detection of beacons, cell phones, and other Bluetooth devices.
MIT License
55 stars 9 forks source link
ble bluetooth bluetooth-low-energy docker-image hass hassio hassio-addon home-assistant limych mqtt presence-detection presence-monitor

Please :star: this repo if you find it useful

Home Assistant Add-on: Bluetooth Presence Monitor

GitHub Release Project Stage License

Supports aarch64 Architecture Supports amd64 Architecture Supports armhf Architecture Supports armv7 Architecture Supports i386 Architecture

Travis CI Project Maintenance GitHub Activity

GitHub pull requests Bugs

Passive Bluetooth presence detection of beacons, cell phones, and other Bluetooth devices.

About

This add-on actually is a usage convenient shell for launching the Andrew J Freyer's monitor script on the same machine where the Home Assistant itself works. This script useful for MQTT-based home automation, especially when the script runs on multiple devices, distributed throughout a property.

Features

Add add-on to Hass.io

Go to "ADD-ON STORE" on Hass.io screen and add the https://github.com/Limych/hassio-addons to "Add new repository by URL".

After that Limych's add-ons should show under the title: Limych's Hass.io Add-ons

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other Hass.io add-on.

  1. Search for the "Bluetooth Presence Monitor" add-on in the group "Limych's Hass.io Add-ons" in the Hass.io add-on store and install it.
  2. Configure the add-on. Especially MQTT username and password options.
  3. Start the "Bluetooth Presence Monitor" add-on.
  4. Check the logs of the "Bluetooth Presence Monitor" add-on to see if everything went well.

* * *

I put a lot of work into making this repo and component available and updated to inspire and help others! I will be glad to receive thanks from you — it will give me new strength and add enthusiasm:


Patreon
or support via Bitcoin or Etherium:
Bitcoin
16yfCfz9dZ8y8yuSwBFVfiAa3CNYdMh7Ts

:books: Read the full add-on documentation

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.

Thank you for being involved! :heart_eyes:

Authors & contributors

The original setup of this add-on is by Andrey "Limych" Khrolenok.

For a full list of all authors and contributors, check the contributor's page.

License

MIT License

Copyright (c) 2019–2020 Andrey "Limych" Khrolenok

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.