Raritan PX2/PX3 JSON-RPC API
Port.idl
1 #ifndef __PORTSMODEL_PORT_IDL__
2 #define __PORTSMODEL_PORT_IDL__
3 
4 #include <Event.idl>
5 
9 module portsmodel {
10 
12  interface Port_2_0_1 {
13 
15  constant int NO_ERROR = 0;
16  constant int ERR_INVALID_PARAM = 1;
17  constant int ERR_DEVICE_BUSY = 2;
18 
20  enumeration DetectionType {
21  AUTO,
23  DISABLED
24  };
25 
27  structure DetectionMode {
30  };
31 
33  structure Properties {
34  string name;
35  string label;
39  };
40 
42  valueobject PropertiesChangedEvent extends idl.Event {
43  Properties oldProperties;
45  };
46 
48  valueobject DeviceChangedEvent extends idl.Event {
49  Object oldDevice;
50  Object newDevice;
51  };
52 
58  Properties getProperties();
59 
67  void setName(in string name);
68 
77  int setDetectionMode(in DetectionMode mode);
78 
84  vector<string> getDetectableDevices();
85 
91  Object getDevice();
92 
100  Object getDeviceConfig(in string deviceType);
101  };
102 }
103 
104 #endif /* __PORTSMODEL_PORT_IDL__ */
port is pinned to a specific device type
Definition: Port.idl:22
string detectedDeviceName
detected device name or empty if nothing connected
Definition: Port.idl:38
Properties newProperties
Properties after change.
Definition: Port.idl:44
string detectedDeviceType
detected device type or empty if nothing connected
Definition: Port.idl:37
Basic IDL definitions.
Definition: Event.idl:6
auto detection of connected devices
Definition: Port.idl:21
string label
label on device
Definition: Port.idl:35
Ports.
Definition: Port.idl:9
Port interface.
Definition: Port.idl:12
DetectionType type
detection type: auto or pinned
Definition: Port.idl:28
Port properties.
Definition: Port.idl:33
Port detection mode.
Definition: Port.idl:27
string pinnedDeviceType
contains specific device type in pinned mode, not used for auto
Definition: Port.idl:29
string name
user defineable name - NOT USED RIGHT NOW!
Definition: Port.idl:34
Object newDevice
Connected device after change.
Definition: Port.idl:50
DetectionMode mode
detection mode
Definition: Port.idl:36
DetectionType
Port detection type.
Definition: Port.idl:20