BessDevice

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

Default value: battery_energy_storage_system

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

ScheduledBessPolicy

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]

once

date_timesstring<date-time>[]required

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

Possible values: >= 1

weekly

day_of_weekDayOfWeek (string)[]required

Days of week when the schedule runs

Possible values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday], >= 1

timeTime (string)required

Time in HH:MM format (24-hour)

Possible values: Value must match regular expression ^([0-1][0-9]|2[0-3]):[0-5][0-9]$

timezoneTimezone (string)required

IANA timezone identifier

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

]

BessDevice

{
  "name": "LR34_001",
  "collector": "main_collector",
  "type": "battery_energy_storage_system",
  "charging_efficiency": 0.95,
  "discharging_efficiency": 0.95,
  "maximum_charging_power": 0,
  "maximum_discharging_power": 0,
  "operational_battery_capacity": 0,
  "charging_priority": 10,
  "discharging_priority": 10,
  "policies": [
    {
      "type": "schedule",
      "schedule": {
        "frequency": "weekly",
        "day_of_week": [
          "monday",
          "friday"
        ],
        "time": "09:00",
        "timezone": "America/New_York"
      },
      "minimum_state_of_charge": 85.49,
      "maximum_state_of_charge": 85.49
    }
  ]
}