input
null | output
stringclasses 2
values | instruction
stringclasses 1
value |
---|---|---|
null | <|begin_of_text|>Initialize : (Hardware Simulation)
Description:
This function is used to initialize the XML Configuration file by giving label of Mouse & Serial as parameter.
Syntax
public override OutputData<object> Initialize(string MouseLabel,string SerialLabel)
Parameter (In)
MouseLabel - Parameter to hold any label inside the particular vendor.
MouseLabel should be passed as “Default“ If there is no configuration setting done for the Mouse inside the XML else specify the configured mouse label.
SerialLabel - Parameter to hold the Serial Label
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess
String StatusMessage
IsSuccess: Returns true if success else returns false
StatusMessage: Returns success message if true else returns the corresponding error message
Global Data used
None
Global function / macro imported
None
Usage(Powershell)
Usage:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Port Label=============
$MouseLabel = " "okbutton""
$SerialLabel = " COM3"
=========Call Initialize API=============
$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel)
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the initialize call
Initialize (Software Simulation)
Description:
This function is used to initialize the XML Configuration file by giving label of Mouse as parameter for software simulation.
Syntax
public override OutputData<object> Initialize(string MouseLabel)
Parameter (In)
MouseLabel - Parameter to hold any label inside the particular vendor.
MouseLabel should be passed as “Default“ If there is no configuration setting done for the Mouse inside the XML else specify the configured mouse label.
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess
String StatusMessage
IsSuccess: Returns true if success else returns false
StatusMessage: Returns success message if true else returns the corresponding error message
Global Data used
None
Global function / macro imported
None
Usage(Powershell)
Usage:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Port Label=============
$MouseLabel = " "okbutton""
=========Call Initialize API=============
$bRet = $oSimulation.Initialize($MouseLabel)
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the initialize call
SendKeyboardText
Description:
This function is used to simulate the keyboard events to the DUT/ AUT with the user given text.
Syntax
public override OutputData<object> SendKeyboardText(string value, UInt16 delay = 0)
Parameter (In)
value –
Parameter to hold the data in text format to be transmitted (Mandatory)
delay - Parameter to hold the delay in milliseconds for text to be transmitted
(Optional)
By default delay will be 0.
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess
string StatusMessage
IsSuccess: Returns true if success else returns false
StatusMessage: Returns success message if true else returns the corresponding error message
Global Data used
None
Global function / macro imported
None
Usage(Powershell)
Usage:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Variables=============
$MouseLabel = " "okbutton"
$SerialLabel = " COM3"
$value = "abcdef"
$delay = 500
=========Call Initialize API=============
Hardware:
$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) Software:
$bRet = $oSimulation.Initialize($MouseLabel)
=========Call SendKeyboardText API==========
$bRet = $oSimulation.SendKeyboardText($value)
$bRet = $oSimulation.SendKeyboardText($value,$delay)
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the SendKeyboardText call
SendKeyboardText
Description:
This funciton is used to simulate the keyboard events to the DUT/ AUT with the user given text,value,numberoftimes and delay as parameter.
Syntax
public override OutputData<object> SendKeyboardText(string value, int NumberOfTimes, int DelayInMilliseconds, bool IsBlocking = true)
Parameter (In)
value –
Parameter to hold the data in text format to be transmitted (Mandatory)
NumberOfTimes –
Parameter to hold the number of times to repeat the value to be transmitted
(Mandatory)
DelayInMilliseconds –
Parameter to hold the delay in milliseconds for the data to be transmitted
(Mandatory)
bool IsBlocking –
If the provided user key values need to be in blocking state then user need to specify as TRUE, else FALSE(Optional)
By default IsBlocking will be true.
When Isblocking is false then the status of the task execution is read using the API- TaskExecutionStatus:
Call TaskExecutionStatus() and check its state.
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess
string StatusMessage
IsSuccess: Returns true if success else returns false
StatusMessage: Returns success message if true else returns the corresponding error message
Global Data used
None
Global function / macro imported
None
Usage(Powershell)
Usage:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Variables=============
$MouseLabel = "okbutton"
$value = "abcdef"
=========Call Initialize API=============
Hardware:
$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) Software:
$bRet = $oSimulation.Initialize($MouseLabel)
=========Call SendKeyboardText API==========
$bRet = $oSimulation.SendKeyboardText($value,100,200,$true)
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the SendKeyboardText call
SendKeyboardTextFile
Description:
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.
Syntax
public override OutputData<object> SendKeyboardTextFile(string FilePath, UInt16 delay = 0))
Parameter (In)
FilePath –
Parameter to hold the path of the file containing texts to be transmitted (Mandatory)
delay - Parameter to hold the delay in milliseconds for file containing texts to be transmitted
(Optional)
By default delay will be 0.
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess
string StatusMessage
IsSuccess: Returns true if success else returns false
StatusMessage: Returns success message if true else returns the corresponding error message
Global Data used
None
Global function / macro imported
None
Usage(Powershell)
Usage:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Variables=============
$MouseLabel = "okbutton"
$SerialLabel = " COM3"
$ FilePath = " D:\\ test.txt"
$delay = 100
=========Call Initialize API=============
Hardware:
$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) Software:
$bRet = $oSimulation.Initialize($MouseLabel)
=========Call SendKeyboardText API==========
$bRet = $oSimulation.SendKeyboardTextFile($FilePath)
$bRet = $oSimulation.SendKeyboardTextFile($FilePath,$true, $delay)
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the SendKeyboardText call
SendKeyboardSpecialKey
Description:
This funciton is used to simulate the keyboard events to the DUT/ AUT with the user given special key.
Syntax
public override OutputData<object> SendKeyboardSpecialKey(string Keycode, bool IsReleaseKey, UInt16 delay = 0, bool <|begin_of_text|>IsDelayRequired=false))
Parameter (In)
Keycode –
Parameter to hold the data in special key format(Mandatory)
List of possible keys:
Please refer section 5.1(Keyboard Keys)
bool IsReleaseKey –
If the provided user key values need to be released then user need to specify as TRUE, else FALSE(Optional)
By default IsReleaseKey will be true.
(Not required for software simultion)
delay - Parameter to hold the delay in milliseconds for special key to be transmitted
(Optional)
By default delay will be 0.
IsDelayRequired -Its default value is false.This parameter is only applicable for software simulations only
If IsDelayRequired parameter is false then no delay will apply for sending special keyboard key.
If 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.
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess
string StatusMessage
IsSuccess: Returns true if success else returns false
StatusMessage: Returns success message if true else returns the corresponding error message
Global Data used
None
Global function /macro imported
None
Usage(Powershell)
Usage1:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Variables=============
$MouseLabel = "okbutton“
$SerialLabel = " COM3"
$Keycode = "Enter"
$delay = 3000
=========Call Initialize API=============
Hardware:
$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) Software:
$bRet = $oSimulation.Initialize($MouseLabel)
=========Call SendKeyboardSpecialKey API===========
$bRet = $oSimulation.SendKeyboardSpecialKey($Keycode,$true)
$bRet = $oSimulation.SendKeyboardSpecialKey($Keycode,$true,$delay)
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the SendKeyboardSpecialKey call
Usage2:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Variables=============
$MouseLabel = "okbutton“
$Keycode = "Enter"
$delay = 100
$IsDelayRequired=$true
=========Call Initialize API=============
Software:
$bRet = $oSimulation.Initialize($MouseLabel)
=========Call SendKeyboardSpecialKey API===========
$oSimulation.SendKeyboardSpecialKey($Keycode,$true,$delay, $IsDelayRequired)
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the SendKeyboardSpecialKey call
SendKeyboardSpecialKey
Description:
This funciton is used to simulate the keyboard events to the DUT/ AUT with the user given special key,numberoftimes,delay as parameter.
Syntax
public override OutputData<object> SendKeyboardSpecialKey(string Keycode, int NumberOfTimes, int DelayInMilliseconds, bool IsBlocking = true)
Parameter (In)
Keycode –
Parameter to hold the data in special key format(Mandatory)
List of possible keys:
Please refer section 5.1(Software-Keyboard Keys)
NumberOfTimes –
Parameter to hold the number of times to repeat the value to be transmitted
(Mandatory)
DelayInMilliseconds –
Parameter to hold the delay in milliseconds for the data to be transmitted
(Mandatory)
bool IsBlocking –
If the provided user key values need to be in blocking state then user need to specify as TRUE, else FALSE(Optional)
By default IsBlocking will be true.
When Isblocking is false then the status of the task execution is read using the API- TaskExecutionStatus:
Call TaskExecutionStatus() and check its state.
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess
string StatusMessage
IsSuccess: Returns true if success else returns false
StatusMessage: Returns success message if true else returns the corresponding error message
Global Data used
None
Global function /macro imported
None
Usage(Powershell)
Usage:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Variables=============
$MouseLabel = "okbutton“
$Keycode = "Enter"
=======Call Initialize API=============
Hardware:
$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel) Software:
$bRet = $oSimulation.Initialize($MouseLabel)
=========Call SendKeyboardSpecialKey API===========
$bRet = $oSimulation.SendKeyboardSpecialKey($Keycode,100,200,$true)
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the SendKeyboardSpecialKey call
SendKeyboardCombinations
Description:
This funciton is used to simulate the keyboard events to the DUT/ AUT with the user given key combinations.
Syntax
public override OutputData<object> SendKeyboardSpecialCombinations(string value, UInt16 delay = 0)
Parameter (In)
value –
Parameter to hold the data in combination format(Mandatory)
List of possible keys:
Please refer section 5.1(Keyboard Keys)
Some of not supported combination keys are mentioned in section 8 and point no 9 (For software simulation)
delay - Parameter to hold the delay in milliseconds for combinations to be transmitted
(Optional)
By default delay will be 0.
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess
string StatusMessage
IsSuccess: Returns true if success else returns false
StatusMessage: Returns empty if true else returns the corresponding error message
Global Data used
None
Global function / macro imported
None
Usage(Powershell)
Usage:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Variables=============
$MouseLabel = "okbutton"
$SerialLabel = " COM3"
$value = "Ctrl+Alt+Delete"‘
$delay = 1000
=========Call Initialize API=============
$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel)
=========Call SendKeyboardCombinations API=============
$bRet = $oSimulation.SendKeyboardCombinations($value)
$bRet = $oSimulation.SendKeyboardCombinations($value, $delay)
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the SendKeyboardCombinations call
SendKeyboardUnicode
Description:
This function is used to simulate the keyboard events to the AUT by giving Character code as parameter.
This API is not supported for hardware simulation.
Syntax
public override OutputData<object> SendKeyboardUnicode(int Charcode)
Parameter (In)
Charcode –
Provide Unicode value for the character(Unicode values can be referd from charcter map)(Mandatory)
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess
string StatusMessage
IsSuccess: Returns true if success else returns false
StatusMessage: Returns empty if true else returns the corresponding error message
Global Data used
None
Global function / macro imported
None
Usage(Powershell)
Usage:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Variables=============
$MouseLabel = "okbutton"
$Charcode = "0x00ae"‘
=========Call Initialize API=============
$bRet = $oSimulation.Initialize($MouseLabel)
=========Call SendKeyboardUnicode API=============
$bRet = $oSimulation.SendKeyboardUnicode($Charcode)
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the SendKeyboardCombinations call
TaskExecutionStatus
Description:
This function is used to get the execution status for keyboard when execution
happens in Non-blocking mode.
Syntax
public override OutputDa<|begin_of_text|>ta<object> TaskExecutionStatus()
Parameter (In)
----- NA -----
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess: Returns true if success else returns false
String StatusMessage: Returns empty if true else returns the corresponding error message
String State :
Three States of TaskExecutionStatus API are:
1.IDLE
2.PROCESSING
3.COMPLETED
Global Data used
None
Global function / macro imported
None
Usage(Powershell)
Usage:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Variables=============
$MouseLabel = "okbutton"
=========Call Initialize API=============
$bRet = $oSimulation.Initialize($MouseLabel)
========Call TaskExecutionStatus API=============
$bRet = $oSimulation.TaskExecutionStatus()
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the SendKeyboardCombinations call
DoMouseActions
Description:
This funciton is used to simulate the mouse events to the DUT/ AUT with the user given mouse actions.
Syntax
public override OutputData<object> DoMouseActions(string label,string action, bool IsSingleClick, bool IsReleaseKey, UInt16 delay = 0, string movetype = "Absolute", bool isEventfunction = true)
Parameter (In)
label - Parameter to hold the Mouse Label (Mandatory)
action –
Parameter to hold the action(Mandatory)
List of possible Action:(Not CaseSensitive)
Left
Right
Middle
Move
bool IsSingleClick-
If the provided user mouse actions need to be single clicked then user need to specify as TRUE, else FALSE(Optional)
By default IsSingleClick will be true.
bool IsReleaseKey –
If the provided user mouse actions need to be released then user need to specify as TRUE, else FALSE(Optional)
By default IsReleaseKey will be true.
delay - Parameter to hold the delay in milliseconds for mouse actions to be transmitted
(Optional)
By default delay will be 0.
movetype - Parameter to hold the move type for mouse move to be transmitted
(Optional)
By default movetype will be Absolute.
List of possible Movetypes:(Not CaseSensitive)
Absolute
Relative
bool isEventfunction-The default value is true.This parameter is only applicable for software simulation only.
If isEventfunction is true,the DoMouseActions function will use MouseEvent function to perform the mouse click operation.
If 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.
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess
string StatusMessage
IsSuccess: Returns true if success else returns false
StatusMessage: Returns empty if true else returns the corresponding | |
null | error message
Global Data used
None
Global function / macro imported
None
Usage(Powershell)
Usage 1:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Variables============
$MouseLabel = " "okbutton"
$SerialLabel = " COM3"
$label = “okbutton“
$action = "move"
$delay = 1000
$movetype = "Relative“
=========Call Initialize API=============
$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel)
=========Call DoMouseActions API=============
$bRet = $oSimulation.DoMouseActions($label,$action,$true,$true)
$bRet = $oSimulation.DoMouseActions($label,$action,$true,$true, $delay,$movetype)
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the DoMouseActions call
Usage 2:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Variables============
$MouseLabel = " "okbutton"
$action = "move"
$delay = 1000
$movetype = "Absolute“
$ isEventfunction=false
=========Call Initialize API=============
$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel)
=========Call DoMouseActions API=============
$oSimulation.DoMouseActions($label,$action,$true,$true, $delay,$movetype, $ isEventfunction)
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the DoMouseActions call
DoMouseClick
Description:
This function is used to simulate the mouse events to the DUT/ AUT with the user given mouse click actions at the current position.
Syntax
public override OutputData<object> DoMouseClick(string action, bool IsSingleClick, bool IsReleaseKey, UInt16 delay = 0)
Parameter (In)
action –
Parameter to hold the action(Mandatory)
List of possible Action:(Not CaseSensitive)
Left
Right
Middle
bool IsSingleClick-
If the provided user mouse actions need to be single clicked then user need to specify as TRUE, else FALSE(Optional)
By default IsSingleClick will be true.
bool IsReleaseKey –
If the provided user mouse actions need to be released then user need to specify as TRUE, else FALSE(Optional)
By default IsReleaseKey will be true.
delay - Parameter to hold the delay in milliseconds for mouse actions to be transmitted
(Optional)
By default delay will be 0.
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess
string StatusMessage
IsSuccess: Returns true if success else returns false
StatusMessage: Returns empty if true else returns the corresponding error message
Global Data used
None
Global function / macro imported
None
Usage(Powershell)
Usage:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Variables============
$MouseLabel = " "okbutton"
$SerialLabel = " COM3"
$action = "left"‘
$delay = 1200
=========Call Initialize API=============
$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel)
=========Call DoMouseClick API=============
$bRet = $oSimulation.DoMouseClick($action,$true,$true)
$bRet = $oSimulation.DoMouseClick($action,$true,$true,$delay)
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the DoMouseActions call
DoRealTimeMouseActions
Description:
This funciton is used to simulate the mouse events to the DUT/ AUT with the user given mouse actions & coordinates at runtime.
Syntax
public override OutputData<object> DoRealTimeMouseActions(int X,int Y,string action, bool IsSingleClick, bool IsReleaseKey, UInt16 delay = 0, string movetype = "Absolute")
Parameter (In)
X – Parameter to hold the x coordinate (Mandatory)
Y - Parameter to hold the y coordinate (Mandatory)
action –
Parameter to hold the action to be transmitted (Mandatory)
List of possible Action:(Not CaseSensitive)
Left
Right
Middle
Move
bool IsSingleClick-
If the provided user mouse actions need to be single clicked then user need to specify as TRUE, else FALSE(Optional)
By default IsSingleClick will be true.
bool IsReleaseKey –
If the provided user mouse actions need to be released then user need to specify as TRUE, else FALSE(Optional)
By default IsReleaseKey will be true.
delay - Parameter to hold the delay in milliseconds for mouse actions to be transmitted
(Optional)
By default delay will be 0.
movetype - Parameter to hold the move type for mouse move to be transmitted
(Optional)
By default movetype will be Absolute.
List of possible Movetypes:(Not CaseSensitive)
A<|begin_of_text|>bsolute
Relative
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess
string StatusMessage
IsSuccess: Returns true if success else returns false
StatusMessage: Returns empty if true else returns the corresponding error message
Global Data used
None
Global function / macro imported
None
Usage(Powershell)
Usage:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Variables============
$MouseLabel = " "okbutton"
$SerialLabel = " COM3"
X = “456“
Y = “545“
$action = "left"‘
$delay = 3000
$movetype = "Absolute“
=========Call Initialize API=============
$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel)
=========Call DoMouseActions API============
$bRet =
$oSimulation. DoRealTimeMouseActions (X,Y,$action,$true,$true)
$bRet =
$oSimulation. DoRealTimeMouseActions (X,Y,$action,$true,$true,$delay,$movetype)
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the DoMouseActions call
DoMouseScroll
Description:
This funciton is used to simulate the mouse events to the DUT/ AUT with the user given scroll actions..
Syntax
public override OutputData<object> DoMouseActions(string action,int NumberOfScrollTimes, UInt16 delay = 0)
Parameter (In)
action –
Parameter to hold the action(Mandatory)
List of possible Action:(Not CaseSensitive)
Up
Down
NumberOfScrollTimes – Parameter to hold the times to perform the scroll action (Mandatory)
delay - Parameter to hold the delay in milliseconds for mouse actions to be transmitted
(Optional)
By default delay will be 0.
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess
string StatusMessage
IsSuccess: Returns true if success else returns false
StatusMessage: Returns empty if true else returns the corresponding error message
Global Data used
None
Global function / macro imported
None
Usage(Powershell)
Usage:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Variables============
$MouseLabel = " "okbutton"
$SerialLabel = " COM3"
$action = "Up“
$NumberOfScrollTimes = 5
$delay = 3000
=========Call Initialize API=============
$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel)
=========Call DoMouseScroll API=============
$bRet = $oSerial.DoMouseScroll($action,$ NumberOfScrollTimes)
$bRet = $oSerial.DoMouseScroll($action,$ NumberOfScrollTimes,$delay)
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the DoMouseScroll call
DoMouseDragDrop(Using Label)
Description:
This funciton is used to simulate the mouse events to the DUT/ AUT with the user given coordinates for drag & drop actions.
Syntax
public override OutputData<object> DoMouseDragDrop(string label, UInt16 delay = 0)
Parameter (In)
label - Parameter to hold any label inside the particular vendor. (Mandatory)
delay - Parameter to hold the delay in milliseconds for mouse actions to be transmitted
(Optional)
By default delay will be 0.
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess
string StatusMessage
IsSuccess: Returns true if success else returns false
StatusMessage: Returns empty if true else returns the corresponding error message
Global Data used
None
Global function / macro imported
None
Usage(Powershell)
Usage:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Variables============
$MouseLabel = " "okbutton"
$SerialLabel = " COM3"
$label = “okbutton“
$delay = 1245
=========Call Initialize API=============
$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel)
=========Call DoMouseDragDrop API=============
$bRet = $oSerial.DoMouseDragDrop($action,$ NumberOfScrollTimes)
$bRet = $oSerial.DoMouseDragDrop($action,$ NumberOfScrollTimes,$delay)
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the DoMouseDragDrop call
DoMouseDragDrop(Using Coordinates)
Description:
This funciton is used to simulate the mouse events to the DUT/ AUT with the user given coordinates at runtime for drag & drop actions.
Syntax
public override OutputData<object> DoMouseDragDrop(int X1,int Y1,int X2,int Y2, UInt16 delay = 0)
Parameter (In)
X1 – Parameter to hold the x1 coordinate (Mandatory)
Y1 - Parameter to hold the y1 coordinate (Mandatory)
X2 – Parameter to hold the x2 coordinate (Mandatory)
Y2 - Parameter to hold the y2 coordinate (Mandatory)
delay - Parameter to hold the delay in milliseconds for mouse actions to be transmitted
(Optional)
By default delay will be 0.
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess
string StatusMessage
IsSuccess: Returns true if success else returns false
StatusMessage: Returns empty if true else returns the corresponding error message
Global Data used
None
Global function / macro imported
None
Usage(Powershell)
Usage:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Variables============
$MouseLabel = " "okbutton"
$SerialLabel = " COM3"
X1 = “456“
Y1 = “545“
X2 = “676“
Y2 = “789“
$delay = 1250
=========Call Initialize API=============
$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel)
=========Call DoMouseDragDrop API(Using Coordinates)=============
$bRet = $oSerial.DoMouseDragDrop(X1,Y1,X2,Y2)
$bRet = $oSerial.DoMouseDragDrop(X1,Y1,X2,Y2,$delay)
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the DoMouseDragDrop call
Release
Description:
This funciton is used to simulate the release action for keyboard & mouse events to the DUT/ AUT with the user given action parameter.
In this API,only mouse release action is supported for software simulation.
Syntax
public override OutputData<object> Release(string action)
Parameter (In)
action –
Parameter to hold the action to be transmitted (Mandatory)
List of possible Action:(Not CaseSensitive)
keyboard
mouse
both
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess
string StatusMessage
IsSuccess: Returns true if success else returns false
StatusMessage: Returns empty if true else returns the corresponding error message
Global Data used
None
Global function / macro imported
None
Usage(Powershell)
Usage:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Variables============
$MouseLabel = "okbutton"
$SerialLabel = " COM3"
$action = " keyboard“
=========Call Initialize API=============
$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel)
=========Call Release API=============
$bRet = $oSerial.Release($action)
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the Release call
GetCommunicationStatus
Description:
This function is used to perform the communication checking operation
This API is not supported for software simulation
Syntax
public override OutputData<object> GetCommunicationStatus()
Parameter (In)
None
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess
string StatusMessage
IsSuccess: Returns true if success else returns false
StatusMessage: Returns success message if true else returns the corresponding error message
Global Data used
None
Global function / macro imported
None
Usage(Powershell)
Usage:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Confi<|begin_of_text|>guration_File)
=========Assign Variables============
$MouseLabel = " "okbutton"
$SerialLabel = " COM3"
=========Call Initialize API=============
$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel)
======Call GetCommunicationStatus API==========
$bRet = $oSimulation.GetCommunicationStatus ()
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the GetCommunicationStatus call
Reset
Description:
This function is used to reset the device
This API is not supported for software simulation
Syntax
public override OutputData<object> Reset ()
Parameter (In)
None
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess
string StatusMessage
IsSuccess: Returns true if success else returns false
StatusMessage: Returns success message if true else returns the corresponding error message
Global Data used
None
Global function / macro imported
None
Usage(Powershell)
Usage:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Variables============
$MouseLabel = " "okbutton"
$SerialLabel = " COM3"
=========Call Initialize API=============
$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel)
=========Call Reset API=============
$bRet = $oSimulation.Reset ()
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the Reset call
Disconnect
Description:
Hardware simulation:
This function used to disconnect the communication port.
Software simulation:
This function used to dispose the objects.
Syntax
public override OutputData<object> Disconnect()
Parameter (In)
None
Parameter (Out)
None
Return Value
OutputData:
bool IsSuccess
string StatusMessage
IsSuccess: Returns true if success else returns false
StatusMessage: Returns success message if true else returns the corresponding error message
Global Data used
None
Global function / macro imported
None
Usage(Powershell)
Usage:
Object creation :
$oSimulation=New-Object Hcl.eDAT.Custom.Controller. KeyboardMouseController($Configuration_File)
=========Assign Variables============
$MouseLabel = " "okbutton"
$SerialLabel = " COM3"
=========Call Initialize API=============
$bRet = $oSimulation.Initialize($MouseLabel,$SerialLabel)
=========Call Disconnect API=============
$bRet = $oSimulation.Disconnect()
Write-Host $bRet.IsSuccess : Prints the message True/False
Write-Host $bRet.StatusMessage : Prints the status of the Disconnect call
|
No dataset card yet
New: Create and edit this dataset card directly on the website!
Contribute a Dataset Card- Downloads last month
- 4