Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lux4rd0/sense-collector

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://github.com/lux4rd0/sense-collector

dashboards docker energy-consumption energy-monitor grafana influxdb observability sense

Last synced: 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/lux4rd0/sense-collector
Owner: lux4rd0
License: apache-2.0
Created: 2021-07-09T05:21:12.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2021-07-23T04:23:55.000Z (over 3 years ago)
Last Synced: 2024-02-14T21:51:21.483Z (12 months ago)
Topics: dashboards, docker, energy-consumption, energy-monitor, grafana, influxdb, observability, sense
Language: Shell
Homepage: https://labs.lux4rd0.com/sense-collector/
Size: 3.34 MB
Stars: 23
Watchers: 3
Forks: 4
Open Issues: 12
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Sense Collector

![Sense Collector Header](https://labs.lux4rd0.com/wp-content/uploads/2021/07/sense_collector_header.png)

**Sense Collector** is a Python-based application deployed via Docker that collects data from the [Sense](https://sense.com/) 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.

## 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](https://github.com/lux4rd0/sense-collector/wiki/Getting-Started).

## 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](https://github.com/lux4rd0/sense-collector/wiki/Grafana-Dashboards) 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](https://github.com/lux4rd0/sense-collector/wiki/Environment-Variables).

## Support & Contact

If you have any questions or need support, feel free to reach out:

- **Dave Schmid**: [@lux4rd0](https://twitter.com/lux4rd0)
- **Email**: [email protected]

Project Link: [https://github.com/lux4rd0/sense-collector](https://github.com/lux4rd0/sense-collector)

## Acknowledgements

- [Grafana Labs](https://grafana.com/)
- [InfluxData](https://www.influxdata.com/)
- [Sense Labs](https://sense.com/)