Class: Sensor¶

A Sensor object in OpenDSS.

 classDiagram
    class Sensor
    click Sensor href "../Sensor/"
      Sensor : action

      Sensor : basefreq

      Sensor : clear

      Sensor : conn

      Sensor : currents

      Sensor : Deltadirection

      Sensor : element

      Sensor : enabled

      Sensor : kvars

      Sensor : kvbase

      Sensor : kVs

      Sensor : kWs

      Sensor : like

      Sensor : name

      Sensor : pct_Error

      Sensor : terminal

      Sensor : Weight

Class Properties¶

Property	Value
Class URI	dss:Sensor

Slots¶

Name	Cardinality and Range	Description	Inheritance
name	1 String	Object name	direct
element	0..1 String	Name (Full Object name) of element to which the Sensor is connected	direct
terminal	0..1 Integer	Number of the terminal of the circuit element to which the Sensor is connecte...	direct
kvbase	0..1 Float	Voltage base for the sensor, in kV	direct
clear	0..1 Float	{ Yes	No }
kVs	0..1 Float	Array of Voltages (kV) measured by the voltage sensor	direct
currents	0..1 Float	Array of Currents (amps) measured by the current sensor	direct
kWs	0..1 Float	Array of Active power (kW) measurements at the sensor	direct
kvars	0..1 Float	Array of Reactive power (kvar) measurements at the sensor	direct
conn	0..1 Float	Voltage sensor Connection: { wye	delta
Deltadirection	0..1 String	{1 or -1} Default is 1: 1-2, 2-3, 3-1	direct
pct_Error	0..1 Float	Assumed percent error in the measurement	direct
Weight	0..1 String	Weighting factor: Default is 1	direct
action	0..1 String	NOT IMPLEMENTED	direct
basefreq	0..1 Float	Base Frequency for ratings	direct
enabled	0..1 Boolean	{Yes	No or True
like	0..1 String	Make like another object, e	direct

Identifier and Mapping Information¶

Schema Source¶

from schema: https://gridappsd.github.io/dss-graph/opendss

Mappings¶

Mapping Type	Mapped Value
self	dss:Sensor
native	dss:Sensor

LinkML Source¶

Direct¶

name: Sensor
description: A Sensor object in OpenDSS.
from_schema: https://gridappsd.github.io/dss-graph/opendss
attributes:
  name:
    name: name
    description: Object name. Must be unique per object type.
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    identifier: true
    domain_of:
    - Load
    - Generator
    - Generic5
    - Gicline
    - Indmach012
    - Pvsystem
    - Storage
    - Upfc
    - Vccs
    - Vsconverter
    - Windgen
    - Autotrans
    - Capacitor
    - Gictransformer
    - Line
    - Reactor
    - Transformer
    - Capcontrol
    - Espvlcontrol
    - Expcontrol
    - Fuse
    - Gendispatcher
    - Invcontrol
    - Pycontrol
    - Recloser
    - Regcontrol
    - Relay
    - Storagecontroller
    - Swtcontrol
    - Upfccontrol
    - Cndata
    - Dynamicexp
    - Growthshape
    - Linecode
    - Linegeometry
    - Linespacing
    - Loadshape
    - Priceshape
    - Spectrum
    - TccCurve
    - Tsdata
    - Tshape
    - Wiredata
    - Xfmrcode
    - Xycurve
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: string
    required: true
  element:
    name: element
    annotations:
      order:
        tag: order
        value: 1
    description: Name (Full Object name) of element to which the Sensor is connected
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    domain_of:
    - Capcontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    range: string
    required: false
  terminal:
    name: terminal
    annotations:
      order:
        tag: order
        value: 2
    description: Number of the terminal of the circuit element to which the Sensor
      is connected
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    domain_of:
    - Capcontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    range: integer
    required: false
  kvbase:
    name: kvbase
    annotations:
      order:
        tag: order
        value: 3
    description: Voltage base for the sensor, in kV
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    domain_of:
    - Relay
    - Sensor
    range: float
    required: false
  clear:
    name: clear
    annotations:
      order:
        tag: order
        value: 4
    description: '{ Yes | No }'
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    rank: 1000
    domain_of:
    - Sensor
    range: float
    required: false
  kVs:
    name: kVs
    annotations:
      order:
        tag: order
        value: 5
    description: Array of Voltages (kV) measured by the voltage sensor
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    - Sensor
    range: float
    required: false
  currents:
    name: currents
    annotations:
      order:
        tag: order
        value: 6
    description: Array of Currents (amps) measured by the current sensor
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    rank: 1000
    domain_of:
    - Sensor
    range: float
    required: false
  kWs:
    name: kWs
    annotations:
      order:
        tag: order
        value: 7
    description: Array of Active power (kW) measurements at the sensor
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    rank: 1000
    domain_of:
    - Sensor
    range: float
    required: false
  kvars:
    name: kvars
    annotations:
      order:
        tag: order
        value: 8
    description: Array of Reactive power (kvar) measurements at the sensor
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    rank: 1000
    domain_of:
    - Sensor
    range: float
    required: false
  conn:
    name: conn
    annotations:
      order:
        tag: order
        value: 9
    description: 'Voltage sensor Connection: { wye | delta | LN | LL }'
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    domain_of:
    - Load
    - Generator
    - Generic5
    - Indmach012
    - Pvsystem
    - Storage
    - Windgen
    - Autotrans
    - Capacitor
    - Reactor
    - Transformer
    - Xfmrcode
    - Sensor
    range: float
    required: false
  Deltadirection:
    name: Deltadirection
    annotations:
      order:
        tag: order
        value: 10
    description: '{1 or -1}  Default is 1:  1-2, 2-3, 3-1'
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    rank: 1000
    domain_of:
    - Sensor
    range: string
    required: false
  pct_Error:
    name: pct_Error
    annotations:
      order:
        tag: order
        value: 11
      dss_name:
        tag: dss_name
        value: '%Error'
    description: Assumed percent error in the measurement
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    rank: 1000
    domain_of:
    - Sensor
    range: float
    required: false
  Weight:
    name: Weight
    annotations:
      order:
        tag: order
        value: 12
    description: 'Weighting factor: Default is 1'
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    rank: 1000
    domain_of:
    - Sensor
    range: string
    required: false
  action:
    name: action
    annotations:
      order:
        tag: order
        value: 13
    description: NOT IMPLEMENTED
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    domain_of:
    - Relay
    - Loadshape
    - Priceshape
    - Tshape
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    range: string
    required: false
  basefreq:
    name: basefreq
    annotations:
      order:
        tag: order
        value: 14
    description: Base Frequency for ratings
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    domain_of:
    - Load
    - Generator
    - Generic5
    - Gicline
    - Indmach012
    - Pvsystem
    - Storage
    - Upfc
    - Vccs
    - Vsconverter
    - Windgen
    - Autotrans
    - Capacitor
    - Gictransformer
    - Line
    - Reactor
    - Transformer
    - Capcontrol
    - Espvlcontrol
    - Expcontrol
    - Fuse
    - Gendispatcher
    - Invcontrol
    - Pycontrol
    - Recloser
    - Regcontrol
    - Relay
    - Storagecontroller
    - Swtcontrol
    - Upfccontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: float
    required: false
  enabled:
    name: enabled
    annotations:
      order:
        tag: order
        value: 15
    description: '{Yes|No or True|False} Indicates whether this element is enabled'
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    domain_of:
    - Load
    - Generator
    - Generic5
    - Gicline
    - Indmach012
    - Pvsystem
    - Storage
    - Upfc
    - Vccs
    - Vsconverter
    - Windgen
    - Autotrans
    - Capacitor
    - Gictransformer
    - Line
    - Reactor
    - Transformer
    - Capcontrol
    - Espvlcontrol
    - Expcontrol
    - Fuse
    - Gendispatcher
    - Invcontrol
    - Pycontrol
    - Recloser
    - Regcontrol
    - Relay
    - Storagecontroller
    - Swtcontrol
    - Upfccontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: boolean
    required: false
  like:
    name: like
    annotations:
      order:
        tag: order
        value: 16
    description: Make like another object, e
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    domain_of:
    - Load
    - Generator
    - Generic5
    - Gicline
    - Indmach012
    - Pvsystem
    - Storage
    - Upfc
    - Vccs
    - Vsconverter
    - Windgen
    - Autotrans
    - Capacitor
    - Gictransformer
    - Line
    - Reactor
    - Transformer
    - Capcontrol
    - Espvlcontrol
    - Expcontrol
    - Fuse
    - Gendispatcher
    - Invcontrol
    - Pycontrol
    - Recloser
    - Regcontrol
    - Relay
    - Storagecontroller
    - Swtcontrol
    - Upfccontrol
    - Cndata
    - Dynamicexp
    - Growthshape
    - Linecode
    - Linegeometry
    - Linespacing
    - Loadshape
    - Priceshape
    - Spectrum
    - TccCurve
    - Tsdata
    - Tshape
    - Wiredata
    - Xfmrcode
    - Xycurve
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: string
    required: false
class_uri: dss:Sensor

Induced¶

name: Sensor
description: A Sensor object in OpenDSS.
from_schema: https://gridappsd.github.io/dss-graph/opendss
attributes:
  name:
    name: name
    description: Object name. Must be unique per object type.
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    identifier: true
    owner: Sensor
    domain_of:
    - Load
    - Generator
    - Generic5
    - Gicline
    - Indmach012
    - Pvsystem
    - Storage
    - Upfc
    - Vccs
    - Vsconverter
    - Windgen
    - Autotrans
    - Capacitor
    - Gictransformer
    - Line
    - Reactor
    - Transformer
    - Capcontrol
    - Espvlcontrol
    - Expcontrol
    - Fuse
    - Gendispatcher
    - Invcontrol
    - Pycontrol
    - Recloser
    - Regcontrol
    - Relay
    - Storagecontroller
    - Swtcontrol
    - Upfccontrol
    - Cndata
    - Dynamicexp
    - Growthshape
    - Linecode
    - Linegeometry
    - Linespacing
    - Loadshape
    - Priceshape
    - Spectrum
    - TccCurve
    - Tsdata
    - Tshape
    - Wiredata
    - Xfmrcode
    - Xycurve
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: string
    required: true
  element:
    name: element
    annotations:
      order:
        tag: order
        value: 1
    description: Name (Full Object name) of element to which the Sensor is connected
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    owner: Sensor
    domain_of:
    - Capcontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    range: string
    required: false
  terminal:
    name: terminal
    annotations:
      order:
        tag: order
        value: 2
    description: Number of the terminal of the circuit element to which the Sensor
      is connected
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    owner: Sensor
    domain_of:
    - Capcontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    range: integer
    required: false
  kvbase:
    name: kvbase
    annotations:
      order:
        tag: order
        value: 3
    description: Voltage base for the sensor, in kV
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    owner: Sensor
    domain_of:
    - Relay
    - Sensor
    range: float
    required: false
  clear:
    name: clear
    annotations:
      order:
        tag: order
        value: 4
    description: '{ Yes | No }'
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    rank: 1000
    owner: Sensor
    domain_of:
    - Sensor
    range: float
    required: false
  kVs:
    name: kVs
    annotations:
      order:
        tag: order
        value: 5
    description: Array of Voltages (kV) measured by the voltage sensor
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    owner: Sensor
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    - Sensor
    range: float
    required: false
  currents:
    name: currents
    annotations:
      order:
        tag: order
        value: 6
    description: Array of Currents (amps) measured by the current sensor
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    rank: 1000
    owner: Sensor
    domain_of:
    - Sensor
    range: float
    required: false
  kWs:
    name: kWs
    annotations:
      order:
        tag: order
        value: 7
    description: Array of Active power (kW) measurements at the sensor
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    rank: 1000
    owner: Sensor
    domain_of:
    - Sensor
    range: float
    required: false
  kvars:
    name: kvars
    annotations:
      order:
        tag: order
        value: 8
    description: Array of Reactive power (kvar) measurements at the sensor
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    rank: 1000
    owner: Sensor
    domain_of:
    - Sensor
    range: float
    required: false
  conn:
    name: conn
    annotations:
      order:
        tag: order
        value: 9
    description: 'Voltage sensor Connection: { wye | delta | LN | LL }'
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    owner: Sensor
    domain_of:
    - Load
    - Generator
    - Generic5
    - Indmach012
    - Pvsystem
    - Storage
    - Windgen
    - Autotrans
    - Capacitor
    - Reactor
    - Transformer
    - Xfmrcode
    - Sensor
    range: float
    required: false
  Deltadirection:
    name: Deltadirection
    annotations:
      order:
        tag: order
        value: 10
    description: '{1 or -1}  Default is 1:  1-2, 2-3, 3-1'
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    rank: 1000
    owner: Sensor
    domain_of:
    - Sensor
    range: string
    required: false
  pct_Error:
    name: pct_Error
    annotations:
      order:
        tag: order
        value: 11
      dss_name:
        tag: dss_name
        value: '%Error'
    description: Assumed percent error in the measurement
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    rank: 1000
    owner: Sensor
    domain_of:
    - Sensor
    range: float
    required: false
  Weight:
    name: Weight
    annotations:
      order:
        tag: order
        value: 12
    description: 'Weighting factor: Default is 1'
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    rank: 1000
    owner: Sensor
    domain_of:
    - Sensor
    range: string
    required: false
  action:
    name: action
    annotations:
      order:
        tag: order
        value: 13
    description: NOT IMPLEMENTED
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    owner: Sensor
    domain_of:
    - Relay
    - Loadshape
    - Priceshape
    - Tshape
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    range: string
    required: false
  basefreq:
    name: basefreq
    annotations:
      order:
        tag: order
        value: 14
    description: Base Frequency for ratings
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    owner: Sensor
    domain_of:
    - Load
    - Generator
    - Generic5
    - Gicline
    - Indmach012
    - Pvsystem
    - Storage
    - Upfc
    - Vccs
    - Vsconverter
    - Windgen
    - Autotrans
    - Capacitor
    - Gictransformer
    - Line
    - Reactor
    - Transformer
    - Capcontrol
    - Espvlcontrol
    - Expcontrol
    - Fuse
    - Gendispatcher
    - Invcontrol
    - Pycontrol
    - Recloser
    - Regcontrol
    - Relay
    - Storagecontroller
    - Swtcontrol
    - Upfccontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: float
    required: false
  enabled:
    name: enabled
    annotations:
      order:
        tag: order
        value: 15
    description: '{Yes|No or True|False} Indicates whether this element is enabled'
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    owner: Sensor
    domain_of:
    - Load
    - Generator
    - Generic5
    - Gicline
    - Indmach012
    - Pvsystem
    - Storage
    - Upfc
    - Vccs
    - Vsconverter
    - Windgen
    - Autotrans
    - Capacitor
    - Gictransformer
    - Line
    - Reactor
    - Transformer
    - Capcontrol
    - Espvlcontrol
    - Expcontrol
    - Fuse
    - Gendispatcher
    - Invcontrol
    - Pycontrol
    - Recloser
    - Regcontrol
    - Relay
    - Storagecontroller
    - Swtcontrol
    - Upfccontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: boolean
    required: false
  like:
    name: like
    annotations:
      order:
        tag: order
        value: 16
    description: Make like another object, e
    from_schema: https://gridappsd.github.io/dss-graph/meters/sensor
    owner: Sensor
    domain_of:
    - Load
    - Generator
    - Generic5
    - Gicline
    - Indmach012
    - Pvsystem
    - Storage
    - Upfc
    - Vccs
    - Vsconverter
    - Windgen
    - Autotrans
    - Capacitor
    - Gictransformer
    - Line
    - Reactor
    - Transformer
    - Capcontrol
    - Espvlcontrol
    - Expcontrol
    - Fuse
    - Gendispatcher
    - Invcontrol
    - Pycontrol
    - Recloser
    - Regcontrol
    - Relay
    - Storagecontroller
    - Swtcontrol
    - Upfccontrol
    - Cndata
    - Dynamicexp
    - Growthshape
    - Linecode
    - Linegeometry
    - Linespacing
    - Loadshape
    - Priceshape
    - Spectrum
    - TccCurve
    - Tsdata
    - Tshape
    - Wiredata
    - Xfmrcode
    - Xycurve
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: string
    required: false
class_uri: dss:Sensor