Model¶

class yamcs.client.Algorithm(proto)¶

Bases: MissionDatabaseItem

class yamcs.client.Argument(proto)¶

Bases: object

property description: Optional[str]¶

Short description

property initial_value: Optional[str]¶

Initial value

property name: str¶

Argument name

property type: ArgumentType¶

Argument type information

class yamcs.client.ArgumentType(proto)¶

Bases: object

property eng_type: str¶

Engineering type

property name: str¶

Type name

class yamcs.client.ArrayType(proto)¶

Bases: object

property array_type: Optional[ArrayType]¶

In case the elements of an array of this type are also of type array, this returns type info of the elements’ array type.

Note

This is an uncommon use case. Multi-dimensional arrays are more prevalent.

property dimensions: Optional[int]¶

The number of dimensions in case of a multi-dimensional array.

property members: List[Member]¶

In case the elements of this array are of type aggregate, this returns an ordered list of its direct sub-members.

property name: str¶

Short name of this type.

class yamcs.client.Command(proto)¶

Bases: MissionDatabaseItem

property abstract: bool¶

Whether this is an abstract command. Abstract commands are intended for inheritance and cannot be issued directly.

property arguments: List[Argument]¶

property base_command: Optional[Command]¶

property significance: Optional[Significance]¶

class yamcs.client.Container(proto)¶

Bases: MissionDatabaseItem

class yamcs.client.DataEncoding(proto)¶

Bases: object

property bitlength: Optional[int]¶

The size in bits

property encoding: Optional[str]¶

Encoding detail

property little_endian: bool¶

True if little-endian

property type: str¶

Raw type

class yamcs.client.EnumValue(proto)¶

Bases: object

property description: Optional[str]¶

State description

property label: str¶

String value

property value: int¶

Numeric value

class yamcs.client.Member(proto)¶

Bases: object

A member is a data structure for a specific field of a parent data type (either another member, or a parameter of type aggregate).

This is similar to C structs. The top-level of a member hierarchy is a parameter of type aggregate.

property array_type: Optional[ArrayType]¶

In case this member is of type array, this returns array-specific type info.

property members: List[Member]¶

In case this member is of type aggregate, this returns an ordered list of its direct sub-members.

property name: str¶

Short name

property type: str¶

Engineering type.

class yamcs.client.MissionDatabaseItem(proto)¶

Bases: ABC

Superclass for MDB items. Implementations:

• Algorithm

• Command

• Container

• Parameter

• ParameterType

• SpaceSystem

property aliases: Dict[str, str]¶

Aliases, keyed by namespace

property aliases_dict: Dict[str, str]¶

Aliases, keyed by namespace

This method shall be deprecated in a future release. Use aliases instead.

property description: Optional[str]¶

Short description.

property long_description: Optional[str]¶

Long description.

property name: str¶

Short name

property qualified_name: str¶

Full name (incl. space system)

class yamcs.client.Parameter(proto)¶

Bases: MissionDatabaseItem

A Parameter is a description of something that can have a value. It is not the value itself.

property array_type: Optional[ArrayType]¶

In case this parameter is of type array, this returns array-specific type info.

property data_encoding: Optional[DataEncoding]¶

Information on the raw encoding of this parameter, if applicable.

property data_source: Optional[str]¶

TELEMETERED)

Type:

Specifies the source of this parameter (example

property enum_values: List[EnumValue]¶

In case this parameter is of type enumeration, this returns an ordered list of possible values.

property members: List[Member]¶

In case this parameter is of type aggregate, this returns an ordered list of its direct members.

property type: Optional[str]¶

Engineering type.

property units: List[str]¶

Engineering unit(s)

class yamcs.client.ParameterType(proto)¶

Bases: MissionDatabaseItem

property array_type: Optional[ArrayType]¶

In case this parameter type is of type array, this returns array-specific type info.

property data_encoding: Optional[DataEncoding]¶

Information on the raw encoding of this parameter type, if applicable.

property enum_values: List[EnumValue]¶

In case this parameter type is of type enumeration, this returns an ordered list of possible values.

property members: List[Member]¶

In case this parameter type is of type aggregate, this returns an ordered list of its direct members.

property type: str¶

Engineering type.

property units: List[str]¶

Engineering unit(s)

class yamcs.client.RangeSet(watch: Optional[Tuple[Optional[float], Optional[float]]] = None, warning: Optional[Tuple[Optional[float], Optional[float]]] = None, distress: Optional[Tuple[Optional[float], Optional[float]]] = None, critical: Optional[Tuple[Optional[float], Optional[float]]] = None, severe: Optional[Tuple[Optional[float], Optional[float]]] = None, min_violations: int = 1)¶

Bases: object

A set of alarm ranges that apply in a specific context.

Parameters:

• watch – Range expressed as a tuple (lo, hi) where lo and hi are assumed exclusive.

• warning – Range expressed as a tuple (lo, hi) where lo and hi are assumed exclusive.

• distress – Range expressed as a tuple (lo, hi) where lo and hi are assumed exclusive.

• critical – Range expressed as a tuple (lo, hi) where lo and hi are assumed exclusive.

• severe – Range expressed as a tuple (lo, hi) where lo and hi are assumed exclusive.

• min_violations – Minimum violations before an alarm is generated.

class yamcs.client.Significance(proto)¶

Bases: object

property consequence_level: str¶

One of NONE, WATCH, WARNING, DISTRESS, CRITICAL or SEVERE.

property reason: Optional[str]¶

Message attached to this significance.

class yamcs.client.SpaceSystem(proto)¶

Bases: MissionDatabaseItem

From XTCE:

A SpaceSystem is a collection of SpaceSystem(s) including space assets, ground assets, multi-satellite systems and sub-systems. A SpaceSystem is the root element for the set of data necessary to monitor and command an arbitrary space device - this includes the binary decomposition of the data streams going into and out of a device.