corrently_io

CorrentlyIo - JavaScript client for corrently_io Corrently - from italian corrente, which is energy

Introduction

The Corrently ecosystem gets maintained by STROMDAO GmbH to support green energy services for prosumers, grid operators, regulators, integrators or any other party with an emerging need of consensus driven management. As the energy product Corrently got first launched in Germany parts of this documentation provide simple translations for better understanding.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 2.0.0
• Package version: 2.0.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://stromdao.de/kontakt

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install corrently_io --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your corrently_io from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var CorrentlyIo = require('corrently_io');


var api = new CorrentlyIo.DispatchGreenEnergyDistributionAPIApi()
var opts = {
  'zip': "zip_example", // {String} Zipcode (Postleitzahl) of a city in Germany.
  'key': "key_example" // {String} Any valid Stromkonto account (address).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.gsiDispatch(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.corrently.io/v2.0

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CorrentlyIo.DispatchGreenEnergyDistributionAPIApi | gsiDispatch | GET /gsi/dispatch | Dispatch (Green Energy Distribution Schedule) CorrentlyIo.GreenPowerIndexGrnstromIndexApi | gsiBesthour | GET /gsi/bestHour | Get best hour (with most regional green energy) in a given timeframe. CorrentlyIo.GreenPowerIndexGrnstromIndexApi | gsiDispatch | GET /gsi/dispatch | Dispatch (Green Energy Distribution Schedule) CorrentlyIo.GreenPowerIndexGrnstromIndexApi | gsiMarketdata | GET /gsi/marketdata | Marketdata CorrentlyIo.GreenPowerIndexGrnstromIndexApi | gsiPrediction | GET /gsi/prediction | Prediction CorrentlyIo.MeteringDecoratorApi | meteringGet | GET /metering/reading | Meter Reading CorrentlyIo.MeteringDecoratorApi | meteringPost | POST /metering/reading | Meter Reading CorrentlyIo.OpenMETERApi | omActivities | GET /alternative/openmeter/activities | Public shared smart meters installed in Germany and available for subservices and exploration. CorrentlyIo.OpenMETERApi | omMeters | GET /alternative/openmeter/meters | Public shared smart meters installed in Germany and available for subservices and exploration. CorrentlyIo.OpenMETERApi | omReadings | GET /alternative/openmeter/readings | Public shared smart meters installed in Germany and available for subservices and exploration. CorrentlyIo.SmartHomeApi | gsiBesthour | GET /gsi/bestHour | Get best hour (with most regional green energy) in a given timeframe. CorrentlyIo.StromkontoLedgerApi | prepareTransaction | POST /stromkonto/prepareTransaction | Prepare Transaction CorrentlyIo.StromkontoLedgerApi | stromkontoBalances | GET /stromkonto/balances | Balances CorrentlyIo.StromkontoLedgerApi | stromkontoChoices | GET /stromkonto/choices | Selectable Choices for customer CorrentlyIo.StromkontoLedgerApi | stromkontoLogin | POST /stromkonto/login | Login (via Mail) CorrentlyIo.StromkontoLedgerApi | stromkontoRegister | POST /stromkonto/register | Register (new Stromkonto) CorrentlyIo.TariffPriceAPIApi | tariffSLPH0 | GET /tariff/slph0 | Energy Tariff information CorrentlyIo.TariffPriceAPIApi | tariffcomponents | GET /tariff/components | Energy Tariff price components CorrentlyIo.WiMWechselprozesseImMesswesenStromStatusAPIApi | wimstatus | GET /wim/status | WiM Proess Informtion

Documentation for Models

• CorrentlyIo.Balance
• CorrentlyIo.Componentsh0
• CorrentlyIo.DispatchLocation
• CorrentlyIo.ForecastItem
• CorrentlyIo.InlineObject
• CorrentlyIo.InlineObject1
• CorrentlyIo.InlineObject2
• CorrentlyIo.InlineObject3
• CorrentlyIo.InlineResponse200
• CorrentlyIo.InlineResponse2001
• CorrentlyIo.InlineResponse2001Location
• CorrentlyIo.InlineResponse2001Matrix
• CorrentlyIo.InlineResponse2001MatrixH0
• CorrentlyIo.InlineResponse2002
• CorrentlyIo.InlineResponse2002Timeframe
• CorrentlyIo.InlineResponse2003
• CorrentlyIo.InlineResponse2004
• CorrentlyIo.InlineResponse2005
• CorrentlyIo.InlineResponse2006
• CorrentlyIo.MarketData
• CorrentlyIo.Ommeters
• CorrentlyIo.Tariffh0
• CorrentlyIo.Transactions

Documentation for Authorization

All endpoints do not require authorization.