tslumd.tallyobj

class tslumd.tallyobj.Tally(*args, **kwargs)

Bases: Dispatcher

A single tally object

Properties:

rh_tally: TallyColor → Property(TallyColor)

State of the right-hand tally indicator

txt_tally: TallyColor → Property(TallyColor)

State of the text tally indicator

lh_tally: TallyColor → Property(TallyColor)

State of the left-hand tally indicator

brightness: int → Property(int)

Tally indicator brightness from 0 to 3

text: str → Property(str)

Text to display

control: bytes → Property(bytes)

Any control data received for the tally indicator

normalized_brightness: float → Property(float)

The brightness value normalized as a float from 0.0 to 1.0

Events:

on_update(instance: Tally, props_changed: set[str])

Fired when any property changes

on_control(instance: Tally, data: bytes)

Fired when control data is received for the tally indicator

Added in version 0.0.2: The on_control event

Changed in version 0.0.5: Added container emulation

class InitKwargs

Bases: TypedDict

Keyword arguments for initializing a Tally instance

class UpdateKwargs

Bases: InitKwargs

Keyword arguments for use in the Tally.update() method

class SerializeTD

Bases: TypedDict

Dictionary representation of a Tally instance

screen: Screen | None

The parent Screen this tally belongs to

Added in version 0.0.3.

property index: int

Index of the tally object from 0 to 65534 (0xfffe)

property id: Tuple[int, int]

A key to uniquely identify a Tally / Screen combination.

Tuple of (Screen.index, Tally.index)

Raises:

ValueError – If the Tally.screen is None

Added in version 0.0.3.

property is_broadcast: bool

True if the tally is to be “broadcast”, meaning sent to all display indices.

(if the index is 0xffff)

Added in version 0.0.2.

classmethod broadcast(**kwargs) → Tally

Create a broadcast tally

(with index set to 0xffff)

Added in version 0.0.2.

classmethod from_display(display: Display, screen: Screen | None = None) → Tally

Create an instance from the given Display object

set_color(tally_type: str | TallyType, color: str | TallyColor)

Set the color property (or properties) for the given TallyType

Sets the rh_tally, txt_tally or lh_tally properties matching the TallyType value(s).

If the given tally_type is a combination of tally types, all of the matched attributes will be set to the given color.

Parameters:

• tally_type (TallyType or str) –

  The TallyType member(s) to set. Multiple types can be specified using bitwise | operators.

  If the argument is a string, it should be formatted as shown in TallyType.from_str()

• color (TallyColor or str) – The TallyColor to set, or the name as a string

>>> from tslumd import Tally, TallyType, TallyColor
>>> tally = Tally(0)
>>> tally.set_color(TallyType.rh_tally, TallyColor.RED)
>>> tally.rh_tally
<TallyColor.RED: 1>
>>> tally.set_color('lh_tally', 'green')
>>> tally.lh_tally
<TallyColor.GREEN: 2>
>>> tally.set_color('rh_tally|txt_tally', 'green')
>>> tally.rh_tally
<TallyColor.GREEN: 2>
>>> tally.txt_tally
<TallyColor.GREEN: 2>
>>> tally.set_color('all', 'off')
>>> tally.rh_tally
<TallyColor.OFF: 0>
>>> tally.txt_tally
<TallyColor.OFF: 0>
>>> tally.lh_tally
<TallyColor.OFF: 0>

Added in version 0.0.4.

Changed in version 0.0.5: Allow string arguments and multiple tally_type members

get_color(tally_type: str | TallyType) → TallyColor

Get the color of the given tally_type

If tally_type is a combination of tally types, the color returned will be a combination all of the matched color properties.

Parameters:

tally_type (TallyType or str) –

TallyType member(s) to get the color values from.

If the argument is a string, it should be formatted as shown in TallyType.from_str()

>>> tally = Tally(0)
>>> tally.get_color('rh_tally')
<TallyColor.OFF: 0>
>>> tally.set_color('rh_tally', 'red')
>>> tally.get_color('rh_tally')
<TallyColor.RED: 1>
>>> tally.set_color('txt_tally', 'red')
>>> tally.get_color('rh_tally|txt_tally')
<TallyColor.RED: 1>
>>> tally.get_color('all')
<TallyColor.RED: 1>
>>> tally.set_color('lh_tally', 'green')
>>> tally.get_color('lh_tally')
<TallyColor.GREEN: 2>
>>> tally.get_color('all')
<TallyColor.AMBER: 3>

Added in version 0.0.5.

merge_color(tally_type: TallyType, color: TallyColor)

Merge the color property (or properties) for the given TallyType using the set_color() method

Combines the existing color value with the one provided using a bitwise | (or) operation

Parameters:

• tally_type (TallyType) – The TallyType member(s) to merge. Multiple types can be specified using bitwise | operators.

• color (TallyColor) – The TallyColor to merge

Added in version 0.0.4.

merge(other: Tally, tally_type: TallyType = <TallyType.all_tally: 7>)

Merge the color(s) from another Tally instance into this one using the merge_color() method

Parameters:

• other (Tally) – The Tally instance to merge with

• tally_type (TallyType, optional) – The TallyType member(s) to merge. Multiple types can be specified using bitwise | operators. Default is all_tally (all three types)

Added in version 0.0.4.

update(**kwargs: Unpack[UpdateKwargs]) → set[str]

Update any known properties from the given keyword-arguments

Returns:

The property names, if any, that changed

Return type:

set

update_from_display(display: Display) → set[str]

Update this instance from the values of the given Display object

Returns:

The property names, if any, that changed

Return type:

set

to_dict() → SerializeTD

Serialize to a SerializeTD

to_common_dict() → DisplayTallyCommonDict

Return a dict of the common fields between Tally and Display objects

Added in version 0.0.8.

class tslumd.tallyobj.Screen(*args, **kwargs)

Bases: Dispatcher

A group of Tally displays

Properties:

scontrol: bytes → Property(bytes)

Any control data received for the screen

Events:

on_tally_added(tally: Tally)

Fired when a new Tally instance is added to the screen

on_tally_update(tally: Tally, props_changed: set[str])

Fired when any Tally property changes. This is a retransmission of Tally.on_update

on_tally_control(tally: Tally, data: bytes)

Fired when control data is received for a Tally object. This is a retransmission of Tally.on_control

on_control(instance: Screen, data: bytes)

Fired when control data is received for the Screen itself

Added in version 0.0.3.

tallies: dict[int, Tally]

Mapping of Tally objects within the screen using their index as keys

property index: int

The screen index from 0 to 65534 (0xFFFE)

property is_broadcast: bool

True if the screen is to be “broadcast”, meaning sent to all screen indices.

(if the index is 0xffff)

classmethod broadcast(**kwargs) → Screen

Create a broadcast Screen

(with index set to 0xffff)

broadcast_tally(**kwargs: Unpack[InitKwargs]) → Tally

Create a temporary Tally using Tally.broadcast()

Parameters:

**kwargs – Keyword arguments to pass to the Tally constructor

Note

The tally object is not stored in tallies and no event propagation (on_tally_added, on_tally_update, on_tally_control) is handled by the Screen.

add_tally(index_: int, **kwargs: Unpack[InitKwargs]) → Tally

Create a Tally object and add it to tallies

Parameters:

• index – The tally index

• **kwargs – Keyword arguments passed to create the tally instance

Raises:

KeyError – If the given index_ already exists

get_or_create_tally(index_: int) → Tally

If a Tally object matching the given index exists, return it. Otherwise create one and add it to tallies

This method is similar to add_tally() and it can be used to avoid exception handling. It does not however take keyword arguments and is only intended for object creation.

update_from_message(msg: Message)

Handle an incoming Message