Raritan PX2/PX3 JSON-RPC API
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
SensorLogger.idl
1 #include <Sensor.idl>
2 #include <PeripheralDeviceSlot.idl>
3 #include <UserEvent.idl>
4 
6 module sensors {
7 
16  interface Logger_2_1_3 {
17 
19  structure Settings {
20  boolean isEnabled;
26  };
27 
29  structure SensorSet {
31  vector<sensors.Sensor_4_0_1> sensors;
33  vector<peripheral.DeviceSlot_2_0_1> slots;
34  };
35 
37  valueobject SettingsChangedEvent extends event.UserEvent {
38  Settings oldSettings;
40  };
41 
43  valueobject LoggedSensorsChangedEvent extends event.UserEvent {
44  SensorSet oldSensors;
46  };
47 
53  Settings getSettings();
54 
64  int setSettings(in boolean isEnabled, in int samplesPerRecord);
65 
67  constant int STATE_UNAVAILABLE = 0;
68  constant int STATE_OPEN = 1;
69  constant int STATE_CLOSE = 2;
70  constant int STATE_BELOW_LOWER_CRITICAL = 3;
71  constant int STATE_BELOW_LOWER_WARNING = 4;
72  constant int STATE_NORMAL = 5;
73  constant int STATE_ABOVE_UPPER_WARNING = 6;
74  constant int STATE_ABOVE_UPPER_CRITICAL = 7;
75  constant int STATE_ON = 8;
76  constant int STATE_OFF = 9;
77  constant int STATE_ALARMED = 10;
78  constant int STATE_OK = 11;
79  constant int STATE_MARGINAL = 12;
80  constant int STATE_FAIL = 13;
81  constant int STATE_YES = 14;
82  constant int STATE_NO = 15;
83  constant int STATE_STANDBY = 16;
84  constant int STATE_ONE = 17;
85  constant int STATE_TWO = 18;
86  constant int STATE_IN_SYNC = 19;
87  constant int STATE_OUT_OF_SYNC = 20;
88  constant int STATE_FAULT = 21;
89  constant int STATE_SELF_TEST = 22;
90  constant int STATE_I1_OPEN_FAULT = 23;
91  constant int STATE_I1_SHORT_FAULT = 24;
92  constant int STATE_I2_OPEN_FAULT = 25;
93  constant int STATE_I2_SHORT_FAULT = 26;
94  constant int STATE_WARNING = 27;
95  constant int STATE_CRITICAL = 28;
96  constant int STATE_NON_REDUNDANT = 29;
97 
108  int getTimeStamps(out vector<time> timestamps,
109  in int recid, in int count);
110 
112  structure Record {
113  boolean available;
115  int state;
116  double minValue;
117  double avgValue;
118  double maxValue;
119  };
120 
132  int getSensorRecords(out vector<Record> recs, in sensors.Sensor_4_0_1 sensor,
133  in int recid, in int count);
134 
146  int getPeripheralDeviceRecords(out vector<Record> recs,
147  in peripheral.DeviceSlot_2_0_1 slot,
148  in int recid, in int count);
149 
151  structure TimedRecord {
152  time timestamp;
154  };
155 
167  int getSensorTimedRecords(out vector<TimedRecord> recs, in sensors.Sensor_4_0_1 sensor,
168  in int recid, in int count);
169 
181  int getPeripheralDeviceTimedRecords(out vector<TimedRecord> recs,
182  in peripheral.DeviceSlot_2_0_1 slot,
183  in int recid, in int count);
184 
190  SensorSet getLoggedSensors();
191 
200  int setLoggedSensors(in SensorSet sensors);
201 
205  void enableAllSensors();
206 
210  void disableAllSensors();
211 
220  time getSensorSetTimestamp();
221 
223  structure LogRow {
227  time timestamp;
229  vector<Record> sensorRecords;
231  vector<Record> peripheralDeviceRecords;
232  };
233 
243  int getLogRow(out LogRow row, in int recid);
244 
245  };
246 
247 }
boolean isEnabled
true if sensor logging is enabled
Definition: SensorLogger.idl:20
time sensorSetTimestamp
Time of last sensor set modification.
Definition: SensorLogger.idl:225
Set of logged sensors.
Definition: SensorLogger.idl:29
time timestamp
Timestamp.
Definition: SensorLogger.idl:152
Sensor log record with timestamp.
Definition: SensorLogger.idl:151
SensorSet newSensors
Sensor set after change.
Definition: SensorLogger.idl:45
Settings newSettings
Settings after change.
Definition: SensorLogger.idl:39
vector< Record > sensorRecords
Sensor records; same order as in SensorSet::sensors.
Definition: SensorLogger.idl:229
int newestRecId
Id of newest record in ring buffer.
Definition: SensorLogger.idl:24
double maxValue
Maximum sensor reading.
Definition: SensorLogger.idl:118
vector< peripheral.DeviceSlot_2_0_1 > slots
List of peripheral device slots.
Definition: SensorLogger.idl:33
double minValue
Minimum sensor reading.
Definition: SensorLogger.idl:116
int logCapacity
Number of log records in ring buffer.
Definition: SensorLogger.idl:25
One full log row.
Definition: SensorLogger.idl:223
Sensor log record.
Definition: SensorLogger.idl:112
boolean available
Sensor was available for at least one sample.
Definition: SensorLogger.idl:113
time timestamp
Log row time stamp.
Definition: SensorLogger.idl:227
Sensor logger settings.
Definition: SensorLogger.idl:19
int samplesPerRecord
Number of samples per log record.
Definition: SensorLogger.idl:22
vector< sensors.Sensor_4_0_1 > sensors
List of numeric or state sensors.
Definition: SensorLogger.idl:31
int state
Sensor state.
Definition: SensorLogger.idl:115
int oldestRecId
Id of oldest record in ring buffer.
Definition: SensorLogger.idl:23
Record record
Log record.
Definition: SensorLogger.idl:153
int samplePeriod
Sensor scan interval in milliseconds.
Definition: SensorLogger.idl:21
Sensor logger interface.
Definition: SensorLogger.idl:16
int takenValidSamples
Number of samples with a valid reading/state.
Definition: SensorLogger.idl:114
vector< Record > peripheralDeviceRecords
Peripheral device records; same order as in SensorSet::slots.
Definition: SensorLogger.idl:231
double avgValue
Average sensor reading.
Definition: SensorLogger.idl:117