Raritan PX2/PX3 JSON-RPC API
OverCurrentProtector.idl
1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /*
3  * Copyright 2009 Raritan Inc. All rights reserved.
4  */
5 
6 #ifndef __PDUMODEL_OVERCURRENTPROTECTOR_IDL__
7 #define __PDUMODEL_OVERCURRENTPROTECTOR_IDL__
8 
9 #include <Nameplate.idl>
10 #include <StateSensor.idl>
11 #include <NumericSensor.idl>
12 #include <Pole.idl>
13 #include <Inlet.idl>
14 
15 /**
16  * PDU Model
17  */
18 module pdumodel {
19 
20  /** Overcurrent protector statistics */
22  int tripCnt; ///< Trip count
23  };
24 
25  /** Overcurrent protector interface */
26  interface OverCurrentProtector_3_0_6 extends EDevice {
27 
28  /** Overcurrent protector type */
29  enumeration Type {
30  BREAKER_1POLE, ///< Single-pole circuit breaker
31  BREAKER_2POLE, ///< Two-pole circuit breaker
32  BREAKER_3POLE, ///< Three-pole circuit breaker
33  FUSE, ///< Fuse
34  FUSE_PAIR, ///< Fuse Pair
35  RCBO_2POLE, ///< Two-pole residual-current device including overcurrent protection
36  RCBO_3POLE, ///< Three-pole residual-current device including overcurrent protection
37  RCBO_4POLE ///< Four-pole residual-current device including overcurrent protection
38  };
39 
40  /** Overcurrent protector metadata */
41  structure MetaData {
42  string label; ///< OCP label
43  Nameplate_2_0_0 namePlate; ///< %Nameplate information
44  Rating_2_0_0 rating; ///< Numerical usage ratings
45  Type type; ///< OCP type
46  int maxTripCnt; ///< Maximum trip count
47  };
48 
49  /** Overcurrent protector sensors */
50  structure Sensors {
51  sensors.StateSensor_4_0_4 trip; ///< Trip sensor (an instance of {@link OverCurrentProtectorTripSensor})
52  sensors.NumericSensor_4_0_4 voltage; ///< RMS voltage sensor
53  sensors.NumericSensor_4_0_4 current; ///< RMS current sensor
54  sensors.NumericSensor_4_0_4 peakCurrent; ///< Peak current sensor
55  sensors.NumericSensor_4_0_4 maximumCurrent; ///< Maximum current sensor
56  sensors.NumericSensor_4_0_4 activePower; ///< Active power sensor
57  sensors.NumericSensor_4_0_4 reactivePower; ///< Reactive power sensor
58  sensors.NumericSensor_4_0_4 apparentPower; ///< Apparent power sensor
59  sensors.NumericSensor_4_0_4 powerFactor; ///< Power factor sensor
60  sensors.NumericSensor_4_0_4 displacementPowerFactor;///< Displacement power factor sensor
61  sensors.NumericSensor_4_0_4 crestFactor; ///< Crest factor sensor
62  sensors.NumericSensor_4_0_4 activeEnergy; ///< Active energy sensor
63  sensors.NumericSensor_4_0_4 apparentEnergy; ///< Apparent energy sensor
64  sensors.NumericSensor_4_0_4 phaseAngle; ///< Phase angle sensor
65  sensors.NumericSensor_4_0_4 lineFrequency; ///< AC line frequency sensor
66  };
67 
68  /** Overcurrent protector settings */
69  structure Settings {
70  string name; ///< User-defined name
71  };
72 
73  /** Event: Overcurrent protector settings have been changed */
74  valueobject SettingsChangedEvent extends event.UserEvent {
75  Settings oldSettings; ///< Settings before change
76  Settings newSettings; ///< Settings after change
77  };
78 
79  /**
80  * Retrieve the OCP metadata.
81  *
82  * @return OCP metadata
83  */
85 
86  /**
87  * Get the OCP sensors.
88  *
89  * @return OCP sensors
90  */
92 
93  /**
94  * Get the list of OCP poles.
95  *
96  * @return List of OCP poles
97  */
98  vector<DoublePole_6_0_0> getPoles();
99 
100  /**
101  * Get the inlet this OCP is connected to
102  *
103  * @return inlet
104  */
106 
107  /**
108  * Get parent OCP - next OCP going towards inlet (for cascaded OCPs).
109  *
110  * @return OCP or null
111  */
113 
114  /**
115  * Retrieve the OCP settings.
116  *
117  * @return OCP settings
118  */
120 
121  /**
122  * Change the OCP settings.
123  *
124  * @param settings New OCP settings
125  *
126  * @return 0 if OK
127  * @return 1 if any parameters are invalid
128  */
129  int setSettings(in Settings settings);
130 
131  };
132 
133 }
134 
135 #endif
pdumodel::OverCurrentProtector_3_0_6::Sensors::crestFactor
sensors::NumericSensor_4_0_4 crestFactor
Crest factor sensor.
Definition: OverCurrentProtector.idl:61
pdumodel::OverCurrentProtector_3_0_6::MetaData::namePlate
Nameplate_2_0_0 namePlate
Nameplate information
Definition: OverCurrentProtector.idl:43
pdumodel::OverCurrentProtector_3_0_6::Sensors::phaseAngle
sensors::NumericSensor_4_0_4 phaseAngle
Phase angle sensor.
Definition: OverCurrentProtector.idl:64
sensors
Sensors Model.
Definition: AccumulatingNumericSensor.idl:13
pdumodel::OverCurrentProtector_3_0_6::Settings::name
string name
User-defined name.
Definition: OverCurrentProtector.idl:70
pdumodel::OverCurrentProtector_3_0_6::Sensors::apparentPower
sensors::NumericSensor_4_0_4 apparentPower
Apparent power sensor.
Definition: OverCurrentProtector.idl:58
pdumodel::Rating_2_0_0
Numerical usage ratings.
Definition: Nameplate.idl:15
pdumodel::OverCurrentProtector_3_0_6::getMetaData
MetaData getMetaData()
Retrieve the OCP metadata.
pdumodel::OverCurrentProtector_3_0_6::Sensors::activePower
sensors::NumericSensor_4_0_4 activePower
Active power sensor.
Definition: OverCurrentProtector.idl:56
pdumodel::OverCurrentProtector_3_0_6::getPoles
vector< DoublePole_6_0_0 > getPoles()
Get the list of OCP poles.
pdumodel::OverCurrentProtector_3_0_6::BREAKER_2POLE
@ BREAKER_2POLE
Two-pole circuit breaker.
Definition: OverCurrentProtector.idl:31
pdumodel::CircuitBreakerStatistic::tripCnt
int tripCnt
Trip count.
Definition: OverCurrentProtector.idl:22
pdumodel::OverCurrentProtector_3_0_6::Sensors::trip
sensors::StateSensor_4_0_4 trip
Trip sensor (an instance of OverCurrentProtectorTripSensor)
Definition: OverCurrentProtector.idl:51
pdumodel::OverCurrentProtector_3_0_6::MetaData
Overcurrent protector metadata.
Definition: OverCurrentProtector.idl:41
pdumodel::OverCurrentProtector_3_0_6::MetaData::rating
Rating_2_0_0 rating
Numerical usage ratings.
Definition: OverCurrentProtector.idl:44
pdumodel::OverCurrentProtector_3_0_6::BREAKER_1POLE
@ BREAKER_1POLE
Single-pole circuit breaker.
Definition: OverCurrentProtector.idl:30
pdumodel
PDU Model.
Definition: Ade.idl:12
pdumodel::OverCurrentProtector_3_0_6::Sensors::voltage
sensors::NumericSensor_4_0_4 voltage
RMS voltage sensor.
Definition: OverCurrentProtector.idl:52
pdumodel::OverCurrentProtector_3_0_6::Sensors::lineFrequency
sensors::NumericSensor_4_0_4 lineFrequency
AC line frequency sensor.
Definition: OverCurrentProtector.idl:65
pdumodel::OverCurrentProtector_3_0_6::setSettings
int setSettings(in Settings settings)
Change the OCP settings.
pdumodel::OverCurrentProtector_3_0_6::Sensors
Overcurrent protector sensors.
Definition: OverCurrentProtector.idl:50
pdumodel::OverCurrentProtector_3_0_6::newSettings
Settings newSettings
Settings after change.
Definition: OverCurrentProtector.idl:76
pdumodel::OverCurrentProtector_3_0_6::Sensors::powerFactor
sensors::NumericSensor_4_0_4 powerFactor
Power factor sensor.
Definition: OverCurrentProtector.idl:59
sensors::StateSensor_4_0_4
Sensor with discrete readings.
Definition: StateSensor.idl:43
pdumodel::OverCurrentProtector_3_0_6::MetaData::maxTripCnt
int maxTripCnt
Maximum trip count.
Definition: OverCurrentProtector.idl:46
pdumodel::OverCurrentProtector_3_0_6::Sensors::peakCurrent
sensors::NumericSensor_4_0_4 peakCurrent
Peak current sensor.
Definition: OverCurrentProtector.idl:54
pdumodel::OverCurrentProtector_3_0_6
Overcurrent protector interface.
Definition: OverCurrentProtector.idl:26
pdumodel::OverCurrentProtector_3_0_6::MetaData::type
Type type
OCP type.
Definition: OverCurrentProtector.idl:45
pdumodel::OverCurrentProtector_3_0_6::RCBO_3POLE
@ RCBO_3POLE
Three-pole residual-current device including overcurrent protection.
Definition: OverCurrentProtector.idl:36
pdumodel::Nameplate_2_0_0
Component nameplate information.
Definition: Nameplate.idl:23
pdumodel::OverCurrentProtector_3_0_6::getInlet
Inlet_2_0_6 getInlet()
Get the inlet this OCP is connected to.
pdumodel::OverCurrentProtector_3_0_6::BREAKER_3POLE
@ BREAKER_3POLE
Three-pole circuit breaker.
Definition: OverCurrentProtector.idl:32
pdumodel::OverCurrentProtector_3_0_6::getSettings
Settings getSettings()
Retrieve the OCP settings.
pdumodel::OverCurrentProtector_3_0_6::Sensors::displacementPowerFactor
sensors::NumericSensor_4_0_4 displacementPowerFactor
Displacement power factor sensor.
Definition: OverCurrentProtector.idl:60
pdumodel::CircuitBreakerStatistic
Overcurrent protector statistics.
Definition: OverCurrentProtector.idl:21
pdumodel::OverCurrentProtector_3_0_6::Settings
Overcurrent protector settings.
Definition: OverCurrentProtector.idl:69
pdumodel::OverCurrentProtector_3_0_6::Sensors::maximumCurrent
sensors::NumericSensor_4_0_4 maximumCurrent
Maximum current sensor.
Definition: OverCurrentProtector.idl:55
pdumodel::OverCurrentProtector_3_0_6::Sensors::activeEnergy
sensors::NumericSensor_4_0_4 activeEnergy
Active energy sensor.
Definition: OverCurrentProtector.idl:62
pdumodel::OverCurrentProtector_3_0_6::getSensors
Sensors getSensors()
Get the OCP sensors.
pdumodel::OverCurrentProtector_3_0_6::MetaData::label
string label
OCP label.
Definition: OverCurrentProtector.idl:42
pdumodel::OverCurrentProtector_3_0_6::getOCP
OverCurrentProtector_3_0_6 getOCP()
Get parent OCP - next OCP going towards inlet (for cascaded OCPs).
sensors::NumericSensor_4_0_4
A sensor with numeric readings.
Definition: NumericSensor.idl:17
pdumodel::Inlet_2_0_6
Inlet interface
Definition: Inlet.idl:22
pdumodel::OverCurrentProtector_3_0_6::FUSE
@ FUSE
Fuse.
Definition: OverCurrentProtector.idl:33
pdumodel::OverCurrentProtector_3_0_6::Sensors::current
sensors::NumericSensor_4_0_4 current
RMS current sensor.
Definition: OverCurrentProtector.idl:53
pdumodel::EDevice
Common base interface for any kind of electrical device that is used in the PDU model,...
Definition: EDevice.idl:24
pdumodel::OverCurrentProtector_3_0_6::Type
Type
Overcurrent protector type.
Definition: OverCurrentProtector.idl:29
pdumodel::OverCurrentProtector_3_0_6::FUSE_PAIR
@ FUSE_PAIR
Fuse Pair.
Definition: OverCurrentProtector.idl:34
pdumodel::OverCurrentProtector_3_0_6::Sensors::apparentEnergy
sensors::NumericSensor_4_0_4 apparentEnergy
Apparent energy sensor.
Definition: OverCurrentProtector.idl:63
pdumodel::OverCurrentProtector_3_0_6::RCBO_2POLE
@ RCBO_2POLE
Two-pole residual-current device including overcurrent protection.
Definition: OverCurrentProtector.idl:35
pdumodel::OverCurrentProtector_3_0_6::Sensors::reactivePower
sensors::NumericSensor_4_0_4 reactivePower
Reactive power sensor.
Definition: OverCurrentProtector.idl:57