Skip to content

Models

Models are objects that are referred to in endpoints.

LimitProductionPower

Limit the power production of an inverter or turbine. The Teleport device will send an extra measurement report immediately after startAt and endAt (unless a report is already scheduled within 3 seconds).

MODEL
{
type: 'limitProductionPower';
percentage: number;
startAt: Date;
endAt: Date;
}
details
percentage
Non-negative and <= 100. 0 will turn power production off, 100 will not curtail it at all.

ReduceProductionPower

Reduce the power production of an inverter or turbine with the specified power, compared to the available power given the weather conditions. This can be used when providing automatic Frequency Restoration Reserve (aFRR) services. For PV assets this requires at least one pyranometer or irradiance sensor on site. LimitProductionPower commands for the same asset can be active in parallel: the Teleport will apply the power reduction on the lowest active setpoint.

MODEL
{
type: 'reduceProductionPower';
powerReduction: number;
startAt: Date;
endAt: Date;
}
details
powerReduction
In W and nonnegative.

SetBatteryOperation

Set the operating mode for a battery.

MODEL
{
type: 'setBatteryOperation';
operation: {
dispatchPower: {
activePower: number;
} | null;
deliverFCR: {
maxRate: number;
} | null;
chargeToState: {
percentage: number;
} | null;
};
startAt: Date;
endAt: Date;
}
details
operation.dispatchPower.activePower
In W. Positive means discharging, negative charging.
operation.deliverFCR.maxRate
In W and non-negative.
operation.chargeToState.percentage
Non-negative and <= 100.

SetEVOperation

Set the operating mode for a set of EV charger stations.

MODEL
{
type: 'setEVOperation';
operation: {
limit: {
power?: number | null;
current?: number | null;
} | null;
};
startAt: Date;
endAt: Date;
}
details
operation.limit.power?
In W. Active power for AC chargers. For non-bidirectional chargers this value should not be positive. Use null or leave the property out to indicate that no limit should be set.
operation.limit.current?
In A. For non-bidirectional chargers this value should not be positive. Use null or leave the property out to indicate that no limit should be set. This is the phase current. In wye configurations it is the same as the line current. For delta configurations the phase current has to be multiplied by √3 to get the line current

LimitPower

Set an active power limit at the grid connection or designated metering point with dynamic control where startAt defines the start period of the limit and endAt defined the end period. Once the control schedule ends, the limits revert to their preconfigured static settings. The Teleport will apply the limitation on the lowest active setpoint.

MODEL
{
type: 'limitPower';
feedIn: number | null;
consume: number | null;
startAt: Date;
endAt: Date;
}
details
feedIn
In W and nonnegative
consume
In W and nonnegative

SagerFurnace

Parameters for a Sager Furnace.

MODEL
{
type: 'sagerFurnace';
schedule: {
charge: boolean;
startAt: string;
endAt: string;
}[] | null;
}
details
schedule
A daily recurring schedule that is stored in the thermal store. Elements should not be overlapping. Not more than 11 elements.
schedule[].startAt
In hh:mm (UTC).
schedule[].endAt
In hh:mm (UTC). Not including.

DemoBattery

Parameters for controlling the errors and warnings of a demo battery. The demo battery will use these warnings and errors in the batteryPower messages.

MODEL
{
type: 'demoBattery';
errors: string[];
warnings: string[];
}