Raritan PX2/PX3 JSON-RPC API
|
6 #ifndef __PDUMODEL_TRANSFERSWITCH_IDL__
7 #define __PDUMODEL_TRANSFERSWITCH_IDL__
10 #include <Nameplate.idl>
12 #include <StateSensor.idl>
22 constant
int ERR_INVALID_PARAM = 1;
23 constant
int ERR_SWITCH_PREVENTED = 2;
24 constant
int ERR_SWITCH_FAILED = 3;
42 REASON_INTERNAL_FAILURE
55 constant
int OPERATIONAL_STATE_OFF = 0;
56 constant
int OPERATIONAL_STATE_NORMAL = 1;
57 constant
int OPERATIONAL_STATE_STANDBY = 2;
58 constant
int OPERATIONAL_STATE_NON_REDUNDANT = 3;
61 constant
int SWITCH_FAULT_I1_SHORT = 1;
62 constant
int SWITCH_FAULT_I1_OPEN = 2;
63 constant
int SWITCH_FAULT_I2_SHORT = 4;
64 constant
int SWITCH_FAULT_I2_OPEN = 8;
103 valueobject SettingsChangedEvent extends
event.UserEvent {
Statistics getStatistics()
Retrieve the transfer switch statistics.
int autoRetransferWaitTime
Time (in s) to delay retransfer after power restoration.
Definition: TransferSwitch.idl:84
sensors::StateSensor_4_0_4 switchFault
Switch fault (ok, open, short)
Definition: TransferSwitch.idl:74
int switchFault
Switch fault status.
Definition: TransferSwitch.idl:191
Sensors Model.
Definition: AccumulatingNumericSensor.idl:13
TransferReason getLastTransferReason()
Get the reason for the last transfer.
@ REASON_OVERLOAD
Switched off due to overload alarm.
Definition: TransferSwitch.idl:40
Transfer log entry.
Definition: TransferSwitch.idl:184
@ REASON_STARTUP
Startup or return to normal conditions.
Definition: TransferSwitch.idl:35
sensors::StateSensor_4_0_4 operationalState
Operational state sensor (off, normal, standby)
Definition: TransferSwitch.idl:69
int preferredSource
Preferred inlet.
Definition: TransferSwitch.idl:81
int setParameters(in Parameters parameters)
Update one or more transfer switch parameters.
Numerical usage ratings.
Definition: Nameplate.idl:15
Parameters getParameters()
Retrieve the transfer switch parameters.
int setSettings(in Settings settings)
Change the transfer switch settings.
int transferCount
Number of transfers since device startup.
Definition: TransferSwitch.idl:90
@ REASON_MANUAL_TRANSFER
Manual transfer.
Definition: TransferSwitch.idl:36
@ REASON_OVERHEAT
Switched off due to overheat alarm.
Definition: TransferSwitch.idl:41
MetaData getMetaData()
Retrieve the transfer switch metadata.
vector< WaveformSample > waveform
Voltage and current waveforms.
Definition: TransferSwitch.idl:189
int transferToSource(in int source, in boolean faultOverride)
Select the active inlet.
boolean manualTransferEnabled
Enable state of 'manual transfer' front panel button.
Definition: TransferSwitch.idl:85
sensors::StateSensor_4_0_4 selectedSource
Selected source sensor.
Definition: TransferSwitch.idl:68
@ REASON_POWER_QUALITY
New inlet provided better power quality.
Definition: TransferSwitch.idl:39
int newInlet
Active inlet after transfer (0 for none)
Definition: TransferSwitch.idl:187
PDU Model.
Definition: Ade.idl:12
TransferReason reason
Transfer reason.
Definition: TransferSwitch.idl:188
Type
Transfer switch type.
Definition: TransferSwitch.idl:27
boolean noAutoRetransferIfPhaseFault
Don't automatically retransfer if inlet phases are out of sync.
Definition: TransferSwitch.idl:83
Sensor with discrete readings.
Definition: StateSensor.idl:43
int relayOpenTime
Time in us until all relays have opened during the last transfer.
Definition: TransferSwitch.idl:92
vector< WaveformSample > getLastTransferWaveform()
Get the voltage and current waveforms during the last transfer.
@ STS
Static transfer switch (using SCRs as switch technology)
Definition: TransferSwitch.idl:28
@ REASON_POWER_FAILURE
Previous inlet power failed.
Definition: TransferSwitch.idl:38
Transfer switch settings.
Definition: TransferSwitch.idl:78
Transfer switch sensors.
Definition: TransferSwitch.idl:67
Component nameplate information.
Definition: Nameplate.idl:23
time timestamp
Time of the transfer (UNIX timestamp, UTC)
Definition: TransferSwitch.idl:185
@ REASON_AUTO_RETRANSFER
Automatic retransfer.
Definition: TransferSwitch.idl:37
Transfer switch statistics.
Definition: TransferSwitch.idl:89
Settings newSettings
Settings after change.
Definition: TransferSwitch.idl:105
sensors::NumericSensor_4_0_4 sourceVoltagePhaseSyncAngle
Maximum phase difference between two sources.
Definition: TransferSwitch.idl:70
int oldInlet
Active inlet before transfer (0 for none)
Definition: TransferSwitch.idl:186
boolean autoRetransfer
Enable automatic retransfer if power on active inlet is restored.
Definition: TransferSwitch.idl:82
Statistics statistics
Transfer statistics.
Definition: TransferSwitch.idl:190
int totalTransferTime
Total time in us for last transfer.
Definition: TransferSwitch.idl:93
vector< ThrowPole_2_0_0 > getPoles()
Get the list of transfer switch poles.
int powerFailDetectTime
Detection time in us for the last inlet power failure.
Definition: TransferSwitch.idl:91
string name
User-defined name.
Definition: TransferSwitch.idl:79
@ REASON_UNKNOWN
Transfer reason unknown.
Definition: TransferSwitch.idl:34
Transfer switch interface.
Definition: TransferSwitch.idl:20
Sensors getSensors()
Get the transfer switch sensors.
vector< TransferLogEntry > getTransferLog()
Retrieve the transfer log.
map< string, int > Parameters
Transfer switch parameter map.
Definition: TransferSwitch.idl:208
A sensor with numeric readings.
Definition: NumericSensor.idl:17
sensors::StateSensor_4_0_4 phaseSyncAlarm
Source phases out of sync.
Definition: TransferSwitch.idl:73
Common base interface for any kind of electrical device that is used in the PDU model,...
Definition: EDevice.idl:24
Settings getSettings()
Retrieve the transfer switch settings.
@ ATS
Asynchronous transfer switch (using relays)
Definition: TransferSwitch.idl:29
sensors::StateSensor_4_0_4 overloadAlarm
Overload alarm.
Definition: TransferSwitch.idl:72
TransferReason
Definition: TransferSwitch.idl:33