Differences

This shows you the differences between two versions of the page.

--- soplarpet:opcua_methods [2024/11/14 11:07] – created superuser
+++ soplarpet:opcua_methods [2024/12/20 14:03] (current) – superuser
@@ Line 2: / Line 2: @@
 ===== ListCameras =====
-Returns a list of loaded camera configurations
+Returns an array of loaded camera configurations
-*Note:* both arrays wil contain the same list. since camera names feature was canceled
+**Note:** both arrays will contain the same list since the camera names feature was canceled.
 **Input Arguments**
   * None
 **Output Arguments**
-  * cameraIds (IList<string>) - A list of camera IDs
+  * cameraIds (string[]) - An array of camera IDs
-  * cameraNames (IList<string>) - A list of camera names
+  * cameraNames (string[]) - An array of camera names
 ===== LearnNewObject =====
 Learns new pattern for all cameras to look for
 **Input Arguments**
   * image (byte[]) - The image data containing the new object
-  * roiCoordinates (IList<int>) - The region of interest coordinates
+  * roiCoordinates (int[]) - The region of interest coordinates in px, specified in format [X1,Y1,X2,Y2]
-  * upperBorder (int) - The upper border value of search area
+  * upperBorder (int) - The upper border value of search area in px.
-  * lowerBorder (int) - The lower border value of search area
+  * lowerBorder (int) - The lower border value of search area in px.
 **Output Arguments**
@@ Line 23: / Line 26: @@
 ===== LearnNewObjectPerCamera =====
-Learns new pattern for specified camera. Also allows to set offset that adds to x coordinate of detected pattern
+Learns new pattern for a specified camera. Also allows setting an offset that adds to the x-coordinate of the detected pattern.
 **Input Arguments**
   * imageWithNewObject (byte[]) - The image data containing the new object
-  * regionOfInterest (int[]) - The region of interest coordinates
+  * regionOfInterest (int[]) - The region of interest coordinates in px, specified in format [X1,Y1,X2,Y2]
   * upperBorderLineYPos (int) - The upper border value of search area
   * lowerBorderLineYPos (int) - The lower border value of search area
-  * offset (int) - The offset value
+  * offset (int) - The offset value in px. When pattern is detected, it's center X coordinate will be returned as a result. Offset allows to shift this coordinates. If pattern is detected between X10 and X20 and offset is -2 then result would be X13(X15-2)
   * camera (int) - The camera identifier
@@ Line 36: / Line 40: @@
 ===== ReadCameraParameters =====
-Returs parameter names for specified camera
+Returns parameter names for a specified camera
 **Input Arguments**
   * cameraNameOrId (string) - The camera name or ID
 **Output Arguments**
-  * parameterNames (IList<string>) - A list of parameter names
+  * parameterNames (string[]) - An array of parameter names
-  * parameterValues (IList<string>) - A list of parameter values
+  * parameterValues (string[]) - An array of parameter values
 ===== WriteCameraParameters =====
-Sets parameters for specified camera
+Sets parameters for a specified camera
 **Input Arguments**
   * cameraIdOrName (string) - The camera ID or name
-  * parameterNames (IList<object>) - A list of parameter names
+  * parameterNames (object[]) - An array of parameter names
-  * parameterValues (IList<object>) - A list of parameter values
+  * parameterValues (object[]) - An array of parameter values
 **Output Arguments**
@@ Line 55: / Line 61: @@
 ===== GetMarkerParametersPerCamera =====
-Returns serialized parameters of learned marker for later use
+Returns serialized parameters of the learned marker for later use
 **Input Arguments**
   * camera (int) - The camera identifier
@@ Line 63: / Line 70: @@
 ===== GetImageById =====
-Returns an image that was made by camera for specified trigger id
+Returns an image that was made by a camera for the specified trigger ID
 **Input Arguments**
   * imageId (string) - The image ID
@@ Line 74: / Line 82: @@
 ===== GetMinimalRecognitionAccuracy =====
-Returns minimal recognition accuracy for marker to be accepted as valid
+Returns the minimal recognition accuracy for a marker to be accepted as valid
 **Input Arguments**
   * None
 **Output Arguments**
-  * accuracy (int) - The minimal recognition accuracy
+  * accuracy (int) - The minimal recognition accuracy in %
 ===== SetMinimalRecognitionAccuracy =====
-Sets minimal recognition accuracy for marker to be accepted as valid
+Sets the minimal recognition accuracy for a marker to be accepted as valid
 **Input Arguments**
-  * accuracy (int) - The minimal recognition accuracy
+  * accuracy (int) - The minimal recognition accuracy in %
 **Output Arguments**
   * None
+===== GetErrorTable=====
+Sets the minimal recognition accuracy for a marker to be accepted as valid
+**Input Arguments**
+  * None
+**Output Arguments**
+  * result (string) - json serialized error table
+Detailed output specified [[soplarpet:error_table|here]]
+===== Restart =====
+Restarts the application
+**Input Arguments**
+  * None
+**Output Arguments**
+  * None
+===== ShutdownComputer =====
+Shuts down the computer
+**Input Arguments**
+  * None
+**Output Arguments**
+  * None
+===== RestartComputer =====
+Restarts the computer
+**Input Arguments**
+  * None
+**Output Arguments**
+  * None