Model¶

class yamcs.client.Band(proto)¶

Bases: ABC

Superclass for bands. Implementations:

TimeRuler
ItemBand
ParameterPlot
ParameterStateBand
Spacer
CommandBand

property band_type: str¶: Type of band.

property description: str¶: Description of this band.

property id: str¶: Band identifier.

property name: str¶: Name of this band.

class yamcs.client.CommandBand(proto=None)¶

Bases: Band

Display issued commands.

class yamcs.client.Item(proto=None)¶

Bases: object

property activity: Optional[Activity]¶: Activity definition.

property background_color: Optional[str]¶: CSS color string.

property border_color: Optional[str]¶: CSS color string.

property border_width: Optional[int]¶

property corner_radius: Optional[int]¶

property duration: timedelta¶: Item duration.

property id: str¶: Item identifier.

property item_type: str¶: Type of item.

property margin_left: Optional[int]¶

property name: str¶: Name of this item.

property start: datetime¶: Item start time.

property tags: List[str]¶: Item tags. Used by bands to filter what is visible.

property text_color: Optional[str]¶: CSS color string.

property text_size: Optional[int]¶

class yamcs.client.ItemBand(proto=None)¶

Bases: Band

Show a selection of timeline items.

property frozen: bool¶: Fix this line to the top of the view. Frozen bands are always rendered above other bands.

property item_background_color: str¶: CSS color string.

property item_border_color: str¶: CSS color string.

property item_border_width: int¶

property item_corner_radius: int¶

property item_height: int¶

property item_margin_left: int¶

property item_text_color: str¶: CSS color string.

property item_text_overflow: str¶: One of show, clip, or hide.

property item_text_size: int¶

property margin_bottom: int¶

property margin_top: int¶

property multiline: bool¶: Draw items on multiple lines if otherwise there would be collisions.

property space_between_items: int¶: In case of multilining, this indicates the minimum horizontal space between items. If an item does not meet this treshold, it gets rendered on a different line.

property space_between_lines: int¶: In case of multilining, this indicates the vertical space between lines.

property tags: List[str]¶: Item tags that this band filters on.

class yamcs.client.ParameterPlot(proto=None)¶

Bases: Band

Plot the values of a numeric parameter.

New in version 1.11.2: Compatible with Yamcs 5.11.2 onwards

property frozen: bool¶: Fix this line to the top of the view. Frozen bands are always rendered above other bands.

property height: int¶: Band height

property maximum: Optional[float]¶: Maximum value to show on Y-axis. Set to None for fitting actual data

property maximum_fraction_digits: int¶: Maximum fraction digits

property minimum: Optional[float]¶: Minimum value to show on Y-axis. Set to None for fitting actual data

property minimum_fraction_digits: int¶: Minimum fraction digits

traces: List[Trace]¶: Plot lines.

property zero_line_color: str¶: Color of the zero line

property zero_line_width: int¶: Thickness of the zero line. 0 is invisible

class yamcs.client.ParameterStateBand(proto=None)¶

Bases: Band

Show state transitions of a parameter

New in version 1.11.2: Compatible with Yamcs 5.11.2 onwards

property frozen: bool¶: Fix this line to the top of the view. Frozen bands are always rendered above other bands.

property height: int¶: Band height

mappings: List[Union[ValueMapping, RangeMapping]]¶: Map engineering values to a label and/or color. Mappings are applied in order.

property parameter: str¶: Qualified parameter name

class yamcs.client.RangeMapping(start: float, end: float, label: Optional[str] = None, color: Optional[str] = None)¶

Bases: object

Maps a value to a label and/or color.

color: Optional[str] = None¶: If specified, show states of this value (or mapped label) in this color

end: float¶: Match engineering value lesser or equal than the provided end value

label: Optional[str] = None¶: If specified, map the provided value to this label

start: float¶: Match engineering value greater or equal than the provided start value

class yamcs.client.Spacer(proto=None)¶

Bases: Band

Insert empty vertical space.

property height: int¶: Spacer height

class yamcs.client.TimeRuler(proto=None)¶

Bases: Band

Displays absolute time, formatted in a timezone of choice.

property timezone: str¶

IANA timezone name.

Corresponds with the third column of the following table: https://data.iana.org/time-zones/data/zone1970.tab

In addition, the name UTC is supported.

class yamcs.client.Trace(parameter: str, line_color: str, visible: bool = True, line_width: int = 1, fill: bool = False, fill_color: str = '#dddddd', min_max: bool = False, min_max_opacity: float = 0.17)¶