adderlib.adder module

class adderlib.adder.AdderAPI(server_address: str, *, url_handler: Optional[adderlib.urlhandlers.UrlHandler] = None, user: Optional[adderlib.users.AdderUser] = None, api_version: Optional[int] = 8)

Bases: object

connectToChannel(channel: adderlib.channels.AdderChannel, receiver: adderlib.devices.AdderReceiver, mode: Optional[adderlib.channels.AdderChannel.ConnectionMode] = ConnectionMode.SHARED): Connect a channel to a receiver

connectUSBExtender(receiver: adderlib.devices.AdderUSBReceiver, transmitter: adderlib.devices.AdderUSBTransmitter): Connect a C-USB LAN Receiver to a Transmitter

createChannel(name: str, description: Optional[str] = None, location: Optional[str] = None, modes: Optional[list[adderlib.channels.AdderChannel.ConnectionMode]] = None, video1: Optional[adderlib.devices.AdderTransmitter] = None, video1_head: Optional[int] = None, video2: Optional[adderlib.devices.AdderTransmitter] = None, video2_head: Optional[int] = None, audio: Optional[adderlib.devices.AdderTransmitter] = None, usb: Optional[adderlib.devices.AdderTransmitter] = None, serial: Optional[adderlib.devices.AdderTransmitter] = None, group_name: Optional[str] = None) → adderlib.channels.AdderChannel: Create a new channel from the specified transmitters

createPreset(name: str, pairs: Union[Iterable[adderlib.presets.AdderPreset.Pair], adderlib.presets.AdderPreset.Pair], modes: Union[Iterable[adderlib.channels.AdderChannel.ConnectionMode], adderlib.channels.AdderChannel.ConnectionMode]) → adderlib.presets.AdderPreset: Create a preset consisting of one or more channel/receiver pairs

deleteChannel(channel: adderlib.channels.AdderChannel): Delete a channel. Admin privileges are required.

deleteUSBExtender(usb: adderlib.devices.AdderUSBExtender): Delete a C-USB LAN Transmitter or Receiver

disconnectFromChannel(receiver: Union[adderlib.devices.AdderReceiver, Iterable[adderlib.devices.AdderReceiver]], force: Optional[bool] = False): Disconnect a receiver – or iterable of receivers – from its current channel

disconnectUSBExtender(receiver: adderlib.devices.AdderUSBReceiver): Connect a C-USB LAN Receiver to a Transmitter

getChannels(id: Optional[str] = None, name: Optional[str] = '') → Generator[adderlib.channels.AdderChannel, None, None]: Request a list of available Adderlink channels

getPresets(id: Optional[str] = None) → Generator[adderlib.presets.AdderPreset, None, None]: Request a list of available Adderlink presets

getReceivers(r_id: Optional[str] = None) → Generator[adderlib.devices.AdderReceiver, None, None]: Request a list of available Adderlink receivers

getServers() → Generator[adderlib.devices.AdderServer, None, None]: Request a list of available Adderlink AIM Servers

getTransmitters(t_id: Optional[str] = None) → Generator[adderlib.devices.AdderTransmitter, None, None]: Request a list of available Adderlink transmitters

getUSBReceivers(mac_address: Optional[adderlib.devices.AdderUSBReceiver] = None) → Generator[adderlib.devices.AdderUSBReceiver, None, None]: Get a list of C-USB LAN Receivers, optionally filtered by MAC address

getUSBTransmitters(mac_address: Optional[adderlib.devices.AdderUSBTransmitter] = None) → Generator[adderlib.devices.AdderUSBTransmitter, None, None]: Get a list of C-USB LAN Transmitters, optionally filtered by MAC address

identifyDevice(device: adderlib.devices.AdderDevice): Sends an ‘identify’ command to the specified device

loadPreset(preset: adderlib.presets.AdderPreset, mode: adderlib.channels.AdderChannel.ConnectionMode, force: Optional[bool] = False): Connect a preset

login(username: str, password: str): Log the user in to the KVM system and retrieve an API token

rebootDevices(devices: Union[Iterable[adderlib.devices.AdderDevice], adderlib.devices.AdderDevice]): Reboot one or more devices

replaceDevice(old_device: adderlib.devices.AdderDevice, new_device: adderlib.devices.AdderDevice): Replace an old device with a new one

property server_address: urllib.parse.ParseResult: Get the server address

setDeviceInfo(device: adderlib.devices.AdderDevice, *, description: Optional[str] = None, location: Optional[str] = None): Update the information for an existing device

setUSBExtenderInfo(usb: adderlib.devices.AdderUSBExtender, *, name: str): Update the information for an existing USB extender

setUrlHandler(handler: adderlib.urlhandlers.UrlHandler): Set the UrlHandler to use for AdderAPI URL calls

setUser(user: adderlib.users.AdderUser): Set the AdderUser to use for AdderAPI calls

unloadPreset(preset: adderlib.presets.AdderPreset, force: Optional[bool] = False): Disconnect a preset

property url_handler: adderlib.urlhandlers.UrlHandler: Get the URL Handler

exception adderlib.adder.AdderRequestError

Bases: Exception

Adder API request has not returned success