class TMSiSDK.device.tmsi_measurement.TMSiMeasurement(dev, name='TMSi Measurement')

Bases: object

A class to handle all the TMSi Measurements.

__init__(dev, name='TMSi Measurement')

Initialize the measurement.

Parameters:

• dev (TMSiDevice) – Device to measure from.

• name (str, optional) – name of the measurement, defaults to “TMSi Measurement”

Methods

__init__(dev[, name])	Initialize the measurement.
get_conversion_pause()	Get the conversion pause.
get_download_percentage()	Get download percentage.
get_name()	Get the name of the measurement.
get_sampling_pause()	Get the sampling pause.
is_timeout()	Check if the measurement is in timeout.
set_conversion_pause(pause)	Set the conversion thread pause.
set_download_samples_limit([...])	Set the limit to the samples to download.
set_sampling_pause(pause)	Set the sampling thread pause.
start()	Start the measurement.
stop()	Stop the measurement.

get_conversion_pause()

Get the conversion pause.

Returns:

the pause between each loop of the conversion thread.

Return type:

float

get_download_percentage()

Get download percentage.

Returns:

percentage of the download.

Return type:

float

get_name()

Get the name of the measurement.

Returns:

name of the measurement.

Return type:

str

get_sampling_pause()

Get the sampling pause.

Returns:

the pause between each loop of the sampling thread.

Return type:

float

is_timeout()

Check if the measurement is in timeout.

Returns:

True if it is in timeout.

Return type:

bool

set_conversion_pause(pause)

Set the conversion thread pause.

Parameters:

pause (float) – the pause between each loop of the conversion thread.

set_download_samples_limit(max_number_of_samples=None)

Set the limit to the samples to download.

Parameters:

max_number_of_samples (int, optional) – max number of samples to download, defaults to None

set_sampling_pause(pause)

Set the sampling thread pause.

Parameters:

pause (float) – the pause between each loop of the sampling thread.

start()

Start the measurement.

Raises:

NotImplementedError – Must be overridden by the child class.

stop()

Stop the measurement.

Raises:

NotImplementedError – Must be overridden by the child class.