PTW UNIDOS Tango/Romeo dosemeters

class pymeasure.instruments.ptw.ptwUNIDOS(adapter, name='PTW UNIDOS dosemeter', **kwargs)

Bases: Instrument

A class representing the PTW UNIDOS Tango/Romeo dosemeters.

property autoreset_enabled: Any

Control the measurement autoreset function (bool).

property autostart_enabled: Any

Control the measurement autostart function (bool).

property autostart_level: Any

Control the threshold level of autostart measurements (str, strictly LOW, MEDIUM or HIGH).

check_set_errors()

Check for errors after sending a command.

Return type:

list[str]

clear()

Clear the complete measurement history.

Note

Write permission is required.

Return type:

None

property electrical_units_enabled: Any

Control whether electrical units are used (bool).

errorflags_to_text(flags)

Convert the error flags to the error message(s).

Parameters:

flags (str)

Return type:

list[str]

hold()

Set the measurment to HOLD state.

Note

Write permission is required.

Return type:

None

property id: Any

Get the dosemeter ID (list[str]).

property integration_time: Any

Control the time of the interval measurement in seconds (int, strictly from 1 to 3599999).

interval_measurement(interval=None)

Execute an interval measurement.

Parameters:

interval (int | None) – optional, measurement interval in seconds (default: None)

Return type:

None

If interval is not specified a measurement with the current setting of the integration_time is executed.

Note

Write permission is required.

intervall(intervall=None)

Execute an interval measurement.

Deprecated since version 0.16.0: Use interval_measurement() instead.

Return type:

None

property lan_config: Any

Get the ethernet configuration (dict).

Dict keys:

dns, ipv4, ipv6

property mac_address: Any

Get the dosemeter MAC address (str).

measure()

Start the dose or charge measurement.

Note

Write permission is required.

Return type:

None

property measurement_history: Any

Get the measurement history (list[dict]).

Dict keys:

date, detector, dose, flags, id, kTotal

property measurement_parameters: Any

Get the measurement parameters (dict).

Dict keys:

correction, detectorGuid, highResolution, hv, integrationTime, isElectrical, limitDose, limitDoseEnabled, limitDoseRate, limitDoseRateEnabled, range, triggerAuto, triggerReset, triggerSensitivity

property measurement_result: Any

Get the measurement results (dict).

Dict keys:

status, charge, dose, current, doserate, timebase, time, voltage, error

property range: Any

Control the measurement range (str, strictly VERY_LOW, LOW, MEDIUM or HIGH).

property range_max: Any

Get the max value of the current measurement range (dict).

Dict keys:

range, current, doserate, timebase

property range_res: Any

Get the resolution of the measurement range (dict).

Dict keys:

range, charge, dose, current, doserate, timebase

read()

Read the device response and check for errors.

Returns:

str – Read string with semicolons replaced by comma

Raises:

ValueError for error response or ConnectionError for an unknown error

read_detector(guid='ALL')

Read the properties of the requested detector.

Parameters:

guid (str) – optional, ID of the detector. A list of all detectors is returned if guid is not passed. (default: 'ALL')

Type:

dict or list[dict]

Dict keys:

calibrationFactor, calibrationFactorUnit, calibrationLab, calibrationProcedure, calibrationTemp, calibrationType, calibrationUser, comment, guid, manufacturer, maxHv, measuredQuantity, minHv, name, nominalHv, polarity, radiationQuality, range, serialNumber, testDate, testLimits, testResult, testTarget, timebase, type, typeNumber

Return type:

dict | list[dict]

reset()

Reset the dose and charge measurement values.

Note

Write permission is required.

Return type:

None

selftest()

Execute the electrometer selftest.

The function returns before the end of the selftest. End and result of the self test have to be requested by the selftest_result property.

Note

Write permission is required.

Return type:

None

property selftest_result: Any

Get the dosemeter selftest status and result (dict).

Dict keys:

status, time_remaining, time_total, low, medium, high

property serial_number: Any

Get the dosemeter serial number (int).

property status: Any

Get the measurement status (str).

The status string has of one of the following values: RES, MEAS, HOLD, INT, INTHLD, ZERO, AUTO, AUTO_MEAS, AUTO_HOLD, EOM, WAIT, INIT, ERROR, SELF_TEST or TST

property system_info: Any

Get the system information (dict).

Dict keys:

calibrationDate, debugBuild, features, hardwareVersion, hostname, lastTest, macAddress, nextCalibration, serialNumber, softwareVersion, testTemperature, typeNumber

property system_settings: Any

Get the system settings (dict).

Dict keys:

brightness, date, keyboardSound, locale, mark, startAsMaster, time, timezone, volume

property tfi: Any

Get the telegram failure information (str).

The property provides information about the last failed command with HTTP request.

property voltage: Any

Control the detector voltage in Volts (int, strictly from -400 to 400)

The Limits of the detector are applied.

property wlan_config: Any

Get the WLAN access point configuration (dict).

Dict keys:

enabled, ssid

property write_enabled: Any

Control the write permission (bool).

The result of the request/release has to be checked afterwards.

Important

The UNIDOS has to be in viewer mode (closed lock symbol on the display).

zero()

Execute a zero correction measurement.

The function returns before the end of the zero correction measurement. The end of the zero correction measurement has to be requested by the zero_status property.

Note

Write permission is required.

Return type:

None

property zero_status: Any

Get the status of the zero correction measurement (dict).

Dict keys:

status, time_remaining, time_total