boulderopalscaleup.QctrlScaleUpClient.get_device_summary

*async* QctrlScaleUpClient.get_device_summary(device_name=None)

Retrieve the summary of a device.

Parameters

device_name (str or None , optional) – The device whose summary should be retrieved. Defaults to the current device.

Returns

The summary of the device.

Return type

DeviceSummary

Raises

  • RuntimeError – If the device name is not set.
  • ScaleUpServerError – If the response from the server is invalid.

Was this useful?