Raritan PX2/PX3 JSON-RPC API
Classes | Public Member Functions | Public Attributes | List of all members
peripheral::DeviceSlot_2_0_2 Interface Reference

Peripheral Device Slot. More...

import"PeripheralDeviceSlot.idl";

Classes

struct  Location
 user writeable location More...
 
struct  Settings
 user configurable slot attributes More...
 

Public Member Functions

Device_3_0_1 getDevice ()
 Returns the actual device reference. More...
 
int assign (in DeviceID_3_0_1 devid)
 Associate this slot with a given (old or detected new) peripheral device. More...
 
int assignAddress (in string packageClass, in Address_3_0_1 address)
 Associate this slot with an addressable (new) peripheral device. More...
 
int unassign ()
 Break the association for this slot. More...
 
Settings getSettings ()
 Retrieve the user-defined settings. More...
 
int setSettings (in Settings settings)
 Change the slot settings. More...
 

Public Attributes

constant int ERR_INVALID_PARAMS = 1
 Invalid parameters.
 
constant int ERR_NOT_SUPPORTED = 2
 Operation not supported.
 
constant int CHANNEL_INVALID = -1
 Device has no channels.
 
valueobject DeviceChangedEvent: idl::Event { Device_3_0_1 oldDevice
 Event: The device attached to this slot has changed. More...
 
Device_3_0_1 newDevice
 Device after change.
 
valueobject SettingsChangedEvent: event::UserEvent { Settings oldSettings
 Event: The slot settings have been changed. More...
 
Settings newSettings
 Settings after change.
 

Detailed Description

Peripheral Device Slot.

Member Function Documentation

int peripheral::DeviceSlot_2_0_2::assign ( in DeviceID_3_0_1  devid)

Associate this slot with a given (old or detected new) peripheral device.

Parameters
devidperipheral device identification
Returns
0 if OK
ERR_INVALID_PARAMS if devid is unknown or invalid
int peripheral::DeviceSlot_2_0_2::assignAddress ( in string  packageClass,
in Address_3_0_1  address 
)

Associate this slot with an addressable (new) peripheral device.

Parameters
addressperipheral device address
Returns
0 if OK
ERR_INVALID_PARAMS if address is invalid
Device_3_0_1 peripheral::DeviceSlot_2_0_2::getDevice ( )

Returns the actual device reference.

The reference becomes invalid due to assign/unassign method call. This conditions is also flagged by EVT_KEY_DEVICE_CHANGED event

Settings peripheral::DeviceSlot_2_0_2::getSettings ( )

Retrieve the user-defined settings.

Returns
Slot settings
int peripheral::DeviceSlot_2_0_2::setSettings ( in Settings  settings)

Change the slot settings.

Parameters
settingsNew slot settings
Returns
0 if OK
ERR_INVALID_PARAMS if any parameters are invalid
int peripheral::DeviceSlot_2_0_2::unassign ( )

Break the association for this slot.

Returns
0 if OK
ERR_NOT_SUPPORTED if operation is not supported this is the case for sensors with complete position information

Member Data Documentation

valueobject peripheral::DeviceSlot_2_0_2::DeviceChangedEvent

Event: The device attached to this slot has changed.

Device before change

valueobject peripheral::DeviceSlot_2_0_2::SettingsChangedEvent

Event: The slot settings have been changed.

Settings before change


The documentation for this interface was generated from the following file: