Client¶

class yamcs.timeline.TimelineClient(ctx, instance)¶

Client for working with Yamcs timeline.

delete_band(band)¶

Delete a band.

Parameters

band (string) – Band identifier.

delete_item(item)¶

Delete an item.

Parameters

item (string) – Item identifier.

delete_view(view)¶

Delete a view.

Parameters

view (string) – View identifier.

get_band(id)¶

Fetch a band by its identifier.

Parameters

id (str) – Band identifier

Return type

Band

get_item(id)¶

Fetch an item by its identifier.

Parameters

id (str) – Item identifier

Return type

Item

get_view(id)¶

Fetch a view by its identifier.

Parameters

id (str) – View identifier

Return type

View

list_bands()¶

List the bands.

Return type

Iterable[Band]

list_items(band=None, start=None, stop=None, page_size=500)¶

List the items.

Parameters

• band (str) – Return only items matching the specified band

• start (datetime) – Minimum stop time of the returned items (exclusive)

• stop (datetime) – Maximum start time of the returned items (exclusive)

• page_size (int) – Page size of underlying requests. Higher values imply less overhead, but risk hitting the maximum message size limit.

Return type

Iterable[Item]

list_views()¶

List the views.

Return type

Iterable[View]

save_band(band)¶

Save or update a band.

Parameters

band (Band) – Band object

save_item(item)¶

Save or update an item.

Parameters

item (Item) – Item object

save_view(view)¶

Save or update a view.

Parameters

view (View) – View object