eda-readings

An NPM package to send EDA (Electricidade dos Açores) power readings.

Installation

npm install eda-readings

Usage

import { createClient, type ReadingResponse, type SendReadingPayload } from 'eda-readings';

const client = createClient('<your-client-number>', '<your-contract-number>');

// Fetch current reading data
const reading: ReadingResponse = await client.getReading();
console.log(reading);

// Send meter readings
const payload: SendReadingPayload = {
  cil: reading.cil,
  cilToken: reading.cilToken,
  cilTokenExpires: reading.cilTokenExpires,
  serial: reading.serial,
  material: reading.material,
  valorContador1: '8900',
  register1: reading.register1,
  valorContador2: '5420',
  register2: reading.register2,
  valorContador3: '13400',
  register3: reading.register3,
};
await client.sendReading(payload);

API

createClient(clientNumber, contractNumber)

Creates an EDA readings client.

| Parameter | Type | Description | | ---------------- | -------- | ---------------------------------- | | clientNumber | string | Your CIL (client identification number) | | contractNumber | string | Your contract number |

Returns an object with the following methods:

client.getReading()

Fetches the current reading data from the EDA API.

• Returns: Promise<ReadingResponse> — the reading data object.

client.sendReading(readings)

Sends meter readings to the EDA API.

| Field | Type | Required | Description | | -------------------- | -------- | -------- | ---------------------------------- | | cil | string | ✅ | CIL identifier | | cilToken | string | ✅ | CIL token | | cilTokenExpires | number | ✅ | CIL token expiry timestamp | | serial | string | ✅ | Meter serial number | | material | string | ✅ | Material identifier | | valorContador1 | string | ✅ | Reading for counter 1 | | register1 | string | ✅ | Register identifier for counter 1 | | valorContador2 | string | ❌ | Reading for counter 2 | | register2 | string | ❌ | Register identifier for counter 2 | | valorContador3 | string | ❌ | Reading for counter 3 | | register3 | string | ❌ | Register identifier for counter 3 |

• Returns: Promise<unknown> — the API response.

Scripts

| Script | Description | | ----------------- | --------------------------------------------------- | | npm run build | Compile TypeScript to dist/ | | npm test | Run the test suite | | npm run release | Run tests, build, and publish to NPM |

License

MIT