|
"output": "<|begin_of_text|>Initialize : (Hardware Simulation)\n\nDescription:\n\n This function is used to initialize the XML Configuration file by giving label of Mouse & Serial as parameter.\n\nSyntax\n\npublic override OutputData<object> Initialize(string MouseLabel,string SerialLabel)\n\nParameter (In)\n\nMouseLabel - Parameter to hold any label inside the particular vendor.\n\nMouseLabel should be passed as \u201cDefault\u201c If there is no configuration setting done for the Mouse inside the XML else specify the configured mouse label.\n\nSerialLabel - Parameter to hold the Serial Label\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess\n\nString StatusMessage \n\n\n\nIsSuccess: Returns true if success else returns false\n\nStatusMessage: Returns success message if true else returns the corresponding error message\n\nGlobal Data used\n\nNone\n\nGlobal function / macro imported\n\nNone\n\nUsage(Powershell)\n\n\tUsage:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n\n\n=========Assign Port Label=============\n\n$MouseLabel = \" \"okbutton\"\" \n\n$SerialLabel = \" COM3\" \n\n\n\n\t=========Call Initialize API=============\n\n$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) \n\n\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the initialize call\n\n\n\n\n\nInitialize (Software Simulation)\n\nDescription:\n\n This function is used to initialize the XML Configuration file by giving label of Mouse as parameter for software simulation.\n\nSyntax\n\npublic override OutputData<object> Initialize(string MouseLabel)\n\nParameter (In)\n\nMouseLabel - Parameter to hold any label inside the particular vendor.\n\nMouseLabel should be passed as \u201cDefault\u201c If there is no configuration setting done for the Mouse inside the XML else specify the configured mouse label.\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess\n\nString StatusMessage \n\n\n\nIsSuccess: Returns true if success else returns false\n\nStatusMessage: Returns success message if true else returns the corresponding error message\n\nGlobal Data used\n\nNone\n\nGlobal function / macro imported\n\nNone\n\nUsage(Powershell)\n\n\tUsage:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n\n\n=========Assign Port Label=============\n\n$MouseLabel = \" \"okbutton\"\" \n\n\n\n\t=========Call Initialize API=============\n\n$bRet = $oSimulation.Initialize($MouseLabel) \n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the initialize call\n\n\n\n\n\nSendKeyboardText\n\nDescription:\n\n This function is used to simulate the keyboard events to the DUT/ AUT with the user given text.\n\nSyntax\n\npublic override OutputData<object> SendKeyboardText(string value, UInt16 delay = 0)\n\nParameter (In)\n\nvalue \u2013 \n\nParameter to hold the data in text format to be transmitted (Mandatory)\n\ndelay - Parameter to hold the delay in milliseconds for text to be transmitted\n\n(Optional)\n\nBy default delay will be 0.\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess\n\nstring StatusMessage \n\nIsSuccess: Returns true if success else returns false\n\nStatusMessage: Returns success message if true else returns the corresponding error message\n\nGlobal Data used\n\nNone\n\nGlobal function / macro imported\n\nNone\n\nUsage(Powershell)\n\n\tUsage:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n\n\n=========Assign Variables=============\n\n$MouseLabel = \" \"okbutton\"\n\n$SerialLabel = \" COM3\" \n\n$value = \"abcdef\"\n\n$delay = 500\n\n\n\n\t=========Call Initialize API=============\n\n\tHardware:\n\n$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) Software:\n\n$bRet = $oSimulation.Initialize($MouseLabel) \n\n\n\n\t=========Call SendKeyboardText API==========\n\n\t$bRet = $oSimulation.SendKeyboardText($value)\n\n$bRet = $oSimulation.SendKeyboardText($value,$delay)\n\n\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the SendKeyboardText call\n\n\n\n\t\n\n\n\n\n\nSendKeyboardText\n\nDescription:\n\n This funciton is used to simulate the keyboard events to the DUT/ AUT with the user given text,value,numberoftimes and delay as parameter.\n\nSyntax\n\npublic override OutputData<object> SendKeyboardText(string value, int NumberOfTimes, int DelayInMilliseconds, bool IsBlocking = true)\n\nParameter (In)\n\nvalue \u2013 \n\nParameter to hold the data in text format to be transmitted (Mandatory)\n\n\n\nNumberOfTimes \u2013 \n\nParameter to hold the number of times to repeat the value to be transmitted\n\n(Mandatory)\n\n\n\nDelayInMilliseconds \u2013\n\nParameter to hold the delay in milliseconds for the data to be transmitted\n\n(Mandatory)\n\n\n\nbool IsBlocking \u2013\n\nIf the provided user key values need to be in blocking state then user need to specify as TRUE, else FALSE(Optional)\n\nBy default IsBlocking will be true.\n\n\n\nWhen Isblocking is false then the status of the task execution is read using the API- TaskExecutionStatus:\n\nCall TaskExecutionStatus() and check its state.\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess\n\nstring StatusMessage \n\n\n\nIsSuccess: Returns true if success else returns false\n\nStatusMessage: Returns success message if true else returns the corresponding error message\n\nGlobal Data used\n\nNone\n\nGlobal function / macro imported\n\nNone\n\nUsage(Powershell)\n\n\tUsage:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n\n\n=========Assign Variables=============\n\n$MouseLabel = \"okbutton\"\n\n$value = \"abcdef\"\n\n\n\n\t=========Call Initialize API=============\n\n\tHardware:\n\n$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) Software:\n\n$bRet = $oSimulation.Initialize($MouseLabel) \n\n\n\n\t=========Call SendKeyboardText API==========\n\n$bRet = $oSimulation.SendKeyboardText($value,100,200,$true)\n\n\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the SendKeyboardText call\n\n\n\n\n\nSendKeyboardTextFile\n\nDescription:\n\n This function is used to simulate the keyboard events to the DUT/ AUT with the text which is available in the user specified text file.\n\nSyntax\n\npublic override OutputData<object> SendKeyboardTextFile(string FilePath, UInt16 delay = 0))\n\nParameter (In)\n\nFilePath \u2013 \n\nParameter to hold the path of the file containing texts to be transmitted (Mandatory)\n\n\n\ndelay - Parameter to hold the delay in milliseconds for file containing texts to be transmitted\n\n(Optional)\n\nBy default delay will be 0.\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess\n\nstring StatusMessage \n\n\n\nIsSuccess: Returns true if success else returns false\n\nStatusMessage: Returns success message if true else returns the corresponding error message\n\nGlobal Data used\n\nNone\n\nGlobal function / macro imported\n\nNone\n\nUsage(Powershell)\n\n\tUsage:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n\n\n=========Assign Variables=============\n\n$MouseLabel = \"okbutton\"\n\n$SerialLabel = \" COM3\" \n\n$ FilePath = \" D:\\\\ test.txt\"\n\n$delay = 100\n\n\t=========Call Initialize API=============\n\n\tHardware:\n\n$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) Software:\n\n$bRet = $oSimulation.Initialize($MouseLabel) \n\n\n\n\t=========Call SendKeyboardText API==========\n\n\t$bRet = $oSimulation.SendKeyboardTextFile($FilePath)\n\n$bRet = $oSimulation.SendKeyboardTextFile($FilePath,$true, $delay)\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the SendKeyboardText call\n\n\n\n\n\n\n\n\n\nSendKeyboardSpecialKey\n\nDescription:\n\n This funciton is used to simulate the keyboard events to the DUT/ AUT with the user given special key.\n\nSyntax\n\npublic override OutputData<object> SendKeyboardSpecialKey(string Keycode, bool IsReleaseKey, UInt16 delay = 0, bool <|begin_of_text|>IsDelayRequired=false))\n\nParameter (In)\n\nKeycode \u2013 \n\nParameter to hold the data in special key format(Mandatory) \n\nList of possible keys:\n\nPlease refer section 5.1(Keyboard Keys)\n\n\n\nbool IsReleaseKey \u2013 \n\nIf the provided user key values need to be released then user need to specify as TRUE, else FALSE(Optional)\n\nBy default IsReleaseKey will be true.\n\n(Not required for software simultion)\n\n\n\ndelay - Parameter to hold the delay in milliseconds for special key to be transmitted\n\n(Optional)\n\nBy default delay will be 0.\n\nIsDelayRequired -Its default value is false.This parameter is only applicable for software simulations only\n\nIf IsDelayRequired parameter is false then no delay will apply for sending special keyboard key.\n\nIf IsDelayRequired parameter is true then delay will apply for sending special key.This delay will apply for each subaction(Keypress Down and Up) of send special key. The minimum delay is 100ms require to send special key. The maximum suggested delay is 3000ms. It supports single click only.\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess\n\nstring StatusMessage \n\n\n\nIsSuccess: Returns true if success else returns false\n\nStatusMessage: Returns success message if true else returns the corresponding error message\n\nGlobal Data used\n\nNone\n\nGlobal function /macro imported\n\nNone\n\nUsage(Powershell)\n\n\tUsage1:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n=========Assign Variables=============\n\n$MouseLabel = \"okbutton\u201c \n\n$SerialLabel = \" COM3\" \n\n$Keycode = \"Enter\"\n\n$delay = 3000\n\n\n\n\t=========Call Initialize API=============\n\n\tHardware:\n\n$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) Software:\n\n$bRet = $oSimulation.Initialize($MouseLabel) \n\n\n\n\n\n\t=========Call SendKeyboardSpecialKey API===========\n\n\t$bRet = $oSimulation.SendKeyboardSpecialKey($Keycode,$true)\n\n$bRet = $oSimulation.SendKeyboardSpecialKey($Keycode,$true,$delay)\n\n\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the SendKeyboardSpecialKey call\n\n\n\n\tUsage2:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n=========Assign Variables=============\n\n$MouseLabel = \"okbutton\u201c \n\n$Keycode = \"Enter\"\n\n$delay = 100\n\n$IsDelayRequired=$true\n\n\n\n\t=========Call Initialize API=============\n\nSoftware:\n\n$bRet = $oSimulation.Initialize($MouseLabel) \n\n\n\n\n\n\t=========Call SendKeyboardSpecialKey API===========\n\n$oSimulation.SendKeyboardSpecialKey($Keycode,$true,$delay, $IsDelayRequired)\n\n\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the SendKeyboardSpecialKey call\n\n\n\n\n\nSendKeyboardSpecialKey\n\nDescription:\n\n This funciton is used to simulate the keyboard events to the DUT/ AUT with the user given special key,numberoftimes,delay as parameter.\n\nSyntax\n\npublic override OutputData<object> SendKeyboardSpecialKey(string Keycode, int NumberOfTimes, int DelayInMilliseconds, bool IsBlocking = true)\n\nParameter (In)\n\nKeycode \u2013 \n\nParameter to hold the data in special key format(Mandatory) \n\nList of possible keys:\n\nPlease refer section 5.1(Software-Keyboard Keys)\n\n\n\nNumberOfTimes \u2013 \n\nParameter to hold the number of times to repeat the value to be transmitted\n\n(Mandatory)\n\n\n\nDelayInMilliseconds \u2013\n\nParameter to hold the delay in milliseconds for the data to be transmitted\n\n(Mandatory)\n\n\n\nbool IsBlocking \u2013\n\nIf the provided user key values need to be in blocking state then user need to specify as TRUE, else FALSE(Optional)\n\nBy default IsBlocking will be true.\n\n\n\nWhen Isblocking is false then the status of the task execution is read using the API- TaskExecutionStatus:\n\nCall TaskExecutionStatus() and check its state.\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess\n\nstring StatusMessage \n\n\n\nIsSuccess: Returns true if success else returns false\n\nStatusMessage: Returns success message if true else returns the corresponding error message\n\nGlobal Data used\n\nNone\n\nGlobal function /macro imported\n\nNone\n\nUsage(Powershell)\n\n\tUsage:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n=========Assign Variables=============\n\n$MouseLabel = \"okbutton\u201c \n\n$Keycode = \"Enter\"\n\n\t=======Call Initialize API=============\n\n\tHardware:\n\n$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) Software:\n\n$bRet = $oSimulation.Initialize($MouseLabel) \n\n\t=========Call SendKeyboardSpecialKey API===========\n\n$bRet = $oSimulation.SendKeyboardSpecialKey($Keycode,100,200,$true)\n\n\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the SendKeyboardSpecialKey call\n\n\n\n\n\nSendKeyboardCombinations\n\nDescription:\n\n This funciton is used to simulate the keyboard events to the DUT/ AUT with the user given key combinations.\n\nSyntax\n\npublic override OutputData<object> SendKeyboardSpecialCombinations(string value, UInt16 delay = 0)\n\nParameter (In)\n\nvalue \u2013 \n\nParameter to hold the data in combination format(Mandatory)\n\nList of possible keys:\n\nPlease refer section 5.1(Keyboard Keys)\n\nSome of not supported combination keys are mentioned in section 8 and point no 9 (For software simulation)\n\n\n\n\n\ndelay - Parameter to hold the delay in milliseconds for combinations to be transmitted\n\n(Optional)\n\nBy default delay will be 0.\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess\n\nstring StatusMessage \n\n\n\nIsSuccess: Returns true if success else returns false\n\nStatusMessage: Returns empty if true else returns the corresponding error message\n\nGlobal Data used\n\nNone\n\nGlobal function / macro imported\n\nNone\n\nUsage(Powershell)\n\n\tUsage:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n=========Assign Variables=============\n\n$MouseLabel = \"okbutton\" \n\n$SerialLabel = \" COM3\" \n\n$value = \"Ctrl+Alt+Delete\"\u2018\n\n$delay = 1000\n\n\t=========Call Initialize API=============\n\n$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) \n\n\n\n\t=========Call SendKeyboardCombinations API=============\n\n\t$bRet = $oSimulation.SendKeyboardCombinations($value)\n\n$bRet = $oSimulation.SendKeyboardCombinations($value, $delay)\n\n\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the SendKeyboardCombinations call\n\nSendKeyboardUnicode\n\nDescription:\n\n This function is used to simulate the keyboard events to the AUT by giving Character code as parameter.\n\nThis API is not supported for hardware simulation.\n\nSyntax\n\npublic override OutputData<object> SendKeyboardUnicode(int Charcode)\n\nParameter (In)\n\nCharcode \u2013 \n\nProvide Unicode value for the character(Unicode values can be referd from charcter map)(Mandatory)\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess\n\nstring StatusMessage \n\nIsSuccess: Returns true if success else returns false\n\nStatusMessage: Returns empty if true else returns the corresponding error message\n\nGlobal Data used\n\nNone\n\nGlobal function / macro imported\n\nNone\n\nUsage(Powershell)\n\n\tUsage:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n\n\n=========Assign Variables=============\n\n$MouseLabel = \"okbutton\" \n\n$Charcode = \"0x00ae\"\u2018\n\n\n\n\t=========Call Initialize API=============\n\n$bRet = $oSimulation.Initialize($MouseLabel) \n\n\n\n\t=========Call SendKeyboardUnicode API=============\n\n$bRet = $oSimulation.SendKeyboardUnicode($Charcode)\n\n\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the SendKeyboardCombinations call\n\nTaskExecutionStatus\n\nDescription:\n\n This function is used to get the execution status for keyboard when execution \n\nhappens in Non-blocking mode. \n\nSyntax\n\npublic override OutputDa<|begin_of_text|>ta<object> TaskExecutionStatus()\n\nParameter (In)\n\n----- NA -----\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess: Returns true if success else returns false\n\nString StatusMessage: Returns empty if true else returns the corresponding error message\n\nString State :\n\nThree States of TaskExecutionStatus API are:\n\n1.IDLE\n\n2.PROCESSING\n\n3.COMPLETED\n\nGlobal Data used\n\nNone\n\nGlobal function / macro imported\n\nNone\n\nUsage(Powershell)\n\n\tUsage:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n=========Assign Variables=============\n\n$MouseLabel = \"okbutton\" \n\n\t=========Call Initialize API=============\n\n$bRet = $oSimulation.Initialize($MouseLabel) \n\n\t========Call TaskExecutionStatus API=============\n\n$bRet = $oSimulation.TaskExecutionStatus()\n\n\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the SendKeyboardCombinations call\n\nDoMouseActions\n\nDescription:\n\n This funciton is used to simulate the mouse events to the DUT/ AUT with the user given mouse actions.\n\nSyntax\n\npublic override OutputData<object> DoMouseActions(string label,string action, bool IsSingleClick, bool IsReleaseKey, UInt16 delay = 0, string movetype = \"Absolute\", bool isEventfunction = true)\n\nParameter (In)\n\nlabel - Parameter to hold the Mouse Label (Mandatory) \n\n\n\naction \u2013 \n\nParameter to hold the action(Mandatory)\n\nList of possible Action:(Not CaseSensitive)\n\nLeft\n\nRight\n\nMiddle\n\nMove\n\n\n\nbool IsSingleClick- \n\nIf the provided user mouse actions need to be single clicked then user need to specify as TRUE, else FALSE(Optional)\n\nBy default IsSingleClick will be true.\n\n\n\nbool IsReleaseKey \u2013 \n\nIf the provided user mouse actions need to be released then user need to specify as TRUE, else FALSE(Optional)\n\nBy default IsReleaseKey will be true.\n\n\n\ndelay - Parameter to hold the delay in milliseconds for mouse actions to be transmitted\n\n(Optional)\n\nBy default delay will be 0.\n\n\n\nmovetype - Parameter to hold the move type for mouse move to be transmitted\n\n(Optional)\n\nBy default movetype will be Absolute.\n\nList of possible Movetypes:(Not CaseSensitive)\n\nAbsolute\n\nRelative\n\nbool isEventfunction-The default value is true.This parameter is only applicable for software simulation only.\n\nIf isEventfunction is true,the DoMouseActions function will use MouseEvent function to perform the mouse click operation.\n\nIf isEventfunction is false,the DoMouseActions function will use SendInput function to perform the mouse click operation.It will perform better than MouseEvent for mouseclick in some scenarios.User can use SendInput option when MouseEvent not performed well.It supports left single click,right single click,left double click,right double click operations only.The SendInput function supports movetype parameter value is Absolute only.The minimum delay is required for mouse click is 100ms.This delay is applicable for each subaction(mouse left click Down and Up) of mouse click operation.\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess\n\nstring StatusMessage \n\nIsSuccess: Returns true if success else returns false\n\nStatusMessage: Returns empty if true else returns the corresponding", |
|
"output": " error message\n\nGlobal Data used\n\nNone\n\nGlobal function / macro imported\n\nNone\n\nUsage(Powershell)\n\n\tUsage 1: \t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n\n\n=========Assign Variables============\n\n$MouseLabel = \" \"okbutton\" \n\n$SerialLabel = \" COM3\" \n\n$label = \u201cokbutton\u201c\n\n$action = \"move\"\n\n$delay = 1000\n\n$movetype = \"Relative\u201c\n\n\t=========Call Initialize API=============\n\n$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel)\n\n \n\n\t=========Call DoMouseActions API=============\n\n$bRet = $oSimulation.DoMouseActions($label,$action,$true,$true)\n\n$bRet = $oSimulation.DoMouseActions($label,$action,$true,$true, $delay,$movetype)\n\n\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the DoMouseActions call\n\n\n\n\tUsage 2: \t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n\n\n=========Assign Variables============\n\n$MouseLabel = \" \"okbutton\" \n\n$action = \"move\"\n\n$delay = 1000\n\n$movetype = \"Absolute\u201c\n\n$ isEventfunction=false\n\n\n\n\t=========Call Initialize API=============\n\n$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel)\n\n \n\n\t=========Call DoMouseActions API=============\n\n$oSimulation.DoMouseActions($label,$action,$true,$true, $delay,$movetype, $ isEventfunction)\n\n\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the DoMouseActions call\n\nDoMouseClick\n\nDescription:\n\n This function is used to simulate the mouse events to the DUT/ AUT with the user given mouse click actions at the current position.\n\nSyntax\n\npublic override OutputData<object> DoMouseClick(string action, bool IsSingleClick, bool IsReleaseKey, UInt16 delay = 0)\n\nParameter (In)\n\naction \u2013 \n\nParameter to hold the action(Mandatory)\n\nList of possible Action:(Not CaseSensitive)\n\nLeft\n\nRight\n\nMiddle\n\n\n\nbool IsSingleClick- \n\nIf the provided user mouse actions need to be single clicked then user need to specify as TRUE, else FALSE(Optional)\n\nBy default IsSingleClick will be true.\n\n\n\nbool IsReleaseKey \u2013 \n\nIf the provided user mouse actions need to be released then user need to specify as TRUE, else FALSE(Optional)\n\nBy default IsReleaseKey will be true.\n\n\n\ndelay - Parameter to hold the delay in milliseconds for mouse actions to be transmitted\n\n(Optional)\n\nBy default delay will be 0.\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess\n\nstring StatusMessage \n\n\n\nIsSuccess: Returns true if success else returns false\n\nStatusMessage: Returns empty if true else returns the corresponding error message\n\nGlobal Data used\n\nNone\n\nGlobal function / macro imported\n\nNone\n\nUsage(Powershell)\n\n\tUsage:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n\n\n=========Assign Variables============\n\n$MouseLabel = \" \"okbutton\" \n\n$SerialLabel = \" COM3\" \n\n$action = \"left\"\u2018\n\n$delay = 1200\n\n\n\n\t=========Call Initialize API=============\n\n$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel)\n\n \n\n\t=========Call DoMouseClick API=============\n\n$bRet = $oSimulation.DoMouseClick($action,$true,$true)\n\n$bRet = $oSimulation.DoMouseClick($action,$true,$true,$delay)\n\n\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the DoMouseActions call\n\nDoRealTimeMouseActions\n\nDescription:\n\n This funciton is used to simulate the mouse events to the DUT/ AUT with the user given mouse actions & coordinates at runtime.\n\nSyntax\n\npublic override OutputData<object> DoRealTimeMouseActions(int X,int Y,string action, bool IsSingleClick, bool IsReleaseKey, UInt16 delay = 0, string movetype = \"Absolute\")\n\nParameter (In)\n\nX \u2013 Parameter to hold the x coordinate (Mandatory)\n\n\n\nY - Parameter to hold the y coordinate (Mandatory)\n\n\n\naction \u2013 \n\nParameter to hold the action to be transmitted (Mandatory)\n\nList of possible Action:(Not CaseSensitive)\n\nLeft\n\nRight\n\nMiddle\n\nMove\n\n\n\nbool IsSingleClick- \n\nIf the provided user mouse actions need to be single clicked then user need to specify as TRUE, else FALSE(Optional)\n\nBy default IsSingleClick will be true.\n\n\n\nbool IsReleaseKey \u2013 \n\nIf the provided user mouse actions need to be released then user need to specify as TRUE, else FALSE(Optional)\n\nBy default IsReleaseKey will be true.\n\n\n\ndelay - Parameter to hold the delay in milliseconds for mouse actions to be transmitted\n\n(Optional)\n\nBy default delay will be 0.\n\n\n\nmovetype - Parameter to hold the move type for mouse move to be transmitted\n\n(Optional)\n\nBy default movetype will be Absolute.\n\nList of possible Movetypes:(Not CaseSensitive)\n\nA<|begin_of_text|>bsolute\n\nRelative\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess\n\nstring StatusMessage \n\n\n\nIsSuccess: Returns true if success else returns false\n\nStatusMessage: Returns empty if true else returns the corresponding error message\n\nGlobal Data used\n\nNone\n\nGlobal function / macro imported\n\nNone\n\nUsage(Powershell)\n\n\tUsage:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n\n\n=========Assign Variables============\n\n$MouseLabel = \" \"okbutton\" \n\n$SerialLabel = \" COM3\" \n\nX = \u201c456\u201c\n\nY = \u201c545\u201c\n\n$action = \"left\"\u2018\n\n$delay = 3000\n\n$movetype = \"Absolute\u201c\n\n\t=========Call Initialize API=============\n\n$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) \n\n\n\n\t=========Call DoMouseActions API============\n\n\n\n$bRet =\n\n$oSimulation. DoRealTimeMouseActions (X,Y,$action,$true,$true)\n\n$bRet =\n\n$oSimulation. DoRealTimeMouseActions (X,Y,$action,$true,$true,$delay,$movetype)\n\n\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the DoMouseActions call\n\n DoMouseScroll\n\nDescription:\n\n This funciton is used to simulate the mouse events to the DUT/ AUT with the user given scroll actions..\n\nSyntax\n\npublic override OutputData<object> DoMouseActions(string action,int NumberOfScrollTimes, UInt16 delay = 0)\n\nParameter (In)\n\naction \u2013 \n\nParameter to hold the action(Mandatory)\n\nList of possible Action:(Not CaseSensitive)\n\nUp\n\nDown\n\n\n\nNumberOfScrollTimes \u2013 Parameter to hold the times to perform the scroll action (Mandatory)\n\n\n\ndelay - Parameter to hold the delay in milliseconds for mouse actions to be transmitted\n\n(Optional)\n\nBy default delay will be 0.\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess\n\nstring StatusMessage \n\n\n\nIsSuccess: Returns true if success else returns false\n\nStatusMessage: Returns empty if true else returns the corresponding error message\n\nGlobal Data used\n\nNone\n\nGlobal function / macro imported\n\nNone\n\nUsage(Powershell)\n\n\tUsage:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n\n\n=========Assign Variables============\n\n$MouseLabel = \" \"okbutton\" \n\n$SerialLabel = \" COM3\" \n\n$action = \"Up\u201c\n\n$NumberOfScrollTimes = 5\n\n$delay = 3000\n\n\t=========Call Initialize API=============\n\n$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) \n\n\n\n\t=========Call DoMouseScroll API=============\n\n$bRet = $oSerial.DoMouseScroll($action,$ NumberOfScrollTimes)\n\n$bRet = $oSerial.DoMouseScroll($action,$ NumberOfScrollTimes,$delay)\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the DoMouseScroll call\n\n DoMouseDragDrop(Using Label)\n\nDescription:\n\n This funciton is used to simulate the mouse events to the DUT/ AUT with the user given coordinates for drag & drop actions.\n\nSyntax\n\npublic override OutputData<object> DoMouseDragDrop(string label, UInt16 delay = 0)\n\nParameter (In)\n\nlabel - Parameter to hold any label inside the particular vendor. (Mandatory)\n\n\n\ndelay - Parameter to hold the delay in milliseconds for mouse actions to be transmitted\n\n(Optional)\n\nBy default delay will be 0.\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess\n\nstring StatusMessage \n\n\n\nIsSuccess: Returns true if success else returns false\n\nStatusMessage: Returns empty if true else returns the corresponding error message\n\nGlobal Data used\n\nNone\n\nGlobal function / macro imported\n\nNone\n\nUsage(Powershell)\n\n\tUsage:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n\n\n=========Assign Variables============\n\n$MouseLabel = \" \"okbutton\" \n\n$SerialLabel = \" COM3\" \n\n$label = \u201cokbutton\u201c\n\n$delay = 1245\n\n\t=========Call Initialize API=============\n\n$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) \n\n\n\n\t=========Call DoMouseDragDrop API=============\n\n$bRet = $oSerial.DoMouseDragDrop($action,$ NumberOfScrollTimes)\n\n$bRet = $oSerial.DoMouseDragDrop($action,$ NumberOfScrollTimes,$delay)\n\n\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the DoMouseDragDrop call\n\n\n\n\n\n\t\n\nDoMouseDragDrop(Using Coordinates)\n\nDescription:\n\n This funciton is used to simulate the mouse events to the DUT/ AUT with the user given coordinates at runtime for drag & drop actions.\n\nSyntax\n\npublic override OutputData<object> DoMouseDragDrop(int X1,int Y1,int X2,int Y2, UInt16 delay = 0)\n\nParameter (In)\n\nX1 \u2013 Parameter to hold the x1 coordinate (Mandatory)\n\n\n\nY1 - Parameter to hold the y1 coordinate (Mandatory)\n\n\n\nX2 \u2013 Parameter to hold the x2 coordinate (Mandatory)\n\n\n\nY2 - Parameter to hold the y2 coordinate (Mandatory)\n\n\n\ndelay - Parameter to hold the delay in milliseconds for mouse actions to be transmitted\n\n(Optional)\n\nBy default delay will be 0.\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess\n\nstring StatusMessage \n\nIsSuccess: Returns true if success else returns false\n\nStatusMessage: Returns empty if true else returns the corresponding error message\n\nGlobal Data used\n\nNone\n\nGlobal function / macro imported\n\nNone\n\nUsage(Powershell)\n\n\tUsage:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n\n\n=========Assign Variables============\n\n$MouseLabel = \" \"okbutton\" \n\n$SerialLabel = \" COM3\" \n\nX1 = \u201c456\u201c\n\nY1 = \u201c545\u201c\n\nX2 = \u201c676\u201c\n\nY2 = \u201c789\u201c\n\n$delay = 1250\n\n\t=========Call Initialize API=============\n\n$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) \n\n\n\n\t=========Call DoMouseDragDrop API(Using Coordinates)=============\n\n$bRet = $oSerial.DoMouseDragDrop(X1,Y1,X2,Y2)\n\n$bRet = $oSerial.DoMouseDragDrop(X1,Y1,X2,Y2,$delay)\n\n\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the DoMouseDragDrop call\n\n Release\n\nDescription:\n\n This funciton is used to simulate the release action for keyboard & mouse events to the DUT/ AUT with the user given action parameter.\n\nIn this API,only mouse release action is supported for software simulation.\n\nSyntax\n\npublic override OutputData<object> Release(string action)\n\nParameter (In)\n\naction \u2013 \n\nParameter to hold the action to be transmitted (Mandatory)\n\nList of possible Action:(Not CaseSensitive)\n\nkeyboard\n\nmouse\n\nboth\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess\n\nstring StatusMessage \n\nIsSuccess: Returns true if success else returns false\n\nStatusMessage: Returns empty if true else returns the corresponding error message\n\nGlobal Data used\n\nNone\n\nGlobal function / macro imported\n\nNone\n\nUsage(Powershell)\n\n\tUsage:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n\n\n=========Assign Variables============\n\n$MouseLabel = \"okbutton\" \n\n$SerialLabel = \" COM3\" \n\n$action = \" keyboard\u201c\n\n\n\n\t=========Call Initialize API=============\n\n$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) \n\n\t=========Call Release API=============\n\n$bRet = $oSerial.Release($action)\n\n\n\n\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the Release call\n\n\tGetCommunicationStatus\n\nDescription:\n\n This function is used to perform the communication checking operation\n\nThis API is not supported for software simulation\n\nSyntax\n\n\n\npublic override OutputData<object> GetCommunicationStatus()\n\nParameter (In)\n\nNone\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess\n\nstring StatusMessage \n\nIsSuccess: Returns true if success else returns false\n\nStatusMessage: Returns success message if true else returns the corresponding error message\n\nGlobal Data used\n\nNone\n\nGlobal function / macro imported\n\nNone\n\nUsage(Powershell)\n\nUsage:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Confi<|begin_of_text|>guration_File)\n\n=========Assign Variables============\n\n$MouseLabel = \" \"okbutton\" \n\n$SerialLabel = \" COM3\" \n\n\t=========Call Initialize API=============\n\n$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) \n\n\t======Call GetCommunicationStatus API==========\n\n$bRet = $oSimulation.GetCommunicationStatus () \n\n\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the GetCommunicationStatus call\n\n\tReset\n\nDescription:\n\n This function is used to reset the device\n\nThis API is not supported for software simulation\n\nSyntax\n\n\n\npublic override OutputData<object> Reset ()\n\nParameter (In)\n\nNone\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess\n\nstring StatusMessage \n\n\n\nIsSuccess: Returns true if success else returns false\n\nStatusMessage: Returns success message if true else returns the corresponding error message\n\nGlobal Data used\n\nNone\n\nGlobal function / macro imported\n\nNone\n\nUsage(Powershell)\n\nUsage:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n\n\n=========Assign Variables============\n\n$MouseLabel = \" \"okbutton\" \n\n$SerialLabel = \" COM3\" \n\n\n\n\t=========Call Initialize API=============\n\n$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) \n\n\n\n\t=========Call Reset API=============\n\n$bRet = $oSimulation.Reset () \n\n\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the Reset call\n\n\tDisconnect\n\nDescription:\n\nHardware simulation:\n\n This function used to disconnect the communication port.\n\nSoftware simulation:\n\n This function used to dispose the objects.\n\nSyntax\n\n\n\npublic override OutputData<object> Disconnect()\n\nParameter (In)\n\nNone\n\nParameter (Out)\n\nNone\n\nReturn Value\n\nOutputData: \n\nbool IsSuccess\n\nstring StatusMessage \n\n\n\nIsSuccess: Returns true if success else returns false\n\nStatusMessage: Returns success message if true else returns the corresponding error message\n\nGlobal Data used\n\nNone\n\nGlobal function / macro imported\n\nNone\n\nUsage(Powershell)\n\nUsage:\t\n\n\tObject creation :\n\n$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)\n\n\n\n=========Assign Variables============\n\n$MouseLabel = \" \"okbutton\" \n\n$SerialLabel = \" COM3\" \n\n\t=========Call Initialize API=============\n\n$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) \n\n\t=========Call Disconnect API=============\n\n$bRet = $oSimulation.Disconnect() \n\n\n\nWrite-Host $bRet.IsSuccess : Prints the message True/False\n\n\n\nWrite-Host $bRet.StatusMessage : Prints the status of the Disconnect call\n\n", |
