Raritan PX2/PX3 JSON-RPC API
|
7 #include <PeripheralDeviceSlot.idl>
8 #include <UserEvent.idl>
52 valueobject SettingsChangedEvent extends
event.UserEvent {
58 valueobject LoggedSensorsChangedEvent extends
event.UserEvent {
79 int setSettings(in
boolean isEnabled, in
int samplesPerRecord);
82 constant
int STATE_UNAVAILABLE = 0;
83 constant
int STATE_OPEN = 1;
84 constant
int STATE_CLOSE = 2;
85 constant
int STATE_BELOW_LOWER_CRITICAL = 3;
86 constant
int STATE_BELOW_LOWER_WARNING = 4;
87 constant
int STATE_NORMAL = 5;
88 constant
int STATE_ABOVE_UPPER_WARNING = 6;
89 constant
int STATE_ABOVE_UPPER_CRITICAL = 7;
90 constant
int STATE_ON = 8;
91 constant
int STATE_OFF = 9;
92 constant
int STATE_ALARMED = 10;
93 constant
int STATE_OK = 11;
94 constant
int STATE_MARGINAL = 12;
95 constant
int STATE_FAIL = 13;
96 constant
int STATE_YES = 14;
97 constant
int STATE_NO = 15;
98 constant
int STATE_STANDBY = 16;
99 constant
int STATE_ONE = 17;
100 constant
int STATE_TWO = 18;
101 constant
int STATE_IN_SYNC = 19;
102 constant
int STATE_OUT_OF_SYNC = 20;
103 constant
int STATE_FAULT = 21;
104 constant
int STATE_SELF_TEST = 22;
105 constant
int STATE_I1_OPEN_FAULT = 23;
106 constant
int STATE_I1_SHORT_FAULT = 24;
107 constant
int STATE_I2_OPEN_FAULT = 25;
108 constant
int STATE_I2_SHORT_FAULT = 26;
109 constant
int STATE_WARNING = 27;
110 constant
int STATE_CRITICAL = 28;
111 constant
int STATE_NON_REDUNDANT = 29;
124 in
int recid, in
int count);
148 in
int recid, in
int count);
163 in
int recid, in
int count);
183 in
int recid, in
int count);
198 in
int recid, in
int count);
vector< Record > sensorRecords
Sensor records; same order as in SensorSet::sensors.
Definition: SensorLogger.idl:288
int disableSensors(in SensorSet sensors)
Disable logging for one or more sensors or peripheral device slots.
Record record
Log record.
Definition: SensorLogger.idl:168
Sensor logger interface.
Definition: SensorLogger.idl:31
int logCapacity
Maximum number of log records in buffer.
Definition: SensorLogger.idl:40
Peripheral Devices.
Definition: PeripheralDeviceManager.idl:18
Sensors Model.
Definition: AccumulatingNumericSensor.idl:13
boolean isEnabled
true if sensor logging is enabled
Definition: SensorLogger.idl:35
SensorSet getLoggedSensors()
Retrieve the set of logged sensors.
vector< Record > peripheralDeviceRecords
Peripheral device records; same order as in SensorSet::slots.
Definition: SensorLogger.idl:290
time timestamp
UNIX timestamp (UTC)
Definition: SensorLogger.idl:167
Settings newSettings
Settings after change.
Definition: SensorLogger.idl:54
double minValue
Minimum sensor reading.
Definition: SensorLogger.idl:131
double avgValue
Average sensor reading.
Definition: SensorLogger.idl:132
time sensorSetTimestamp
Time of last sensor set modification (UNIX timestamp, UTC)
Definition: SensorLogger.idl:284
int enableSensors(in SensorSet sensors)
Enable logging for one or more sensors or peripheral device slots.
void enableAllSensors()
Enable logging for all PDU sensors.
int setLoggedSensors(in SensorSet sensors)
Change the set of logged sensors.
int newestRecId
ID of newest record in buffer (0 if empty)
Definition: SensorLogger.idl:39
int oldestRecId
ID of oldest record in buffer (0 if empty)
Definition: SensorLogger.idl:38
int setSettings(in boolean isEnabled, in int samplesPerRecord)
Change the sensor logger settings.
int state
Sensor state.
Definition: SensorLogger.idl:130
int takenValidSamples
Number of samples with a valid reading/state.
Definition: SensorLogger.idl:129
double maxValue
Maximum sensor reading.
Definition: SensorLogger.idl:133
Peripheral Device Slot.
Definition: PeripheralDeviceSlot.idl:61
SensorSet newSensors
Sensor set after change.
Definition: SensorLogger.idl:60
int getSensorRecords(out vector< Record > recs, in sensors::Sensor_4_0_4 sensor, in int recid, in int count)
Retrieve log records for a given sensor.
int getTimeStamps(out vector< time > timestamps, in int recid, in int count)
Retrieve a set of log record timestamps.
int getPeripheralDeviceRecords(out vector< Record > recs, in peripheral::DeviceSlot_3_0_0 slot, in int recid, in int count)
Retrieve log records for an peripheral device slot.
Sensor interface
Definition: Sensor.idl:15
vector< sensors::Sensor_4_0_4 > sensors
List of numeric or state sensors.
Definition: SensorLogger.idl:46
Set of logged sensors.
Definition: SensorLogger.idl:44
time timestamp
Log row time stamp (UNIX timestamp, UTC)
Definition: SensorLogger.idl:286
Sensor log record with timestamp.
Definition: SensorLogger.idl:166
vector< peripheral::DeviceSlot_3_0_0 > slots
List of peripheral device slots.
Definition: SensorLogger.idl:48
int samplesPerRecord
Number of samples per log record.
Definition: SensorLogger.idl:37
int getLogRow(out LogRow row, in int recid)
Get one full log row.
One full log row.
Definition: SensorLogger.idl:282
boolean isSlotEnabled(in peripheral::DeviceSlot_3_0_0 slot)
Check if logging is enabled for a given peripheral device slot.
void disableAllSensors()
Disable logging for all PDU sensors.
boolean isSensorEnabled(in sensors::Sensor_4_0_4 sensor)
Check if logging is enabled for a given sensor.
boolean available
Sensor was available for at least one sample.
Definition: SensorLogger.idl:128
Sensor logger settings.
Definition: SensorLogger.idl:34
int samplePeriod
Sensor scan interval in milliseconds.
Definition: SensorLogger.idl:36
int getPeripheralDeviceTimedRecords(out vector< TimedRecord > recs, in peripheral::DeviceSlot_3_0_0 slot, in int recid, in int count)
Retrieve log records with timestamps for an peripheral device slot.
int getSensorTimedRecords(out vector< TimedRecord > recs, in sensors::Sensor_4_0_4 sensor, in int recid, in int count)
Retrieve log records with timestamps for a given sensor.
Settings getSettings()
Retrieve the sensor logger settings.
Sensor log record.
Definition: SensorLogger.idl:127
time getSensorSetTimestamp()
Get the time of the last sensor set modification.