Raritan PX2/PX3 JSON-RPC API
|
6 #ifndef __PERIPHERAL_DEVICE_MANAGER_IDL__
7 #define __PERIPHERAL_DEVICE_MANAGER_IDL__
9 #include <PeripheralDeviceSlot.idl>
10 #include <SensorHub.idl>
11 #include <PeripheralDevicePackage.idl>
12 #include <PortFuse.idl>
13 #include <NumericSensor.idl>
15 #include <UserEvent.idl>
23 constant
int ERR_INVALID_PARAMS = 1;
65 valueobject SettingsChangedEvent extends
event.UserEvent {
71 valueobject DeviceEvent extends
idl.Event {
72 vector<Device_4_0_0> devices;
77 valueobject DeviceAddedEvent extends DeviceEvent { };
80 valueobject DeviceRemovedEvent extends DeviceEvent { };
83 valueobject UnknownDeviceAttachedEvent extends
idl.Event {
96 valueobject DeviceFirmwareUpdateStateChangedEvent extends
idl.Event {
107 valueobject FirmwareUpdateStateChangedEvent extends
idl.Event {
112 valueobject PackageEvent extends
idl.Event {
113 vector<PackageInfo_3_0_0> packageInfos;
118 valueobject PackageAddedEvent extends PackageEvent { };
120 valueobject PackageRemovedEvent extends PackageEvent { };
vector< DeviceTypeInfo > getDeviceTypeInfos()
Get the list of all peripheral device type infos.
int maxActivePoweredDryContacts
The maximum number of concurrently active powered dry contacts.
Definition: PeripheralDeviceManager.idl:38
Peripheral Devices.
Definition: PeripheralDeviceManager.idl:18
MetaData getMetaData()
Retreive the Peripheral DeviceManager's metadata.
Sensors Model.
Definition: AccumulatingNumericSensor.idl:13
string identifier
Device type identifier.
Definition: PeripheralDeviceManager.idl:52
@ UPDATE_STARTED
Update is running.
Definition: PeripheralDeviceManager.idl:90
vector< Package_2_0_0 > getDiscoveredPackages()
Get the list of currently attached peripheral device packages.
@ RACKUNITS
Z coordinate of slot settings is in rack units.
Definition: PeripheralDeviceManager.idl:27
FirmwareUpdateState getFirmwareUpdateState()
Return the state of device firmware updates running on devices connected to this device manager.
Peripheral device statistics.
Definition: PeripheralDeviceManager.idl:123
string serial
Serial number of device.
Definition: PeripheralDeviceManager.idl:99
Numeric sensor thresholds.
Definition: NumericSensor.idl:111
sensors::NumericSensor_4_0_4 Range defaultRange
Default sensor range (numeric sensors only)
Definition: PeripheralDeviceManager.idl:54
vector< Device_4_0_0 > allDevices
New list of discovered devices after change.
Definition: PeripheralDeviceManager.idl:73
Complete sensor type specification.
Definition: Sensor.idl:163
Settings getSettings()
Retrieve the peripheral DeviceManager's settings.
int presenceDetectionTimeout
Timeout for presence detection (sec)
Definition: PeripheralDeviceManager.idl:36
int defaultDecDigits
Default sensor precision (numeric sensors only)
Definition: PeripheralDeviceManager.idl:55
Range of possible sensor readings.
Definition: NumericSensor.idl:24
Settings newSettings
Settings after change.
Definition: PeripheralDeviceManager.idl:67
sensors::Sensor_4_0_4 TypeSpec type
Device (sensor) type.
Definition: PeripheralDeviceManager.idl:50
int remaining
Number of peripheral devices that are still pending to be updated.
Definition: PeripheralDeviceManager.idl:61
vector< PosElement_2_0_0 > position
Device position in the chain.
Definition: PeripheralDeviceManager.idl:85
portsmodel::PortFuse getPortFuse()
Get the fuse for the sensor port.
boolean autoManageNewDevices
Automatically manage newly detected devices.
Definition: PeripheralDeviceManager.idl:34
vector< SensorHub > getSensorHubs()
Get the list of sensor hubs.
Statistics getStatistics()
Retrieve statistics.
Basic IDL definitions.
Definition: Event.idl:10
Peripheral Device Manager.
Definition: PeripheralDeviceManager.idl:21
vector< DeviceSlot_3_0_0 > getDeviceSlots()
Get the list of peripheral device slots.
Ports.
Definition: Port.idl:15
Peripheral device type info.
Definition: PeripheralDeviceManager.idl:49
float deviceAltitude
Altitude of device in meters.
Definition: PeripheralDeviceManager.idl:35
Peripheral Device Slot.
Definition: PeripheralDeviceSlot.idl:61
boolean active
true if any peripheral device is currently updated
Definition: PeripheralDeviceManager.idl:60
Interface describing a controllable fuse for a device port.
Definition: PortFuse.idl:17
boolean isActuator
Is actuator or not.
Definition: PeripheralDeviceManager.idl:51
int setSettings(in Settings settings)
Change the peripheral DeviceManager's settings.
boolean muteOtherAccessControlUnit
Mute other access control unit (door handle) enabled.
Definition: PeripheralDeviceManager.idl:39
map< string, sensors::NumericSensor_4_0_4.Thresholds > defaultThresholdsMap
Default thresholds by peripheral device type.
Definition: PeripheralDeviceManager.idl:37
Sensor interface
Definition: Sensor.idl:15
DeviceSlot_3_0_0 getDeviceSlot(in int idx)
Get a DeviceSlot by its index.
peripheral DeviceManager's s settings
Definition: PeripheralDeviceManager.idl:32
vector< PackageInfo_3_0_0 > allPackages
New list of discovered packages after change.
Definition: PeripheralDeviceManager.idl:114
DeviceFirmwareUpdateState
Enumeration: State of device firmware update.
Definition: PeripheralDeviceManager.idl:89
vector< PackageInfo_3_0_0 > getDiscoveredPackageInfos()
Get the list of currently attached peripheral device packages.
string newVersion
Firmware version to be updated to.
Definition: PeripheralDeviceManager.idl:98
@ UPDATE_SUCCESSFUL
Update has finished successfully.
Definition: PeripheralDeviceManager.idl:91
DeviceFirmwareUpdateState state
Update state.
Definition: PeripheralDeviceManager.idl:100
vector< Device_4_0_0 > getDiscoveredDevices()
Get the list of currently attached peripheral devices.
Firmware update status.
Definition: PeripheralDeviceManager.idl:59
A sensor with numeric readings.
Definition: NumericSensor.idl:17
ZCoordMode
Z Coordinate Mode identifier.
Definition: PeripheralDeviceManager.idl:26
int cSumErrCnt
CRC / checksum error counter.
Definition: PeripheralDeviceManager.idl:124
string name
Device type display name.
Definition: PeripheralDeviceManager.idl:53
ZCoordMode zCoordMode
Z coordinate semantics.
Definition: PeripheralDeviceManager.idl:33