Skip to main content

Device-Output

type

Possible values: [battery_energy_storage_system, charging_pole_3phase, dc_charging_pole, forecasted_series_3phase]

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_intervalWith Transaction Expected Measurement Interval (number)

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
number
charging_efficiencyCharging Efficiency (number)

Charging efficiency of the battery [0 < x <= 1].

Possible values: > 0 and <= 1

Default value: 0.95
discharging_efficiencyDischarging Efficiency (number)

Discharging efficiency of the battery [0 < x <= 1].

Possible values: > 0 and <= 1

Default value: 0.95
maximum_charging_powerMaximum Charging Power (number)required

Maximum charging power of the battery in W.

Possible values: > 0

maximum_discharging_powerMaximum Discharging Power (number)required

Maximum discharging power of the battery in W.

Possible values: > 0

operational_battery_capacityOperational Battery Capacity (number)required

The operational battery capacity in Wh.

Possible values: > 0

charging_priorityCharging Priority (integer)

Priority of charging the battery. Default is 10

Possible values: >= 1 and <= 10

Default value: 10
discharging_priorityDischarging Priority (integer)

Priority of discharging the battery. Default is 10

Possible values: >= 1 and <= 10

Default value: 10
policies object[]

List of policies for the BESS device.

  • Array [
    • oneOf
    typeType (string)
    Constant value: schedule
    Default value: schedule
    schedule objectrequired

    The schedule defining when the state of charge should be between minimum_state_of_charge and maximum_state_of_charge.

    frequency

    The schedule defining when the state of charge should be between minimum_state_of_charge and maximum_state_of_charge.

    Possible values: [continuous, once, weekly]

    object
    minimum_state_of_chargeMinimum State Of Charge (number)required

    The minimum state of charge to reach at the scheduled time. At each timestamp in the schedule, the state of charge will be between minimum_state_of_charge and maximum_state_of_charge.

    Possible values: >= 0 and <= 100

    maximum_state_of_chargeMaximum State Of Charge (number)required

    The maximum state of charge to reach at the scheduled time. At each timestamp in the schedule, the state of charge will be between minimum_state_of_charge and maximum_state_of_charge.

    Possible values: >= 0 and <= 100

    violation_price_euros_per_mwhViolation Price Euros Per Mwh (number)

    Soft-constraint penalty in euros per MWh of state-of-charge band violation. The default acts as a near-hard constraint; lower values let the optimiser cross the band when the expected revenue justifies it.

    Possible values: >= 0

    Default value: 3000000
  • ]
    • Device-Output
    {
      "name": "LR34_001",
      "collector": "main_collector",
      "ingress_validation": {
        "with_transaction_expected_measurement_interval": 0,
        "without_transaction_expected_measurement_interval": 0
      },
      "type": "charging_pole_3phase",
      "line_current": 32,
      "pin_to_phase_mapping": {
        "pin_list": [
          "pin1"
        ],
        "phase_list": [
          "L1"
        ]
      }
    }