umd Module

class tallypi.outputs.umd.ClientData(hostaddr: str, hostport: int)

Bases: object

Container for network client data

hostaddr: str

The network host address

hostport: int

The port number

property as_tuple: Tuple[str, int]

The client data as a tuple of (hostaddr, hostport)

tallypi.outputs.umd.ClientOrData

Client or ClientData

alias of Union[Tuple[str, int], tallypi.outputs.umd.ClientData]

class tallypi.outputs.umd.UmdOutput(*args, **kwargs)

Bases: tallypi.baseio.BaseOutput

Networked tally output using the UMDv5 protocol

Parameters

• config (MultiTallyConfig) – The initial value for config

• clients (Iterable[ClientOrData], optional) – The initial clients to set

• all_off_on_close – (bool, optional): Value to set for all_off_on_close

Properties

clients: set → SetProperty(set)

A SetProperty containing the remote host addresses as address/port tuples.

sender: tslumd.sender.UmdSender

The tslumd.sender.UmdSender instance

property all_off_on_close: bool

Alias for tslumd.sender.UmdSender.all_off_on_close.

If True, the sender will turn all tally indicators off before closing. Default is False

classmethod get_init_options() → Tuple[tallypi.config.Option]

Get the config.Option definitions required for this object

async open()

Initalize any necessary device communication

async close()

Close device communication

add_client(client: Union[Tuple[str, int], tallypi.outputs.umd.ClientData])

Add an item to clients

remove_client(client: Union[Tuple[str, int], tallypi.outputs.umd.ClientData])

Remove an item from clients

async on_receiver_tally_change(tally: tslumd.tallyobj.Tally, props_changed: Set[str], **kwargs)

Callback for tally updates from tslumd.tallyobj.Tally