Client¶

from yamcs.client import YamcsClient

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

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

get_algorithm(name)¶

Gets a single algorithm by its unique name.

Parameters

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

Return type

Algorithm

get_command(name)¶

Gets a single command by its unique name.

Parameters

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

Return type

Command

get_container(name)¶

Gets a single container by its unique name.

Parameters

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

Return type

Container

get_parameter(name)¶

Gets a single parameter by its name.

Parameters

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

Return type

Parameter

get_space_system(name)¶

Gets a single space system by its unique name.

Parameters

name (str) – A fully-qualified XTCE name

Return type

SpaceSystem

list_algorithms(page_size=None)¶

Lists the algorithms visible to this client.

Algorithms are returned in lexicographical order.

Return type

Algorithm iterator

list_commands(page_size=None)¶

Lists the commands visible to this client.

Commands are returned in lexicographical order.

Return type

Command iterator

list_containers(page_size=None)¶

Lists the containers visible to this client.

Containers are returned in lexicographical order.

Return type

Container iterator

list_parameters(parameter_type=None, page_size=None)¶

Lists the parameters visible to this client.

Parameters are returned in lexicographical order.

Parameters

parameter_type (str) – The type of parameter

Return type

Parameter iterator

list_space_systems(page_size=None)¶

Lists the space systems visible to this client.

Space systems are returned in lexicographical order.

Return type

SpaceSystem iterator