SiteConfiguration

device_list object[]required

Array [

oneOf

AcChargingPole3Phase

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]

DcChargingPole

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: dc_charging_pole

Default value: dc_charging_pole

max_powerMax Power (integer)required

The maximum power in Watt for the charging pole itself / connection to the charging pole.

ForecastedThreePhaseDevice

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: 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]

]

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

Array [

0

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

]

null

null

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

PinToPhasePermutation

parentstring[]required

childstring[]required

null

null

line_currentLine Current (integer)required

The line current in Ampere.

line_voltage objectdeprecated

Deprecated: use phase_voltage instead.

anyOf

integer

integer

null

null

phase_voltage object

The phase voltage in Volt.

anyOf

integer

integer

null

null

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]

]

SiteConfiguration

{
  "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"
    }
  ]
}