ha

homebridge-analytics

Monitor how much you're using your HomeKit devices via homebridge

Showing:

Popularity

Downloads/wk

3

GitHub Stars

8

Maintenance

Last Commit

5yrs ago

Contributors

1

Package

Dependencies

1

License

Type Definitions

Tree-Shakeable

No?

Categories

Readme

homebridge-analytics

https://github.com/neilgupta/homebridge-analytics/

This is a plugin for homebridge to monitor how much you're using your HomeKit devices.

HomeKit does not expose any native way to get alerted when your devices turn on or off, so homebridge-analytics creates fake switches for you that will write their state to a sqlite database whenever they are turned on or off. You can setup HomeKit triggers to toggle the corresponding fake switch whenever one of your devices is turned on or off. This is a sad hack, but it's the best we can do with HomeKit so far. Once you've done the manual setup, you can then query the sqlite database to see your usage history.

Installation

  1. Install homebridge (if not already installed) using: npm install -g homebridge
  2. Install this plugin using: npm install -g homebridge-analytics
  3. Update your configuration file. See below for a sample.

Configuration

"platforms": [
  {
    "platform": "Analytics",
    "suffix" : "Analytics", // suffix to append to all your fake switch names (default: "Analytics")
    "switchNames" : ["Kitchen", "Bar", "Living Room", "Foyer", "Closet", "Bedroom"]
  }
]

Usage

Once you have this plugin configured and running with homebridge, you'll find the analytics.db file in your homebridge's persist directory. You can query this database via the node repl like so:

var sqlite3 = require("sqlite3");

var db = new sqlite3.Database("path to analytics.db");

db.all("SELECT * FROM AccessoryUsage", function(err, rows) {
    // do something with rows
});

The AccessoryUsage table has 3 columns: name (text), state (int), updated (timestamp).

TODO

  • Add support for lights with brightness values rather than just binary switches
  • Push status change notifications to a remote db

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial