Raritan PX2/PX3 JSON-RPC API
Port.idl
1 #ifndef __PORTSMODEL_PORT_IDL__
2 #define __PORTSMODEL_PORT_IDL__
3 
4 #include <Event.idl>
5 #include <PortFuse.idl>
6 
10 module portsmodel {
11 
13  interface Port_2_0_2 {
14 
16  constant int NO_ERROR = 0;
17  constant int ERR_INVALID_PARAM = 1;
18  constant int ERR_DEVICE_BUSY = 2;
19 
21  enumeration DetectionType {
22  AUTO,
24  DISABLED
25  };
26 
28  structure DetectionMode {
31  };
32 
34  structure Properties {
35  string name;
36  string label;
40  };
41 
43  valueobject PropertiesChangedEvent extends idl.Event {
44  Properties oldProperties;
46  };
47 
49  valueobject DeviceChangedEvent extends idl.Event {
50  Object oldDevice;
51  Object newDevice;
52  };
53 
59  Properties getProperties();
60 
68  void setName(in string name);
69 
78  int setDetectionMode(in DetectionMode mode);
79 
85  vector<string> getDetectableDevices();
86 
92  Object getDevice();
93 
101  Object getDeviceConfig(in string deviceType);
102 
108  PortFuse getFuse();
109  };
110 }
111 
112 #endif /* __PORTSMODEL_PORT_IDL__ */
DetectionMode mode
detection mode
Definition: Port.idl:37
port is pinned to a specific device type
Definition: Port.idl:23
DetectionType type
detection type: auto or pinned
Definition: Port.idl:29
Port detection mode.
Definition: Port.idl:28
Object newDevice
Connected device after change.
Definition: Port.idl:51
Basic IDL definitions.
Definition: Event.idl:6
auto detection of connected devices
Definition: Port.idl:22
Properties newProperties
Properties after change.
Definition: Port.idl:45
Ports.
Definition: Port.idl:10
string detectedDeviceName
detected device name or empty if nothing connected
Definition: Port.idl:39
Interface describing a controllable fuse for a device port.
Definition: PortFuse.idl:12
Port properties.
Definition: Port.idl:34
string label
label on device
Definition: Port.idl:36
string pinnedDeviceType
contains specific device type in pinned mode, not used for auto
Definition: Port.idl:30
string name
user defineable name - NOT USED RIGHT NOW!
Definition: Port.idl:35
string detectedDeviceType
detected device type or empty if nothing connected
Definition: Port.idl:38
Port interface.
Definition: Port.idl:13
DetectionType
Port detection type.
Definition: Port.idl:21