common Module

TallyConfig Classes

class tallypi.common.TallyConfig

Bases: object

Configuration data for tally assignment

to_dict() → Dict

Serialize the config data

classmethod from_dict(d: Dict) → tallypi.common.TallyConfig

Create a TallyConfig from serialized data

class tallypi.common.SingleTallyConfig(tally_index: int, tally_type: tslumd.common.TallyType = <TallyType.no_tally: 0>, color_mask: tslumd.common.TallyColor = <TallyColor.AMBER: 3>, screen_index: Optional[int] = None, name: Optional[str] = '')

Bases: tallypi.common.TallyConfig

Configuration for a single tally

tally_index: int

The tally index ranging from 0 to 65534 (0xfffe)

The special value of 65535 (0xffff) is used as a “broadcast” address

tally_type: tslumd.common.TallyType = 0

The TallyType

color_mask: tslumd.common.TallyColor = 3

An optional mask which can limit the color changes

The default (AMBER) allows all changes

screen_index: Optional[int] = None

The index of the tslumd.tallyobj.Screen the tally belongs to, ranging from 0 to 65534 (0xfffe)

If not provided (or None), the tally is assumed to belong to any screen. This is also the case if the value is 65535 (0xffff), defined as the “broadcast” screen address.

name: Optional[str] = ''

User-defined name for the tally

classmethod from_tally(tally: tslumd.tallyobj.Tally, **kwargs) → tallypi.common.SingleTallyConfig

Create a SingleTallyConfig from a Tally

property tally_key: Tuple[int, int]

A tuple of (screen_index, tally_index) matching the format used for tslumd.tallyobj.Tally.id

If screen_index or tally_index is None, they are set to 65535 (0xffff)

property id: Tuple[int, int]

Alias for tally_key to match Tally.id

property is_broadcast_screen: bool

True if screen_index is set to None or the “broadcast” address of 65535 (0xffff)

property is_broadcast_tally: bool

True if tally_index is set to None or the “broadcast” address of 65535 (0xffff)

matches(other: Union[tslumd.tallyobj.Tally, tallypi.common.SingleTallyConfig, Tuple[int, int]], tally_type: Optional[tslumd.common.TallyType] = <TallyType.all_tally: 7>, return_matched: Optional[bool] = False) → Union[bool, tallypi.common.SingleTallyConfig]

Determine whether the given tally argument matches this one

For screen_index the matches_screen() method is used

Parameters

• other – Either another SingleTallyConfig, a tslumd.tallyobj.Tally instance or a TallyKey

• tally_type – If provided, a TallyType member (or members) to match against

• return_matched – If False (the default), only return a boolean result, otherwise return the matched SingleTallyConfig if one was found.

matches_screen(other: Union[tslumd.tallyobj.Tally, tallypi.common.SingleTallyConfig, tallypi.common.MultiTallyConfig, Tuple[int, int], int]) → bool

Determine whether the screen_index matches the given argument

For tslumd.tallyobj.Tally, the screen's is_broadcast value is taken into account as well as cases where screen_index is set to None

Parameters

other – A SingleTallyConfig, MultiTallyConfig, tslumd.tallyobj.Tally or int

to_dict() → Dict

Serialize the config data

classmethod from_dict(d: Dict) → tallypi.common.SingleTallyConfig

Create a TallyConfig from serialized data

create_screen() → tslumd.tallyobj.Screen

Create a tslumd.tallyobj.Screen with the screen_index of this object

create_tally(screen: Optional[tslumd.tallyobj.Screen] = None) → Tuple[tslumd.tallyobj.Screen, tslumd.tallyobj.Tally]

Create a tslumd.tallyobj.Tally from this instance

Parameters

screen (tslumd.tallyobj.Screen, optional) – The parent tslumd.tallyobj.Tally.screen to add the tally to. If not provided, one will be created

Returns

• screen (tslumd.tallyobj.Screen) – The parent screen that was either created or given as an argument

• tally (tslumd.tallyobj.Tally) – The tally object

class tallypi.common.MultiTallyConfig(tallies: Optional[dataclasses.InitVar] = None, screen_index: Optional[int] = None, allow_all: bool = False, name: Optional[str] = '')

Bases: tallypi.common.TallyConfig

Configuration for multiple tallies

tallies: dataclasses.InitVar = None

A list of SingleTallyConfig instances

screen_index: Optional[int] = None

The index of the tslumd.tallyobj.Screen for the configuration ranging from 0 to 65534 (0xfffe)

This only takes effect if allow_all is True and provides a method of filtering the tally assignments to a single tslumd.tallyobj.Screen if desired.

If not provided (or None), all tallies within all screens are considered to be members of the configuration. This is also the case if the value is 65535 (0xffff), defined as the “broadcast” screen address.

allow_all: bool = False

If True, all possible tally configurations exist within this instance

Tallies can still be limited to a specific screen_index if desired

name: Optional[str] = ''

User-defined name for the tally config

property is_broadcast_screen: bool

True if screen_index is set to None or the “broadcast” address of 65535 (0xffff)

Note

Behavior is undefined if allow_all is False

matches(tally: Union[tslumd.tallyobj.Tally, tallypi.common.SingleTallyConfig, Tuple[int, int]], tally_type: Optional[tslumd.common.TallyType] = <TallyType.all_tally: 7>, return_matched: Optional[bool] = False) → Union[bool, tallypi.common.SingleTallyConfig]

Alias for contains()

matches_screen(other: Union[tslumd.tallyobj.Tally, tallypi.common.SingleTallyConfig, tallypi.common.MultiTallyConfig, Tuple[int, int], int]) → bool

Determine whether the screen_index matches the given argument

For tslumd.tallyobj.Tally, the screen's is_broadcast value is taken into account as well as cases where screen_index is set to None

Parameters

other – A SingleTallyConfig, MultiTallyConfig, tslumd.tallyobj.Tally or int

Note

Behavior is undefined if allow_all is False

contains(tally: Union[tslumd.tallyobj.Tally, tallypi.common.SingleTallyConfig, Tuple[int, int]], tally_type: Optional[tslumd.common.TallyType] = <TallyType.all_tally: 7>, return_matched: Optional[bool] = False) → Union[bool, tallypi.common.SingleTallyConfig]

Determine whether the given tally argument is included in this configuration

The matches_screen() method is used to match the screen_index. If allow_all is False, each object in tallies is checked

Parameters

tally – Either a SingleTallyConfig or a tslumd.tallyobj.Tally instance

to_dict() → Dict

Serialize the config data

classmethod from_dict(d: Dict) → tallypi.common.MultiTallyConfig

Create a TallyConfig from serialized data

Helper Types

tallypi.common.Pixel

A tuple of (x, y) coordinates

alias of Tuple[int, int]

tallypi.common.Rgb

A color tuple of (r, g, b)

alias of Tuple[int, int, int]