sift_py.yaml.channel

CLASS	DESCRIPTION
ChannelBitFieldElementYamlSpec	Formal spec that defines what a bit-field element should look like in YAML.
ChannelConfigYamlSpec	Formal spec that defines what a channel should look like in YAML.
ChannelEnumTypeYamlSpec	Formal spec that defines what a channel enum type should look like in YAML.

ChannelBitFieldElementYamlSpec

Bases: TypedDict

Formal spec that defines what a bit-field element should look like in YAML.

ATTRIBUTE	DESCRIPTION
bit_count	TYPE: int
index	TYPE: int
name	TYPE: str

bit_count instance-attribute

bit_count: int

index instance-attribute

index: int

name instance-attribute

name: str

ChannelConfigYamlSpec

Bases: TypedDict

Formal spec that defines what a channel should look like in YAML.

name: Name of channel. description: Optional channel description. unit: Unit of measurement. component: Name of component that channel belongs to. data_type: Type of the data associated with the channel. enum_types: Required if data_type is enum.bit_field_elements: Required ifdata_typeisbit_field`.

ATTRIBUTE	DESCRIPTION
bit_field_elements	TYPE: NotRequired[List[ChannelBitFieldElementYamlSpec]]
component	TYPE: NotRequired[str]
data_type	TYPE: Union[Literal['double'], Literal['string'], Literal['enum'], Literal['bit_field'], Literal['bool'], Literal['float'], Literal['int32'], Literal['int64'], Literal['uint32'], Literal['uint64']]
description	TYPE: NotRequired[str]
enum_types	TYPE: NotRequired[List[ChannelEnumTypeYamlSpec]]
name	TYPE: str
unit	TYPE: NotRequired[str]

bit_field_elements instance-attribute

bit_field_elements: NotRequired[
    List[ChannelBitFieldElementYamlSpec]
]

component instance-attribute

component: NotRequired[str]

data_type instance-attribute

data_type: Union[
    Literal["double"],
    Literal["string"],
    Literal["enum"],
    Literal["bit_field"],
    Literal["bool"],
    Literal["float"],
    Literal["int32"],
    Literal["int64"],
    Literal["uint32"],
    Literal["uint64"],
]

description instance-attribute

description: NotRequired[str]

enum_types instance-attribute

enum_types: NotRequired[List[ChannelEnumTypeYamlSpec]]

name instance-attribute

name: str

unit instance-attribute

unit: NotRequired[str]

ChannelEnumTypeYamlSpec

Bases: TypedDict

Formal spec that defines what a channel enum type should look like in YAML.

ATTRIBUTE	DESCRIPTION
key	TYPE: int
name	TYPE: str

key instance-attribute

key: int

name instance-attribute

name: str