HeatpumpMonitor.org

An open source initiative to share and compare heat pump performance data.
https://github.com/openenergymonitor/heatpumpmonitor.org

Category: Consumption
Sub Category: Buildings and Heating

Keywords from Contributors

emoncms openenergymonitor sustainability emonpi hardware-designs emonth humidity-sensor temperature-sensor rfm12b rfm12pi

Last synced: about 4 hours ago
JSON representation

Repository metadata

public list of heat pumps sharing performance data via emoncms

readme.md

HeatpumpMonitor.org

An open source initiative to share and compare heat pump performance data.

See: https://heatpumpmonitor.org

heatpumpmonitor.png

Install on existing Apache2 server

Install public site content in /var/www

sudo ln -s /home/USERNAME/heatpumpmonitor.org/www/ /var/www/heatpumpmonitororg

Create a mariadb/mysql database:

CREATE DATABASE heatpumpmonitor;

Copy example.settings.php:

cp www/example.settings.php settings.php

Modify database credentials to match your system

Load public data from heatpumpmonitor.org to create functioning development environment

php load_dev_env_data.php

Login using 'Self hosted data' and username and password: admin:admin

Run using Docker

docker compose build
docker compose up

Site should now be running on http://localhost:8080

Emoncms runs on http://localhost:8081 (same compose stack).

Optional: load Emoncms testdataset feeds

The testdataset repo (clone as a sibling of this project, or set a custom path) can populate phpfina feeds into your dev Emoncms MySQL user for apps such as MyHeatpump.

  • Enable: docker compose --profile testdata up (or add --profile testdata when you already use up). This starts one-shot service load_emoncms_testdata after load_dev_env_data and a healthy emoncms container.
  • TESTDATASET_PATH: Host path to the testdataset repo. Default in compose is ../testdataset (relative to this project directory). Set in a .env file next to docker-compose.yml if your clone lives elsewhere (absolute path recommended).
  • TESTDATASET_EMONCMS_USER_ID: Numeric Emoncms user id to attach feeds to. Default 1 (the admin user created by load_dev_env_data when LOAD_USERS=1). Override in .env e.g. TESTDATASET_EMONCMS_USER_ID=2 for user2.
  • PHP_CLI_MEMORY_LIMIT: PHP CLI memory for add_feeds_to_account.php / post_process.php (default 1024M). Raise in .env if postprocess still exhausts memory.

After the feeds are imported, load_emoncms_testdata also runs docker/testdataset/configure_hpm_app.php to:

  1. Create a myheatpump app in Emoncms for the target user (via /app/add.json + /app/setconfig.json).
  2. Map the testdataset feeds (heatpump_elec, heatpump_heat, heatpump_flowT, ...) into the app config by name.
  3. Point the user's heatpumpmonitor system_meta row at the new app_id + readkey (creating one if missing).

Overrides (set in .env beside docker-compose.yml): HPM_APP_NAME (default My Heatpump), HPM_SYSTEM_LOCATION (default Test System). This step is idempotent — re-running will reuse an existing app with the same name and update the same system_meta row.

Re-running the loader may append or duplicate data; reset the emon-phpfina volume (and re-run stack) for a clean feed store.

Scripts and layout: docker/testdataset/.

Users

Login using 'Self hosted data' and username and password: admin:admin for the admin user and user<N>:password for any of the users accounts


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 2 days ago

Total Commits: 798
Total Committers: 10
Avg Commits per committer: 79.8
Development Distribution Score (DDS): 0.262

Commits in past year: 356
Committers in past year: 6
Avg Commits per committer in past year: 59.333
Development Distribution Score (DDS) in past year: 0.306

Name Email Commits
TrystanLea t****a@g****m 589
Jeremy Poulter j****r@w****m 80
MrTimbones t****a@g****m 56
Glyn Hudson g****n@g****m 26
copilot-swe-agent[bot] 1****t 19
Trystan Lea t****a@g****m 15
Kamil Baczkowicz k****z@g****m 6
MyForest d****d@m****m 4
Sam Reed s****m@r****t 2
Simon Bennett s****n@b****m 1

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 76
Total pull requests: 59
Average time to close issues: 6 months
Average time to close pull requests: 14 days
Total issue authors: 9
Total pull request authors: 12
Average comments per issue: 0.62
Average comments per pull request: 0.8
Merged pull request: 31
Bot issues: 0
Bot pull requests: 0

Past year issues: 26
Past year pull requests: 28
Past year average time to close issues: about 2 months
Past year average time to close pull requests: 21 days
Past year issue authors: 3
Past year pull request authors: 5
Past year average comments per issue: 0.62
Past year average comments per pull request: 0.61
Past year merged pull request: 15
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/openenergymonitor/heatpumpmonitor.org

Top Issue Authors

  • glynhudson (38)
  • MrTimbones (15)
  • TrystanLea (13)
  • zarch1972 (3)
  • reedy (3)
  • langestefan (1)
  • irecord (1)
  • JonasGhost (1)
  • BenjaminWatts (1)

Top Pull Request Authors

  • jeremypoulter (20)
  • MrTimbones (6)
  • TrystanLea (5)
  • Arifah25 (5)
  • kamilfb (4)
  • hakim813 (4)
  • Copilot (3)
  • reedy (3)
  • MyForest (3)
  • glynhudson (3)
  • putrifatirah (2)
  • mrsimonbennett (1)

Top Issue Labels

  • enhancement (17)
  • bug (8)
  • documentation (1)

Top Pull Request Labels


Dependencies

Dockerfile docker
  • php 8.0-apache build
docker-compose.yml docker
  • mariadb 11.0

Score: 6.593044534142437