KEMBAR78
FQ2 Net Control Reference Manual | PDF | 64 Bit Computing | Ip Address
0% found this document useful (0 votes)
262 views168 pages

FQ2 Net Control Reference Manual

Fq2 net control

Uploaded by

Djebbi Sami
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
262 views168 pages

FQ2 Net Control Reference Manual

Fq2 net control

Uploaded by

Djebbi Sami
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 168

Smart Camera

FQ2-S/CH Series

.NET Control Reference Manual

1st Edition, 2015/04/01

©Copyright OMRON Corporation 2015 All Rights Reserved.

Cat. No. Q225I-E-01


Introduction
This manual provides information that is required to use .NET Controls with the FQ2-S/CH.
When using the FQ2-S/CH, be sure to observe the following:
• Read and understand this manual to ensure correct use of the product.
• Keep this manual in a safe place for reference whenever necessary.

• All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or
transmitted, in any form, or by any means, mechanical, electronic, photocopying, recording, or
otherwise, without the prior written permission of OMRON.
• No patent liability is assumed with respect to the use of the information contained herein.
Moreover, because OMRON is constantly striving to improve its high-quality products, the
information contained in this manual is subject to change without notice.
• Every precaution has been taken in the preparation of this manual. Nevertheless, OMRON
assumes no responsibility for errors or omissions. Neither is any liability assumed for damages
resulting from the use of the information contained in this publication.

Trademarks
・Intel and Core are trademarks of Intel Corporation in the USA and other countries.
・Microsoft, Visual Studio, Visual Basic, Visual C#, and Windows are either registered trademarks or
trademarks of Microsoft Corporation in the USA and other countries.
 Other company names and product names in this document are the trademarks or registered
trademarks of their respective companies.

Microsoft product screen shots are reprinted with permission from Microsoft Corporation.

Related Manuals
The information required to use the FQ2-S/CH Series is divided into two manuals: "FQ2-S/CH Series
User's Manual" (Cat. No. Z337) and "FQ2-S/CH Series User's Manual for Communications Settings"
(Cat. No. Z338). Read each manual as appropriate for your needs.

Manual Description Contents


Product specifications
Connections, wiring
Describes the product specifications,
FQ2-S/CH Series User's Camera, image adjustment
basic settings, and other information
Manual (Cat. No. Z337) Inspection item settings
required to use the FQ2-S/CH Series.
Test measurement, operation
Troubleshooting
System configuration
Sensor control method
FQ2-S/CH Series User's
Provides information required to Data input/output specifications
Manual for Communications
operate the sensor by remote control. Connectable network types
Settings (Cat. No. Z338)
Communication settings
Output data settings

2
Contents

1 Overview of .NET Controls .............................................4


2 Recommended System....................................................4
3 Required Environment ......................................................4
4 Supported Development Languages ..........................4
5 Overview of Functions .....................................................4
6 Specifications Restrictions............................................5
7 Procedures ...........................................................................5
7-1 Adding Controls to an Application ..........................5
7-2 Executing the Application ..........................................9
8 Appendix.............................................................................12
8-1 How to Use .NET Controls ......................................12
8-2 How to Specify Items................................................27
8-3 System Data List........................................................28
8-4 Figure Data List...........................................................29
8-4-1 Figure Data Structure List..................................29
8-4-2 List of Figure Data Array Elements.................30
8-5 API List ...........................................................................36
8-6 External Reference Parameters ........................163
Revision History ..............................................................166
.NET Control Reference Manual

1 Overview of .NET Controls


.NET Controls are custom controls that enable easy display of measurement images and results of
the FQ2-S/CH series in an application created using Microsoft Visual Studio.
By simply adding custom controls to the application, you can show measurement images and
measurement results of the FQ2-S/CH series.

2 Recommended System
CPU: CPU with Intel Streaming SIMD Extensions, SSE2 or higher and adapted to the system
requirements of OS to be used, Visual Studio and .NET Framework
OS: Windows 7 Professional (32 bit)
Windows 8.1 Pro (32 bit)
.NET Framework: .NET Framework 3.5
Monitor screen: XGA (1024 × 768), True Color (32 bit) or higher
Memory: 2 GB or more of RAM
Free hard disk space: 2 GB or more

*When Windows8.1 pro is used for OS, the installation of NET Framework3.5 is required.

3 Required Environment
Microsoft Visual Studio 2008, 2010, 2012 or 2013
FQ2 Sensor with firmware version 1.91 or later

4 Supported Development Languages


Visual Basic .NET
Visual C#

5 Overview of Functions
.NET Controls consists of the following custom controls.

Control (function name) Description


Executes communication between the created application and the
connected FQ2 sensor.
You can use CoreRA to detect FQ2 sensor events and control the
CoreRA FQ2 sensor through the API.
(sensor control) Controls other than CoreRA and SensorListWindow connect to
the FQ2 sensor through CoreRA.
To use .NET controls other than CoreRA and SensorListWindow,
the controls must be added.
ImageWindow Displays the measurement image of the specified item.
(image display)

4
.NET Control Reference Manual
Control (function name) Description
TextWindow Displays the measurement results of the specified item.
(detailed result display)
SensorListWindow Finds FQ2 sensors on the network and shows a list of
(sensor detection) information.
JudgeWindow Displays the overall OK/NG judgement, measurement time,
(overall judgement) execution mode, scene name, and scene number.
FlowWindow
Displays the flow* of the current scene. The flow cannot be edited.
(flow display)
TrendGraphWindow
Displays the trend monitor.
(trend monitor)
HistogramWindow
Displays histograms.
(histogram)
MeasureWindow
Provides a user interface for measurement and remeasurement.
(measurement) 
 *The processes required for image inspection are combined into a package on the FQ2 sensor. The sequence
of the processes in the package, in order of execution, is called a flow.

6 Specifications Restrictions
Note the restriction below when using .NET Control.

A maximum of two CoreRA controls or Touch Finders can be connected to one FQ2 sensor. An error
will occur if you attempt to connect a third CoreRA control or Touch Finder.

7 Procedures
This section describes the procedures for adding controls to an application and executing the
application.

7-1 Adding Controls to an Application

Follow the procedure below to add a .NET Control to an application form.


Procedure
(1) Open the form application project in Visual Studio.
(2) To add a .NET Control to the toolbox, drag "Omron.FQ-Control.dll" to "General" (outlined in red
below) of the toolbox of Visual Studio.

5
.NET Control Reference Manual
(3) Position and mount the .NET Controls that you added to the application form.
Select each control in the toolbox and drag to the application form.

The controls are added to Form Designer as indicated in the red frame below.
■CoreRA Control

■ImageWindow Control  

6
.NET Control Reference Manual
■TextWindow Control

■SensorListWindow Control

■JudgeWindow Control

7
.NET Control Reference Manual
■FlowWindow Control

■TrendGraphWindow Control

■HistgramWindow Control

8
.NET Control Reference Manual
■MeasureWindow Control 

*For the procedures for using each control, refer to "8-1. How to Use .NET Controls". (Reference:
How to Use .NET Controls (p. 12))

■Changing the Language


 You can use the codes below (Visual Basic .NET) to set the language for all custom controls in
the application. If a code is not set, the language will be Japanese.

- Japanese
 Public Class Form1
 Public Sub New()
 System.Threading.Thread.CurrentThread.CurrentUICulture _
  = System.Globalization.CultureInfo.GetCultureInfo("ja-JP")
 InitializeComponent()
 End Sub
 End Class

- English
 Public Class Form1
 Public Sub New()
 System.Threading.Thread.CurrentThread.CurrentUICulture _
  = System.Globalization.CultureInfo.GetCultureInfo("en-US")
 InitializeComponent()
 End Sub
 End Class

7-2 Executing the Application

This section explains the procedure for executing the application.


The files and folders below must be in the same folder as the executable file for the application.
The language folder can be in any location.

9
.NET Control Reference Manual
File Description
Omron.FQ-Control.dll
Omron.FQ-Control.
PlatformCLR.dll
Omron.FQ-Control.
Dll required for use of .NET Controls.
Resources.dll
Omron.FQ-Control.
ViewModels.dll
Omron.FQ-Control.
VisionComm.dll
ja-JP folder Folder required for display of Japanese with .NET Controls.
Folder required for display of Chinese (simplified) with .NET
zh-CN folder
Controls.
Folder required for display of Chinese (traditional) with .NET
zh-TW folder
Controls.
de-DE folder Folder required for display of German with .NET Controls.
es-ES folder Folder required for display of Spanish with .NET Controls.
fr-FR folder Folder required for display of French with .NET Controls.
it-IT folder Folder required for display of Italian with .NET Controls.
ko-KR folder Folder required for display of Korean with .NET Controls.
System.Windows.Forms.
Dll required for display of graphs with .NET Controls.
DataVisualization.dll

Different versions of Omron.FQ-Control.dll are required for 32 bit and 64 bit operating systems. Use
the appropriate Omron.FQ-Control.dll for your system. Acceptable combinations of operating
system, application, and Omron.FQ-Control.dll are indicated below.

Application Operation mode of


OS FQ-Control.dll used
project platform process
32 bit Any CPU 32-bit process 32 bit
32 bit x86 32-bit process 32 bit
64 bit Any CPU 64-bit process 64 bit
32-bit process
64 bit x86 32 bit
(WOW64)
64 bit x64 64-bit process 64 bit

■FQ2 Sensor Connection and Disconnection (Specifying an IP Address)


(1) Start the FQ2 sensor to be connected to the application.
(2) Start the application.
(3) Set the properties (IP address) of the CoreRA control in the application.
(4) Call up the ConnectStart method of the CoreRA control and connect the application to the FQ2
sensor.
Example: When the button is pressed, set the CoreRA control properties and connect to the FQ2
sensor.
 (Visual Basic.NET)
Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs)
Handles Button1.Click

10
.NET Control Reference Manual
 'Setting property.
 Me.CoreRA1.IpAddress = "10.5.5.100"

 'Connect to FQ2-S.
 Me.CoreRA1.ConnectStart()

End Sub

■FQ2 Sensor Connection (Connecting After Finding Sensor)


(1) Start the FQ2 sensor to be connected to the application.
(2) Start the application.
(3) Call up the SearchSensor method of the SensorListWindow control, and search for FQ2 sensors
on the network.
(4) Acquire the properties (IP address) using the SensorListUpdated event of the SensorListWindow
control in the application, and set in the properties (IP address) of the CoreRA control.
(5) Call up the ConnectSensor method of the CoreRA control, and connect the application to the
FQ2 sensor.

Example: When the button is pressed, search for FQ2 sensors on the network using the
SensorListWindow control. Set the properties (IP address) of the CoreRA control using the
SensorListUpdated event of the SensorListWindow control, and connect to the FQ2 sensor.
(Visual Basic.NET)
Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs)
Handles Button1.Click

'Search for sensors on the network.


Me.SensorListWindow1.SearchSensor()

End Sub

Private Function SensorListWindow1_SensorListUpdated(ByVal sender As System.Object) As


System.Int32 Handles SensorListWindow1.SensorListUpdated

If Me.SensorListWindow1.SensorIpList.Count > 0 Then


'A sensor was detected.

'Setting property.
Me.CoreRA1.IpAddress = Me.SensorListWindow1.SensorIpList(0)

'Connect to FQ2-S.
Me.CoreRA1.ConnectStart()

Else
'A sensor was not detected.
End If
End Function

11
.NET Control Reference Manual
■ Disconnecting from the FQ2 Sensor

(1) Call up the ConnectSensor method of the CoreRA control, and disconnect the application from
the FQ2 sensor.

Example: When the button is pressed, disconnect from the FQ2 sensor.
(Visual Basic.NET)
Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs)
Handles Button2.Click

'Disconnect to FQ2-S.
Me.CoreRA1.Disconnect()

End Sub

8 Appendix
This section explains how to use .NET controls in an application and specify items, and describes
system data, graphic data, APIs, and external reference parameters.

8-1 How to Use .NET Controls

This section explains how to use .NET Controls Values enclosed in brackets [ ] are default values.
● CoreRA Control

・Function
Executes communication between the created application and the connected FQ2 sensor.

・Properties
Property Type Set/Get Description
Specifies the IP address of the FQ2 sensor to
IpAddress String Set/Get
which the application will connect.
Returns the connection status. (Read-only.)  
IsConnected Boolean Get only True: Connected
 False: Not connected
Specify the resolution of transmitted measurement
Set/Get images (X direction). (Units: px)
DispImageTransferSize Integer
Setting range
0 to 999999 [320]
Specify whether logging is enabled or disabled.  
Set to True when using the trend monitor or
histograms.
 False: No logging
 [True: Logging]
Boolean Set/Get
LoggingEnabled
When two Touch Finder or FQ control units are
connected to one sensor, logging is only possible
on one of the units. When two controls with the
logging function turned ON are connected to the
sensor, the logging function turns OFF on the
control that was connected last.

12
.NET Control Reference Manual
Property Type Set/Get Description
Specify whether image logging is enabled or
Boolean Set/Get disabled.
ImageLoggingFileSave
 [False: No image logging]
 True: Image logging
Specify the prefix of the image logging file. [img]
The sum of this string and the ImageLoggingDirectory
ImageLoggingPrefix String Set/Get string cannot exceed 200 characters.
The following characters cannot be used:
 / \ : , * ? " < > |
Enable or disable data logging.
Boolean Set/Get
DataLoggingFileSave  [False: No logging]
 True: Logging
Specify the prefix of the data logging file. [None]
The sum of this string and the
DataLoggingDirectory string cannot exceed 200
DataLoggingPrefix String Set/Get
characters.
The following characters cannot be used:
 / \ : , * ? " < > |
Specify the path to the save location of the
logging image file. [None]
The sum of this string and the
ImageLoggingDirectory String Set/Get ImageLoggingPrefix string cannot exceed 200
characters.
The following characters cannot be used:
 / \ : , * ? " < > |
Specify the path to the save location of the
logging data file. [None]
The sum of this string and the
DataLoggingDirectory String Set/Get DataLoggingPrefix string cannot exceed 200
characters.
The following characters cannot be used:
 / \ : , * ? " < > |
Specify the field separator used in the logging
data.
 None
 [Comma]
Set/Get  Tab
FieldSeparator Delimiter
 Space
 Colon
 SemiColon
 CR
 CRLF
Specify the record separator used in the logging
data.
 None
 Comma
Delimiter Set/Get  Tab
RecordSeparator
 Space
 Colon
 SemiColon
 CR
 [CRLF]
Specify the decimal point symbol used in the
logging data.
Decimal
DecimalSymbol Set/Get  None
Point
 Comma
 [Period]

13
.NET Control Reference Manual
・Methods
Method Description
Format:
Function ConnectStart(ByVal myIp As String) As
Omron.FQ_Control.ConnectionState

Parameters:
 myIP IP address of FQ2 sensor

Return values:
 Connection: Success = 0
 Specified path does not exist: DirectoryNotFoundError = 1
ConnectStart  Failed to connect: InvalidArgumentError = 3

Description:
Connect to the FQ2 sensor according to the property settings.
When connection is successful, the ImageWindow, TextWindow,
JudgeWindow, FlowWindow, TrendGraphWindow, HistogramWindow,
and MeasureWindow controls show FQ2 sensor measurement
information and settings.

If the application for the connected FQ2 sensor is not running, an


application without a main form is started.
Format: Function Disconnect() As Integer

Parameters:
None

Disconnect Return values:


Disconnected from sensor: 0
No connected sensor: -1

Description:
Disconnects from the FQ2 sensor.

For other methods of controlling the FQ2 sensor, refer to "8-5 API List".
(Reference: 8-5 API List (p.32))

・Events
Event Description
Occurs when connection to the FQ2 sensor by the ConnectStart method is
ProcessStarted
successful.
ProcessClosed Occurs when the connection with the FQ2 sensor is broken.
Occurs when one of the FQ2 errors below occurs.
・Connection number over : 0x02110102
ErrorProc
・Connection failure : 0x02110104
・File output error : 0x02140600
Occurs when measurement result display processing is executed on the FQ2
MeasureDisp
sensor.
SceneChange Occurs when scene change processing is executed on the FQ2 sensor.
RunModeChange Occurs when the run mode of the FQ2 sensor is changed.

14
.NET Control Reference Manual
● ImageWindow Control

・Function
Displays the measurement result image of the specified item.
To open the setting window, click the square in the upper left corner of the control.

・Display image

・Setting window

・Properties
Property Type Set/Get Description
ConnectCoreRAComponent CoreRA Set/Get Specify the CoreRA control used for connection.
Specify the coordinates of the upper left corner of
the displayed image, with the coordinates relative
System.Dra Set/Get
ImageOrigin to the upper left corner of the window.
wing.Point
Setting range
 (-9999, -9999) to (9999, 9999) [(0,0)]
Specify whether the image window is shown or
Set/Get hidden.
ImageVisible Integer
 0: Hide window
 [1: Show window]
Specify the image magnification.
Specify the magnification using a real number. For
example, to reduce the size of the image by one-
half, specify "0.5". To double the size of the image,
Set/Get
Magnification Double specify "2.0".
To automatically adjust the image to the size of
the window, specify "-1".
Setting range
 -1 to 12.0 [-1]

15
.NET Control Reference Manual
Property Type Set/Get Description
Specify the type of processing item that is
displayed.
 [ITEM_CAMERA (0) image input item]
Set/Get
ItemKind ITEM KIND  ITEM_COMPENSATION (1) image adjustment
item
 ITEM_MEASURE (2) inspection item
 ITEM_OUTPUT (3) output item (calculation)
Specify the sub-number of the processing item
that is displayed.
To activate position list mode and show the
Set/Get
SubNo Integer measurement regions of all inspection items,
specify "-1".
Setting range
 -1 to 100 [0]
Specify the number of the processing item that is
displayed.
Setting range
 0 to 31 [0]
Set/Get
ItemNo Integer The setting range varies by processing item type.
 0 only (image input item)
 0 to 7 (image adjustment item)
 0 to 31 (inspection item)
 0 only (output item (calculation))
Link to flow display
Set/Get  0: Display the item specified by ItemKind and
FollowFlow Integer
ItemNo.
 [1: Display the item selected in FlowWindow.]
Specify the image update timing during operation.
UPDATE
Set/Get  [LATEST]: (0) Display the most recent
UpdateImageRun IMAGE
measurement image
SETUP
 LAST NG: (1) Display the most recent NG image
Specify the image update timing during
UPDATE adjustment.
Set/Get
UpdateImageSetup IMAGE  [FREEZE]: (0) Update at each measurement
SETUP  THROUGH: (1) Update continuously (live
display)
Window number (0 only)
Set/Get
WindowNo Integer Setting range
0 only [0]

・Methods
Method Description
Format:
Protected Overridable Sub pictureBox_MouseDown(ByVal sender As
Object, ByVal e As System.Windows.Forms.MouseEventArgs)

Parameters:
 Sender Source object of event 
 e Mouse movement information
pictureBox_MouseDown

Return value:
None

Description:
By overriding with a derived class, you can redefine the MouseDown
event handler of the image display part of the image window.

16
.NET Control Reference Manual
Method Description
Format:
Protected Overridable Sub pictureBox_MouseUp(ByVal sender As
Object, ByVal e As System.Windows.Forms.MouseEventArgs)

Parameters:
 Sender Source object of event
 e Mouse movement information
pictureBox_MouseUp
Return value:
None

Description:
By overriding with a derived class, you can redefine the MouseUp event
handler of the image display part of the image window.
Format:
Protected Overridable Sub pictureBox_MouseMove(ByVal sender As
Object, ByVal e As System.Windows.Forms.MouseEventArgs)

Parameters:
 Sender Source object of event
 e Mouse movement information
pictureBox_MouseDown
Return value:
None

Description:
By overriding with a derived class, you can redefine the MouseMove
event handler of the image display part of the image window.

・Events
Event Description
Occurs when the image display part of the image window is
ImageWindowPictureClick
clicked.
Occurs when the image display part of the image window is
ImageWindowPicturePaint
redrawn.

● TextWindow Control

・Function
Displays the detailed results of the item specified in the item type or display item properties.
To open the setting window, click the square in the upper right corner of the control.

・Display image

17
.NET Control Reference Manual
・Setting window

・Properties
Property Type Set/Get Description
Set/Get
ConnectCoreRAComponent CoreRA Specify the CoreRA control used for connection.

Specify the type of processing item that is


displayed.
 [ITEM_CAMERA (0) image input item]
Set/Get
ItemKind ITEM KIND  ITEM_COMPENSATION (1) image adjustment
item
 ITEM_MEASURE (2) inspection item
 ITEM_OUTPUT (3) output item (calculation)
Specify the number of the processing item that is
displayed.
Setting range
 0 to 31 [0]
Set/Get
ItemNo Integer The setting range varies by processing item type.
 0 only (image input item)
 0 to 7 (image adjustment item)
 0 to 31 (inspection item)
 0 only (output item (calculation))
Link to flow display
Set/Get
 0: Display the item specified by ItemKind and
FollowFlow Integer
ItemNo.
 [1: Display the item selected in FlowWindow.]
Specify the font size of the display text. (Units:
Set/Get px)
FontSize Float
Setting range
 8 to 72 [10]

● SensorListWindow Control

・Function
Finds FQ2 sensors on the network and shows a list of information.
You can also use this control to configure network settings of FQ2 sensors that are found.

・Searches for sensors and shows a list of the FQ2 sensors that are found on the network.
・Sensors that have already been connected are not detected.
・You can acquire the sensor information, MAC address, and IP address of detected sensors.
・You can select a sensor from the list and set auto IP address assignment or configure network
settings.

18
.NET Control Reference Manual
・Display image

・Properties
Property Type Set/Get Description
Found sensor information
SensorInformation
 {string Mac: MAC address
System.Coll
 string Name: Sensor name
ections.Gen
 string IPAddress: IP address
eric.List(Of
Get only  string SubnetMask: Subnet mask
SensorInfoList Omron.
 string Defaultgateway: Default gateway
FQ_Control.
string Version: Software version
SensorInfor
 string Model: Model
mation)
bool IPSettingAuto: Sensor IP setting method
(auto/manual)
}
System.Coll
ections.Gen Get only
SensorMacList List of MAC addresses of found sensors
eric.List(
Of String)
System.Coll
ections.Gen
SensorIpList Get only List of IP addresses of found sensors
eric.List(
Of String)
System.Coll
ections.Gen
CheckedIndeces Get only Index of checked sensors
eric.List(
Of String)
SelectedIndex Integer Get only Index of selected sensors
Specify the font size of the display text. (Units:
Set/Get
px)
FontSize Single
Setting range
8 to 64 [9]

・Methods
Method Description
Format:
Sub SearchSensor(ByVal myIp As String)

Parameters:
 myIP IP address to be used (if omitted, the IP address is automatically
selected from a valid local area connection)
SearchSensor

Return value:
None

Description:
Searches for sensors on the network and updates the sensor list.

19
.NET Control Reference Manual
Method Description
Format:
Sub IpAutoSetting(ByVal indeces As
System.Collections.Generic.List(Of Integer),
ByVal myIp As String)
Parameters:
indeces: Sensor list index (if omitted, CheckedIndeces is used)
myIP: IP address to be used (if omitted, the IP address is automatically
IpAutoSetting selected from a valid local area connection)

Return value:
None

Description:
Assigns IP addresses to sensors whose IP setting method is "Auto" in
the sensor list.
Format:
Sub NetworkSetting(ByVal index As Integer, ByVal ip As String, ByVal
subnet As String, ByVal gateway As String, ByVal option As Integer,
ByVal myIp As String)

Parameters:
indeces: Sensor list index (if omitted, CheckedIndeces is used)
ip: IP address to be changed
subnet: Subnet mask to be changed
NetworkSetting gateway: Default gateway to be changed
option: 0: None, 1: Save in sensor
myIP: IP address to be used (if omitted, the IP address is automatically
selected from a valid local area connection)

Return value:
None

Description:
Changes the network settings of the sensors in the sensor list.

・Event
Event Description
SensorListUpdated Occurs when the sensor list is updated

● JudgeWindow Control

・Function
 Displays the overall judgement, measurement time, current scene number, scene name, and
execution mode.

・Display image

20
.NET Control Reference Manual
・Properties
Property Type Set/Get Description
Set/Get
ConnectCoreRAComponent CoreRA Specify the CoreRA control used for connection.

Specify the font size of the judgement string.


Set/Get (Units: px)
JudgeFontSize Single
Setting range
 8 to 64 [64]
Coordinates of the upper left corner of the
System.Dra Set/Get judgement string
JudgeLocation
wing.Point Setting range
 (-32768, -32768) to (32767, 32767) [(0,0)]
Set/Get Judgement string display
JudgeVisible Boolean  [True: Show]
 False: Hide
Specify the font size of the measurement time
Set/Get string. (Units: px)
TimeFontSize Single
Setting range
 8 to 64 [20]
Coordinates of the upper left corner of the
measurement time string
System.Dra Set/Get
TimeLocation Setting range
wing.Point
 (-32768, -32768) to (32767, 32767)
[(164, 70)]
Set/Get Measurement time string display
TimeVisible Boolean  [True: Show]
 False: Hide
Specify the font size of the measurement mode
Set/Get string. (Units: px)
ModeFontSize Single
Setting range
 8 to 64 [25]
Coordinates of the upper left corner of the
System.Dra measurement mode string
Set/Get
ModeLocation wing.Point Setting range
 (-32768, -32768) to (32767, 32767)
[(212, 11)]
Set/Get Measurement mode string display
ModeVisible Boolean  [True: Show]
 False: Hide
Specify the font size of the scene name string.
Set/Get (Units: px)
SceneFontSize Single
Setting range
 8 to 64 [20]
Coordinates of the upper left corner of the scene
name string
System.Dra Set/Get
SceneLocation Setting range
wing.Point
 (-32768, -32768) to (32767, 32767)
[(287, 70)]
Scene name string display
SceneVisible Boolean Set/Get  [True: Show]
 False: Hide

・Event
Event Description
JudgeWindowClick Occurs when JudgeWindow is clicked.

21
.NET Control Reference Manual
● FlowWindow Control

・Function
Displays the flow of the current scene.
This control also displays a list of the processing items in the current scene, along with icons, item
names, and judgement results (OK/NG) for each item.
For ImageWindow and TextWindow, if you specify "Link to flow display" in these properties and click
a flow, the display in each window will be updated in sync with the selected flow.

・Display image

・Properties
Property Type Set/Get Description
Set/Get
ConnectCoreRAComponent CoreRA Specify the CoreRA control used for connection.

Specify the size (height) of items to be displayed


Set/Get in the flow list.
ItemHeight Integer
Setting range
16 to 128 [48]
Specify the font size of the item name. (Units: px)
Set/Get
FontSize Single Setting range
8 to 64 [12]
Get only Get the total number of items currently on
FlowItemCount Integer
FlowWindow.
Get only Gets the identifiers of items currently on
SelectedItemIdent Integer
FlowWindow.
SelectedItemKind ITEM KIND Get only Get the type of items currently on FlowWindow.
Get the item numbers of items currently on
SelectedItemNo Integer Get only
FlowWindow.

・Event
Event Description
ItemButtonClick Occurs when the item button is clicked.

● TrendGraphWindow Control

・Function
 Displays a trend monitor of the item data selected in the properties.
The trend monitor plots up to 1,000 points of data per graph line. Measurement data is always
added to the right of the graph. If the number of points specified in the horizontal axis range

22
.NET Control Reference Manual
parameter is already plotted, the latest data will be added to the right end. The existing data points
will be shifted to the left.
To open the setting window, click the square in the upper left corner of the control.
The trend monitor shows up to three lines simultaneously.
If you change the items or data that are displayed, the data of the previously shown items or data
are not discarded.
To show the trend monitor, enable the logging settings of the CoreRA control that is used for
connection.

・Display image

・Setting window

・Properties
Property Type Set/Get Description
Set/Get
ConnectCoreRAComponent CoreRA Specify the CoreRA control used for connection.

LINESETTI Set/Get
LineSetting Graph line settings, 3 lines
NG
Show/hide setting
Set/Get
GraphVisible Integer   [0: Hide line]
  1: Show line
Line color
System.Dra
Set/Get Setting range
LineColor wing.Color
  (R, G, B) = (0, 0, 0) to (255, 255, 255)
 [(255, 0, 0)]
Line thickness
LineWidth Integer Set/Get Setting range
1 to 10 [1]

23
.NET Control Reference Manual
Property Type Set/Get Description
Processing item type
 [ITEM_CAMERA (0) image input item]
 ITEM_COMPENSATION (1) image adjustment
ItemKind ITEM KIND Set/Get
item
 ITEM_MEASURE (2) inspection item
 ITEM_OUTPUT (3) output item (calculation)
Specify the number of the processing item that is
displayed.
Setting range
 0 to 31 [0]
ItemNo Integer Set/Get The setting range varies by processing item type.
 0 only (image input item)
 0 to 7 (image adjustment item)
 0 to 31 (inspection item)
 0 only (output item (calculation))
Data number of data to be displayed
Set/Get
DataNo Integer Setting range
 0 to 99999 [0]
Data number of multi-measurement data
Set/Get
MultiDataNo Integer Setting range
 0 to 99 [0]
Lower limit of vertical axis
Set/Get Setting range
MinValue Double
 -999999999.9999 to 999999999.9999
[-999999999.9999]
Upper limit of vertical axis
Set/Get Setting range
MaxValue Double
 -999999999.9999 to 999999999.9999
[999999999.9999]
Horizontal axis range
Setting range
 [COUNT_100]
 COUNT_200
 COUNT_300
Set/Get  COUNT_400
DisplayMaximum Dmaximum
 COUNT_500
 COUNT_600
 COUNT_700
 COUNT_800
 COUNT_900
 COUNT_1000
Specify the font size of the axis scale. (Units: px)
FontSize Single Set/Get Setting range
 8 to 64 [10]

● HistogramWindow Control

・Function
 Displays a histogram of the item data selected in the properties.
You can plot up to 1,000 points of data.
To open the setting window, click the square in the upper left corner of the control.
To show the trend monitor, enable the logging settings of the CoreRA control that is used for
connection.

24
.NET Control Reference Manual
・Display image

・Setting window

・Properties
Property Type Set/Get Description
Set/Get
ConnectCoreRAComponent CoreRA Specify the CoreRA control used for connection.

Bar color
System.Dra Set/Get Setting range
BarColor
wing.Color   (R, G, B) = (0, 0, 0) to (255, 255, 255)
 [(0, 0, 255)]
Processing item type
 [ITEM_CAMERA (0) image input item]
Set/Get  ITEM_COMPENSATION (1) image adjustment
ItemKind ITEM KIND
item
 ITEM_MEASURE (2) inspection item
 ITEM_OUTPUT (3) output item (calculation)
Specify the number of the processing item that is
displayed.
Setting range
 0 to 31 [0]
Set/Get
ItemNo Integer The setting range varies by processing item type.
 0 only (image input item)
 0 to 7 (image adjustment item)
 0 to 31 (inspection item)
 0 only (output item (calculation))
Data number of data to be displayed
DataNo Integer Set/Get Setting range
 0 to 99999 [0]
Data number of multi-measurement data
MultiDataNo Integer Set/Get Setting range
 0 to 99 [0]

25
.NET Control Reference Manual
Property Type Set/Get Description
Lower limit of horizontal axis
Setting range
MinValue Double Set/Get
 -999999999.9999 to 999999999.9999
 [-999999999.9999]
Upper limit of horizontal axis
Set/Get Setting range
MaxValue Double
-999999999.9999 to 999999999.9999
[999999999.9999]
Vertical axis range
Setting range
 [COUNT_100]
 COUNT_200
 COUNT_300
Set/Get  COUNT_400
YAxis DMaximum
 COUNT_500
 COUNT_600
 COUNT_700
 COUNT_800
 COUNT_900
 COUNT_1000
Skipping width
Set/Get
StepSize Integer Setting range
 1 to 10000 [10]
Specify the font size of the axis scale. (Units: px)
Set/Get
FontSize Single Setting range
 8 to 64 [10]

● MeasureWindow Control

・Function
 In the run window, the control remeasures the camera images. In the setup window, the control
measures or remeasures the camera images, the logging images, and the file images.
File formats of image files you can remeasure are ifz and bmp.

・Display image

26
.NET Control Reference Manual
・Properties
Property Type Set/Get Description
Set/Get
ConnectCoreRAComponent CoreRA Specify the CoreRA control used for connection.

8-2 How to Specify Items

 To specify a target item, use the item type number and the item number. The item number is
assigned in order of item registration for items of that type.

Item type (item type


Item
number)
Image input (0) Camera image input
Color gray filter, weak smoothing, strong smoothing, dilate,
erosion, median, extract edges, extract horizontal edges,
extract vertical edges, enhance edges, background
suppression, shape search position compensation, search
Image adjustment (1)
position compensation, edge position compensation, two-
edge position compensation, two-edge midpoint
compensation, edge rotation position compensation, and
position compensation
OCR, barcode, 2D-code, 2D-code (DPM), search, sensitive
Inspection (2) search, shape search II, edge position, edge width, edge
pitch, area, color data, labeling
Calculation (3) Calculation

 For details on the inspection items and image adjustment items, refer to the user's manual.

Example:
 Specify a processing item in the following processing flow of the FQ2 sensor

Image input (0)


 0: Camera image input
Image adjustment (1)
 0: Edge position compensation
 1: Weak smoothing
Inspection items (2)
 0. Search
 1. Shape search II
 2. OCR
Output item (calculation) (3)
 0. Calculation

To specify shape search II as the target item, specify as follows:


 Item type number: 2 (inspection)
 Item number: 1 (shape search II)

27
.NET Control Reference Manual
8-3 System Data List

The identification information and data identifiers that are required to set or get system data are
shown below.

Identification information 0 Identification information 1 Data identifier


--- Configuration
Configuration Startup scene control saveSceneStart
Startup scene number initialSceneNo
--- CameraControl
Camera control
Trigger delay cameraDelay0
--- MeasureControl
Measurement control
BUSY output condition BusyControl
--- Logging
Image data imageLogging
Logging control
Measurement data dataLogging
Statistical data totalLogging
--- ParallelIo
OR output polarity
Output delay riseTime
Judgement output mode orOutMode
One-shot output time orOutputTime
OUT0 polarity out0Polarity
Parallel control OUT1 polarity out1Polarity
OUT2 polarity out2Polarity
OUT0 signal assignment out0Control
OUT1 signal assignment out1Control
OUT2 signal assignment out2Control
Input mode commandMode
LED BUSY busyLedControl
--- Retry
Switch order (scene switching) retryChangeSceneMethod
Retry function
Switch order (target scene) retryChangeSceneArray
Timeout time retryTimeout

28
.NET Control Reference Manual
Identification information 0 Identification information 1 Data identifier
--- Sdu1
OR output orOutJudge
Judgement output mode orOutMode
OR output delay orRiseTime
OR one-shot output time orOutputTime

Parallel Interface Sensor Output control handshake


Data Unit Output period cycleTime
GATE ON delay riseTime
Output time outputTime
Timeout timeout
Number of delay delayCount
ACK signal ON period ackOutputTime
--- Sdu2
OR output orOutJudge
Judgement output mode orOutMode
RS-232C Interface Sensor OR output delay time orRiseTime
Data Unit
OR one-shot output time orOutputTime
ALL OUT signals polarity outPolarity
Parallel command mode commandMode
ACK signal ON period ackOutputTime

8-4 Figure Data List

To set or get a model figure or region figure held in a processing unit, use an array to specify the
figure data.

8-4-1 Figure Data Structure List

The structure of figure data is indicated below.

Array element Description Description


Contains figure data header information. Includes the number
of figures and figure data size information.
Upper 16 bits: Number of figures
Figure data header
figure(0) Lower 16 bits: Number of bytes of figure data size (figure
information
array length x 4)
Figure data header information = Number of bytes of figure
data size + Number of figure data x 65536
Type information of figure 0 data. Includes drawing mode and
figure type information.
Upper 16 bits: Drawing mode
figure(1) Figure 0 type information
Lower 16 bits: Figure type
Figure type information = Figure type + Drawing mode x
65536
Figure data of figure 0. The size and content depend on the figure
figure(2) Figure 0 data
type.

29
.NET Control Reference Manual
Array element Description Description
Figure data of figure 0. The size and content depend on the figure
figure(3) Figure 0 data
type.
... ...

...

...
Figure 1 type information Type information of figure 1 data.
...

Figure data of figure 1. The size and content depend on the figure
Figure 1 data
type.
... ...

...

...
Figure N type information Type information of figure N data.
...

Figure data of figure N. The size and content depend on the figure
Figure N data
type.
...

...

...
The following shows an example of a data structure that is composed of multiple figures (rectangles
and polygons).
aaa
Array element Description
figure(0) Figure data header information
figure(1) Figure type information: Rectangle
figure(2) X-coordinate of upper left point
figure(3) Y-coordinate of upper left point
figure(4) X-coordinate of lower right point
figure(5) Y-coordinate of lower right point
figure(6) Figure type information: Polygon
figure(7) Number of vertices
figure(8) X-coordinate of first point
figure(9) Y-coordinate of first point
figure(10) X-coordinate of second point
figure(11) Y-coordinate of second point
. .
. .
. .
figure(24) X-coordinate of ninth point
figure(25) Y-coordinate of ninth point
figure(26) X-coordinate of tenth point
figure(27) Y-coordinate of tenth point

8-4-2 List of Figure Data Array Elements

The array elements of each figure and corresponding settings are shown below. The information
shown in the table is for a figure count of 1.

30
.NET Control Reference Manual
Figure Array
Figure Description
type element
figure(0) Figure data header information
figure(1) Figure type information
figure(2) X-coordinate of first point
Wide line 4 figure(3) Y-coordinate of first point
figure(4) X-coordinate of second point
figure(5) Y-coordinate of second point
figure(6) Width
figure(0) Figure data header information
figure(1) Figure type information
figure(2) X-coordinate of upper left point
Rectangle 8
figure(3) Y-coordinate of upper left point
figure(4) X-coordinate of lower right point
figure(5) Y-coordinate of lower right point
figure(0) Figure data header information
figure(1) Figure type information
figure(2) X-coordinate of center point
Ellipse 16
figure(3) Y-coordinate of center point
figure(4) Radius on X-axis
figure(5) Radius on Y-axis
figure(0) Figure data header information
figure(1) Figure type information
figure(2) X-coordinate of center point
Wide circle 64
figure(3) Y-coordinate of center point
figure(4) Radius
figure(5) Width
figure(0) Figure data header information
figure(1) Figure type information
figure(2) Number of vertices
figure(3) X-coordinate of first point
figure(4) Y-coordinate of first point
figure(5) X-coordinate of second point

Polygon 512 figure(6) Y-coordinate of second point


. .
. .
. .
figure(19) X-coordinate of ninth point
figure(20) Y-coordinate of ninth point
figure(21) X-coordinate of tenth point
figure(22) Y-coordinate of tenth point

31
.NET Control Reference Manual
8-5 API List

The following table shows APIs that can be used.


Alphabetical Order

API name Function Classification References


Reference: 
AssignMeasureItem Adds an inspection item. Flow Control
Details (p.41)
Reference: 
AssignPositionItem Adds an image adjustment item. Flow Control
Details (p.43)
Processing Reference: 
CalculationData Gets numerical data of a calculation.
Item Control Details (p.45)
Gets character string data of a Processing Reference: 
CalculationData2
calculation. Item Control Details (p.46)
Gets numerical data of camera Processing Reference: 
CameraData
parameters. Item Control Details (p.47)
Reference:  Details
ChangeScene Changes the scene. Scene Control
(p.48)
Reference:  Details
ClearError Clears an error. Other
(p.49)
Clears measurement results of a Reference:  Details
ClearMeasureData Other
processing item. (p.50)
Reference:  Details
ClearScene Clears scene data. Scene Control
(p.51)
Reference:  Details
ClearTotalData Clears statistical data. Other
(p.52)
Reference:  Details
CopyMeasureItem Copies an inspection item. Flow Control
(p.53)
Reference:  Details
CopyPositionItem Copies an image adjustment item. Flow Control
(p.54)
Reference:  Details
CopyScene Copies scene data. Scene Control
(p.55)
Reference:  Details
DeleteMeasureItem Deletes an inspection item. Flow Control
(p.56)
Reference:  Details
DeletePositionItem Deletes an image adjustment item. Flow Control
(p.57)
Gets the input statuses of all input IO Module Reference:  Details
GetAll
terminals. Control (p.58)
Gets the software version of the Reference:  Details
GetApplicationVersion Other
sensor. (p.60)
Processing Reference:  Details
GetCalculationData Gets calculation data.
Item Control (p.61)
Processing Reference:  Details
GetCameraData Gets data of camera parameters.
Item Control (p.63)
Gets the most recent sensor error Reference:  Details
GetErrorCode Other
code. (p.65)
Gets data output by link data / Processing Reference:  Details
GetLinkOutputData
Fieldbus data communication. Item Control (p.66)
Processing Reference:  Details
GetMeasureItemData Gets data of an inspection item.
Item Control (p.68)

32
.NET Control Reference Manual
API name Function Classification References
Gets figure data registered in an Processing Reference:  Details
GetMeasureItemFigure
inspection item. Item Control (p.70)
Gets the external output setting for Measurement Reference:  Details
GetMeasureOut
measurement results. Control (p.71)
Gets data output by no protocol data Processing Reference:  Details
GetNoprotocolOutputData
communication. Item Control (p.72)
Gets data output by parallel data Processing Reference:  Details
GetParallelData
communication. Item Control (p.73)
Gets data output by parallel Processing Reference:  Details
GetParallelJudgeData
judgement output. Item Control (p.74)
Gets the input status of a specified IO Module Reference:  Details
GetPort
input terminal. Control (p.76)
Gets data of an image adjustment Processing Reference:  Details
GetPositionItemData
item. Item Control (p.78)
Gets figure data of an image Processing Reference:  Details
GetPositionItemFigure
adjustment item. Item Control (p.79)
Processing Reference:  Details
GetRetryData Gets retry data.
Item Control (p.80)
Gets the execution status (execution Measurement Reference:  Details
GetRunMode
mode) of the FQ2 sensor. Control (p.82)
Reference:  Details
GetSystemData Gets system data. System Data
(p.83)
Reference:  Details
GetTotalData Gets statistical data. Other
(p.84)
Updates the image input from the Measurement Reference:  Details
ImageUpdate
camera. Control (p.85)
IO Module Reference:  Details
IOMonitorStart Starts the IO monitor.
Control (p.86)
IO Module Reference:  Details
IOMonitorStop Terminates the IO monitor.
Control (p.87)
Gets numerical data output by link Processing Reference:  Details
LinkOutputData
data / Fieldbus data communication. Item Control (p.88)
Gets character string data output by
Processing Reference:  Details
LinkOutputData2 link data / Fieldbus data
Item Control (p.89)
communication.
Loads all setting data (all scene
Data Save/ Reference:  Details
LoadBackupData data, system data, and calibration
Load (p.90)
group data).
Data Save/ Reference:  Details
LoadScene Loads scene data.
Load (p.91)
Data Save/ Reference:  Details
LoadSceneGroup Loads scene group data.
Load (p.92)
Data Save/ Reference:  Details
LoadSystemData Loads system data.
Load (p.93)
Measurement Reference:  Details
Measure Executes measurement processing.
Control (p.94)
Reference:  Details
MeasureItemCount Gets the number of inspection items. Flow Control
(p.95)
Gets numerical data of an inspection Processing Reference:  Details
MeasureItemData
item. Item Control (p.96)

33
.NET Control Reference Manual
API name Function Classification References
Gets character string data of an Processing Reference:  Details
MeasureItemData2
inspection item. Item Control (p.97)
Gets the identifier of a registered Processing Reference:  Details
MeasureItemIdent
inspection item. Item Control (p.98)
Gets the judgement result of an Measurement Reference:  Details
MeasureItemJudge
inspection item. Control (p.99)
Processing Reference:  Details
MeasureItemTitle Gets the title of an inspection item
Item Control (p.100)
Gets numerical data output by no Processing Reference:  Details
NoprotocolOutputData
protocol data communication. Item Control (p.101)
Gets character string data by no Processing Reference:  Details
NoprotocolOutputData2
protocol data communication. Item Control (p.102)
Gets numerical data output by Processing Reference:  Details
ParallelData
parallel data communication. Item Control (p.103)
Gets character string data output by Processing Reference:  Details
ParallelData2
parallel data communication. Item Control (p.104)
Gets numerical data output by Processing Reference:  Details
ParallelJudgeData
parallel judgement output. Item Control (p.105)
Gets string data output by parallel Processing Reference:  Details
ParallelJudgeData2
judgement output. Item Control (p.106)
Gets the number of image adjustment Reference:  Details
PositionItemCount Flow Control
items. (p.107)
Gets numerical data of an image Processing Reference:  Details
PositionItemData
adjustment item. Item Control (p.108)
Gets the identifier of a registered Processing Reference:  Details
PositionItemIdent
image adjustment item. Item Control (p.109)
Gets the judgement result of an Measurement Reference:  Details
PositionItemJudge
image adjustment item. Control (p.110)
Gets the title of an image adjustment Processing Reference:  Details
PositionItemTitle
item. Item Control (p.111)
Sets the output statuses of all output IO Module Reference:  Details
PutAll
terminals. Control (p.112)
Sets the output status of a specified IO Module Reference:  Details
PutPort
output terminal. Control (p.114)
Updates the image display window Display Reference:  Details
RefreshImageWindow
and text display window. Control (p.116)
Measurement Reference:  Details
ReMeasure Executes remeasurement.
Control (p.117)
Processing Reference:  Details
RetryData Gets numerical data related to retry.
Item Control (p.119)
Sets the output status of the RUN IO Module Reference:  Details
RunOut
signal Control (p.120)
Saves all setting data (all scene
Data Save/ Reference:  Details
SaveBackupData data, system data, and calibration
Load (p.121)
group data) of the sensor to a file.
Data Save/ Reference:  Details
SaveData Saves all setting data in the sensor.
Load (p.122)
Measurement Reference:  Details
SaveImage Saves image data.
Control (p.123)

34
.NET Control Reference Manual
API name Function Classification References
Saves measurement data saved in
Reference:  Details
SaveLoggingData the sensor memory by the logging Other
(p.124)
function to a file.
Data Save/ Reference:  Details
SaveScene Saves scene data.
Load (p.125)
Data Save/ Reference:  Details
SaveSceneGroup Saves the scene group data.
Load (p.126)
Data Save/ Reference:  Details
SaveSystemData Saves system data.
Load (p.127)
Gets the number of scenes that can Reference:  Details
SceneCount Scene Control
be used. (p.128)
Gets the scene number of the current Reference:  Details
SceneNo Scene Control
scene. (p.129)
Reference:  Details
SceneTitle Gets the scene title. Scene Control
(p.130)
Reference:  Details
SensorName Gets the sensor name. System Data
(p.131)
Processing Reference:  Details
SetCalculationData Sets calculation data.
Item Control (p.132)
Processing Reference:  Details
SetCameraData Sets camera parameter data.
Item Control (p.134)
Sets the data output by link data / Processing Reference:  Details
SetLinkOutputData
Fieldbus data communication. Item Control (p.136)
Processing Reference:  Details
SetMeasureItemData Sets the data of an inspection item.
Item Control (p.138)
Sets the figure data of an inspection Processing Reference:  Details
SetMeasureItemFigure
item. Item Control (p.140)
Processing Reference:  Details
SetMeasureItemTitle Sets the title of an inspection item
Item Control (p.142)
Sets whether or not measurement
Measurement Reference:  Details
SetMeasureOut results are output to an external
Control (p.143)
device.
Sets the data that are output by no Processing Reference:  Details
SetNoprotocolOutputData
protocol communication. Item Control (p.144)
Reference:  Details
SetSensorName Sets the sensor name. System Data
(p.158)
Sets the data that are output by Processing Reference:  Details
SetParallelData
parallel data communication. Item Control (p.146)
Sets the data that are output by Processing Reference:  Details
SetParallelJudgeData
parallel judgement output. Item Control (p.148)
Sets the data of an image adjustment Processing Reference:  Details
SetPositionItemData
item. Item Control (p.150)
Sets the figure data of an image Processing Reference:  Details
SetPositionItemFigure
adjustment item. Item Control (p.152)
Sets the title of an image adjustment Processing Reference:  Details
SetPositionItemTitle
item Item Control (p.154)
Processing Reference:  Details
SetRetryData Sets the retry data.
Item Control (p.155)
Sets the execution status (execution Measurement Reference:  Details
SetRunMode
mode) of the sensor. Control (p.156)

35
.NET Control Reference Manual
API name Function Classification References
Reference:  Details
SetSceneTitle Sets the title of a scene. Scene Control
(p.157)
Reference:  Details
SetSystemData Sets the system data. System Data
(p.159)
Reference:  Details
SystemReset Reboots the sensor. Other
(p.160)
Performs teaching for a specified Processing Reference:  Details
TeachMeasureItem
inspection item. Item Control (p.161)
Performs teaching for a specified Processing Reference:  Details
TeachPositionItem
image adjustment item. Item Control (p.162)

36
.NET Control Reference Manual
Function-based Index

●Scene Controls
API name Function References
ChangeScene Changes the scene. Reference:  Details (p.48)
ClearScene Clears scene data. Reference:  Details (p.51)
CopyScene Copies scene data. Reference:  Details (p.55)
SceneCount Gets the number of scenes that can be used. Reference:  Details (p.128)
SceneNo Gets the scene number of the current scene. Reference:  Details (p.129)
SceneTitle Gets the scene title. Reference:  Details (p.130)
SetSceneTitle Sets the title of a scene. Reference:  Details (p.157)

●Processing Flow Controls

API name Function References


AssignMeasureItem Adds an inspection item. Reference:  Details (p.41)
AssignPositionItem Adds an image adjustment item. Reference:  Details (p.43)
CopyMeasureItem Copies an inspection item. Reference:  Details (p.53)
CopyPositionItem Copies an image adjustment item. Reference:  Details (p.54)
DeleteMeasureItem Deletes an inspection item. Reference:  Details (p.56)
DeletePositionItem Deletes an image adjustment item. Reference:  Details (p.57)
MeasureItemCount Gets the number of inspection items. Reference:  Details (p.95)
PositionItemCount Gets the number of image adjustment items. Reference:  Details (p.107)

●Processing item control

API name Function References


CalculationData Gets numerical data of a calculation. Reference:  Details (p.45)
CalculationData2 Gets character string data of a calculation. Reference:  Details (p.46)
CameraData Gets numerical data of camera parameters. Reference:  Details (p.47)
GetCalculationData Gets calculation data. Reference:  Details (p.61)
GetCameraData Gets data of camera parameters. Reference:  Details (p.63)
Gets data output by link data / Fieldbus data
GetLinkOutputData Reference:  Details (p.66)
communication.
GetMeasureItemData Gets data of an inspection item. Reference:  Details (p.68)
GetMeasureItemFigure Gets figure data registered in an inspection item. Reference:  Details (p.70)
Gets data output by no protocol data
GetNoprotocolOutputData Reference:  Details (p.72)
communication.
GetParallelData Gets data output by parallel data communication. Reference:  Details (p.73)
GetParallelJudgeData Gets data output by parallel judgement output. Reference:  Details (p.74)
GetPositionItemData Gets data of an image adjustment item. Reference:  Details (p.78)
GetPositionItemFigure Gets figure data of an image adjustment item. Reference:  Details (p.79)
GetRetryData Gets retry data. Reference:  Details (p.80)
Gets numerical data output by link data / Fieldbus
LinkOutputData Reference:  Details (p.88)
data communication.

37
.NET Control Reference Manual
API name Function References
Gets character string data output by link data /
LinkOutputData2 Reference:  Details (p.89)
Fieldbus data communication.
MeasureItemData Gets numerical data of an inspection item. Reference:  Details (p.96)
MeasureItemData2 Gets character string data of an inspection item. Reference:  Details (p.97)
Gets the identifiers of the registered inspection
MeasureItemIdent Reference:  Details (p.98)
items.
MeasureItemTitle Gets the title of an inspection item Reference:  Details (p.100)
Gets numerical data output by no protocol data
NoprotocolOutputData Reference:  Details (p.101)
communication.
Gets character string data by no protocol data
NoprotocolOutputData2 Reference:  Details (p.102)
communication.
Gets numerical data output by parallel data
ParallelData Reference:  Details (p.103)
communication.
Gets character string data output by parallel data
ParallelData2 Reference:  Details (p.104)
communication.
Gets numerical data output by parallel judgement
ParallelJudgeData Reference:  Details (p.105)
output.
Gets string data output by parallel judgement
ParallelJudgeData2 Reference:  Details (p.106)
output.
PositionItemData Gets numerical data of an image adjustment item. Reference:  Details (p.108)
Gets the identifier of a registered image adjustment
PositionItemIdent Reference:  Details (p.109)
item.
PositionItemTitle Gets the title of an image adjustment item Reference:  Details (p.111)
RetryData Gets the numerical data of a retry. Reference:  Details (p.119)
SetCalculationData Sets calculation data. Reference:  Details (p.132)
SetCameraData Sets camera parameter data. Reference:  Details (p.134)
Sets the data output by link data / Fieldbus data
SetLinkOutputData Reference:  Details (p.136)
communication.
SetMeasureItemData Sets the data of an inspection item. Reference:  Details (p.138)
SetMeasureItemFigure Sets the figure data of an inspection item. Reference:  Details (p.140)
SetMeasureItemTitle Sets the title of an inspection item Reference:  Details (p.142)
Sets the data that are output by no protocol
SetNoprotocolOutputData Reference:  Details (p.144)
communication.
Sets the data that are output by parallel data
SetParallelData Reference:  Details (p.146)
communication.
Sets the data that are output by parallel judgement
SetParallelJudgeData Reference:  Details (p.148)
output.
SetPositionItemData Sets the data of an image adjustment item. Reference:  Details (p.150)
SetPositionItemFigure Sets the figure data of an image adjustment item. Reference:  Details (p.152)
SetPositionItemTitle Sets the title of an image adjustment item Reference:  Details (p.154)
SetRetryData Sets the retry data. Reference:  Details (p.155)
TeachMeasureItem Performs teaching for a specified inspection item. Reference:  Details (p.161)
Performs teaching for a specified image adjustment
TeachPositionItem Reference:  Details (p.162)
item.

38
.NET Control Reference Manual
●Measurement Controls

API name Function References


ClearMeasureData Clears measurement results of a processing item. Reference:  Details (p.50)
Gets the external output setting for measurement
GetMeasureOut Reference:  Details (p.71)
results.
ImageUpdate Updates the image input from the camera. Reference:  Details (p.85)
Gets the execution status (execution mode) of the
GetRunMode Reference:  Details (p.82)
FQ2 sensor.
Measure Executes measurement processing. Reference:  Details (p.94)
MeasureItemJudge Gets the judgement result of an inspection item. Reference:  Details (p.99)
Gets the judgement result of an image adjustment
PositionItemJudge Reference:  Details (p.110)
item.
ReMeasure Executes remeasurement. Reference:  Details (p.117)
SaveImage Saves image data. Reference:  Details (p.123)
Sets whether or not measurement results are output
SetMeasureOut Reference:  Details (p.143)
to an external device.
Sets the execution status (execution mode) of the
SetRunMode Reference:  Details (p.156)
FQ2 sensor.

●IO Module Controls

API name Function References


GetAll Gets the input statuses of all input terminals. Reference:  Details (p.58)
GetPort Gets the input status of a specified input terminal. Reference:  Details (p.76)
IOMonitorStart Starts the IO monitor. Reference:  Details (p.86)
IOMonitorStop Terminates the IO monitor. Reference:  Details (p.87)
PutAll Sets the output statuses of all output terminals. Reference:  Details (p.112)
Sets the output status of a specified output
PutPort Reference:  Details (p.114)
terminal.
RunOut Sets the output status of the RUN signal. Reference:  Details (p.120)

●Display Controls

API name Function References


Updates the image display window and text display
RefreshImageWindow Reference:  Details (p.116)
window.

●System Data

API name Function References


GetSystemData Gets system data. Reference:  Details (p.83)
SensorName Gets the sensor name. Reference:  Details (p.131)
SetSensorName Sets the sensor name. Reference:  Details (p.158)
SetSystemData Sets the system data. Reference:  Details (p.159)

39
.NET Control Reference Manual
●Data Save/Load

API name Function References


Loads all setting data (all scene data, system data,
LoadBackupData Reference:  Details (p.90)
and calibration group data).
LoadScene Loads scene data. Reference:  Details (p.91)
LoadSceneGroup Loads scene group data. Reference:  Details (p.92)
LoadSystemData Loads system data. Reference:  Details (p.93)
Saves all setting data (all scene data, system data,
SaveBackupData Reference:  Details (p.121)
and calibration group data) of the sensor to a file.
SaveData Saves all setting data of the FQ2 sensor. Reference:  Details (p.122)
SaveScene Saves scene data. Reference:  Details (p.125)
SaveSceneGroup Saves the scene group data. Reference:  Details (p.126)
SaveSystemData Saves system data. Reference:  Details (p.127)

●Others

API name Function References


ClearError Clears an error. Reference:  Details (p.49)
ClearTotalData Clears statistical data. Reference:  Details (p.52)
GetApplicationVersion Gets the software version of the sensor. Reference:  Details (p.60)
GetErrorCode Gets the most recent sensor error code. Reference:  Details (p.65)
GetTotalData Gets statistical data. Reference:  Details (p.84)
Saves measurement data saved in the sensor
SaveLoggingData Reference:  Details (p.124)
memory by the logging function to a file.
SystemReset Reboots the sensor. Reference:  Details (p.160)

40
.NET Control Reference Manual
8-5-1AssignMeasureItem

Adds an inspection item.

Format
Function AssignMeasureItem(ByVal itemIdent As String) As Integer
Parameter
Parameter
Data type Description
name
itemIdent String Identifier of the processing item to be registered as an inspection item

Return value
Error code (0: Normal, -1: Error)

Description
Adds an inspection item with identifier specified in the <itemIdent> parameter to the end of the
measurement flow. You can add up to 32 inspection items.
The inspection item identifiers are shown below.

Inspection item Inspection item identifier


OCR OCR
Barcode Barcode
2D-code 2DCode
2D-code (DPM) 2dcrV400
Search Search
Sensitive search SensitiveSearch
Shape search II ShapeSearch2
Edge position EdgePosition
Edge width EdgeWidth
Edge pitch EdgePitch
Area ColorArea
Color data ColorData
Labeling ColorLabeling

Usage Cautions
・ This command is only valid in setup mode.
Example
Add a search processing item to the end of the measurement flow.

Me.CoreRA1.SetRunMode(2)
'Add the search processing item.
Dim ret As Integer = Me.CoreRA1.AssignMeasureItem("Search")
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

41
.NET Control Reference Manual
Related Items
CopyMeasureItem (Reference:  Details (p.53)) DeleteMeasureItem
(Reference:  Details (p.56))
GetRunMode (Reference:  Details (p.82)) MeasureItemCount
(Reference:  Details (p.95))
SetRunMode (Reference:  Details (p.156))

42
.NET Control Reference Manual
8-5-2 AssignPositionItem

Adds an image adjustment item.

Format
Function AssignPositionItem(ByVal itemident As String) As Integer

Parameter
Parameter
Data type Description
name
<itemIdent> String Identifier of the image adjustment item to be added as an inspection item

Return value
Error code (0: Normal, -1: Error)

Description
Add an image adjustment item with identifier specified in the <itemIdent> parameter to the end of
the measurement flow for image adjustment items. You can add up to 8 image adjustment items.

The image adjustment item identifiers are shown below.

Image adjustment item Image adjustment item identifier


Color gray filter FilterColorGray
Weak smoothing WeakSmoothing
Strong smoothing StrongSmoothing
Dilate Dilate
Erosion Erosion
Median Median
Extract edges ExtractEdges
Extract horizontal edges ExtractHorizontalEdges
Extract vertical edges ExtractVerticalEdges
Enhance edges EnhanceEdges
Background suppression FilterHighContrast
Shape search position compensation ShapeMdlScroll
Search position compensation ModelScroll
Edge position compensation EdgePosScrl
Two-edge position compensation 2EdgePosScrl
Two-edge midpoint compensation 2EdgeMidPosScrl
Edge rotation position compensation EdgeRotPosScrl
Position compensation Scroll

Usage Cautions
・ This command is only valid in setup mode.
Example
Add a position compensation processing item to the end of the measurement flow for image

43
.NET Control Reference Manual
adjustment items.
Me.CoreRA1.SetRunMode(2)
'Add the position compensation processing item.
Dim ret As Integer = Me.CoreRA1.AssignPositionItem("Scroll")
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
CopyPositionItem (Reference:  Details (p.54)) DeletePositionItem
(Reference:  Details (p.57))
GetRunMode (Reference:  Details (p.82)) PositionItemCount
(Reference:  Details (p.107))
SetRunMode (Reference:  Details (p.156))

44
.NET Control Reference Manual
8-5-3 CalculationData

Gets numerical data of a calculation.

Format
Function CalculationData(ByVal dataNo As Integer) As Double

Parameter
Parameter
Data type Description
name
External reference data number of the calculation (Reference: 8-6
<dataNo> Integer
External Reference Parameters (p.163))

Return value
Returns the calculation data as a double precision floating point decimal value.
Returns -1 if an error occurs.

Description
Gets numerical data of a calculation.

Usage Cautions
・ None.
Example
Gets numerical data of a calculation.
'Get external reference data No. 0 (judgement) of the calculation.
Dim data As Double = Me.CoreRA1.CalculationData(0)

Supported Versions
Version 1.91 or later

Related Items
CalculationData2 (Reference:  Details (p.46)) GetCalculationData
(Reference:  Details (p.61))
SetCalculationData
(Reference:  Details (p.82))

45
.NET Control Reference Manual
8-5-4 CalculationData2

Gets character string data of a calculation.

Format
Function CalculationData2(ByVal dataNo As Integer, ByVal type As Integer) As
String

Parameter
Parameter
Data type Description
name
External reference data number of the calculation (Reference: 8-6
<dataNo> Integer
External Reference Parameters (p.163))
<type> Integer Type of character string (0: char, 1: TCHAR)

Return value
Returns character string calculation data.
Returns null if an error occurs.

Description
Gets character string data of a calculation.

Usage Cautions
・ None.
Example
Gets character string data of a calculation.
'Get external reference data No. 150 (expression 0) of the calculation.
Dim data As String = Me.CoreRA1.CalculationData2(150, 0)

Supported Versions
Version 1.91 or later

Related Items
CalculationData (Reference:  Details (p.45)) GetCalculationData
(Reference:  Details (p.61))
SetCalculationData
(Reference:  Details (p.82))

46
.NET Control Reference Manual
8-5-5 CameraData

Gets numerical data of a camera parameter.

Format
Function CameraData(ByVal dataNo As Integer) As Double

Parameter
Parameter
Data type Description
name
<dataNo> Integer Camera parameter number

Return value
Returns a camera parameter as a double precision floating point decimal value.
Returns -1 if an error occurs.

Description
Gets numerical data of a camera parameter.
For the camera parameter numbers, refer to "Camera parameter numbers" in FQ2-S/CH Series
User's Manual for Communications Settings (Cat. No. Z338).

Usage Cautions
・ None.

Example
Gets the data of camera parameter No. 1 (shutter speed).
Dim data As Double = Me.CoreRA1.CameraData(1)

Supported Versions
Version 1.91 or later

Related Items
GetCameraData (Reference:  Details (p.63)) SetCameraData (Reference:  Details (p.134))

47
.NET Control Reference Manual
8-5-6 ChangeScene

Changes a scene.

Format
Function ChangeScene(ByVal sceneNo As Integer) As Integer

Parameter
Parameter
Data type Description
name
<sceneNo> Integer Scene number of destination scene (0 to 31)

Return value
Error code (0: Normal, -1: Error)

Description
Changes the current scene to the scene with the scene number specified in the <sceneNo>
parameter.

Usage Cautions
・ None.

Example
Change the current scene to scene No. 2.

Dim ret As Integer = Me.CoreRA1.ChangeScene(2)

Supported Versions
Version 1.91 or later

Related Items
GetRunMode (Reference:  Details (p.82)) SceneCount (Reference:  Details (p.128))
SceneNo (Reference:  Details (p.129)) SetRunMode (Reference:  Details (p.156))

48
.NET Control Reference Manual
8-5-7 ClearError

Clears an error.

Format
Function ClearError() As Integer

Parameter

 None

Return value
Error code (0: Normal, -1: Error)

Description
Clears an error.

Usage Cautions
・ None.

Example
Clears an error.

Dim ret As Integer = Me.CoreRA1.ClearError()

Supported Versions
Version 1.91 or later

Related Items
GetErrorCode (Reference:  Details (p.65))

49
.NET Control Reference Manual
8-5-8 ClearMeasureData

Clears the measurement results of a processing item.

Format
Function ClearMeasureData() As Integer

Parameter
None.

Return value
Error code (0: Normal, -1: Error)

Description
Clears all measurement results of a processing item.

Usage Cautions
・ None.

Example
Clears all measurement results of a processing item.
'Clear the measurement results.
Dim ret As Integer = Me.CoreRA1.ClearMeasureData()

Supported Versions
Version 1.91 or later

Related Items
 None

50
.NET Control Reference Manual
8-5-9 ClearScene

Clears scene data.

Format
Function ClearScene(ByVal sceneNo As Integer) As Integer

Parameter
Parameter
Data type Description
name
<sceneNo> Integer Scene number of scene to be cleared (0 to 31)

Return value
Error code (0: Normal, -1: Error)

Description
Clears the setting information in the scene with the scene number specified in the <sceneNo>
parameter, and restores the scene to the factory default state.

Usage Cautions
・ This command is only valid in setup mode.
Example
Clear the scene data of scene No. 2.

Me.CoreRA1.SetRunMode(2)
Dim ret As Integer = Me.CoreRA1.ClearScene(2)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
GetRunMode (Reference:  Details (p.82)) SceneCount (Reference:  Details (p.128))
SceneNo (Reference:  Details (p.129)) SetRunMode (Reference:  Details (p.156))

51
.NET Control Reference Manual
8-5-10 ClearTotalData

Clears statistical data.

Format
Function ClearTotalData() As Integer

Parameter
None

Return value
Error code (0: Normal, -1: Error)

Description
Clears statistical data.

Usage Cautions
・ None.

Example
Clears statistical data.
Dim ret As Integer = Me.CoreRA1.ClearTotalData()

Supported Versions
Version 1.91 or later

Related Items
ClearScene (Reference:  Details (p.51)) GetRunMode (Reference:  Details (p.82))
GetTotalData (Reference:  Details (p.84)) SetRunMode (Reference:  Details (p.156))

52
.NET Control Reference Manual
8-5-11 CopyMeasureItem

Copies an inspection item.

Format
Function CopyMeasureItem(ByVal itemNo As Integer) As Integer

Parameter
Parameter
Data type Description
name
<itemNo> Integer Item number (0 to 30) of the inspection item to be copied.

Return value
Error code (0: Normal, -1: Error)

Description
Copies the inspection item specified in the <itemNo> parameter to the end of the inspection
processing item block.

Usage Cautions
・ This command is only valid in setup mode.

Example

Copies the specified inspection item to the end of the inspection processing item block.
Me.CoreRA1.SetRunMode(2)
Dim ret As Integer = Me.CoreRA1.CopyMeasureItem(2)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
AssignMeasureItem DeleteMeasureItem
(Reference:  Details (p.41)) (Reference:  Details (p.56))
GetRunMode MeasureItemCount
(Reference:  Details (p.82)) (Reference:  Details (p.95))
SetRunMode (Reference:  Details (p.156))

53
.NET Control Reference Manual
8-5-12 CopyPositionItem

Copies an image adjustment item.

Format
Function CopyPositionItem(ByVal itemNo As Integer) As Integer

Parameter
Parameter
Data type Description
name
<itemNo> Integer Item number (0 to 6) of the image adjustment item to be copied.

Return value
Error code (0: Normal, -1: Error)

Description
Copies the image adjustment item specified in the <itemNo> parameter to the end of the
inspection processing item block.

Usage Cautions
・ This command is only valid in setup mode.

Example

Copies the image adjustment item to the end of the image adjustment item block.
Me.CoreRA1.SetRunMode(2)
Dim ret As Integer = Me.CoreRA1.CopyPositionItem(2)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
AssignPositionItem DeletePositionItem
(Reference:  Details (p.43)) (Reference:  Details (p.57))
GetRunMode (Reference:  Details (p.82)) PositionItemCount
(Reference:  Details (p.107))
SetRunMode (Reference:  Details (p.156))

54
.NET Control Reference Manual
8-5-13 CopyScene

Copies scene data.

Format
Function CopyScene(ByVal srcSceneNo As Integer, ByVal destSceneNo As
Integer) As Integer

Parameter
Parameter
Data type Description
name
<srcSceneNo> Integer Scene number (0 to 31) of the scene to be copied.
<destSceneNo> Integer Scene number (0 to 31) of destination scene.

Return value
Error code (0: Normal, -1: Error)

Description
Copies the scene data with the scene number specified in the <srcSceneNo> parameter to the
scene data with the scene number specified in the <destSceneNo> parameter.

Usage Cautions
・ This command is only valid in setup mode.

Example
Copy the data of scene 2 to scene 3.

Me.CoreRA1.SetRunMode(2)
Dim ret As Integer = Me.CoreRA1.CopyScene(2, 3)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
GetRunMode (Reference:  Details (p.82)) SceneCount (Reference:  Details (p.128))
SceneNo (Reference:  Details (p.129)) SetRunMode (Reference:  Details (p.156))

55
.NET Control Reference Manual
8-5-14 DeleteMeasureItem

Deletes an inspection item.

Format
Function DeleteMeasureItem(ByVal itemNo As Integer) As Integer

Parameter
Parameter
Data type Description
name
<itemNo> Integer Item number (0 to 31) of the inspection item

Return value
Error code (0: Normal, -1: Error)

Description
Deletes the inspection item specified in the <itemNo> parameter.

Usage Cautions
・ This command is only valid in setup mode.

Example
Deletes the processing item of inspection item No. 2.

Me.CoreRA1.SetRunMode(2)
Dim ret As Integer = Me.CoreRA1.DeleteMeasureItem(2)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
AssignMeasureItem CopyMeasureItem (Reference:  Details (p.53))
(Reference:  Details (p.41))
GetRunMode (Reference:  Details (p.82)) MeasureItemCount
(Reference:  Details (p.95))
SetRunMode (Reference:  Details (p.156))

56
.NET Control Reference Manual
8-5-15 DeletePositionItem

Deletes an image adjustment item.

Format
Function DeletePositionItem(ByVal itemNo As Integer) As Integer

Parameter
Parameter
Data type Description
name
<itemNo> Integer Item number (0 to 7) of the image adjustment item.

Return value
Error code (0: Normal, -1: Error)

Description
Deletes the image adjustment item specified in the <itemNo> parameter.

Usage Cautions
・ This command is only valid in setup mode.

Example
Delete image adjustment item No. 2.

Me.CoreRA1.SetRunMode(2)
Dim ret As Integer = Me.CoreRA1.DeletePositionItem(2)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
AssignPositionItem CopyPositionItem (Reference:  Details (p.54))
(Reference:  Details (p.43))
GetRunMode (Reference:  Details (p.82)) PositionItemCount
(Reference:  Details (p.107))
SetRunMode (Reference:  Details (p.156))

57
.NET Control Reference Manual
8-5-16 GetAll

Gets the input statuses of all input terminals.


Format
Function GetAll(ByVal ioIdent As String) As Integer

Parameter
Parameter
Data type Description
name
<ioIdent> String Identifier of the communication module to be used (always "ParallelIo")

Return value
The input status of each input terminal is expressed as an integer value (OFF (0) or ON (1)) in
each digit of a character string in binary notation.

Example: DI0 and DI2 are ON


Binary notation: 0000 0101
Value of input statuses that can be acquired: 5
  IN0, 0x0001
  IN1, 0x0002
  IN2, 0x0004
  IN3, 0x0008
  IN4, 0x0010
  TRIG, 0x0020
  IN5, 0x0040
  IN6, 0x0080
  IN7, 0x0100
  RESET, 0x0800
  DSA, 0x2000
  Returns -1 if an error occurs.

Description
Gets the input statuses of all input terminals of the communication module specified in the
<ioIdent> parameter.
Specify "ParallelIo" in the <ioIdent> parameter.
  For the FQ2 sensor standard parallel interface, the statuses of the TRIG and IN0 to IN5
terminals can be acquired. For the Parallel Interface Sensor Data Unit, the statuses of the TRIG,
DSA, IN0 to IN7, and RESET terminals can be acquired. For the RS-232C Interface Sensor Data Unit,
the statuses of the TRIG, IN0 to IN5, and RESET terminals can be acquired.

Usage Cautions
・ This command is valid only in setup mode (IO monitor mode only).
Example
Gets the input statuses of the DI signals in parallel I/O.

58
.NET Control Reference Manual
Me.CoreRA1.SetRunMode(2)
Me.CoreRA1.IOMonitorStart()
Dim ioModule As String = "ParallelIo"
'Get the input statuses.
Dim state As Integer = Me.CoreRA1.GetAll(ioModule)
Me.CoreRA1.IOMonitorStop()
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
GetPort (Reference:  Details (p.76)) PutAll (Reference:  Details (p.112))
PutPort (Reference:  Details (p.114)) SetMeasureOut (Reference:  Details (p.143))
SetParallelJudgeData
(Reference:  Details (p.148))

59
.NET Control Reference Manual
8-5-17 GetApplicationVersion

Gets the software version of the sensor.

Format
Function GetApplicationVersion(ByVal kind As Integer) As String

Parameter
Parameter
Data type Description
name
Type of version to be acquired
0: Sensor model
<kind> Integer
1. Software version (without date)
2. Software version (with date) 

Return value
Gets the software version as a character string value.
Returns null if an error occurs.

Description
Gets the software version of the sensor.

Usage Cautions
・ None.
Example
  Gets the sensor model.

Dim Version As String = Me.CoreRA1.GetApplicationVersion(0)

Supported Versions
Version 1.91 or later

Related Items
None

60
.NET Control Reference Manual
8-5-18 GetCalculationData

Gets calculation data.

Format
Function GetCalculationData(ByVal dataNo As Integer, ByRef data As Integer) As
Integer
Function GetCalculationData(ByVal dataNo As Integer, ByRef data As Double) As
Integer
Function GetCalculationData(ByVal dataNo As Integer, ByRef data As String, ByVal
string_type As Integer) As Integer

Parameter
Parameter
Data type Description
name
External reference data number of the calculation (Reference: 8-6
<dataNo> Integer
External Reference Parameters (p.163))
Integer
<data> Double Data acquired
String
Specifies the character string type when the data to be acquired is a character
<string_type> Integer
string. (0: char, 1: TCHAR)

Return value
 Error code (0: Normal, -1: Error)

Description
Gets calculation data.
Set the same data type for the <data> parameter as the data to be acquired.
Usage Cautions
・ None.
Example
Get external reference data No. 55 (judgement 0) of the calculation.

Dim data As Integer


'Change the variable data type to signed integer because the judgement data value is an integer.
Dim ret As Integer = Me.CoreRA1.GetCalculationData(55, data)

Get external reference data No. 5 (data 0) of the calculation.

Dim data As Double


'Change the variable data type to double precision floating point decimal because the judgement value is a
real number.
Dim ret As Integer = Me.CoreRA1.GetCalculationData(5, data)

Get external reference data No. 150 (expression 0) of the calculation.

Dim data As String


'Change the variable data type to string because the expression 0 value is a character string.
Dim ret As Integer = Me.CoreRA1.GetCalculationData(150, data,0)

61
.NET Control Reference Manual
Supported Versions
Version 1.91 or later

Related Items
CalculationData (Reference:  Details (p.45)) CalculationData2 (Reference:  Details (p.46))
SetCalculationData
(Reference:  Details (p.82))

62
.NET Control Reference Manual
8-5-19 GetCameraData

Gets the data of a camera parameter.

Format
Function GetCameraData(ByVal dataNo As Integer, ByRef data As Integer) As
Integer
Function GetCameraData(ByVal dataNo As Integer, ByRef data As Double) As
Integer

Parameter
Parameter
Data type Description
name
<dataNo> Integer Camera parameter number
Integer
<data> Data acquired
Double

Return value
 Error code (0: Normal, -1: Error)

Description
Gets the data of a camera parameter.
For the camera parameter numbers, refer to "Camera parameter numbers" in FQ2-S/CH Series
User's Manual for Communications Settings (Cat. No. Z338).
Set the same data type for the <data> parameter as the data to be acquired.

Usage Cautions
・ This command is only valid in setup mode.
Example
Gets the data of camera parameter No. 1 (shutter speed).

Me.CoreRA1.SetRunMode(2)
Dim data As Integer
'Change the variable data type to signed integer because the shutter speed value is an integer.
Dim ret As Integer = Me.CoreRA1.GetCameraData(1, data)
Me.CoreRA1.SetRunMode(1)

Get the data of camera parameter No. 10 (white balance R scaling).

Me.CoreRA1.SetRunMode(2)
Dim data As Double
'Change the variable data type to double precision floating point decimal because the white balance R
scaling data value is a real number.
Dim ret As Integer = Me.CoreRA1.GetCameraData(10, data)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items

63
.NET Control Reference Manual
SetCameraData (Reference:  Details (p.134))

64
.NET Control Reference Manual
8-5-20 GetErrorCode

Gets the most recent error code of the sensor.

Format
Function GetErrorCode() As Integer

Parameter
 None.

Return value
 Most recent error code
 Returns -1 if an error occurs.

Description
Gets the most recent error code of the sensor.
For recent error code, refer to "8-1 Error Histories" in FQ2-S/CH Series User's Manual (Cat. No.
Z337).

Usage Cautions
・ None.

Example
Gets the most recent error code of the sensor.

Dim ret As Integer = Me.CoreRA1.GetErrorCode()

Supported Versions
Version 1.91 or later

Related Items
ClearError (Reference:  Details (p.49))

65
.NET Control Reference Manual
8-5-21 GetLinkOutputData

Gets data output by link data / Fieldbus data communication.

Format
Function GetLinkOutputData(ByVal dataNo As Integer, ByRef data As Integer) As
Integer
Function GetLinkOutputData(ByVal dataNo As Integer, ByRef data As String, ByVal
string_type As Integer) As Integer

Parameter
Parameter
Data type Description
name
Data number of external reference data of link data output / Fieldbus
<dataNo> Integer
data output (Reference: 8-6 External Reference Parameters (p.163))
Integer
<data> Data acquired
String
Specifies the character string type when the data to be acquired is a character
<string_type> Integer
string. (0: char, 1: TCHAR)

Return value
 Error code (0: Normal, -1: Error)

Description
Gets data output by link data / Fieldbus data communication.
Set the same data type for the <data> parameter as the data to be acquired.
Usage Cautions
・ This command is only valid in setup mode.
Example
Get external reference data No. 307 (output form) of link data output / Fieldbus data output.

Me.CoreRA1.SetRunMode(2)
Dim data As Integer
'Change the variable data type to signed integer because the output data type is integer.
Dim ret As Integer = Me.CoreRA1.GetLinkOutputData(307, data)
Me.CoreRA1.SetRunMode(1)

Get external reference data No. 120 (output data 0) of link data output / Fieldbus data output. 

Me.CoreRA1.SetRunMode(2)
Dim data As String
'Change the variable data type to string because the output data 0 value is a character string.
Dim ret As Integer = Me.CoreRA1.GetLinkOutputData(120, data,0)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items

66
.NET Control Reference Manual
LinkOutputData (Reference:  Details (p.88)) LinkOutputData2 (Reference:  Details (p.89))

67
.NET Control Reference Manual
8-5-22 GetMeasureItemData

Gets the data of an inspection item.

Format
Function GetMeasureItemData(ByVal itemNo As Integer, ByVal dataNo As Integer,
ByRef data As Integer) As Integer
Function GetMeasureItemData(ByVal itemNo As Integer, ByVal dataNo As Integer,
ByRef data As Double) As Integer
Function GetMeasureItemData(ByVal itemNo As Integer, ByVal dataNo As Integer,
ByRef data As String, ByVal string_type As Integer) As Integer

Parameter
Parameter
Data type Description
name
<itemNo> Integer Item number (0 to 31) of the inspection item
<dataNo> Integer External reference data number of the inspection item
Integer
<data> Double Data acquired
String
Specifies the character string type when the data to be acquired is a character
<string_type> Integer
string. (0: char, 1: TCHAR)

Return value
 Error code (0: Normal, -1: Error)

Description
Gets the data of an inspection item.
Set the same data type for the <data> parameter as the data to be acquired.
Usage Cautions
・ This command is only valid in setup mode.
Example
Get external reference data No. 5 (correlation) of inspection item No. 1 (search).

Me.CoreRA1.SetRunMode(2)
Dim data As Integer
'Change the variable data type to integer because the correlation data value is an integer.
Dim ret As Integer = Me.CoreRA1.GetMeasureItemData(1, 5, data)
Me.CoreRA1.SetRunMode(1)

Get external reference data No. 6 (position X) of inspection item No. 1 (search).

Me.CoreRA1.SetRunMode(2)
Dim data As Double
'Change the variable data type to double precision floating point decimal because the position X data value
is a real number.
Dim ret As Integer = Me.CoreRA1.GetMeasureItemData(1, 6, data)
Me.CoreRA1.SetRunMode(1)

Get external reference data No. 7 (decode character string) of inspection item No. 2 (2D code). 

68
.NET Control Reference Manual
Me.CoreRA1.SetRunMode(2)
Dim data As String
'Change the variable data type to string because the decode character string value is a character string.
Dim ret As Integer = Me.CoreRA1.GetMeasureItemData(2, 7, data, 0)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
GetMeasureItemFigure SetMeasureItemData
(Reference:  Details (p.70)) (Reference:  Details (p.138))
SetMeasureItemFigure MeasureItemData (Reference:  Details (p.96))
(Reference:  Details (p.140))
MeasureItemData2
(Reference:  Details (p.97))

69
.NET Control Reference Manual
8-5-23 GetMeasureItemFigure

Gets the figure data of an inspection item.

Format
Function GetMeasureItemFigure(ByVal itemNo As Integer, ByVal figureNo As
Integer, ByRef figure As Integer()) As Integer

Parameter
Parameter
Data type Description
name
<itemNo> Integer Item number (0 to 31) of the inspection item
<figureNo> Integer Region number (0 to 7)
<figure> Integer() Figure data to be acquired

Return value
 Error code (0: Normal, -1: Error)

Description
Gets the figure data of an inspection item.
For region numbers and figure data, refer to "SETITEMFIGPARAM or SIFP" in FQ2-S/CH Series
User's Manual for Communications Settings (Cat. No. Z338).

Usage Cautions
・ This command is only valid in setup mode.

Example
Get figure data No. 1 (region figure) of inspection item No. 1 (search).

Me.CoreRA1.SetRunMode(2)
Dim figure(5) As Integer
Dim ret As Integer = Me.CoreRA1.GetMeasureItemFigure(1, 1, figure)

Supported Versions
Version 1.91 or later

Related Items
GetMeasureItemData SetMeasureItemData
(Reference:  Details (p.68)) (Reference:  Details (p.138))
SetMeasureItemFigure MeasureItemData
(Reference:  Details (p.140)) (Reference:  Details (p.96))
MeasureItemData2
(Reference:  Details (p.97))

70
.NET Control Reference Manual
8-5-24 GetMeasureOut

Gets the setting for output of measurement results to an external device.

Format
Function GetMeasureOut() As Integer

Parameter
None.

Return value
 Output yes/no (0: No, 1: Yes)
 Returns -1 if an error occurs.

Description
Gets the setting for output of measurement results to an external device.

Usage Cautions
・ None.
Example
Gets the setting for output of measurement results to an external device.

Dim meaureOut As Integer = Me.CoreRA1.GetMeasureOut()

Supported Versions
Version 1.91 or later

Related Items
SetMeasureOut (Reference:  Details (p.143))

71
.NET Control Reference Manual
8-5-25 GetNoprotocolOutputData

Gets data that is output by no protocol data communication.

Format
Function GetNoprotocolOutputData(ByVal dataNo As Integer, ByRef data As
Integer) As Integer
Function GetNoprotocolOutputData(ByVal dataNo As Integer, ByRef data As
String, ByVal string_type As Integer) As Integer

Parameter
Parameter
Data type Description
name
External reference data number of no protocol data output (Reference:
<dataNo> Integer
8-6 External Reference Parameters (p.163))
Integer
<data> Data acquired
String
Specifies the character string type when the data to be acquired is a character
<string_type> Integer
string. (0: char, 1: TCHAR)

Return value
 Error code (0: Normal, -1: Error)

Description
Gets data that is output by no protocol data communication.
Set the same data type for the <data> parameter as the data to be acquired.
Usage Cautions
・ None.
Example
Get external reference data No. 300 (data format) of no protocol data output.

Dim data As Integer


'Change the variable data type to signed integer because the data type is integer.
Dim ret As Integer = Me.CoreRA1.GetNoprotocolOutputData(300, data)

Get external reference data No. 120 (output data 0) of no protocol data output. 

Dim data As String


'Change the variable data type to string because the output data 0 value is a character string.
Dim ret As Integer = Me.CoreRA1.GetNoprotocolOutputData(120, data,0)

Supported Versions
Version 1.91 or later

Related Items
SetNoprotocolOutputData
(Reference:  Details (p.144))

72
.NET Control Reference Manual
8-5-26 GetParallelData

Gets data output by parallel data communication.

Format
Function GetParallelData(ByVal dataNo As Integer, ByRef data As Integer) As
Integer
Function GetParallelData(ByVal dataNo As Integer, ByRef data As String, ByVal
string_type As Integer) As Integer

Parameter
Parameter
Data type Description
name
External reference data number of parallel data output (Reference: 8-
<dataNo> Integer
6 External Reference Parameters (p.163))
Integer
<data> Data acquired
String
Specifies the character string type when the data to be acquired is a character
<string_type> Integer
string. (0: char, 1: TCHAR)

Return value
 Error code (0: Normal, -1: Error)

Description
Gets data output by parallel data communication.
Set the same data type for the <data> parameter as the data to be acquired.
Usage Cautions
・ None.
Example
Get external reference data No. 300 (data format) of parallel data output.

Dim data As Integer


'Change the variable data type to signed integer because the output data type is integer.
Dim ret As Integer = Me.CoreRA1.GetParallelData(300, data)

Get external reference data No. 150 (output data 0) of the parallel data output. 

Dim data As String


'Change the variable data type to string because the output data 0 value is a character string.
Dim ret As Integer = Me.CoreRA1.GetParallelData(150, data,0)

Supported Versions
Version 1.91 or later

Related Items
ParallelData (Reference:  Details (p.103)) ParallelData2 (Reference:  Details (p.104))
SetParallelData (Reference:  Details (p.146))

73
.NET Control Reference Manual
8-5-27 GetParallelJudgeData

Gets data output by parallel judgement output.

Format
Function GetParallelJudgeData(ByVal dataNo As Integer, ByRef data As Integer)
As Integer
Function GetParallelJudgeData(ByVal dataNo As Integer, ByRef data As Double)
As Integer
Function GetParallelJudgeData(ByVal dataNo As Integer, ByRef data As String,
ByVal string_type As Integer) As Integer

Parameter
Parameter
Data type Description
name
External reference data number of parallel judgement output
<dataNo> Integer
(Reference: 8-6 External Reference Parameters (p.163))
Integer
<data> Double Data acquired
String
Specifies the character string type when the data to be acquired is a character
<string_type> Integer
string. (0: char, 1: TCHAR)

Return value
 Error code (0: Normal, -1: Error)

Description
Gets data output by parallel judgement output.
Set the same data type for the <data> parameter as the data to be acquired.
Usage Cautions
・ None.
Example
Get external reference data No. 103 (reflect) of parallel judgement output.

Dim data As Integer


'Change the variable data type to signed integer because the reflect value is an integer.
Dim ret As Integer = Me.CoreRA1.GetParallelJudgeData(103, data)

Get external reference data No. 300 (judgement upper limit) of the parallel judgement output.

Dim data As Double


'Change the variable data type to double precision floating point decimal because the judgement upper limit
value is a real number.
Dim ret As Integer = Me.CoreRA1.GetParallelJudgeData(300, data)

Get external reference data No. 150 (output data 0) of parallel judgement output. 

Dim data As String


'Change the variable data type to string because the output data 0 value is a character string.
Dim ret As Integer = Me.CoreRA1.GetParallelData(150, data,0)

74
.NET Control Reference Manual
Supported Versions
Version 1.91 or later

Related Items
ParallelJudgeData ParallelJudgeData2
(Reference:  Details (p.105)) (Reference:  Details (p.106))
SetParallelJudgeData
(Reference:  Details (p.148))

75
.NET Control Reference Manual
8-5-28 GetPort

Gets the input status of a specified input terminal.

Format
Function GetPort(ByVal ioIdent As String, ByVal portKind As Integer, ByVal portNo
As Integer) As Integer

Parameter
Parameter
Data type Description
name
<ioIdent> String Identifier of the communication module to be used (always "ParallelIo")
Terminal type of input terminal whose input status is to be acquired.
0: TRIG
<portkind> Integer 1: DSA (only when the sensor is connected to the Sensor Data Unit)
2: DI
13: RESET
Terminal number of input terminal whose input status is to be acquired.
Terminal type is DI and only when the sensor is connected to the FQ-SDU1
Sensor Data Unit
0 to 7 : (IN0 to 7)
<portNo> Integer Terminal type is DI and when the sensor is connected to the FQ-SDU2 Sensor
Data Unit
0 to 5 : (IN0 to 5)
Terminal type is other than DI
0 only

Return value
Returns the input status of the input terminal as an integer value.
0: Input OFF state
1: Input ON state
 -1: Error

Description
Gets the status of the input terminal, specified in the <portKind> parameter and <portNo>
parameter, of the communication module specified in the <ioIdent> parameter.
Normally "ParallelIo" should be specified in the <ioIdent> parameter.

Usage Cautions
・ This command is valid only in setup mode (IO monitor mode only).

Example
Get the input status of DI5 of parallel I/O.

76
.NET Control Reference Manual
Me.CoreRA1.SetRunMode(2)
Me.CoreRA1.IOMonitorStart()
Dim ioModule As String = "ParallelIo"
'Get the input status.
Dim state As Integer = Me.CoreRA1.GetPort(ioModule, 2, 5)
Me.CoreRA1.IOMonitorStop()
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
GetAll (Reference:  Details (p.58)) PutAll (Reference:  Details (p.112))
PutPort (Reference:  Details (p.114)) RunOut (Reference:  Details (p.120))
SetMeasureOut SetParalleJudgeData
(Reference:  Details (p.143)) (Reference:  Details (p.148))

77
.NET Control Reference Manual
8-5-29 GetPositionItemData

Gets the data of an image adjustment item.

Format
Function GetPositionItemData(ByVal itemNo As Integer, ByVal dataNo As Integer,
ByRef data As Integer) As Integer
Function GetPositionItemData(ByVal itemNo As Integer, ByVal dataNo As Integer,
ByRef data As Double) As Integer

Parameter
Parameter
Data type Description
name
<itemNo> Integer Item number (0 to 7) of the image adjustment item.
<dataNo> Integer External reference data number of the image adjustment item
Integer
<data> Data acquired
Double

Return value
 Error code (0: Normal, -1: Error)

Description
Gets the data of an image adjustment item.
Set the same data type for the <data> parameter as the data to be acquired.
Usage Cautions
・ None.
Example
Get external reference data No. 120 (source image) of image adjustment inspection item No. 1
(color gray filter).

Dim data As Integer


'Change the variable data type to signed integer because the source image data value is an integer.
Dim ret As Integer = Me.CoreRA1.GetPositionItemData(1, 120, data)

Get external reference data No. 125 (RGB gain R) of inspection item No. 1 (color gray filter).

Dim data As Double


'Change the variable data type to double precision floating point decimal because the RGB gain R value is
a real number.
Dim ret As Integer = Me.CoreRA1.GetMeasureItemData(1, 125, data)

Supported Versions
Version 1.91 or later

Related Items
GetPositionItemFigure PositionItemData
(Reference:  Details (p.79)) (Reference:  Details (p.108))
SetPositionItemData
(Reference:  Details (p.150))

78
.NET Control Reference Manual
8-5-30 GetPositionItemFigure

Gets the figure data of an image adjustment item.

Format
Function GetPositionItemFigure(ByVal itemNo As Integer, ByVal figureNo As
Integer, ByRef figure As Integer()) As Integer

Parameter
Parameter
Data type Description
name
<itemNo> Integer Item number (0 to 7) of the image adjustment item.
<figureNo> Integer Region number (0 to 7)
<figure> Integer() Figure data to be acquired

Return value
 Error code (0: Normal, -1: Error)

Description
Gets the figure data of an image adjustment item.
For region numbers and figure data, refer to "SETITEMFIGPARAM or SIFP" in FQ2-S/CH Series
User's Manual for Communications Settings (Cat. No. Z338).

Usage Cautions
・ None.

Example
Get figure data No. 0 (region figure) of image adjustment item No. 1 (extract edges).

Dim figure(5) As Integer


Dim ret As Integer = Me.CoreRA1.GetPositionItemFigure(1, 0, figure)

Supported Versions
Version 1.91 or later

Related Items
GetPositionItemData SetPositionItemFigure
(Reference:  Details (p.78)) (Reference:  Details (p.152))

79
.NET Control Reference Manual
8-5-31 GetRetryData

Gets retry data.

Format
Function GetRetryData(ByVal dataNo As Integer, ByRef data As Integer) As
Integer
Function GetRetryData(ByVal dataNo As Integer, ByRef data As Double) As
Integer

Parameter
Parameter
Data type Description
name
External reference data number of the retry (Reference: 8-6 External
<dataNo> Integer
Reference Parameters (p.163))
Integer
<data> Data acquired
Double

Return value
 Error code (0: Normal, -1: Error)

Description
Gets retry data.
Set the same data type for the <data> parameter as the data to be acquired.

Usage Cautions
・ This command is only valid in setup mode.

Example
Get external reference data No. 121 (max count) of the retry.

Me.CoreRA1.SetRunMode(2)
Dim data As Integer
'Change the variable data type to signed integer because the max count value is an integer.
Dim ret As Integer = Me.CoreRA1.GetRetryData(121, data)
Me.CoreRA1.SetRunMode(1)

Get external reference data No. 123 (shutter speed step) of the retry.

Me.CoreRA1.SetRunMode(2)
Dim data As Double
'Change the variable data type to double precision floating point decimal because the shutter speed step
value is a real number.
Dim ret As Integer = Me.CoreRA1.GetRetryData(123, data)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

80
.NET Control Reference Manual
Related Items
RetryData (Reference:  Details (p.119)) SetRetryData (Reference:  Details (p.155))

81
.NET Control Reference Manual
8-5-32 GetRunMode

Gets the execution status (execution mode) of the FQ2 sensor.

Format
Function GetRunMode() As Integer

Parameter
None.

Return value
Returns the execution mode.

Execution mode
1: Run mode
2: Setup mode
 Returns -1 if an error occurs.

Description
Gets the execution status (execution mode) of the FQ2 sensor.

Usage Cautions
・ None.
Example
  Gets the execution mode.
Dim runMode As Integer = Me.CoreRA1.GetRunMode()

Supported Versions
Version 1.91 or later

Related Items
GetMeasureItemData Measure (Reference:  Details (p.94))
(Reference:  Details (p.68))
SetMeasureItemData SetRunMode
(Reference:  Details (p.138)) (Reference:  Details (p.156))

82
.NET Control Reference Manual
8-5-33 GetSystemData

Gets system data.

Format
Function GetSystemData(ByVal dataIdent0 As String, ByVal dataIdent1 As String,
ByRef data As Integer) As Integer

Parameter
Parameter
Data type Description
name
<dataIdent0> String Data identifier of identification information 0 of system data to be acquired
<dataIdent1> String Data identifier of identification information 1 of system data to be acquired
<data> Integer Value of acquired system data

Return value
 Error code (0: Normal, -1: Error)

Description
Get the system data of identification information 1 specified in the <dataIdent1> parameter,
which belongs to identification information 0 specified in the <dataIdent0> parameter.
For system data identification information, refer to the system data list. (Reference: System
Data List (p. 28))

Usage Cautions
・ None.

Example
Get the value set for the startup scene number whose identification information 1 is
"initialSceneNo" and which belongs to identification information 0 of "Configuration", and switch
the scene used to the startup scene.
'Get the set value for the startup scene number that belongs to Configuration.
Dim sceneNo As Integer
Dim ret As Integer = Me.CoreRA1.GetSystemData("Configuration", "initialSceneNo", sceneNo)
'Change the scene.
ret = Me.CoreRA1.ChangeScene(sceneNo)

Supported Versions
Version 1.91 or later

Related Items
SetSystemData (Reference:  Details (p.159))

83
.NET Control Reference Manual
8-5-34 GetTotalData

Gets statistical data.

Format
Function GetTotalData(ByVal kind As Integer) As Double

Parameter
Parameter
Data type Description
name
Specifies the type of statistical data to be acquired.
1: Number of measurements
2: Number of NGs
<kind> Integer
3: NG rate
4: Number of OKs
5: OK rate

Return value
Returns the specified type of statistical data as a double precision floating point decimal value.
Returns -1 if an error occurs.

Description
 Gets statistical data.

Usage Cautions
・ None.

Example
Get statistical data (number of measurements).

Dim MeaCount As Double = Me.CoreRA1.GetTotalData(1)

Supported Versions
Version 1.91 or later
Related Items
ClearTotalData (Reference:  Details (p.52))

84
.NET Control Reference Manual
8-5-35 ImageUpdate

Updates the image input from the camera.

Format
Function ImageUpdate() As Integer

Parameter
None.

Return value
 Error code (0: Normal, -1: Error)

Description
Updates the image input from the camera to the most recent image.

Usage Cautions
・ This command is valid only when the image mode is "Camera Image Freeze". When the image
mode is "Camera Image Live", the image input from the camera is continuously updated.

Example
Update an image displayed in "Camera Image Freeze" image mode to the most recent image.

'Update the frozen image to the most recent image.


Dim ret As Integer = Me.CoreRA1.ImageUpdate()

Supported Versions
Version 1.91 or later

Related Items
RefreshImageWindow
(Reference:  Details (p.116))

85
.NET Control Reference Manual
8-5-36 IOMonitorStart

Starts the IO monitor.

Format
Function IOMonitorStart() As Integer

Parameter
None.

Return value
 Error code (0: Normal, -1: Error)

Description
Starts the IO monitor.
To use an IO module command, you must first execute the IOMonitorStart command.
When the action of the IO module command is finished, execute the IOMonitorStop command.

Usage Cautions
・ This command is only valid in setup mode.

Example
Gets the input statuses of the DI signals in parallel I/O.

Me.CoreRA1.SetRunMode(2)
Me.CoreRA1.IOMonitorStart()
Dim ioModule As String = "ParallelIo"
Dim state As Integer = Me.CoreRA1.GetAll(ioModule)
Me.CoreRA1.IOMonitorStop()
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
IOMonitorStop (Reference:  Details (p.87))

86
.NET Control Reference Manual
8-5-37 IOMonitorStop

Stops the IO monitor.

Format
Function IOMonitorStop() As Integer

Parameter
None.

Return value
 Error code (0: Normal, -1: Error)

Description
Stops the IO monitor.
To use an IO module command, you must first execute the IOMonitorStart command.
When the action of the IO module command is finished, execute the IOMonitorStop command.

Usage Cautions
・ This command is only valid in setup mode.

Example
Gets the input statuses of the DI signals in parallel I/O.

Me.CoreRA1.SetRunMode(2)
Me.CoreRA1.IOMonitorStart()
Dim ioModule As String = "ParallelIo"
Dim state As Integer = Me.CoreRA1.GetAll(ioModule)
Me.CoreRA1.IOMonitorStop()
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
IOMonitorStart (Reference:  Details (p.86))

87
.NET Control Reference Manual
8-5-38 LinkOutputData

Gets numerical data output by link data / Fieldbus data communication.

Format
Function LinkOutputData(ByVal dataNo As Integer) As Double

Parameter
Parameter
Data type Description
name
Data numbers of the link data output/Fieldbus data output (Reference:
<dataNo> Integer
8-6 External Reference Parameters (p.163))

Return value
Returns the data as a double precision floating point decimal value.
Returns -1 if an error occurs.

Description
Gets the numerical data specified in the <dataNo> parameter.

Usage Cautions
・ None.

Example
Get external reference data No. 307 (output format) of the link data output / Fieldbus data
output.

Dim data As Double = Me.CoreRA1.LinkOutputData(307)

Supported Versions
Version 1.91 or later

Related Items
GetLinkOutputData LinkOutputData2 (Reference:  Details (p.89))
(Reference:  Details (p.66))

88
.NET Control Reference Manual
8-5-39 LinkOutputData2

Gets character string data output by link data / Fieldbus data communication.

Format
Function LinkOutputData2(ByVal dataNo As Integer, ByVal string_type As Integer)
As String

Parameter
Parameter
Data type Description
name
Data numbers of the link data output/Fieldbus data output (Reference:
<dataNo> Integer
8-6 External Reference Parameters (p.163))
Specifies the character string type when the data to be acquired is a character
<string_type> Integer
string. (0: char, 1: TCHAR)

Return value
Returns character string data.
Returns null if an error occurs.
Description
Gets the character string data specified in the <dataNo> parameter.

Usage Cautions
・ None.

Example
Get external reference data No. 120 (output data) of the link data output / Fieldbus data output.
Dim data As String = Me.CoreRA1.LinkOutputData2(120, 0)

Supported Versions
Version 1.91 or later

Related Items
GetLinkOutputData (Reference:  Details LinkOutputData (Reference:  Details (p.88))
(p.66))

89
.NET Control Reference Manual
8-5-40 LoadBackupData

Loads all setting data (all scene data, system data, and calibration group data).

Format
Function LoadBackupData(ByVal fileName As String) As Integer

Parameter
Parameter
Data type Description
name
File name of all sensor setting data (system + all scene data) to be loaded
<fileName> String
(*.bkd)

Return value
 Error code (0: Normal, -1: Error)

Description
Loads the file containing all setting data (all scene data, system data, and calibration group
data) that is specified in the <fileName> parameter.
Specify the file name by absolute path in the <fileName> parameter.
Usage Cautions
・ This command is only valid in setup mode.

Example
Load all setting data (all scene data, system data, and calibration group data) and then save the
data to the sensor. To enable the loaded settings, restart the sensor.

Me.CoreRA1.SetRunMode(2)
'Loads the file of all setting data (all scene data, system data, and calibration group data).
Dim ret As Integer = Me.CoreRA1.LoadBackupData("C:\BACKDIR\BackupData.bkd")
'Save the data to the sensor.
ret = Me.CoreRA1.SaveData()
Reboot the sensor.
ret = Me.CoreRA1.SystemReset()
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
GetSystemData (Reference:  Details (p.83)) LoadScene (Reference:  Details (p.91))
LoadSceneGroup (Reference:  Details (p.92)) LoadSystemData (Reference:  Details (p.93))
SaveBackupData SaveData (Reference:  Details (p.122))
(Reference:  Details (p.121))
SystemReset (Reference:  Details (p.160))

90
.NET Control Reference Manual
8-5-41 LoadScene

Loads scene data.

Format
Function LoadScene(ByVal sceneNo As Integer, ByVal fileName As String) As
Integer

Parameter
Parameter
Data type Description
name
<sceneNo> Integer Scene number to be loaded (0 to 31)
<fileName> String File name of the scene data to be loaded (*.scn)

Return value
 Error code (0: Normal, -1: Error)

Description
Loads the scene data file specified in the <fileName> parameter into the scene number specified
in the <sceneNo> parameter.
Specify the file name by absolute path in the <fileName> parameter.

Usage Cautions
・ This command is only valid in setup mode.
Example
Load scene data into scene 2 and then change the scene to scene 2.

Me.CoreRA1.SetRunMode(2)
'Load the scene data file.
Dim ret As Integer = Me.CoreRA1.LoadScene(2, "C:\BACKDIR\scene02.scn")
'Change the scene.
ret = Me.CoreRA1.ChangeScene(2)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
ChangeScene (Reference:  Details (p.48)) LoadBackupData (Reference:  Details (p.90))
LoadSceneGroup (Reference:  Details (p.92)) LoadSystemData (Reference:  Details (p.93))
SaveScene (Reference:  Details (p.125)) SceneNo (Reference:  Details (p.129))

91
.NET Control Reference Manual
8-5-42 LoadSceneGroup

Loads scene group data.

Format
Function LoadSceneGroup(ByVal fileName As String) As Integer

Parameter
Parameter
Data type Description
name
<fileName> String File name of the scene group data to be loaded (*.sgp)

Return value
 Error code (0: Normal, -1: Error)

Description
Loads the scene group data file specified in the <fileName> parameter.
Specify the file name by absolute path in the <fileName> parameter.

Usage Cautions
・ This command is only valid in setup mode.
Example
Load the scene group data and then change the scene used to scene 0.

Me.CoreRA1.SetRunMode(2)
'Load the file of the scene group data.
Dim ret As Integer = Me.CoreRA1.LoadSceneGroup("C:\BACKDIR\scenegroup.sgp")
'Change the scene.
ret = Me.CoreRA1.ChangeScene(0)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
ChangeScene (Reference:  Details (p.48)) LoadBackupData (Reference:  Details (p.90))
LoadScene (Reference:  Details (p.91)) LoadSystemData (Reference:  Details (p.93))
SaveSceneGroup
(Reference:  Details (p.126))

92
.NET Control Reference Manual
8-5-43 LoadSystemData

Loads system data.

Format
Function LoadSystemData(ByVal fileName As String) As Integer

Parameter
Parameter
Data type Description
name
<fileName> String File name of the system data to be loaded (*.syd)

Return value
 Error code (0: Normal, -1: Error)

Description
Loads the system data file specified in the <fileName> parameter.
Specify the file name by absolute path in the <fileName> parameter.

Usage Cautions
・ This command is only valid in setup mode.

Example
Load system data and then execute "Save data". Restart the sensor to apply the loaded settings.

Me.CoreRA1.SetRunMode(2)
'Load the system data file
Dim ret As Integer = Me.CoreRA1.LoadSystemData("C:\BACKDIR\backupsysset.syd")
'Save the data to the sensor.
ret = Me.CoreRA1.SaveData()
'Reboot the sensor.
ret = Me.CoreRA1.SystemReset()
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
LoadBackupData (Reference:  Details (p.90)) LoadScene (Reference:  Details (p.91))
LoadSceneGroup (Reference:  Details (p.92)) SaveData (Reference:  Details (p.122))
SaveSystemData (Reference:  Details (p.127)) SystemReset (Reference:  Details (p.160))

93
.NET Control Reference Manual
8-5-44 Measure

Executes measurement processing.

Format
Function Measure() As Integer

Parameter
  None.

Return value
 Error code (0: Normal, -1: Error)

Description
Executes measurement processing.

Usage Cautions
・ None.

Example
Executes measurement processing.

Dim ret As Integer = Me.CoreRA1.Measure()

Supported Versions
Version 1.91 or later

Related Items
GetRunMode (Reference:  Details (p.82)) ReMeasure (Reference:  Details (p.117))
SetRunMode (Reference:  Details (p.156))

94
.NET Control Reference Manual
8-5-45 MeasureItemCount

Gets the number of inspection items.

Format
Function MeasureItemCount() As Integer

Parameter
  None.

Return value
Returns the number of inspection items as an integer value.
Returns -1 if an error occurs.

Description
Gets the number of inspection items.

Usage Cautions
・ None.

Example
Gets the number of inspection items.

Dim ret As Integer = Me.CoreRA1.MeasureItemCount()

Supported Versions
Version 1.91 or later

Related Items
MeasureItemIdent (Reference:  Details (p.98)) PositionItemCount
(Reference:  Details (p.107))
PositionItemIdent
(Reference:  Details (p.109))

95
.NET Control Reference Manual
8-5-46 MeasureItemData

Gets the numerical data of an inspection item.

Format
Function MeasureItemData(ByVal itemNo As Integer, ByVal dataNo As Integer) As
Double

Parameter
Parameter
Data type Description
name
<itemNo> Integer Item number (0 to 31) of the inspection item
<dataNo> Integer External reference data number of the inspection item to be acquired.

Return value
Returns the data of the inspection item as a double precision floating point decimal value.
Returns -1 if an error occurs.

Description
Gets the numerical data of the external reference data number specified in the <dataNo>
parameter, which belongs the inspection item specified in the <itemNo> parameter.

Usage Cautions
・ None.

Example
Get external reference data No. 0 (judgement) of inspection item No. 0 (search).

Dim data As Double = Me.CoreRA1.MeasureItemData(0, 0)

Supported Versions
Version 1.91 or later

Related Items
GetMeasureItemData MeasureItemData2
(Reference:  Details (p.68)) (Reference:  Details (p.97))

96
.NET Control Reference Manual
8-5-47 MeasureItemData2

Gets the character string data of an inspection item.

Format
Function MeasureItemData2(ByVal itemNo As Integer, ByVal dataNo As Integer,
ByVal string_type As Integer) As String

Parameter
Parameter
Data type Description
name
<itemNo> Integer Item number (0 to 31) of the inspection item
<dataNo> Integer External reference data number of the inspection item to be acquired.
Specifies the character string type when the data to be acquired is a character
<string_type> Integer
string. (0: char, 1: TCHAR)

Return value
Returns the character string data of the inspection item as a character string.
Returns null if an error occurs.

Description
Gets the character string data of the external reference data number specified in the <dataNo>
parameter, which belongs to the inspection item specified in the <itemNo> parameter.

Usage Cautions
・ None.

Example
Get external reference data No. 127 (error string) of inspection item No. 2 (bar code).

Dim data As String = Me.CoreRA1.MeasureItemData2(2, 127, 0)

Supported Versions
Version 1.91 or later

Related Items
GetMeasureItemData MeasureItemData
(Reference:  Details (p.68)) (Reference:  Details (p.96))

97
.NET Control Reference Manual
8-5-48 MeasureItemIdent

Gets the identifier of a registered inspection item.

Format
Function MeasureItemIdent(ByVal itemNo As Integer) As String

Parameter
Parameter
Data type Description
name
<itemNo> Integer Item number (0 to 31) of the inspection item

Return value
Returns the identifier of the inspection item as a character string.
Returns null if an error occurs.

Description
Gets the identifier of the inspection item specified in the <itemNo> parameter.

Usage Cautions
・ None.

Example
Get the identifier of the inspection item registered in item 1.

Dim ItemIdent As String = Me.CoreRA1.MeasureItemIdent(1)

Supported Versions
Version 1.91 or later

Related Items
MeasureItemCount MeasureItemTitle
(Reference:  Details (p.95)) (Reference:  Details (p.100))

98
.NET Control Reference Manual
8-5-49 MeasureItemJudge

Gets the judgement result of an inspection item.

Format
Function MeasureItemJudge(ByVal itemNo As Integer) As Integer

Parameter
Parameter
Data type Description
name
Item number (0 to 31) of the inspection item whose judgement result is to be
<itemNo> Integer
acquired.

Return value
Returns the judgement result as an integer value.
-2: No judgement (unmeasured)
0: Judgement result OK
-1: Judgement result NG
-10: Judgement result error (image format mismatch)
-11: Judgement result error (unregistered model)
-12: Judgement result error (insufficient memory)
-13: Teaching not performed error
-14: Figure not registered error
-15: Out of range error
-16: Measurement timeout error
-17: Format character string error
-20: Judgement result error (other errors)

Description
Gets the judgement result of the inspection item specified in the <itemNo> parameter.

Usage Cautions
・ None.

Example
Get the judgement result of inspection item No. 1.
Dim judge As Integer = Me.CoreRA1.MeasureItemJudge(1)

Supported Versions
Version 1.91 or later

Related Items

 None

99
.NET Control Reference Manual
8-5-50 MeasureItemTitle

Gets the title of an inspection item

Format
Function MeasureItemTitle(ByVal itemNo As Integer) As String

Parameter
Parameter
Data type Description
name
Inspection item number (0 to 31) of the inspection item whose title is to be
<itemNo> Integer
acquired.

Return value
Returns the title of the inspection item as a character string.
Returns null if an error occurs.

Description
Gets the title of the inspection item specified in the <itemNo> parameter.
The title can be acquired in the language specified in the language setting.

Usage Cautions
・ This command is only valid in setup mode.

Example
Get the title of inspection item No. 1 (search).

Me.CoreRA1.SetRunMode(2)
Dim ItemIdent As String = Me.CoreRA1.MeasureItemTitle(1)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
MeasureItemCount MeasureItemTitle (Reference:  Details (p.100))
(Reference:  Details (p.95))
SetMeasureItemData
(Reference:  Details (p.138))

100
.NET Control Reference Manual
8-5-51 NoprotocolOutputData

Gets numerical data output by no protocol data communication.

Format
Function NoprotocolOutputData(ByVal dataNo As Integer) As Double

Parameter
Parameter
Data type Description
name
External reference data number of no protocol data output (Reference:
<dataNo> Integer
8-6 External Reference Parameters (p.163))

Return value
Returns the data output by no protocol communication as a double precision floating point
decimal value.
Returns -1 if an error occurs.

Description
Gets the numerical data of the external reference number specified in the <dataNo> parameter,
which is output by no protocol communication.

Usage Cautions
・ None.

Example
Get external reference data No. 300 (data format) of no protocol data output.

Dim data As Double = Me.CoreRA1.NoprotocolOutputData(300)

Supported Versions
Version 1.91 or later

Related Items
GetNoprotocolOutputData NoprotocolOutputData2
(Reference:  Details (p.72)) (Reference:  Details (p.102))
SetMeasureOut (Reference:  Details (p.143))

101
.NET Control Reference Manual
8-5-52 NoprotocolOutputData2

Gets character string data output by no protocol communication.

Format
Function NoprotocolOutputData2(ByVal dataNo As Integer, ByVal string_type As
Integer) As String

Parameter
Parameter
Data type Description
name
External reference data number of no protocol data output (Reference:
<dataNo> Integer
8-6 External Reference Parameters (p.163))
Specifies the character string type when the data to be acquired is a character
<string_type> Integer
string. (0: char, 1: TCHAR)

Return value
Returns the character string data that is output by no protocol communication.
Returns null if an error occurs.

Description
Gets the character string data of the external reference data number specified in the <dataNo>
parameter, which is output by no-protocol communication.

Usage Cautions
・ None.

Example
Get external reference data No. 120 (output data 0) of no protocol data output.

Dim data As String = Me.CoreRA1.NoprotocolOutputData2(120, 0)

Supported Versions
Version 1.91 or later

Related Items
GetNoprotocolOutputData NoprotocolOutputData
(Reference:  Details (p.72)) (Reference:  Details (p.101))
SetMeasureOut (Reference:  Details (p.143))

102
.NET Control Reference Manual
8-5-53 ParallelData

Gets numerical data output by parallel data communication.

Format
Function ParallelData(ByVal dataNo As Integer) As Double

Parameter
Parameter
Data type Description
name
External reference data number of parallel data output (Reference: 8-
<dataNo> Integer
6 External Reference Parameters (p.163))

Return value
Returns the data output by parallel data communication as a double precision floating point
decimal value.
Returns -1 if an error occurs.

Description
Gets the numerical data, output by parallel output, of the external reference data number
specified in the <dataNo> parameter.

Usage Cautions
・ None.

Example
Get external reference data No. 300 (data format) of parallel data output.

Dim data As Double = Me.CoreRA1.ParallelData(300)

Supported Versions
Version 1.91 or later

Related Items
GetParallelData (Reference:  Details (p.73)) ParallelData2 (Reference:  Details (p.104))
SetMeasureOut (Reference:  Details (p.143))

103
.NET Control Reference Manual
8-5-54 ParallelData2

Gets character string data output by parallel data communication.

Format
Function ParallelData2(ByVal dataNo As Integer, ByVal string_type As Integer) As
String

Parameter
Parameter
Data type Description
name
External reference data number of parallel data output (Reference: 8-
<dataNo> Integer
6 External Reference Parameters (p.163))
Specifies the character string type when the data to be acquired is a character
<string_type> Integer
string. (0: char, 1: TCHAR)

Return value
Returns the character string data that is output by parallel data communication.
Returns null if an error occurs.

Description
Gets the character string data, output by parallel output, of the external reference data number
specified in the <dataNo> parameter.

Usage Cautions
・ None.

Example
Get external reference data No. 150 (output data 0) of the parallel data output.

Dim data As String = Me.CoreRA1.ParallelData2(150, 0)

Supported Versions
Version 1.91 or later

Related Items
GetParallelData (Reference:  Details (p.73)) ParallelData (Reference:  Details (p.103))
SetMeasureOut (Reference:  Details (p.143))

104
.NET Control Reference Manual
8-5-55 ParallelJudgeData

Gets numerical data output by parallel judgement output.

Format
Function ParallelJudgeData(ByVal dataNo As Integer) As Double

Parameter
Parameter
Data type Description
name
External reference data number of parallel judgement output
<dataNo> Integer
(Reference: 8-6 External Reference Parameters (p.163))

Return value
Returns the data output that is by parallel judgement output as a double precision floating point
decimal value.
Returns -1 if an error occurs.

Description
Gets the numerical data, output by parallel judgement output, of the external reference data
number specified in the <dataNo> parameter.

Usage Cautions
・ None.

Example
Get external reference data No. 300 (judgement upper limit 0) of parallel judgement output.

Dim data As Double = Me.CoreRA1.ParallelJudgeData(300)

Supported Versions
Version 1.91 or later

Related Items
GetParallelJudgeData ParallelJudgeData2
(Reference:  Details (p.74)) (Reference:  Details (p.106))
SetMeasureOut (Reference:  Details (p.143)) SetParallelJudgeData
(Reference:  Details (p.148))

105
.NET Control Reference Manual
8-5-56 ParallelJudgeData2

Gets character string data output by parallel judgement output.

Format
Function ParallelJudgeData2(ByVal dataNo As Integer, ByVal string_type As
Integer) As String

Parameter
Parameter
Data type Description
name
External reference data number of parallel judgement output (Reference:
<dataNo> Integer
8-6 External Reference Parameters (p.163))
Specifies the character string type when the data to be acquired is a character
<string_type> Integer
string. char, 1: TCHAR)

Return value
Returns the character string data that is output by parallel judgement output.
Returns null if an error occurs.

Description
Gets the character string data, output by parallel judgement output, of the external reference
data number specified in the <dataNo> parameter.

Usage Cautions
・ None.

Example
Get external reference data No. 150 (output data name 0) of parallel judgement output.

Dim data As String = Me.CoreRA1.ParallelJudgeData2(150, 0)

Supported Versions
Version 1.91 or later

Related Items
GetParallelJudgeData ParallelJudgeData
(Reference:  Details (p.74)) (Reference:  Details (p.105))
SetMeasureOut (Reference:  Details (p.143))

106
.NET Control Reference Manual
8-5-57 PositionItemCount

Gets the number of image adjustment items.

Format
Function PositionItemCount() As Integer

Parameter
  None.

Return value
Returns the number of image adjustment items as a signed integer value.
Returns -1 if an error occurs.

Description
Gets the number of image adjustment items.

Usage Cautions
・ None.

Example
Gets the number of inspection items.

Dim ret As Integer = Me.CoreRA1.PositionItemCount()

Supported Versions
Version 1.91 or later

Related Items
MeasureItemCount PositionItemIdent
(Reference:  Details (p.95)) (Reference:  Details (p.109))

107
.NET Control Reference Manual
8-5-58 PositionItemData

Gets the numerical data of an image adjustment item.

Format
Function PositionItemData(ByVal itemNo As Integer, ByVal dataNo As Integer) As
Double

Parameter
Parameter
Data type Description
name
<itemNo> Integer Item number (0 to 7) of the image adjustment item
<dataNo> Integer External reference data number of the image adjustment item to be acquired

Return value
Returns the data of the image adjustment item as a double precision floating point decimal value.
Returns -1 if an error occurs.

Description
Gets the numerical data of the external reference data number specified in the <dataNo>
parameter, which belongs to the image adjustment item specified in the <itemNo> parameter.

Usage Cautions
・ None.

Example
Get external reference data No. 0 (judgement) of image adjustment item No. 0 (color gray filter).

Dim data As Double = Me.CoreRA1.PositionItemData(0, 0)

Supported Versions
Version 1.91 or later

Related Items
GetPositionItemData
(Reference:  Details (p.78))

108
.NET Control Reference Manual
8-5-59 PositionItemIdent

Gets the identifier of a registered image adjustment item.

Format
Function PositionItemIdent(ByVal itemNo As Integer) As String

Parameter
Parameter
Data type Description
name
<itemNo> Integer Item number (0 to 7) of the image adjustment item.

Return value
Returns the identifier of the image adjustment item as a character string.
Returns null if an error occurs.

Description
Gets the identifier of the image adjustment item specified in the <itemNo> parameter.

Usage Cautions
・ None.

Example
Get the identifier of the image adjustment item registered in item 1.

Dim ItemIdent As String = Me.CoreRA1.PositionItemIdent(1)

Supported Versions
Version 1.91 or later

Related Items
PositionItemCount PositionItemTitle
(Reference:  Details (p.107)) (Reference:  Details (p.111))

109
.NET Control Reference Manual
8-5-60 PositionItemJudge

Gets the judgement result of an image adjustment item.

Format
Function PositionItemJudge(ByVal itemNo As Integer) As Integer

Parameter
Parameter
Data type Description
name
Item number (0 to 7) of an image adjustment item whose judgement result is to
<itemNo> Integer
be gotten

Return value
Returns the judgement result as an integer value.
-2: No judgement (unmeasured)
0: Judgement result OK
-1: Judgement result NG
-10: Judgement result error (image format mismatch)
-11: Judgement result error (unregistered model)
-12: Judgement result error (insufficient memory)
-13: Teaching not performed error
-14: Figure not registered error
-15: Out of range error
-16: Measurement timeout error
-17: Format character string error
-20: Judgement result error (other errors)

Description
Gets the judgement result of the image adjustment item specified in the <itemNo> parameter.

Usage Cautions
・ None.

Example
Get the judgement result of image adjustment item No. 1.
Dim judge As Integer = Me.CoreRA1.PositionItemJudge(1)

Supported Versions
Version 1.91 or later

Related Items
GetPositionItemData
(Reference:  Details (p.78))

110
.NET Control Reference Manual
8-5-61 PositionItemTitle
Gets the title of an image adjustment item.

Format
Function PositionItemTitle(ByVal itemNo As Integer) As String

Parameter
Parameter
Data type Description
name
Inspection item number (0 to 7) of image adjustment item whose title is to be
<itemNo> Integer
acquired

Return value
Returns the title of the image adjustment item as a character string.
Returns null if an error occurs.

Description
Gets the title of the inspection item specified in the <itemNo> parameter.
The title can be acquired in the language specified in the language setting.

Usage Cautions
・ This command is only valid in setup mode.

Example
Get the title of image adjustment item No. 1.
Me.CoreRA1.SetRunMode(2)
Dim ItemIdent As String = Me.CoreRA1.PositionItemTitle(1)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
PositionItemCount SetPositionItemData
(Reference:  Details (p.107)) (Reference:  Details (p.150))

111
.NET Control Reference Manual
8-5-62 PutAll

Sets the output statuses of all output terminals.

Format
Function PutAll(ByVal ioIdent As String, ByVal state As Integer) As Integer

Parameter
Parameter
Data type Description
name
<ioIdent> String Identifier of the communication module to be used (always "ParallelIo")
Output status of terminal
BIT0: DO0
BIT1: DO1
BIT2: DO2
BIT3: DO3
BIT4: DO4
BIT5: DO5
BIT6: DO6
<state> Integer BIT7: DO7
BIT8: DO8
BIT9: DO9
BIT10: DO10
BIT11: DO11
BIT12: DO12
BIT13: DO13
BIT14: DO14
BIT15: DO15

Return value
 Error code (0: Normal, -1: Error)

Description
Sets the output status of all output terminals of the communication module specified in the
<ioIdent> parameter to the state specified in the <state> parameter.
Normally "ParallelIo" should be specified in the <ioIdent> parameter.
The output statuses are set using an integer value expressed in binary with OFF (0) or ON (1) in
each binary digit for each output terminal.
In parallel I/O, an integer value is returned wherein the statuses of DO0 to DO15 are expressed
by the 1st digit to the 16th digit.
Example: Set DO0 and DO4 to ON
Binary notation: 0000 0000 0001 0001
Value of output statuses that are set: 17

Usage Cautions
・ This command is valid only in setup mode (IO monitor mode only).
Example
Set all DO output statuses of parallel I/O to ON.

112
.NET Control Reference Manual
Me.CoreRA1.SetRunMode(2)
Me.CoreRA1.IOMonitorStart()
Dim ioModule As String = "ParallelIo"
'Set the output statuses.
Dim ret As Integer = Me.CoreRA1.PutAll(ioModule, 65535)
Me.CoreRA1.IOMonitorStop()
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
GetAll (Reference:  Details (p.58)) GetPort (Reference:  Details (p.76))
PutPort (Reference:  Details (p.114)) SetParallelJudgeData
(Reference:  Details (p.148))

113
.NET Control Reference Manual
8-5-63 PutPort

Sets the output status of a specified output terminal.

Format
Function PutPort(ByVal ioIdent As String, ByVal portKind As Integer, ByVal portNo
As Integer, ByVal state As Integer) As Integer

Parameter
Parameter
Data type Description
name
<ioIdent> String Identifier of the communication module to be used (always "ParallelIo")
Terminal type of output terminal whose output status is to be set.
3: RUN
4: ERROR
5: BUSY
6: OR
<portKind> Integer
7: GATE
9: DO0 to DO15
10: STGOUT
11: SHTOUT
12: ACK
Terminal number of output terminal whose output status is to be set.
When the terminal type is DO
<portNo> Integer 0 to 15: DO0 to DO15
・ When the terminal type is other than DO
0 only
Output status of output terminal
<state> Integer 0: Output OFF
1: Output ON

Return value
 Error code (0: Normal, -1: Error)

Description
Sets the state of the output terminal of the terminal number specified in the <portKind>
parameter and the <portNo> parameter of the communication module specified in the <ioIdent>
parameter to the output status specified in the <state> parameter.

Usage Cautions
・ This command is valid only in setup mode (IO monitor mode only).
Example
Set the DO3 output status of parallel I/O to ON.

Me.CoreRA1.SetRunMode(2)
Me.CoreRA1.IOMonitorStart()
Dim ioModule As String = "ParallelIo"
Set the output statuses.
Dim ret As Integer = Me.CoreRA1.PutPort(ioModule, 9, 3, 1)
Me.CoreRA1.IOMonitorStop()
Me.CoreRA1.SetRunMode(1)

114
.NET Control Reference Manual
Supported Versions
Version 1.91 or later

Related Items
GetAll (Reference:  Details (p.58)) GetPort (Reference:  Details (p.76))
PutAll (Reference:  Details (p.112))

115
.NET Control Reference Manual
8-5-64 RefreshImageWindow

Updates the image display window and text display window.

Format
Function RefreshImageWindow() As Integer

Parameter
None.
Return value
 Error code (0: Normal, -1: Error)

Description
Updates the image display window and the text display window.

Usage Cautions
・ None.

Example
Update an image displayed in "Camera Image Freeze" image mode to the most recent image. Apply
the updated image to the image window and the text display window.

'Update the frozen image to the most recent image.


Dim ret As Integer = Me.CoreRA1.ImageUpdate()
'Apply the updated image to the display in the image window.
ret = Me.CoreRA1.RefreshImageWindow()

Supported Versions
Version 1.91 or later

Related Items
ImageUpdate (Reference:  Details (p.85))

116
.NET Control Reference Manual
8-5-65 ReMeasure

Executes remeasurement.

Format
Function ReMeasure(ByVal preImageNo As Integer) As Integer
Function ReMeasure(ByVal imagefileName As String) As Integer

Parameter
Parameter
Data type Description
name
Image logging number (-1 to (number of images in the sensor already logged
<preImageNo> Integer
minus one)) of image to be remeasured
<imagefileName> String Image file name of image to be remeasured

Return value
 Error code (0: Normal, -1: Error)

Description
Executes remeasurement for the image of the image logging number specified in the
<preImageNo> parameter or the image of the image logging file name specified in the
<imagefileName> parameter.
In the <preImageNo> parameter, specify the image number of the logging image already logged
as a logging image in the sensor.
If -1 is specified for the <preImageNo> parameter, remeasurement is executed using the most
recent input image.
If 0 is specified for the <preImageNo> parameter, remeasurement is executed using the most
recent logged image of the sensor.
Specify the <imagefileName> parameter by an absolute path.

Usage Cautions
・ This command is only valid in setup mode.

Example
Execute remeasurement using the image of image logging number 0.

Me.CoreRA1.SetRunMode(2)
Dim ret As Integer = Me.CoreRA1.ReMeasure(0)
Me.CoreRA1.SetRunMode(1)

Execute remeasurement using the image with the specified file name.

Me.CoreRA1.SetRunMode(2)
Dim ret As Integer = Me.CoreRA1.ReMeasure("C:\BACKDIR\a.ifz")
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

117
.NET Control Reference Manual
Related Items
GetRunMode (Reference:  Details (p.82)) Measure (Reference:  Details (p.94))
SetRunMode (Reference:  Details (p.156))

118
.NET Control Reference Manual
8-5-66 RetryData

Gets the numerical data of a retry.

Format
Function RetryData(ByVal dataNo As Integer) As Double

Parameter
Parameter
Data type Description
name
External reference data number of the retry (Reference: 8-6 External
<dataNo> Integer
Reference Parameters (p.163))

Return value
Returns retry data as a double precision floating point decimal value.
Returns -1 if an error occurs.

Description
Gets the retry numerical data specified in the <dataNo> parameter.

Usage Cautions
・ None.

Example
Get external reference data No. 121 (max count) of the retry data.

Dim data As Double = Me.CoreRA1.RetryData(121)

Supported Versions
Version 1.91 or later

Related Items
GetRetryData (Reference:  Details (p.80)) SetRetryData (Reference:  Details (p.155))

119
.NET Control Reference Manual
8-5-67 RunOut

Sets the output status of the RUN signal.

Format
Function RunOut(ByVal ioIdent As String, ByVal state As Integer) As Integer

Parameter
Parameter
Data type Description
name
<ioIdent> String Identifier of the communication module to be used ("ParallelIo")
Output status of terminal
<state> Integer 0: Output OFF
1: Output ON

Return value
 Error code (0: Normal, -1: Error)

Description
Sets the RUN signal state of the communication module specified in the <ioIdent> parameter to the state
specified in the <state> parameter.

Usage Cautions
・ This command is valid only in setup mode (IO monitor mode only).
・ This command requires the Parallel Interface Sensor Data Unit.

Example
Set the RUN signal of parallel I/O to ON.

Me.CoreRA1.SetRunMode(2)
Me.CoreRA1.IOMonitorStart()
Dim ioModule As String = "ParallelIo"
Set the output statuses.
Dim ret As Integer = Me.CoreRA1.RunOut(ioModule, 1)
Me.CoreRA1.IOMonitorStop()
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
GetAll (Reference:  Details (p.58)) GetPort (Reference:  Details (p.76))
PutAll (Reference:  Details (p.112)) PutPort (Reference:  Details (p.114))

120
.NET Control Reference Manual
8-5-68 SaveBackupData

Saves all setting data (all scene data, system data, and calibration group data) of the sensor to a
file.
Format
Function SaveBackupData(ByVal fileName As String) As Integer

Parameter
Parameter
Data type Description
name
<fileName> String Name (*.bkd) of backup file for all setting data

Return value
 Error code (0: Normal, -1: Error)

Description
Saves all setting data in the file specified in the <fileName> parameter.
In the <fileName> parameter, use an absolute path to specify the file name of the file to be saved.
Specify the file extension ".bkd" in the file name specified in the <fileName> parameter.
If the file specified in the <fileName> parameter already exists, it is overwritten.

Usage Cautions
・ None.
Example
Save all setting data in a file.

Dim ret As Integer = Me.CoreRA1.SaveBackupData("C:\BACKDIR\BackupData.bkd")

Supported Versions
Version 1.91 or later

Related Items
GetSystemData (Reference:  Details (p.83)) LoadBackupData (Reference:  Details (p.90))
SaveData (Reference:  Details (p.122)) SaveScene (Reference:  Details (p.125))
SaveSceneGroup SaveSystemData (Reference:  Details (p.127))
(Reference:  Details (p.126))

121
.NET Control Reference Manual
8-5-69 SaveData

Saves all sensor setting data in the sensor.

Format
Function SaveData() As Integer

Parameter
None.

Return value
 Error code (0: Normal, -1: Error)

Description
Saves all sensor setting data in the sensor.

Usage Cautions
・ This command is only valid in setup mode.

Example
Save all setting data in the sensor.

Me.CoreRA1.SetRunMode(2)
Dim ret As Integer = Me.CoreRA1.SaveData()
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
SaveBackupData SaveScene (Reference:  Details (p.125))
(Reference:  Details (p.121))
SaveSceneGroup SaveSystemData (Reference:  Details (p.127))
(Reference:  Details (p.126))

122
.NET Control Reference Manual
8-5-70 SaveImage

Saves image data.

Format
Function SaveImage(ByVal preImageNo As Integer, ByVal fileName As String) As
Integer

Parameter
Parameter
Data type Description
name
Image number (0 to 19) of the logging image to be saved
<preImageNo> Integer
(-1) saves the most recent image.
<fileName> String File name of image to be saved

Return value
 Error code (0: Normal, -1: Error)

Description
Saves the image that has the image logging number specified in the <preImageNo> parameter,
using the file name in ifz format specified in the <fileName> parameter.
In the <preImageNo> parameter, specify the image number of the logging image already logged
as a logging image in the sensor.
In the <fileName> parameter, use an absolute path to specify the file name of the file to be saved.
Specify the file extension ".ifz" in the file name specified in the <fileName> parameter.
If the file specified in the <fileName> parameter already exists, it is overwritten.

Usage Cautions
・ This command is only valid in setup mode.

Example
Save the image with image logging number 0 to a file.

Me.CoreRA1.SetRunMode(2)
Dim ret As Integer = Me.CoreRA1.SaveImage(0, "C:\BACKDIR\a.ifz")
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
SaveLoggingData
(Reference:  Details (p.124))

123
.NET Control Reference Manual
8-5-71 SaveLoggingData

Saves the measurement data that is saved by data logging in the sensor memory to a file.

Format
Function SaveLoggingData(ByVal fileName As String) As Integer

Parameter
Parameter
Data type Description
name
<fileName> String File name of the logging data to be saved

Return value
 Error code (0: Normal, -1: Error)

Description
Saves logging data in the file specified in the <fileName> parameter.
Specify the file extension ".csv" in the file name specified in the <fileName> parameter.
If the file specified in the <fileName> parameter already exists, it is overwritten.

Usage Cautions
・ None.

Example
Saves the measurement data that is saved by data logging in the sensor memory to a file.

Dim ret As Integer = Me.CoreRA1.SaveLoggingData("C:\BACKDIR\loggingData.csv")

Supported Versions
Version 1.91 or later

Related Items
SaveImage (Reference:  Details (p.123))

124
.NET Control Reference Manual
8-5-72 SaveScene

Saves scene data.

Format
Function SaveScene(ByVal sceneNo As Integer, ByVal fileName As String) As
Integer

Parameter
Parameter
Data type Description
name
<sceneNo> Integer Scene number to save the scene (0 to 31)
<fileName> String Name of the scene data file to be saved (*.scn)

Return value
 Error code (0: Normal, -1: Error)

Description
Saves the scene data with the scene number specified in the <sceneNo> parameter in the file
with the file name specified in the <fileName> parameter.
In the <fileName> parameter, use an absolute path to specify the file name of the file to be saved.
Specify the file extension ".scn" in the file name specified in the <fileName> parameter.
If the file specified in the <fileName> parameter already exists, it is overwritten.

Usage Cautions
・ None.

Example
Save the scene data of scene 2 in a file.

Dim ret As Integer = Me.CoreRA1.SaveScene(2, "C:\BACKDIR\scene02.scn")

Supported Versions
Version 1.91 or later

Related Items
LoadScene SaveBackupData
(Reference:  Details (p.91)) (Reference:  Details (p.121))
SaveData SaveSceneGroup
(Reference:  Details (p.122)) (Reference:  Details (p.126))
SaveSystemData (Reference:  Details (p.127))

125
.NET Control Reference Manual
8-5-73 SaveSceneGroup

Saves the scene group data.

Format
Function SaveSceneGroup(ByVal fileName As String) As Integer

Parameter
Parameter
Data type Description
name
<fileName> String Name of the scene group data file to be saved (*.sgp)

Return value
 Error code (0: Normal, -1: Error)

Description
Saves the scene group data in the file with the file name specified in the <fileName> parameter.
In the <fileName> parameter, use an absolute path to specify the file name of the file to be saved.
Specify the file extension ".sgp" in the file name specified in the <fileName> parameter.
If the file specified in the <fileName> parameter already exists, it is overwritten.

Usage Cautions
・ None.
Example
Save the scene group data in a file.

Dim ret As Integer = Me.CoreRA1.SaveSceneGroup("C:\BACKDIR\scenegroup.sgp")

Supported Versions
Version 1.91 or later

Related Items
LoadSceneGroup SaveBackupData
(Reference:  Details (p.92)) (Reference:  Details (p.121))
SaveData (Reference:  Details (p.122)) SaveScene (Reference:  Details (p.125))
SaveSystemData (Reference:  Details (p.127))

126
.NET Control Reference Manual
8-5-74 SaveSystemData

Saves system data.

Format
Function SaveSystemData(ByVal fileName As String) As Integer

Parameter
Parameter
Data type Description
name
<fileName> String Name of the system data file to be saved (*.syd)

Return value
 Error code (0: Normal, -1: Error)

Description
Saves the system data in the file with the file name specified in the <fileName> parameter.
In the <fileName> parameter, use an absolute path to specify the file name of the file to be saved.
Specify the file extension ".syd" in the file name specified in the <fileName> parameter.
If the file specified in the <fileName> parameter already exists, it is overwritten.

Usage Cautions
・ None.

Example
Save the system data in a file.

Dim ret As Integer = Me.CoreRA1.SaveSystemData("C:\BACKDIR\backupsysset.syd")

Supported Versions
Version 1.91 or later

Related Items
GetSystemData (Reference:  Details (p.83)) LoadSystemData (Reference:  Details (p.93))
SaveBackupData SaveData (Reference:  Details (p.122))
(Reference:  Details (p.121))
SaveScene (Reference:  Details (p.125)) SaveSceneGroup
(Reference:  Details (p.126))

127
.NET Control Reference Manual
8-5-75 SceneCount

Gets the number of scenes that can be used.

Format
Function SceneCount() As Integer

Parameter
None.

Return value
Returns the number of scenes that can be used as an integer.
Returns -1 if an error occurs.

Description
Gets the number of scenes that can be used.

Usage Cautions
・ None.

Example
Gets the number of scenes that can be used.

Dim num As Integer = Me.CoreRA1.SceneCount()

Supported Versions
Version 1.91 or later

Related Items
ChangeScene (Reference:  Details (p.48)) ClearScene (Reference:  Details (p.51))
CopyScene (Reference:  Details (p.55)) SceneNo (Reference:  Details (p.129))

128
.NET Control Reference Manual
8-5-76 SceneNo

Gets the scene number of the current scene.

Format
Function SceneNo() As Integer

Parameter
None.

Return value
Returns the scene number of the current scene as an integer.
Returns -1 if an error occurs.

Description
Gets the scene number of the current scene.

Usage Cautions
・ None.

Example
Get the scene number of the current scene. If the scene number is not 2, change to scene 2.

'Get the scene number of the current scene.


Dim no As Integer = Me.CoreRA1.SceneNo()
'If the scene number is not 2, change to scene 2
Dim ret As Integer
If no <> 2 Then
ret = Me.CoreRA1.ChangeScene(2)
End If

Supported Versions
Version 1.91 or later

Related Items
ChangeScene (Reference:  Details (p.48)) ClearScene (Reference:  Details (p.51))
CopyScene (Reference:  Details (p.55)) SceneCount (Reference:  Details (p.128))

129
.NET Control Reference Manual
8-5-77 SceneTitle

Gets the scene title.

Format
Function SceneTitle(ByVal sceneNo As Integer) As String

Parameter
Parameter
Data type Description
name
<sceneNo> Integer Scene number (0 to 31)

Return value
Returns the scene title as a character string.
Returns null if an error occurs.

Description
Gets the title set in the scene that has the scene number specified in the <sceneNo> parameter.
If a title name is not set, returns null.

Usage Cautions
・ None.

Example
Get the title of scene 2.

Dim title As String = Me.CoreRA1.SceneTitle(2)

Supported Versions
Version 1.91 or later

Related Items
SetSceneTitle (Reference:  Details (p.157))

130
.NET Control Reference Manual
8-5-78 SensorName

Gets the sensor name.

Format
Function SensorName() As String

Parameter

 None
Return value
Returns the sensor name as a character string.
Returns null if an error occurs.

Description
Gets the FQ2 sensor name.
If a sensor name is not set, returns the default value "FQ".

Usage Cautions
・ None.

Example
Gets the sensor name.

Dim title As String = Me.CoreRA1.SensorName()

Supported Versions
Version 1.91 or later

Related Items
SetSensorName (Reference:  Details (p.158))

131
.NET Control Reference Manual
8-5-79 SetCalculationData

Sets calculation data.

Format
Function SetCalculationData(ByVal dataNo As Integer, ByVal data As Integer) As
Integer
Function SetCalculationData(ByVal dataNo As Integer, ByVal data As Double) As
Integer
Function SetCalculationData(ByVal dataNo As Integer, ByVal data As String, ByVal
string_type As Integer) As Integer

Parameter
Parameter
Data type Description
name
External reference data number of the calculation (Reference: 8-6
<dataNo> Integer
External Reference Parameters (p.163))
Integer
<data> Double Setting data
String
If the setting data is a character string, specify the character string type (0:
<string_type> Integer
char, 1: TCHAR)

Return value
 Error code (0: Normal, -1: Error)

Description
Sets the data specified in the <data> parameter in the calculation data specified in the
<dataNo> parameter.
Change the data type of the <data> parameter to the type of data to be set.

Usage Cautions
・ This command is only valid in setup mode.

Example
Set external reference data No. 410 (data logging switch) in the calculation data.

Me.CoreRA1.SetRunMode(2)
Dim data As Integer = 1
'Change the variable data type to signed integer because the data logging switch value is an integer.
Dim ret As Integer = Me.CoreRA1.SetCalculationData(410, data)
Me.CoreRA1.SetRunMode(1)

Set external reference data No. 300 (judgement upper limit 0) in the calculation data.

Me.CoreRA1.SetRunMode(2)
Dim data As Double = 100.0
'Change the variable data type to double precision floating point decimal because the judgement upper limit
value is a real number.
Dim ret As Integer = Me.CoreRA1.SetCalculationData(300, data)
Me.CoreRA1.SetRunMode(1)

132
.NET Control Reference Manual
Set external reference data No. 150 (expression name 0) in the calculation data.

Me.CoreRA1.SetRunMode(2)
Dim data As String = "1+2"
'Change the variable data type to string because expression name 0 is a character string.
Dim ret As Integer = Me.CoreRA1.SetCalculationData(150, data,0)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
CalculationData (Reference:  Details (p.45)) GetCalculationData
(Reference:  Details (p.61))

133
.NET Control Reference Manual
8-5-80 SetCameraData

Sets data in a camera parameter.

Format
Function SetCameraData(ByVal dataNo As Integer, ByVal data As Integer) As
Integer
Function SetCameraData(ByVal dataNo As Integer, ByVal data As Double) As
Integer

Parameter
Parameter
Data type Description
name
<dataNo> Integer Camera parameter number
Integer
<data> Setting data
Double

Return value
 Error code (0: Normal, -1: Error)

Description
Sets the data specified in the <data> parameter in the camera image input data specified in the
<dataNo> parameter.
For the camera parameter numbers, refer to "Camera parameter numbers" in FQ2-S/CH Series
User's Manual for Communications Settings (Cat. No. Z338).
Change the data type of the <data> parameter to the type of data to be set.

Usage Cautions
・ This command is only valid in setup mode.

Example
Set data in camera parameter No. 1 (shutter speed).

Me.CoreRA1.SetRunMode(2)
Dim data As Integer = 20
'Change the variable data type to signed integer because the shutter speed value is an integer.
Dim ret As Integer = Me.CoreRA1.SetCameraData(1, data)
Me.CoreRA1.SetRunMode(1)

Set data in camera parameter No. 10 (white balance R scaling).

Me.CoreRA1.SetRunMode(2)
Dim data As Double = 1.2
'Change the variable data type to double precision floating point decimal because the white balance R
scaling data value is a real number.
Dim ret As Integer = Me.CoreRA1.SetCameraData(10, data)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

134
.NET Control Reference Manual
Related Items
CameraData (Reference:  Details (p.47)) GetCameraData (Reference:  Details (p.63))

135
.NET Control Reference Manual
8-5-81 SetLinkOutputData

Sets the data output by link data / Fieldbus data communication.

Format
Function SetLinkOutputData(ByVal dataNo As Integer, ByVal data As Integer) As
Integer
Function SetLinkOutputData(ByVal dataNo As Integer, ByVal data As String, ByVal
string_type As Integer) As Integer

Parameter
Parameter
Data type Description
name
Data number of external reference data of link data output / Fieldbus
<dataNo> Integer
data output (Reference: 8-6 External Reference Parameters (p.163))
Integer
<data> Setting data
String
If the setting data is a character string, specify the character string type (0:
<string_type> Integer
char, 1: TCHAR)

Return value
 Error code (0: Normal, -1: Error)

Description
Sets the data output by link data / Fieldbus data communication.
Change the data type of the <data> parameter to the type of data to be set.
Usage Cautions
・ This command is only valid in setup mode.
Example
Set external reference data No. 307 (output format) of link data output / Fieldbus data output.

Me.CoreRA1.SetRunMode(2)
Dim data As Integer
'Change the variable data type to signed integer because the output format is an integer value.
Dim ret As Integer = Me.CoreRA1.SetLinkOutputData(307, data)
Me.CoreRA1.SetRunMode(1)

Set external reference data No. 120 (output data 0) of link data output / Fieldbus data output. 

Me.CoreRA1.SetRunMode(2)
Dim data As String = "1+2"
'Change the variable data type to string because the output data 0 value is a character string.
Dim ret As Integer = Me.CoreRA1.SetLinkOutputData(120, data,0)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items

136
.NET Control Reference Manual
GetLinkOutputData
(Reference:  Details (p.66))

137
.NET Control Reference Manual
8-5-82 SetMeasureItemData

Sets the data of an inspection item.

Format
Function SetMeasureItemData(ByVal itemNo As Integer, ByVal dataNo As Integer,
ByVal data As Integer) As Integer
Function SetMeasureItemData(ByVal itemNo As Integer, ByVal dataNo As Integer,
ByVal data As Double) As Integer
Function SetMeasureItemData(ByVal itemNo As Integer, ByVal dataNo As Integer,
ByVal data As String, ByVal string_type As Integer) As Integer

Parameter
Parameter
Data type Description
name
<itemNo> Integer Item number (0 to 31) of the inspection item
<dataNo> Integer External reference data number of the inspection item
Integer
<data> Double Setting data
String
If the setting data is a character string, specify the character string type (0:
<string_type> Integer
char, 1: TCHAR)

Return value
 Error code (0: Normal, -1: Error)

Description
Sets the data of an inspection item.
Set the same data type for the <data> parameter as the data to be acquired.
Usage Cautions
・ This command is only valid in setup mode.
Example
Set external reference data No. 103 (reflect) of inspection item No. 1 (search).

Me.CoreRA1.SetRunMode(2)
Dim data As Integer = 1
'Change the variable data type to signed integer because the reflect value is an integer.
Dim ret As Integer = Me.CoreRA1.SetMeasureItemData(1, 103, data)
Me.CoreRA1.SetRunMode(1)

Sets external reference data No. 132 (detection point X) of inspection item No. 1 (search).

Me.CoreRA1.SetRunMode(2)
Dim data As Double = 100.0
'Change the variable data type to double precision floating point decimal because the detection point X
data value is a real number.
Dim ret As Integer = Me.CoreRA1.SetMeasureItemData(1, 132, data)
Me.CoreRA1.SetRunMode(1)

Set external reference data No. 127 (error string) of inspection item No. 2 (2D code).

138
.NET Control Reference Manual
Me.CoreRA1.SetRunMode(2)
Dim data As String = "CodeNG"
'Change the variable data type to string because the decode character string is a character string.
Dim ret As Integer = Me.CoreRA1.SetMeasureItemData(2, 127, data, 0)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
GetMeasureItemData
(Reference:  Details (p.68))

139
.NET Control Reference Manual
8-5-83 SetMeasureItemFigure

Sets inspection item figure data.

Format
Function SetMeasureItemFigure(ByVal itemNo As Integer, ByVal figureNo As
Integer, ByVal figure As Integer()) As Integer

Parameter
Parameter
Data type Description
name
<itemNo> Integer Item number (0 to 31) of the inspection item
<figureNo> Integer Region number (0 to 7)
<figure> Integer() Figure data to be set

Return value
 Error code (0: Normal, -1: Error)

Description
Sets inspection item figure data.
For region numbers and figure data, refer to "SETITEMFIGPARAM or SIFP" in FQ2-S/CH Series
User's Manual for Communications Settings (Cat. No. Z338).

Usage Cautions
・ This command is only valid in setup mode.

Example
Set the coordinates of the upper left corner of figure data No. 1 (region figure) of inspection item
No. 1 (search) to (100, 50).

Me.CoreRA1.SetRunMode(2)
Dim figure(5) As Integer
Dim ret As Integer = Me.CoreRA1.GetMeasureItemFigure(1, 1, figure)

If ret = 0 Then

 figure(2) = 100
 figure(3) = 50

 ret = Me.CoreRA1.SetMeasureItemFigure(1, 1, figure)

End If
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items

140
.NET Control Reference Manual
GetMeasureItemData GetMeasureItemFigure
(Reference:  Details (p.68)) (Reference:  Details (p.70))

141
.NET Control Reference Manual
8-5-84 SetMeasureItemTitle
Sets the title of an inspection item.

Format
Function SetMeasureItemTitle(ByVal itemNo As Integer, ByVal unitTitle As String)
As Integer

Parameter
Parameter
Data type Description
name
<itemNo> Integer Inspection item number (0 to 31) of inspection item whose title is to be set
<unitTitle> Integer Title to be set

Return value
 Error code (0: Normal, -1: Error)

Description
Sets the title specified in the <unitTitle> parameter in the title of the inspection item specified in
the <itemNo> parameter.
The title can be set in the language specified in the language setting.

Usage Cautions
・ This command is only valid in setup mode.

Example
Set the title of inspection item No. 1 (search).

Me.CoreRA1.SetRunMode(2)
Dim unitTitle As String = "MySearch"
'Set the title of inspection item No. 1 (search).
Dim ret As Integer = Me.CoreRA1.SetMeasureItemTitle(1, unitTitle)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
MeasureItemCount MeasureItemIdent
(Reference:  Details (p.95)) (Reference:  Details (p.98))
MeasureItemTitle (Reference:  Details (p.100))

142
.NET Control Reference Manual
8-5-85 SetMeasureOut

Sets whether or not measurement results are output to an external device.

Format
Function SetMeasureOut(ByVal mode As Integer) As Integer

Parameter
Parameter
Data type Description
name
<mode> Integer Output yes/no (0: Yes, 1: No)

Return value
 Error code (0: Normal, -1: Error)

Description
Sets whether or not measurement results are output to an external device.
Usage Cautions
・ None.
Example
Sets measurement result output to "enable".

Dim ret As Integer = Me.CoreRA1.SetMeasureOut(1)

Supported Versions
Version 1.91 or later

Related Items
GetMeasureOut (Reference:  Details (p.71))

143
.NET Control Reference Manual
8-5-86 SetNoprotocolOutputData

Sets the data that is output by no protocol data communication.

Format
Function SetNoprotocolOutputData(ByVal dataNo As Integer, ByVal data As
Integer) As Integer
Function SetNoprotocolOutputData(ByVal dataNo As Integer, ByVal data As
String, ByVal string_type As Integer) As Integer

Parameter
Parameter
Data type Description
name
External reference data number of no protocol data output (Reference:
<dataNo> Integer
8-6 External Reference Parameters (p.163))
Integer
<data> Setting data
String
If the setting data is a character string, specify the character string type (0:
<string_type> Integer
char, 1: TCHAR)

Return value
 Error code (0: Normal, -1: Error)

Description
Sets the data that is output by no protocol data communication.
Change the data type of the <data> parameter to the type of data to be set.
Usage Cautions
・ This command is only valid in setup mode.
Example
Set external reference data No. 300 (data format) of no protocol data output to ASCII.

Me.CoreRA1.SetRunMode(2)
Dim data As Integer = 0
'Change the variable data type to signed integer because the data type is integer.
Dim ret As Integer = Me.CoreRA1.SetNoprotocolOutputData(300, data)
Me.CoreRA1.SetRunMode(1)

Set external reference data No. 120 (output data 0) of no protocol data output. 

Me.CoreRA1.SetRunMode(2)
Dim data As String = "1+2"
'Change the variable data type to string because the output data 0 value is a character string.
Dim ret As Integer = Me.CoreRA1.SetNoprotocolOutputData(120, data,0)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items

144
.NET Control Reference Manual
GetNoprotocolOutputData
(Reference:  Details (p.72))

145
.NET Control Reference Manual
8-5-87 SetParallelData

Sets the data that is output by parallel data communication.

Format
Function SetParallelData(ByVal dataNo As Integer, ByVal data As Integer) As
Integer
Function SetParallelData(ByVal dataNo As Integer, ByVal data As String, ByVal
string_type As Integer) As Integer

Parameter
Parameter
Data type Description
name
External reference data number of parallel data output (Reference: 8-
<dataNo> Integer
6 External Reference Parameters (p.163))
Integer
<data> Setting data
String
If the setting data is a character string, specify the character string type (0:
<string_type> Integer
char, 1: TCHAR)

Return value
 Error code (0: Normal, -1: Error)

Description
Sets the data that is output by parallel data communication.
Set the same data type for the <data> parameter as the data to be acquired.
Usage Cautions
・ This command is only valid in setup mode.
Example
Set external reference data No. 300 (data format) of parallel data output.

Me.CoreRA1.SetRunMode(2)
Dim data As Integer = 0
'Change the variable data type to signed integer because the output format is an integer value.
Dim ret As Integer = Me.CoreRA1.SetParallelData(300, data)
Me.CoreRA1.SetRunMode(1)

Set external reference data No. 150 (output data 0) of parallel data output. 

Me.CoreRA1.SetRunMode(2)
Dim data As String = "1+2"
'Change the variable data type to string because the output data 0 value is a character string.
Dim ret As Integer = Me.CoreRA1.SetParallelData(150, data,0)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items

146
.NET Control Reference Manual
GetParallelData (Reference:  Details (p.73)) ParallelData (Reference:  Details (p.103))

147
.NET Control Reference Manual
8-5-88 SetParallelJudgeData

Sets the data that is output by parallel judgement output.

Format
Function SetParallelJudgeData(ByVal dataNo As Integer, ByVal data As Integer)
As Integer
Function SetParallelJudgeData(ByVal dataNo As Integer, ByVal data As Double)
As Integer
Function SetParallelJudgeData(ByVal dataNo As Integer, ByVal data As String,
ByVal string_type As Integer) As Integer

Parameter
Parameter
Data type Description
name
External reference data number of parallel judgement output
<dataNo> Integer
(Reference: 8-6 External Reference Parameters (p.163))
Integer
<data> Double Setting data
String
If the setting data is a character string, specify the character string type (0:
<string_type> Integer
char, 1: TCHAR)

Return value
 Error code (0: Normal, -1: Error)

Description
Sets the data that is output by parallel judgement output.
Set the same data type for the <data> parameter as the data to be acquired.
Usage Cautions
・ This command is only valid in setup mode.
Example
Get external reference data No. 103 (reflect) of parallel judgement output.

Me.CoreRA1.SetRunMode(2)
Dim data As Integer = 0
'Change the variable data type to signed integer because the reflect value is an integer.
Dim ret As Integer = Me.CoreRA1.SetParallelJudgeData(103, data)
Me.CoreRA1.SetRunMode(1)

Set external reference data No. 300 (judgement upper limit) of parallel judgement output.

Me.CoreRA1.SetRunMode(2)
Dim data As Double = 100.0
'Change the variable data type to double precision floating point decimal because the judgement upper limit
value is a real number.
Dim ret As Integer = Me.CoreRA1.SetParallelJudgeData(300, data)
Me.CoreRA1.SetRunMode(1)

Set external reference data No. 150 (output data 0) of parallel judgement output. 

148
.NET Control Reference Manual
Me.CoreRA1.SetRunMode(2)
Dim data As String = "1+2"
'Change the variable data type to string because the output data is a character string.
Dim ret As Integer = Me.CoreRA1.SetParallelJudgeData(150, data, 0)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
GetParallelJudgeData ParallelJudgeData
(Reference:  Details (p.74)) (Reference:  Details (p.105))

149
.NET Control Reference Manual
8-5-89 SetPositionItemData

Sets the data of an image adjustment item.

Format
Function SetPositionItemData(ByVal itemNo As Integer, ByVal dataNo As Integer,
ByVal data As Integer) As Integer
Function SetPositionItemData(ByVal itemNo As Integer, ByVal dataNo As Integer,
ByVal data As Double) As Integer

Parameter
Parameter
Data type Description
name
<itemNo> Integer Item number (0 to 7) of the image adjustment item.
<dataNo> Integer External reference data number of the image adjustment item
Integer
<data> Setting data
Double

Return value
 Error code (0: Normal, -1: Error)

Description
Sets the data of an image adjustment item.
Change the data type of the <data> parameter to the type of data to be set.
Usage Cautions
・ This command is only valid in setup mode.
Example
Set external reference data No. 120 (source image) of image adjustment item No. 1 (color gray
filter).

Me.CoreRA1.SetRunMode(2)
Dim data As Integer = 1
'Change the variable data type to signed integer because the source image data value is an integer.
Dim ret As Integer = Me.CoreRA1.SetPositionItemData(1, 120, data)
Me.CoreRA1.SetRunMode(1)

Set external reference data No. 145 (detection point X) of image adjustment item No. 2 (search
position compensation).

Me.CoreRA1.SetRunMode(2)
Dim data As Double = 100.0
'Change the variable data type to double precision floating point decimal because the detection point X is a
real number.
Dim ret As Integer = Me.CoreRA1.SetPositionItemData(2, 145, data)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

150
.NET Control Reference Manual
Related Items
GetPositionItemData PositionItemData
(Reference:  Details (p.78)) (Reference:  Details (p.108))

151
.NET Control Reference Manual
8-5-90 SetPositionItemFigure

Sets the figure data of an image adjustment item.

Format
Function SetPositionItemFigure(ByVal itemNo As Integer, ByVal figureNo As
Integer, ByVal figure As Integer()) As Integer

Parameter
Parameter
Data type Description
name
<itemNo> Integer Item number (0 to 7) of the image adjustment item.
<figureNo> Integer Region number (0 to 7)
Figure data to be set (Reference: 8-4 Figure Data List (p.30))
<figure> Integer()

Return value
 Error code (0: Normal, -1: Error)

Description
Sets the figure data of an image adjustment item.
For region numbers and figure data, refer to "SETITEMFIGPARAM or SIFP" in FQ2-S/CH Series
User's Manual for Communications Settings (Cat. No. Z338).

Usage Cautions
・ This command is only valid in setup mode.

Example
Set the coordinates of the upper left corner of figure data No. 1 (region figure) of image
adjustment item No. 0 (extract edges) to (100, 50).

Me.CoreRA1.SetRunMode(2)
Dim figure(5) As Integer
Dim ret As Integer = Me.CoreRA1.GetPositionItemFigure(1, 0, figure)

If ret = 0 Then

 figure(2) = 100
 figure(3) = 50

ret = Me.CoreRA1.SetPositionItemFigure(1, 0, figure)

End If
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items

152
.NET Control Reference Manual
GetPositionItemFigure
(Reference:  Details (p.79))

153
.NET Control Reference Manual
8-5-91 SetPositionItemTitle
Sets the title of an image adjustment item

Format
Function SetPositionItemTitle(ByVal itemNo As Integer, ByVal unitTitle As String)
As Integer

Parameter
Parameter
Data type Description
name
Inspection item number (0 to 7) of image adjustment item whose title is to be
<itemNo> Integer
set
<unitTitle> String Title to be set

Return value
 Error code (0: Normal, -1: Error)

Description
Sets the title specified in the <unitTitle> parameter in the title of the image adjustment item
specified in the <itemNo> parameter.
The title can be set in the language specified in the language setting.

Usage Cautions
・ This command is only valid in setup mode.

Example
Get the title of image adjustment item No. 1 (position compensation).

Me.CoreRA1.SetRunMode(2)
Dim unitTitle As String = "MyScroll"
'Set the title of image adjustment item No. 1 (position compensation).
Dim ret As Integer = Me.CoreRA1.SetPositionItemTitle(1, unitTitle)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
PositionItemCount PositionItemIdent
(Reference:  Details (p.107)) (Reference:  Details (p.109))

154
.NET Control Reference Manual
8-5-92 SetRetryData

Sets retry data.

Format
Function SetRetryData(ByVal dataNo As Integer, ByVal data As Integer) As
Integer
Function SetRetryData(ByVal dataNo As Integer, ByVal data As Double) As Integer

Parameter
Parameter
Data type Description
name
<dataNo> Integer External reference data number of retry
Integer
<data> Setting data
Double

Return value
 Error code (0: Normal, -1: Error)

Description
Sets retry data.
Change the data type of the <data> parameter to the type of data to be set.

Usage Cautions
・ This command is only valid in setup mode.

Example
Set external reference data No. 121 (max count) of the retry.

Me.CoreRA1.SetRunMode(2)
Dim data As Integer = 2
'Change the variable data type to signed integer because the max count value is an integer.
Dim ret As Integer = Me.CoreRA1.SetRetryData(121, data)
Me.CoreRA1.SetRunMode(1)

Set external reference data No. 123 (shutter speed step) of the retry.

Me.CoreRA1.SetRunMode(2)
Dim data As Double = 0.02
'Change the variable data type to double precision floating point decimal because the shutter speed step
value is a real number.
Dim ret As Integer = Me.CoreRA1.SetRetryData(123, data)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
GetRetryData (Reference:  Details (p.80)) RetryData (Reference:  Details (p.119))

155
.NET Control Reference Manual
8-5-93 SetRunMode

Sets the execution status (execution mode) of the FQ2 sensor.

Format
Function SetRunMode(ByVal mode As Integer) As Integer

Parameter
Parameter
Data type Description
name
Execution mode
<mode> Integer 1: Run mode
2: Setup mode

Return value
 Error code (0: Normal, -1: Error)

Description
Sets the execution status (execution mode) of the FQ2 sensor.

Usage Cautions
・ None.
Example
  Change the execution mode to setup mode.
Dim ret As Integer = Me.CoreRA1.SetRunMode(2)

Supported Versions
Version 1.91 or later

Related Items
GetRunMode (Reference:  Details (p.82)) Measure (Reference:  Details (p.94))
Remeasure (Reference:  Details (p.117))

156
.NET Control Reference Manual
8-5-94 SetSceneTitle

Sets the title of a scene.

Format
Function SetSceneTitle(ByVal sceneNo As Integer, ByVal sceneTitle As String) As
Integer

Parameter

Parameter
Data type Description
name
<sceneNo> Integer Scene number (0 to 31) of the scene for which a title is to be set.
<sceneTitle> String Scene title

Return value
 Error code (0: Normal, -1: Error)

Description
Sets the title specified in the <sceneTitle> parameter in the title of the scene specified in the
<sceneNo> parameter.
If a title with 32 or more characters is specified in the <sceneTitle> parameter, the first 31
characters are set in the title.

Usage Cautions
・ This command is only valid in setup mode.

Example
Set the title of scene 2.

Me.CoreRA1.SetRunMode(2)
Dim ret As Integer = Me.CoreRA1.SetSceneTitle(2, "Title")
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
SceneTitle (Reference:  Details (p.130))

157
.NET Control Reference Manual
8-5-95 SetSensorName

Sets the sensor name.

Format
Function SetSensorName(ByVal name As String) As Integer

Parameter
Parameter
Data type Description
name
<name> String Sensor name

Return value
 Error code (0: Normal, -1: Error)

Description
Sets the FQ2 sensor name.
Usage Cautions
・ This command is only valid in setup mode.

Example
Sets the sensor name.

Me.CoreRA1.SetRunMode(2)
Dim name As String = "MyFq"
Dim ret As Integer = Me.CoreRA1.SetSensorName(name)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
SensorName (Reference:  Details (p.131))

158
.NET Control Reference Manual
8-5-96 SetSystemData

Sets the system data.


Format
Function SetSystemData(ByVal dataIdent0 As String, ByVal dataIdent1 As String,
ByVal data As Integer) As Integer

Parameter
Parameter
Data type Description
name
<dataIdent0> String Data identifier of identification information 0 of system data to be set.
<dataIdent1> String Data identifier of identification information 1 of system data to be set.
<data> Integer Value of the system data to be set

Return value
 Error code (0: Normal, -1: Error)

Description
Sets the value specified in the <data> parameter in the system data of identification information
1 specified in the <dataIdent1> parameter, which belongs to identification information 0
specified in the <dataIdent0> parameter.
For system data identification information, refer to the system data list. (Reference: System
Data List (p. 28))

Usage Cautions
・ This command is only valid in setup mode.

Example
Specify 7 for the startup scene number that belongs to identification information 0 of
"Configuration" and whose identification information 1 is "initialSceneNo".

Me.CoreRA1.SetRunMode(2)
'Set the startup scene number of Configuration.
Dim ret As Integer = Me.CoreRA1.SetSystemData("Configuration", "initialSceneNo", 7)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
GetSystemData (Reference:  Details (p.83))

159
.NET Control Reference Manual
8-5-97 SystemReset

Reboots the sensor.

Format
Function SystemReset() As Integer

Parameter
None.
Return value
 Error code (0: Normal, -1: Error)

Description
Reboots the sensor.

Usage Cautions
・ None.
Example
Reboots the sensor.

Dim ret As Integer = Me.CoreRA1.SystemReset()

Supported Versions
Version 1.91 or later

Related Items

 None

160
.NET Control Reference Manual
8-5-98 TeachMeasureItem

Executes teaching for a specified inspection item.

Format
Function TeachMeasureItem(ByVal itemNo As Integer) As Integer

Parameter
Parameter
Data type Description
name
<itemNo> Integer Item number (0 to 31) of the inspection item

Return value
 Error code (0: Normal, -1: Error)

Description
Executes teaching for the inspection item specified in the <itemNo> parameter.

Usage Cautions
・ This command is only valid in setup mode.

Example
Execute teaching for inspection item No. 1 (search).
Me.CoreRA1.SetRunMode(2)
Dim ret As Integer = Me.CoreRA1.TeachMeasureItem(1)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
TeachPositionItem
(Reference:  Details (p.162))

161
.NET Control Reference Manual
8-5-99 TeachPositionItem

Executes teaching for a specified image adjustment item.

Format
Function TeachPositionItem(ByVal itemNo As Integer) As Integer

Parameter
Parameter
Data type Description
name
<itemNo> Integer Item number (0 to 7) of the image adjustment item.

Return value
 Error code (0: Normal, -1: Error)

Description
Executes teaching for the image adjustment item specified in the <itemNo> parameter.

Usage Cautions
・ This command is only valid in setup mode.

Example
Execute teaching for image adjustment item No. 1 (shape search position compensation).
Me.CoreRA1.SetRunMode(2)
Dim ret As Integer = Me.CoreRA1.TeachPositionItem(1)
Me.CoreRA1.SetRunMode(1)

Supported Versions
Version 1.91 or later

Related Items
TeachMeasureItem
(Reference:  Details (p.161))

162
.NET Control Reference Manual
8-6 External Reference Parameters

 Retry 
External
reference Data name Set/Get Data type Data range Default
number
121 Max count Set/Get Integer 0 to 20 4
122 Interval Set/Get Integer 32 to 999 100
Shutterspeed
123 Set/Get Double 0.01 to 1 0.3
step
Brightness
124 Set/Get Integer 1 to 20 5
step
Exposure time
125 increment Set/Get Integer 0 to 10 2
count
Exposure time
126 decrement Set/Get Integer 0 to 10 2
count

 Calculation 
External
reference Data name Set/Get Data type Data range Default
number
-2: No judgement
0 Judgement Get Integer 0: Judgement result OK -2
-1: Judgement result NG
-999999999.9999
5+N Data N Get Double 0
to 999999999.9999
-2: No judgement
0: Judgement result OK
55 + N Judgement N Get Integer -2
-1: Judgement result NG

Apply overall
103 Set/Get Integer 0: Yes, 1: No 0
judgement
String Empty character string
150 + N Expression N Set/Get 255 characters
(char) (“”)
Name of String Empty character string
250 + N Set/Get 15 characters
expression N (TCHAR) (“”)
Judgement -999999999.9999
300 + N Set/Get Double 999999999.9999
upper limit N to 999999999.9999
Judgement -999999999.9999
350 + N Set/Get Double -999999999.9999
lower limit N to 999999999.9999
Data logging
0: Data logging OFF
410 switch Set/Get Integer 1
1: Data logging ON
(all items)
Data logging 0: Data logging OFF
411 sw for Set/Get Integer 1: Data logging ON 1
judgement

 (N = 0 to 31)

163
.NET Control Reference Manual
 No protocol data output 
External
reference Data name Set/Get Data type Data range Default
number
Output data String Empty character string
120 + N Set/Get 255 characters
N (char) (“”)
Output data String Empty character string
200 + N Set/Get 15 characters
name N (TCHAR) (“”)
Data format
300 Set/Get Integer 0: ASCII, 1: Binary 0

Integer digits
301 Set/Get Integer 0 to 10 6
(for ASCII)
Decimal part
302 digits Set/Get Integer 0 to 10 4
(for ASCII)
Negative 0: ”-”
303 Set/Get Integer 0
(for ASCII) 1: ”8”
Field 0: OFF
304 separator Set/Get Integer 1: Comma 0
(for ASCII) 2: Tab
3: Space
Record
4: CR
305 separator Set/Get Integer 0
5: LF
(for ASCII)
6: CR+LF
Zero
306 suppressed Set/Get Integer 0: No, 1: Yes 0
(for ASCII)
Decimal
0: Floating point
307 output form Set/Get Integer 1
1: Fixed point
(for binary)

 (N = 0 to 31)

 Link data output / Fieldbus data output 


External
reference Data name Set/Get Data type Data range Default
number
Apply overall
103 Set/Get Integer 0: Yes, 1: No 0
judgement
Output data String Empty character string
120 + N Set/Get 255 characters
N (char) (“”)
Output data String Empty character string
200 + N Set/Get 15 characters
name N (TCHAR) (“”)
Output 0: Floating point
307 Set/Get Integer 1
format 1: Fixed point

(N = 0 to 15)

 Parallel judgement output 


External
reference Data name Set/Get Data type Data range Default
number
Apply overall
103 Set/Get Integer 0: Yes, 1: No 0
judgement
Output data String Empty character string
150 + N Set/Get 255 characters
N (char) (“”)

164
.NET Control Reference Manual
External
reference Data name Set/Get Data type Data range Default
number
Output data String Empty character string
250 + N Set/Get 15 characters
name N (TCHAR) (“”)
Judgement -999999999.9999
300 + N Set/Get Double 999999999.9999
upper limit N to 999999999.9999
Judgement -999999999.9999
350 + N Set/Get Double -999999999.9999
lower limit N to 999999999.9999
400 Data output Set/Get Integer 0: No, 1: Yes 1
 (N = 0 to 15)

 Parallel data output 


External
reference Data name Set/Get Data type Data range Default
number
Output data String Empty character string
150 + N Set/Get 255 characters
N (char) (“”)
Output data String Empty character string
250 + N Set/Get 15 characters
name N (TCHAR) (“”)
Output 0: Binary
300 Set/Get Integer 0
format 1: BCD
400 Data output Set/Get Integer 0: No, 1: Yes 1

 (N = 0 to 31)

165
.NET Control Reference Manual
Revision History
zz

Software
Revision code Rev. date Revised contents
Version
01 April 2015 1st edition Ver. 1.91 or later

166
Revision History
Terms and Conditions of Sale
1. Offer; Acceptance. These terms and conditions (these "Terms") are deemed ITY OR FITNESS FOR A PARTICULAR PURPOSE OF THE PRODUCTS.
part of all quotes, agreements, purchase orders, acknowledgments, price lists, BUYER ACKNOWLEDGES THAT IT ALONE HAS DETERMINED THAT THE
catalogs, manuals, brochures and other documents, whether electronic or in PRODUCTS WILL SUITABLY MEET THE REQUIREMENTS OF THEIR
writing, relating to the sale of products or services (collectively, the "Products") INTENDED USE. Omron further disclaims all warranties and responsibility of
by Omron Electronics LLC and its subsidiary companies (“Omron”). Omron any type for claims or expenses based on infringement by the Products or oth-
objects to any terms or conditions proposed in Buyer’s purchase order or other erwise of any intellectual property right. (c) Buyer Remedy. Omron’s sole obli-
documents which are inconsistent with, or in addition to, these Terms. gation hereunder shall be, at Omron’s election, to (i) replace (in the form
2. Prices; Payment Terms. All prices stated are current, subject to change with- originally shipped with Buyer responsible for labor charges for removal or
out notice by Omron. Omron reserves the right to increase or decrease prices replacement thereof) the non-complying Product, (ii) repair the non-complying
on any unshipped portions of outstanding orders. Payments for Products are Product, or (iii) repay or credit Buyer an amount equal to the purchase price of
due net 30 days unless otherwise stated in the invoice. the non-complying Product; provided that in no event shall Omron be responsi-
3. Discounts. Cash discounts, if any, will apply only on the net amount of invoices ble for warranty, repair, indemnity or any other claims or expenses regarding
sent to Buyer after deducting transportation charges, taxes and duties, and will the Products unless Omron’s analysis confirms that the Products were prop-
be allowed only if (i) the invoice is paid according to Omron’s payment terms erly handled, stored, installed and maintained and not subject to contamina-
and (ii) Buyer has no past due amounts. tion, abuse, misuse or inappropriate modification. Return of any Products by
4. Interest. Omron, at its option, may charge Buyer 1-1/2% interest per month or Buyer must be approved in writing by Omron before shipment. Omron Compa-
the maximum legal rate, whichever is less, on any balance not paid within the nies shall not be liable for the suitability or unsuitability or the results from the
stated terms. use of Products in combination with any electrical or electronic components,
5. Orders. Omron will accept no order less than $200 net billing. circuits, system assemblies or any other materials or substances or environ-
6. Governmental Approvals. Buyer shall be responsible for, and shall bear all ments. Any advice, recommendations or information given orally or in writing,
costs involved in, obtaining any government approvals required for the impor- are not to be construed as an amendment or addition to the above warranty.
tation or sale of the Products. See http://www.omron247.com or contact your Omron representative for pub-
7. Taxes. All taxes, duties and other governmental charges (other than general lished information.
real property and income taxes), including any interest or penalties thereon, 14. Limitation on Liability; Etc. OMRON COMPANIES SHALL NOT BE LIABLE
imposed directly or indirectly on Omron or required to be collected directly or FOR SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
indirectly by Omron for the manufacture, production, sale, delivery, importa- LOSS OF PROFITS OR PRODUCTION OR COMMERCIAL LOSS IN ANY
tion, consumption or use of the Products sold hereunder (including customs WAY CONNECTED WITH THE PRODUCTS, WHETHER SUCH CLAIM IS
duties and sales, excise, use, turnover and license taxes) shall be charged to BASED IN CONTRACT, WARRANTY, NEGLIGENCE OR STRICT LIABILITY.
and remitted by Buyer to Omron. Further, in no event shall liability of Omron Companies exceed the individual
8. Financial. If the financial position of Buyer at any time becomes unsatisfactory price of the Product on which liability is asserted.
to Omron, Omron reserves the right to stop shipments or require satisfactory 15. Indemnities. Buyer shall indemnify and hold harmless Omron Companies and
security or payment in advance. If Buyer fails to make payment or otherwise their employees from and against all liabilities, losses, claims, costs and
comply with these Terms or any related agreement, Omron may (without liabil- expenses (including attorney's fees and expenses) related to any claim, inves-
ity and in addition to other remedies) cancel any unshipped portion of Prod- tigation, litigation or proceeding (whether or not Omron is a party) which arises
ucts sold hereunder and stop any Products in transit until Buyer pays all or is alleged to arise from Buyer's acts or omissions under these Terms or in
amounts, including amounts payable hereunder, whether or not then due, any way with respect to the Products. Without limiting the foregoing, Buyer (at
which are owing to it by Buyer. Buyer shall in any event remain liable for all its own expense) shall indemnify and hold harmless Omron and defend or set-
unpaid accounts. tle any action brought against such Companies to the extent based on a claim
9. Cancellation; Etc. Orders are not subject to rescheduling or cancellation that any Product made to Buyer specifications infringed intellectual property
unless Buyer indemnifies Omron against all related costs or expenses. rights of another party.
10. Force Majeure. Omron shall not be liable for any delay or failure in delivery 16. Property; Confidentiality. Any intellectual property in the Products is the exclu-
resulting from causes beyond its control, including earthquakes, fires, floods, sive property of Omron Companies and Buyer shall not attempt to duplicate it
strikes or other labor disputes, shortage of labor or materials, accidents to in any way without the written permission of Omron. Notwithstanding any
machinery, acts of sabotage, riots, delay in or lack of transportation or the charges to Buyer for engineering or tooling, all engineering and tooling shall
requirements of any government authority. remain the exclusive property of Omron. All information and materials supplied
11. Shipping; Delivery. Unless otherwise expressly agreed in writing by Omron: by Omron to Buyer relating to the Products are confidential and proprietary,
a. Shipments shall be by a carrier selected by Omron; Omron will not drop ship and Buyer shall limit distribution thereof to its trusted employees and strictly
except in “break down” situations. prevent disclosure to any third party.
b. Such carrier shall act as the agent of Buyer and delivery to such carrier shall 17. Export Controls. Buyer shall comply with all applicable laws, regulations and
constitute delivery to Buyer; licenses regarding (i) export of products or information; (iii) sale of products to
c. All sales and shipments of Products shall be FOB shipping point (unless oth- “forbidden” or other proscribed persons; and (ii) disclosure to non-citizens of
erwise stated in writing by Omron), at which point title and risk of loss shall regulated technology or information.
pass from Omron to Buyer; provided that Omron shall retain a security inter- 18. Miscellaneous. (a) Waiver. No failure or delay by Omron in exercising any right
est in the Products until the full purchase price is paid; and no course of dealing between Buyer and Omron shall operate as a waiver
d. Delivery and shipping dates are estimates only; and of rights by Omron. (b) Assignment. Buyer may not assign its rights hereunder
e. Omron will package Products as it deems proper for protection against nor- without Omron's written consent. (c) Law. These Terms are governed by the
mal handling and extra charges apply to special conditions. law of the jurisdiction of the home office of the Omron company from which
12. Claims. Any claim by Buyer against Omron for shortage or damage to the Buyer is purchasing the Products (without regard to conflict of law princi-
Products occurring before delivery to the carrier must be presented in writing ples). (d) Amendment. These Terms constitute the entire agreement between
to Omron within 30 days of receipt of shipment and include the original trans- Buyer and Omron relating to the Products, and no provision may be changed
portation bill signed by the carrier noting that the carrier received the Products or waived unless in writing signed by the parties. (e) Severability. If any provi-
from Omron in the condition claimed. sion hereof is rendered ineffective or invalid, such provision shall not invalidate
13. Warranties. (a) Exclusive Warranty. Omron’s exclusive warranty is that the any other provision. (f) Setoff. Buyer shall have no right to set off any amounts
Products will be free from defects in materials and workmanship for a period of against the amount owing in respect of this invoice. (g) Definitions. As used
twelve months from the date of sale by Omron (or such other period expressed herein, “including” means “including without limitation”; and “Omron Compa-
in writing by Omron). Omron disclaims all other warranties, express or implied. nies” (or similar words) mean Omron Corporation and any direct or indirect
(b) Limitations. OMRON MAKES NO WARRANTY OR REPRESENTATION, subsidiary or affiliate thereof.
EXPRESS OR IMPLIED, ABOUT NON-INFRINGEMENT, MERCHANTABIL-

Certain Precautions on Specifications and Use


1. Suitability of Use. Omron Companies shall not be responsible for conformity ADDRESS THE RISKS, AND THAT THE OMRON’S PRODUCT IS PROP-
with any standards, codes or regulations which apply to the combination of the ERLY RATED AND INSTALLED FOR THE INTENDED USE WITHIN THE
Product in the Buyer’s application or use of the Product. At Buyer’s request, OVERALL EQUIPMENT OR SYSTEM.
Omron will provide applicable third party certification documents identifying 2. Programmable Products. Omron Companies shall not be responsible for the
ratings and limitations of use which apply to the Product. This information by user’s programming of a programmable Product, or any consequence thereof.
itself is not sufficient for a complete determination of the suitability of the Prod- 3. Performance Data. Data presented in Omron Company websites, catalogs
uct in combination with the end product, machine, system, or other application and other materials is provided as a guide for the user in determining suitabil-
or use. Buyer shall be solely responsible for determining appropriateness of ity and does not constitute a warranty. It may represent the result of Omron’s
the particular Product with respect to Buyer’s application, product or system. test conditions, and the user must correlate it to actual application require-
Buyer shall take application responsibility in all cases but the following is a ments. Actual performance is subject to the Omron’s Warranty and Limitations
non-exhaustive list of applications for which particular attention must be given: of Liability.
(i) Outdoor use, uses involving potential chemical contamination or electrical 4. Change in Specifications. Product specifications and accessories may be
interference, or conditions or uses not described in this document. changed at any time based on improvements and other reasons. It is our prac-
(ii) Use in consumer products or any use in significant quantities. tice to change part numbers when published ratings or features are changed,
(iii) Energy control systems, combustion systems, railroad systems, aviation or when significant construction changes are made. However, some specifica-
systems, medical equipment, amusement machines, vehicles, safety equip- tions of the Product may be changed without any notice. When in doubt, spe-
ment, and installations subject to separate industry or government regulations. cial part numbers may be assigned to fix or establish key specifications for
(iv) Systems, machines and equipment that could present a risk to life or prop- your application. Please consult with your Omron’s representative at any time
erty. Please know and observe all prohibitions of use applicable to this Prod- to confirm actual specifications of purchased Product.
uct. 5. Errors and Omissions. Information presented by Omron Companies has been
NEVER USE THE PRODUCT FOR AN APPLICATION INVOLVING SERIOUS checked and is believed to be accurate; however, no responsibility is assumed
RISK TO LIFE OR PROPERTY OR IN LARGE QUANTITIES WITHOUT for clerical, typographical or proofreading errors or omissions.
ENSURING THAT THE SYSTEM AS A WHOLE HAS BEEN DESIGNED TO
OMRON AUTOMATION AND SAFETY • THE AMERICAS HEADQUARTERS • Chicago, IL USA • 847.843.7900 • 800.556.6766 • www.omron247.com

OMRON CANADA, INC. • HEAD OFFICE OMRON ARGENTINA • SALES OFFICE


Toronto, ON, Canada • 416.286.6465 • 866.986.6766 • www.omron247.com Cono Sur • 54.11.4783.5300

OMRON ELECTRONICS DE MEXICO • HEAD OFFICE OMRON CHILE • SALES OFFICE


México DF • 52.55.59.01.43.00 • 01-800-226-6766 • mela@omron.com Santiago • 56.9.9917.3920

OMRON ELECTRONICS DE MEXICO • SALES OFFICE OTHER OMRON LATIN AMERICA SALES
Apodaca, N.L. • 52.81.11.56.99.20 • 01-800-226-6766 • mela@omron.com 54.11.4783.5300

OMRON ELETRÔNICA DO BRASIL LTDA • HEAD OFFICE


São Paulo, SP, Brasil • 55.11.2101.6300 • www.omron.com.br

OMRON EUROPE B.V. • Wegalaan 67-69, NL-2132 JD, Hoofddorp, The Netherlands. • +31 (0) 23 568 13 00 • www.industrial.omron.eu

Authorized Distributor: Automation Control Systems


• Machine Automation Controllers (MAC) • Programmable Controllers (PLC)
• Operator interfaces (HMI) • Distributed I/O • Software
Drives & Motion Controls
• Servo & AC Drives • Motion Controllers & Encoders
Temperature & Process Controllers
• Single and Multi-loop Controllers
Sensors & Vision
• Proximity Sensors • Photoelectric Sensors • Fiber-Optic Sensors
• Amplified Photomicrosensors • Measurement Sensors
• Ultrasonic Sensors • Vision Sensors
Industrial Components
• RFID/Code Readers • Relays • Pushbuttons & Indicators
• Limit and Basic Switches • Timers • Counters • Metering Devices
• Power Supplies
Safety
• Laser Scanners • Safety Mats • Edges and Bumpers • Programmable Safety
Controllers • Light Curtains • Safety Relays • Safety Interlock Switches

Q225I-E-01 04/15 Note: Specifications are subject to change. © 2016 Omron Electronics LLC Printed in U.S.A.

Printed on recycled paper.

You might also like