upload_to_device#

CommandTableNode.upload_to_device(ct: CommandTable | str | dict, *, validate: bool = False, check_upload: bool = True) → None[source]#

Upload command table into the device.

The command table can either be specified through the dedicated CommandTable class or in a raw format, meaning a json string or json dict. In the case of a json string or dict the command table is validated by default against the schema provided by the device.

Parameters:

  • ct (CommandTable | str | dict) – Command table.

  • validate (bool) – Flag if the command table should be validated. (Only applies if the command table is passed as a raw json string or json dict)

  • check_upload (bool) – Flag if the upload should be validated by calling check_status. This is not mandatory bat strongly recommended since the device does not raise an error when it rejects the command table. This Flag is ignored when called from within a transaction.

Raises:

  • RuntimeError – If the command table upload into the device failed.

  • zhinst.toolkit.exceptions.ValidationError – Incorrect schema.

Return type:

None

Changed in version 0.4.2: New Flag check_upload that makes the upload check optional. check_status is only called when not in a ongoing transaction.