Raritan EMX JSON-RPC API
SensorLogger.idl
1 #include <Sensor.idl>
2 #include <PeripheralDeviceSlot.idl>
3 #include <UserEvent.idl>
4 
6 module sensors {
7 
26  interface Logger_2_1_5 {
27 
29  structure Settings {
30  boolean isEnabled;
36  };
37 
39  structure SensorSet {
44  };
45 
47  valueobject SettingsChangedEvent extends event.UserEvent {
48  Settings oldSettings;
50  };
51 
53  valueobject LoggedSensorsChangedEvent extends event.UserEvent {
54  SensorSet oldSensors;
56  };
57 
63  Settings getSettings();
64 
74  int setSettings(in boolean isEnabled, in int samplesPerRecord);
75 
77  constant int STATE_UNAVAILABLE = 0;
78  constant int STATE_OPEN = 1;
79  constant int STATE_CLOSE = 2;
80  constant int STATE_BELOW_LOWER_CRITICAL = 3;
81  constant int STATE_BELOW_LOWER_WARNING = 4;
82  constant int STATE_NORMAL = 5;
83  constant int STATE_ABOVE_UPPER_WARNING = 6;
84  constant int STATE_ABOVE_UPPER_CRITICAL = 7;
85  constant int STATE_ON = 8;
86  constant int STATE_OFF = 9;
87  constant int STATE_ALARMED = 10;
88  constant int STATE_OK = 11;
89  constant int STATE_MARGINAL = 12;
90  constant int STATE_FAIL = 13;
91  constant int STATE_YES = 14;
92  constant int STATE_NO = 15;
93  constant int STATE_STANDBY = 16;
94  constant int STATE_ONE = 17;
95  constant int STATE_TWO = 18;
96  constant int STATE_IN_SYNC = 19;
97  constant int STATE_OUT_OF_SYNC = 20;
98  constant int STATE_FAULT = 21;
99  constant int STATE_SELF_TEST = 22;
100  constant int STATE_I1_OPEN_FAULT = 23;
101  constant int STATE_I1_SHORT_FAULT = 24;
102  constant int STATE_I2_OPEN_FAULT = 25;
103  constant int STATE_I2_SHORT_FAULT = 26;
104  constant int STATE_WARNING = 27;
105  constant int STATE_CRITICAL = 28;
106  constant int STATE_NON_REDUNDANT = 29;
107 
118  int getTimeStamps(out vector<time> timestamps,
119  in int recid, in int count);
120 
122  structure Record {
123  boolean available;
125  int state;
126  double minValue;
127  double avgValue;
128  double maxValue;
129  };
130 
142  int getSensorRecords(out vector<Record> recs, in sensors.Sensor_4_0_2 sensor,
143  in int recid, in int count);
144 
156  int getPeripheralDeviceRecords(out vector<Record> recs,
158  in int recid, in int count);
159 
161  structure TimedRecord {
162  time timestamp;
164  };
165 
177  int getSensorTimedRecords(out vector<TimedRecord> recs, in sensors.Sensor_4_0_2 sensor,
178  in int recid, in int count);
179 
191  int getPeripheralDeviceTimedRecords(out vector<TimedRecord> recs,
193  in int recid, in int count);
194 
200  SensorSet getLoggedSensors();
201 
210  int setLoggedSensors(in SensorSet sensors);
211 
223  int enableSensors(in SensorSet sensors);
224 
236  int disableSensors(in SensorSet sensors);
237 
245  boolean isSensorEnabled(in sensors.Sensor_4_0_2 sensor);
246 
254  boolean isSlotEnabled(in peripheral.DeviceSlot_2_0_2 slot);
255 
259  void enableAllSensors();
260 
264  void disableAllSensors();
265 
274  time getSensorSetTimestamp();
275 
277  structure LogRow {
281  time timestamp;
283  vector<Record> sensorRecords;
285  vector<Record> peripheralDeviceRecords;
286  };
287 
297  int getLogRow(out LogRow row, in int recid);
298 
299  };
300 
301 }
time timestamp
Log row time stamp.
Definition: SensorLogger.idl:281
int samplePeriod
Sensor scan interval in milliseconds.
Definition: SensorLogger.idl:31
Settings newSettings
Settings after change.
Definition: SensorLogger.idl:49
Record record
Log record.
Definition: SensorLogger.idl:163
Sensor log record with timestamp.
Definition: SensorLogger.idl:161
int newestRecId
ID of newest record in buffer (0 if empty)
Definition: SensorLogger.idl:34
double avgValue
Average sensor reading.
Definition: SensorLogger.idl:127
Sensor logger settings.
Definition: SensorLogger.idl:29
time sensorSetTimestamp
Time of last sensor set modification.
Definition: SensorLogger.idl:279
Peripheral Devices.
Definition: PeripheralDeviceManager.idl:12
Set of logged sensors.
Definition: SensorLogger.idl:39
One full log row.
Definition: SensorLogger.idl:277
time timestamp
Timestamp.
Definition: SensorLogger.idl:162
int samplesPerRecord
Number of samples per log record.
Definition: SensorLogger.idl:32
double maxValue
Maximum sensor reading.
Definition: SensorLogger.idl:128
double minValue
Minimum sensor reading.
Definition: SensorLogger.idl:126
Sensor logger interface.
Definition: SensorLogger.idl:26
int takenValidSamples
Number of samples with a valid reading/state.
Definition: SensorLogger.idl:124
Sensor interface
Definition: Sensor.idl:10
Sensors Model.
Definition: AccumulatingNumericSensor.idl:8
int state
Sensor state.
Definition: SensorLogger.idl:125
Sensor log record.
Definition: SensorLogger.idl:122
int logCapacity
Maximum number of log records in buffer.
Definition: SensorLogger.idl:35
Peripheral Device Slot.
Definition: PeripheralDeviceSlot.idl:55
vector< peripheral::DeviceSlot_2_0_2 > slots
List of peripheral device slots.
Definition: SensorLogger.idl:43
int oldestRecId
ID of oldest record in buffer (0 if empty)
Definition: SensorLogger.idl:33
vector< Record > sensorRecords
Sensor records; same order as in SensorSet::sensors.
Definition: SensorLogger.idl:283
SensorSet newSensors
Sensor set after change.
Definition: SensorLogger.idl:55
boolean available
Sensor was available for at least one sample.
Definition: SensorLogger.idl:123
vector< sensors::Sensor_4_0_2 > sensors
List of numeric or state sensors.
Definition: SensorLogger.idl:41
vector< Record > peripheralDeviceRecords
Peripheral device records; same order as in SensorSet::slots.
Definition: SensorLogger.idl:285
boolean isEnabled
true if sensor logging is enabled
Definition: SensorLogger.idl:30