Control Jobs

class AdcStateInfo(self: zahner_link._zahner_link.control.AdcStateInfo)

Object which contains the state of the adc

property active_gain_indexes

list of gain indexes active during measurements

class BeepJob(self: zahner_link._zahner_link.control.BeepJob, frequency: SupportsFloat, duration: SupportsFloat)

Beep job

Parameters:

• frequency – frequency of the beep

• duration – duration of the beep

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "beep",
    "parameters": {
      "frequency": 1000.0,
      "duration": 0.5
    }
  },
  "request_id": "beep-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.control.BeepParametersPy

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 BeepParametersPy

property duration

property frequency

class GetAdcStateJob(self: zahner_link._zahner_link.control.GetAdcStateJob, adc: str)

Get the state of the analog-to-digital converter job.

Parameters:

adc – locator of the ADC like “PAD:1:PAD_U”

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "get_adc_state",
    "parameters": {
      "adc": "PAD:1:PAD_U"
    }
  },
  "request_id": "get-adc-state-job-uuid-example"
}

get_job_result(self: zahner_link._zahner_link.control.GetAdcStateJob) → zahner_link._zahner_link.control.AdcStateInfo

Get the state of the analog-to-digital converter.

Returns:

object with the state

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.control.GetAdcStateParametersPy

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 GetAdcStateParametersPy

property adc

class ReenumerateHardwareJob(self: zahner_link._zahner_link.control.ReenumerateHardwareJob)

Reenumerate hardware job

Reenumerates all connected hardware devices to detect newly connected or disconnected potentiostats like PP2x2 or EL1002. After executing this job, the hardware has to be reconfigured again using the zahner_link.control.SetHardwareSettingsJob.

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "reenumerate_hardware",
    "parameters": {}
  },
  "request_id": "reenumerate-hardware-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

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 GetHardwareInfoJob(self: zahner_link._zahner_link.control.GetHardwareInfoJob)

GetHardwareInfoJob job

This job queries the device tree of the IM7, which contains all signal paths and potentiostats that are available.

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "get_hardware_info",
    "parameters": {}
  },
  "request_id": "get-hardware-info-job-uuid-example"
}

get_job_result(self: zahner_link._zahner_link.control.GetHardwareInfoJob) → zahner_link._zahner_link.HardwareInfo

Get the queried device tree.

Returns:

object with the device tree

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.control.GetHardwareInfoParametersPy

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 GetHardwareInfoParametersPy

class GetHardwareSettingsJob(self: zahner_link._zahner_link.control.GetHardwareSettingsJob)

GetHardwareSettingsJob job

This job queries the current signal path measurement settings. If the uri of a potentiostat contains “nc:” like “nc:33000:POT” means, the configured pot ist not connected/available.

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "get_hardware_settings",
    "parameters": {}
  },
  "request_id": "get-hardware-settings-job-uuid-example"
}

get_job_result(self: zahner_link._zahner_link.control.GetHardwareSettingsJob) → zahner_link._zahner_link.HardwareSettings

Get the queried hardware settings.

Returns:

object with the settings

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.control.GetHardwareSettingsParametersPy

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 GetHardwareSettingsParametersPy

class GetPotentiostatStateJob(self: zahner_link._zahner_link.control.GetPotentiostatStateJob, potentiostat: str)

GetPotentiostatStateJob job

This job queries the status and information for a potentiostat.

Url examples:

• EPC:1:EXT2:POT

• MAIN:1:POT

Urn example:

• 354531:POT

Parameters:

potentiostat – url or urn of the desired potentiostat.

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "get_potentiostat_state",
    "parameters": {
      "potentiostat": "MAIN:1:POT"
    }
  },
  "request_id": "get-potentiostat-state-job-uuid-example"
}

get_job_result(self: zahner_link._zahner_link.control.GetPotentiostatStateJob) → zahner_link._zahner_link.control.PotentiostatState

Get the queried potentiostat state.

Returns:

object with the potentiostat state

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.control.GetPotentiostatStateParametersPy

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 GetPotentiostatStateParametersPy

property potentiostat

class MeasureIntegralJob(self: zahner_link._zahner_link.control.MeasureIntegralJob, channel: str, duration: SupportsFloat = 0.3)

Measurement of a single value

This job can be used to measure a single value from a path or source.

Parameters:

• channel – locator like “MAIN:1:POT:U”, “MAIN:1:POT:I”, or a dimension like “voltage” or “current”

• duration – duration of the measurement

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "measure_integral",
    "parameters": {
      "channel": "MAIN:1:POT:U",
      "duration": 0.3
    }
  },
  "request_id": "measure-integral-job-uuid-example"
}

get_job_result(self: zahner_link._zahner_link.control.MeasureIntegralJob) → float

Get the queried value.

Returns:

the measured value

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.control.MeasureIntegralParametersPy

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 MeasureIntegralParametersPy

property channel

property duration

class PotentiostatState(self: zahner_link._zahner_link.control.PotentiostatState)

property active_bandwidth_indexes

bandwidths which are used for the measurement

property active_current_range_indexes

current ranges which are used for the measurement

property autocompensation_on

state whether the autocompensation is on, usually true

property bandwidth_index

bandwidth range as index

property bias

DC value

property compliance_range_index

compliance range as index

property coupling

current feedback type, such as potentiostatic or galvanostatic

property current_range_index

current range as index

property current_range_integration_time

current range integration time for the ranging process

property current_range_relaxation_time

current range relaxation time for the ranging process

property switched_on

state whether the potentiostat is on

property voltage_range_index

voltage range as index

class SetActiveCurrentRangesJob(self: zahner_link._zahner_link.control.SetActiveCurrentRangesJob, potentiostat: str, indexes: collections.abc.Sequence[SupportsInt] = [])

Set active current ranges job

Parameters:

• potentiostat – url or urn of the desired potentiostat

• indexes – shunt indexes that may be used for the measurement. An empty list for all current ranges available in the hardware.

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "set_active_current_ranges",
    "parameters": {
      "potentiostat": "MAIN:1:POT",
      "indexes": []
    }
  },
  "request_id": "set-active-current-ranges-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.control.SetActiveCurrentRangesParametersPy

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 SetActiveCurrentRangesParametersPy

property indexes

property potentiostat

class SetActiveGainsJob(self: zahner_link._zahner_link.control.SetActiveGainsJob, adc: str, indexes: collections.abc.Sequence[SupportsInt] = [])

Set active gains job

Parameters:

• adc – url or urn of the desired adc

• indexes – gain indexes that may be used for the measurement. An empty list for all gain indexes available in the hardware.

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "set_active_gains",
    "parameters": {
      "adc": "MAIN:1:ADC",
      "indexes": []
    }
  },
  "request_id": "set-active-gains-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.control.SetActiveGainsParametersPy

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 SetActiveGainsParametersPy

property adc

property indexes

class SetCableOptionsJob(self: zahner_link._zahner_link.control.SetCableOptionsJob, potentiostat: str, additional_ce_capacitance: SupportsFloat)

Set cable options job

Sets additional cable options, like the additional CE capacitance (shunt capacitance).

Parameters:

• potentiostat – url or urn of the desired potentiostat

• additional_ce_capacitance – additional capacitance of the CE cable in Farad. For example 95e-12 for 95pF of Shielded Cable Set.

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "set_cable_options",
    "parameters": {
      "potentiostat": "MAIN:1:POT",
      "additional_ce_capacitance": 95e-12
    }
  },
  "request_id": "set-cable-options-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.control.SetCableOptionsParametersPy

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 SetCableOptionsParametersPy

property additional_ce_capacitance

property potentiostat

class SetBiasJob(self: zahner_link._zahner_link.control.SetBiasJob, potentiostat: str, bias: SupportsFloat)

Set bias job

Only the bias is set and possibly ranged. Current or voltage are only measured internally for the ranging.

Parameters:

• potentiostat – url or urn of the desired potentiostat

• bias – value in V or A depending on mode

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "set_bias",
    "parameters": {
      "potentiostat": "MAIN:1:POT",
      "bias": 1.5
    }
  },
  "request_id": "set-bias-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.control.SetBiasParametersPy

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 SetBiasParametersPy

property bias

property potentiostat

class SetHardwareSettingsJob(*args, **kwargs)

Overloaded function.

1. __init__(self: zahner_link._zahner_link.control.SetHardwareSettingsJob, settings: zahner_link.control.SetHardwareSettingsParametersPy) -> None

   Set hardware settings for sampling job.

   Only the necessary channels should be measured, not simply all of them. As the sampling rate decreases slightly with each channel, less averaging can be performed.

   This class should be used in combination with the zahner_link.HardwareSettingsHelper class.

   param settings:

   object with the settings

   WebSocket JSON Example

   {
     "do": "/job/start",
     "job": {
       "type": "set_hardware_settings",
       "parameters": {
         "output_potentiostats": [
             {
                 "uri": "MAIN:1:POT",
                 "potentiostatic_polynomial": [
                     0E0,
                     1E0
                 ],
                 "galvanostatic_polynomial": [
                     0E0,
                     1E0
                 ]
             }
         ],
         "channels": [
             {
                 "uri": "MAIN:1:POT:U~PAD:1:PAD_U",
                 "dimension": "voltage",
                 "unit": "V",
                 "polynomial": [
                     0E0,
                     1E0
                 ]
             },
             {
                 "uri": "MAIN:1:POT:I~PAD:1:PAD_I",
                 "dimension": "current",
                 "unit": "A",
                 "polynomial": [
                     0E0,
                     1E0
                 ]
             }
         ],
         "impedance_configurations": [
             {
             "numerator": "MAIN:1:POT:U~PAD:1:PAD_U",
             "denominator": "MAIN:1:POT:I~PAD:1:PAD_I"
             }
         ]
       }
     },
     "request_id": "set-hardware-settings-job-uuid-example"
   }
   

2. __init__(self: zahner_link._zahner_link.control.SetHardwareSettingsJob, channels: collections.abc.Sequence[zahner_link._zahner_link.Channel], impedance_configurations: collections.abc.Sequence[zahner_link._zahner_link.ImpedanceConfiguration], output_potentiostats: collections.abc.Sequence[zahner_link._zahner_link.PotentiostatConfiguration]) -> None

   Set hardware settings for sampling job.

   Only the necessary channels should be measured, not simply all of them. As the sampling rate decreases slightly with each channel, less averaging can be performed.

   This class should be used in combination with the zahner_link.HardwareSettingsHelper class.

   param channels:

   • channels to be measured during the measurement

   • sequential and parallel channels together these are automatically split

   param impedance_configurations:

   • parallel sampled channels

   • as a list of lists from which impedances are calculated

   • in the sub list, the first element (index 0) divided by the second element (index 1) is used for the impedance calculation

   param output_potentiostats:

   potentiostat on which the measurement is to be output

3. __init__(self: zahner_link._zahner_link.control.SetHardwareSettingsJob, channels: collections.abc.Sequence[zahner_link._zahner_link.Channel], impedance_configurations: collections.abc.Sequence[zahner_link._zahner_link.ImpedanceConfiguration], output_potentiostats: collections.abc.Sequence[str]) -> None

   Set hardware settings for sampling job.

   Only the necessary channels should be measured, not simply all of them. As the sampling rate decreases slightly with each channel, less averaging can be performed.

   This class should be used in combination with the zahner_link.HardwareSettingsHelper class.

   param channels:

   • channels to be measured during the measurement

   • sequential and parallel channels together these are automatically split

   param impedance_configurations:

   • parallel sampled channels

   • as a list of lists from which impedances are calculated

   • in the sub list, the first element (index 0) divided by the second element (index 1) is used for the impedance calculation

   param output_potentiostats:

   potentiostat on which the measurement is to be output

4. __init__(self: zahner_link._zahner_link.control.SetHardwareSettingsJob, config: zahner_link._zahner_link.UserHardwareSettings) -> None

   Set hardware settings for sampling job.

   The zahner_link.HardwareSettingsHelper class returns a zahner_link.UserHardwareSettings object, which can be passed to this class.

   param config:

   object with the settings

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.control.SetHardwareSettingsParametersPy

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 SetHardwareSettingsParametersPy

property channels

property impedance_configurations

property output_potentiostats

class SetLedColorJob(*args, **kwargs)

Overloaded function.

1. __init__(self: zahner_link._zahner_link.control.SetLedColorJob, red: typing.SupportsInt, green: typing.SupportsInt, blue: typing.SupportsInt) -> None

   Set LED Colors using red green and blue values

   Only the color of the lower RGB LED can be set.

   param red:

   red value from 0 to 255

   param green:

   green value from 0 to 255

   param blue:

   blue value from 0 to 255

   WebSocket JSON Example

   {
     "do": "/job/start",
     "job": {
       "type": "set_led_color",
       "parameters": {
         "red": 255,
         "green": 128,
         "blue": 0
       }
     },
     "request_id": "set-led-color-job-uuid-example"
   }
   

2. __init__(self: zahner_link._zahner_link.control.SetLedColorJob, led: typing.SupportsInt) -> None

   Set LED Color using integer color values

   Color examples: - 0xFF0000 for red - 0x00FF00 for green - 0x0000FF for blue

   param led:

   integer color value for lower LED

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.control.SetLedColorParametersPy

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 SetLedColorParametersPy

property blue

property green

property red

class SleepJob(self: zahner_link._zahner_link.control.SleepJob, duration: SupportsFloat)

Sleep job

Parameters:

duration – duration of the sleep in seconds

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "sleep",
    "parameters": {
      "duration": 2.0
    }
  },
  "request_id": "sleep-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.control.SleepParametersPy

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 SleepParametersPy

property duration

class SwitchAllOffJob(self: zahner_link._zahner_link.control.SwitchAllOffJob)

Switch all potentiostats off job

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "switch_all_off",
    "parameters": {}
  },
  "request_id": "switch-all-off-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

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 SwitchOffJob(self: zahner_link._zahner_link.control.SwitchOffJob, potentiostat: str)

Switch off job

Parameters:

potentiostat – url or urn of the desired potentiostat

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "switch_off",
    "parameters": {
      "potentiostat": "MAIN:1:POT"
    }
  },
  "request_id": "switch-off-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.control.SwitchOffParametersPy

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 SwitchOffParametersPy

property potentiostat

class SwitchOnJob(self: zahner_link._zahner_link.control.SwitchOnJob, potentiostat: str, coupling: zahner_link._zahner_link.PotentiostatCoupling, bias: SupportsFloat, voltage_range_index: SupportsInt = 0, compliance_range_index: SupportsInt = 0)

Switch on job with checks.

This switch on job checks whether the setpoint has been set correctly and whether the voltages and currents are within the range of the potentiometer, which means that the switch-on process is longer. If the setpoint cannot be switched on correctly, it is switched off again immediately.

If the potentiostat was switched on in potentiostatic mode, all primitives are executed in potentiostatic mode. If it was switched on in galvanostatic mode, all primitives are executed in galvanostatic mode. In cyclic voltammetry, for example, all passed values, such as the reverse vertex values, are currents in galvanostatic mode.

There are only a few methods that require an explicit operating mode and cannot be performed galvanostatically or potentiostatically.

When FRA_PROBE mode is activated, the potentiostat is switched to internal feedback and nothing other than an FRA probe or FRA-X may be connected to the device. In FRA mode, the potentiostatic_polynomial of the MAIN potentiostat must be set to the appropriate gain and offset values for the external source or sink to be controlled.

Url examples:

• EPC:1:EXT2:POT

• MAIN:1:POT

Urn example:

• 354531:POT

Parameters:

• potentiostat – url or urn of the desired potentiostat

• coupling – coupling how the potentiostat is operated potentiostatically or galvanostatically

• bias – DC value

• voltage_range_index – voltage range as index with which to switch on

• compliance_range_index – compliance range as index with which to switch on

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "switch_on",
    "parameters": {
      "potentiostat": "MAIN:1:POT",
      "coupling": "POTENTIOSTATIC",
      "bias": 1.5,
      "voltage_range_index": 2,
      "compliance_range_index": 1
    }
  },
  "request_id": "switch-on-job-uuid-example"
}

get_job_result(self: zahner_link._zahner_link.control.SwitchOnJob) → zahner_link._zahner_link.SwitchOnInfo

Get the result of the switch on.

Returns an object with the applied bias scaled with the configured polynomial with the zahner_link.control.SetHardwareSettingsJob. It also contains the output values of voltage and current of the potentiostat without polynomials.

Returns:

object with the values

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.control.SwitchOnParametersPy

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 SwitchOnParametersPy

property bias

property compliance_range_index

property coupling

property potentiostat

property voltage_range_index

class SwitchOnInfo

property applied_bias

bias that was actually applied

property current

output current of the potentiostat

property voltage

output voltage of the potentiostat

class SwitchOnQuickJob(self: zahner_link._zahner_link.control.SwitchOnQuickJob, potentiostat: str, coupling: zahner_link._zahner_link.PotentiostatCoupling, bias: SupportsFloat, voltage_range_index: SupportsInt = 0, compliance_range_index: SupportsInt = 0)

Switch on quick job

This job does not check whether the potentiostat was switched on at the desired value. The user can then decide flexibly how to proceed after switching on.

If the potentiostat was switched on in potentiostatic mode, all primitives are executed in potentiostatic mode. If it was switched on in galvanostatic mode, all primitives are executed in galvanostatic mode. In cyclic voltammetry, for example, all passed values, such as the reverse vertex values, are currents in galvanostatic mode.

There are only a few methods that require an explicit operating mode and cannot be performed galvanostatically or potentiostatically.

When FRA_PROBE mode is activated, the potentiostat is switched to internal feedback and nothing other than an FRA probe or FRA-X may be connected to the device. In FRA mode, the potentiostatic_polynomial of the MAIN potentiostat must be set to the appropriate gain and offset values for the external source or sink to be controlled.

Url examples:

• EPC:1:EXT2:POT

• MAIN:1:POT

Urn example:

• 354531:POT

Parameters:

• potentiostat – url or urn of the desired potentiostat

• coupling – coupling how the potentiostat is operated potentiostatically or galvanostatically

• bias – DC value

• voltage_range_index – voltage range as index with which to switch on

• compliance_range_index – compliance range as index with which to switch on

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "switch_on_quick",
    "parameters": {
      "potentiostat": "MAIN:1:POT",
      "coupling": "POTENTIOSTATIC",
      "bias": 1.5,
      "voltage_range_index": 2,
      "compliance_range_index": 1
    }
  },
  "request_id": "switch-on-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.control.SwitchOnQuickParametersPy

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 SwitchOnQuickParametersPy

property bias

property compliance_range_index

property coupling

property potentiostat

property voltage_range_index

class SetHardwarePropertyJob(self: zahner_link._zahner_link.control.SetHardwarePropertyJob, uri: str, key: str, value: bool | SupportsInt | SupportsFloat | str)

Set hardware property job

For setting a hardware property on a device like RMUX or MIO channels.

Parameters:

• uri – URI of the hardware device, e.g., MIO:1

• key – Property key to set, e.g., “DIGITAL_OUT”

• value – Value to set, can be bool, int, double, or string

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "set_hardware_property",
    "parameters": {
      "uri": "MIO:1",
      "key": "DIGITAL_OUT",
      "value": 3
    }
  },
  "request_id": "set-hardware-property-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.control.SetHardwarePropertyParametersPy

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 SetHardwarePropertyParametersPy

property key

property uri

property value

class GetHardwarePropertyJob(self: zahner_link._zahner_link.control.GetHardwarePropertyJob, channel: str, duration: str = 0.3)

Get hardware property job

For getting a hardware property on a device like RMUX or MIO channels.

Parameters:

• uri – URI of the hardware device, e.g., MIO:1

• key – Property key to set, e.g., “DIGITAL_OUT”

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "get_hardware_property",
    "parameters": {
      "uri": "MIO:1",
      "key": "DIGITAL_OUT"
    }
  },
  "request_id": "get-hardware-property-job-uuid-example"
}

get_job_result(self: zahner_link._zahner_link.control.GetHardwarePropertyJob) → bool | int | float | str

Get the queried value.

Returns:

the measured value

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.control.GetHardwarePropertyParametersPy

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 GetHardwarePropertyParametersPy

property key

property uri

class InitializeRtcJob(self: zahner_link._zahner_link.control.InitializeRtcJob)

Initialize Rtc Job

This job initializes the real-time clock (RTC) of the IM7, must be performed after replacing the CPU battery.

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "initialize_rtc",
    "parameters": {}
  },
  "request_id": "initialize-rtc-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

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 SetDateTimeJob(self: zahner_link._zahner_link.control.SetDateTimeJob, datetime: str)

SetDateTimeJob job

Sets the date and time on the device.

Parameters:

datetime – date and time string to set on the device, in ISO 8601 format (e.g., “2025-01-01T00:00:00”, YYYY-MM-DDTHH:MM:SS)

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "set_date_time",
    "parameters": {
      "datetime": "2025-01-01T00:00:00"
    }
  },
  "request_id": "set-date-time-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.control.SetDateTimeParametersPy

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 SetDateTimeParametersPy

property datetime

class GetDateTimeJob(self: zahner_link._zahner_link.control.GetDateTimeJob)

GetDateTimeJob job

Queries the current date and time from the device.

WebSocket JSON Example

{
  "do": "/job/start",
  "job": {
    "type": "get_date_time",
    "parameters": {}
  },
  "request_id": "get-date-time-job-uuid-example"
}

get_job_result(self: zahner_link._zahner_link.control.GetDateTimeJob) → str

Get the queried date and time.

Returns:

string with the date and time in ISO 8601 format (e.g., “2025-01-01T00:00:00”, YYYY-MM-DDTHH:MM:SS)

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.control.GetDateTimeParametersPy

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 GetDateTimeParametersPy