Skip to main content

A library for reading EcoTracker energy consumption data from everHome's local HTTP endpoint

Project description

EcoTracker Library by everHome

A Python library for reading energy consumption data from everHome's EcoTracker device via a local HTTP endpoint. This library is designed to work with EcoTracker devices that expose power and energy counter data via a JSON API.

Installation

pip install ecotracker

Usage

Basic Usage

from ecotracker import EcoTracker

# Initialize the EcoTracker device with the IP address of your device
meter = EcoTracker("192.168.1.100")

# Update the meter data
if meter.update():
    # Get the current power consumption
    power = meter.get_power()
    print(f"Current power consumption: {power} W")
    
    # Get the energy counter for incoming energy
    energy_in = meter.get_energy_counter_in()
    print(f"Energy counter in: {energy_in} kWh")
    
    # Get all available data
    all_data = meter.get_all_data()
    print(f"All data: {all_data}")

Available Methods

The EcoTracker class provides the following methods:

  • update(): Updates the electricity meter data from the HTTP endpoint
  • get_power(): Gets the current power consumption in watts
  • get_power_phase1(): Gets the current power consumption of phase 1 in watts
  • get_power_phase2(): Gets the current power consumption of phase 2 in watts
  • get_power_phase3(): Gets the current power consumption of phase 3 in watts
  • get_power_avg(): Gets the average power consumption in watts
  • get_energy_counter_out(): Gets the energy counter for outgoing energy in kWh
  • get_energy_counter_in(): Gets the energy counter for incoming energy in kWh
  • get_energy_counter_in_t1(): Gets the energy counter for incoming energy in tariff 1 in kWh
  • get_energy_counter_in_t2(): Gets the energy counter for incoming energy in tariff 2 in kWh
  • get_all_data(): Gets all electricity meter data as a dictionary

Running Tests

python -m unittest discover tests

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ecotracker-0.1.4.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ecotracker-0.1.4-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file ecotracker-0.1.4.tar.gz.

File metadata

  • Download URL: ecotracker-0.1.4.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.6

File hashes

Hashes for ecotracker-0.1.4.tar.gz
Algorithm Hash digest
SHA256 620e05dce0fe99e61b04eb7b26017f42ca907f0c1d30ae8fd6551c2d1223ef16
MD5 9158a8ec5524823f7e2e8ec7e9556aba
BLAKE2b-256 03439fbd2cdee24f601c46240d3a49eb0104c49ae2268a3bf60b2c1da181cf01

See more details on using hashes here.

File details

Details for the file ecotracker-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: ecotracker-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.6

File hashes

Hashes for ecotracker-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 fa3e1cf332757d73243749f254f5317114971a45c0bee1f6cbf06cd33cfeec42
MD5 daf22ec18d8e767a2e0296f1163a1f53
BLAKE2b-256 19c10aeef4400c0339c4ea29a25444de9f7d6dca6967f29891f239640d9e8656

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page