Raritan EMX JSON-RPC API
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 <PortFuse.idl>
7 #include <NumericSensor.idl>
8 #include <Sensor.idl>
9 #include <UserEvent.idl>
10 
12 module peripheral {
13 
15  interface DeviceManager_3_0_1 {
16 
17  constant int ERR_INVALID_PARAMS = 1;
18 
20  enumeration ZCoordMode {
22  FREEFORM
23  };
24 
26  structure Settings {
33  };
34 
36  structure MetaData {
39  };
40 
42  structure DeviceTypeInfo {
44  boolean isActuator;
45  string identifier;
46  string name;
49  };
50 
52  structure FirmwareUpdateState {
53  boolean active;
54  int remaining;
55  };
56 
58  valueobject SettingsChangedEvent extends event.UserEvent {
59  Settings oldSettings;
61  };
62 
64  valueobject DeviceEvent_2_0_0 extends idl.Event {
65  vector<Device_3_0_1> devices;
66  vector<Device_3_0_1> allDevices;
67  };
68 
70  valueobject DeviceAddedEvent_2_0_0 extends DeviceEvent_2_0_0 { };
71 
73  valueobject DeviceRemovedEvent_2_0_0 extends DeviceEvent_2_0_0 { };
74 
76  valueobject UnknownDeviceAttachedEvent extends idl.Event {
77  string romCode;
78  vector<PosElement> position;
79  };
80 
85  UPDATE_FAILED
86  };
87 
89  valueobject DeviceFirmwareUpdateStateChangedEvent extends idl.Event {
90  string oldVersion;
91  string newVersion;
92  string serial;
94  };
95 
100  valueobject FirmwareUpdateStateChangedEvent extends idl.Event {
101  FirmwareUpdateState newState;
102  };
103 
105  valueobject PackageEvent_2_0_0 extends idl.Event {
106  vector<PackageInfo_2_0_1> packageInfos;
107  vector<PackageInfo_2_0_1> allPackages;
108  };
109 
111  valueobject PackageAddedEvent_2_0_0 extends PackageEvent_2_0_0 { };
113  valueobject PackageRemovedEvent_2_0_0 extends PackageEvent_2_0_0 { };
114 
116  structure Statistics {
118  };
119 
125  vector<DeviceSlot_2_0_2> getDeviceSlots();
126 
133  DeviceSlot_2_0_2 getDeviceSlot(in int idx);
134 
140  vector<Device_3_0_1> getDiscoveredDevices();
141 
147  vector<PackageInfo_2_0_1> getDiscoveredPackageInfos();
148 
154  Settings getSettings();
155 
164  int setSettings(in Settings settings);
165 
171  MetaData getMetaData();
172 
178  vector<DeviceTypeInfo> getDeviceTypeInfos();
179 
186  FirmwareUpdateState getFirmwareUpdateState();
187 
193  Statistics getStatistics();
194 
200  vector<Package_1_0_1> getDiscoveredPackages();
201 
207  portsmodel.PortFuse getPortFuse();
208  };
209 }
210 
211 #endif /* !__PERIPHERAL_DEVICE_MANAGER_IDL__ */
int cSumErrCnt
CRC / checksum error counter.
Definition: PeripheralDeviceManager.idl:117
A sensor with numeric readings.
Definition: NumericSensor.idl:12
ZCoordMode zCoordMode
Z coordinate semantics.
Definition: PeripheralDeviceManager.idl:27
Range of possible sensor readings.
Definition: NumericSensor.idl:19
DeviceFirmwareUpdateState
Enumeration: State of device firmware update.
Definition: PeripheralDeviceManager.idl:82
peripheral DeviceManager&#39;s s settings
Definition: PeripheralDeviceManager.idl:26
ZCoordMode
Z Coordinate Mode identifier.
Definition: PeripheralDeviceManager.idl:20
int presenceDetectionTimeout
Timeout for presence detection (sec)
Definition: PeripheralDeviceManager.idl:30
Z coordinate of slot settings is in rack units.
Definition: PeripheralDeviceManager.idl:21
sensors::Sensor_4_0_2 TypeSpec type
Device (sensor) type.
Definition: PeripheralDeviceManager.idl:43
int onboardDeviceCount
Number of onboard peripheral devices.
Definition: PeripheralDeviceManager.idl:38
vector< PackageInfo_2_0_1 > allPackages
New list of discovered packages after change.
Definition: PeripheralDeviceManager.idl:107
Peripheral Devices.
Definition: PeripheralDeviceManager.idl:12
Peripheral Device Manager.
Definition: PeripheralDeviceManager.idl:15
Peripheral device statistics.
Definition: PeripheralDeviceManager.idl:116
Settings newSettings
Settings after change.
Definition: PeripheralDeviceManager.idl:60
Update has finished successfully.
Definition: PeripheralDeviceManager.idl:84
boolean isActuator
Is actuator or not.
Definition: PeripheralDeviceManager.idl:44
DeviceFirmwareUpdateState state
Update state.
Definition: PeripheralDeviceManager.idl:93
vector< Device_3_0_1 > allDevices
New list of discovered devices after change.
Definition: PeripheralDeviceManager.idl:66
boolean active
true if any peripheral device is currently updated
Definition: PeripheralDeviceManager.idl:53
int maxActivePoweredDryContacts
The maximum number of concurrently active powered dry contacts.
Definition: PeripheralDeviceManager.idl:32
vector< PosElement > position
Device position in the chain.
Definition: PeripheralDeviceManager.idl:78
Basic IDL definitions.
Definition: Event.idl:6
int oneWirePortCount
Number of 1-wire ports.
Definition: PeripheralDeviceManager.idl:37
string serial
Serial number of device.
Definition: PeripheralDeviceManager.idl:92
Numeric sensor thresholds.
Definition: NumericSensor.idl:106
Firmware update status.
Definition: PeripheralDeviceManager.idl:52
Ports.
Definition: Port.idl:10
Update is running.
Definition: PeripheralDeviceManager.idl:83
string identifier
Device type identifier.
Definition: PeripheralDeviceManager.idl:45
Peripheral DeviceManager&#39;s metadata.
Definition: PeripheralDeviceManager.idl:36
string name
Device type display name.
Definition: PeripheralDeviceManager.idl:46
Sensor interface
Definition: Sensor.idl:10
Sensors Model.
Definition: AccumulatingNumericSensor.idl:8
int remaining
Number of peripheral devices that are still pending to be updated.
Definition: PeripheralDeviceManager.idl:54
Interface describing a controllable fuse for a device port.
Definition: PortFuse.idl:12
string newVersion
Firmware version to be updated to.
Definition: PeripheralDeviceManager.idl:91
Peripheral Device Slot.
Definition: PeripheralDeviceSlot.idl:55
boolean autoManageNewDevices
Automatically manage newly detected devices.
Definition: PeripheralDeviceManager.idl:28
float deviceAltitude
Altitude of device in meters.
Definition: PeripheralDeviceManager.idl:29
sensors::NumericSensor_4_0_2 Range defaultRange
Default sensor range (numeric sensors only)
Definition: PeripheralDeviceManager.idl:47
Complete sensor type specification.
Definition: Sensor.idl:153
int defaultDecDigits
Default sensor precision (numeric sensors only)
Definition: PeripheralDeviceManager.idl:48
Peripheral device type info.
Definition: PeripheralDeviceManager.idl:42
map< string, sensors::NumericSensor_4_0_2.Thresholds > defaultThresholdsMap
Default thresholds by peripheral device type.
Definition: PeripheralDeviceManager.idl:31