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 */
21 structure CircuitBreakerStatistic {
22 int tripCnt; ///< Trip count
23 };
24
25 /** Overcurrent protector interface */
26 interface OverCurrentProtector_3_0_4 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_3 trip; ///< Trip sensor (an instance of {@link OverCurrentProtectorTripSensor})
52 sensors.NumericSensor_4_0_3 voltage; ///< RMS voltage sensor
53 sensors.NumericSensor_4_0_3 current; ///< RMS current sensor
54 sensors.NumericSensor_4_0_3 peakCurrent; ///< Peak current sensor
55 sensors.NumericSensor_4_0_3 maximumCurrent; ///< Maximum current sensor
56 sensors.NumericSensor_4_0_3 activePower; ///< Active power sensor
57 sensors.NumericSensor_4_0_3 reactivePower; ///< Reactive power sensor
58 sensors.NumericSensor_4_0_3 apparentPower; ///< Apparent power sensor
59 sensors.NumericSensor_4_0_3 powerFactor; ///< Power factor sensor
60 sensors.NumericSensor_4_0_3 displacementPowerFactor;///< Displacement power factor sensor
61 sensors.NumericSensor_4_0_3 crestFactor; ///< Crest factor sensor
62 sensors.NumericSensor_4_0_3 activeEnergy; ///< Active energy sensor
63 sensors.NumericSensor_4_0_3 apparentEnergy; ///< Apparent energy sensor
64 sensors.NumericSensor_4_0_3 phaseAngle; ///< Phase angle sensor
65 sensors.NumericSensor_4_0_3 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 */
84 MetaData getMetaData();
85
86 /**
87 * Get the OCP sensors.
88 *
89 * @return OCP sensors
90 */
91 Sensors getSensors();
92
93 /**
94 * Get the list of OCP poles.
95 *
96 * @return List of OCP poles
97 */
98 vector<DoublePole_5_0_0> getPoles();
99
100 /**
101 * Get the inlet this OCP is connected to
102 *
103 * @return inlet
104 */
105 Inlet_2_0_4 getInlet();
106
107 /**
108 * Get parent OCP - next OCP going towards inlet (for cascaded OCPs).
109 *
110 * @return OCP or null
111 */
112 OverCurrentProtector_3_0_4 getOCP();
113
114 /**
115 * Retrieve the OCP settings.
116 *
117 * @return OCP settings
118 */
119 Settings getSettings();
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_4::FUSE_PAIR
Fuse Pair.
Definition: OverCurrentProtector.idl:34
pdumodel::OverCurrentProtector_3_0_4::RCBO_2POLE
Two-pole residual-current device including overcurrent protection.
Definition: OverCurrentProtector.idl:35
pdumodel::OverCurrentProtector_3_0_4::Type
Type
Overcurrent protector type.
Definition: OverCurrentProtector.idl:29
pdumodel::OverCurrentProtector_3_0_4
Overcurrent protector interface.
Definition: OverCurrentProtector.idl:26
pdumodel::OverCurrentProtector_3_0_4::Sensors::powerFactor
sensors::NumericSensor_4_0_3 powerFactor
Power factor sensor.
Definition: OverCurrentProtector.idl:59
pdumodel::OverCurrentProtector_3_0_4::Sensors
Overcurrent protector sensors.
Definition: OverCurrentProtector.idl:50
pdumodel::Inlet_2_0_4
Inlet interface
Definition: Inlet.idl:22
pdumodel::OverCurrentProtector_3_0_4::Sensors::voltage
sensors::NumericSensor_4_0_3 voltage
RMS voltage sensor.
Definition: OverCurrentProtector.idl:52
pdumodel::OverCurrentProtector_3_0_4::MetaData::namePlate
Nameplate_2_0_0 namePlate
Nameplate information
Definition: OverCurrentProtector.idl:43
pdumodel::OverCurrentProtector_3_0_4::BREAKER_3POLE
Three-pole circuit breaker.
Definition: OverCurrentProtector.idl:32
pdumodel::OverCurrentProtector_3_0_4::RCBO_3POLE
Three-pole residual-current device including overcurrent protection.
Definition: OverCurrentProtector.idl:36
pdumodel::EDevice
Common base interface for any kind of electrical device that is used in the PDU model, such as inlets, OCPs and outlets.
Definition: EDevice.idl:24
pdumodel::OverCurrentProtector_3_0_4::FUSE
Fuse.
Definition: OverCurrentProtector.idl:33
pdumodel::OverCurrentProtector_3_0_4::Sensors::displacementPowerFactor
sensors::NumericSensor_4_0_3 displacementPowerFactor
Displacement power factor sensor.
Definition: OverCurrentProtector.idl:60
pdumodel::OverCurrentProtector_3_0_4::newSettings
Settings newSettings
Settings after change.
Definition: OverCurrentProtector.idl:76
pdumodel::CircuitBreakerStatistic
Overcurrent protector statistics.
Definition: OverCurrentProtector.idl:21
pdumodel::OverCurrentProtector_3_0_4::Sensors::peakCurrent
sensors::NumericSensor_4_0_3 peakCurrent
Peak current sensor.
Definition: OverCurrentProtector.idl:54
pdumodel::OverCurrentProtector_3_0_4::MetaData::label
string label
OCP label.
Definition: OverCurrentProtector.idl:42
pdumodel::OverCurrentProtector_3_0_4::Sensors::phaseAngle
sensors::NumericSensor_4_0_3 phaseAngle
Phase angle sensor.
Definition: OverCurrentProtector.idl:64
pdumodel::OverCurrentProtector_3_0_4::Sensors::trip
sensors::StateSensor_4_0_3 trip
Trip sensor (an instance of OverCurrentProtectorTripSensor)
Definition: OverCurrentProtector.idl:51
pdumodel::OverCurrentProtector_3_0_4::MetaData::maxTripCnt
int maxTripCnt
Maximum trip count.
Definition: OverCurrentProtector.idl:46
pdumodel::OverCurrentProtector_3_0_4::Sensors::maximumCurrent
sensors::NumericSensor_4_0_3 maximumCurrent
Maximum current sensor.
Definition: OverCurrentProtector.idl:55
pdumodel::OverCurrentProtector_3_0_4::Sensors::activeEnergy
sensors::NumericSensor_4_0_3 activeEnergy
Active energy sensor.
Definition: OverCurrentProtector.idl:62
pdumodel::Nameplate_2_0_0
Component nameplate information.
Definition: Nameplate.idl:23
pdumodel::OverCurrentProtector_3_0_4::BREAKER_2POLE
Two-pole circuit breaker.
Definition: OverCurrentProtector.idl:31
pdumodel::OverCurrentProtector_3_0_4::MetaData::rating
Rating_2_0_0 rating
Numerical usage ratings.
Definition: OverCurrentProtector.idl:44
pdumodel::OverCurrentProtector_3_0_4::Sensors::current
sensors::NumericSensor_4_0_3 current
RMS current sensor.
Definition: OverCurrentProtector.idl:53
sensors
Sensors Model.
Definition: AccumulatingNumericSensor.idl:13
pdumodel::OverCurrentProtector_3_0_4::MetaData::type
Type type
OCP type.
Definition: OverCurrentProtector.idl:45
pdumodel::OverCurrentProtector_3_0_4::Sensors::apparentEnergy
sensors::NumericSensor_4_0_3 apparentEnergy
Apparent energy sensor.
Definition: OverCurrentProtector.idl:63
pdumodel
PDU Model.
Definition: Ade.idl:12
pdumodel::OverCurrentProtector_3_0_4::MetaData
Overcurrent protector metadata.
Definition: OverCurrentProtector.idl:41
pdumodel::OverCurrentProtector_3_0_4::BREAKER_1POLE
Single-pole circuit breaker.
Definition: OverCurrentProtector.idl:30
pdumodel::OverCurrentProtector_3_0_4::Sensors::lineFrequency
sensors::NumericSensor_4_0_3 lineFrequency
AC line frequency sensor.
Definition: OverCurrentProtector.idl:65
pdumodel::OverCurrentProtector_3_0_4::Settings
Overcurrent protector settings.
Definition: OverCurrentProtector.idl:69
sensors::NumericSensor_4_0_3
A sensor with numeric readings.
Definition: NumericSensor.idl:17
pdumodel::CircuitBreakerStatistic::tripCnt
int tripCnt
Trip count.
Definition: OverCurrentProtector.idl:22
pdumodel::Rating_2_0_0
Numerical usage ratings.
Definition: Nameplate.idl:15
sensors::StateSensor_4_0_3
Sensor with discrete readings.
Definition: StateSensor.idl:43
pdumodel::OverCurrentProtector_3_0_4::Sensors::reactivePower
sensors::NumericSensor_4_0_3 reactivePower
Reactive power sensor.
Definition: OverCurrentProtector.idl:57
pdumodel::OverCurrentProtector_3_0_4::Settings::name
string name
User-defined name.
Definition: OverCurrentProtector.idl:70
pdumodel::OverCurrentProtector_3_0_4::Sensors::apparentPower
sensors::NumericSensor_4_0_3 apparentPower
Apparent power sensor.
Definition: OverCurrentProtector.idl:58
pdumodel::OverCurrentProtector_3_0_4::Sensors::crestFactor
sensors::NumericSensor_4_0_3 crestFactor
Crest factor sensor.
Definition: OverCurrentProtector.idl:61
pdumodel::OverCurrentProtector_3_0_4::Sensors::activePower
sensors::NumericSensor_4_0_3 activePower
Active power sensor.
Definition: OverCurrentProtector.idl:56