Skip to content

Bluetooth Low Energy powered room occupation detection for HomeKit.

License

Notifications You must be signed in to change notification settings

lukasmalkmus/homekit-ble-occupancy

Repository files navigation

HomeKit Bluetooth Low Energy Occupancy Detection

Go Workflow Coverage Status Go Report Latest Release License


Table of Contents

  1. Introduction
  2. Usage
  3. Contributing
  4. License

Introduction

HomeKit Bluetooth Low Energy Occupancy Detection utilizes Bluetooth Low Energy (BLE) to detect nearby devices and derive the occupancy status of a room from their presence and signal strength.

Installation

Download the pre-compiled and archived binary manually

Binary releases are available on GitHub Releases.

Install from source

$ git clone https://github.com/lukasmalkmus/homekit-ble-occupancy.git
$ cd homekit-ble-occupancy
$ make build

Usage

  1. Run without an argument to scan for nearby devices:
$ homekit-ble-occupancy
  1. Provide the device(s) to track plus their signal strength at which they are considered close:
$ homekit-ble-occupancy 3577d0ee-61da-445b-bcf1-704265437842+75

Contributing

Feel free to submit PRs or to fill issues. Every kind of help is appreciated.

Before committing, make should run without any issues.

License

© Lukas Malkmus, 2021

Distributed under MIT License (The MIT License).

See LICENSE for more information.