Raritan PX2/PX3 JSON-RPC API
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Sensor.idl
1 #ifndef __TFW_SENSOR_IDL__
2 #define __TFW_SENSOR_IDL__
3 
4 #include <Event.idl>
5 
7 module sensors {
8 
10  interface Sensor_4_0_1 {
11 
12  constant int ERR_NOT_SUPPORTED = 1;
13 
15  constant int NUMERIC = 0; //< %Sensor has numeric readings
16  constant int DISCRETE_ON_OFF = 1; //< %Sensor has two discrete readings: 0 (off) and 1 (on), see OnOffState
17  constant int DISCRETE_MULTI = 2; //< %Sensor has multiple discrete readings
18 
20  enumeration OnOffState {
21  OFF,
22  ON
23  };
24 
26  constant int UNSPECIFIED = 0; //< Unspecified
27 
28  constant int VOLTAGE = 1; //< Voltage
29  constant int CURRENT = 2; //< Current
30  constant int UNBALANCE_CURRENT = 3; //< Current unbalance
31  constant int POWER = 4; //< Power
32  constant int POWER_FACTOR = 5; //< Power factor
33  constant int ENERGY = 6; //< Energy
34  constant int FREQUENCY = 7; //< Frequency
35  constant int TEMPERATURE = 8; //< Temperature
36  constant int HUMIDITY = 9; //< Relative humidity
37  constant int AIR_FLOW = 10; //< Air flow
38  constant int AIR_PRESSURE = 11; //< Air pressure
39  constant int CONTACT_CLOSURE = 12; //< Contact Closure
40  constant int ON_OFF_SENSOR = 13; //< Switch state
41  constant int TRIP_SENSOR = 14; //< Circuit breaker tripped
42  constant int VIBRATION = 15; //< Vibration
43  constant int WATER_LEAK = 16; //< Water leak
44  constant int SMOKE_DETECTOR = 17; //< Smoke detector
45 
46  constant int TOTAL_HARMONIC_DISTORTION = 18; //< Total harmonic distortion
47 
48  constant int MASS = 19; //< Mass
49  constant int ELECTRICAL_RESISTANCE = 20; //< Electrical resistance
50  constant int FLUX = 21; //< Flux (mass per time, e.g. water flow)
51 
52  constant int LUMINOUS_INTENSITY = 22; //< Luminous intensity
53  constant int ACCELERATION = 23; //< Acceleration
54  constant int MAGNETIC_FLUX_DENSITY = 24; //< Magnetic flux density
55  constant int ELECTRIC_FIELD_STRENGTH = 25; //< Electric field strength
56  constant int MAGNETIC_FIELD_STRENGTH = 26; //< Magnetic field strength
57  constant int ANGLE = 27; //< Angle (e.g. phase angle)
58 
59  constant int SELECTION = 28; //< Selected index (one of n)
60  constant int FAULT_STATE = 29; //< Fault state
61  constant int POWER_QUALITY = 30; //< Power quality
62  constant int ROTATIONAL_SPEED = 31; //< Rotational speed (e.g. fan speed)
63 
64  constant int LUMINOUS_ENERGY = 32; //< Luminous energy
65  constant int LUMINOUS_FLUX = 33; //< Luminous flux
66  constant int ILLUMINANCE = 34; //< Illuminance used for light incident on a surface
67  constant int LUMINOUS_EMITTANCE = 35; //< Luminous emittance used for light emitted from a surface
68 
69  constant int MOTION = 36; //< Motion detection
70  constant int OCCUPANCY = 37; //< Occupancy detection
71  constant int TAMPER = 38; //< Tamper detection
72  constant int DRY_CONTACT = 39; //< Dry contact (actuator)
73  constant int POWERED_DRY_CONTACT = 40; //< Powered dry contact (actuator)
74 
75  constant int ABSOLUTE_HUMIDITY = 41; //< Absolute humidity
76 
78  constant int NONE = 0; //< No unit
79  constant int VOLT = 1; //< Volts
80  constant int AMPERE = 2; //< Amperes
81  constant int WATT = 3; //< Watts
82  constant int VOLT_AMP = 4; //< Voltamperes
83  constant int WATT_HOUR = 5; //< Watthours
84  constant int VOLT_AMP_HOUR = 6; //< Voltamperehours
85  constant int DEGREE_CELSIUS = 7; //< Degrees Celsius
86  constant int HZ = 8; //< Hertz
87  constant int PERCENT = 9; //< Percent
88  constant int METER_PER_SEC = 10; //< Meters per second
89  constant int PASCAL = 11; //< Pascal
90  constant int G = 12; //< G-force
91  constant int RPM = 13; //< Revolutions per minute
92  constant int METER = 14; //< Meters
93  constant int HOUR = 15; //< Hours
94  constant int MINUTE = 16; //< Minutes
95  constant int SECOND = 17; //< Seconds
96 
97  constant int VOLT_AMP_REACTIVE = 18; //< Voltamperesreactive (var)
98  constant int VOLT_AMP_REACTIVE_HOUR = 19; //< Voltamperesreactivehours (varh)
99 
100  constant int GRAM = 20; //< Gram (g)
101  constant int OHM = 21; //< Ohm (omega, R)
102  constant int LITERS_PER_HOUR = 22; //< Liters per hour (l/h)
103 
104  constant int CANDELA = 23; //< Candela (cd)
105  constant int METER_PER_SQARE_SEC = 24; //< Meter per square second (m/s^2)
106  constant int TESLA = 25; //< Tesla (T)
107  constant int VOLT_PER_METER = 26; //< Volt per meter (V/m)
108  constant int VOLT_PER_AMPERE = 27; //< Volt per ampere (V/A)
109  constant int DEGREE = 28; //< Degree (angle)
110 
111  constant int DEGREE_FAHRENHEIT = 29; //< Degrees Fahrenheit (deg F)
112  constant int KELVIN = 30; //< Kelvin (deg K)
113  constant int JOULE = 31; //< Joules (J)
114  constant int COULOMB = 32; //< Coulombs (C)
115  constant int NIT = 33; //< Nits (cd/m^2)
116  constant int LUMEN = 34; //< Lumen (lm)
117  constant int LUMEN_SECOND = 35; //< Lumen second (lh s)
118  constant int LUX = 36; //< Lux (lx)
119  constant int PSI = 37; //< Pounds per square inch (psi)
120  constant int NEWTON = 38; //< Newtons (N, J/m)
121  constant int FOOT = 39; //< Feet (ft)
122  constant int FOOT_PER_SEC = 40; //< Feet per second (ft/s)
123  constant int CUBIC_METER = 41; //< Cubic meters (m^3)
124  constant int RADIANT = 42; //< Radiants (rad)
125  constant int STERADIANT = 43; //< Steradiants (sr)
126  constant int HENRY = 44; //< Henries (H, Vs/A, Ohm s)
127  constant int FARAD = 45; //< Farads (f)
128  constant int MOL = 46; //< Moles (mol)
129  constant int BECQUEREL = 47; //< Becquerels (Bq)
130  constant int GRAY = 48; //< Grays (Gy, J/kg)
131  constant int SIEVERT = 49; //< Sieverts (Sv = J/kg)
132  constant int G_PER_CUBIC_METER = 50; //< Gram per cubic meter (g/m^3)
133 
135  structure TypeSpec {
137  int type;
138  int unit;
139  };
140 
142  valueobject TypeSpecChangedEvent extends idl.Event {
143  TypeSpec oldTypeSpec;
145  };
146 
152  TypeSpec getTypeSpec();
153 
162  int setType(in int type, in int unit);
163 
164  };
165 
166 }
167 
168 #endif
int type
Sensor type
Definition: Sensor.idl:137
int unit
Sensor unit
Definition: Sensor.idl:138
int readingtype
Sensor reading type
Definition: Sensor.idl:136
TypeSpec newTypeSpec
Type specification after change.
Definition: Sensor.idl:144
Sensor interface
Definition: Sensor.idl:10
Complete sensor type specification.
Definition: Sensor.idl:135
off
Definition: Sensor.idl:21
OnOffState
DISCRETE_ON_OFF Sensor State.
Definition: Sensor.idl:20