Source code for elasticai.hw_measurements.template.amp

from os.path import join, dirname, basename
from glob import glob
from time import sleep
from logging import getLogger, Logger
from elasticai.hw_measurements import get_path_to_project, init_project_folder, DriverPort, DriverPortIES
from elasticai.hw_measurements.driver import DriverNGUX01, DriverDMM6500
from elasticai.hw_measurements.charac.amp import CharacterizationAmplifier




class TestHandlerAmplifier:
    _hndl_test: CharacterizationAmplifier
    _hndl_src: DriverNGUX01
    _hndl_daq: DriverDMM6500
    _logger: Logger = getLogger(__name__)
    _en_debug: bool = False
    _file_name: str
    _folder_name: str
    _search_index: str='amp'

    def __init__(self, com_sets: DriverPort=DriverPortIES, en_debug: bool=False, only_plot: bool=False) -> None:
        """Class for handling the test routine of an electronic amplifier stage
        :param com_sets:    Class with COM-Ports of laboratory devices
        :param en_debug:    Boolean for enabling debugging mode (without DAQ system) (default=False)
        :param only_plot:   Boolean for plotting mode (default=False)
        """
        init_project_folder()
        self._hndl_test = CharacterizationAmplifier()
        system_id = int(self._hndl_test.settings.system_id)
        self._file_name = f'{self._hndl_test.settings.get_date_string()}_{self._search_index}_charac_id-{system_id:03d}'
        self._folder_name = join(get_path_to_project(), "runs")

        self._en_debug = en_debug
        if not self._en_debug and not only_plot:
            self._hndl_src = DriverNGUX01()
            self._hndl_src.serial_open_known_target(
                resource_name=com_sets.com_ngu,
                do_reset=True
            )
            self._hndl_src.do_beep()
            sleep(1)

            self._hndl_daq = DriverDMM6500()
            self._hndl_daq.serial_start_known_target(
                resource_name=com_sets.com_dmm,
                do_reset=True
            )
            self._hndl_daq.do_beep()



    def get_overview_folder(self) -> list:
        """Function to get an overview of available numpyz files"""
        return glob(join(self._folder_name, "*.npz"))




    def run_transfer_test(self, chnnl_num: int) -> dict:
        """Function for running the ADC test on DUT device
        :return:            Dictionary with ['stim': DAC input stream, 'settings': Settings, 'ch<X>': DAQ results with 'val' and 'std']
        """
        self._hndl_src.output_activate()
        sleep(0.5)
        results = self._hndl_test.run_test_transfer(
            chnl=chnnl_num,
            func_mux=self._hndl_test.dummy_set_mux,
            func_set_daq=self._hndl_src.set_voltage if not self._en_debug else self._hndl_test.dummy_set_daq,
            func_sens=self._hndl_src.get_measurement_voltage if not self._en_debug else self._hndl_test.dummy_get_daq,
            func_get_daq=self._hndl_daq.get_voltage,
            func_beep=self._hndl_daq.do_beep if not self._en_debug else self._hndl_test.dummy_beep,
        )
        self._hndl_test.save_results(
            file_name=self._file_name,
            data=results,
            settings=self._hndl_test.settings,
            folder_name=self._folder_name,
        )
        self._hndl_src.output_deactivated()
        return results




    def plot_results_from_measurement(self, results: dict) -> None:
        """Function for plotting the ADC test results
        :param results:     Dictionary from measurement
        :return:            None
        """
        self._hndl_test.plot_characteristic_results_direct(
            data=results,
            file_name=self._file_name,
            path=self._folder_name
        )




    def plot_results_from_file(self, path2file: str) -> None:
        """Function for plotting the ADC test results
        :param path2file:   String with path to file
        :return:            None
        """
        if self._search_index in path2file:
            self._hndl_test.plot_characteristic_results_from_file(
                path=dirname(path2file),
                file_name=basename(path2file)
            )





def run_test() -> None:
    bool_only_plot = False
    hndl = TestHandlerAmplifier(
        en_debug=False,
        only_plot=bool_only_plot
    )

    if not bool_only_plot:
        data = hndl.run_transfer_test(0)
        hndl.plot_results_from_measurement(data)
    else:
        for file in hndl.get_overview_folder():
            hndl.plot_results_from_file(file)



if __name__ == "__main__":
    run_test()