functions.py

"""
Module containing helper functions and functions that write messages to the sourcemeter device
"""
import os
import time


def staircase_lin(
    instrument,
    current_compliance,
    source_voltage,
    source_delay,
    source_voltage_start,
    source_voltage_stop,
    source_voltage_step,
    source_voltage_neg,
    neg_step,
    trig_count,
    trig_count_neg,
    accuracy
):
    """
    Instructions to be sent to the sourcemeter
    Returns a string containing all the data received from sourcemeter
    """
    # UP
    instrument.timeout = 100000
    instrument.write("SYST:REM")
    instrument.write("*RST")
    instrument.write(":SYST:BEEP:STAT 0")
    instrument.write(f":SENS:VOLT:NPLC {accuracy}")
    instrument.write(f":SENS:CURR:PROT {current_compliance}")
    instrument.write(f":SOUR:VOLT {source_voltage}")
    instrument.write(f":SOUR:DEL {source_delay}")
    instrument.write(":SOUR:SWE:RANG BEST")
    instrument.write(":SOUR:VOLT:MODE SWE")
    instrument.write(":SOUR:SWE:SPAC LIN")
    instrument.write(f":SOUR:VOLT:STAR {source_voltage_start}")
    instrument.write(f":SOUR:VOLT:STOP {source_voltage_stop}")
    instrument.write(f":SOUR:VOLT:STEP {source_voltage_step}")
    instrument.write(f":TRIG:COUN {trig_count}")
    instrument.write(":OUTP ON")
    measure = instrument.query(":READ?")[:-1]
    # DOWN
    instrument.write(f":SENS:VOLT:NPLC {accuracy}")
    instrument.write(f":SENS:CURR:PROT {current_compliance}")
    instrument.write(f":SOUR:VOLT {source_voltage_stop}")
    instrument.write(f":SOUR:DEL {source_delay}")
    instrument.write(":SOUR:SWE:RANG BEST")
    instrument.write(":SOUR:VOLT:MODE SWE")
    instrument.write(":SOUR:SWE:SPAC LIN")
    instrument.write(f":SOUR:VOLT:STAR {source_voltage_stop}")
    instrument.write(f":SOUR:VOLT:STOP {source_voltage_start}")
    instrument.write(f":SOUR:VOLT:STEP {source_voltage_step*-1}")
    instrument.write(f":TRIG:COUN {trig_count}")
    instrument.write(":OUTP ON")
    measure_down = instrument.query(":READ?")[:-1]
    measure = measure + "," + measure_down
    # ZERO
    instrument.write(f":SENS:VOLT:NPLC {accuracy}")
    instrument.write(f":SENS:CURR:PROT {current_compliance}")
    instrument.write(":SOUR:VOLT 0")
    instrument.write(":SOUR:DEL 0")
    instrument.write(":SOUR:SWE:RANG BEST")
    instrument.write(":SOUR:VOLT:MODE LIST")
    instrument.write(":SOUR:LIST:VOLT 0, 0")
    instrument.write(":TRIG:COUN 2")
    # UP
    instrument.write("*RST")
    instrument.write(":SYST:BEEP:STAT 0")
    instrument.write(f":SENS:VOLT:NPLC {accuracy}")
    instrument.write(f":SENS:CURR:PROT {current_compliance}")
    instrument.write(f":SOUR:VOLT {source_voltage}")
    instrument.write(f":SOUR:DEL {source_delay}")
    instrument.write(":SOUR:SWE:RANG BEST")
    instrument.write(":SOUR:VOLT:MODE SWE")
    instrument.write(":SOUR:SWE:SPAC LIN")
    instrument.write(f":SOUR:VOLT:STAR {source_voltage_start}")
    instrument.write(f":SOUR:VOLT:STOP {source_voltage_neg}")
    instrument.write(f":SOUR:VOLT:STEP {neg_step}")
    instrument.write(f":TRIG:COUN {trig_count_neg-1}")
    instrument.write(":OUTP ON")
    measure_down_again = instrument.query(":READ?")[:-1]
    measure = measure + "," + measure_down_again

    instrument.write(f":SENS:VOLT:NPLC {accuracy}")
    instrument.write(f":SENS:CURR:PROT {current_compliance}")
    instrument.write(f":SOUR:VOLT {source_voltage_neg}")
    instrument.write(f":SOUR:DEL {source_delay}")
    instrument.write(":SOUR:SWE:RANG BEST")
    instrument.write(":SOUR:VOLT:MODE SWE")
    instrument.write(":SOUR:SWE:SPAC LIN")
    instrument.write(f":SOUR:VOLT:STAR {source_voltage_neg}")
    instrument.write(f":SOUR:VOLT:STOP {source_voltage_start}")
    instrument.write(f":SOUR:VOLT:STEP {abs(neg_step)}")
    instrument.write(f":TRIG:COUN {trig_count_neg+1}")
    instrument.write(":OUTP ON")
    measure_up = instrument.query(":READ?")[:-1]
    measure = measure + "," + measure_up
    return measure


# Logarithmic Staircase
# When working with log source voltage cannot be 0


def staircase_log(
    instrument,
    current_compliance,
    source_voltage,
    source_delay,
    source_voltage_start,
    source_voltage_stop,
    log_num_steps,
    trig_count,
    is_up_down = True
):
    """
    Instructions to be sent to the sourcemeter
    Returns a string containing all the data received from sourcemeter
    """
    instrument.timeout = 10000
    instrument.write("SYST:REM")
    instrument.write("*RST")
    instrument.write(":SENS:VOLT:NPLC 10")
    instrument.write(f":SENS:CURR:PROT {current_compliance}")
    instrument.write(f":SOUR:VOLT {source_voltage}")
    instrument.write(f":SOUR:DEL {source_delay}")
    instrument.write(":SOUR:SWE:RANG BEST")
    instrument.write(":SOUR:VOLT:MODE SWE")
    instrument.write(":SOUR:SWE:SPAC LOG")
    instrument.write(f":SOUR:VOLT:STAR {source_voltage_start}")
    instrument.write(f":SOUR:VOLT:STOP {source_voltage_stop}")
    instrument.write(f":SOUR:SWE:POIN {log_num_steps}")
    instrument.write(f":TRIG:COUN {trig_count}")
    instrument.write(":OUTP ON")
    measure = instrument.query(":READ?")[:-1]

    if is_up_down:
        instrument.write(":SENS:VOLT:NPLC 0.1")
        instrument.write(f":SENS:CURR:PROT {current_compliance}")
        instrument.write(f":SOUR:VOLT {source_voltage_stop}")
        instrument.write(f":SOUR:DEL {source_delay}")
        instrument.write(":SOUR:SWE:RANG BEST")
        instrument.write(":SOUR:VOLT:MODE SWE")
        instrument.write(":SOUR:SWE:SPAC LOG")
        instrument.write(f":SOUR:VOLT:STAR {source_voltage_stop}")
        instrument.write(f":SOUR:VOLT:STOP {source_voltage_start}")
        instrument.write(f":SOUR:SWE:POIN {log_num_steps}")
        instrument.write(f":TRIG:COUN {trig_count}")
        instrument.write(":OUTP ON")
        measure_down = instrument.query(":READ?")
        measure = measure + "," + measure_down[:-1]
    return measure

def staircase_forming(
    instrument,
    current_compliance,
    source_voltage,
    source_delay,
    source_voltage_start,
    source_voltage_stop,
    source_voltage_step,
    trig_count,
    accuracy
):
    """
    Instructions to be sent to the sourcemeter
    Returns a string containing all the data received from sourcemeter
    """
    # UP
    instrument.timeout = 100000
    instrument.write("SYST:REM")
    instrument.write("*RST")
    instrument.write(":SYST:BEEP:STAT 0")
    instrument.write(f":SENS:VOLT:NPLC {accuracy}")
    instrument.write(f":SENS:CURR:PROT {current_compliance}")
    instrument.write(f":SOUR:VOLT {source_voltage}")
    instrument.write(f":SOUR:DEL {source_delay}")
    instrument.write(":SOUR:SWE:RANG BEST")
    instrument.write(":SOUR:VOLT:MODE SWE")
    instrument.write(":SOUR:SWE:SPAC LIN")
    instrument.write(f":SOUR:VOLT:STAR {source_voltage_start}")
    instrument.write(f":SOUR:VOLT:STOP {source_voltage_stop}")
    instrument.write(f":SOUR:VOLT:STEP {source_voltage_step}")
    instrument.write(f":TRIG:COUN {trig_count}")
    instrument.write(":OUTP ON")
    measure = instrument.query(":READ?")[:-1]
    # DOWN
    instrument.write(f":SENS:VOLT:NPLC {accuracy}")
    instrument.write(f":SENS:CURR:PROT {current_compliance}")
    instrument.write(f":SOUR:VOLT {source_voltage_stop}")
    instrument.write(f":SOUR:DEL {source_delay}")
    instrument.write(":SOUR:SWE:RANG BEST")
    instrument.write(":SOUR:VOLT:MODE SWE")
    instrument.write(":SOUR:SWE:SPAC LIN")
    instrument.write(f":SOUR:VOLT:STAR {source_voltage_stop}")
    instrument.write(f":SOUR:VOLT:STOP {source_voltage_start}")
    instrument.write(f":SOUR:VOLT:STEP {source_voltage_step*-1}")
    instrument.write(f":TRIG:COUN {trig_count+1}")
    instrument.write(":OUTP ON")
    measure_down = instrument.query(":READ?")[:-1]
    measure = measure + "," + measure_down
    return measure

def endurance_test(
    instrument,
    accuracy,
    current_compliance,
    source_voltage,
    source_delay,
    voltage_list,
    list_length,
    ):
    """
    Instructions to be sent to the sourcemeter
    Returns a string containing all the data received from sourcemeter
    """
    instrument.timeout = 10000
    instrument.write("SYST:REM")
    instrument.write("*RST")
    instrument.write(":SYST:BEEP:STAT 0")
    instrument.write(f":SENS:VOLT:NPLC {accuracy}")
    instrument.write(f":SENS:CURR:PROT {current_compliance}")
    instrument.write(f":SOUR:VOLT {source_voltage}")
    instrument.write(f":SOUR:DEL {source_delay}")
    instrument.write(":SOUR:SWE:RANG BEST")
    instrument.write(":SOUR:VOLT:MODE LIST")
    instrument.write(f":SOUR:LIST:VOLT {voltage_list}")
    instrument.write(f":TRIG:COUN {list_length}")
    instrument.write(":OUTP ON")
    measure = (instrument.query(":READ?"))[:-1]
    return measure


def read_test(
    instrument,
    accuracy,
    current_compliance,
    source_voltage,
    source_delay,
    voltage_list,
    list_length,
    ):
    """ 
    Instructions to be sent to the sourcemeter
    Returns a string containing all the data received from sourcemeter
    """
    instrument.timeout = 10000
    instrument.write("SYST:REM")
    instrument.write("*RST")
    instrument.write(":SYST:BEEP:STAT 0")
    instrument.write(f":SENS:VOLT:NPLC {accuracy}")
    instrument.write(f":SENS:CURR:PROT {current_compliance}")
    instrument.write(f":SOUR:VOLT {source_voltage}")
    instrument.write(f":SOUR:DEL {source_delay}")
    instrument.write(":SOUR:SWE:RANG BEST")
    instrument.write(":SOUR:VOLT:MODE LIST")
    instrument.write(f":SOUR:LIST:VOLT {voltage_list}")
    instrument.write(f":TRIG:COUN {list_length}")
    instrument.write(":OUTP ON")
    measure = (instrument.query(":READ?"))[:-1]
    return measure

def create_voltage_list(set_voltage, read_voltage, reset_voltage):
    """
    creates the list of voltages for 5 cycles of the endurance test
    """
    voltage = []
    for _ in range(1, 6):
        voltage.append(set_voltage)
        voltage.append(0)
        voltage.append(read_voltage)
        voltage.append(0)
        voltage.append(reset_voltage)
        voltage.append(0)
        voltage.append(read_voltage)
        voltage.append(0)
    volt_string = ", ".join(str(item) for item in voltage)
    return volt_string

def create_read_voltage_list(read_voltage):
    voltage  =[]
    voltage.append(read_voltage)
    voltage.append(0)
    volt_string = ", ".join(str(item) for item in voltage)
    return volt_string

def calc_trig_count(
    source_voltage_stop,
    source_voltage_start,
    source_voltage_step,
    log_num_steps,
    iv_space,
):
    """
    Calculates the trigger count for different iv tests
    """
    if iv_space == "LIN":
        trig_count = (source_voltage_stop - source_voltage_start) / source_voltage_step
    elif iv_space == "LOG":
        trig_count = log_num_steps
    return trig_count


def create_test_folder(test):
    """
    Creates Folder for each test type and stores the individual excel files with in
    """
    test_type = test.get_test_type()
    str_time = test.start_time.strftime("%H-%M-%S")
    folder = create_chip_folder(test)
    folder_path = os.path.join(folder, f"{test_type}_{str_time}")
    os.makedirs(folder_path, exist_ok=True)
    return folder_path


def create_chip_folder(test):  # Called once
    """
    Creates folder for all device test files of a test
    return:
        folder path
    """
    # Get current directory
    folder = create_main_folder()
    # Make new folder for test if doesn't exist
    folder_path = os.path.join(folder, f"{test.chiplet_name}")
    os.makedirs(folder_path, exist_ok=True)
    return folder_path


def create_main_folder():
    """
    Creates Main folder for every test in a run this is where the Summary excel is stored
    """
    home_dir = os.path.abspath(__file__)
    current_directory = os.path.dirname(home_dir)
    str_time = time.strftime("%m-%d-%Y")
    folder_path = os.path.join(current_directory, f"{str_time}")
    os.makedirs(folder_path, exist_ok=True)
    return folder_path


def find_hrs_et(dataframe):
    """
    Input dataframe must be data from endurance test
    returns list of HRS readings from endurance test
    """
    resistance = dataframe["Real Resistance"]
    hrs = []
    for i in range(2, len(resistance), 8):
        hrs.append(resistance[i])
    return hrs


def find_lrs_et(dataframe):
    """
    Input dataframe must be data from endurance test
    returns list of LRS readings from endurance test
    """
    resistance = dataframe["Real Resistance"]
    lrs = []
    for i in range(6, len(resistance), 8):
        lrs.append(resistance[i])
    return lrs

def find_hrs_rt(dataframe):
    """
    Input dataframe must be data from endurance test
    returns list of HRS readings from endurance test
    """
    resistance = dataframe["Real Resistance"]
    hrs = []
    for i in range(0, len(resistance),2):
        hrs.append(resistance[i])
    return hrs


def find_hrs_iv(dataframe):
    """
    Input dataframe must be data from an endurance test
    Returns a list of HRS readings from the endurance test
    """
    resistance = dataframe["Real Resistance"]
    voltage = dataframe["Voltage"]
    hrs = []

    prev_voltage = voltage.iloc[0]  # Store the previous voltage value
    for i in range(1, len(voltage)):
        if voltage.iloc[i] < 0.2 and voltage.iloc[i] < prev_voltage:
            hrs.append(resistance.iloc[i])
        prev_voltage = voltage.iloc[i]  # Update the previous voltage value

    return hrs


def find_lrs_iv(dataframe):
    """
    Input dataframe must be data from an endurance test
    Returns a list of LRS readings from the endurance test
    """
    resistance = dataframe["Real Resistance"]
    voltage = dataframe["Voltage"]
    lrs = []

    prev_voltage = voltage.iloc[0]  # Store the previous voltage value
    for i in range(1, len(voltage)):
        if voltage.iloc[i] > 0.2 and voltage.iloc[i] > prev_voltage:
            lrs.append(resistance.iloc[i])
        prev_voltage = voltage.iloc[i]  # Update the previous voltage value

    return lrs