StarkZarn/sense-collector
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages 1 Wiki Activity Actions
Sense Collector provides a way of collecting real-time data from the Sense Energy Monitor. Includes Grafana dashboards for visualizations of detected devices and smart plugs and their wattage, voltage, and amp utilization. https://labs.lux4rd0.com/sense-collector/
83 commits 1 branch 0 tags 3.6 MiB
  • Python 98.4%
  • Dockerfile 1.6%
Find a file
Exact
starkzarn 92be29d608
All checks were successful
build / build (push) Successful in 1m37s
Details
Chore: change build pipeline for new git forge
2026-03-14 09:56:29 -07:00
.forgejo/workflows Chore: change build pipeline for new git forge 2026-03-14 09:56:29 -07:00
grafana/shared Add files via upload 2024-06-22 12:31:05 -05:00
images Add files via upload 2021-07-18 21:27:54 -05:00
src Delete src/holder.txt 2024-06-27 11:19:37 -05:00
.dockerignore Refactor to uv for package management and runtime 2025-09-21 08:03:26 -07:00
.python-version Update python Docker tag to v3.14 2025-10-08 23:06:26 +00:00
docker-compose.yml point to new git forge 2026-03-14 09:56:16 -07:00
Dockerfile point to new git forge 2026-03-14 09:56:16 -07:00
LICENSE Create LICENSE 2024-06-24 20:48:29 -05:00
pyproject.toml Refactor to uv for package management and runtime 2025-09-21 08:03:26 -07:00
README.md Update README 2025-09-21 08:17:03 -07:00
renovate.json stage renovate 2025-09-21 08:16:56 -07:00
uv.lock Chore: bump deps 2026-03-14 09:55:51 -07:00

README.md

Sense Collector

Sense Collector Header

Sense Collector is a Python-based application deployed via Docker that collects data from the Sense energy monitoring system. It enables real-time energy monitoring through a set of pre-built, configurable Grafana dashboards, giving you powerful insights into your energy consumption patterns.

Change in this Fork:

  • Python package management
  • Docker image best practices
  • CI/CD Pipeline

Key Features

  • Data Collection: Automatically collects energy usage data from Sense energy monitors.
  • Grafana Dashboards: Pre-configured dashboards for visualizing device-specific and whole-home energy usage data.
  • InfluxDB Integration: Stores data in InfluxDB, offering a flexible and scalable way to manage energy metrics.
  • Easy Setup: Deployed quickly using Docker with minimal configuration.

Quick Start Guide

To get up and running with Sense Collector, you will need to:

  1. Ensure you have Docker, Docker Compose, InfluxDB 2.x, and Grafana installed.
  2. Pull the latest Sense Collector Docker image.
  3. Configure your environment variables for Sense API credentials and InfluxDB connection.

For complete setup instructions, including all the necessary environment variables and deployment configurations, please visit the Wiki.

Dashboards

Sense Collector includes several Grafana dashboards to help you monitor your energy usage:

  • Collector Info: Provides insights into the status and performance of Sense Collector.
  • Device Overview: Displays real-time wattage usage for individual devices.
  • Mains Overview: Shows household voltage, frequency, and power consumption.
  • Monitor & Detection: Visualizes Sense monitor detection status and Wi-Fi signal strength.

You can find detailed instructions on setting up and customizing these dashboards in the Grafana Dashboards section of the Wiki.

Configuration

Sense Collector uses a set of environment variables to control its behavior and integrate with the Sense API and InfluxDB. These variables must be configured before deploying the container. For a full list of required and optional variables, visit the Environment Variables page.

Support & Contact

Project Link: https://github.com/starkzarn/sense-collector

If you enjoy this version, consider a buying me a coffee! ko-fi

Acknowledgements