| Legrand / Raritan / Server Technology Xerus™ JSON-RPC API
    | 
Peripheral Device Slot. More...
import <PeripheralDeviceSlot.idl;
| Classes | |
| struct | DeviceChangedEvent | 
| Event: The device attached to this slot has changed.  More... | |
| struct | Location | 
| user writeable location  More... | |
| struct | Settings | 
| user configurable slot attributes  More... | |
| struct | SettingsChangedEvent | 
| Event: The slot settings have been changed.  More... | |
| Public Member Functions | |
| Device | getDevice () | 
| Returns the actual device reference. | |
| int | assign (in DeviceID devid) | 
| Associate this slot with a given (old or detected new) peripheral device. | |
| int | assignAddress (in string packageClass, in Address address) | 
| Associate this slot with an addressable (new) peripheral device. | |
| int | unassign () | 
| Break the association for this slot. | |
| Settings | getSettings () | 
| Retrieve the user-defined settings. | |
| int | setSettings (in Settings settings) | 
| Change the slot settings. | |
| 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. | |
Peripheral Device Slot.
Definition at line 47 of file PeripheralDeviceSlot.idl.
| int peripheral::DeviceSlot::assign | ( | in DeviceID | devid | ) | 
Associate this slot with a given (old or detected new) peripheral device.
| devid | peripheral device identification | 
| int peripheral::DeviceSlot::assignAddress | ( | in string | packageClass, | 
| in Address | address ) | 
Associate this slot with an addressable (new) peripheral device.
| address | peripheral device address | 
| Device peripheral::DeviceSlot::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::getSettings | ( | ) | 
Retrieve the user-defined settings.
| int peripheral::DeviceSlot::setSettings | ( | in Settings | settings | ) | 
Change the slot settings.
| settings | New slot settings | 
| int peripheral::DeviceSlot::unassign | ( | ) | 
Break the association for this slot.
| constant int peripheral::DeviceSlot::CHANNEL_INVALID = -1 | 
Device has no channels.
Definition at line 52 of file PeripheralDeviceSlot.idl.
| constant int peripheral::DeviceSlot::ERR_INVALID_PARAMS = 1 | 
Invalid parameters.
Definition at line 49 of file PeripheralDeviceSlot.idl.
| constant int peripheral::DeviceSlot::ERR_NOT_SUPPORTED = 2 | 
Operation not supported.
Definition at line 50 of file PeripheralDeviceSlot.idl.