FACTSControlDevice
Package: PowerOperationsOpenAPIModels · Source: Operations/StaticInjection/FACTSControlDevice.json
Facts control devices.
Most often used in AC power flow studies as a control of voltage and, active and reactive power.
Properties
| Property | Type | Required | Unit | Description |
|---|---|---|---|---|
name | string | yes | — | Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name. |
id | integer | yes | — | Unique integer identifier for this component. |
available | boolean | yes | — | Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations. |
bus | integer | yes | — | Sending end bus number. |
control_mode | string (FACTSControlDeviceControlMode) | — | — | Control mode. Used to describe the behavior of the control device. |
voltage_setpoint_units | string (VoltageUnitBasis) | — | — | Unit basis for voltage_setpoint. COMPONENT_BASE (pu on the bus base voltage) is PSS/E RAW native (VSET). |
voltage_setpoint | number | yes | kV / pu (by voltage_setpoint_units) | Voltage setpoint at the sending end bus in kV, it has to be a PV bus. Units: kV. Units: per voltage_setpoint_units — NATURAL_UNITS: kV, COMPONENT_BASE: pu . |
max_shunt_current | number | yes | MVA / pu (by power_units) | Maximum shunt current at the sending end bus; entered at unity voltage. Units: per power_units — NATURAL_UNITS: MVA, COMPONENT_BASE: pu . |
reactive_power_required | number | yes | 1 | Total reactive power required to hold voltage at sending bus, as a fraction in the range 0-1. Units: 1. |
max_reactive_power | number | — | MVAr / pu (by power_units) | Independent maximum reactive power ceiling; the device reactive limit is min(the current/susceptance law on max_shunt_current, this value). Non-binding at the 9999.0 default. Units: per power_units — NATURAL_UNITS: MVAr, COMPONENT_BASE: pu . |
shunt_control_type | string | — | — | Device class selecting the reactive-limit law (SVC vs STATCOM). |
regulated_bus_number | integer | — | 1 | Bus whose voltage this device regulates; 0 means local (sending) bus (PSS/E FCREG). Units: 1. |
base_power | number | yes | MVA | System base power for per-unitization of this component’s per-unit fields, recorded per component in lieu of a system-level table. Units: MVA. |
power_units | string (UnitSystem) | yes | — | Unit basis for this component’s power-family fields (active/reactive/apparent power, ratings, limits, ramp rates). COMPONENT_BASE: per unit on this component’s own base_power. NATURAL_UNITS: the field’s physical unit. |
dynamic_injector | integer or null | — | — | ID of the corresponding dynamic injection model for FACTS control device, if any. |