Ctrl+K

dss.ISensors

dss.ISensors#

Module Contents#

Classes#

ISensors

API#

class dss.ISensors.ISensors(api_util)#

Bases: dss._cffi_api_util.Iterable

property AllNames: List[str]#

Array of all names of this object type

property AllocationFactor#

Array of doubles for the allocation factors for each phase.

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

property Count: int#

Number of objects of this type

property Currents: dss._types.Float64Array#

Array of doubles for the line current measurements; don’t use with kWS and kVARS.

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

property First: int#

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

property IsDelta: bool#

True if measured voltages are line-line. Currents are always line currents.

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

property MeteredElement: str#

Full Name of the measured element

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

property MeteredTerminal: int#

Number of the measured terminal in the measured element.

Original COM help: https://opendss.epri.com/MeteredTerminal1.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 PctError: float#

Assumed percent error in the Sensor measurement. Default is 1.

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

Reset()#
ResetAll()#
property ReverseDelta: bool#

True if voltage measurements are 1-3, 3-2, 2-1.

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

property Weight: float#

Weighting factor for this Sensor measurement with respect to other Sensors. Default is 1.

Original COM help: https://opendss.epri.com/Weight.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)

property kVARS: dss._types.Float64Array#

Array of doubles for Q measurements. Overwrites Currents with a new estimate using kWS.

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

property kVS: dss._types.Float64Array#

Array of doubles for the LL or LN (depending on Delta connection) voltage measurements.

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

property kVbase: float#

Voltage base for the sensor measurements. LL for 2 and 3-phase sensors, LN for 1-phase sensors.

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

property kWS: dss._types.Float64Array#

Array of doubles for P measurements. Overwrites Currents with a new estimate using kVARS.

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

Contents