Skip to content

Releases: yamcs/python-yamcs-client

yamcs-client 1.9.5

25 Mar 17:04
2462f1e

Choose a tag to compare

  • Add purge_parameter_archive to archive client

yamcs-client 1.9.4

18 Mar 16:27
bd3a303

Choose a tag to compare

  • Add rebuild_ccsds_index to archive client
  • Add run_script to processor client
  • Fix few more typing issues

yamcs-client 1.9.3

05 Mar 18:00
ce33c4a

Choose a tag to compare

  • Everything (excluding generated protobuf classes) can now be imported directly from yamcs.client. Previous imports remain functional, but we'll gradually start recommending to use the shorter import. This was done for ease of use, but also because the current modules are not all under yamcs.client, and we'd like to change that in a future update.
  • Many typing fixes (many more remaining)
  • Added static YamcsClient.from_environment() method which initializes the client from environment properties. The main goal here is to make it easy to instantiate a YamcsClient when used in a Python script ran by the Yamcs Activity Service (the activity service sets the necessary environment variables automatically).
  • Storage: Added capability to set an object's metadata
  • Storage: Add create option to get_bucket()
  • Processing: Add await_first_delivery() to ParameterSubscription. This makes it easier to await an expected value update (for example following a telecommand).
  • Timeline: Add capability to schedule activities (Yamcs v5.9.0+)
  • Timeline: Allow changing the styling of individual items (Yamcs v5.9.0+)

yamcs-client 1.9.2

09 Nov 11:35
fa36940

Choose a tag to compare

  • Add aliases, assignments and all_assignments properties to CommandHistory and IssuedCommand classes.
  • MDB: Temporarily deprecate aliases property of MDB items, in favor of aliases_dict. Eventually aliases will become preferred again, but with a different type (dictionary instead of list of 2-tuples).
  • ArchiveClient: Fix "namespace/alias" syntax not working with list_parameter_values.

yamcs-client 1.9.1

03 Nov 12:18
e400343

Choose a tag to compare

  • Add Python 3.12, drop Python 3.6
  • Bump minimum protobuf version from 3.8 to 3.11
  • Add streaming operations for packets/events/commands
  • Add method to load a large amount of parameter values into Yamcs (via client-streaming)
  • Add method to export parameter values in CSV format
  • Add methods to create Parameters and Parameter Types (in case of a writable space system)

yamcs-client 1.9.0

01 May 12:11
5d298d6

Choose a tag to compare

  • This release introduces the use of Python's typing library for better editor support. Previously, type hints were supplied in method comments.
  • YamcsClient:
    • Add method to delete a processor
  • ProcessorClient:
    • Allow setting sequence number when submitting commands
    • Use non-deprecated API to pass command arguments (the newer API was first introduced in Yamcs v5.5.4)
    • Alarm methods require passing a sequence number (used by Yamcs to validate the correct alarm instance)
    • create_packet_subscription will now default to subscribe to realtime processor, instead of the tm_realtime stream. This capability was first introduced on Yamcs v5.5.x branch.
  • ArchiveClient:
    • Add query option to dump_table
    • Add method to list alarms
  • MdbClient: Add method to export XTCE for a space system
  • FileTransferClient: Fix backwards compatibility around changes to upload options API (reliable, overwrite, createPath).

yamcs-client 1.8.8

17 Mar 09:38
d22f06f

Choose a tag to compare

  • Generate ConnectionFailure exception when login attempt is made and Yamcs is not available (previously this would generate an error coming from the requests dependency)
  • Fix possibility of mutation error when iterating command acknowledgements that are still being updated
  • Add a reconnection example: https://docs.yamcs.org/python-yamcs-client/examples/reconnection/ (#17)

yamcs-client 1.8.7

14 Mar 16:09
94b7b66

Choose a tag to compare

  • Fix WebSocket connections not closed when monitoring file transfers #21
  • FileTransferClient:
    • Add support for remote file listing (requires Yamcs 5.7.10+)
    • upload(...): Arguments reliable, createPath and overwrite should be passed inside the new options argument. For example, replace:
      service.upload("somebucket", "myfile", "/CF:/mytarget", reliable=True)
      with:
      service.upload("somebucket", "myfile", "/CF:/mytarget", options={"reliable": True})
      This change was done to further make FileTransferClient independent of a specific implementation like CFDP.
    • download(...): The order of arguments was changed to allow for object_name to be optional
    • download(...): Arguments overwrite, parents and reliable should be passed inside the new options argument. For example, replace:
      service.download("somebucket", "targetfile", reliable=True)
      service.download("somebucket", "targetfile", options={"reliable": True})
      This change was done to further make FileTransferClient independent of a specific implementation like CFDP.

yamcs-client 1.8.6

21 Feb 21:38
1759428

Choose a tag to compare

  • Add is_failure() to MonitoredCommand instances returned from CommandSubscription.issue(...) (to complement existing is_success()).
  • Make MonitoredCommand.is_complete() always return either True or False. Prior to this release, it was returning None when the completion could not yet be established.
  • Add support for the websocket-client dependency to releases between 0.48.0 and 0.57.0. This range of versions had a breaking change which we did not support until now (although we did support both earlier and later versions). Some LTS Linux distributions still use these versions in their standard repositories, so it made sense to add support.

yamcs-client 1.8.5

21 Oct 14:21
aec1cfd

Choose a tag to compare

  • Fix decode issue with list_items in TimelineClient