Raritan PX2/PX3 JSON-RPC API
|
6 #ifndef __PDUMODEL_PDU_IDL__
7 #define __PDUMODEL_PDU_IDL__
9 #include <Nameplate.idl>
11 #include <PeripheralDeviceManager.idl>
13 #include <OverCurrentProtector.idl>
15 #include <TransferSwitch.idl>
16 #include <StateSensor.idl>
17 #include <SensorLogger.idl>
18 #include <Controller.idl>
19 #include <InternalBeeper.idl>
29 constant
int ERR_INVALID_PARAM = 1;
101 valueobject SettingsChangedEvent extends
event.UserEvent {
107 valueobject LoadSheddingModeChangedEvent extends
event.UserEvent {
112 valueobject OutletSequenceStateChangedEvent extends
idl.Event {
309 in
boolean respectSequence);
328 in
boolean respectSequence);
OutletSequenceState getOutletSequenceState()
Retrieve the current outlet sequencing status.
StartupState startupState
Default outlet state on device startup; can be overriden per outlet.
Definition: Pdu.idl:72
Internal beeper interface.
Definition: InternalBeeper.idl:15
Peripheral Devices.
Definition: PeripheralDeviceManager.idl:18
Sensors Model.
Definition: AccumulatingNumericSensor.idl:13
void setLoadSheddingActive(in boolean active)
Enable or disable load shedding.
Settings newSettings
Settings after change.
Definition: Pdu.idl:103
Human Machine Interface.
Definition: ExternalBeeper.idl:14
peripheral::DeviceManager_5_0_0 getPeripheralDeviceManager()
Get the peripheral device manager.
vector< Outlet_2_1_8 > getOutlets()
Get the list of outlets.
boolean sequenceRunning
true if an outlet sequence is currently running
Definition: Pdu.idl:92
int timeUntilNextSwitch
Time in milliseconds before the next outlet is switched.
Definition: Pdu.idl:94
int demandUpdateInterval
BCM2 only: Update interval in seconds for demand sensors.
Definition: Pdu.idl:86
Outlet interface
Definition: Outlet.idl:29
string name
User-defined name.
Definition: Pdu.idl:71
Sensors getSensors()
Retrieve the PDU sensors.
Peripheral device statistics.
Definition: PeripheralDeviceManager.idl:123
sensors::NumericSensor_4_0_4 activeEnergy
Active energy sensor.
Definition: Pdu.idl:51
Peripheral Device Manager.
Definition: PeripheralDeviceManager.idl:21
int powerOnDelay
Delay in seconds before restoring outlet states after device startup.
Definition: Pdu.idl:82
int inRushGuardDelay
Minimum delay in milliseconds between switching two outlets on.
Definition: Pdu.idl:74
Main PDU interface.
Definition: Pdu.idl:27
int leaveRS485ConfigMode()
Leave RS485 config mode.
int enterRS485ConfigModeAndAssignCtrlBoardAddress(in int addr)
Enter RS485 config mode and assign an address to a relay board.
vector< Inlet_2_0_7 > getInlets()
Get the list of inlets.
PDU Model.
Definition: Ade.idl:12
int setSettings(in Settings settings)
Change the PDU settings.
Port interface.
Definition: Port.idl:18
Sensor logger interface.
Definition: SensorLogger.idl:31
Sensor with discrete readings.
Definition: StateSensor.idl:43
Outlet sequencing status
Definition: Pdu.idl:91
int setAllOutletPowerStates(in Outlet_2_1_8::PowerState pstate)
Switch all outlets.
int cycleAllOutletPowerStates()
Power-cycle all outlets.
vector< CircuitBreakerStatistic > cbStats
Circuit breaker statistics.
Definition: Pdu.idl:56
vector< OutletStatistic > outletStats
Outlet statistics
Definition: Pdu.idl:58
vector< Controller_4_0_1 > getControllers()
Get the list of slave controllers.
PDU sensors.
Definition: Pdu.idl:48
Basic IDL definitions.
Definition: Event.idl:10
int energyPulsesPerKWh
Ratio between LED pulses and energy consumption.
Definition: Pdu.idl:85
int cycleMultipleOutletPowerStates(in vector< int > outletNumbers, in boolean respectSequence)
Power-cycle multiple outlets.
Ports.
Definition: Port.idl:15
Component nameplate information.
Definition: Nameplate.idl:23
boolean isLoadSheddingActive()
Retrieve the current load shedding state.
int cancelableOutletsRemaining
Number of outlets remaining whose switch operation can be canceled (non-cancelable operations won't b...
Definition: Pdu.idl:96
boolean latchingRelays
If true, relays keep their state during power-cycling.
Definition: Pdu.idl:83
Nameplate_2_0_0 getNameplate()
Retrieve the PDU nameplate information.
vector< portsmodel::Port_2_0_2 > getRemoteHubPorts()
Get all remote hub ports of this device.
vector< portsmodel::Port_2_0_2 > getSensorPorts()
Get all sensor ports of this device.
int cycleDelay
Default power-cycle interval in seconds; can be overriden per outlet.
Definition: Pdu.idl:73
vector< TransferSwitch_4_0_5 > getTransferSwitches()
Returns list of Transfer Switches.
Settings getSettings()
Retrieve the PDU settings.
int outletsRemaining
Number of outlets remaining in the sequence.
Definition: Pdu.idl:95
sensors::NumericSensor_4_0_4 activePower
Active power sensor.
Definition: Pdu.idl:50
vector< portsmodel::Port_2_0_2 > getFeaturePorts()
Get all feature ports of this device.
int setMultipleOutletPowerStates(in vector< int > outletNumbers, in Outlet_2_1_8::PowerState state, in boolean respectSequence)
Switch multiple outlets.
sensors::Logger_2_3_7 getSensorLogger()
Get the sensor logger.
vector< OverCurrentProtector_3_0_7 > getOverCurrentProtectors()
Get the list of overcurrent protectors.
vector< int > outletPowerStateSequence
The order in which multiple outlets should be switched.
Definition: Pdu.idl:75
int nextOutletToSwitch
Number (zero-based) of the next outlet in the sequence.
Definition: Pdu.idl:93
StartupState
Outlet power state on device startup
Definition: Pdu.idl:63
PDU settings.
Definition: Pdu.idl:70
vector< CtrlStatistic > ctrlStats
Slave controller statistics.
Definition: Pdu.idl:57
MetaData getMetaData()
Retrieve the PDU metadata.
@ SS_OFF
Outlet will be switched off
Definition: Pdu.idl:65
vector< sensors::StateSensor_4_0_4 > powerSupplyStatus
Power supply fault status.
Definition: Pdu.idl:49
Statistic getStatistic()
Retrieve PDU statistics.
PowerState
Outlet power state.
Definition: Outlet.idl:50
@ SS_ON
Outlet will be switched on
Definition: Pdu.idl:64
A sensor with numeric readings.
Definition: NumericSensor.idl:17
void cancelOutletSequence()
Stop a currently running outlet sequence.
int enterRS485ConfigModeAndAssignSCBoardAddress(in int deviceId, in int addr)
Enter RS485 config mode and assign an address to a slave controller device with a given device ID.
int demandAveragingIntervals
BCM2 only: Average demand sensors over this many update intervals.
Definition: Pdu.idl:87
hmi::InternalBeeper_2_0_1 getBeeper()
Get the built-in beeper, if there is any.
boolean energyPulseEnabled
Enables energy consumption counting using the PDU's LED(s)
Definition: Pdu.idl:84
PDU statistics.
Definition: Pdu.idl:55
peripheral::DeviceManager_5_0_0 Statistics peripheralStats
Peripheral device statistics.
Definition: Pdu.idl:59