Ctrl+K

dss.ICapControls

dss.ICapControls#

Module Contents#

Classes#

ICapControls

API#

class dss.ICapControls.ICapControls(api_util)#

Bases: dss._cffi_api_util.Iterable

property AllNames: List[str]#

Array of all names of this object type

property CTratio: float#

Transducer ratio from primary current to control current.

Original COM help: https://opendss.epri.com/CTratio.html

property Capacitor: str#

Name of the Capacitor that is controlled.

Original COM help: https://opendss.epri.com/Capacitor.html

property Count: int#

Number of objects of this type

property DeadTime: float#

Dead time after capacitor is turned OFF before it can be turned back ON for the active CapControl.

Default is 300 sec.

Original COM help: https://opendss.epri.com/DeadTime.html

property Delay: float#

Time delay [s] to switch on after arming. Control may reset before actually switching.

Original COM help: https://opendss.epri.com/Delay.html

property DelayOff: float#

Time delay [s] before switching off a step. Control may reset before actually switching.

Original COM help: https://opendss.epri.com/DelayOff.html

property First: int#

Sets the first object of this type active. Returns 0 if none.

property Mode: dss.enums.CapControlModes#

Type of automatic controller.

Original COM help: https://opendss.epri.com/Mode.html

property MonitoredObj: int#

Full name of the element that PT and CT are connected to.

Original COM help: https://opendss.epri.com/MonitoredObj.html

property MonitoredTerm: int#

Terminal number on the element that PT and CT are connected to.

Original COM help: https://opendss.epri.com/MonitoredTerm.html

property Name: str#

Gets the current name or sets the active object of this type by name

property Next: int#

Sets next object of this type active. Returns 0 if no more.

property OFFSetting: float#

Threshold to switch off a step. See Mode for units.

Original COM help: https://opendss.epri.com/OFFSetting.html

property ONSetting: float#

Threshold to arm or switch on a step. See Mode for units.

Original COM help: https://opendss.epri.com/ONSetting.html

property PTratio: float#

Transducer ratio from primary feeder to control voltage.

Original COM help: https://opendss.epri.com/PTratio.html

Reset()#

Force a reset of this CapControl.

Original COM help: https://opendss.epri.com/Reset.html

property UseVoltOverride: float#

Enables Vmin and Vmax to override the control Mode

Original COM help: https://opendss.epri.com/UseVoltOverride.html

property Vmax: float#

With VoltOverride, swtich off whenever PT voltage exceeds this level.

Original COM help: https://opendss.epri.com/Vmax.html

property Vmin: float#

With VoltOverride, switch ON whenever PT voltage drops below this level.

Original COM help: https://opendss.epri.com/Vmin.html

__init__(api_util)#
__iter__() → Iterator[dss._cffi_api_util.Iterable]#

Get an iterator of the object collection.

Note that OpenDSS, via the classic APIs, only allow a single object of a specific type to be activated. That is, you cannot use references of distinct objects and interact with both at the same time, or keep a reference to use later. You need to reactivate the target object or ensure it is the active one.

For an alternative, consider using our AltDSS-Python package.

(API Extension)

__len__() → int#
property idx: int#

Gets the current index or sets the active object of this type by index

While the official API included this for some classes, this is an API Extension for:

  • Capacitors

  • CapControls

  • ISources

  • LineCodes

  • Lines

  • LoadShapes

  • Meters

  • Monitors

  • RegControls

  • Sensors

  • SwtControls

  • Transformers

  • Vsources

  • XYCurves

(API Extension)

Contents