Raritan PX2/PX3 JSON-RPC API
LhxSensor.idl
1 #ifndef __LHXMODEL_SENSOR_IDL__
2 #define __LHXMODEL_SENSOR_IDL__
3 
4 #include <Event.idl>
5 #include <Sensor.idl>
6 #include <UserEvent.idl>
7 
9 module lhxmodel {
10 
12  interface Sensor_4_0_2 extends sensors.Sensor_4_0_2 {
13 
15  structure MetaData {
20 
29 
33  double numRangeMin;
34 
38  double numRangeMax;
39 
44 
49 
53  string label;
54 
58  string id;
59  };
60 
62  structure NumThresholds {
64  double lowerCritical;
66  double lowerWarning;
68  double upperWarning;
70  double upperCritical;
71  double hysteresis;
72  };
73 
74  constant int STATE_NOT_AVAILABLE = -1;
75  constant int STATE_CLOSED = 0;
76  constant int STATE_OPEN = 1;
77  constant int STATE_NUM_NORMAL = 0;
78  constant int STATE_NUM_ABOVE_UPPER_CRITICAL = 1;
79  constant int STATE_NUM_ABOVE_UPPER_WARNING = 2;
80  constant int STATE_NUM_BELOW_LOWER_WARNING = 3;
81  constant int STATE_NUM_BELOW_LOWER_CRITICAL = 4;
82 
84  structure Reading {
85  time timestamp;
86  int state;
87  double value;
88  boolean isValid;
89  };
90 
92  valueobject ThresholdsChangedEvent extends event.UserEvent {
93  NumThresholds oldThresholds;
95  };
96 
98  valueobject StateChangedEvent extends idl.Event {
99  Reading oldReading;
101  };
102 
104  valueobject ReadingChangedEvent extends idl.Event {
105  Reading newReading;
106  };
107 
108  constant int ERR_INVALID_PARAM = 1;
109  constant int ERR_NOT_SUPPORTED = 2;
110 
116  MetaData getMetaData();
117 
123  NumThresholds getThresholds();
124 
131  int setThresholds(in NumThresholds thresholds);
132 
138  Reading getReading();
139 
140  };
141 
142 }
143 
144 #endif /* !__LHXMODEL_SENSOR_IDL__ */
time timestamp
Time of sample.
Definition: LhxSensor.idl:85
string id
Descriptive ID of sensor containing label.
Definition: LhxSensor.idl:58
boolean lowerCriticalIsEnabled
Lower critical threshold enabled.
Definition: LhxSensor.idl:63
double upperWarning
Upper warning threshold value.
Definition: LhxSensor.idl:68
boolean upperWarningIsEnabled
Upper warning threshold enabled.
Definition: LhxSensor.idl:67
double upperCritical
Upper critical threshold value.
Definition: LhxSensor.idl:70
NumThresholds newThresholds
Thresholds after change.
Definition: LhxSensor.idl:94
LHX Sensor Interface.
Definition: LhxSensor.idl:12
int state
discrete reading or state
Definition: LhxSensor.idl:86
int numDecDigits
Number of significant decimal digits.
Definition: LhxSensor.idl:28
boolean upperCriticalIsEnabled
Upper critical threshold enabled.
Definition: LhxSensor.idl:69
LHX Model.
Definition: Lhx.idl:9
Basic IDL definitions.
Definition: Event.idl:6
boolean lowerWarningIsEnabled
Lower warning threshold enabled.
Definition: LhxSensor.idl:65
Reading newReading
Reading after change.
Definition: LhxSensor.idl:100
double value
numeric reading value
Definition: LhxSensor.idl:87
sensors::Sensor_4_0_2 TypeSpec type
Sensor type, reading type and unit.
Definition: LhxSensor.idl:19
double numThresholdMin
Smallest possible Numeric Reading Threshold Value.
Definition: LhxSensor.idl:43
Sensor interface
Definition: Sensor.idl:10
double lowerCritical
Lower critical threshold value.
Definition: LhxSensor.idl:64
boolean isValid
numeric value is valid or NAN
Definition: LhxSensor.idl:88
Sensors Model.
Definition: AccumulatingNumericSensor.idl:8
Sensor reading.
Definition: LhxSensor.idl:84
Sensor&#39;s self describing data.
Definition: LhxSensor.idl:15
double lowerWarning
Lower warning threshold value.
Definition: LhxSensor.idl:66
double numRangeMax
Largest possible Numeric Reading Value.
Definition: LhxSensor.idl:38
double hysteresis
Deassertion hysteresis.
Definition: LhxSensor.idl:71
Complete sensor type specification.
Definition: Sensor.idl:153
Numerical sensor thresholds.
Definition: LhxSensor.idl:62
double numRangeMin
Smallest possible Numeric Reading Value.
Definition: LhxSensor.idl:33
string label
The sensor label.
Definition: LhxSensor.idl:53
double numThresholdMax
Largest possible Numeric Reading Threshold Value.
Definition: LhxSensor.idl:48