Raritan PX2/PX3 JSON-RPC API
TransferSwitch.idl
1 #ifndef __PDUMODEL_TRANSFERSWITCH_IDL__
2 #define __PDUMODEL_TRANSFERSWITCH_IDL__
3 
4 #include <EDevice.idl>
5 #include <Nameplate.idl>
6 #include <Pole.idl>
7 #include <StateSensor.idl>
8 
12 module pdumodel {
13 
15  interface TransferSwitch_4_0_2 extends EDevice {
16 
17  constant int ERR_INVALID_PARAM = 1;
18  constant int ERR_SWITCH_PREVENTED = 2;
19  constant int ERR_SWITCH_FAILED = 3;
20 
22  enumeration Type {
23  STS,
24  ATS,
25  HTS
26  };
27 
28  enumeration TransferReason {
37  REASON_INTERNAL_FAILURE
38  };
39 
41  structure MetaData {
42  string label;
47  };
48 
49  /* Values for operational state sensor */
50  constant int OPERATIONAL_STATE_OFF = 0;
51  constant int OPERATIONAL_STATE_NORMAL = 1;
52  constant int OPERATIONAL_STATE_STANDBY = 2;
53  constant int OPERATIONAL_STATE_NON_REDUNDANT = 3;
54 
55  /* Bitmask values for switch fault sensors */
56  constant int SWITCH_FAULT_I1_SHORT = 1;
57  constant int SWITCH_FAULT_I1_OPEN = 2;
58  constant int SWITCH_FAULT_I2_SHORT = 4;
59  constant int SWITCH_FAULT_I2_OPEN = 8;
60 
62  structure Sensors {
70  };
71 
73  structure Settings {
74  string name;
75 
77  boolean autoRetransfer;
81  };
82 
84  structure Statistics {
89  };
90 
92  structure WaveformSample {
93  double voltage;
94  double current;
95  };
96 
98  valueobject SettingsChangedEvent extends event.UserEvent {
99  Settings oldSettings;
101  };
102 
108  MetaData getMetaData();
109 
115  Sensors getSensors();
116 
122  vector<ThrowPole_2_0_0> getPoles();
123 
129  Settings getSettings();
130 
137  int setSettings(in Settings settings);
138 
144  Statistics getStatistics();
145 
159  int transferToSource(in int source, in boolean faultOverride);
160 
166  TransferReason getLastTransferReason();
167 
176  vector<WaveformSample> getLastTransferWaveform();
177 
179  structure TransferLogEntry {
180  time timestamp;
181  int oldInlet;
182  int newInlet;
184  vector<WaveformSample> waveform;
187  };
188 
194  vector<TransferLogEntry> getTransferLog();
195 
203  typedef map<string, int> Parameters;
204 
210  Parameters getParameters();
211 
221  int setParameters(in Parameters parameters);
222 
223  };
224 
225 }
226 
227 #endif
Transfer switch sensors.
Definition: TransferSwitch.idl:62
A sensor with numeric readings.
Definition: NumericSensor.idl:12
Numerical usage ratings.
Definition: Nameplate.idl:10
Transfer log entry.
Definition: TransferSwitch.idl:179
int newInlet
Active inlet after transfer (0 for none)
Definition: TransferSwitch.idl:182
Sensor with discrete readings.
Definition: StateSensor.idl:38
sensors::StateSensor_4_0_2 phaseSyncAlarm
Source phases out of sync.
Definition: TransferSwitch.idl:68
Sample of voltage and current waveform.
Definition: TransferSwitch.idl:92
boolean manualTransferEnabled
Enable state of &#39;manual transfer&#39; front panel button.
Definition: TransferSwitch.idl:80
sensors::StateSensor_4_0_2 operationalState
Operational state sensor (off, normal, standby)
Definition: TransferSwitch.idl:64
boolean noAutoRetransferIfPhaseFault
Don&#39;t automatically retransfer if inlet phases are out of sync.
Definition: TransferSwitch.idl:78
Transfer reason unknown.
Definition: TransferSwitch.idl:29
Nameplate namePlate
Nameplate information
Definition: TransferSwitch.idl:43
Asynchronous transfer switch (using relays)
Definition: TransferSwitch.idl:24
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:19
Transfer switch settings.
Definition: TransferSwitch.idl:73
int oldInlet
Active inlet before transfer (0 for none)
Definition: TransferSwitch.idl:181
Switched off due to overload alarm.
Definition: TransferSwitch.idl:35
Type
Transfer switch type.
Definition: TransferSwitch.idl:22
Statistics statistics
Transfer statistics.
Definition: TransferSwitch.idl:185
Settings newSettings
Settings after change.
Definition: TransferSwitch.idl:100
int powerFailDetectTime
Detection time in us for the last inlet power failure.
Definition: TransferSwitch.idl:86
New inlet provided better power quality.
Definition: TransferSwitch.idl:34
TransferReason reason
Transfer reason.
Definition: TransferSwitch.idl:183
Transfer switch metadata.
Definition: TransferSwitch.idl:41
vector< WaveformSample > waveform
Voltage and current waveforms.
Definition: TransferSwitch.idl:184
int switchFault
Switch fault status.
Definition: TransferSwitch.idl:186
TransferReason
Definition: TransferSwitch.idl:28
sensors::NumericSensor_4_0_2 sourceVoltagePhaseSyncAngle
Maximum phase difference between two sources.
Definition: TransferSwitch.idl:65
Component nameplate information.
Definition: Nameplate.idl:17
time timestamp
Time of the transfer.
Definition: TransferSwitch.idl:180
Transfer switch statistics.
Definition: TransferSwitch.idl:84
Manual transfer.
Definition: TransferSwitch.idl:31
int autoRetransferWaitTime
Time (in s) to delay retransfer after power restoration.
Definition: TransferSwitch.idl:79
boolean autoRetransfer
Enable automatic retransfer if power on active inlet is restored.
Definition: TransferSwitch.idl:77
Type type
Transfer switch type.
Definition: TransferSwitch.idl:45
Transfer switch interface.
Definition: TransferSwitch.idl:15
string label
Transfer switch label.
Definition: TransferSwitch.idl:42
Previous inlet power failed.
Definition: TransferSwitch.idl:33
Automatic retransfer.
Definition: TransferSwitch.idl:32
double voltage
Voltage sample in Volts.
Definition: TransferSwitch.idl:93
Sensors Model.
Definition: AccumulatingNumericSensor.idl:8
sensors::StateSensor_4_0_2 switchFault
Switch fault (ok, open, short)
Definition: TransferSwitch.idl:69
PDU Model.
Definition: Ade.idl:7
int sourceCount
Number of sources.
Definition: TransferSwitch.idl:46
double current
Current sample in Amperes.
Definition: TransferSwitch.idl:94
string name
User-defined name.
Definition: TransferSwitch.idl:74
sensors::StateSensor_4_0_2 overloadAlarm
Overload alarm.
Definition: TransferSwitch.idl:67
sensors::StateSensor_4_0_2 selectedSource
Selected source sensor.
Definition: TransferSwitch.idl:63
Switched off due to overheat alarm.
Definition: TransferSwitch.idl:36
Startup or return to normal conditions.
Definition: TransferSwitch.idl:30
Rating rating
Numerical usage ratings.
Definition: TransferSwitch.idl:44
int relayOpenTime
Time in us until all relays have opened during the last transfer.
Definition: TransferSwitch.idl:87
int transferCount
Number of transfers since device startup.
Definition: TransferSwitch.idl:85
int totalTransferTime
Total time in us for last transfer.
Definition: TransferSwitch.idl:88
Static transfer switch (using SCRs as switch technology)
Definition: TransferSwitch.idl:23
int preferredSource
Preferred inlet.
Definition: TransferSwitch.idl:76
map< string, int > Parameters
Transfer switch parameter map.
Definition: TransferSwitch.idl:203