Raritan PX2/PX3 JSON-RPC API
NumericSensor.idl
1 #ifndef __SENSORMODEL_NUMERICSENSOR_IDL__
2 #define __SENSORMODEL_NUMERICSENSOR_IDL__
3 
4 #include <Event.idl>
5 #include <Sensor.idl>
6 #include <UserEvent.idl>
7 
9 module sensors {
10 
12  interface NumericSensor_4_0_2 extends Sensor_4_0_2 {
13 
14  constant int THRESHOLD_OUT_OF_RANGE = 1;
15  constant int THRESHOLD_INVALID = 2;
16  constant int THRESHOLD_NOT_SUPPORTED = 3;
17 
19  structure Range {
20  double lower;
21  double upper;
22  };
23 
28  boolean hasUpperCritical;
29  boolean hasUpperWarning;
30  boolean hasLowerWarning;
31  boolean hasLowerCritical;
32  };
33 
35  structure MetaData {
40 
48  int decdigits;
49 
61  float accuracy;
62 
69  float resolution;
70 
81  float tolerance;
82 
91 
98 
103  };
104 
106  structure Thresholds {
108  double upperCritical;
110  double upperWarning;
112  double lowerWarning;
114  double lowerCritical;
117  };
118 
120  structure Reading {
122  structure Status {
127  };
128  time timestamp;
129  boolean available;
131  boolean valid;
132  double value;
133  };
134 
136  valueobject ReadingChangedEvent extends idl.Event {
137  Reading newReading;
138  };
139 
141  valueobject StateChangedEvent extends idl.Event {
142  Reading oldReading;
144  };
145 
147  valueobject MetaDataChangedEvent extends idl.Event {
148  MetaData oldMetaData;
150  };
151 
153  valueobject ThresholdsChangedEvent extends event.UserEvent {
154  Thresholds oldThresholds;
156  };
157 
163  MetaData getMetaData();
164 
170  Thresholds getDefaultThresholds();
171 
177  Thresholds getThresholds();
178 
189  int setThresholds(in Thresholds thresh);
190 
196  Reading getReading();
197 
198  };
199 
200 }
201 
202 #endif
A sensor with numeric readings.
Definition: NumericSensor.idl:12
Range of possible sensor readings.
Definition: NumericSensor.idl:19
int decdigits
Number of significant decimal digits.
Definition: NumericSensor.idl:48
MetaData newMetaData
Metadata after change.
Definition: NumericSensor.idl:149
double lowerCritical
Lower critical threshold.
Definition: NumericSensor.idl:114
Threshold capabilities.
Definition: NumericSensor.idl:27
float noiseThreshold
Sensor noise threshold.
Definition: NumericSensor.idl:90
float accuracy
Sensor accuracy in percent.
Definition: NumericSensor.idl:61
double lower
Minimum reading.
Definition: NumericSensor.idl:20
boolean belowLowerCritical
Reading is below lower critical threshold.
Definition: NumericSensor.idl:126
boolean valid
true if the sensor reading is valid
Definition: NumericSensor.idl:131
Reading newReading
Reading after state change.
Definition: NumericSensor.idl:143
Status status
Numeric sensor status.
Definition: NumericSensor.idl:130
boolean hasLowerWarning
Sensor has lower warning threshold.
Definition: NumericSensor.idl:30
time timestamp
Timestamp of last sample.
Definition: NumericSensor.idl:128
int assertionTimeout
Assertion timeout in samples.
Definition: NumericSensor.idl:115
boolean belowLowerWarning
Reading is below lower warning threshold.
Definition: NumericSensor.idl:125
boolean lowerCriticalActive
true if the lower critical threshold is enabled
Definition: NumericSensor.idl:113
boolean hasLowerCritical
Sensor has lower critical threshold.
Definition: NumericSensor.idl:31
Thresholds newThresholds
Threshold set after change.
Definition: NumericSensor.idl:155
Range range
Range of possible sensor readings.
Definition: NumericSensor.idl:97
double upperWarning
Upper warning threshold.
Definition: NumericSensor.idl:110
boolean hasUpperWarning
Sensor has upper warning threshold.
Definition: NumericSensor.idl:29
double value
Numeric sensor reading.
Definition: NumericSensor.idl:132
boolean upperWarningActive
true if the upper warning threshold is enabled
Definition: NumericSensor.idl:109
boolean upperCriticalActive
true if the upper critical threshold is enabled
Definition: NumericSensor.idl:107
Basic IDL definitions.
Definition: Event.idl:6
boolean available
true if the sensor is available
Definition: NumericSensor.idl:129
Sensor_4_0_2::TypeSpec type
Sensor type, reading type and unit.
Definition: NumericSensor.idl:39
boolean aboveUpperWarning
Reading is above upper warning threshold.
Definition: NumericSensor.idl:124
double lowerWarning
Lower warning threshold.
Definition: NumericSensor.idl:112
Numeric sensor thresholds.
Definition: NumericSensor.idl:106
float tolerance
Sensor tolerance.
Definition: NumericSensor.idl:81
Sensor interface
Definition: Sensor.idl:10
Sensors Model.
Definition: AccumulatingNumericSensor.idl:8
Numeric sensor reading.
Definition: NumericSensor.idl:120
boolean aboveUpperCritical
Reading is above upper critical threshold.
Definition: NumericSensor.idl:123
double upper
Maximum reading.
Definition: NumericSensor.idl:21
ThresholdCapabilities thresholdCaps
Threshold capabilities.
Definition: NumericSensor.idl:102
double upperCritical
Upper critical threshold.
Definition: NumericSensor.idl:108
float resolution
Sensor resolution.
Definition: NumericSensor.idl:69
boolean hasUpperCritical
Sensor has upper critical threshold.
Definition: NumericSensor.idl:28
Numeric sensor status.
Definition: NumericSensor.idl:122
Numeric sensor metadata.
Definition: NumericSensor.idl:35
Complete sensor type specification.
Definition: Sensor.idl:153
boolean lowerWarningActive
true if the lower warning threshold is enabled
Definition: NumericSensor.idl:111
float deassertionHysteresis
Deassertion hysteresis.
Definition: NumericSensor.idl:116