Skip to main content

Device-Input

type

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

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.

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: [once, weekly]

    date_timesstring<date-time>[]required

    List of specific date-times in ISO 8601 format with timezone

    Possible values: >= 1

    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

  • ]
    • Device-Input
    {
      "name": "LR34_001",
      "collector": "main_collector",
      "type": "charging_pole_3phase",
      "line_current": 0,
      "pin_to_phase_mapping": {
        "pin_list": [
          "pin1"
        ],
        "phase_list": [
          "L1"
        ]
      }
    }