adderlib.devices module

class adderlib.devices.AdderDevice(properties: dict)

Bases: abc.ABC

Abstract Adder device

class DeviceModel(value)

Bases: enum.Enum

AdderLink device models

ALIF1000 = '1'

ALIF1002 = 's'

ALIF100T = 'd'

ALIF100T_VGA = ('f',)

ALIF101T_HDMI = ('h',)

ALIF2002 = 'b'

ALIF2020 = 't'

ALIF2112 = 'v'

ALIF4021R = ('4',)

ALIFE300R = '8'

UNKNOWN = '?'

class DeviceStatus(value)

Bases: enum.Enum

Operational status of Adder device

BACKUP_FIRMWARE = 6

OFFLINE = 0

ONLINE = 1

REBOOTING = 2

UNKNOWN = -1

UPGRADING = 4

class DeviceType(value)

Bases: enum.Enum

Types of Adder devices

RX = 0

TX = 1

property backup_firmware: str: Backup firmware version

property date_dadded: datetime.datetime: The date/time this device was set up

property description: str: Device description

property firmware: str: Current firmware version

property id: str: Device ID

property ip_address: Optional[Union[ipaddress.IPv4Address, ipaddress.IPv6Address]]: Primary IP address of the device

property ip_addresses: Tuple[Optional[Union[ipaddress.IPv4Address, ipaddress.IPv6Address]]]: IP addresses on the network

property is_backup_firmware_valid: bool: If the current firmware is in working order

property is_configured: bool: If the device has been set up

property is_firmware_valid: bool: If the current firmware is in working order

property location: str: Device location

property mac_address: str: Primary MAC address

property mac_addresses: Tuple[str]: MAC addresses of the interfaces

property model: adderlib.devices.AdderDevice.DeviceModel: Device model

property name: str: Device name

property network_interfaces: Tuple[adderlib.devices.NetworkInterface]: Return network interfaces

property serial_number: str: Device serial number

property status: adderlib.devices.AdderDevice.DeviceStatus: Device status

class adderlib.devices.AdderReceiver(properties: dict)

Bases: adderlib.devices.AdderDevice

Adderlink Receiver (RX) Device

class ConnectionControlType(value)

Bases: enum.Enum

Control modes

EXCLUSIVE = 2

SHARED = 3

UNKNOWN = -1

VIDEO_ONLY = 1

property channel_name: str: The name of the last known channel this receiver was connected

property connection_control: adderlib.devices.AdderReceiver.ConnectionControlType: Control mode of the last known connection

property connection_end: Optional[datetime.datetime]: Time the last known connection was ended. Returns None if connection is current.

property connection_start: Optional[datetime.datetime]: Time the last known connection started

property current_userid: str: User ID of current user connected

property current_username: str: Name of current user connected

property group_count: int: Number of receiver groups this belongs to

property is_connected: bool: Is the receiver currently connected to a channel

property last_userid: str: Last known user ID

property last_username: str: Last known username

property preset_count: int: Number of receiver presets this belongs to

property user_count: int: Number of users with access to this receiver

class adderlib.devices.AdderServer(properties: dict)

Bases: object

An Adder Server Device

class DualEthernetConfig(value)

Bases: enum.Enum

The configuration of the second ethernet port

BONDED = (3,)

DHCP = (1,)

NO = (0,)

STATIC = (2,)

UNKNOWN = -1

class Role(value)

Bases: enum.Enum

The role of the AIM

BACKUP = ('backup',)

PRIMARY = ('primary',)

SOLO = ('solo',)

UNCONFIGURED = ('unconfigured',)

UNKNOWN = 'unknown'

class Status(value)

Bases: enum.Enum

The status of the AIM

ACTIVE = ('active',)

FAILED = ('failed',)

QUISCENT = ('quiscent',)

STANDBY = ('standby',)

UNKNOWN = 'unknown'

property description: str: Server description

property dual_ethernet_config: adderlib.devices.AdderServer.DualEthernetConfig: The configuration of the second ethernet port

property ip_address: Optional[Union[ipaddress.IPv4Address, ipaddress.IPv6Address]]: Primary IP address of the device

property ip_addresses: Tuple[Optional[Union[ipaddress.IPv4Address, ipaddress.IPv6Address]]]: IP addresses on the network

property location: str: Server location

property mac_address: str: Primary MAC address

property mac_addresses: Tuple[str]: MAC addresses of the interfaces

property name: str: Server name

property role: adderlib.devices.AdderServer.Role: The configured role of the AIM

property status: adderlib.devices.AdderServer.Status: The current status of the AIM

class adderlib.devices.AdderTransmitter(properties: dict)

Bases: adderlib.devices.AdderDevice

Adderlink Transmitter (TX) Device

property channel_count: int: Number of channels that use this device

property preset_count: int: Number of presets that use this device

class adderlib.devices.AdderUSBExtender(properties: dict)

Bases: abc.ABC

Abstract Adder C-USB LAN Extender Device

property ip_address: Optional[Union[ipaddress.IPv4Address, ipaddress.IPv6Address]]

property is_online: bool

property mac_address: str

property name: str: Device name

property network_interface: adderlib.devices.NetworkInterface

class adderlib.devices.AdderUSBReceiver(properties: dict)

Bases: adderlib.devices.AdderUSBExtender

Adder C-USB Lan Network Receiver

property connected_to: str: MAC address of the connected transmitter

class adderlib.devices.AdderUSBTransmitter(properties: dict)

Bases: adderlib.devices.AdderUSBExtender

Adder C-USB LAN Network Transmitter

class adderlib.devices.NetworkInterface(ip_address: Union[ipaddress.IPv4Address, ipaddress.IPv6Address], mac_address: str, is_online: bool)

Bases: object

Network interface info

ip_address: Union[ipaddress.IPv4Address, ipaddress.IPv6Address]

is_online: bool

mac_address: str