Raritan PX2/PX3 JSON-RPC API
Lhx.idl
1 #ifndef __LHXMODEL_LHX_IDL__
2 #define __LHXMODEL_LHX_IDL__
3 
4 #include <Sensor.idl>
5 #include "LhxSensor.idl"
6 #include "LhxParameter.idl"
7 
9 module lhxmodel {
10 
12  interface Lhx_3_2_3 {
13  constant int ERR_INVALID_PARAMS = 1;
14  constant int ERR_NOT_SUPPORTED = 2;
15 
17  structure ParamCfg {
18  double min;
19  double max;
20  int decdigits;
21  };
22 
24  structure MetaData {
25  string model;
26  string version;
30  };
31 
33  structure Settings {
36  double defaultFanSpeed;
37  };
38 
40  structure AlertStatus {
41  vector<boolean> sensorFailure;
42  vector<boolean> fanFailure;
43  vector<boolean> powerSupplyFailure;
47  boolean doorOpened;
49  boolean emergencyCooling;
50  boolean waterLeak;
54  boolean stBusError;
57  boolean voltageLow;
58  };
59 
61  structure OpState {
62  boolean on;
65  vector<int> operatingHoursFan;
66  };
67 
69  structure Capabilities {
70  AlertStatus alerts;
71  map<string, boolean> features;
72  };
73 
75  valueobject OpStateChangedEvent extends idl.Event {
76  OpState oldState;
78  };
79 
81  valueobject SettingsChangedEvent extends event.UserEvent {
82  Settings oldSettings;
84  };
85 
89  Capabilities getCapabilities();
90 
96  MetaData getMetaData();
97 
103  Settings getSettings();
104 
113  int setSettings(in Settings settings);
114 
118  vector<Sensor_4_0_2> getSensors();
119 
123  OpState getOpState();
124 
133  int setPowerState(in sensors.Sensor_4_0_2.OnOffState state);
134 
138  vector<Parameter_2_0_1> getParameters();
139 
143  vector<Parameter_2_0_1> getActualValues();
144 
154  int setMaximumCoolingRequest(in boolean requested);
155 
162  int acknowledgeAlertStatus();
163  };
164 
165 }
166 
167 #endif /* !__LHXMODEL_LHX_IDL__ */
168 
string model
The LHX model (e.g. "LHX 20")
Definition: Lhx.idl:25
boolean voltageLow
The battery voltage is low.
Definition: Lhx.idl:57
double setpointWaterValve
setpoint temperature, default 20deg C
Definition: Lhx.idl:34
LHX settings.
Definition: Lhx.idl:33
boolean thresholdWaterOutlet
The water outlet temperature threshold was crossed.
Definition: Lhx.idl:53
boolean emergencyCooling
LHX is in emergency cooling mode.
Definition: Lhx.idl:49
int operatingHoursLhx
Operating hours of Varistar LHX.
Definition: Lhx.idl:64
OnOffState
Sensor states for DISCRETE_ON_OFF sensors.
Definition: Sensor.idl:20
double defaultFanSpeed
fanspeed for &#39;normal&#39; operation, default 80%
Definition: Lhx.idl:36
boolean thresholdHumidity
The humidity threshold was crossed.
Definition: Lhx.idl:51
LHX metadata.
Definition: Lhx.idl:24
ParamCfg setpointVentilatorsCfg
Ventilators configuration characteristics.
Definition: Lhx.idl:28
int decdigits
Number of significant decimal digits.
Definition: Lhx.idl:20
LHX Model.
Definition: Lhx.idl:9
Basic IDL definitions.
Definition: Event.idl:6
string version
The LHX firmware version, empty if not available.
Definition: Lhx.idl:26
boolean externalWaterCoolingFailure
An external water cooling failure occurred.
Definition: Lhx.idl:52
boolean on
LHX is switched on.
Definition: Lhx.idl:62
Configuration parameter characteristics.
Definition: Lhx.idl:17
boolean baseElectronicsFailure
Base electronics failure occurred.
Definition: Lhx.idl:56
OpState newState
Status after change.
Definition: Lhx.idl:77
AlertStatus alertStatus
Alert status of LHX controller.
Definition: Lhx.idl:63
boolean doorOpened
The door was opened.
Definition: Lhx.idl:47
Settings newSettings
Settings after change.
Definition: Lhx.idl:83
double max
Maximum value.
Definition: Lhx.idl:19
boolean waterLeak
Water leakage was detected.
Definition: Lhx.idl:50
boolean thresholdWaterInlet
The water inlet temperature threshold was crossed.
Definition: Lhx.idl:46
boolean thresholdAirOutlet
The air outlet temperature threshold was crossed.
Definition: Lhx.idl:44
double min
Minimum value.
Definition: Lhx.idl:18
Sensor interface
Definition: Sensor.idl:10
LHX alert status.
Definition: Lhx.idl:40
Sensors Model.
Definition: AccumulatingNumericSensor.idl:8
ParamCfg defaultFanSpeedCfg
Default fan speed configuration characteristics.
Definition: Lhx.idl:29
boolean condenserPumpFailure
Condenser pump failure occurred.
Definition: Lhx.idl:55
boolean maximumCoolingRequest
Maximum cooling was requested.
Definition: Lhx.idl:48
ParamCfg setpointWaterValveCfg
Water valve configuration characteristics.
Definition: Lhx.idl:27
vector< boolean > sensorFailure
Sensor failure (broken or short circuit)
Definition: Lhx.idl:41
vector< boolean > fanFailure
Fan motor failure.
Definition: Lhx.idl:42
vector< int > operatingHoursFan
Operating hours of Fans.
Definition: Lhx.idl:65
LHX operational state.
Definition: Lhx.idl:61
boolean thresholdAirInlet
The air inlet temperature threshold was crossed.
Definition: Lhx.idl:45
LHX capabilities.
Definition: Lhx.idl:69
double setpointVentilators
setpoint temperature, default 3deg C / Pa
Definition: Lhx.idl:35
LHX Interface.
Definition: Lhx.idl:12
boolean stBusError
ST-Bus communication error.
Definition: Lhx.idl:54
vector< boolean > powerSupplyFailure
Power supply failure.
Definition: Lhx.idl:43