- General Client
- Mission Database
- TM/TC Processing
- Archive
- Link Management
- Object Storage
- File Transfer
- Time Correlation (TCO)
- Timeline
- Examples
Client¶
Note
MDBClient
instances are usually created via
YamcsClient.get_mdb()
:
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.
- get_command(name)¶
Gets a single command by its unique name.
- get_container(name)¶
Gets a single container by its unique name.
- get_parameter(name)¶
Gets a single parameter by its name.
- get_space_system(name)¶
Gets a single space system by its unique name.
- Parameters
name (str) – A fully-qualified XTCE name
- Return type
- 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.
- 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