soplarpet:opcua_methods [Inspectron docs]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== OPCUA methods ======

===== ListCameras =====
Returns an array of loaded camera configurations

**Note:** both arrays will contain the same list since the camera names feature was canceled.

**Input Arguments**
  * None

**Output Arguments**
  * cameraIds (string[]) - An array of camera IDs
  * 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 (int[]) - The region of interest coordinates in px, specified in format [X1,Y1,X2,Y2]
  * upperBorder (int) - The upper border value of search area in px.
  * lowerBorder (int) - The lower border value of search area in px.

**Output Arguments**
  * None

===== LearnNewObjectPerCamera =====
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 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 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

**Output Arguments**
  * None

===== ReadCameraParameters =====
Returns parameter names for a specified camera

**Input Arguments**
  * cameraNameOrId (string) - The camera name or ID

**Output Arguments**
  * parameterNames (string[]) - An array of parameter names
  * parameterValues (string[]) - An array of parameter values

===== WriteCameraParameters =====
Sets parameters for a specified camera

**Input Arguments**
  * cameraIdOrName (string) - The camera ID or name
  * parameterNames (object[]) - An array of parameter names
  * parameterValues (object[]) - An array of parameter values

**Output Arguments**
  * None

===== GetMarkerParametersPerCamera =====
Returns serialized parameters of the learned marker for later use

**Input Arguments**
  * camera (int) - The camera identifier

**Output Arguments**
  * parameters (string) - The marker parameters

===== GetImageById =====
Returns an image that was made by a camera for the specified trigger ID

**Input Arguments**
  * imageId (string) - The image ID
  * camId (string) - The camera ID

**Output Arguments**
  * filename (string) - The filename of the image
  * image (byte[]) - The image data
  * metadata (string) - The image metadata

===== GetMinimalRecognitionAccuracy =====
Returns the minimal recognition accuracy for a marker to be accepted as valid

**Input Arguments**
  * None

**Output Arguments**
  * accuracy (int) - The minimal recognition accuracy in %

===== SetMinimalRecognitionAccuracy =====
Sets the minimal recognition accuracy for a marker to be accepted as valid

**Input Arguments**
  * 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