Raritan / Server Technology Xerus™ PDU JSON-RPC API
|
Peripheral Device Manager. More...
import"PeripheralDeviceManager.idl";
Classes | |
struct | DeviceTypeInfo |
Peripheral device type info. More... | |
struct | FirmwareUpdateState |
Firmware update status. More... | |
struct | MetaData |
Peripheral DeviceManager's metadata. More... | |
struct | Settings |
peripheral DeviceManager's s settings More... | |
struct | Statistics |
Peripheral device statistics. More... | |
Public Types | |
enum | ZCoordMode { RACKUNITS , FREEFORM } |
Z Coordinate Mode identifier. More... | |
enum | DeviceFirmwareUpdateState { UPDATE_STARTED , UPDATE_SUCCESSFUL , UPDATE_FAILED } |
Enumeration: State of device firmware update. More... | |
Public Member Functions | |
vector< DeviceSlot > | getDeviceSlots () |
Get the list of peripheral device slots. More... | |
DeviceSlot | getDeviceSlot (in int idx) |
Get a DeviceSlot by its index. More... | |
vector< SensorHub > | getSensorHubs () |
Get the list of sensor hubs. More... | |
vector< Device > | getDiscoveredDevices () |
Get the list of currently attached peripheral devices. More... | |
vector< PackageInfo > | getDiscoveredPackageInfos () |
Get the list of currently attached peripheral device packages. More... | |
Settings | getSettings () |
Retrieve the peripheral DeviceManager's settings. More... | |
int | setSettings (in Settings settings) |
Change the peripheral DeviceManager's settings. More... | |
MetaData | getMetaData () |
Retreive the Peripheral DeviceManager's metadata. More... | |
vector< DeviceTypeInfo > | getDeviceTypeInfos () |
Get the list of all peripheral device type infos. More... | |
FirmwareUpdateState | getFirmwareUpdateState () |
Return the state of device firmware updates running on devices connected to this device manager. More... | |
Statistics | getStatistics () |
Retrieve statistics. More... | |
vector< Package > | getDiscoveredPackages () |
Get the list of currently attached peripheral device packages. More... | |
portsmodel::PortFuse | getPortFuse () |
Get the fuse for the sensor port. More... | |
Public Attributes | |
constant int | ERR_INVALID_PARAMS = 1 |
Invalid parameters. | |
constant int | ERR_NOT_ON_SECONDARY = 2 |
Unsupported on secondary instance. | |
valueobject | SettingsChangedEvent: event::UserEvent { Settings oldSettings |
Event: Peripheral device manager's settings have been changed. More... | |
Settings | newSettings |
Settings after change. | |
valueobject | DeviceEvent: idl::Event { vector<Device> devices |
Event: A peripheral device was added or removed. More... | |
vector< Device > | allDevices |
New list of discovered devices after change. | |
valueobject | DeviceAddedEvent: DeviceEvent { } |
Event: A peripheral device was added. | |
valueobject | DeviceRemovedEvent: DeviceEvent { } |
Event: A peripheral device was removed. | |
valueobject | UnknownDeviceAttachedEvent: idl::Event { string romCode |
Event: An unknown device was attached. More... | |
vector< PosElement > | position |
Device position in the chain. | |
valueobject | DeviceFirmwareUpdateStateChangedEvent: idl::Event { string oldVersion |
Event: Firmware update on a device was started or has finished. More... | |
string | newVersion |
Firmware version to be updated to. | |
string | serial |
Serial number of device. | |
DeviceFirmwareUpdateState | state |
Update state. | |
valueobject | FirmwareUpdateStateChangedEvent: idl::Event { FirmwareUpdateState newState |
Event: Firmware update state has changed This event will be sent to enclose one of more DeviceFirmwareUpdateStateChangedEvent. More... | |
valueobject | PackageEvent: idl::Event { vector<PackageInfo> packageInfos |
Event: A peripheral device package was added or removed. More... | |
vector< PackageInfo > | allPackages |
New list of discovered packages after change. | |
valueobject | PackageAddedEvent: PackageEvent { } |
Event: A peripheral device package was added. | |
valueobject | PackageRemovedEvent: PackageEvent { } |
Event: A peripheral device package was removed. | |
Peripheral Device Manager.
DeviceSlot peripheral::DeviceManager::getDeviceSlot | ( | in int | idx | ) |
Get a DeviceSlot by its index.
idx | index of the slot to get (0-based) |
vector<DeviceSlot> peripheral::DeviceManager::getDeviceSlots | ( | ) |
Get the list of peripheral device slots.
vector<DeviceTypeInfo> peripheral::DeviceManager::getDeviceTypeInfos | ( | ) |
Get the list of all peripheral device type infos.
vector<Device> peripheral::DeviceManager::getDiscoveredDevices | ( | ) |
Get the list of currently attached peripheral devices.
vector<PackageInfo> peripheral::DeviceManager::getDiscoveredPackageInfos | ( | ) |
Get the list of currently attached peripheral device packages.
vector<Package> peripheral::DeviceManager::getDiscoveredPackages | ( | ) |
Get the list of currently attached peripheral device packages.
FirmwareUpdateState peripheral::DeviceManager::getFirmwareUpdateState | ( | ) |
Return the state of device firmware updates running on devices connected to this device manager.
MetaData peripheral::DeviceManager::getMetaData | ( | ) |
Retreive the Peripheral DeviceManager's metadata.
portsmodel::PortFuse peripheral::DeviceManager::getPortFuse | ( | ) |
Get the fuse for the sensor port.
vector<SensorHub> peripheral::DeviceManager::getSensorHubs | ( | ) |
Get the list of sensor hubs.
Settings peripheral::DeviceManager::getSettings | ( | ) |
Retrieve the peripheral DeviceManager's settings.
Statistics peripheral::DeviceManager::getStatistics | ( | ) |
Retrieve statistics.
int peripheral::DeviceManager::setSettings | ( | in Settings | settings | ) |
Change the peripheral DeviceManager's settings.
settings | New peripheral DeviceManager's settings |
valueobject peripheral::DeviceManager::DeviceEvent |
Event: A peripheral device was added or removed.
Affected devices
valueobject peripheral::DeviceManager::DeviceFirmwareUpdateStateChangedEvent |
Event: Firmware update on a device was started or has finished.
Firmware version before update
valueobject peripheral::DeviceManager::FirmwareUpdateStateChangedEvent |
Event: Firmware update state has changed This event will be sent to enclose one of more DeviceFirmwareUpdateStateChangedEvent.
That is, it will be sent before a series of firmware updates is started and after the firmware update series has ended. New update state
valueobject peripheral::DeviceManager::PackageEvent |
Event: A peripheral device package was added or removed.
Information about affected packages
valueobject peripheral::DeviceManager::SettingsChangedEvent |
Event: Peripheral device manager's settings have been changed.
Settings before change
valueobject peripheral::DeviceManager::UnknownDeviceAttachedEvent |
Event: An unknown device was attached.
Device ROM code