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_1 {
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  valueobject SettingsChangedEvent extends event.UserEvent {
51  Settings oldSettings;
53  };
54 
56  valueobject DeviceEvent extends idl.Event {
58  vector<Device_3_0_0> allDevices;
59  };
60 
62  valueobject DeviceAddedEvent extends DeviceEvent { };
63 
65  valueobject DeviceRemovedEvent extends DeviceEvent { };
66 
68  valueobject UnknownDeviceAttachedEvent extends idl.Event {
69  string romCode;
70  vector<PosElement> position;
71  };
72 
77  UPDATE_FAILED
78  };
79 
81  valueobject DeviceFirmwareUpdateStateChangedEvent extends idl.Event {
82  string oldVersion;
83  string newVersion;
84  string serial;
86  };
87 
89  valueobject PackageEvent extends idl.Event {
90  PackageInfo_2_0_0 packageInfo;
91  vector<PackageInfo_2_0_0> allPackages;
92  };
93 
95  valueobject PackageAddedEvent extends PackageEvent { };
97  valueobject PackageRemovedEvent extends PackageEvent { };
98 
100  structure Statistics {
102  };
103 
109  vector<DeviceSlot_2_0_1> getDeviceSlots();
110 
117  DeviceSlot_2_0_1 getDeviceSlot(in int idx);
118 
124  vector<Device_3_0_0> getDiscoveredDevices();
125 
131  vector<PackageInfo_2_0_0> getDiscoveredPackageInfos();
132 
138  Settings getSettings();
139 
148  int setSettings(in Settings settings);
149 
155  MetaData getMetaData();
156 
162  vector<DeviceTypeInfo> getDeviceTypeInfos();
163 
169  Statistics getStatistics();
170  };
171 }
172 
173 #endif /* !__PERIPHERAL_DEVICE_MANAGER_IDL__ */
Peripheral Device Slot.
Definition: PeripheralDeviceSlot.idl:55
valueobject Device_3_0_0
A peripheral device is the collection of.
Definition: PeripheralDeviceSlot.idl:47
int cSumErrCnt
CRC / checksum error counter.
Definition: PeripheralDeviceManager.idl:101
vector< PackageInfo_2_0_0 > allPackages
New list of discovered packages after change.
Definition: PeripheralDeviceManager.idl:91
sensors NumericSensor_4_0_1 Range defaultRange
Default sensor range (numeric sensors only)
Definition: PeripheralDeviceManager.idl:45
Settings newSettings
Settings after change.
Definition: PeripheralDeviceManager.idl:52
ZCoordMode
Z Coordinate Mode identifier.
Definition: PeripheralDeviceManager.idl:19
Peripheral DeviceManager's metadata.
Definition: PeripheralDeviceManager.idl:34
vector< PosElement > position
Device position in the chain.
Definition: PeripheralDeviceManager.idl:70
string name
Device type display name.
Definition: PeripheralDeviceManager.idl:44
ZCoordMode zCoordMode
Z coordinate semantics.
Definition: PeripheralDeviceManager.idl:26
Peripheral device statistics.
Definition: PeripheralDeviceManager.idl:100
vector< Device_3_0_0 > allDevices
New list of discovered devices after change.
Definition: PeripheralDeviceManager.idl:58
string serial
Serial number of device.
Definition: PeripheralDeviceManager.idl:84
sensors Sensor_4_0_1 TypeSpec type
Device (sensor) type.
Definition: PeripheralDeviceManager.idl:41
string newVersion
Firmware version to be updated to.
Definition: PeripheralDeviceManager.idl:83
int defaultDecDigits
Default sensor precision (numeric sensors only)
Definition: PeripheralDeviceManager.idl:46
Peripheral Device Manager.
Definition: PeripheralDeviceManager.idl:14
float deviceAltitude
Altitude of device in meters.
Definition: PeripheralDeviceManager.idl:28
DeviceFirmwareUpdateState
Enumeration: State of device firmware update.
Definition: PeripheralDeviceManager.idl:74
Update has finished successfully.
Definition: PeripheralDeviceManager.idl:76
string identifier
Device type identifier.
Definition: PeripheralDeviceManager.idl:43
DeviceFirmwareUpdateState state
Update state.
Definition: PeripheralDeviceManager.idl:85
sensors Sensor_4_0_1 device
device reference
Definition: PeripheralDeviceSlot.idl:51
boolean isActuator
Is actuator or not.
Definition: PeripheralDeviceManager.idl:42
Peripheral device type info.
Definition: PeripheralDeviceManager.idl:40
Peripheral device package information.
Definition: PeripheralDevicePackage.idl:9
Z coordinate of slot settings is in rack units.
Definition: PeripheralDeviceManager.idl:20
map< string, sensors.NumericSensor_4_0_1.Thresholds > defaultThresholdsMap
Default thresholds by peripheral device type.
Definition: PeripheralDeviceManager.idl:30
int presenceDetectionTimeout
Timeout for presence detection (sec)
Definition: PeripheralDeviceManager.idl:29
Update is running.
Definition: PeripheralDeviceManager.idl:75
int oneWirePortCount
Number of 1-wire ports.
Definition: PeripheralDeviceManager.idl:35
boolean autoManageNewDevices
Automatically manage newly detected devices.
Definition: PeripheralDeviceManager.idl:27
int onboardDeviceCount
Number of onboard peripheral devices.
Definition: PeripheralDeviceManager.idl:36
peripheral DeviceManager's s settings
Definition: PeripheralDeviceManager.idl:25