Skip to main content

ForecastedThreePhaseDevice

phase_permutations object

Specify the phase mapping between this asset (child) and its parent collector (parent). Leave unset when the wiring is unknown; phase-aware control (use_topology) requires every asset's mapping to be declared, so a single unset mapping makes the controller fall back to the worst case.

anyOf
parentstring[]required

Possible values: [L1, L2, L3]

childstring[]required

Possible values: [L1, L2, L3]

nameName (string)required

The name of the device itself. This value will be used as the asset ID in the rest of the API.

collectorCollector (string)required

The name of the collector to which this device is connected.

ingress_validation object

Overrides the site-level ingress validation config for this asset. When set, controls how often measurements are expected during active and inactive transactions. When null, the site-level configuration is used.

anyOf
with_transaction_expected_measurement_intervalstring<duration>

Expected measurement interval for the asset while it has an active transaction. Measurements arriving less frequently than this are flagged as stale by ingress validation. Note: the UCL calculation requires measurements at least every 5 minutes to produce accurate results, so this value should not exceed 5 minutes for assets that participate in the uncontrollable-load computation.

without_transaction_expected_measurement_interval object

Expected measurement interval for the asset when no transaction is active. When null, the asset is always considered valid while idle. Note: the UCL calculation requires measurements at least every 5 minutes to produce accurate results, so if this asset contributes to the uncontrollable-load computation it should still report at least every 5 minutes.

anyOf
string
typeType (string)
Constant value: forecasted_series_3phase
Default value: forecasted_series_3phase
line_currentLine Current (integer)required

The line current in Ampere.

forecast_typeForecastTypeSiteConfiguration (string)required

Defines the type of forecast to be used for this device.

Possible values: [pv, load]

should_be_aggregatedShould Be Aggregated (boolean)
Default value: false
curtailment_modeCurtailmentMode (string)

How the controller may curtail this device's production to respect the grid minimum. NONE never curtails; CONTINUOUS curtails to any level. Only relevant for PV devices.

Possible values: [none, continuous]

Default value: none
ForecastedThreePhaseDevice
{
  "phase_permutations": {
    "parent": [
      "L1"
    ],
    "child": [
      "L1"
    ]
  },
  "name": "LR34_001",
  "collector": "main_collector",
  "ingress_validation": {
    "with_transaction_expected_measurement_interval": "string",
    "without_transaction_expected_measurement_interval": "string"
  },
  "type": "forecasted_series_3phase",
  "line_current": 32,
  "forecast_type": "pv",
  "should_be_aggregated": false,
  "curtailment_mode": "none"
}