Python Yamcs Client
- General Client
- Mission Database
- TM/TC Processing
- Archive
- Link Management
- Object Storage
- File Transfer
- Time Correlation (TCO)
- Activities
- Timeline
- Examples
Related
Python Yamcs Client Release Notes
PyPI
Download this Document
Python Yamcs ClientΒΆ
Getting Started
Install Python 3.8 or higher.
Install yamcs-client from PyPI:
pip install --upgrade yamcs-client
For better performance when decoding large or frequent messages (for example
high-rate parameter subscriptions), include the protobuf extra:
pip install --upgrade yamcs-client[protobuf]
This installs the official protobuf runtime, which yamcs-client then uses
instead of its bundled pure-Python copy. Any compatible protobuf package
that is already installed is used automatically, even without this extra.
Usage
Get domain-specific clients:
from yamcs.client import YamcsClient
client = YamcsClient('localhost:8090')
mdb = client.get_mdb(instance='simulator')
# ...
archive = client.get_archive(instance='simulator')
# ...
processor = client.get_processor(instance='simulator', processor='realtime')
# ...
Documentation
Examples