Calibration Jobs

class CalibrateJob(*args, **kwargs)

Overloaded function.

1. __init__(self: zahner_link._zahner_link.calibration.CalibrateJob, calibration_type: str = ‘dc’, calibration_path: str = ‘’, indexes: collections.abc.Sequence[typing.SupportsInt] = [], paths: collections.abc.Sequence[str] = []) -> None

   Calibrate job

   This job starts a calibration of the passed type.

   param calibration_type:

   calibration type, only “dc” available

2. __init__(self: zahner_link._zahner_link.calibration.CalibrateJob, calibration_type: zahner_link._zahner_link.CalibrationTypesEnum = <CalibrationTypesEnum.DC: 2>, calibration_path: str = ‘’, indexes: collections.abc.Sequence[typing.SupportsInt] = [], paths: collections.abc.Sequence[str] = []) -> None

   Calibrate job

   This job starts a calibration of the passed type.

   param calibration_type:

   calibration type, only CalibrationTypesEnum.DC available

   WebSocket JSON Example

   {
     "do": "/job/start",
     "job": {
       "type": "calibrate",
       "parameters": {
         "calibration_type": "dc"
       }
     },
     "request_id": "calibrate-job-uuid-example"
   }
   

get_last_job_error_message(self: zahner_link._zahner_link.AbstractMeasurementJob) → str

Get the last job error message when failing.

The job must have been previously executed using methods such as zahner_link.ZahnerLink.do_job() or zahner_link.ZahnerLink.do_measurement().

Returns:

string containing the error message or empty string

get_last_job_info(self: zahner_link._zahner_link.AbstractMeasurementJob) → zahner_link._zahner_link.JobInfo

Get the info of the last job.

The job must have been previously executed using methods such as zahner_link.ZahnerLink.do_job() or zahner_link.ZahnerLink.do_measurement().

Returns:

object with the job info

get_last_job_status(self: zahner_link._zahner_link.AbstractMeasurementJob) → zahner_link._zahner_link.JobStatusEnum

Get status of the last job.

The job must have been previously executed using methods such as zahner_link.ZahnerLink.do_job() or zahner_link.ZahnerLink.do_measurement().

Returns:

object with the job status

property parameters

object with the parameters that were passed to the constructor of type zahner_link.calibration.CalibrateParameters

was_successful(self: zahner_link._zahner_link.AbstractMeasurementJob) → bool

Get status if the last job was successful.

The job must have been previously executed using methods such as zahner_link.ZahnerLink.do_job() or zahner_link.ZahnerLink.do_measurement().

Returns:

True if job was successful

class CalibrateParametersPy

property calibration_path

property calibration_type

property indexes

class CalibrateParametersStringPy

property calibration_path

property calibration_type

property indexes