https://github.com/energychain/node-red-contrib-discovergy-meter

Allows to work with a Discovergy Smart Meter (Electricity only) within Node RED flows
https://github.com/energychain/node-red-contrib-discovergy-meter

Last synced: 4 months ago
JSON representation

Allows to work with a Discovergy Smart Meter (Electricity only) within Node RED flows

• Host: GitHub
• URL: https://github.com/energychain/node-red-contrib-discovergy-meter
• Owner: energychain
• License: apache-2.0
• Created: 2020-08-16T21:44:43.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-23T04:14:12.000Z (over 2 years ago)
• Last Synced: 2025-01-11T15:20:39.165Z (5 months ago)
• Language: HTML
• Size: 1.35 MB
• Stars: 3
• Watchers: 4
• Forks: 2
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# casa-corrently

Allows to work with a smartmeters (Electricity only) within Node RED flows. If you do not have a Smart Meter you might get it [here from STROMDAO](https://www.corrently.de/transparenz/bestellung-smartmeter/) (Germany only).

![npm](https://img.shields.io/npm/dw/node-red-contrib-discovergy-meter) [![Build Status](https://travis-ci.com/energychain/node-red-contrib-discovergy-meter.svg?branch=master)](https://travis-ci.com/energychain/node-red-contrib-discovergy-meter) [![Code Quality](https://www.code-inspector.com/project/12360/score/svg)](https://frontend.code-inspector.com/public/project/12360/node-red-contrib-discovergy-meter/dashboard) [![chat](https://img.shields.io/badge/chat-support-brightgreen)](https://tawk.to/chat/5c53189451410568a109843f/default) [![CO2Offset](https://api.corrently.io/v2.0/ghgmanage/statusimg?host=casa.corrently&svg=1)](https://co2offset.io/badge.html?host=casa.corrently)

## NOTE: new name

This package gets renamed into **casa-corrently** - Previous: **node-red-contrib-discovergy-meter**

## Installation

### Node-RED (Node) via Shell

```shell

cd ~/.node-red/

npm install --save node-red-contrib-discovergy-meter

```

### Node-RED (Node) via Editor

Install `node-red-contrib-discovergy-meter` as NODE package.

## QuickStart

This QuickStart allows you to start node-red with one the sample meters to get quickly familiar with this Node (module).

### Prerequisites

- Node-RED installed global (e.q you could start it from command line using `node-red`)

- Cloned version of GIT Repository https://github.com/energychain/node-red-contrib-discovergy-meter.git

### Corrently Demo Meter(s) - Full generation (Messkonzept1 - Volleinspeisung)

Reference: https://casa.corrently.de/books/demo-z%C3%A4hler/page/messkonzept-1-%28volleinspeisung%29

```shell

npm install node-red-dashboard

npm run demo-messkonzept1

```

### Corrently Demo Meter(s) - surplus feed-in (Messkonzept2 - Überschusseinspeisung)

Reference: https://casa.corrently.de/books/demo-z%C3%A4hler/page/messkonzept-2-%28%C3%BCberschusseinspeisung%29

```shell

npm install node-red-dashboard

npm run demo-messkonzept2

```

### Accessing Demo

 - Editor: http://localhost:1880/

 - Dashboard (UI): http://localhost:1880/ui

###

## Usage

### First time usage

On first time adding a Discovery Meter to a flow the list of available meters will be empty.

- Add Discovergy login information to configuration node

- `Deploy` changes to flow

- Re-Open Configuration of Discovergy Meter

### Modify time and reading of installation (optional)

You might overwrite time and value of first reading from the node configuration.

### Output (standard)

If triggered (maybe periodic via an inject) this node provides a json Object as `msg.payload`.

```javascript

msg.payload =  {

  time: , // time of reading per Discovergy API

  latest: {

    power: , // Power in Watt * 10^-3

    power1: ,// Power in Watt * 10^-3 of Phase 1

    power2: ,// Power in Watt * 10^-3 of Phase 2

    power3: ,// Power in Watt * 10^-3 of Phase 3

    energy: ,// Actual Meter Reading in Watthours * 10^-7 (consumption . OBIS Code 1.8.0)

    energyOut: ,// Actual Meter Reading in Watthours * 10^-7 (production . OBIS Code 2.8.0)

    baseCosts: , // Accumulated base fee (Grundgebühr) since first measument time (eq. installation - might be overwritten)

    energyCost: , // Accumulated energy costs (Arbeitspreis) since first measument time (eq. installation - might be overwritten)

    energyRevenue: , // Revenue from feeding Energy into the grid

    incomeSaldo:  // Pre Calculated : energyRevenue - (baseCosts + energyCost)

  }

}

```

### Output with statistics (advanced)

If `msg.topic` is set to `statistics` additional statistic information will be provided. Beside of power,power1,power2,power3 the object gets formated same as in `msg.payload.latest` above.

*NOTE: Retrieving statistics requires a significant higher amount of API calls. Consider to use it less than once per minute. *

```javascript

msg.payload =  {

  time: // time of reading per Discovergy API

  latest: { ... }, // latest values

  last24h: { ... }, // From latest reading 24 hours backward

  today: { ... }, // Values from today

  yesterday: { ... }, // Values from yesterday

  monthToDay: { ... }, // Values from this month

  lastMonth: { ... }, // Values from last month

  yearToDay: { ... }, // Values from this year

  last365d: { ... } // Values from last 365 days

}

```

### Output with aggregation (advanced)

You might add multiple Discovergy Meters in sequence. In this case a property `aggregation` will contain aggregated values of all meters.

```javascript

msg.payload =  {

  time: // time of reading per Discovergy API

  latest: { ... }, // latest values  

  aggregation: { ... } // Aggregated values of all meters in sequence

}

```

## Sample flows

### Messkonzept 2 (Überschußeinspeisung) ohne Z2 (Produktionszähler)

[Dashboard](https://flows.nodered.org/flow/6f43f7d48405927ab3231ef1eea38a96)

## Standalone usage

It is possible to run this node without Node-RED. It comes shipped with a express APP.

```shell

git clone https://github.com/energychain/node-red-contrib-discovergy-meter.git

cd node-red-contrib-discovergy-meter.git

npm install

npm start ./sample_config_messkonzept2.json

```

![Prosumer Display](https://squad.stromdao.de/nextcloud/index.php/s/EjaBaya9WPgcRzw/preview)

Online Demo (via Heroku):

https://casa-corrently-demo.herokuapp.com/index.html

By default the Web UI will be visible at http://localhost:3000/index.html

### One Click Deployment

Heroku:

https://heroku.com/deploy?template=https://github.com/energychain/node-red-contrib-discovergy-meter

## Funding

This module is part of the Corrently Ecosystem which looks for funding in Germany:  https://www.stromdao.de/crowdfunding/info

![STROMDAO - Corrently Crowdfunding](https://squad.stromdao.de/nextcloud/index.php/s/Do4pzpM7KndZxAx/preview)

## Further reading

Further Documentation is available as Casa Corrently Chapter at: https://casa.corrently.de/books/nutzung-von-node-red/chapter/gr%C3%BCnstromz%C3%A4hler-%28discovergy-meter%29

## Maintainer / Imprint

This module is not an official contribution by Discovergy GmbH.

STROMDAO GmbH  


Gerhard Weiser Ring 29  


69256 Mauer  


Germany  


  


+49 6226 968 009 0  


  


[email protected]  


  


Handelsregister: HRB 728691 (Amtsgericht Mannheim)

## LICENSE

Apache-2.0