Data Types¶

Epoch¶

class yamcs.pymdb.Epoch¶

Bases: Enum

An enumeration.

GPS = 1¶

J2000 = 2¶

TAI = 3¶

UNIX = 4¶

DynamicInteger¶

class yamcs.pymdb.DynamicInteger¶

Bases: object

DynamicInteger(parameter: ‘IntegerParameter | str’)

__init__(parameter: IntegerParameter | str) → None¶

parameter: IntegerParameter | str¶

Retrieve the value of this parameter.

The parameter may be specified as str, which is intended for referencing a parameter that is not managed with PyMDB.

DataType¶

class yamcs.pymdb.DataType¶

Bases: object

__init__(short_description: Optional[str] = None, long_description: Optional[str] = None, extra: Optional[Mapping[str, str]] = None, units: Optional[str] = None, encoding: Optional[Encoding] = None) → None¶

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

long_description: str | None¶: Multiline description

short_description: str | None¶: Oneline description

units: str | None¶: Engineering units

AbsoluteTimeDataType¶

class yamcs.pymdb.AbsoluteTimeDataType¶

Bases: DataType

__init__(reference: Epoch | datetime | AbsoluteTimeParameter, short_description: str | None = None, long_description: str | None = None, extra: Mapping[str, str] | None = None, units: str | None = None, encoding: TimeEncoding | None = None) → None¶

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

long_description: str | None¶: Multiline description

short_description: str | None¶: Oneline description

units: str | None¶: Engineering units

AggregateDataType¶

class yamcs.pymdb.AggregateDataType¶

Bases: DataType

__init__(members: Sequence[Member], short_description: Optional[str] = None, long_description: Optional[str] = None, extra: Optional[Mapping[str, str]] = None, units: Optional[str] = None, encoding: Optional[Encoding] = None) → None¶

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

find_member(name: str) → Member¶

long_description: str | None¶: Multiline description

short_description: str | None¶: Oneline description

units: str | None¶: Engineering units

ArrayDataType¶

class yamcs.pymdb.ArrayDataType¶

Bases: DataType

__init__(data_type: DataType, length: int | DynamicInteger, short_description: Optional[str] = None, long_description: Optional[str] = None, extra: Optional[Mapping[str, str]] = None, encoding: Optional[Encoding] = None) → None¶

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

long_description: str | None¶: Multiline description

short_description: str | None¶: Oneline description

units: str | None¶: Engineering units

BinaryDataType¶

class yamcs.pymdb.BinaryDataType¶

Bases: DataType

__init__(min_length: Optional[int] = None, max_length: Optional[int] = None, short_description: Optional[str] = None, long_description: Optional[str] = None, extra: Optional[Mapping[str, str]] = None, units: Optional[str] = None, encoding: Optional[Encoding] = None) → None¶

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

long_description: str | None¶: Multiline description

max_length: int | None¶: Maximum length in bytes

min_length: int | None¶: Minimum length in bytes

short_description: str | None¶: Oneline description

units: str | None¶: Engineering units

BooleanDataType¶

class yamcs.pymdb.BooleanDataType¶

Bases: DataType

__init__(zero_string_value: str = 'False', one_string_value: str = 'True', short_description: Optional[str] = None, long_description: Optional[str] = None, extra: Optional[Mapping[str, str]] = None, units: Optional[str] = None, encoding: Optional[Encoding] = None) → None¶

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

long_description: str | None¶: Multiline description

short_description: str | None¶: Oneline description

units: str | None¶: Engineering units

EnumeratedDataType¶

class yamcs.pymdb.EnumeratedDataType¶

Bases: DataType

__init__(choices: Sequence[tuple[int, str] | tuple[int, str, str]] | type[Enum], short_description: Optional[str] = None, long_description: Optional[str] = None, extra: Optional[Mapping[str, str]] = None, units: Optional[str] = None, encoding: Optional[Encoding] = None) → None¶

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

label_for(value: int)¶

long_description: str | None¶: Multiline description

short_description: str | None¶: Oneline description

units: str | None¶: Engineering units

FloatDataType¶

class yamcs.pymdb.FloatDataType¶

Bases: DataType

__init__(bits: Literal[32, 64] = 32, minimum: float | None = None, minimum_inclusive: bool = True, maximum: float | None = None, maximum_inclusive: bool = True, short_description: str | None = None, long_description: str | None = None, extra: Mapping[str, str] | None = None, units: str | None = None, encoding: Encoding | None = None, calibrator: Calibrator | None = None) → None¶

calibrator: Calibrator | None¶: Describes how a raw value is transformed to an engineering value

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

long_description: str | None¶: Multiline description

maximum: float | None¶: Maximum valid engineering value (inclusive)

maximum_inclusive: bool¶: Whether the maximum value itself is valid

minimum: float | None¶: Minimum valid engineering value

minimum_inclusive: bool¶: Whether the minimum value itself is valid

short_description: str | None¶: Oneline description

units: str | None¶: Engineering units

IntegerDataType¶

class yamcs.pymdb.IntegerDataType¶

Bases: DataType

__init__(signed: bool = True, bits: int = 32, minimum: int | None = None, maximum: int | None = None, short_description: str | None = None, long_description: str | None = None, extra: Mapping[str, str] | None = None, units: str | None = None, encoding: Encoding | None = None, calibrator: Calibrator | None = None) → None¶

calibrator: Calibrator | None¶: Describes how a raw value is transformed to an engineering value

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

long_description: str | None¶: Multiline description

maximum: int | None¶: Maximum valid engineering value (inclusive)

minimum: int | None¶: Minimum valid engineering value (inclusive)

short_description: str | None¶: Oneline description

units: str | None¶: Engineering units

StringDataType¶

class yamcs.pymdb.StringDataType¶

Bases: DataType

__init__(min_length: Optional[int] = None, max_length: Optional[int] = None, short_description: Optional[str] = None, long_description: Optional[str] = None, extra: Optional[Mapping[str, str]] = None, units: Optional[str] = None, encoding: Optional[Encoding] = None) → None¶

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

long_description: str | None¶: Multiline description

max_length: int | None¶: Maximum length in characters

min_length: int | None¶: Minimum length in characters

short_description: str | None¶: Oneline description

units: str | None¶: Engineering units

Member¶

class yamcs.pymdb.Member¶

Bases: DataType

__init__(name: str, initial_value: Optional[Any] = None, short_description: Optional[str] = None, long_description: Optional[str] = None, extra: Optional[Mapping[str, str]] = None, units: Optional[str] = None, encoding: Optional[Encoding] = None) → None¶

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

initial_value: Any¶: Initial value

long_description: str | None¶: Multiline description

name: str¶: Member name

short_description: str | None¶: Oneline description

units: str | None¶: Engineering units

AbsoluteTimeMember¶

class yamcs.pymdb.AbsoluteTimeMember¶

Bases: Member, AbsoluteTimeDataType

__init__(name: str, reference: Epoch | datetime | AbsoluteTimeParameter, initial_value: Any = None, short_description: str | None = None, long_description: str | None = None, extra: Mapping[str, str] | None = None, units: str | None = None, encoding: TimeEncoding | None = None) → None¶

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

initial_value: Any¶: Initial value

long_description: str | None¶: Multiline description

name: str¶: Member name

reference: Epoch | datetime | AbsoluteTimeParameter¶

short_description: str | None¶: Oneline description

units: str | None¶: Engineering units

AggregateMember¶

class yamcs.pymdb.AggregateMember¶

Bases: Member, AggregateDataType

__init__(name: str, members: Sequence[Member], initial_value: Optional[Any] = None, short_description: Optional[str] = None, long_description: Optional[str] = None, extra: Optional[Mapping[str, str]] = None, encoding: Optional[Encoding] = None) → None¶

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

find_member(name: str) → Member¶

initial_value: Any¶: Initial value

long_description: str | None¶: Multiline description

members: list[Member]¶

name: str¶: Member name

short_description: str | None¶: Oneline description

units: str | None¶: Engineering units

ArrayMember¶

class yamcs.pymdb.ArrayMember¶

Bases: Member, ArrayDataType

__init__(name: str, data_type: DataType, length: int, initial_value: Optional[Any] = None, short_description: Optional[str] = None, long_description: Optional[str] = None, extra: Optional[Mapping[str, str]] = None, encoding: Optional[Encoding] = None) → None¶

data_type: DataType¶

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

initial_value: Any¶: Initial value

length: int | DynamicInteger¶

long_description: str | None¶: Multiline description

name: str¶: Member name

short_description: str | None¶: Oneline description

units: str | None¶: Engineering units

BinaryMember¶

class yamcs.pymdb.BinaryMember¶

Bases: Member, BinaryDataType

__init__(name: str, min_length: Optional[int] = None, max_length: Optional[int] = None, initial_value: Optional[Any] = None, short_description: Optional[str] = None, long_description: Optional[str] = None, extra: Optional[Mapping[str, str]] = None, units: Optional[str] = None, encoding: Optional[Encoding] = None) → None¶

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

initial_value: Any¶: Initial value

long_description: str | None¶: Multiline description

max_length: int | None¶: Maximum length in bytes

min_length: int | None¶: Minimum length in bytes

name: str¶: Member name

short_description: str | None¶: Oneline description

units: str | None¶: Engineering units

BooleanMember¶

class yamcs.pymdb.BooleanMember¶

Bases: Member, BooleanDataType

__init__(name: str, zero_string_value: str = 'False', one_string_value: str = 'True', initial_value: Optional[Any] = None, short_description: Optional[str] = None, long_description: Optional[str] = None, extra: Optional[Mapping[str, str]] = None, units: Optional[str] = None, encoding: Optional[Encoding] = None) → None¶

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

initial_value: Any¶: Initial value

long_description: str | None¶: Multiline description

name: str¶: Member name

one_string_value: str¶

short_description: str | None¶: Oneline description

units: str | None¶: Engineering units

zero_string_value: str¶

EnumeratedMember¶

class yamcs.pymdb.EnumeratedMember¶

Bases: Member, EnumeratedDataType

__init__(name: str, choices: Sequence[tuple[int, str] | tuple[int, str, str]] | type[Enum], initial_value: Optional[Any] = None, short_description: Optional[str] = None, long_description: Optional[str] = None, extra: Optional[Mapping[str, str]] = None, units: Optional[str] = None, encoding: Optional[Encoding] = None) → None¶

choices: Sequence[tuple[int, str] | tuple[int, str, str]] | type[Enum]¶

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

initial_value: Any¶: Initial value

label_for(value: int)¶

long_description: str | None¶: Multiline description

name: str¶: Member name

short_description: str | None¶: Oneline description

units: str | None¶: Engineering units

FloatMember¶

class yamcs.pymdb.FloatMember¶

Bases: Member, FloatDataType

__init__(name: str, bits: Literal[32, 64] = 32, minimum: float | None = None, minimum_inclusive: bool = True, maximum: float | None = None, maximum_inclusive: bool = True, initial_value: Any = None, short_description: str | None = None, long_description: str | None = None, extra: Mapping[str, str] | None = None, units: str | None = None, encoding: Encoding | None = None, calibrator: Calibrator | None = None) → None¶

bits: Literal[32, 64]¶

calibrator: Calibrator | None¶: Describes how a raw value is transformed to an engineering value

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

initial_value: Any¶: Initial value

long_description: str | None¶: Multiline description

maximum: float | None¶: Maximum valid engineering value (inclusive)

maximum_inclusive: bool¶: Whether the maximum value itself is valid

minimum: float | None¶: Minimum valid engineering value

minimum_inclusive: bool¶: Whether the minimum value itself is valid

name: str¶: Member name

short_description: str | None¶: Oneline description

units: str | None¶: Engineering units

IntegerMember¶

class yamcs.pymdb.IntegerMember¶

Bases: Member, IntegerDataType

__init__(name: str, signed: bool = True, bits: int = 32, minimum: int | None = None, maximum: int | None = None, initial_value: Any = None, short_description: str | None = None, long_description: str | None = None, extra: Mapping[str, str] | None = None, units: str | None = None, encoding: Encoding | None = None, calibrator: Calibrator | None = None) → None¶

bits: int¶

calibrator: Calibrator | None¶: Describes how a raw value is transformed to an engineering value

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

initial_value: Any¶: Initial value

long_description: str | None¶: Multiline description

maximum: int | None¶: Maximum valid engineering value (inclusive)

minimum: int | None¶: Minimum valid engineering value (inclusive)

name: str¶: Member name

short_description: str | None¶: Oneline description

signed: bool¶

units: str | None¶: Engineering units

StringMember¶

class yamcs.pymdb.StringMember¶

Bases: Member, StringDataType

__init__(name: str, min_length: Optional[int] = None, max_length: Optional[int] = None, initial_value: Optional[Any] = None, short_description: Optional[str] = None, long_description: Optional[str] = None, extra: Optional[Mapping[str, str]] = None, units: Optional[str] = None, encoding: Optional[Encoding] = None) → None¶

encoding: Encoding | None¶: How this data is sent or received from some non-native, off-platform device. (e.g. a spacecraft)

extra: dict[str, str]¶: Arbitrary information, keyed by name

initial_value: Any¶: Initial value

long_description: str | None¶: Multiline description

max_length: int | None¶: Maximum length in characters

min_length: int | None¶: Minimum length in characters

name: str¶: Member name

short_description: str | None¶: Oneline description

units: str | None¶: Engineering units