Client¶

from yamcs.client import YamcsClient

client = YamcsClient('localhost:8090')
mdb = client.get_mdb(instance='simulator')
# ...

class yamcs.mdb.client.MDBClient(ctx: Context, instance: str)¶

export_space_system(name: str) → str¶

Exports an XTCE description of a space system (XML format).

New in version 1.9.0: Compatible with Yamcs 5.8.0 onwards

Parameters:

name – A fully-qualified XTCE name. Use / for root.

get_algorithm(name: str) → Algorithm¶

Gets a single algorithm by its unique name.

Parameters:

name – Either a fully-qualified XTCE name or an alias in the format NAMESPACE/NAME.

get_command(name: str) → Command¶

Gets a single command by its unique name.

Parameters:

name – Either a fully-qualified XTCE name or an alias in the format NAMESPACE/NAME.

get_container(name: str) → Container¶

Gets a single container by its unique name.

Parameters:

name – Either a fully-qualified XTCE name or an alias in the format NAMESPACE/NAME.

get_parameter(name: str) → Parameter¶

Gets a single parameter by its name.

Parameters:

name – Either a fully-qualified XTCE name or an alias in the format NAMESPACE/NAME.

get_space_system(name: str) → SpaceSystem¶

Gets a single space system by its unique name.

Parameters:

name – A fully-qualified XTCE name. Use / for root.

list_algorithms(page_size: Optional[int] = None) → Iterable[Algorithm]¶

Lists the algorithms visible to this client.

Algorithms are returned in lexicographical order.

list_commands(page_size: Optional[int] = None) → Iterable[Command]¶

Lists the commands visible to this client.

Commands are returned in lexicographical order.

list_containers(page_size: Optional[int] = None) → Iterable[Container]¶

Lists the containers visible to this client.

Containers are returned in lexicographical order.

list_parameters(parameter_type: Optional[str] = None, page_size: Optional[int] = None) → Iterable[Parameter]¶

Lists the parameters visible to this client.

Parameters are returned in lexicographical order.

Parameters:

parameter_type – The type of parameter

list_space_systems(page_size: Optional[int] = None) → Iterable[SpaceSystem]¶

Lists the space systems visible to this client.

Space systems are returned in lexicographical order.