# Test name: Diagnostic
# Test interlocks of diagnostic modules by generating a pulse
# Copyright (c) 2015 Paul Scherrer Institute. All rights reserved.

###### Init - DO NOT MODIFY THE CODE BELOW ######
global sys, inspect, os, traceback
import sys, inspect, os, traceback


def startTest(testName, DEVICE, params):
    """
    Main method running the test
    """
    # by default, assume the test failed:
    ret = 'Test failed'
    status = False
    # put the whole custom code under try/catch.
    try:
        # get the path of this script:
        testPath = inspect.getfile(inspect.currentframe())
        # init the testing tool class:
        test = TestingTool(testName, testPath, DEVICE, params)

################ END OF Init #####################
######### WRITE YOUR CODE HERE BELOW #############

        """
        All the code in this section # WRITE YOUR CODE HERE BELOW # is just an example and can be modified/deleted.
        It must be indented to the same level as this comment.
        -----------------------------------
                   GETTING INPUTS:
        -----------------------------------
        If needed, the following methods are available:

        test.getPath()        string, path of this test file
        test.getName()        string, name of this test
        test.getDeviceName()  string, device for which the test must run (typically it is the beginning of a process variable name)
        test.getPlotName()    string, name to be given to the plot when using setPlotTitle(). Example: scan.setPlotTitle(test.getPlotName())
        -----------------------------------
                   GETTING TEST PARAMETERS:
        -----------------------------------
        if you need to get parameters for the test, use:

        myParamValue = test.getParam('myParamName')

        the calls to getParam are added to the code automatically, one per parameter, when creating the new test.
        NOTE:  Casting may be necessary.
        See the test config for the list of parameters specific to the test.
        -----------------------------------
                   SETTING OUTPUTS:
        -----------------------------------
        When the test has ended (error or success), this method must be called in order to return to pshell:

        test.sendFeedback(ret,success)

        ret        string,   a text summarizing the result of the test.
        success    bool,     True = test successful. False = test failed.
        -----------------------------------
                   LOG INFO:
        -----------------------------------
        when some information must be shown on the log on pshell, use the following line:
        test.log('text to log')
        """

        ########## Example (can be removed) ######

        # print the list of parameters passed. If any error, stop and send feedback.
        test.log("Example - Test name:   " + test.getName())
        test.log("Example - Device name: " + test.getDeviceName() )
        try:
            test.log("Running test with the following parameters:")
            test.printParams()
            # If present, use the parameters here below for your test script.
            # These parameters were automatically generated: you might need to change the casting.
            setGetDelay = float(test.getParam('setGetDelay'))  
            rpsAttribute = test.getParam('rpsAttribute')
            rpsModule = test.getParam('rpsModule')
            expectedValue2 = test.getParam('expectedValue2')
            expectedValue1 = test.getParam('expectedValue1')
        except:
            import traceback
            # test failed, write the report into the variables ret and success and send feedback:
            ret = 'Could not retrieve testing parameters - ' + traceback.format_exc()
            success = False
            test.sendFeedback(ret, success)
            return

        # now try with data from real device: this part will most probably fail: correct the PV names with existing ones.
        try:
            # set up connection to channels. "type" of data can be "d" (= double), "l" (= long).
            #rpsCh = Channel(test.getDeviceName()  + ':' + rpsAttribute  , type='d')
            test.log('doing nothing here...')
        except:
            import traceback
            # prepare return information: return text:
            ret = 'Unable to create channel - ' + traceback.format_exc()
            # prepare return information: return success:
            success = False
            # send return information:
            test.sendFeedback(ret, success)
            return
        # send a command to a channel (it is translated to a caput): uncomment this line below to try it
        #pv_motor_com.put(1.0, timeout=None) # optionally, a timeout can be given.
        # take 100 samples of the channels and plot them:
        # get value (it is translated to a caget):
        # motor_msta = pv_motor_msta.get()

        # Closing channels: all channels that were opened with Channel() must be closed before exit:
        #rpsCh.close()

        # IMPORTANT: if the test was successful, write the report into the variables ret and success.
        # for example, write the following:
        ret = "Success, nothing was done :-)"
        success = True
        # once the test is finished, no need to do anything. The code below yours will do the rest.
        ################ End of Example ##########

################ END OF YOUR CODE ################
###### Final - DO NOT MODIFY THE CODE BELOW ######

        # just in case the feedback was forgotten.
        test.sendFeedback(ret, success)
    except (KeyboardInterrupt):
        # user stop error handler.
        import traceback
        ret = 'Test stopped by user.'
        success = False
        test.sendFeedback(ret, success)
    except:
        # generic error handler.
        import traceback
        ret = traceback.format_exc()
        success = False
        test.sendFeedback(ret, success)


# launch the test.
startTest(test, device, parameters)

################ END OF Final ####################
#### IF NEEDED, ADD YOUR FUNCTIONS HERE BELOW ####
# Indent to end left
# def yourCustomFunction:
