Data

Tools

Indexes

Applications

Experiments

Open Source Science

emoncms

Web-app for processing, logging and visualising energy, temperature and other environmental data

https://github.com/emoncms/emoncms

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 147 committers (0.7%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (7.5%) to scientific vocabulary

Keywords

dashboards emoncms energy-monitor openenergymonitor php sustainability
Last synced: 6 months ago · JSON representation

Repository

Web-app for processing, logging and visualising energy, temperature and other environmental data

Basic Info
  • Host: GitHub
  • Owner: emoncms
  • License: agpl-3.0
  • Language: PHP
  • Default Branch: master
  • Homepage: https://emoncms.org
  • Size: 28.6 MB
Statistics
  • Stars: 1,288
  • Watchers: 108
  • Forks: 522
  • Open Issues: 62
  • Releases: 100
Topics
dashboards emoncms energy-monitor openenergymonitor php sustainability
Created over 13 years ago · Last pushed 6 months ago
Metadata Files
Readme License Security Copyright

readme.md

Emoncms

Emoncms is an open-source web application for processing, logging and visualising energy, temperature and other environmental data and is part of the OpenEnergyMonitor project.

Emoncms

Requirements

  • PHP (tested with 8.1.12)
  • MySQL or MariaDB (tested with 10.5.15)
  • Apache (tested with 2.4.54)
  • Redis* (tested with 6.0.16)

*Redis is recommended because it reduces the number of disk writes and therefore prolongs disk life (noticeably on SD cards e.g. Raspberry Pi). Some input-processors also require Redis and fail silently if Redis is not installed. Some environments such as shared hosting or as far as we have tried Windows servers don't support Redis hence why Emoncms has a fall back mode that allows core operation without Redis.

Documentation

View the Emoncms documentation at: https://docs.openenergymonitor.org/emoncms

Design

Emoncms timeseries database design (feed storage)

Other

Emoncms Terminology

  • Input: An incoming datasource. Each input has an associated "node" identifier and a "key" sub-identifier. Inputs are entry points, only the last value and time of the input is recorded. To record historic data a feed needs to be created from an input.
  • Input: Node: A grouping identifier for an input or feed.
  • Input: Key: A sub-identifier for items within each Node.
  • Input process list (or input processing): A list of processes* performed sequentially on each input value as it is received on that input.
  • Process: A function that can be attached to the process list of an input to change the value or to save the value to a feed*.

  • Feed: A place where data is recorded, a time-series of datapoints. The standard time-series databases used by Emoncms are PHPFina and PHPTimeSeries and were written as part of the Emoncms project.

  • For a description of what each input process does in Emoncms, see the helper note within the Emoncms input processing configuration interface.

Emoncms.org API Reference

Install

Emoncms is designed and tested to run on either Ubuntu Linux (Local, Dedicated machine or VPS) or RaspberryPi OS. It should work on other Debian Linux systems though we dont test or provide documentation for installation on these.

We do not recommend and are unable to support installation on shared hosting or XAMPP servers, shared hosting in particular has no or limited capabilities for running some of the scripts used by emoncms. There is now a large choice of low cost miniature Linux VPS hosting solutions that provide a much better installation environment at similar cost.

Recommended:

docker standalone container

An easy way to start with emoncms is to use the all-in-one docker container

A pipeline using github actions is producing builds with latest emoncms stable version for different architectures : amd64, arm64, arm/v7

These docker images, based on the alpine linux distribution, are designed for iot. Images are tagged using alpine and emoncms versions, for example alpine3.19_emoncms11.4.11.

The images have onboard : - the mariadb and redis databases, - the mosquitto mqtt broker, - the main modules : graph, sync, backup, dashboard and app, - the workers : emoncms_mqtt, service-runner and feedwriter.

You can easily : * deactivate the low-write * use an external broker.

To pull the latest image for testing :

sudo docker pull alexjunk/emoncms More on https://emoncms-docker.github.io

Experimental

not currently up to date

Multi-platform using Docker Container

Modules

Modules can be installed by downloading or git cloning into the emoncms/Modules folder. Be sure to check for database updates in Administration menu after installing new modules. The following core modules are included on the emonSD image:

There are many other available modules such as the event module and openbem (open source building energy modelling module): check out the Emoncms repo list.

Branches

  • master - The latest and greatest developments. Potential bugs, use at your own risk! All pull-requests should be made to the master branch.

  • stable - emonPi/emonBase release branch, regularly merged from master. Slightly more tried and tested. See release change log.

Tools

  • PHPFina data file viewer - Easily explore phpfina timeseries feed engine data files directly without a full Emoncms installation. Useful for checking backups and archived data.

Android App

Google Play

GitHub Repo

Development Forum

More information

Owner

  • Name: Emoncms
  • Login: emoncms
  • Kind: organization

GitHub Events

Total
  • Create event: 6
  • Release event: 1
  • Issues event: 44
  • Watch event: 47
  • Delete event: 5
  • Issue comment event: 149
  • Push event: 109
  • Pull request review comment event: 5
  • Pull request review event: 8
  • Pull request event: 30
  • Fork event: 8
Last Year
  • Create event: 6
  • Release event: 1
  • Issues event: 44
  • Watch event: 47
  • Delete event: 5
  • Issue comment event: 149
  • Push event: 109
  • Pull request review comment event: 5
  • Pull request review event: 8
  • Pull request event: 30
  • Fork event: 8

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 3,962
  • Total Committers: 147
  • Avg Commits per committer: 26.952
  • Development Distribution Score (DDS): 0.776
Past Year
  • Commits: 238
  • Committers: 12
  • Avg Commits per committer: 19.833
  • Development Distribution Score (DDS): 0.223
Top Committers
Name Email Commits
TrystanLea t****a@g****m 889
TrystanLea g****n@o****g 740
Emrys e****s@o****g 452
Trystan Lea t****a@g****m 274
Aymeric THIBAUT t****6 218
chaveiro n****o@g****m 214
Trystan t****n@t****) 126
Paul Reed p****d@g****m 95
Alexandre CUER a****r@c****r 70
trystan t****n@e****g 67
borpin b****n@g****m 52
Adrian Minde A****e@l****e 46
fake-name l****x@g****m 38
Dave McCraw d****e@m****k 37
AndyTaylorTweet a****y@a****k 34
Ildefonso Martínez i****a@g****m 34
Rubén de Celis Hernández r****s@i****s 33
Paul p****6 31
Sam Reed s****m@r****t 30
cagabi c****i@l****g 30
Malachi Soord i****i@g****m 27
PlaneteDomo c****t@p****m 24
CDuffers 4****4@o****m 22
Gabriele Lauricella g****u@g****m 21
SlyRemarks g****e@o****g 15
Paul-Reed d****9 15
Dave d****8@h****m 14
Arjen Hiemstra a****h@m****m 14
Marco Bisioli b****i@g****m 13
Erik Karlsson e****k@i****m 11
and 117 more...
Committer Domains (Top 20 + Academic)
openenergymonitor.org: 3 me.com: 2 att.net: 1 kaasan.ee: 1 hutorny.in.ua: 1 galloway.me.uk: 1 joos.se: 1 stammtec.de: 1 emlchem.com.au: 1 capnbry.net: 1 emonpi.com: 1 gmx.net: 1 collab.nl: 1 rostwald.de: 1 wonderland.org: 1 air-di-edoardo.lan: 1 netty.(none): 1 live.nl: 1 antispam.fake: 1 ubuntu-server.(none): 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 819
  • Total pull requests: 1,124
  • Average time to close issues: 8 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 305
  • Total pull request authors: 169
  • Average comments per issue: 3.24
  • Average comments per pull request: 2.11
  • Merged pull requests: 936
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 23
  • Pull requests: 27
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 20 days
  • Issue authors: 17
  • Pull request authors: 9
  • Average comments per issue: 2.26
  • Average comments per pull request: 2.89
  • Merged pull requests: 22
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • borpin (85)
  • TrystanLea (76)
  • pb66 (52)
  • glynhudson (39)
  • emrysr (34)
  • reedy (20)
  • Paul-Reed (19)
  • chaveiro (19)
  • danbates2 (16)
  • kumarmohan7 (10)
  • euqip (8)
  • lafrech (8)
  • arthurlutz (8)
  • spike3312 (6)
  • inverse (6)
Pull Request Authors
  • emrysr (207)
  • TrystanLea (139)
  • chaveiro (80)
  • thib66 (65)
  • glynhudson (57)
  • borpin (46)
  • reedy (37)
  • Paul-Reed (35)
  • alexandrecuer (34)
  • pb66 (32)
  • AndyTaylorTweet (21)
  • cagabi (18)
  • inverse (18)
  • Twincarb (17)
  • gablau (14)
Top Labels
Issue Labels
enhancement (127) bug (98) Needs User Feedback (12) question (9) testing required (7) locale (7) BuildScript (6) emoncms.org (4) Design (4) Priority: Low (4) notice (2) wontfix (2) admin (1) documentation (1) virtual feed (1) androidapp (1) feature request (1) duplicate (1) Priority: High (1)
Pull Request Labels
enhancement (8) process (4) Priority: Low (3) bug (2) testing required (2) Needs User Feedback (1) feature request (1) mysql (1) locale (1)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 12
proxy.golang.org: github.com/emoncms/emoncms
  • Versions: 12
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago

Dependencies

tests/package.json npm
  • selenium-standalone ^6.15.3 development
  • wdio-jasmine-framework ^0.3.6 development
  • wdio-spec-reporter ^0.1.5 development
  • webdriverajax ^2.2.0 development
  • webdriverio ^4.13.2 development
composer.json packagist
  • php-parallel-lint/php-parallel-lint ^1.2.0 development
  • ext-ctype *
  • ext-curl *
  • ext-gettext *
  • ext-json *
  • ext-mysqli *
  • ext-openssl *
.github/workflows/PHP.yml actions
  • actions/checkout v3 composite
  • shivammathur/setup-php v2 composite