API Reference
  1. Edgecom Energy
  2. NeuraCharge IESO BTM

Set the control mode and parameters for an asset

post
https://dev.edgecom.ai/neuracharge/ieso/btm/asset//setcontrol

Sets the asset's control mode and its parameters. The request body is a manual, scheduled, or smart control request selected by the mode field; smart mode is not yet available and is rejected with 400. Dispatch to the asset is asynchronous, so the response returns a commandId and an acceptanceState alongside the resulting control status; poll the controlstatus endpoint until lastCommand.acceptanceState is accepted or rejected. Use this endpoint to issue manual commands or replace the asset's schedule windows.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Unique identifier for the NeuraCharge asset

Body Params
string
enum
required

manual: Apply a single command until it is changed.

Allowed:
string
enum
required

Command applied to the asset in manual mode, or the charge type of a schedule window. off: Asset is idle; no charge or discharge. direct_charge: Charge at the given setpoint (kW), or at rated power if no setpoint is given. direct_discharge: Discharge at the given setpoint (kW), or at rated power if no setpoint is given. energy_charge: Charge or discharge until the asset reaches the target energy level ("go to energy").

Allowed:
float | null

Charge or discharge setpoint in kW for direct_charge and direct_discharge. Must not exceed the asset's ratedPowerKw. Defaults to rated power if omitted.

float | null

Target stored energy in kWh. Required for energy_charge; ignored for other commands.

string

Optional free-text note recorded in the asset log

Responses

Updated 6 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago

Did this page help you?