Skip to main content
You reach a device only through its enrollment in one of your programs.

Object model

Click an object for its reference.

Devices

A device is a battery, electric vehicle, EV charger or PV system, connected through its OEM. It has a dev_ ID and a device_type, which names the whole product: an EV has a battery but is not BATTERY_STORAGE, and a vehicle charging through a connected charge point is dispatched as that EV_CHARGER. dispatch_limits is the envelope Flatpeak checks every instruction against, computed at the device’s connection point with inverter and connector limits included. It changes when the OEM adds or removes hardware, and device.update fires. List all OEMs returns the OEMs on your account. To add one, contact support.

Telemetry and settings

  • Device state is a snapshot of the live envelope at the grid connection point.
  • Meter records are signed interval energy in kWh, used to settle delivery.
  • Location meter records cover the whole site, where the OEM’s hardware meters the grid connection point.
  • Device settings are one record per device, which the customer owns and changes in your app or the OEM’s.
Devices covers each.

Import and export

The sign of every power and energy value gives the direction. Prices are the exception: their sign is economic, and every tariff states the direction its prices apply to.

VPP events and plans

Both are binding on the OEM, and the OEM confirms the power the device will deliver. Dispatch stays above backup_reserve_percent, and it does not export from a battery whose export_rule forbids it.

Groups and zones

A group is a named set of devices, for bulk dispatch and aggregated reads. A zone is a network area that Flatpeak resolves, so you dispatch by location without sending addresses. A capacity forecast gives a group’s dispatchable power for a future window.

Programs and enrollment

A program is your offer to customers. They enroll in your app, with program_id on the Connect session, or in their OEM’s app once the program is listed and the OEM approves it. A managed program is a managed tariff: you supply the energy and run the device with plans. A customer who finds a listed managed tariff in their OEM’s app signs up on your site, at the program’s enrollment.signup_url, before they consent. An enrollment has six states, from PENDING to ACTIVE to ENDED. A device needs a connected tariff to enroll.