FlatPeak for your use case

Choose your use case from the tabs below. If yours is not yet listed (HEMS, EMS, HVAC, Heat Pump) or if you need help designing implementation, schedule a call or open a support ticket. We would be glad to assist.

If your system generates energy, such as solar PV or wind turbine, and you want to report cost savings and export revenue that it creates:

Design

Once customer completes the Connect flow, or if you created their tariff via the API:

To optimise the operation of your system for cost-benefit:

Supply your customer’s premises when your system generates (supplied energy).
Export surplus energy to the grid (exported energy).

To determine the savings and earnings achieved by your system:

Log supplied energy to meter-records API under the IMPORT tariff.
When your system exports energy (to the grid), subtract the exported amount from the supplied energy meter record (synchronised by time interval) and log it as exported energy to the meter-records API under the EXPORT tariff.
When you want to display savings and earnings, call the cost-calculation API to get the value of energy your system has supplied and exported, aggregated by day, month, or year.

Implementation

When your system supplies the energy it generates to your customer’s premises, log it as if it was supplied from the grid. This is so it can be priced at the value of the grid import tariff at the time - enabling you to demonstrate the savings your system creates.

Submit meter records from your system to meter-records API at device-level, setting direction=EXPORT and tariff_rate=IMPORT:

curl --request PUT \
  --url https://api.flatpeak.com/meters/interval \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[{
  "start_time": "2024-09-01T08:00:00Z",
  "end_time": "2024-09-01T09:00:00Z",
  "device_id": "dev_65e6d8334c8d715963d99db3",
  "location_id": "loc_641b90b758fb8e6293716e40",
  "direction": "EXPORT",
  "tariff_rate": "IMPORT",
  "units": "W",
  "value": 6125
}]'

When your system exports energy to the grid, log it using the export tariff. To make this measurement, you will place a CT clamp on the property power feed in the configuration that measures exported energy (export CT clamp).

When your system gets non-zero meter records from the export CT clamp:

Subtract the exported amount of energy from the supplied energy meter record that covers the same time interval.
Log it to meter-records API, at location-level (i.e. with no device_id), setting direction=EXPORT and tariff_rate=EXPORT.

Request

curl --request PUT \
  --url https://api.flatpeak.com/meters/interval \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[{
  "start_time": "2024-09-01T08:00:00Z",
  "end_time": "2024-09-01T09:00:00Z",
  "location_id": "loc_641b90b758fb8e6293716e40",
  "direction": "EXPORT",
  "tariff_rate": "EXPORT",
  "units": "W",
  "value": 1324
}]'

If you find it challenging to implement savings calculation using this guide, get in touch with our support team. We’d be glad to help!

Getting Started

Connect Tutorials

API Tutorials

FlatPeak for your use case

Design

Implementation