Web-app for processing, logging and visualising energy, temperature and other environmental data
Latest commit 1e3ed99 Nov 7, 2018
Failed to load latest commit information.
Lib Improved Continuous Integration Oct 18, 2018
Modules css & positioning of device/auth allow Nov 7, 2018
Theme/basic formatting from @adminde pull request Nov 2, 2018
docs spelling fix. Nov 2, 2018
scripts Added systemd based service-runner in python (#1025) Sep 22, 2018
tests Improved Continuous Integration Oct 18, 2018
.gitignore added composer packages directory to .gitignore Sep 21, 2018
.htaccess small css change to re-align the group titles Aug 15, 2018
.jshintrc Fixed .jshintrc Jul 3, 2014
.travis.yml Travis changed version of firefox from latest to 60 (latest was 63.0 … Oct 30, 2018
COPYRIGHT.txt bump date Dec 17, 2015
LICENSE.txt First commit of modular refactoring of emoncms, for history up and to… Oct 15, 2012
composer.json removed requirements for .toml config file Oct 2, 2018
composer.lock created new toml config file Sep 20, 2018
core.php Merge remote-tracking branch 'origin/master' into device-support Jul 11, 2018
default.emonpi.settings.php fix default email Oct 19, 2018
default.settings.php fix default email Oct 19, 2018
index.php added the new ui_v2 check into the correct controllers Aug 2, 2018
locale.php removed en_EN Jun 25, 2018
logconfig.xml Fix Min Max processors + Merge with 8.5 latest Jun 3, 2015
param.php changes from master not carried across Jul 11, 2018
php-info.php add php-info.php file and restrict to local access Jun 23, 2016
process_settings.php fixed the mqtt settings being saved to incorrect array Oct 2, 2018
readme.md Update readme.md Aug 1, 2018
route.php fixed the "github suggestion" error Oct 17, 2018
version.txt Update version.txt Nov 3, 2018


Standard Emoncms and Emoncms.org

There are differences between the standard version of emoncms and the version of emoncms running on emoncms.org. This repository contains the code for the standard version of emoncms, currently in version 9. This is the version installed on the OpenEnergyMonitor SD Card that comes with the EmonPi and EmonBase and is recommended for all self-install versions of emoncms.

The emoncms.org version Github: emoncms/emoncmsorg is a fork that is specific for multi-server installations. While both versions share the same roots the code for emoncms.org differs significantly to the standard version of emoncms, the user experience is intended to be similar but there are currently a number of differences in the API and look of the inputs and feeds interfaces as well as a reduced feature set in general on emoncms.org in order to ensure stability. In general development on emoncms.org moves slower than the standard emoncms for this reason.

Emoncms 9

Build Status Codacy Badge

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.

Version 9 of emoncms has been developed by Chaveiro with a significant list of improvements, see forum thread with full change log



  • PHP (5.6 - 7 recomended)
  • MYSQL (14.14 recomended)
  • Apache (2.4 recomended)
  • Redis (recommended)*

*Redis is recommended to reduces disk write load prolonging disk life (noticably on SD cards e.g. RaspberryPi). 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 dont support redis hence why emoncms has a fall back mode that allows core operation without redis.

Using Emoncms

Important: See appendix on differences between standard Emoncms and Emoncms.org

1. Screencasts/Videos

These screencasts where put together to accompany the emonPi/emonBase setup guide and do therefore contain a number of references that are EmonPi/EmonBase/RaspberryPi specific. They do however give a useful overview of some of the core parts of Emoncms including configuring inputs, creating feeds and dashboards.

There are also two screencasts that are specific to optional modules that are included on the EmonPi/Emonbase standard SD card install but are not part of the standard install if you follow the installation guides below.

2. From the Guide

3. Emoncms Terminology

  • Inputs: 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 inputs or feeds.
  • 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*.
  • Feeds: (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 where 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.

4. Emoncms.org API Reference

The following API references apply to emoncms.org they differ slightly to the API available on EmonPI/EmonBase installs, the API refrence for which can be found from the inputs and feed pages when logged in locally.




Other (less supported, not tested on latest versions of emoncms)

  • Shared Linux Hosting
  • Windows Emoncms is developed and tested on Linux only and so additional research, steps may be required that are not covered in this guide.


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:

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


  • 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.

  • ARCHIVE low-write (v8.5) - Old emonpi/emonbase emoncms version (July 15 emonSD ready-to-go SD card image). Low-write mode is now available in v9.0. The low write version of emoncms is designed for running on SD cards. This is a cut down version of emoncms supports only the phpfina and phptimeseries feed engines (no in built feed averaging or histograms) and a reduced input processor set. Archived branch


Data Backup


Documentation development

For developers: The following lists the locations of the files that define emoncms's inbuilt documentation for the input and feed API's and input process descriptions:


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


Note: due to ongoing development some docs may now be outdated

Emoncms timeseries database design (feed storage)

Android App

Google Play

GitHub Repo

Development Forum

More information