Raritan PX2/PX3 JSON-RPC API
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
PeripheralDeviceManager.idl
1 #ifndef __PERIPHERAL_DEVICE_MANAGER_IDL__
2 #define __PERIPHERAL_DEVICE_MANAGER_IDL__
3 
4 #include <PeripheralDeviceSlot.idl>
5 #include <PeripheralDevicePackage.idl>
6 #include <NumericSensor.idl>
7 #include <Sensor.idl>
8 #include <UserEvent.idl>
9 
11 module peripheral {
12 
14  interface DeviceManager_2_0_2 {
15 
16  constant int ERR_INVALID_PARAMS = 1;
17 
19  enumeration ZCoordMode {
21  FREEFORM
22  };
23 
25  structure Settings {
30  map<string, sensors.NumericSensor_4_0_1.Thresholds> defaultThresholdsMap;
31  };
32 
34  structure MetaData {
37  };
38 
40  structure DeviceTypeInfo {
41  sensors.Sensor_4_0_1.TypeSpec type;
42  boolean isActuator;
43  string identifier;
44  string name;
45  sensors.NumericSensor_4_0_1.Range defaultRange;
47  };
48 
50  structure FirmwareUpdateState {
51  boolean active;
52  int remaining;
53  };
54 
56  valueobject SettingsChangedEvent extends event.UserEvent {
57  Settings oldSettings;
59  };
60 
62  valueobject DeviceEvent_2_0_0 extends idl.Event {
63  vector<Device_3_0_0> devices;
64  vector<Device_3_0_0> allDevices;
65  };
66 
68  valueobject DeviceAddedEvent_2_0_0 extends DeviceEvent_2_0_0 { };
69 
71  valueobject DeviceRemovedEvent_2_0_0 extends DeviceEvent_2_0_0 { };
72 
74  valueobject UnknownDeviceAttachedEvent extends idl.Event {
75  string romCode;
76  vector<PosElement> position;
77  };
78 
83  UPDATE_FAILED
84  };
85 
87  valueobject DeviceFirmwareUpdateStateChangedEvent extends idl.Event {
88  string oldVersion;
89  string newVersion;
90  string serial;
92  };
93 
98  valueobject FirmwareUpdateStateChangedEvent extends idl.Event {
99  FirmwareUpdateState newState;
100  };
101 
103  valueobject PackageEvent_2_0_0 extends idl.Event {
104  vector<PackageInfo_2_0_0> packageInfos;
105  vector<PackageInfo_2_0_0> allPackages;
106  };
107 
109  valueobject PackageAddedEvent_2_0_0 extends PackageEvent_2_0_0 { };
111  valueobject PackageRemovedEvent_2_0_0 extends PackageEvent_2_0_0 { };
112 
114  structure Statistics {
116  };
117 
123  vector<DeviceSlot_2_0_1> getDeviceSlots();
124 
131  DeviceSlot_2_0_1 getDeviceSlot(in int idx);
132 
138  vector<Device_3_0_0> getDiscoveredDevices();
139 
145  vector<PackageInfo_2_0_0> getDiscoveredPackageInfos();
146 
152  Settings getSettings();
153 
162  int setSettings(in Settings settings);
163 
169  MetaData getMetaData();
170 
176  vector<DeviceTypeInfo> getDeviceTypeInfos();
177 
184  FirmwareUpdateState getFirmwareUpdateState();
185 
191  Statistics getStatistics();
192  };
193 }
194 
195 #endif /* !__PERIPHERAL_DEVICE_MANAGER_IDL__ */
vector< Device_3_0_0 > allDevices
New list of discovered devices after change.
Definition: PeripheralDeviceManager.idl:64
Peripheral Device Slot.
Definition: PeripheralDeviceSlot.idl:55
string name
Device type display name.
Definition: PeripheralDeviceManager.idl:44
Settings newSettings
Settings after change.
Definition: PeripheralDeviceManager.idl:58
boolean active
true if any peripheral device is currently updated
Definition: PeripheralDeviceManager.idl:51
Update is running.
Definition: PeripheralDeviceManager.idl:81
int onboardDeviceCount
Number of onboard peripheral devices.
Definition: PeripheralDeviceManager.idl:36
boolean isActuator
Is actuator or not.
Definition: PeripheralDeviceManager.idl:42
peripheral DeviceManager's s settings
Definition: PeripheralDeviceManager.idl:25
string serial
Serial number of device.
Definition: PeripheralDeviceManager.idl:90
ZCoordMode
Z Coordinate Mode identifier.
Definition: PeripheralDeviceManager.idl:19
sensors::Sensor_4_0_1 TypeSpec type
Device (sensor) type.
Definition: PeripheralDeviceManager.idl:41
Peripheral device statistics.
Definition: PeripheralDeviceManager.idl:114
vector< PackageInfo_2_0_0 > allPackages
New list of discovered packages after change.
Definition: PeripheralDeviceManager.idl:105
DeviceFirmwareUpdateState
Enumeration: State of device firmware update.
Definition: PeripheralDeviceManager.idl:80
map< string, sensors::NumericSensor_4_0_1.Thresholds > defaultThresholdsMap
Default thresholds by peripheral device type.
Definition: PeripheralDeviceManager.idl:30
Peripheral DeviceManager's metadata.
Definition: PeripheralDeviceManager.idl:34
int remaining
Number of peripheral devices that are still pending to be updated.
Definition: PeripheralDeviceManager.idl:52
sensors::NumericSensor_4_0_1 Range defaultRange
Default sensor range (numeric sensors only)
Definition: PeripheralDeviceManager.idl:45
vector< PosElement > position
Device position in the chain.
Definition: PeripheralDeviceManager.idl:76
boolean autoManageNewDevices
Automatically manage newly detected devices.
Definition: PeripheralDeviceManager.idl:27
ZCoordMode zCoordMode
Z coordinate semantics.
Definition: PeripheralDeviceManager.idl:26
DeviceFirmwareUpdateState state
Update state.
Definition: PeripheralDeviceManager.idl:91
Update has finished successfully.
Definition: PeripheralDeviceManager.idl:82
Peripheral Device Manager.
Definition: PeripheralDeviceManager.idl:14
float deviceAltitude
Altitude of device in meters.
Definition: PeripheralDeviceManager.idl:28
Firmware update status.
Definition: PeripheralDeviceManager.idl:50
int presenceDetectionTimeout
Timeout for presence detection (sec)
Definition: PeripheralDeviceManager.idl:29
int cSumErrCnt
CRC / checksum error counter.
Definition: PeripheralDeviceManager.idl:115
int oneWirePortCount
Number of 1-wire ports.
Definition: PeripheralDeviceManager.idl:35
Peripheral device type info.
Definition: PeripheralDeviceManager.idl:40
int defaultDecDigits
Default sensor precision (numeric sensors only)
Definition: PeripheralDeviceManager.idl:46
string newVersion
Firmware version to be updated to.
Definition: PeripheralDeviceManager.idl:89
string identifier
Device type identifier.
Definition: PeripheralDeviceManager.idl:43
Z coordinate of slot settings is in rack units.
Definition: PeripheralDeviceManager.idl:20