Skip to main content

Configurations

site_configuration object
anyOf
device_list object[]required
  • Array [
    • oneOf
    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.

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

    The line current in Ampere.

    pin_to_phase_mapping objectrequired

    Defines how charging pole pins map to the collectors' phases. For more information see the 'Key Concepts - Site configuration' section in the documentation.

    pin_liststring[]required

    Possible values: [pin1, pin2, pin3]

    phase_liststring[]required

    Possible values: [L1, L2, L3]

  • ]
    • collector_list object[]required
  • Array [
    • nameName (string)required
    children object

    The children of this collector. This is used to create a tree structure.

    anyOf
  • Array [
    • 0
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
  • ]
    • phase_permutations object

    If the phase naming conventions (L1, L2, L3) are not consistent between parent and child, specify the phase mapping between them.

    anyOf
    parentstring[]required
    childstring[]required
    line_currentLine Current (integer)required

    The line current in Ampere.

    line_voltage objectdeprecated

    Deprecated: use phase_voltage instead.

    anyOf
    integer
    phase_voltage object

    The phase voltage in Volt.

    anyOf
    integer
    commodityCommodity (string)
    Default value: electricity
    1P_3PCollectorType (string)required

    Specifies whether the collector is single-phase (1P) or three-phase (3P).

    Possible values: [1P, 3P]

  • ]
    • optimization_configuration object
    anyOf
    peak_minimization object
    anyOf
    active object

    Boolean field that indicates if the peak minimization is activated or not.

    anyOf
    boolean
    peak_limit object

    Specifies a line under which the peak_price does not apply. The value specified will be applied to all the phases of the collector separately. By default the peak_limit is set to 0.

    anyOf
    integer
    cost_minimization object
    anyOf
    activeActive (boolean)
    Default value: false
    day_ahead_price object
    anyOf
    boolean
    day_ahead_bidding_zone object
    anyOf
    string

    Possible values: [DE_50HZ, AL, DE_AMPRION, AT, BY, BE, BA, BG, CZ_DE_SK, HR, CWE, CY, CZ, DE_AT_LU, DE_LU, DK, DK_1, DK_1_NO_1, DK_2, DK_CA, EE, FI, MK, FR, DE, GR, HU, IS, IE_SEM, IE, IT, IT_SACO_AC, IT_CALA, IT_SACO_DC, IT_BRNN, IT_CNOR, IT_CSUD, IT_FOGN, IT_GR, IT_MACRO_NORTH, IT_MACRO_SOUTH, IT_MALTA, IT_NORD, IT_NORD_AT, IT_NORD_CH, IT_NORD_FR, IT_NORD_SI, IT_PRGP, IT_ROSN, IT_SARD, IT_SICI, IT_SUD, RU_KGD, LV, LT, LU, LU_BZN, MT, ME, GB, GE, GB_IFA, GB_IFA2, GB_ELECLINK, UK, NL, NO_1, NO_1A, NO_2, NO_2_NSL, NO_2A, NO_3, NO_4, NO_5, NO, PL_CZ, PL, PT, MD, RO, RU, SE_1, SE_2, SE_3, SE_4, RS, SK, SI, GB_NIR, ES, SE, CH, DE_TENNET, DE_TRANSNET, TR, UA, UA_DOBTPP, UA_BEI, UA_IPS, XK, DE_AMP_LU]

    fixed_offtake_price object

    The offtake price in Mega Watt per hour. This is the price electricity is taken from the grid.

    anyOf
    number
    injection_price object

    Price at which electricity can be injected back into to grid in Mega Watt per hour.

    anyOf
    integer
    planning_frequencyPlanning Frequency (string)

    The planned frequency at which a site will be optimized. Should follow the python timedelta notation. Currently this field is disabled as we only support 15 minutes long optimization configuration. Notation is in Pandas Timedelta notation.

    Constant value: PT15M
    Default value: PT15M
    planning_horizonPlanning Horizon (string)

    The planning horizon for which the optimization will be done. Should follow the python timedelta notation. We only allow 1 day, 2 days or 3 days for now

    Possible values: [P1D, P2D, P3D]

    Default value: P1D
    Configurations
    {
      "site_configuration": {
        "device_list": [
          {
            "name": "LR34_001",
            "collector": "main_collector",
            "type": "charging_pole_3phase",
            "line_current": 0,
            "pin_to_phase_mapping": {
              "pin_list": [
                "pin1"
              ],
              "phase_list": [
                "L1"
              ]
            }
          },
          {
            "name": "LR34_001",
            "collector": "main_collector",
            "type": "dc_charging_pole",
            "max_power": 250000
          },
          {
            "name": "LR34_001",
            "collector": "main_collector",
            "type": "forecasted_series_3phase",
            "line_current": 0,
            "forecast_type": "pv"
          }
        ],
        "collector_list": [
          {
            "name": "string",
            "children": [
              null
            ],
            "phase_permutations": {
              "parent": [
                "string"
              ],
              "child": [
                "string"
              ]
            },
            "line_current": 0,
            "phase_voltage": 0,
            "commodity": "electricity",
            "1P_3P": "1P"
          }
        ]
      },
      "optimization_configuration": {
        "peak_minimization": {
          "active": true,
          "peak_limit": 0
        },
        "cost_minimization": {
          "active": false,
          "day_ahead_price": true,
          "day_ahead_bidding_zone": "DE_50HZ",
          "fixed_offtake_price": 0,
          "injection_price": 0
        },
        "planning_frequency": "PT15M",
        "planning_horizon": "P1D"
      }
    }