Raritan PX2/PX3 JSON-RPC API
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
PeripheralDeviceSlot.idl
1 #ifndef __PERIPHERAL_DEVICE_SLOT_IDL__
2 #define __PERIPHERAL_DEVICE_SLOT_IDL__
3 
4 #include <Sensor.idl>
5 #include <UserEvent.idl>
6 
8 module peripheral {
9 
11  enumeration PortType {
16  };
17 
19  structure PosElement {
21  string port;
22  };
23 
25  structure DeviceID_3_0_0 {
26  string serial;
27  sensors.Sensor_4_0_1.TypeSpec type;
28  boolean isActuator;
29  int channel;
30  };
31 
33  structure Address_3_0_0 {
34  vector<PosElement> position;
35  sensors.Sensor_4_0_1.TypeSpec type;
36  boolean isActuator;
37  int channel;
38  };
39 
47  valueobject Device_3_0_0 {
48  DeviceID_3_0_0 deviceID;
49  vector<PosElement> position;
50  string packageClass;
51  sensors.Sensor_4_0_1 device;
52  };
53 
55  interface DeviceSlot_2_0_1 {
56 
57  constant int ERR_INVALID_PARAMS = 1;
58  constant int ERR_NOT_SUPPORTED = 2;
59 
60  constant int CHANNEL_INVALID = -1;
61 
63  structure Location {
64  string x;
65  string y;
66  string z;
67  };
68 
70  structure Settings {
71  string name;
72  string description;
75  map<string, string> properties;
76  };
77 
79  valueobject DeviceChangedEvent extends idl.Event {
80  Device_3_0_0 oldDevice;
82  };
83 
85  valueobject SettingsChangedEvent extends event.UserEvent {
86  Settings oldSettings;
88  };
89 
96  Device_3_0_0 getDevice();
97 
106  int assign(in DeviceID_3_0_0 devid);
107 
116  int assignAddress(in string packageClass, in Address_3_0_0 address);
117 
125  int unassign();
126 
132  Settings getSettings();
133 
142  int setSettings(in Settings settings);
143 
144  };
145 
146 }
147 
148 #endif /* !__PERIPHERAL_DEVICE_SLOT_IDL__ */
sensors::Sensor_4_0_1 TypeSpec type
device's type spec
Definition: PeripheralDeviceSlot.idl:35
sensors::Sensor_4_0_1 TypeSpec type
device's type spec
Definition: PeripheralDeviceSlot.idl:27
Peripheral Device Slot.
Definition: PeripheralDeviceSlot.idl:55
valueobject Device_3_0_0
A peripheral device is the collection of.
Definition: PeripheralDeviceSlot.idl:47
map< string, string > properties
sensor specific settings
Definition: PeripheralDeviceSlot.idl:75
a chain position
Definition: PeripheralDeviceSlot.idl:15
peripheral device identification
Definition: PeripheralDeviceSlot.idl:25
string port
value of the element, a label
Definition: PeripheralDeviceSlot.idl:21
Device_3_0_0 newDevice
Device after change.
Definition: PeripheralDeviceSlot.idl:81
int channel
Channel number.
Definition: PeripheralDeviceSlot.idl:29
int channel
Channel number.
Definition: PeripheralDeviceSlot.idl:37
vector< PosElement > position
Position within 1-wire topo.
Definition: PeripheralDeviceSlot.idl:49
PortType portType
type of the element
Definition: PeripheralDeviceSlot.idl:20
string packageClass
physical package identifier
Definition: PeripheralDeviceSlot.idl:50
string x
X coordinate.
Definition: PeripheralDeviceSlot.idl:64
boolean useDefaultThresholds
use default thresholds
Definition: PeripheralDeviceSlot.idl:74
a 1-wire port on the device
Definition: PeripheralDeviceSlot.idl:13
boolean isActuator
true if device is an actuator
Definition: PeripheralDeviceSlot.idl:28
user configurable slot attributes
Definition: PeripheralDeviceSlot.idl:70
sensors::Sensor_4_0_1 device
device reference
Definition: PeripheralDeviceSlot.idl:51
vector< PosElement > position
Position within 1-wire topo.
Definition: PeripheralDeviceSlot.idl:34
boolean isActuator
true if device is an actuator
Definition: PeripheralDeviceSlot.idl:36
user writeable location
Definition: PeripheralDeviceSlot.idl:63
Location location
user-defined device location
Definition: PeripheralDeviceSlot.idl:73
peripheral device position based address
Definition: PeripheralDeviceSlot.idl:33
string z
Z coordinate (semantics depends on ZCoordMode)
Definition: PeripheralDeviceSlot.idl:66
string name
User-defined name.
Definition: PeripheralDeviceSlot.idl:71
a port on a Hub
Definition: PeripheralDeviceSlot.idl:14
Settings newSettings
Settings after change.
Definition: PeripheralDeviceSlot.idl:87
PortType
peripheral device port types
Definition: PeripheralDeviceSlot.idl:11
a built in, inaccessible port
Definition: PeripheralDeviceSlot.idl:12
string serial
Serial number.
Definition: PeripheralDeviceSlot.idl:26
string description
User-defined description.
Definition: PeripheralDeviceSlot.idl:72
string y
Y coordinate.
Definition: PeripheralDeviceSlot.idl:65
peripheral device position element, list forms position
Definition: PeripheralDeviceSlot.idl:19