@energyweb/origin-247-energy-api

Smart meter readings management library

Usage no npm install needed!

<script type="module">
  import energywebOrigin247EnergyApi from 'https://cdn.skypack.dev/@energyweb/origin-247-energy-api';
</script>

README

Origin 24/7 SDK - Energy API module

Energy API module is responsible for managing meter readings. It can accept readings, for which precise proofs are created. The readings themselves are stored in Influx DB.

Module is built to be used with 24/7 applications, that utilize https://github.com/energywebfoundation/origin and other 24/7 packages.

Important information:

  1. It saves proof request to database, and waits some time to collect more readings, that can be batched under one proof (one proof can contain one deviceId, but many readings).
  2. It queues proof issuance to avoid transaction conflicts.
  3. In case of any error during creating proofs, it's saved in database. Successfully processed requests are removed from database.
  4. Reading timestamp is rounded down to seconds

Installation

  1. Import EnergyApi247Module into your application:
import { EnergyApi247Module } from '@energyweb/origin-247-energy-api';

@Module({
    imports: [EnergyApi247Module]
})
export class SomeModule {}
  1. Add entities to TypeORM.forRoot entities:
import { entities as EnergyApiEntities } from '@energyweb/origin-247-energy-api';

...
TypeORM.forRoot({
  entities: [
    ...EnergyApiEntities
  ]
})
  1. Run migrations on startup:
// package.json
{
    "scripts": {
        "typeorm:run:energy-api": "node_modules/typeorm/cli.js migration:run --config node_modules/@energyweb/origin-247-energy-api/dist/js/ormconfig.js"
    }
}
  1. Add necessary configuration environment variables (for Origin Energy API Influx DB):
# --- SMART METER READINGS --- #
INFLUXDB_URL=http://localhost:8086
INFLUXDB_TOKEN=admin:admin
INFLUXDB_ORG=
INFLUXDB_BUCKET=energy/autogen

# Blockchain - deploy key is used for managing proofs on blockchain
WEB3=http://localhost:8545
DEPLOY_KEY=0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

Usage

  1. Import module (as in installation step)
  2. Inject EnergyApi247Facade into your service, and use it to store readings and access readings or proofs.
  3. Using ReadingProofProcessedEvent (from NestJS CQRS event bus) you can listen to reading batch being processed and react on that.

Configuration

Environment variables

  1. ENERGY_REQUEST_PROCESS_AGGREGATE_SECONDS - default 10 - how long application should wait to aggregate as many readings into batch as possible