greeneye_monitor

What it is and what it does

greeneye-monitor is a Python library for receiving and parsing binary data packets from GreenEye Monitor energy meters. It exposes a layered API: low-level packet parsing (greeneye.packets), stream processing (greeneye.streams), or higher-level monitor state tracking (greeneye.monitor) for single or multiple devices. The library computes rate-of-change metrics (Watts, pulses/sec) alongside cumulative totals, making it suitable for integration into home automation systems, energy dashboards, or data pipelines.

The package is designed as a data-collection layer, not a standalone application—it provides no built-in storage, visualization, or external integrations. You configure your GreenEye Monitor to send binary packets to your computer, then use greeneye-monitor to parse and act on that stream. It depends on aiohttp for async networking and siobrultech-protocols for packet format definitions.

Use it for:

• Integrate real-time energy consumption data from a GreenEye Monitor into a home automation platform or custom monitoring dashboard.
• Stream GreenEye Monitor packets into a time-series database for historical energy analysis and reporting.
• Monitor multiple GreenEye Monitor devices simultaneously and aggregate power consumption across different circuits or buildings.
• Compute instantaneous power draw and rate-of-change metrics for demand-response or load-shedding logic.
• Build a custom energy alerting system that triggers actions when power usage exceeds thresholds.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Parses and processes binary data packets from GreenEye Monitor energy meters, providing APIs to handle individual packets, streams, or monitor state across multiple devices.

Yes, if you own a GreenEye Monitor and need to integrate its data into a Python application. The library is stable, has no known vulnerabilities, and supports current Python versions (3.10, 3.11, 3.12). However, dormant maintenance (no updates in 908 days) means you should not expect bug fixes or feature additions; evaluate whether the existing API meets your needs before committing.

Install

greeneye-monitor on PyPI

pip install greeneye-monitor

uv add greeneye-monitor

poetry add greeneye-monitor

Installing greeneye_monitor

Before you install

Low friction installation with only two runtime dependencies (aiohttp and siobrultech-protocols). Dormant maintenance status—last commit was 2024-02-18 and no releases in 908 days—means bug fixes or feature updates are unlikely, though the repository is not archived.

License in practice

MIT license (permissive) places no restrictions on use, modification, or distribution in your own projects.

Quickstart

pip install greeneye-monitor

from greeneye.monitor import Monitor
monitor = Monitor(host, port)
await monitor.start()

Requires Python 3.10 or later. Your GreenEye Monitor must be configured to send binary format packets to the IP and port where you run this code.

Verify before relying

• Whether the package works reliably with current GreenEye Monitor firmware versions.
• Performance characteristics when handling multiple monitors or high-frequency packet streams.
• Whether dormancy affects real-world usability or if the stable API is sufficient for most integrations.

Package facts

Evidence: greeneye_monitor-5.0.2-py3-none-any.whl

Keywords: greeneye

Tags

More Home Automation packages