Native Mode Commands

Native Mode Communications

Page 0 of 01=


In-Sight Communications Reference

About the Native Mode Protocol Basic Native Mode Syntax xtended Native Mode Syntax Communicating !ith In-Sight Sensors via Serial Port "sing Native Mode Commands Communicating !ith In-Sight Sensors via #elnet "sing Native Mode Commands $ist of Native Mode Commands

About the Native Mode Protocol #he In-Sight Native Mode %rotocol is an ASCII %rotocol that allo!s an In-Sight sensor to be controlled from any of the follo!ing& ' Custom a%%lication %rograms running on a PC ' Remote hosts that su%%ort standard serial communications ' #elnet over an thernet net!or( #he Native Mode %rotocol is divided into t!o sets of commands& Basic and xtended) Basic Native Mode commands are t!o characters long* %lus %arameters +if any, and a terminator character extended Native Mode commands include additional functions or commands) #he commands are not case sensitive) #he terminator is CR . $/ +ASCII characters 01 . 02, !hen sending Native Mode commands using a telnet connection) 3hen using Native Mode commands over a serial %ort* an alternate terminator character may be s%ecified in theNative Mode 4etails the default terminator is CR +ASCII character 01,)

3hen a Native Mode command is remotely issued to an In-Sight sensor* the In-Sight sensor %rocesses the command and then returns a res%onse* consisting of an ASCII string follo!ed by the terminator character) Commands thatset values return 1 for 5success5* 0 for 5unrecogni6ed command5* or a negative number for 5failure5) Commands thatget values return various values* de%ending on the command) Notes&

' A subset of Native Mode commands can be sent from any P$C +that allo!s a genericCIP message, over an therNet7IP connection using x%licit Messaging) ' #he In-Sight 8222 series vision sensor has the follo!ing limitations& 9 /ollo!ing basic native mode commands are not su%%orted on the In-Sight 8222 series vision sensor& Read Image +RI,* 3rite Image +3I,* :et ;alue +:;,* Set Integer +SI,* Set /loat +S/,* Set Region +SR,* Set String +SS,* Set vent +S,* Set vent and 3ait +S3, and Send Message +SM,) 9 xtended Native mode commands are not su%%orted on the In-Sight 8222 series vision sensor* exce%t !here noted) 9 #he In-Sight 8222-00270827082C vision sensor is only ca%able of returning Pass7/ail data) 3hen attem%ting to retrieve numeric data* an invalid %ermission +-<, error !ill be returned)

Basic Native Mode Syntax #he general syntax of a Basic Native Mode command is as follo!s&

[command][parameter][terminator]

!here [command] consists of t!o characters) Some Native Mode commands ta(e an o%tional[parameter])

#he Basic Native Mode command is com%leted !ith a [terminator] character) #he terminator is CR . $/ +ASCII characters 01 . 02, !hen sending Native Mode commands using a telnet connection) 3hen using Native Mode commands over a serial %ort* an alternate terminator character may be s%ecified in the Native Mode 4etails the default terminator is CR +ASCII character 01,)

Basic Native Mode commands are not case-sensitive) No s%aces exist bet!een %arameters)

Notes&

file&777C&7"sers7la%to%7A%%4ata7$ocal7#em%7@hhC88)htm

8>7?7820=


Page 8 of 01=

' Native Mode commands that are executed on a ob +such as3rite ob and 4elete ob, are included %rimarily for bac(!ards com%atibility) ' #he chec(sum that is used by Native Mode file transfer commands is a standard 0<-bitCyclical Redundancy Chec()

Extended Native Mode Syntax #he general syntax of an xtended Native Mode command is as follo!s&

[command1] [command2] [input parameters][terminator]

!here [command1] is any one of the three xtended Native Mode commands +:et* Put* ;,) [command2] re%resents the secondary command* indicating !hich data to send* receive* or execute* based u%on [command1]) [input parameters] su%%ly o%tional su%%lementary information to the command)

#he xtended Native Mode command is com%leted !ith a [terminator] character) #he terminator is CR . $/ + ASCII characters 01 . 02, !hen sending Native Mode commands using a telnet connection) 3hen using N ative Mode commands over a serial %ort* an alternate terminator character may be s%ecified in the Native Mode 4etails the default terminator is CR +ASCII character 01,)

xtended Native Mode commands are not case-sensitive) Note that s%aces exist bet!een certain in%ut %arameters)

Communicating with n!Sight Sensors via Serial Port "sing Native Mode commands 0) n the Sensor menu* clic( Serial Port Settings) 8) In the Serial Port Settings dialog* choose Native /rom the Mode dro%-do!n list) 1) Configure the remote serial device to use the same %ort settings as the In-Sight sensor) Note & 3hen using NativePort Mode commands over a serial %ort* a different terminator character may be s%ecified in theNative Mode 4etails* !hich is accessed from the Serial dialog)

Communicating with n!Sight Sensors via #elnet "sing Native Mode Commands #elnet is a built-in Microsoft 3indo!s client that can be used to remotely communicate !ith the sensor using In-Sight Native Mode commands) 0) %en the telnet client a%%lication on the remot e host) 8) In the telnet a%%lication* connect to the In-Sight sensor by either itsDost Name or IP address) If the connection is successful* a 53elcome to In-Sight+tm,5 message a%%ears* along !ith the hard!are sensor ty%e +for exam%le& ?022* ?>22C, and the session number) 1) nter a valid user name and %ass!ord for the In-Sight sensor) #he user name and %ass!ord entered must exist in the"ser $ist for that sensor) If the log on is successful* the message 5"ser $ogged In5 !ill a%%ear) Eou can test the telnet connection by ty%ing the Native Mode:et ;alue command* 5gva2225* at the telnet %rom%t) If successful* the command returns a 1* follo!ed by the value in cell A2 in t he s%readsheet of the In-Sight sensor*$mage&

Custom a%%lications can be !ritten +to run on a remote host, to automate the telnet logon %rocess* as !ell a s to send and receive Native Mode data)

Notes&

' By default* !hen connected via telnet* there is no default timeout) #o set a timeout value* use thePut #imeout command) ' "nder ty%ical use* %ass!ord echo is disabled in the telnet client a%%lication for security %ur%oses)


8>7?7820=


Page 1 of 01=

' 3hen using telnet to log on to an In-Sight sensor from a "nix-based %latform* the telnet command line must be in the follo!ing format& F telnet !here is either the In-Sight sensorGs Dost Name or IP Address* and is the remote telnet %ort +usually 81,) Su%%lying the %ort number disables the "nix username7%ass!ord authentication and forces the "nix system to %rom%t you for a user name and %ass!ord)

Native Mode Commands


Basic Native Mode Commands xtended Native Mode Commands

Basic Native Mode Commands %ile & 'ob Commands ' ' ' ' ' ' '

$oad /ile& +$/, $oads the s%ecified Hob from flash memory on the In-Sight vision system* ma(ing it the active Hob) Store /ile& +#/, Saves the current Hob in flash memory on the vision system) Read /ile& +R/, Reads a Hob from the flash memory on the vision system) 3rite /ile& +3/, Sends a Hob to the flash memory on the vision system) 4elete /ile& +4/, 4eletes the s%ecified Hob or cell data file +)cxd, from flash memory on the vision system) :et /ile& +:/, Returns the filename of the ac tive Hob on the vision system) Set ob& +S, $oads a Hob from one of the Hob slots in flash memory on the vision system* ma(ing it the active Hob)

'' ' ' '

Store ob& +R, +#, Saves current Hob s%ecified into the s%ecified fla sh memory on the vision system) Read ob& Reads the a Hob from the In-Sight slot Hob in slot) 3rite ob& +3, Sends a Hob to the s%ecified Hob slot in fl ash memory on the vision system) 4elete ob& +4, 4eletes the Hob from the s%ecifie d slot in flash memory on the vision system) :et ob& +:, :ets the currently loaded HobGs I4 number)

mage Commands ' ' ' '

Read BMP& +RB, Sends the current image* in ASCII hexadecimal format* from a vision system to an external device) Read Image& +RI, Sends the current image* in ASCII hexadecimal format* from a vision system to an external device) 3rite BMP& +3B, Sends image data from an external device to the vision system) 3rite Image& +3I, Sends image data from an e xternal device to the vision system)

Settings & Cell (alue Commands ' ' ' ' ' ' ' ' ' ' '

:et ;alue& +:;, Returns the value in a s%ecified cell or symbolic tag) Set Integer& +SI, Sets an i nteger value in a s%ecified cell or symbolic tag) Set /loat& +S/, Sets a floating %oint value in a s%ecified cell or symbolic tag) Set Region& +SR, Sets the values of an ditRegion cell or symbolic tag) Set String& +SS, Sets a string value in a s%ecified cell or symbolic tag) :et Info& +:I, Returns system information about the In-Sight vision system) Read Settings& +RS, Reads the system settings data from a vision system) 3rite Settings& +3S, Sends the system settings data from an external device to the vision system) Store Settings& +#S, Stores the vision system settings to the %roc)set file) Set IP Address $oc( & +S$, Prevents unauthori6ed changes to a vision systemGs IP address) :et IP Address $oc( & +:$, Returns the security status of the IP a ddress on a vision system)

Execution & )nline Commands ' ' ' '

Set nline& +S, Sets the vision system into nline or ffline mode) :et nline& +:, Returns the nline state of the vision system) Set vent& +S, #riggers a s%ecified event) Set vent and 3ait& +S3, #riggers a s%ecified event and !aits until the command is com%leted to return a res%onse)


8>7?7820=


Page > of 01=

' Reset System& +R#, Resets the vision system +similar to %hysically %o!er cycling the vision system,) ' Send Message& +SM, Sends a string to the s%readsheet over a Native Mode connection* and o%tionally* triggers a s%readsheet vent)

Extended Native Mode Commands ' :et& "sed to receive information from the In-Sight vision system and its s%readsheet) ' Put& "sed to send information to a vision system and its s%readsheet)

Evaluate valuate& +;, xecutes In-Sight functions as !ell as inserts formulas into the In-Sight s%readsheet used to retrieve information and ma(e changes to In-Sight vision systems) Note& All In-Sight functions may be used !ith the ; command the commands listed belo! are some of the most common functions to be executed using the ; command)

' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' '

:etCellName& Returns the cell location of a s%ecified symbolic tag name* or the symbolic tag name of a s%ecified cell) :etCell;alue& Returns the contents of a s%ecified symbolic tag or s%readsheet cell in M$ format) :et4energi6eut%uts& Returns the 4e-nergi6e ut%uts 3hile ffline setting configured in the 4iscrete I7 Settings dialog) :et4iagnostic$og& Returns a log of information used to diagnose errors on the In-Sight vision system) :et4iscreteIn%ut& Returns information that is configured in the 4iscrete I7 Settings dialog) :et4iscreteut%ut& Returns information that is configured in the 4iscrete I7 Settings dialog) :et4iscreteut%ut4elay& Returns delay settings that are configured in the 4iscrete I7 Settings dialog) :etasyBuilder#ag& Returns the asyBuilder #ag for the s%ecified symbolic tag name or cell location) :etIPSingleAttribute& Returns In-Sight therNet7IP Class and Instance Attributes) :et/#PSettings& Returns information that is configured in the /#P Settings dialog) :etDost#able& Returns information contained in the In-Sight Dost #able dialog) :etMSBuffer& Returns the Machine Status data stored in one of J indexed buffers +6er o-based, !ithin the Machine Status stac() :etNet!or(& Returns information that is configured in the Net!or( Settings dialog) :etSerialPort& Returns information that is configured in the Serial Port Settings dialog) :etStartu%& Returns information that is configured in the Startu% dialog) :etSystemConfig& ;arious commands that return system information) :et"ser$ist& Returns information that is configured in the "ser $ist dialog) SetCellName& Sets the symbolic tag name of a s%ecified cell) SetCell;alue& Sets the value of s%ecific cell a%%ended !ith an asyBuilder #ag) Set4energi6eut%uts& Configures the 4e-nergi6e ut%uts 3hile ffline setting found in the 4iscrete I7 Settings dialog)

' ' ' ' ' ' ' ' ' ' ' '

Set4iscreteIn%ut& Configures settings that are found in the 4iscrete I7 Settings dialog) Set4iscreteut%ut& Configures settings in the 4iscrete I7 Settings dialog and the ut%ut 4etails dialog) Set4iscreteut%ut4elay& Configures delay settings that are found in the ut%ut 4etails dialog) SetditRegion& Configures settings for a cell that contains an ditRegion function) SetIPSingleAttribute& Configures In-Sight therNet7IP Class a nd Instance Attributes) Set/avorDost#able& nables or disables the Favor Host Table over DNS o%tion found in the In-Sight Dost #able) Set/#PSettings& Configures settings that are found in the /#P Settings dialog) SetDost#able& Configures settings that are found in the In-Sight Dost #able dialog) SetNet!or(& Configures settings that are found in the Net!or( Settings dialog) SetSerialPort& Configures settings that are found in the Serial Port Settings dialog) SetStartu%& Configures settings that are found in the Startu% dialog) SetSystemConfig& ;arious commands that configure system %arameters)

$oad /ile

Basic Native Mode Commands


$oads the s%ecified Hob from flash memory on the In-Sight vision system* RAM 4is( or S4 Card* ma(ing it the active Hob)

Syntax: LF[Filename]


8>7?7820=


Page ? of 01=

Notes&

' #he In-Sight vision system must be ffline) ' #o load a Hob file stored in the RAM4is( folder* the syntax is& $/RAM4is(7K/ilenameL) /or exam%le* to load the file 5Product)Hob5 stored in the vision systemGs RAM4is( folder* issue the follo!ing command& 5$/RAM4is(7Product)Hob5) ' #o load a Hob file stored in the S4 Card folder* the syntax is $/S4CAR47K/ilenameL) /or exam%le* to read the file 5Product)Hob5 stored in the vision systemGs S4 Card folder* issue the follo!ing command& 5$/S4CAR47Product)Hob5) ' #he ob Server Settings dialog can be used to configure an /#P server that !il l host In-Sight Hob files for the In-Sight vision system* !hich allo!s another device* such as a P$C or robot controller via the $/ and#/ Native Mode commands* to change Hobs !ithout s%ecifying a location) $oad /ile In%uts

Input

*escri+tion

%ilename

#he name of the Hob) #he command !ill execute !ith or !ithout the,')B extension)

$oad /ile ut%uts

Returns

0

#he command !as executed successfully)

2

"nrecogni6ed command)

-0

#he filename is missing)

-8

#he Hob failed to load* the vision system is nline* or the file !as not found)

->

#he Hob to be loaded !as not found* or the vision system is out of memory)

-<

"ser does not have /ull Access to execute the command)

$oad /ile xam%le #o load 5Product5 as the active Hob on the I n-Sight vision system* issue the follo!ing command&-%Product,.ob

#he In-Sight sensor res%onds !ith 1* indicating that the Hob !as successfully loaded and made active)

/elated #o+ics Store /ile Read /ile 3rite /ile 4elete /ile :et /ile


8>7?7820=


Page < of 01=

Store /ile



Saves the current Hob in flash memory on the In-Sight vision system* RAM 4is( or S4 Card)

Syntax: TF[Filename]

Notes&

' If the Allo! nline ob Save chec(box is enabled* users !ith /ull or Protected access are allo!ed to save Hobs !hile nline) If the Allow )nline 'ob Save chec(box is not enabled* the vision system must be ffline to save Hobs) ' #o save the current Hob file* !ith the s%ecified filename* to the vision systemGsRAM4is( folder* the syntax is& #/RAM4is(7K/ilenameL) /or exam%le* to save the file 5#est)Hob5 to t he vision systemGs RAM4is( folder* issue the follo!ing command& 5#/RAM4is(7#est)Hob5) ' #o save the current Hob file* !ith the s%ecified file name* to the vision systemGsS4 Card folder* the syntax is #/S4CAR47K/ilenameL) /or exam%le* to save the f ile 5#est)Hob5 stored to the vision systemGs S4 Card folder* issue the follo!ing command& 5#/S4CAR47#est)Hob5) ' #he ob Server Settings dialog is used to configure an /#P server that !ill host In-Sight Hob files for the In-Sight vision system* !hich allo!s another device* such as a P$C or robot controller via the$/ and #/ Native Mode commands* to change Hobs !ithout s%ecifying a location) Store /ile In%uts

Input

*escri+tion

%ilename

#he name of the Hob) #he file extension must be )')B)

Store /ile ut%uts

Returns

A status code* follo!ed by a line terminator) #he status codes are&

0


2


-0

#he filename is missing)

-8

#he Hob failed to save* the vision system is nline or the file !as not found* therefore the command could not be executed)

-<


Store /ile xam%le #o name the current Hob 5#est5 and save it in flash memory on the In-Sight vision system* issue the follo!ing command&#%#est,.ob


8>7?7820=


Page = of 01=

#he In-Sight vision system res%onds !ith 1* indicating that the current Hob !as successfully saved)

/elated #o+ics $oad /ile Read /ile 3rite /ile 4elete /ile :et /ile

Read /ile



Reads a Hob from the s%ecified In-Sight flash memory* RAM 4is( or S4 Card)

Syntax:

RF[Filename]

Notes&

' #o read a Hob file stored in the RAM4is( folder* the syntax is& R/RAM4is(7K/ilenameL) /or exam%le* to read the file 5Model)Hob5 stored in the vision systemGs RAM4is( folder* issue the follo!ing command& 5R/RAM4is(7Model)Hob5) ' #o read a Hob file stored in the S4 Card folder* the syntax is R/S4CAR47K/ilenameL) /or exam%le* to read the file 5 Model)Hob5 stored in the vision systemGs S4 Card folder* issue the follo!ing command& 5R/S4CAR47Model)Hob5) Read /ile In%uts

Input

*escri+tion

%ilename


Read /ile ut%uts

Returns

A status code* follo!ed by a line terminator* follo!ed by lines of Hob data) #he status codes are&

0


2


-0

#he Hob filename is missing)

-8

#here is no Hob saved !ith the given name or the Hob data is invalid* therefore the command could not be executed)

-<



8>7?7820=


Page J of 01=

#he lines of Hob data are&

Name

#he first line contains the Hob name)

Si6e

#he second line contains an integer value for the si6e +in bytes, of the Hob)

4ata

#he actual Hob data is encoded as ASCII hexadecimal values formatted to J2 characters %er line) ach line ends !ith a terminating character)

Chec(Sum

#he last line contains four ASCII hexadecimal bytes that are a chec(sum of the Hob data)

Read /ile xam%le #o receive information about the Hob 5Model)Hob5* !hich is saved on the In-Sight vision system* issue the follo!ing command&/%Model,.ob

After issuing the Read /ile command* the first line out%utted to the telnet !indo! is the status code 1 + ,* follo!ed by the Hob name +Model,.ob, and si6e +2, in bytes* then the Hob data +in ASCII hexadecimal format,) /inally* the four-byte ASCII hexadecimal chec(sum is dis%layed on the last line +323,) Note& #he si6e re%orted by the /% command !ill be t!ice the number of bytes of the a ctual )B file si6e stored on the In-Sight vision system* due to the ASCII hexadecimal encoding of the data)

/elated #o+ics $oad /ile Store /ile 3rite /ile 4elete /ile :et /ile

3rite /ile



Sends a Hob to the flash memory on the In-Sight vision system* RAM 4is( or S4 Card)

Syntax: WF


8>7?7820=


Page  of 01=

[Filename] [Size] [Data] [Checksum]

Notes&

' #he In-Sight vision system must be ffline) ' #o send a Hob file stored in the vision systemGs RAM4is( folder* the filename must include the RAM4is( folder %ath) /or exam%le* 5RAM4is(7Ne!Model)Hob5) ' #o send a Hob file stored in the vision systemGs S4 Card folder* the filename must include the S4 Card folder %ath) /or exam%le* 5S4CAR47Ne!Model)Hob5)

3rite /ile In%uts #he command is sent on a se%arate line* follo!ed by the lines of Hob data* !hich should be an exact co%y of the data received from aRead /ile command) #he lines of Hob data are&

In%ut

4escri%tion

%ilename


Si4e


*ata


Chec5Sum


3rite /ile ut%uts

Returns


0


2


-8

#he Hob could not be !ritten* or the Hob data is invalid)

-1

#he chec(sum failed) #he chec(sum does not match the Hob data)

->

#he In-Sight vision system is out of memory)

-<


6rite %ile Exam+le #o !rite Hob data to the Hob 5Ne!Model)Hob5* issue the follo!ing command&6%) After issuing the 3rite /ile command* the first in%ut is the Hob name +NewModel,.ob,* follo!ed by the si6e +2, in bytes) Next* each ASCII hexadecimal byte of the Hob file is in%ut) /inally* the four ASCII hexadecimal chec(sum bytes are in%ut on the last line +323,)


8>7?7820=


Page 02 of 01=

#he In-Sight vision system res%onds !ith 1* indicating that the Hob !as successfully sent to the vision systemGs flash memory)

Notes&

' If the Hob file already exists on the vision system* the existing Hob data is over!ritten) ' If the Hob file does not already exist on the vision system* a ne! Hob file is created !ith the s%ecified name)

/elated #o+ics $oad /ile Store /ile Read /ile 4elete /ile :et /ile

4elete /ile



4eletes the s%ecified Hob or cell data +)C4, file from flash memory on the In-Sight vision system* RAM 4is( or S4 Card)

Syntax: DF[Filename]

Notes&

' #he In-Sight vision system must be ffline) ' #o delete a Hob or )C4 file stored in the vision systemGs RAM4is( folder* the syntax is& 4/RAM4is(7K/ilenameL) /or exam%le* to delete the file 5#est)Hob5 stored in the vision systemGs RAM4is( folder* issue the follo!ing command& 54/RAM4is(7#est)Hob5) ' #o delete a Hob or )C4 file stored in the vision systemGs S4 Card folder* the syntax is& 4/S4CAR47K/ilenameL) /or exam%le* to delete the file 5#est)Hob5 stored in the vision systemGs S4 Card folder* issue the follo!ing command& 54/S4CAR47#est)Hob5)

4elete /ile In%uts

In%ut

4escri%tion


8>7?7820=


Page 00 of 01=

#he name of the Hob or )C4 file) #he file extension must be ,')B or ,C7*)

%ilename

4elete /ile ut%uts

Returns


0


2

"nrecogni6edc ommand)

-0

#he f ilename is missing)

-8

#he file could not be deleted* the vision system is nline* a file does not exist !ith the given name* or the Hob data is invalid* therefore the command could not be executed)

-<


4elete /ile xam%les xam%le& 4elete a ob /ile xam%le& 4elete a )C4 /ile

Exam+le8 *elete a 'ob %ile #o delete the Hob 5#est)Hob5 from the In-Sight vision system* issue the follo!ing command&*%#est,.ob

#he In-Sight vision system res%onds on the follo!ing line !ith the status code of 1* indicating that the Hob !as successfully deleted)

Exam+le8 *elete a ,C7* %ile #o delete the )C4 file 5/indPatterns)cxd5 from the I n-Sight vision systemGs RAM 4is( folder* issue the follo!ing command& *%/AM*is59%indPatterns,cxd

#he In-Sight vision system res%onds on the follo!ing line !ith the status code of 1* indicating that the )C4 file !as successfully deleted)


8>7?7820=


Page 08 of 01=

/elated #o+ics $oad /ile Store /ile Read /ile 3rite /ile :et /ile

:et /ile



Returns the filename of the active Hob on the In-Sight vision system* RAM 4is( or S4 Card)

Syntax: GF

Notes&

' #he active Hob must be saved before this command can be executed successfully) ' If the active Hob is saved to the vision systemGs RAM4is( folder* the :et /ile out%ut includes the RAM4is( folder %ath) /or exam%le* if the active Hob* 5#est)Hob5* is saved in the vision systemGs RAM4is( f older* the :et /ile command returns 5RAM4is(7#est)Hob5) ' If the active Hob is saved to the vision systemGs S4 Card folder* the :et /ile out%ut includes the S4 Car d folder %ath) /or exam%le* if the active Hob* 5#est)Hob5* is saved in the vision systemGs S4 Card folder* the :et /ile command returns 5S4CAR47#est)Hob5)

:et /ile In%uts None) :et /ile ut%uts

/eturns

A status code* follo!ed by the name of the file) #he status codes are&

1


0


!

#he active Hob has not been saved* therefore the command could not be executed)

:et /ile xam%le

Assume that the active* saved Hob on an In-Sight vision system is named 5#est)Hob5) #o return the filename of the active Hob* issue the follo!ing command& :%


8>7?7820=


Page 01 of 01=

#he In-Sight vision system res%onds !ith 1* indicating that the command executed successfully) n the follo!ing line* the active Hob filename +#est,.ob, is dis%layed)

Notes&

' If the active Hob !as loaded from a remote In-Sight vision system* the filename !ill be dis%layed in the follo!ing format& %#P899;ostName9
/elated #o+ics $oad /ile Store /ile Read /ile 3rite /ile 4elete /ile

Set ob



$oads a Hob from one of the Hob slots in flash memory on the In-Sight sensor* ma(ing it the active Hob)

Syntax: SJ[ID]

Notes&

' #he In-Sight sensor must be ffline) ' #o use the Hob I4 number feature* the Hob to be loaded must be saved !ith a numerical %refix of 2 to ) /or bac(!ards com%atibility on non-net!or( ca%able In-Sight sensors* the %refix must be in the range of 2 to 0) Set ob In%uts

In%ut

4escri%tion

*

#he I4 number of the Hob to load =0 to >>>? )

Set ob ut%uts

/eturns

1



8>7?7820=


Page 0> of 01=

0


!1

#he I4 is less than 2* or is not an integer)

!

#he Hob failed to load* the sensor is nline or the file !as not found* therefore the command could not be executed)

!@

#he In-Sight sensor is out of memory)

!2


Set 'ob Exam+le #o load 5J?#est)Hob5 as the active Hob on the In-Sight sensor* issue the follo!ing command& S')

#he In-Sight sensor res%onds !ith 1* indicating that the Hob !as successfully loaded and made active)

/elated #o+ics Store ob Read ob 3rite ob 4elete ob :et ob

Store ob



Saves the current Hob into the s%ecified slot in flash memory on the In-Sight sensor)

Syntax: TJ[ID][Name]

Notes&

' If the Allo! nline ob Save chec(box is enabled* users !ith /ull or Protected access are allo!ed to save Hobs !hile nline) If the Allow )nline 'ob Save chec(box is not enabled* the vision system must be ffline to save Hobs) ' #o use the Hob I4 number feature* the Hob to be saved must be saved !ith a numerical %refix of 2 to ) /or bac(!ards com%atibility on non-net!or( ca%able In-Sight sensors* the %refix must be in the range of 2 to 0)


8>7?7820=


Page 0? of 01=

Store ob In%uts

In%ut

4escri%tion

*

#he Hob I4 number =0 to >>>? )

Name

#he name of the Hob) #he command !ill execute !ith or !ithout the,')B file extension)

Store ob ut%uts

Returns


0


2


-0

#he Hob I4 number is invalid or it is not an integer)

-8

#hesensor is nline* therefore the command could not be executed)

-<


Store ob xam%le #o name the current Hob 5#est5 and save it into slot 2 on the I n-Sight sensor* issue the follo!ing command&#'00#est,.ob

#he In-Sight sensor res%onds !ith 1* indicating that the current Hob !as successfully saved)

/elated #o+ics Set ob Read ob 3rite ob 4elete ob :et ob

Read ob




8>7?7820=


Page 0< of 01=

Reads a Hob from the s%ecified In-Sight Hob slot)

Syntax:

RJ[ID]

Note& /or bac(!ards com%atibility on non-net!or( ca%able sensors* the Hob I4 number must be in the range of 2 to 0)

Read ob In%uts

In%ut

4escri%tion

*


Read ob ut%uts

Returns

A status code* follo!ed by a line terminator* follo!ed by lines of Hob data) #he status codes are&

0


2


-0

#he Hob I4 number is outside the allo!able range =0 to >>>?)

-8

#he Hob could not be read* or the Hob slot is em%ty* therefore the command could not be executed)

->


-<



Name


Si6e


4ata


Chec(Sum


/ead 'ob Exam+le #o receive information about the Hob named 5J?#est)Hob5* !hich is saved on the In-Sight sensor* issue the follo!ing command&/'


8>7?7820=


Page 0= of 01=

After issuing the Read ob command* the first line out%utted to the telnet !indo! is the status code 1 + ,* follo!ed by the Hob name +#est,.ob, and si6e +2, in bytes* then the Hob data +in ASCII hexadecimal format,) /inally* the four-byte ASCII hexadecimal chec(sum is dis%layed on the last line +@,) Note& #he si6e re%orted by the /' command !ill be t!ice the number of bytes of the ac tual )B file si6e stored on the In-Sight sensor* due to the ASCII hexadecimal encoding of the data)

/elated #o+ics Set ob Store ob 3rite ob 4elete ob :et ob

3rite ob



Sends a Hob to the s%ecified In-Sight Hob slot in flash memory on the In-Sight sensor)

Syntax: WJ[ID]

[Filename] [Size] [Data] [Checksum]

Notes&

' #he In-Sight sensor must be ffline) ' /or bac(!ards com%atibility on non-net!or( ca%able sensors* the Hob I4 number must be in the range of 2 to 0)

3rite ob In%uts #he command and I4 are sent on a se%arate line* f ollo!ed by the lines of Hob data* !hich should be an exact co%y of the data re ceived from aRead ob command)


8>7?7820=


In%ut

4escri%tion

*


Page 0J of 01=


In%ut

4escri%tion

Name


Si4e

#he second line contains an integer value for the si6e* in bytes* of the Hob)

*ata


Chec5Sum


3rite ob ut%uts

Returns


0


2


-0


-8

#he Hob could not be !ritten* or the Hob data is invalid)

-1

#he chec(sum failed) #he chec(sum does not match the Hob data)

->


-<


6rite 'ob Exam+le

#o !rite Hob data to the Hob named 5J<#est)Hob5* issue the follo!ing command&6'2 After issuing the command* in%ut the Hob name +#est,.ob,* follo!ed by the si6e +2, in bytes) Next* each ASCII hexadecimal byte of the Hob file is in%ut) /inally* the four ASCII hexadecimal chec(sum bytes are in%ut on the last line @ + ,)


8>7?7820=


Page 0 of 01=

#he In-Sight sensor res%onds !ith 1* indicating that the Hob !as successfully sent to the sensorGs flash memory)

Notes&

' If the Hob file already exists on the sensor* the existing Hob data is over!ritten) ' If the Hob file does not already exist on the sensor* a ne! Hob file is created !ith the s%ecified name) ' #he si6e !ill be t!ice the number of bytes of the actual )B file si6e stored on the In-Sight sensor* due to the ASCII hexadecimal encoding of the data)

/elated #o+ics Set ob Store ob Read ob 4elete ob :et ob

4elete ob



4eletes the Hob from the s%ecified slot in flash memory on the In-Sight sensor)

Syntax: DJ[ID]

Notes&

' #he In-Sight sensor must be ffline) ' /or bac(!ards com%atibility on non-net!or( ca%able sensors* the Hob I4 number must be in the range of 2 to 0)

4elete ob In%uts

In%ut

4escri%tion


8>7?7820=


*

Page 82 of 01=


4elete ob ut%uts

Returns


0


2


-0


-8

#he Hob could not be deleted* the sensor is nline* or the Hob slot is em%ty* therefore the command could not be executed)

-<


*elete 'ob Exam+le #o delete the Hob 5#est)Hob5 from slot 2 on the In-Sight sensor* issue the follo!ing command& *'00#est,.ob

#he In-Sight sensor res%onds on the follo!ing line !ith the status code of1* indicating that the Hob !as deleted successfully)

/elated #o+ics Store ob Set ob Read ob 3rite ob :et ob

:et ob



Returns the I4 of the active Hob on the In-Sight sensor)

Syntax: GJ


8>7?7820=


Page 80 of 01=

Notes&

' #o use the Hob I4 number feature* the Hob to be loaded must be saved !ith a numerical %refix of 2 to ) /or bac(!ards com%atibility on non-net!or( ca%able In-Sight sensors* the %refix must be in the range of 2 to 0) ' #he active Hob must be saved !ith a numerical %refix before this command can be executed successfully) If the Hob has beendragged and dro%%ed* the file name must have a numerical %refix before this command can be executed successfully) ' 3hen a :et ob command is issued using Motoman communications* the status data is returned but the result data is not returned) "se the :et /ile command instead of the :et ob command* or %lace the Hob I4 number in another cell in the s%readsheet and use the:et ;alue command)

:et ob In%uts None) :et ob ut%uts

/eturns

A status code* follo!ed by the integer I4 of the a ctive Hob) #he status codes are&

1


0


!

#he active Hob has not been saved or does not have a numerical %refix* therefore the command could not be executed)

:et 'ob Exam+le #o return the I4 for the active H ob* issue the follo!ing command&:'

#he In-Sight sensor res%onds !ith 1 to indicate that the command !as executed successfully) #he active HobGs name is 5J?)B5)

/elated #o+ics Store ob Set ob Read ob 3rite ob 4elete ob

Read BMP


8>7?7820=



Page 88 of 01=


Sends the current image* in ASCII hexadecimal format +formatted to J2 characters %er line,* from an In-Sight sensor out to a remote device) 3hen converted to binary* the resulting data is in standard BMP image format)

Syntax:

R

Note& xecuting the Read BMP c ommand is the euivalent of executing theRead Image command)

Read BMP In%uts None) Read BMP ut%uts

Returns

A status code* follo!ed by a line terminator* follo!ed by lines of image data) #he status codes are&

0


2


->


-<


#he lines of image data are&

Si6e

#he second line contains an integer value for the si6e* in bytes* of the image)

Image

#he actual image data is encoded as ASCII hexadecimal values formatted to J2 characters %er line) ach line ends !ith a terminating character)

Chec(Sum

#he last line contains four ASCII hexadecimal bytes that are a chec(sum of the image data)

Read BMP xam%le #o read the current image +in ASCII hexadecimal format, from an In-Sight sensor* issue the follo!ing command&/B


8>7?7820=


Page 81 of 01=

#he In-Sight sensor initially res%onds !ith 1* indicating the command !as successfully executed) #he next line contains the si6e +@2, in bytes* follo!ed by the image data +in ASCII hexadecimal format), Note& Most of the actual image data has been omitted from the %receding gra%hic for clarity)

/inally* the four-byte ASCII hexadecimal chec(sum +E1, is returned)

/elated #o+ics 3rite BMP

Read Image



Sends the current image* in ASCII hexadecimal format +formatted to J2 characters %er line,* from an In-Sight sensor out to a remote device) 3hen converted to binary* the resulting data is in standard BMP image format)

Syntax:

RI

Note& xecuting the Read Image command is the euivalent of executing theRead BMP command)

Read Image In%uts None) Read Image ut%uts

Returns

A status code* follo!ed by a line terminator* follo!ed by lines of image data) #he status codes are&

0


2


->


-<


#he lines of image data are&

Si6e

#he second line contains an integer value for the si6e* in bytes* of the image)

Image


Chec(Sum


/ead mage Exam+le #o read the current image +in ASCII hexadecimal format, from an In-Sight sensor* issue the follo!ing command&/


8>7?7820=


Page 8> of 01=

#he In-Sight sensor initially res%onds !ith 1* indicating the command !as successfully executed) #he next line contains the data si6e +@2, in bytes* follo!ed by the image data +in ASCII hexadecimal format), Note& Most of the actual image data has been omitted from the %receding gra%hic for clarity)

/inally* the four-byte ASCII hexadecimal chec(sum +E1, is returned)

/elated #o+ics 3rite Image

3rite BMP



Sends image data from a remote device to an In-Sight sensor)

Syntax: W

[Size] [Ima!e] [Checksum]

Notes&

' #he In-Sight sensor must be ffline) ' xecuting the 3rite BMP command is the euivalent of executing the3rite Image command)

3rite BMP In%uts


8>7?7820=


Page 8? of 01=

#he command is sent on a se%arate line* follo!ed by the lines of image data* !hich should be an exact co%y of the data sent using aRead BMP command) #he lines of image data are&

In%ut

4escri%tion

Si4e

An integer value for the si6e +in bytes, of the image file)

mage


Chec5Sum


3rite BMP ut%uts

Returns


0


2


-8

#he image could not be !ritten* or the image data is invalid)

-1

#he chec(sum failed) #he chec(sum does not match the image data)

->


-<


6rite BMP Exam+le

#o send the system settings to the sensor* issue the f ollo!ing command&6B) After issuing the 3rite BMP command* the first in%ut is the si6e +@2, in bytes) Next* each ASCII hexadecimal byte of the image data is in%ut) /inally* the four ASCII hexadecimal chec(sum bytes are in%ut on the last line +E1,)

Note& Most of the actual image data has been omitted from the %receding gra%hic for clarity)


8>7?7820=


Page 8< of 01=

#he In-Sight sensor res%onds !ith 1* indicating that the image data !as successfully sent to the sensor)

/elated #o+ics Read BMP

3rite Image



Sends image data from a remote device to an In-Sight sensor)

Syntax: WI

[Size] [Ima!e] [Checksum]

Notes&

' #he In-Sight sensor must be ffline) ' xecuting the 3rite Image command is the euivalent of executing the3rite BMP command) 3rite Image In%uts #he command is sent on a se%arate line* follo!ed by the lines of image data* !hich should be an exact co%y of the data sent using aRead Image command) #he lines of image data are&

In%ut

4escri%tion

Si4e

An integer value for the si6e* in bytes* of the image file)

mage


Chec5Sum


3rite Image ut%uts

Returns


0


2


-8

#he image could not be !ritten* or the image data is invalid)


8>7?7820=


Page 8= of 01=

-1

#he chec(sum failed) #he chec(sum does not match the image data)

->


-<


6rite mage Exam+le

#o send the system settings to the sensor* issue the f ollo!ing command&6 After issuing the 3rite Image command* the first in%ut is the si6e +@2, in bytes) Next* each ASCII hexadecimal byte of the image data is in%ut) /inally* the four ASCII hexadecimal chec(sum bytes are in%ut on the last line +E1,)

Note& Most of the actual image data has been omitted from the %receding gra%hic for clarity)

#he In-Sight sensor res%onds !ith 1* indicating that the image data !as successfully sent to the sensor)

/elated #o+ics Read Image

:et ;alue



asyBuilder ;ie! S%readsheet ;ie!


8>7?7820=


Page 8J of 01=

EasyBuilder (iew Returns the contents of a s%ecified symbolic tag* such as an asyBuilder ocation or !nspection Tool result or Hob data)

Syntax: G"[#Sym$%lic Ta!#]

:et ;alue In%uts

In%ut

4escri%tion

Symbolic #ag

#he name of the symbolic tag Ksuch as a ocation or !nspection Tool result or Hob data +5ob)Robot)/ormatString)5* for exam%le,L)

:et ;alue ut%uts

Returns

A status code* follo!ed by a line terminator* follo!ed by the value contained in the s%ecified symbolic tag) #he status codes are&

0


2


-0

#he 5Symbolic #ag5 is invalid)

-8

#he command could not be executed)

Note& A symbolic tag containing any numeric value !ill return a float value formatted to 1 decimal %laces !hen reuested by the :et ;alue command* regardless of !hether the tool result or Hob data contains an integer or a floating-%oint value) If the symbolic tag contains a non-%rinting character* such as a Structure* a %ound character +, !ill re%lace the non-%rinting character) If the tool result or Hob data is em%ty* a null string !ill be sent)

:et ;alue xam%le Eou can return the data contained in a symbolic tag* such as an asyBuilderocation or !nspection Tool result or Hob data* by sending a :et ;alue command) 0) Assume that your Hob is configured to communicate !ith a Mitsubishi robot controller&

8) Eou need to retrieve the data string from the In-Sight vision system* using the :et ;alue Native Mode command) Issue the command :;ob)Robot)/ormatString* as sho!n in the follo!ing telnet client !indo!&

1) #he In-Sight vision system res%onds !ith 1* indicating that the command !as successfully executed* and the data in the formatted string)


8>7?7820=


Page 8 of 01=

S+readsheet (iew Returns the value contained in the s%ecified cell)

Syntax: G"[C%lumn][R%&]

:et ;alue In%uts

In%ut

4escri%tion

Column

#he column letter of the cell value to get =A to D?)

/ow

#he ro! number of the cell value to get) #he ro! number must consist of three digits=000 to >>? )

:et ;alue ut%uts

Returns

A status code* follo!ed by a line terminator* follo!ed by the value contained in the s%ecified cell) #he status codes are&

0


2


-0

#he cell I4 is invalid)

-8


Note& An In-Sight cell containing any numeric value !ill return a float value formatted t o 1 decimal %laces !hen reuested by the :et ;alue command* regardless of !hether the cell contains an integer or a floating-%oint value) If the cell contains a non-%rinting character* such as a Structure* a %ound character +, !ill re%lace the non-%rinting character) If the cell is em%ty* a null string !ill be sent)

:et ;alue xam%le 0) Assume that cells A0* B2 and B0 are %o%ulated as follo!s& A1  @,000 B0  Editnt=0F10? B1  Edit%loat=0F10?

A0 currently contains the value @ B2 contains the value  and B0 contains the value ,0) #he s%readsheet loo(s li(e this&

Issuing various :; commands %roduces the follo!ing results&


8>7?7820=


Page 12 of 01=

Set Integer




EasyBuilder (iew Sets the integer value of a symbolic tag* such as a %arameter contained in an asyBuilder ocation or !nspection Tool* or Hob data* to the s%ecified integer value) #he %arameter or Hob data must be an !nteger Data T"pe)

Syntax: SI[#Name#][S'ace][Int]

Set Integer In%uts

In%ut

4escri%tion

Name

#he name of the ocation or !nspection Tool %arameter +5PatternO0)ModelO#y%e5* for exam%le, or asyBuilder Hob data +5ob)xternalOResetOCounters5* for exam%le, to be set)

S+ace

A blan( s%ace to se%arate the 5name5 from the integer value)

nt

#he integer value to set)

Set Integer ut%uts

/eturns

0


2


-0

#he asyBuilder 5Name5 is invalid* or !as not an Integer 4ata #y%e)

-8

#he command could not be executed* or the s%ecified integer value is outside of the controlGs valid range) /or exam%le* the s%ecified name may not contain a control of the valid 4ata #y%e)

-<



8>7?7820=


Page 10 of 01=

Set Integer xam%les xam%le 0& Change the ;alue of a Parameter Containing an Integer ;alue

xam%le 8& "nchec( or Chec( a Parameter Containing a Chec(box

xam%le 1& Change the Selection !ithin a 4ro%-4o!n $ist

Exam+le 18 Change the (alue o< a Parameter Containing an nteger (alue Eou can set the integer value of a ocation or !nspection Tool %arameter* or Hob data* by sending a Set Integer command containing the ne! integer value) 0) Assume that your Hob contains a #attern ocation Tool* and the toolGs current Timeout %arameter setting is the default* ?222 milliseconds&

8) Do!ever* you !ould li(e to change that %arameterGs setting via the Set Integer Native Mode command) Issue the command SPatternG1,#imeout 00 as sho!n in the follo!ing telnet client !indo!&

1) #he In-Sight vision system res%onds !ith 1* indicating that the command !as successfully executed) #he toolGs Timeout %arameter has been successfully changed from 000 to 00&

Exam+le 8 "nchec5 or Chec5 a Parameter Containing a Chec5box Eou can enable or disable a toolGs chec(box %arameter by using the Set Integer command to send a value of1 +enable, or 0 +disable, 0) Assume that your Hob contains a #attern ocation Tool* and the toolGs current Scale Tolerance %arameter setting is the default* disabled +unchec(ed,&


8>7?7820=


Page 18 of 01=

8) Do!ever* you !ould li(e to change that %arameterGs setting %rogrammatically* to either enabled or disabled* based on a %articular %art) Issue the command SPatternG1,ScaleG#olerance 1* as sho!n in the follo!ing telnet client !indo!&

1) #he In-Sight vision system res%onds !ith 1* indicating that the command !as successfully executed) #he toolGs Scale Tolerance %arameter has been successfully changed from disabled +unchec(ed, to enabled +chec(ed,&

Exam+le 8 Change the Selection within a *ro+!*own -ist Eou can change the selection of a toolGs dro%-do!n menu list %arameter by using the Set Integer command to send an integer indicating the desired selection) #he items !ithin the dro%-do!n menu corres%ond to a $istBox control* !hich has an integer value +6ero-based, assigned to it) Eou can 5choose5 a different value from the list by using the Set Integer N ative Mode command to assign a different value to the %arameter that contains the dro%-do!n menu) 0) Assume that your Hob contains a $lobs %ounting Tool* and the toolGs current $lob %olor %arameter setting is the default* &ither7&

8) Do!ever* you !ould li(e to change that %arameterGs setting %rogrammatically* to either$lac'70 or (hite71* based on a %articular %roduct %art) Issue the command SBlobsG1,BlobGColor 1* as sho!n in the follo!ing telnet client !indo!&


8>7?7820=


Page 11 of 01=

1) #he In-Sight vision system res%onds !ith 1* indicating that the command !as successfully executed) #he toolGs $lob %olor %arameter has been successfully changed from &ither7 to (hite71&

S+readsheet (iew Sets the control contained in a cell to the s%ecified integer value) #he control must be of the t y%esditInt* Chec(box* or $istBox)

Syntax: SI[C%lumn][R%&][Int]

Set Integer In%uts

In%ut

4escri%tion

Column

#he column letter of the cell value to set =A to D?)

/ow

#he ro! number of the cell value to set) #he ro! number must contain a three-digit number=000 to >>? )

nt

#he integer value to set)

Set Integer ut%uts

/eturns

0


2


-0

#he cell I4 is invalid* or !as not an integer)

-8

#he command could not be executed* or the s%ecified integer value is outside of the controlGs valid range) /or exam%le* the s%ecified cell may not contain a control of the valid ty%e)

-<


Set Integer xam%les xam%le 0& Change the ;alue of an ditInt Control

xam%le 8& #oggle the State of a Chec(Box Control


8>7?7820=


Page 1> of 01=

xam%le 1& Change the Selection !ithin a $istBox Control

Exam+le 18 Change the (alue o< an Editnt Control #he command to set an ditInt control in cell A8 to the integer value is& SA00 0) Assume cell A8 is %o% ulated as follo!s& A  Editnt=0F10?

A8 currently contains the value ) #he s%readsheet loo(s li(e this&

8) 3e !ould li(e to change the value in A8 to  using the Set Integer Native Mode command issue the commandSA00 as sho!n in the follo!ing telnet client !indo!&

#he In-Sight sensor res%onds !ith 1* indicating that the command !as successfully executed) #he ditInt control has been successfully changed from  to  !ithin the s%readsheet&

Exam+le 8 #oggle the State o< a Chec5Box Control Eou can enable or disable a Chec(Box control using the Set Integer command by sending a value of1 +enable, or 0 +disable, to the cell that contains the chec( box) 0) Assume cells B8* 48 and 8 are %o%ulated as follo!s& B  Chec5Box=*raw circle? *  HChec5 box integer value  E  IBI

#he chec( box is currently cleared* as sho!n&


8>7?7820=


Page 1? of 01=

Note& Cell 8 is sim%ly re%orting the integer value of the Chec(Box control)

8) #o select this chec( box using the Set Integer Native Mode command* issue the commandSB001* as sho!n in the follo!ing telnet client !indo!&

#he In-Sight sensor res%onds !ith 1* indicating that the command !as successfully executed) #he chec( box is no! selected&

Cell 8 changed from 0 to 1 to reflect the ne! integer value of the Chec(Box control)

Exam+le 8 Change the Selection within a -istBox Control ach item !ithin a $istBox control has an integer value +6ero-based, assigned to it) Eou can 5choose5 a different value from the list by using the Set Integer Native Mode command to assign a different value to the cell that contains the $istBox control) 0) Assume cells B8* C8 and 48 are %o%u lated as follo!s& B  -istBox=/edF )rangeF JellowF :reenF BlueF ndigoF (iolet? C  H

nteger -ist (alue 

*  IBI

#he $istBox control is currently set to Jellow this corres%onds !ith an integer value of * as sho!n in the follo!ing s%readsheet&

Note& Cell 48 is sim%ly re%orting the integer value of cell B8)

8) #o change the current list selection to Blue using the Set Integer Native Mode command* issue the commandSB00@* as sho!n in the follo!ing telnet client !indo!&

#he In-Sight sensor res%onds !ith 1* indicating that the command !as successfully executed) #he list selection has been changed from Jellow to Blue !ithin the s%readsheet&


8>7?7820=


Page 1< of 01=

Cell 48 changed from  to @ to reflect the ne! integer value of the $istBox control)

Set /loat




EasyBuilder (iew Sets the floating-%oint value of a symbolic tag* such as an asyBuilderocation or !nspection Tool %arameter* or Hob data* to the s%ecified floating%oint value) #he symbolic tag must be a Floating #oint Data T"pe)

Syntax: SF[#Sym$%lic Ta!#][S'ace][Fl%at]

Set /loat In%uts

In%ut

4escri%tion

Symbolic #ag

#he name of the symbolic tag Ksuch as a ocation or !nspection Tool %arameter +5PatternO0)Dori6ontalOffset5* for exam%le, or asyBuilder Hob data +5Acuistion)x%osureO#ime5* for exam%le,L to be set)

S+ace

A blan( s%ace to se%arate the 5symbolic tag5 from the floating-%oint value)

%loat

#he floating-%oint value to set* including the decimal %oint +), character)

Set /loat ut%uts

/eturns

0


2


-0

#he 5Symbolic #ag5 is invalid* or the s%ecified value does not contain a floating-%oint number)

-8

#he command could not be executed* or the s%ecified floating %oint value is outside of the controlGs valid range) /or exam%le* the s%ecified name may not contain a control of the valid 4ata #y%e)

-<


Set /loat xam%le Eou can set the floating-%oint value of a ocation or !nspection Tool %arameter* or Hob data* by sending a Set /loat command containing the ne! floating-%oint value)


8>7?7820=


Page 1= of 01=

0) Assume that your Hob contains a #attern ocation Tool* and the toolGs current Hori)ontal *++set %arameter setting is the default* 2)222&

8) Do!ever* you !ould li(e to change that %arameterGs setting via the Set /loat Native Mode command) Issue the command S%PatternG1,;ori4ontalG)<
1) #he In-Sight vision system res%onds !ith 1* indicating that the command !as successfully executed) #he toolGs Dori6ontal ffset %arameter has been successfully changed from 0,000 to 022)128&

S+readsheet (iew Sets an edit box control contained in a cell to a s%ecified floating-%oint value) #he edit box control must be of the dit/loat ty%e)

Syntax: SF[C%lumn][R%&][Fl%at]

Set /loat In%uts

In%ut

4escri%tion

Column


/ow

#he ro! number of the cell value to set) #he ro! number must consist of three digits=000 to >>? )

%loat

#he floating-%oint value to set* including the decimal %oint +), character)

Set /loat ut%uts


8>7?7820=


/eturns

Page 1J of 01=

0


2


-0

#he cell I4 is invalid* or the s%ecified value does not contain a floating-%oint number)

-8

#he command could not be executed) /or exam%le* the s%ecified cell may not contain an edit box control* or the edit box control !as not created by the dit/loat function)

-<


Set /loat xam%le #he command to set an edit box contained in cell A8 to the floating %oint value =)8 is& S%A003, 0) Assume cell A8 is %o% ulated as follo!s& A  Edit%loat=0F10?

A8 currently contains a value of ,) #he s%readsheet loo(s li(e this&

8) #o change this value to 3, using the Set /loat Native Mode command issue the command S%A003, as sho!n in the follo!ing telnet client !indo!&

#he In-Sight sensor res%onds !ith 1* indicating that the command !as successfully executed) #he dit/loat control has been successfully changed from , to 3,&

Set Region





8>7?7820=


Page 1 of 01=

EasyBuilder (iew Sets a region contained in a symbolic tag* such as an asyBuilder ocation or !nspection Tool,sregion) #he toolGs region must contain an edit region control from an ditRegion function)

Syntax: SR[#Sym$%lic Ta!#][S'ace][R%&][S'ace][C%l][S'ace][(i!h][S'ace][Wi)e][S'ace][*n!le] [S'ace][Cu+,e]

Set Region In%uts

In%ut

4escri%tion

Symbolic #ag

#he name of the ocation or !nspection Tool +5dgeO0)Region5* for exam%le,)

S+ace

A blan( s%ace to se%arate the 5name5 from the floating-%oint value)

/ow

#he x-offset of the srcin* in fixture coordinates)

S+ace

A blan( s%ace to se%arate the value from the next value)

Col

#he y-offset of the srcin* in fixture coordinates)

S+ace


;igh

#he dimension along the regionGs x-axis)

S+ace


6ide

#he dimension along the regionGs y-axis)

S+ace


Angle

#he orientation* in fixture coordinates)

S+ace


Curve

#he angular deviation bet!een the r egionGs x-axis and the o%%osing boundary line)

Set Region ut%uts

/eturns

0


2


-0


-8

#he command could not be executed because the 5Symbolic #ag5 does not contain an edit region control* or the edit region control !as not created by the ditRegion function)

-<


Set Region xam%le Eou can set the Region of an asyBuilder ocation or !nspection Tool by sending a S et Region command containing the ne! regionGs %osition* dimensions* orientation and sha%e) 0) Assume that your Hob contains an &dge ocation Tool* and the toolGs region is currently in another %osition* !ith different dimensions* orientation and sha%e)

8) Do!ever* you !ould li(e to move and re-orient the toolGs region settings via the Set Region Native Mode command) Issue the command S/EdgeG1,/egion 1>,000 11>,000 123,000 0 0, 0 as sho!n in the follo!ing telnet client !indo!&


8>7?7820=


Page >2 of 01=

1) #he In-Sight vision system res%onds !ith 1* indicating that the command !as successfully executed)

S+readsheet (iew Sets an edit region control contained in acell the edit region control must be an ditRegion function)

Syntax: SR[C%lumn][R%&][R%&][S'ace][C%l][S'ace][(i!h][S'ace][Wi)e][S'ace][*n!le][S'ace] [Cu+,e]

Set Region In%uts

In%ut

4escri%tion

Column


/ow

#he ro! number of the cell value to set) #he ro! number must consist of three digits=000 to >>?

/ow

#he x-offset of the srcin* in fixture coordinates)

S+ace


Col

#he y-offset of the srcin* in fixture coordinates)

S+ace


;igh

#he dimension along the regionGs x-axis)

S+ace


6ide

#he dimension along the regionGs y-axis)

S+ace


Angle

#he orientation* in fixture coordinates)

S+ace


Curve

#he angular deviation bet!een the regionGs x-axis and the o%%osing boundary line)

Set Region ut%uts

/eturns

0


2


-0


-8


8>7?7820=


Page >0 of 01=

#he command could not be executed because the s%ecified cell does not contain an edit region control* or the edit region control !as not created by the ditRegion function) -<


Set Region xam%le #he command to set an edit region contained in cell A8 to a ne! location and dimensions) 0) Assume cell A8 is %o% ulated as follo!s&

A  Edit/egion=IAI0F0F0F0F1F1F1F1F/egionF0?

#he s%readsheet loo(s li(e this&

8) #o change the regionGs location and dimensions using the Set Region Native Mode command issue the commandS/A00@3,0 1, ,1 @@1  , as sho!n in the follo!ing telnet client !indo!&

#he In-Sight sensor res%onds !ith 1* indicating that the command !as successfully executed&

Set String




EasyBuilder (iew Sets the string of a symbolic tag* such as a %arameter of an asyBuilder !nspection Tool* to the s%ecified string) #he %arameter must be a String Data T"pe)


8>7?7820=


Page >8 of 01=

Syntax: SS[#Sym$%lic Ta!#][S'ace][St+in!]

Set String In%uts

In%ut

4escri%tion

Symbolic #ag

#he symbolic tag name of the ocation or !nspection Tool result +5#extO0)MatchOString5* for exam%le,)

S+ace

A blan( s%ace to se%arate the 5name5 from the string to set )

String

#he string to set)

Set String ut%uts

/eturns

0


2


-0


-8

#he in%ut string is longer than the s%ecified maximum string length in the ditString function or the cell d oes not contain an ditString function)

-<


Set String xam%le Eou can set the string of a -ead Te.t or -ead !D %ode !nspection Tool by sending a Set String command containing the ne! string) 0) Assume that your Hob contains a -ead Te.t !denti+ication Tool* and the toolGs current /atch String %arameter setting is the default* 0$%&

8) Do!ever* you !ould li(e to change that %arameterGs setting via the Set String Native Mode command) Issue the command S#extG1,MatchGString 20@ as sho!n in the follo!ing telnet client !indo!&

1) #he In-Sight vision system res%onds !ith 1* indicating that the command !as successfully executed) #he toolGs /atch String %arameter has been successfully changed from ABC to 20@&


8>7?7820=


Page >1 of 01=

S+readsheet (iew Sets an edit box control contained in a cell to a s%ecified string) #he edit box must be of the ty%e ditString)

Syntax: SS[C%lumn][R%&][St+in!]

Set String In%uts

In%ut

4escri%tion

Column


/ow

#he ro! number of the cell value to set) #he ro! number must contain a three-digit number=000 to >>? )

String

#he string to set)

Set String ut%uts

/eturns

0


2


-0

#he cell I4 or is invalid)

-8

#he in%ut string is longer than the s%ecified maximum string length in the ditString function or the cell d oes not contain an ditString function)

-<


Set String xam%le 0) Assume cell B8 is %o%ulated as follo!s& B  EditString=0?

#he ditString control currently contains the text Be

8>7?7820=


Page >> of 01=

8) #o change this text to A
#he In-Sight sensor res%onds !ith 1* indicating that the command !as successfully executed) #he ditString control has been successfully changed from Be
:et Info



Returns the system information for the In-Sight vision system)

Syntax: GI

:et Info In%uts None) :et Info ut%uts

Returns

A status code* follo!ed by the system information) #he status codes are&

0


2

"nrecogni6edcommand)

-8



8>7?7820=


Page >? of 01=

System information includes&

Serial Number

#he serial number of the In-Sight vision system)

A%%lication;ersion

#he current firm!are version on the In-Sight vision system)

Monitor;ersion

#he Monitor version of the In-Sight vision system)

MACAddress

4ate of Build

#he

MAC address of the In-Sight vision system)

#he date of build of the firm!are on the In-Sight vision system)

:et Info xam%le

#o dis%lay system information about an In-Sight vision system* i ssue the follo!ing command&:

#he vision system initially res%onds !ith 1* indicating the command successfully executed) n the follo!ing lines* the system information is re%orted)

Read Settings



Reads the system settings data from an In-Sight sensor) #he system settings data consist of the contents of the%roc)set file* encoded in ASCII hexadecimal format)

Syntax:

RS

Read Settings In%uts None) Read Settings ut%uts

Returns

A status code* follo!ed by a line terminator* follo!ed by lines of settings data) #he status codes are&

0


2



8>7?7820=


Page >< of 01=

-8

#he settings could not be read)

->


-<


#he lines of settings data are&

Si6e

#he first line contains an integer value for the si6e +in bytes, of the settings data)

Settings

#he data for the settings is encoded as ASCII hexadecimal values formatted to J2 characters %er line) ach line ends !ith the terminating character)

Chec(Sum

#he last line contains four ASCII hexadecimal bytes that are a chec(sum of the system settings data)

Read Settings xam%le #o read system settings data from an In-Sight sensor* issue the follo!ing command&/S

#he In-Sight sensor initially res%onds !ith 1* indicating the command successfully executed) #he follo!ing line +@@2, re%resents the amount of data +in bytes, to be transmitted) /inally* the system settings data are sent* follo!ed by a chec(sum >A23 + , of the data)

Notes&

' Most of the actual image data has been omitted from the %receding gra%hic for clarity) ' #he si6e re%orted by the /S command !ill be t!ice the number of bytes of t he %roc)set file* due to ASCII hexadecimal encoding of the data)

/elated #o+ics 3rite Settings Store Settings

3rite Settings




8>7?7820=


Page >= of 01=

Sends the system settings data from a remote device to the In-Sight sensor)

Syntax: WS

[Size] [Settin!s] [Checksum]

Note& #he In-Sight sensor must be ffline)

3rite Settings In%uts #he command is sent on a se%arate line* follo!ed by the lines of settings data* !hich should be an exact co%y of the data received from aRead Settings command)

#he lines of settings data are&

In%ut

4escri%tion

Si4e

#he first line contains an integer value for the si6e +in bytes, of the settings)

Settings

#he data for the settings is encoded as ASCII hexadecimal values formatted to J2 characters %er line) ach line ends !ith the terminating character)

Chec5Sum

#he last line contains four ASCII hexadecimal bytes that are a chec(sum of the system settings data)

3rite Settings ut%uts

Returns


0


2


-8

#he settings could not be saved)

-1

#he chec(sum failed) #he chec(sum does not match the settings data)

->


-<


6rite Settings Exam+le #o send the system settings to the sensor* issue the f ollo!ing command&6S

After issuing the 3rite Settings command* the first in%ut is the si6e +@@2, in bytes) Next* each ASCII hexadecimal byte of the system settings is in%ut) /inally* the four ASCII hexadecimal chec(sum bytes are in%ut on the last line >A23 + ,)


8>7?7820=


Page >J of 01=

#he In-Sight sensor res%onds !ith a status code of 1* indicating that the command !as executed successfully)

Notes&

' Most of the actual image data has been omitted from the %receding gra%hic for clarity) ' #he si6e !ill be t!ice the number of bytes of the %roc)set file* due to ASCII hexadecimal encoding of the data)

/elated #o+ics

Read Settings Store Settings

Store Settings



Stores the In-Sight sensor settings to the %roc)set file)

Syntax: TS

Store Settings In%uts None) Store Settings ut%uts

Returns

A status code) #he status codes are&

0


2



8>7?7820=


Page > of 01=

-8

#hesensor is nline* therefore the command could not be executed)

-<


Store Settings Exam+le

#o store the sensor settings to the %roc)set file* issue the follo!ing command&#S

#he In-Sight sensor res%onds !ith a status code of 1* indicating that the command !as executed successfully)

/elated #o+ics Read Settings 3rite Settings

Set IP Address $oc(



Prevents unauthori6ed changes to an In-Sight sensorGs I P address)

Syntax: SL[Int]

Set IP Address $oc( In%uts

In%ut

nt

4escri%tion

0

"nloc( the IP address

1

$oc( the IP Address

Set IP Address $oc( ut%uts

/eturns

1



8>7?7820=


Page ?2 of 01=

0


!1

#he value given for Int is either out of range or is not a valid integer)

!


!2


Set P Address -oc5 Exam+le

#o loc( the sensorGs IP address* issue the follo!ing command& S-1

#he In-Sight sensor res%onds !ith a status code of 1* indicating that the IP address !as successfully loc(ed)

/elated #o+ics :et IP Address $oc(

:et IP Address $oc(



Returns the security status of the IP address on an In-Sight sensor) #he ability to %revent unauthori6ed changes to the IP address is established by the Set IP Address $oc( command)

Syntax: GL

:et P Address -oc5 n+uts

None) :et IP Address $oc( ut%uts


8>7?7820=


/eturns

Page ?0 of 01=

2

#he IP address is not loc(ed)

0

#he IP address is loc(ed)

-8


:et P Address -oc5 Exam+le #o return the security status of the IP address on the sensor* issue the follo!ing command&:-

#he In-Sight sensor res%onds !ith 0* indicating that the IP address is not loc(ed)

/elated #o+ics Set IP Address $oc(

Set nline



Sets the In-Sight sensor into nline or ffline mode)

Syntax: S-[Int]

Notes&

' #his command cannot %lace the In-Sight sensor into nline mode if the sensor has been setffline either manually in the In-Sight x%lorer user interface or by a 4iscrete In%ut signal) ' #he In-Sight x%lorer a%%lication !ill send Set nline commands to In-Sight sensors to %erform administrative functions such asBac(u% and Restore)

Set nline In%uts

Input nt

*escri+tion 0

Sets the In-Sight sensor ffline)


8>7?7820=


1

Page ?8 of 01=

Sets the In-Sight sensor nline)

Set nline ut%uts

/eturns

1


0


!1

#he value given for Int is either out of ra nge* or is not a valid integer)

!


!

#he communications flag !as successful but the sensor did not go nline because the sensor is set ffline manually through the In-Sight x%lorer user interface or by a 4iscrete I 7 signal)

!2


Set nline xam%les xam%le 0& Set the In-Sight Sensor into nline Mode

xam%le 8& Set the In-Sight Sensor into ffline Mode

Exam+le 18 Set the n!Sight Sensor into )nline Mode #o set an In-Sight sensor into nline mode* issue the follo!ing command&S)1

#he In-Sight sensor res%onds !ith a status code of 1* indicating that the sensor !as successfully %laced nline)

Exam+le 8 Set the n!Sight Sensor into )<
#he In-Sight sensor res%onds !ith a status code of 1* indicating that the sensor !as successfully ta(en ffline)


8>7?7820=


Page ?1 of 01=

:et nline



Returns the nline state of the In-Sight sensor)

Syntax: G-

:et nline In%uts None) :et nline ut%uts

/eturns

0

#he In-Sight sensor is currently ffline)

1

#he In-Sight sensor is currently nline)

:et nline xam%le #o determine the nline state of an In-Sight sensor* issue the follo!ing command&:)

#he In-Sight sensor res%onds !ith 0* indicating that the sensor is currently ffline)

Set vent



#riggers a s%ecified event in the s%readsheet through a Native Mode command) ' Setvent In%uts ' Setvent ut%uts ' Setvent xam%le

Notes&

' If the In-Sight vision system !ill be configured to acce%t an acuisition trigger from a P$C7Motion Controller via aNative Mode command* Cognex recommends that the Setvent and 3ait function be utili6ed* !ith the vent code set to J + S6,) #his !ill ensure that vision system !aits for both the acuisition and ins%ection to be com%leted before sending a 5com%lete5 res%onse bac( to t he P$C7Motion Controller* and that %revious ins%ection results are not being sent to the P $C7Motion Controller) #he 5com%lete5 res%onse from the vision system can also then be used to create conditional P$C logic that sends a read reuest for the ins%ection results) If the Setvent function !ill be used by a


8>7?7820=


Page ?> of 01=

P$C7Motion Controller to trigger an acuisition* it should only be used in circumstances !here the ins%ection results are not also being read) ther!ise* the acuisition and ins%ection !ill not be synchroni6ed* !ith the vision system returning a res%onse as soon as the image is acuired and before the ins%ection has been com%leted) ' In Hob de%loyment environments in !hich In-Sight x%lorer or the ;ision;ie! a%%lication are monitoring ins%ections* if the Hob de%ends u%on a Soft vent +configured as a #imer function* for exam%le, to trigger a s%readsheet event* it may cause the ins%ection of an image to be delayed if it is triggered shortly before the acuisition cycle com%letes) If the H ob file is large +i)e) it c ontains many;ision #ools* such as Pattern Match* /la! 4etection and7or Ins%ectdge tools* in addition to additional Hob logic,* the u%date reuired by In-Sight x%lorer or ;ision;ie! may %revent an image from being ins%ected until the dis%lay u%date is ueued) /or a%%lications !hich reuire exact timing +e)g) measured in the 02s of milliseconds, * this u%date may result in a delay in determining a %ass7fail r esults* and thus the transmission of that result to the next station +e)g) a P$C or motion controller, in the ins%ection %rocess) #herefore* in these ty%es of a%%lication environments* Cognex recommends that Soft vents not be utili6ed to avoid the %ossibility of delayed ins%ections)

Set vent In%uts

Syntax: S.[Int]

Input

*escri+tion

nt

#he vent code to set)

+2 to =,

S%ecifies a soft trigger =So
J

Acuire an image and u%date the s%readsheet) #his o%tion reuires theAcuireImage functionGs #rigger %arameter to be set to External* Manual or Networ5)

Set vent ut%uts

/eturns

0


2


-0

#he number is either out of range + 0 to , or not an integer)

-8


-<


Set vent xam%le #he Setvent function may be used to trigger events in the s%readsheet through Native Mode commands)

#he command to trigger vent 2 +Soft 2, is& SE0 0) Assume cells A8 and A1 are %o%ul ated as follo! s& A  Event=0F0? A  Count=IAIF>>>>F0F0?


8) "sing the telnet client* issue > consecutive Set vent commands&


8>7?7820=


Page ?? of 01=

#he counter in cell A1 is incremented by 0 for each t imeSE0 is sent&

Set vent and 3ait



#riggers a s%ecified event and !aits until the command is com%leted to return a res%onse)

Notes&

' #he In-Sight vision system must be nline) ' If the In-Sight vision system !ill be configured to acce%t an acuisition trigger from a P$C7Motion Controller via aNative Mode command* Cognex recommends that the Setvent and 3ait function be utili6ed* !ith the vent code set to J + S6,) #his !ill ensure that vision system !aits for both the acuisition and ins%ection to be com%leted before sending a 5com%lete5 res%onse bac( to t he P$C7Motion Controller* and that %revious ins%ection results are not being sent to the P $C7Motion Controller) #he 5com%lete5 res%onse from the vision system can also then be used to create conditional P$C logic that sends a read reuest for the ins%ection results)

Set vent and 3ait In%uts

Syntax: SW[Int]

Input

*escri+tion

nt

#he vent code to set)

+2 to =,

J

Acuire an image and u%date the s%readsheet) #his o%tion reuires theAcuireImage functionGs #rigger %arameter to be set to External* Manual or Networ5)

Set vent and 3ait ut%uts

/eturns

0


2


-0

#he number is either out of range =0 to ? or not an integer)


8>7?7820=


Page ?< of 01=

-8

#he command could not be executed* or the sensor is ffline)

-<


Set vent and 3ait xam%le #he command to trigger vent 2 +Soft 2, is S60) A res%onse is not sent until the command has been com%leted) 0) Assume cells A8 and A1 are %o%ul ated as follo! s& A  Event=0F0? A  Count=IAIF>>>>F0F0?


8) Place the sensor nline) "sing the telnet client* issue > consecutive Set vent  3ait commands&

#he counter in cell A1 is incremented by 0 for each t imeS60 is sent&

Reset System



Resets the In-Sight sensor) #his c ommand is similar to %hysically cycling %o!er on the sensor)

Syntax: RT

Reset System In%uts None)


8>7?7820=


Page ?= of 01=

/eset System )ut+uts

Returns

A status code* follo!ed by a line terminator* follo!ed by lines of settings data) #he only status code returned is&

-<


/eset System Exam+le #o reset the In-Sight sensor* issue the follo!ing command& /#

#he In-Sight sensor is successfully reset and no status code is returned)

Send Message



Sends a string to an In-Sight s%readsheet over a Native Mode connection* and o%tionally* triggers a s%readsheet vent)

Syntax: S/#St+in!#[Int]

Send Message In%uts

In%ut

4escri%tion

String

#he string to set) Note& #he string must be enclosed !ith uotation mar(s)

Int

#heventcodetoset) Note& #his is an o%tional %arameter)

+2 to =,


8>7?7820=


J

Page ?J of 01=

Acuire an image and u%date the s%readsheet) #his o%tion reuires that theAcuireImage functionGs #rigger %arameter be set to External or Manual)

Send Message ut%uts

/eturns


0


2


-0

#he number is either out of range =0 to ? or not an integer)

-8

#he command could not be executed* or the sensor is ffline)

-<


Send Message Exam+les xam%le& Send a #ext String

xam%le& Send a String and #rigger a S%readsheet vent

Exam+le8 Send a #ext String 0) Assume cells A8 and A1 are %o%ul ated as follo! s& A  Event=0F0? A  /eadMessage=A?


8) Place the sensor nline) "sing the telnet client* issue the Send Message command* follo!ed by theSet vent command) #he command to send the string 5#est5 is SM#est) #he command to trigger vent 2 +Soft 2, is& SE0)

#he ReadMessage function in cell A1 dis%lays 5#est5)

Exam+le8 Send a String and #rigger a S+readsheet Event


8>7?7820=


Page ? of 01=

0) Assume cells A8 and A1 are %o%ul ated as follo! s& A  Event=0F0? A  /eadMessage=A?


8) Place the sensor nline) "sing the telnet client* issue the Send Message command to the In-Sight sensor) #he command to send the string 5#est5 and trigger vent 2 +Soft 2, is& SM#est0)

1) #a(e the sensor ffline) #he ReadMessage function in cell A1 dis%lays 5#est5)

:et

xtended Native Mode Commands - :et


#hree commands are used in conHunction !ith the:et extended Native Mode command to receive information from the I n-Sight vision system and its s%readsheet& ' :et Connections ' :et x%r KColumnLKRo!L ' :et /ilelist

Syntax: Get [c%mman)]

Note& A s%ace is needed bet!een :et and the command* as !ell as bet!een the command and any in%ut %arameters)

:et Connections Returns current connection information for the In-Sight vision system)

Syntax: Get C%nnecti%ns


8>7?7820=


Page <2 of 01=

:et Connections n+uts None)

:et Connections )ut+uts Returns

' A status code) #he status codes are&

0


2

"nrecogni6edco mmand)

-0

#he in%ut is invalid or has exceeded 0? bytes in length)

-8


-<

A %arameter !as invalid or exceeded 0? bytes in length)

' #he number of users currently logged onto the vision system) ' #he names of the users that are currently logged on to the vision system) ' A hexadecimal re%resentation of each userGs /#P Read73rite %ermissions*Access level and ava a%%let connections) #he /#P Read73rite %ermissions* Access levels a nd ava a%%let connections are&

0x01 Read

2x28 3rite

2x2J "sers !ith a Protected access level are restricted from s!itching the vision system bet!een itsnline a modes of o%eration)

2x02 /ull

2x82 Protected 2x>2 $oc(ed 2xJ2 ava a%%let connection ' #he Dost Name and IP address +as a hexadecimal number, of each userGs vision system)

:et Connections Exam+le #o retrieve the vision systemGs connection settings* issue the follo!ing command&:et Connections

#he In-Sight vision system initially res%onds !ith the status code +1,* follo!ed by the number of users currently logged in to the In-Sight vision system +,) Next* the connection information is %resented for each user) #he first user*admin* has a hexadecimal access re%resentation of 0x1 this re%resentation is obtained by summing the /#P Read73rite %ermissions and Access level that a%%lies to the user +see%receding table,) In this case* admin has /ull access +2x02, . /#P Read %ermission +2x20, . /#P 3rite %ermission +2x28, Q 2x01) #he user admin is currently connected from the vision system named %AC#)/J%-))/!1) #he IP address of /AC#RE/$R-0 is 08)0
Connection information for the second user +monitor, is %resented similarly on the follo!ing line)


8>7?7820=


Page <0 of 01=

:et Ex+r Returns the %arameters or value stored in the cell s%ecified by the column and ro address* as !ell as the state of that cell)

Syntax: Get .x'+ [C%lumn][R%&]

Note& If the s%ecified cell is em%ty* the t!o out%ut lines after the status code !ill be blan()

:et Ex+r n+uts Input

*escri+tion

Column


/ow

#he ro! number of the cell value to set) #he ro! number must consist of three digits=000 to >>? )

:et Ex+r )ut+uts

Returns

' A status code) #he status codes are&

0


2


-0

#he cell I4 is invalid or has exceeded 0? bytes in length)

-8


' #he %arameters or values that are stored in the s%ecified cell) ' #he state of the s%ecified cell)

2

#he cell is disabled)

0

#he cell is enabled)

:et Ex+r Exam+le #o retrieve the %arameters returned byAcuireImage that is stored in cell A2* issue the follo!ing command&:et Ex+r A000

After issuing the command :et Ex+r A000 * the In-Sight vision system res%onds !ith a status code +1,* follo!ed by the ex%ression contained !ithin cell A2) /inally* the cell state +1, is dis%layed)

:et %ilelist


8>7?7820=


Page <8 of 01=

Returns the number of files stored in memory* and the name of each file in memory on the In-Sight vision system)

Syntax: Get Filelist

Notes&

' If a RAM 4is( folder is enabled on the vision system* the 5RAM4is(5 folder name is included in the :et /ilelist out%ut) ' It is not %ossible to get the file list from a RAM 4is( folder using the :et /ilelist Native Mode command) In order to obtain the file list of a RAM 4is( folder* use the /#P %rotocol instead) Note that the C4 +change directory, /#P command is not su%%orted)

:et %ilelist n+uts None)

:et %ilelist )ut+uts

Returns

A status code* follo!ed by the number of files stored in memory* follo!ed by the name of each file in memory) #he status codes are&

0


2


-0

#he in%ut is invalid or has exceeded 0? bytes in length)

-8


:et %ilelist Exam+le #o retrieve a count and list of files that are stored on the In-Sight vision system* issue the follo!ing command&:et %ilelist

After issuing the command :et %ilelist* the In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of files %resent in memory +1,) /inally* the individual name of each file is dis%layed)

Put

xtended Native Mode Commands - Put



8>7?7820=


Page <1 of 01=

Syntax& Put KcommandL Kin%ut %arametersL

About Put #he follo!ing commands are used in c onHunction !ith the Put extended Native Mode command to send information to an In-Sight vision system and its s%readsheet& ' ' ' ' ' '

Put $ive KIntL Put Portnum KIntL Put #imeout KIntL Put "%date Put 3atch KColumnLKRo!LKIntL Put M$ KIntL

Note& A s%ace is needed bet!een Put and the command* as !ell as bet!een the command and the in%ut %arameters +if any),

Put -ive #urns live acuisition mode on or off)

Syntax: 0ut Li,e [Int]

Note& #he vision system must be ffline !hen using the Put $ive command)

Put -ive n+uts n+ut

*escri+tion 0  4isable live acuisition mode)

nt

1  nable live acuisition mode)

Put -ive )ut+uts A status code) #he status codes are&

1

Returns

0 !1 ! !2

#he command !as executed successfully) "nrecogni6ed command) #he in%ut is invalid or has exceeded 0? bytes in length) #he command could not be executed* or the vision system is nline) "ser does not have /ull Access to execute the command)

Put -ive Exam+le #o %lace the vision system into live acuisition mode* issue the follo!ing command&Put -ive 1

#he In-Sight vision system res%onded !ith a status code of 1* indicating that the vision system !as successfully %laced into live acuisition mode)


8>7?7820=


Page <> of 01=

#o ta(e the vision system out of live acuisition mode* issue the command&Put -ive 0

#he In-Sight vision system res%onded !ith a status code of 1* indicating that the vision system !as successfully ta(en out of live acuisition mode)

Put Portnum S%ecifies the %ort that !ill be used by the In-Sight vision system for transferring data or images over the net!or()

Syntax: 0ut 0%+tnum [Int]

Notes&

' #he Portnum command must be executed before another device can connect to the s%ecified %ort) ' If the %ort number is changed* the In-Sight PC Server !ill be disabled) ' #he In-Sight 8222 series vision sensor does not su%%ort this extended native mode command* and returns! !hen issued)

Put Portnum n+uts n+ut

*escri+tion

S%ecifies the %ort number) nt

=1 to 2? Note& A valid %ort assignment is any unused number from 0 to
Put Portnum )ut+uts A status code) #he status codes are&

1

Returns

0 !1 ! !2

#he command !as executed successfully) "nrecogni6ed command) #he in%ut is invalid or has exceeded 0? bytes in length) #he command could not be executed* or the vision system is nline) "ser does not have /ull Access to execute the command)

Put Portnum Exam+le #o s%ecify 1220 as the %ort to be used for transferring data or images across the net!or(* issue the follo!ing command&Put Portnum 001


8>7?7820=


Page
#he In-Sight vision system res%onded !ith a status code of 1* indicating that the %ort number !as successfully changed to001)

Put #imeout S%ecifies the amount of time +ms, that a %ort connection from a client may be left o%en !ithout any activity) If the In-Sight vision system does not receive any messages from the client for the s%ecified amount of time* it !ill close the %ort)

Syntax: 0ut Time%ut [Int]

Note& #he timeout is reset to the default +0 ms, if the In-Sight vision system is rebooted)

Put #imeout n+uts n+ut nt

*escri+tion !1 or 0K =1 to >>>>>>>?

4oes not timeout) 4uration of time +ms, that a %ort connection may be left o%en !ithout any activity)

 denotes default value

Put #imeout )ut+uts A status code) #he status codes are&

Returns

1 0 !1 !2

#he command !as executed successfully) "nrecogni6ed command) #he in%ut is invalid or has exceeded 0? bytes in length) "ser does not have /ull Access to execute the command)

Put #imeout Exam+le #o s%ecify a timeout of 12222 ms* issue the follo!ing command& Put #imeout=0000?

#he In-Sight vision system res%onded !ith a status code of 1* indicating that the timeout !as successfully changed to0000)


8>7?7820=


Page << of 01=

Put "+date "%dates the :"I +s%readsheet* cell gra%hics and image dis%lay,)

Syntax: 0ut 1')ate [Int]

Put "+date n+uts n+ut nt

*escri+tion 1 Q "%dates the :"I +s%readsheet* cell gra%hics and image dis%lay,)

Put "+date )ut+uts A status code) #he status codes are&

1

Returns

0 !1 ! !2

#he command !as executed successfully) "nrecogni6ed command) #he in%ut is invalid or has exceeded 0? bytes in length) #he command could not be executed) "ser does not have /ull Access to execute the command)

Put "+date Exam+le #o u%date the :"I* issue the follo!ing command& Put "+date 1

#he In-Sight vision system res%onded !ith a status code of 1* indicating that the command successfully executed)

Put 6atch Returns the value contained in the s%ecified cell each time the cell is u%dated) #he Put 3atch command can be used to s%ecify out%ut cells and send data using the 4ataChannel)

Syntax: 0ut Watch [C%lumn][R%&][Int]

Notes&

' #he Put Portunum command must be executed to s%ecify a %ort to !hich the Put 3atch command !ill send information) ' #he In-Sight 8222 series vision sensor does not su%%ort this extended native mode command* and returns! !hen issued)

Put 6atch n+uts


8>7?7820=


n+ut

Page <= of 01=

*escri+tion

Column


/ow

#he ro! number of the cell value to set) #he ro! number must consist of three digits=000 to >>? ) 0 Q disable out%ut of the cell value

nt

1 Q enable out%ut of the cell value only !hen it changes

8 Q enable out%ut of the cell value on every acuisition

Put 6atch )ut+uts

A status code* follo!ed by a line terminator* follo!ed by the value contained in the s%ecified cell) #he status codes are&

1

Returns

0 !1 ! !2

#he command !as executed successfully) "nrecogni6ed command) #he in%ut is invalid or has exceeded 0? bytes in length) #he command could not be executed) "ser does not have /ull Access to execute the command)

Put 6atch Exam+le #o receive information from cell A2* only !hen that cell is u%dated* issue the follo!ing command&Put 6atch A000

#he In-Sight vision system res%onded !ith a status code of 1* indicating that the command successfully executed)

Put 7MS%ecifies !hether Native Mode command out%ut results are formatted inM$)

Syntax:

0ut 2/L [Int]

Put 7M- n+uts n+ut

*escri+tion 0 Q disable M$ formatting +default,

nt

1 Q enable legacy M$ formatting  Q enable strict M$ formatting

Put 7M- )ut+uts Returns


8>7?7820=


Page

1 0 !1

#he command !as executed successfully) "nrecogni6ed command) #he in%ut is invalid or has exceeded 0? bytes in length)

Put 7M- Exam+le In the follo!ing exam%les* the standard out%ut is com%ared !ith legacy M$-enabled out%ut and strict M$-enabled out%ut)

Put 7M- 0

#o disable M$ formatting for the out%ut results* issue the follo!ing command&Put 7M- 0) #he In-Sight vision system r es%onds !ith 1* indicating the M$ has been successfully disabled) Next* issue the :et /ilelist command)

Put 7M- 1

#o enable legacy M$ formatting for the out%ut results* issue the follo!ing command&Put 7M- 1) #he In-Sight vision system res%onds !ith 1* using the a%%ro%riate M$ formatting* indicating that legacy M$ has been successfully enabled) Next* issue the:et /ilelist command the res%onse is in legacy M$ format)

Put 7M- 

#o enable strict M$ formatting f or the out%ut results* issue the follo!ing command&Put 7M- ) #he In-Sight vision system re s%onds !ith 1* using the a%%ro%riate M$ formatting) Next* issue the:et /ilelist command the res%onse is in strict M$ format +for exam%le* the /ileName I4 value is enclosed in uotes,)


8>7?7820=


Page < of 01=

valuate

xtended Native Mode Commands - valuate In-Sight Communications Reference

xecutes In-Sight functions* as !ell as inserting formulas into the In-Sight s%readsheet) valuate executes commands for retrieving information from* and ma(ing changes to* In-Sight vision systems)

Syntax: ." [c%mman)]

Notes&

' In-Sight functions that return a dat astructure cannot be executed using the valuate command ho!ever* these functions can be inserted into the In-Sight S%readsheet) ' Changes made to the In-Sight system settings using the valuate command are tem%orary rebooting the In-Sight vision system !ill lose any changes) #o save settings to the %roc)set file* use the Store Settings command)

valuate In%uts

Command

Any su%%orted In-Sight function* or a legal string of functions* as !ell as general commands)

Note& Any in%uts that are enclosed in uotation mar(s +such as 54DCP#imeout5 for:etSystemConfig, must be enclosed by uotes !hen sent to the In-Sight vision system)

valuate ut%uts

Returns

' A status code) # he status codes are&

1


0


!


->

#he In-Sight vision system is out of m emory)

!2


' #he number of characters +in bytes, contained !ithin the out%ut that follo!s) ' #he results of the ex%ression in M$ format +only sho!n if the status code is 0),


8>7?7820=


Page =2 of 01=

Note& #he results of the ex%ression are de%endent on the command that is executed)

Evaluate Exam+les xam%le& Remotely Place an In-Sight /ormula into a S%readsheet Cell "sing t he valuate Command

xam%le& Retrieve Information from the In-Sight ;ision System "sing the valuate Command and In-Sight /unctions

xam%le& Retrieve In-Sight Net!or( Settings "sing the valuate Command

xam%le& Change S%ecific In-Sight Settings "sing the valuate Command

Exam+le8 /emotely Place an n!Sight %ormula into a S+readsheet Cell "sing the Evaluate Command #he general syntax to remotely %lace an In-Sight formula into a s%readsheet cell using the valuate command is as follo!s&

Syntax: ." [C%lumn][R%&] [Cell state] [F%+mula]

Evaluate n+uts

Column


/ow

#he ro! number of the cell value to set =0 to >>?)

Cell state

#he current state for the s%ecified cell =0  *isabledL 1  Enabled? ) Notes& ' Cell state can also reference +absolute or relative, another cell) If the referenced cell is em%ty* the cell state !ill be 2) ' If a Controls /unction* containing a text label* is inserted into the s%readsheet !ith the cell state s%ecified as disabled* the :"I !ill only sho! the gra%hic associated !ith the control) #he text label ! ill remain hidden in the s%readsheet until the cell state is modified !ithin the s%readsheet)

%ormula

A combination of values* functions* arguments* and o%erators used to create a formula)

Exam+le A8 /emotely nserting Basic %unctions

0) Assume the s%readsheet is configured as follo!s& A   A@  @ A   A2  2

/ormulas can be inserted into the In-Sight s%readsheet using a remote connection) 8) 3hile logged on to the In-Sight vision system through a telnet client* ty%e the follo!ing command&E( A 1 Sum=1FFA8A2?


8>7?7820=


Page =0 of 01=

#he In-Sight res%onds !ith a status code +1, follo!ed by the number of bytes +0, of M$ data returned) #his evaluate command inserts the formula Sum=1FFA8A2? into Cell AJ)

Note& #he actual result returned by the Sum s%readsheet function* 1* is not returned by this valuate command as M$ data use the:et ;alue command to retrieve this result instead) Exam+le B8 /emotely nserting %unctions with Pro+erty Sheets

/unctions that contain %arameters selected from a%ro%erty sheet can also be remotely inserted into the s%readsheet) /rom the telnet client* ty%e the follo!ing command& E( A 1 ExtractBlobs=IAI0F0F0F0F@0F32F1F@0F0F0FF!1F0F0FF1F100F100000F0? As sho!n in the follo!ing image* the In-Sight vision system res%onds !ith a status code 1+ , and the si6e +0, of M$ data returned)

#he xtractBlobs function has successfully been inserted into cel l A8 of the s%readsheet&

Exam+le8 /etrieve n

8>7?7820=


Page =8 of 01=

Syntax: ." [c%mman)]

0) Assume that an In-Sight s%readsheet contains a string is returned in the adHacent cell* as follo!s&

data structure in cell A8 that !as obtained from aReadI4Code function the decoded

A  /ead*Code=IAI0F0F0F0F12,3>F12,0F13,>2@F13>,11>F0F1F0F1FF0F0F0F0F1F0FF1F0F0F2F0F0F0?

8) "sing a telnet client* log on to the In-Sight vision system and ty%eE( :etString=A? as follo!s&

#he In-Sight vision system returns a status code of 1* indicating that the command !as executed successfully) #he next line re%orts that 2 bytes of M$ data !ere returned* !hile the final line consists of the results of the ex%ression* formatted inM$)

Exam+le8 /etrieve n!Sight Networ5 Settings "sing the Evaluate Command Syntax: ." [c%mman)]

3hile logged on to an In-Sight vision system from a telnet client* ty%eE( :etNetwor5=? to retrieve the system net!or( settings) #he telnet client out%ut is sho!n in the f ollo!ing image&


8>7?7820=


Page =1 of 01=

#he In-Sight vision system res%onds !ith a status code of 1 to indicate that the command !as executed successfully) #he next line contains the si6e + bytes, of the M$ data to follo! the remaining lines consist of the actual  M$ data that !as returned)

Exam+le8 Change S+eci
#he telnet client out%ut is sho!n in the follo!ing image&

#he In-Sight vision system res%onds !ith a status code of 1* indicating that the c ommand successfully executed) Next* 1 re%resents the number of M$ out%ut bytes to follo!) /inally* the actual M$ data is sho!n)

:etCellName


Returns the cell location of a s%ecified symbolic tag name* or the symbolic tag name of a s%ecified cell)

Syntax: ." GetCellName3#Name#4

:etCellName In%uts n+ut Name

*escri+tion #he name of the symbolic tag +such as 4istanceO0)4istance* for exam%le, or the cell location +A>* f or exam%le,) #he name must be enclosed in uotation mar(s)

:etCellName ut%uts

Returns A status code follo!ed by the number of characters* and the name or cell reference of the cell) #he status codes are&

0


2


-0


-8


-<



8>7?7820=


Page => of 01=

:etCellName Exam+le Symbolic #ag Name #o get the symbolic tag name of cell B112* issue the follo!ing command& E( :etCellName=B112?

Issuing this command %roduces the follo!ing result&

#he In-Sight sensor returns 1 to indicate that the command !as executed successfully the number of characters +in bytes, is f ollo!ed by the Symbolic #ag name)

Symbolic #ag Name Cell -ocation #o get the cell location of a symbolically tagged Distance /easurement Tool result* issue the follo!ing command&E( :etCellName =*istanceG1,*istance?


#he In-Sight sensor returns 1 to indicate that the command !as executed successfully) #he number of characters +in bytes, is follo!ed by the cell location)

:etCell;alue


Returns the contents of a s%ecified symbolic tag* such as a n asyBuilder fixture out%ut* asyBuilderocation or !nspection Tool result or S%readsheet cell* in M$ format) Note& If a Hob is being built and configured in a language other than nglish and these &nglish S"mbolic Tags +or &as"$uilder o%tion is enabled +chec(ed, in the %tions dialog* ser !nter+ace %anel* any symbolic tags references that !ere created %rior to enabling the o%tion must be u%dated to the nglish name version)

Syntax: ." GetCell"alue3#Sym$%lic Ta!#4

:etCell;alue In%uts n+ut Symbolic #ag

*escri+tion


8>7?7820=


n+ut

Page =? of 01=

*escri+tion #he name of the symbolic tag* such as a ocation or !nspection Tool result +54istanceO0)4istance5* for exam%le, or the cell reference +A>* for e xam%le,) /or the automatically generated asyBuilder fixture out%ut data* the name must be either 5ob)Robot)/ormatString5 or 5ob)/ormatString5* de%ending u%on the sel ectedDevice and #rotocol selected in the Communications A%%lication Ste%) #he name must be enclosed in uotation mar(s)

:etCell;alue ut%uts

Returns A status code follo!ed by the number of characters* and the contents of the cell +an integer* floating %oint value* or text string,) #he status codes are&

0


2


-8


-<


:etCell(alue Exam+le EasyBuilder #o retrieve fixture data for vision guided robotics a%%lications* or the result of aocation or !nspection Tool&

%ixture Exam+le
#here are t!o %ossible commands to issue* de%ending u%on the selected Device and #rotocol in the Communication ste%& ; :etCell;alue +5ob)Robot)/ormatString5, and ; :etCell;alue+5ob)/ormatString5,)

; :etCell;alue+5ob)Robot)/ormatString5, should be used in the follo!ing situations& ' #he Device selection is -obot) ' #he Device selection is *ther* and the #rotocol selected is either Serial 3u'a or Serial /otoman) ; :etCell;alue+5ob)/ormatString5, should be used in the follo!ing situations& ' #he Device selection is *ther* and the #rotocol selected is &thernet Native* Serial Native* Serial Te.t or T%#4!#) E( :etCell(alue='ob,/obot,%ormatString?


#he In-Sight sensor returns 1 to indicate that the command !as executed successfully) #he number of characters +in bytes, is follo!ed by the value in the cell +integer* floating %oint* or text string,)

E( :etCell(alue='ob,%ormatString?



8>7?7820=


Page =< of 01=


-ocation or ns+ection #ool /esult Exam+le

#he follo!ing exam%le illustrates issuing a command to retrieve the result of aDistance /easurement Tool&

E( :etCell(alue=*istanceG1,*istance?



S+readsheet #o retrieve the value in a s%ecific S%readsheet cell* issue the follo!ing command&

E( :etCell(alue=A?



:et4energi6eut%uts



8>7?7820=


Page == of 01=

Returns the 4e-nergi6e ut%uts 3hile ffline setting configured in the 4iscrete I7 Settings dialog)

Syntax: ." GetDe.ne+!ize-ut'uts34

:et4energi6eut%uts In%uts None) :et4energi6eut%uts ut%uts

/eturns

A status code* follo!ed by the number of characters +in bytes, for the results* then the results inM$ format)

1


0


!


!2


:et4energi6eut%uts xam%le

#o retrieve the 4e-nergi6e ut%uts 3hile ffline setting* issue the follo!ing command&E( :et*eEnergi4e)ut+uts=?

#he In-Sight sensor res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +1,) /inally* the 4e-nergi6e ut%uts 3hile ffline setting is returned)

:et4iagnostic$og


Returns a log of information used to diagnose errors on the In-Sight vision system)

Syntax: ." GetDia!n%sticL%!34

:et4iagnostic$og In%uts None)


8>7?7820=


Page =J of 01=

:et4iagnostic$og ut%uts

/eturns


1


0


!


!2


:et*iagnostic-og Exam+le #o retrieve the diagnostic log of the connection status bet!een the In-Sight Micro 0022 vision system and the CI-MICR* CI-MICR-CC* or CI-3N# thernet I7 module* issue the f ollo!ing command&E( :et*iagnostic-og=?

#he In-Sight sensor res%onds !ith a status code +1,* follo!ed by the number of characters +@@2,* in bytes) /inally* the diagnostic log is returned)

:et4iscreteIn%ut


Returns information that is configured in t he4iscrete I7 Settings dialog)

Syntax: ." GetDisc+eteIn'ut34

:et4iscreteIn%ut In%uts None) :et4iscreteIn%ut ut%uts

/eturns



8>7?7820=


1


0


!


!2


Page = of 01=

:et4iscreteIn%ut xam%le

#o retrieve the information configured in the 4iscrete I7 Settings dialog* issue the follo!ing command&E( :et*iscreten+ut=?

Note& Count* in the first M$ tag* re%resents the number of discrete in%uts) ach discrete in%ut is assigned a$ine I4 +6ero-based),

#he In-Sight sensor res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +@,) /inally* the information configured in the 4iscrete In%ut Settings dialog is returned)

:et4iscreteut%ut xtended Native Mode Commands - valuate In-Sight Communications Reference

Returns information that is configured in t he4iscrete I7 Settings dialog)

Syntax: ." GetDisc+ete-ut'ut34

:et4iscreteut%ut In%uts None) :et4iscreteut%ut ut%uts

/eturns


1


0


!


!2



8>7?7820=


Page J2 of 01=

:et4iscreteut%ut xam%le

#o retrieve the information configured in the 4iscrete I7 Settings dialog* issue the follo!ing command&E( :et*iscrete)ut+ut=?

Note& Count* in the first M$ tag* re%resents the number of discrete out%uts) ach discrete out%ut is assigned a$ine I4 +6ero-based),

#he In-Sight sensor res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +2,) /inally* the information configured in the 4iscrete I7 Settings dialog is returned)

:et4iscreteut%ut4elay


Returns delay settings that are configured in theut%ut 4etails dialog)

Syntax: ." GetDisc+ete-ut'utDelay3LineID5[/%)el]4

:et4iscreteut%ut4elay In%uts n+ut -ine*

*escri+tion

#he out%ut line number) IModule is an o%tional %arameter that can be used to return the 4iscrete ut%ut 4elay for a s%ecificI7 Module ty%e)

)Module

0 Q 4irect I7 7 CI-01?2 1 Q CI-0>?2 and CI-0><2  Q CI-0>22  Q CI-MICR and CI-MICR-CC

:et4iscreteut%ut4elay ut%uts )ut+ut #y+e

*escri+tion 0 Q None 1 Q Acuisition 4elay  Q #ime After #rigger


8>7?7820=


)ut+ut *elay

Page J0 of 01=

*escri+tion ' If #y+e Q 0* 4elay is ignored and forced to 2) ' If #y+e Q 1* 4elay returns the number of acuisition or trac(ing %ulses=0 to 1000? that the out%ut is delayed after a signal %ulse is received by an out%ut $ine) If this value is 2* then the In-Sight vision system u%dates the out%ut line immediately on evaluating the 3rite4iscrete function) If this value is F 2* then the out%ut $ine is al!ays %ulsed) ' If #y+e Q * 4elay returns the amount of time +0 to 10000 ms , before the out%ut is fired)

:et*iscrete)ut+ut*elay Exam+le #o retrieve the delay settings for -ine  for a C)!MC/) 9) Module * issue the f ollo!ing command& E( :et*iscrete)ut+ut*elay=F?

#he In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +3,) /inally* the #y%e +#ime A
:etasyBuilder#ag


Returns the asyBuilder #ag for the s%ecified symbolic tag name or cell location)

Syntax: ." Get.asyuil)e+Ta!3#Name#4

:etasyBuilder#ag In%uts n+ut Name

*escri+tion #he name of the symbolic tag or the cell location) 3hen the in%ut is a symbolic tag* it must be enclosed in uotation mar(s) 3hen the in%ut is a cell location* uotation mar(s are o%tional)

:etasyBuilder#ag ut%uts

Returns A status code follo!ed by the asyBulder #ag name) #he status codes are&

0


2


-8


:etEasyBuilder#ag Exam+le Symbolic #ag Name #o return the asyBuilder #ag associated !ith the 0c5uistion6Frames7#er7Second symbolic tag* issue the follo!ing command&E( :etEasyBuilder#ag=Acuisition,%ramesGPerGSecond?


8>7?7820=


Page J8 of 01=

#he In-Sight sensor returns 1 to indicate that the command !as executed successfully and the number of characters in bytes +@,) /inally* the results are returned in M$ format)

Cell -ocation #o return the asyBuilder #ag for cell /00* issue the follo!ing command&E( :etEasyBuilder#ag=%11?

#he In-Sight sensor returns 1 to indicate that the command !as executed successfully and the number of characters in bytes +@,) /inally* the results are returned in M$ format)

:etIPSingleAttribute


Returns In-Sight therNet7IP Class and I nstance Attributes)

Syntax: ." Get.I0Sin!le*tt+i$ute3Ima!e .,ent5Class5Instance5*tt+i$ute4

Note& #he :etIPSingleAttribute Native Mode command is only su%%orted on sensors !ith firm!are version 1)0)2 - 1)8)?) /or sensors !ith firm!are version 1)1)2 and higher* if the im%licit connection times out* the sensor automatically deletes the im%licit connection and session)

:etIPSingleAttribute In%uts

n+ut

*escri+tion

Image vent

References cell A2 in the s%readsheet) 3hen an Image vent is triggered* the s%readsheet cell u%dates)

Class

#he decimal identifier assigned to the Control and Information Protocol Class)

nstance

#he decimal value of the Instance being referenced)

Attribute

#he decimal identifier of the Attribute)


8>7?7820=


Page J1 of 01=

:etIPSingleAttribute ut%uts

/eturns

A status code* follo!ed by the number of characters +in bytes, for the results* then the results inM$ format) #he status codes are&

1


0


!


!2


#he results are&

(alue

2

#ransition to #imed ut

0

Auto 4elete

:etIPSingleAttribute xam%le

#o return the In-Sight therNet7IP Class and Instance Attributes* issue the follo!ing command&E( :etEPSingleAttribute=A0FF0F1?

#he In-Sight sensor res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +1,) /inally* the value +1, is returned)

:etxternal$ightMode


Returns the ty%e of external strobe device connected to the In-Sight =222 series vision system)

Syntax: ." Get.xte+nalLi!ht/%)e34

:etxternal$ightMode In%uts None)


8>7?7820=


Page J> of 01=

:etxternal$ightMode ut%uts

Status Code


1


0


!


!2


)ut+utMode 0

4isabled

1

PNP +Sourcing,



NPN +Sin(ing,

:etExternal-ightMode Exam+le #o return the ty%e of external strobe device connected to the vision system* issue the follo!ing command&E( :etExternal-ightMode=?

#he In-Sight sensor res%onds !ith a status code +1,* follo!ed by the number of characters +1,* in bytes) /inally* the ut%utMode is returned +,* indicating that the vision system is connected to an NPN +Sin(ing, external strobe device)

:et/#PSettings


Returns information that is configured in t he/#P Settings dialog)

Syntax: ." GetFT0Settin!s34

:et/#PSettings In%uts None) :et/#PSettings ut%uts

/eturns



8>7?7820=


1


0


!


!2


Page J? of 01=

:et/#PSettings xam%le

#o retrieve the information configured in the /#P Settings dialog* issue the follo!ing command&E( :et%#PSettings=?

#he In-Sight sensor res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +,) /inally* the information configured in the /#P Settings dialog is returned)

:etDost#able


Returns information contained in theIn-Sight Dost #able dialog)

Syntax: ." Get(%stTa$le34

:etDost#able In%uts None) :etDost#able ut%uts

/eturns


1



8>7?7820=


0


!


!2


Page J< of 01=

:etDost#able xam%le

#o retrieve the information contained in the In-Sight Dost #able dialog* issue the follo!ing command&E( :et;ost#able=?

Note& Count* in the first M$ tag* re%resents the number of hosts in the D ost #able)

#he In-Sight sensor res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +13,) /inally* the information configured in the In-Sight Dost #able dialog is returned)

:etMSBuffer


Returns the Machine Status data stored in one of J indexed buffers +6ero-based, !ithin theMachine Status stac() If Index is 0* the current Machine Status is returned)

Syntax: ." Get/Su66e+3In)ex4

Note& #he In-Sight 8222 series vi sion sensor does not su%%ort this extended native mode command* and returns ! !hen issued)

:etMSBuffer In%uts n+ut

*escri+tion

ndex

Identifies !hich buffer to return +2 to =,)

:etMSBuffer ut%uts

/eturns



8>7?7820=


1


0


!


!2


Page J= of 01=

:etMSBuffer xam%le

#o retrieve the Machine Status data stored in buffer 0 !ithin the Machine Status stac(* i ssue the follo!ing command&E( :etMSBu<
#he In-Sight sensor res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +,) /inally* the Machine Status data is returned)

Notes&

' #he date and time s%ecified for Boot#imeF !ill only be current after the %o!er has been cycled on an In-Sight device if the"se SN#P Services chec(box is selected and an SN#P server is located) ' #he :etMSBuffer command can be used !ithout the ; %refix by accessing theMachine Status Port)

:etNet!or(


Returns information that is configured in t heNet!or( Settings dialog)

Syntax: ." GetNet&%+k34

:etNet!or( In%uts None) :etNet!or( ut%uts


8>7?7820=


/eturns

Page JJ of 01=


1


0


!


!2


:etNet!or( xam%le

#o retrieve the information configured in the Net!or( Settings dialog* issue the follo!ing command&E( :etNetwor5

#he In-Sight sensor res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +,) /inally* the information configured in the Net!or( Settings dialog is returned) In this exam%le* the sensor is configureddynamically by the 4DCP server on startu%) If the "se4DCP in%ut is set to 0* the settings for static IP assignment are used)

:etSerialPort


Returns information that is configured in t heSerial Port Settings dialog) A valid serial Port +1, must be s%ecified)

Syntax: ." GetSe+ial0%+t30%+t4

:etSerialPort In%uts


8>7?7820=


n+ut

*escri+tion

Port

S%ecifies !hich serial %ortGs data !ill be returned)

Page J of 01=

:etSerialPort ut%uts

/eturns


1


0


!


!2


:etSerialPort xam%le

#o retrieve the information configured in the Serial Port Settings dialog* issue the follo!ing command&E( :etSerialPort=1?

#he In-Sight sensor res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +@33,) /inally* the information configured in the Serial Port Settings dialog is returned) Note& If Mode is set to 1 +"nused,* :etSerialPort returns !1 for the Mode out%ut)

:etStartu%


Returns information that is configured in t heStartu% dialog)

Syntax: ." GetSta+tu'34

:etStartu% In%uts None) :etStartu% ut%uts


8>7?7820=


/eturns

Page 2 of 01=


1


0


!


!2


:etStartu% xam%les

#o retrieve the information configured in the Startu% dialog* issue the follo!ing command&E( :etStartu+=?

#he In-Sight sensor res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +3>,) /inally* the information configured in the Startu% dialog is returned)

:etSystemConfig


#hese %arameters are used i n conHunction !ith the :etSystemConfig valuate Native Mode command to r eturn system information) ' ' ' ' ' ' '

Active Cells $imit 4DCP #imeout #elnet Port Net!or( Su%%orted $in( Modes Net!or( Reuested $in( Mode Services nabled Internal #em%erature

Active Cells -imit Returns the number of available s%readsheet cells settings configured in theActive Cells $imit dialog)

Syntax: ." GetSystemC%n6i!3#*cti,eCellLimit#4


8>7?7820=


Page 0 of 01=

n+uts n+ut

5ActiveCell$imit5

*escri+tion

#he active cell limit* in units of cells)

=0@ to 10@00?

)ut+uts A status code* follo!ed by the number of characters +in bytes, for the results* then the results inM$ format)

1


0


!


!2


/eturns

Exam+le #o retrieve the active cell limit of the I n-Sight vision system or vision system* issue the follo!ing command&E( :etSystemCon
#he In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +,) /inally* the current limit +21@@,* follo!ed by the minimum +0@, and maximum +1>, range active cell limit ranges are returned) 4DCP #imeout Returns 4DCP #imeout information that is c onfigured in theNet!or( Settings dialog)

Syntax: ." GetSystemC%n6i!3#D(C0Time%ut#4

n+uts n+ut

*escri+tion

#he time +? to 0J2 seconds default Q <2, an In-Sight vision system !ill !ait for a 4DCP server to res%ond !ith an available IP 54DCP#imeout5 address* !hen the vision system is configured for 4DCP) If the vision system times out* net!or( communication !ill be sus%ended) #he vision system !ill not attem%t to connect to the net!or( a gain until %o!er is cycled on the vision system)

)ut+uts /eturns



8>7?7820=


Page 8 of 01=

1


0


!


!2


Exam+le #o retrieve the 4DCP #imeout information configured in the Net!or( Settings dialog* issue the follo!ing command&E( :etSystemCon
#he In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +1,) /inally* the 4DCP #imeout information +0, is returned)

#elnet Port Returns #elnet Port information that is configured in theNet!or( Settings dialog)

Syntax: ." GetSystemC%n6i!3#Telnet0%+t#4

n+uts n+ut

*escri+tion

#he telnet %ort on !hich the active In-Sight vision system +a #CP7IP server !aiting for communication, listens for incoming reuests 5#elnetPort5 from a remote device +a #CP7IP client that initiates communication,) A valid %ort assignment is any unused number bet!een 0 and >J0J and ?2222 +reserved for In-Sight communications,)


1


/eturns 0


!


!2


Exam+le #o retrieve the #elnet Port information configured in the Net!or( Settings dialog* issue the follo!ing command&E( :etSystemCon

8>7?7820=


Page 1 of 01=

#he In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +,) /inally* the #elnet Port information +, is returned)

Networ5 Su++orted -in5 Modes Returns the thernet lin( s%eeds and du%lex modes +half or full, su%%orted by the vision system* as configured in theNet!or( Settings dialog)

Syntax: ." GetSystemC%n6i!3#Net&%+k7Su''%+te)Link/%)es#4

n+uts n+ut

*escri+tion

5Net!or()Su%%orted$in(Modes5

#he thernet lin( s%eeds and du%lex modes su%%orted by the vision system)

)ut+uts /eturns


1


0


!


!2


/esults /esult

2 022 020 028 021 02>

*escri+tion

Auto-Negotiate 02Mb%sDalf4u%lex 02Mb%s/ull4u%lex 022Mb%sDalf4u%lex 022Mb%s/ull4u%lex 0222Mb%s/ull4u%lex

Note& #he 1000 Mb+s %ull *u+lex o%tion is only available for vision systems that su%%ort 0222 Mb%s thernet s%eeds) /or In-Sight ?<22 series vision systems* it is only available on models !ith 08JMB non-volatile flash memory or higher)

Exam+le #o retrieve the su%%orted lin( s%eeds and du%lex modes for the vision system* issue the follo!ing command&E( :etSystemCon

8>7?7820=


Page > of 01=

#he In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +2,) /inally* the su%%orted thernet lin( s%eeds and du%lex modes are returned)

Networ5 /euested -in5 Mode Returns the vision systemGs current thernet lin( s%eed and du%lex mode +full or half,* as configured in theNet!or( Settings dialog)

Syntax: ." GetSystemC%n6i!3#Net&%+k7Re8ueste)Link/%)e#4

n+uts n+ut

*escri+tion

5Net!or()Reuested$in(Mode5

#he vision systemGs current thernet lin( s%eed and du%lex mode)

)ut+uts /eturns


1


0


!


!2


/esults /esult

2 022 020 028 021 02>

*escri+tion

Auto-Negotiate 02Mb%sDalf4u%lex 02Mb%s/ull4u%lex 022Mb%sDalf4u%lex 022Mb%s/ull4u%lex 0222Mb%s/ull4u%lex

denotes default value

Note& #he 1000 Mb+s %ull *u+lex o%tion is only available for vision systems that su%%ort 0222 Mb%s thernet s%eeds) /or In-Sight ?<22 series vision systems* it is only available on models !ith 08JMB non-volatile flash memory or higher)

Exam+le #o retrieve the current lin( s%eed for the vision system* issue the follo!ing command&E( :etSystemCon

8>7?7820=


Page ? of 01=

#he In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +0,) /inally* the current lin( s%eed is returned)

Services Enabled Returns Protocol Services information that is configured in the Net!or( Settings dialog) Note& #he therNet7IP and ProfiN# services are mutually exclusive* therefore both services cannot be enabled at the same time)

Syntax: ." GetSystemC%n6i!3#Se+,ices.na$le)#4

n+uts n+ut

*escri+tion

5Servicesnabled5

Services currently enabled on the vision system)

)ut+uts /eturns A status code* follo!ed by the number of characters +in bytes, for the results* then the results inM$ format)

1


0


!

#he active Hob has not been saved* therefore the command could not be executed)

!2


#he results are& #he value returned is a decimal value* converted from its binary euivalent)

Binary

Service

*ecimalEuivalent

ProfiN#

022

>

therNet7IP

202

8

Modbus Server

None

220

222

0

2


8>7?7820=


Page < of 01=

If more than one service is enabled* you can convert the ret urned decimal value to its binary euivalent to determine !hich services are enabled) Exam+le

Exam+le #o retrieve the Protocol Services information configured in the Net!or( Settings dialog* issue the follo!ing command&E( :etSystemCon
#he In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +0,) /inally* the enabled service+s, +, is returned* indicating the therNet7IP service is enabled)

nternal #em+erature Returns the internal tem%erature of the In-Sight =<227=J22 series and In-Sight J222 series vision system* in degrees Celsius)

Syntax: ." GetSystemC%n6i!3#Inte+nal7Tem'e+atu+e#4

n+uts n+ut

*escri+tion

5Internal)#em%erature5

#he vision systemGs internal tem%erature* in degrees Celsius)

)ut+uts /eturns


1


0


!


!2


/esults Returns the vision systemGs internal tem%erature* in degrees Celsius)

Exam+le #o retrieve the vision systemGs current internal tem%erature* issue the follo!ing c ommand&E( :etSystemCon

8>7?7820=


Page = of 01=

#he In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +,) /inally* the current tem%erature is returned* in degrees Celsius)

:et"ser$ist


Returns information configured in the"ser $ist dialog)

Syntax: ." Get1se+List34

:et"ser$ist In%uts None) :et"ser$ist ut%uts

/eturns


1


0


!


!2


:et"ser$ist Results Name

Returns the user name)

Access

Returns the access level of the user)

0

/ull

1

Protected



$oc(ed

(iew

Returns !hether or not the Custom ;ie! is dis%layed !hen the user logs on)

0

Custom

1

Normal +the S%readsheet ;ie! or asyBuilder ;ie! is dis%layed,)


8>7?7820=


/ead

6rite

Save'ob)nline

Page J of 01=

Returns !hether or not the user has /#P Read %rivilege)

0

No

1

Ees

Returns !hether or not the user has /#P 3rite %rivilege)

0

No

1

Ees

Returns !hether or not the user is allo!ed to save Hobs !hile online)

0

4isabled

1

nabled

:et"ser$ist xam%le

#o retrieve information configured in the "ser $ist dialog* issue the follo!ing command&E( :et"ser-ist=?

Note& Count* in the first M$ tag* re%resents the number of users in the "ser $ist)

#he In-Sight sensor res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +2,) /inally* the information configured in the "ser $ist dialog is returned)

/elated #o+ics "ser $ist 4ialog


8>7?7820=


Page  of 01=

SetCellName


Sets the symbolic tag name of a s%ecified cell* and o%tionally enables the symbolic tag to be transmitted over the PC channel to the In-Sight PC Server or to generate audit messages to an audit message server)

Syntax: ." SetCellName3Cell5#Name#5[/%)e]4

SetCellName In%uts n+ut *escri+tion Cell #he cell reference +A> for e xam%le,) Name #he text string that you !ant to use as a symbolic tag name) #he name must be enclosed in uotation mar(s)

Mode is an o%tional in%ut) 0  4isable ut%ut)   #he symbolic tag is transmitted via the PC channel) Mode   #he symbolic tag is used to generate audit messages to an audit message server) 10 #he symbolic tag is transmitted over the PC channel and used to generate audit messages to an audit message server) Note& #o generate audit messages* the nable Audit Messages chec(box must be chec(ed)

SetCellName ut%uts

Returns A status code) #he status codes are&

0


2


-0


-8 -<

#he command could not be executed) "ser does not have /ull Access to execute the command)

SetCellName Exam+le #o assign the symbolic tag name 53idth5 to the cell in B<2* issue the follo!ing command&E( SetCellName=B20F6idth?

#he In-Sight sensor returns 1 to indicate that the command !as executed successfully and the number of characters in bytes +1,) /inally* the results are returned in M$ format)


8>7?7820=


Page 022 of 01=

SetCell;alue


Sets the value of s%ecific cell a%%ended !ith an asyBuilder #ag) Note& #he In-Sight 8222 series vi sion sensor does not su%%ort this extended native mode command and returns !)

Syntax: ." SetCell"alue3#Name#5"alue5[/%)e]4

SetCell;alue In%uts n+ut *escri+tion Name #he asyBuilder #ag name that is being used for that cell) #he name must be enclosed in uotation mar(s) #he value to be used in the cell an integer* floating %oint value or text string) #he function !ill return RR if the cell s%ecified in (alue 5Name5 in%ut is not an ditInt* dit/loat or ditString function* or the value ty%es do not corres%ond)

Mode is an o%tional in%ut) 0  4isable ut%ut) #he named value is not enabled for PC data access and exchange) Mode 1  ut%ut nabled !hen the value of the cell changes)   nable ut%ut) #he named value is enabled for PC data access and exchange)

SetCell;alue ut%uts

Returns A status code) #he status codes are&

0


2


-0


-8


-<


SetCell(alue Exam+le #o set the /inimum Distance value of a Distance /easurement Tool* a%%ended !ith the asyBuilder #ag name 54istanceO0)Minimum5 and located in cell A00<* issue t he follo!ing command& E( SetCell(alue=*istanceG1,MinimumF2?

#he In-Sight sensor returns 1 to indicate that the command !as executed successfully) #he number of characters +in bytes, and%loatO19%loatO follo!s as a second confirmation of successful command execution)


8>7?7820=


Page 020 of 01=

Set4energi6eut%uts


Configures the 4e-nergi6e ut%uts 3hile ffline setting found in the 4iscrete I7 Settings dialog) Note& If the De8&nergi)e *utputs (hile *++linechec(box is enabled and the CI-MICR or CI-MICR-CC I7 module has an out%ut line configured as a i+eine signal ty%e* the line !ill remain DI:D !hen the connected vision system is %laced ffline)

Syntax: ." SetDe.ne+!ize-ut'uts3De.ne+!ize-ut'uts5W+ite0+%cSet4

Set4energi6eut%uts In%uts

In%ut

4escri%tion

4energi6eut%uts

0 Q 4isabled 1 Q nabled

3riteProcSet

0 Q Settings are not saved in the %roc)set file the settings do not %ersist if the In-Sight sensor is %o!er cycled) 1 Q Settings are saved in the %roc)set file the settings %ersist after the In-Sight sensor is %o!er cycled)

 denotes default value Set4energi6eut%uts ut%uts

/eturns


1


0


!


!2


Set4energi6eut%uts xam%le

#o configure the sensor to de-energi6e out%uts !hen %laced ffline* issue the follo!ing command&E( Set*eEnergi4e)ut+uts=1F1?



8>7?7820=


Page 028 of 01=

Set4iscreteIn%ut


Configures in%ut settings that are found in the4iscrete I7 Settings dialog)

Syntax: ." SetDisc+eteIn'ut3LineID5#Name#5Ty'e5Si!nal4

Notes&

' 3hen issuing this command* the In-Sight system must beffline) ' #here are t!o o%tions for enabling serial communication for the In-Sight =222 series vision system& using the Brea(out cable or using the CI-MICR or CI-MICR-CC I7 module) 3hen connected to the Brea(out cable +and there is no connection to an I7 module,* the vision system allo!s one discrete in%ut line and one discrete out%ut line to be configured asSerial -eceive and Serial Transmit* res%ectively) Refer to Do! to nable Serial Communication for the In-Sight =222 ;ision Systemfor more information) ' "se the Store Settings +#S, native mode command to save changes to the %roc)set file) If not saved to t he %roc)set file* the changes !ill be lost after %o!er-cycling the In-Sight vision system) Set4iscreteIn%ut In%uts n+ut

*escri+tion In-Sight 8222 series& =0? !hen connected to the Brea(out cable) In-Sight Micro 0222 series* In-Sight ?222 series and In-Sight J222 series& =0 to 3? !hen connected to a su%%orted I7 module)

In-Sight =222 series& ' =1 to ? * !hen connected to 4irect I7) $ineI4

' =0 to 3 and > to 11? * !hen connected to a su%%orted I7 module)

In-Sight =<227=J22 series& ' =0 to ? * !hen connected to 4irect I7) ' =1 to 3? * !hen connected to the CI-0>22 I7 module) ' =0 to 3? * !hen connected to a CI-MICR I7 module) #he name for the in%ut line) 5Name5 #y%e

Note& #he 5Name5 in%ut must be enclosed in uotation mar(s) 0 Q "ser 4ata 1 Q vent #rigger +1Q Reset Counters if using the In-Sight 8222 series vision sensor,  Q ob I4 Number +not su%%orted on the In-Sight 8222,  Q nline7ffline @ Q Acuisition #rigger +not su%%orted on the In-Sight 8222 series vision sensors and the CI-0>22),  Q ob $oad S!itch +not su%%orted on the In-Sight 8222,  Q Serial Receive +4irect I7  only only valid !hen-ine*  1,

Notes&

' Serial -eceive is only available !hen connecting to an In-Sight =222 series vision system !ith In-Sight x%lorer >)=)0 or later* and using In-Sight >)=)0 or later firm!are) ' 3hen the Set4iscreteIn%ut command is issued and In%ut $ine 0 is set toSerial -eceive* the vision system determines if ut%ut $ine 0 is set to Serial Transmit) If not* In%ut $ine 0 is te m%orarily reset to the default in%ut ty%e for this line) nce theSet4iscreteut%ut command is issued and ut%ut $ine 0 is set to Serial Transmit* In%ut $ine 0 is automatically set to Serial -eceive)

> Q ob Change +Pulsed,



8>7?7820=


n+ut

Page 021 of 01=

*escri+tion Note& 9ob %hange :#ulsed; is only available !hen connecting to an In-Sight 8222 series vision sensor running In-Sight ?)8)1 or later firm!are)

0 Q Rising dge

Signal 1 Q /alling dge

 Q Both dges

 denotes default value Note& #he *nline4*++line* 0c5uisition Trigger and 9ob oad Sitch in%ut ty%es may not be used on more than one in%ut line simultaneously)

Set4iscreteIn%ut ut%uts

/eturns


1


0


!


!2


Set4iscreteIn%ut xam%le

#o configure the follo!ing settings& -ine*& > Name& $ine > #y+e& ob I4 Number Signal& Rising dge

Issue the follo!ing command& E( Set*iscreten+ut=@F-NE@FF0?

#he In-Sight sensor res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +1,) /inally* the results are returned in  M$ format)

Set4iscreteut%ut



8>7?7820=


Page 02> of 01=

Configures out%ut settings in the 4iscrete I7 Settings dialog and the ut%ut 4etails dialog)

Syntax: ." SetDisc+ete-ut'ut3LineID5#Name#5Ty'e50ulse50ulseLen5Delay4

Notes& ' 3hen issuing this command* the In-Sight vision system must beffline) ' #here are t!o o%tions for enabling serial communication for the In-Sight =222 series vision system& using the Brea(out cable or using the CI-MICR or CI-MICR-CC I7 module) 3hen connected to the Brea(out cable +and there is no connection to an I7 module,* the vision system allo!s one discrete in%ut line and one discrete out%ut line to be configured asSerial -eceive and Serial Transmit* res%ectively) Refer to Do! to nable Serial Communication for the In-Sight =222 ;ision Systemfor more information) ' If an In-Sight vision system is being used in conHunction !ith a CI-0>22 or CI-0>?2 I7 module* do not use either theSet4iscreteut%ut or Set4iscreteut%ut4elay commands to change a discrete out%ut setting over the serial %ort) 4oing so may cause the vision system to become unres%onsive) "se the 4iscrete I7 Settings and ut%ut 4etails dialogs to ma(e the change* or send the commands over#elnet) ' "se the Store Settings +#S, native mode command to save changes to the %roc)set file) If not saved to t he %roc)set file* the changes !ill be lost after %o!er-cycling the In-Sight vision system)

Set4iscreteut%ut In%uts n+ut

*escri+tion

In-Sight Micro 0222 series* In-Sight ?222 series and In-Sight J222 series& ' =0F 1F @F ? * !hen connected to 4irect I7) ' =0 to 11? * !hen connected to a su%%orted I7 module)

In-Sight =222 series& $ineI4

' =0F 1F @F ? * !hen connected to 4irect I7) ' =0 to 1? * !hen connected to a su%%orted I7 module)

In-Sight =<227=J22 series& ' =0 to ?* !hen connected to 4irect I7) ' =0 to >?* !hen connected to a su%%orted I7 module) 5Name5 #y%e

#he name for the out%ut line) Note& #he 5Name5 in%ut must be enclosed in uotation mar(s) 0 Q Programmed 1 Q Digh  Q $o!  Q Acuisition Start @ Q Acuisition nd  Q ob Com%leted 2 Q System Busy 3 Q ob $oad T  Q ob $oad /ail > Q RR& Missed Acuisition 10 Q RR& #rac(ing verrun 11 Q RR& #rac(ing Uueue /ull 1 Q nline7ffline 1 Q Strobe ' In-Sight Micro 0222 series& nly valid !he n -ine*  1 +DS"# 0 for 4irect I7, or -ine*  > +DS"# 0 for CI-MICR* CI-MICR-CC* and CI-3N#,) ' In-Sight ?222 series& nly valid !hen -ine*  1 +DS"# 0 for 4irect I7 7 CI-01?2 or CI-0>22, or -ine*  > +DS"# 0 for CI-0>?2* CI-0><2* CI-MICR or CI-MICR-CC,) ' In-Sight =222 series& nly valid !hen -ine*  0 +DS"# 2 for 4irect I7, or -ine*   +DS"# 2 for CI-MICR or CIMICR-CC,) ' #he In-Sight =<227=J22 series& nly valid !hen -ine*  1 +DS"# 0 for 4irect I7  or CI-0>22, or -ine*  > +DS"# 0 for CI-MICR,) ' In-Sight J222 series& nly valid !hen -ine*  1 +DS"# 0 for 4irect I7, or -ine*  > +DS"# 0 for CI-MICR,) 1@ Q I7 Module Standby +CI-0>?2 and CI-0><2 only only valid !hen -ine*  0 ! 3, 1 Q $ight Control +CI-0><2 only only valid !hen -ine*  >, 13 Q $ifeline +CI -MICR  CI-MICR-CC nly, 1 Q 3aveform

denotes default value


8>7?7820=


n+ut

Page 02? of 01=

*escri+tion 0 Q Serial #ransmit +4irect I7 only only valid !hen -ine*  1, Notes&

' Serial Transmit is only available !hen connecting to an In-Sight =222 series vision system !ith In-Sight x%lorer >)=)0 or later* and using In-Sight >)=)0 or later firm!are) ' 3hen the Set4iscreteut%ut command is issued and ut%ut $ine 0 is set toSerial Transmit* the vision system determines if In%ut $ine 0 is set to Serial -eceive) If not* ut%ut $ine 0 is tem%orarily reset to the default out%ut ty%e for this line) nce the Set4iscreteIn%ut command is issued and In%ut $ine 0 is set to Serial -eceive* ut%ut $ine 0 is automatically set to Serial Transmit) @ Q ob Pass7/ail Cell 0 Q $evel ut%ut Note& 3hen T"pe is set to 1 +Strobe, and #ulse is set to 0* the Strobe7$ight Control #rigger setting is set to /ising Edge )

Pulse

1 Q Pulsed ut%ut Note& 3hen T"pe is set to 1 +Strobe, and #ulse is set to 1* the Strobe7$ight Control #rigger setting is set to %alling Edge )

4uration of an out%ut %ulse In-Sight Micro 0222 series* In-Sight ?222 series* In-Sight =<227=J22 series and In-Sight J222 series vision systems =10 to 1000 msL de28* 0>08 and 0?22 vision systems =1 to 1000 msL de
Pulse$en ' /or In-Sight =222 series and In-Sight Micro 0>28* 0>08 and 0?22 vision systems* only the %ulse length of the high-s%eed out%ut lines and user-configurable $4 lines can be set belo! 02ms) ' 3hen using the CI-Micro or CI-Micro-CC I7 module* the minimum %ulse length for general-%ur%ose out%uts is limited by the "%date #ime setting in the I7 Module Configuration dialog) /or exam%le* if the "%date #ime setting in the I7 Module Configuration dialog is 82ms* the minimum %ulse length cannot be set belo! 12ms) 4elay =0 to 1000? denotes default value Set4iscreteut%ut ut%uts

/eturns


1


0


!


!2


Set4iscreteut%ut xam%les

Exam+le 18 Job Load OK#y+e Settings #o configure the follo!ing settings& -ine*& 1 Name& 5$IN15 #y+e& ob $oad T Pulse& $evel ut%ut Pulse-en& 8?2 ms *elay& ?2

Issue the follo!ing command& E( Set*iscrete)ut+ut=F-NEF3F0F0F0?


8>7?7820=


Page 02< of 01=


Exam+le 8 Strobe#y+e Settings #o configure the Strobe #y%e settings& -ine*& 0 Name& 5$IN05 #y+e& Strobe Strobe9-ight Control #rigger & Rising dge Pulse-en& 02 ms *elay& ?2

Issue the follo!ing command& E( Set*iscrete)ut+ut=1F-NE1F1F0F10F0?

#he In-Sight sensor res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +1,) /inally* the results are returned in  M$ format) Note& #o configure the Strobe Start Position* use the SetSystemConfig native mode command)

Set4iscreteut%ut4elay


Configures delay settings that are found in theut%ut 4etails dialog)

Syntax: ." SetDisc+ete-ut'utDelay3LineID5Ty'e5[Delay]5[[W+ite0+%cSet]5[I-/%)ule]]4

Notes&


8>7?7820=


Page 02= of 01=

' If the Set4iscreteut%ut command is issued after the Set4iscreteut%ut4elay command* the Set4iscreteut%ut4elay settings !ill be over!ritten) ' If an In-Sight vision system is being used in conHunction !ith a CI-0>22 or CI-0>?2 I7 module* do not use either theSet4iscreteut%ut or Set4iscreteut%ut4elay commands to change a discrete out%ut setting over the serial %ort) 4oing so may cause the vision system to become unres%onsive) "se the 4iscrete I7 Settings and ut%ut 4etails dialogs to ma(e the change* or send the commands over#elnet) Set4iscreteut%ut4elay In%uts n+ut -ine* #y+e

*escri+tion

#he out%ut line number to be modified) 0 Q None 1 Q Acuisition 4elay  Q #ime After #rigger

*elay

' If #y+e Q 0* 4elay is ignored and forced to 2) ' If #y+e Q 1* 4elay is the number of acuisition or trac(ing %ulses =0 to 1000? to delay the out%ut after a signal %ulse is received by an out%ut $ine) If this value is 2* then the In-Sight vision system u%dates the out%ut line immediately on evaluating the 3rite4iscrete function) If this value is F 2* then the out%ut $ine is al!ays %ulsed) ' If #y+e Q * 4elay is the amount of time +0 to 10000 ms , to !ait before the out%ut is fired)

6riteProcSet

3riteProcSet is an o%tional %arameter) 0 Q Settings are not saved in the %roc)set file the settings do not %ersist if the vision system is %o!er cycled) 1 Q Settings are saved in the %roc)set file t he settings %ersist after the vision system is %o!er cycled)

)Module IModule is an o%tional sub-%arameter that can be used to set the 4iscrete  ut%ut 4elay for a s%ecificI7 Module ty%e) 0 Q 4irect I7 7 CI-01?2 1 Q CI-0>?2 and CI-0><2  Q CI-0>22  Q CI-MICR and CI-MICR-CC

Set4iscreteut%ut4elay ut%uts

Returns A status code follo!ed by the number of characters* in bytes) #he status codes are&

0


2


-8


-<


Set*iscrete)ut+ut*elayExam+le #o configure the follo!ing settings& -ine *& 1 #y+e& #ime After #rigger *elay& 8?2 ms 6riteProcSet& 0 )Module& CI-MICR

Issue the follo!ing command& E( Set*iscrete)ut+ut*elay=FF0F1F?


8>7?7820=


Page 02J of 01=

#he In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +1,) /inally* the results are returned in M$ format)

SetditRegion


Configures settings for a cell that contains anditRegion function) #he Cell must already contain an ditRegion function SetditRegion does not create one)

Syntax: ." Set.)itRe!i%n3Cell5R%&5C%lumn5(i!h5Wi)e5*n!le5Cu+,e4

SetditRegion In%uts

In%ut

4escri%tion

Cell

column

=A toD?

#he column letter of the cell value to set)

row

=0to>>?

#he ro! number of the cell value to set)

Ro!

#he Ro! offset of the origin in fixture coordinates)

Column

#he Column offset of the origin in fixture coordinates)

Digh

#he dimension along the regionGs x-axis) Note& #his value cannot be a negative number)

3ide

#he dimension along the regionGs y-axis) Note& #his value cannot be a negative number)

Angle

#he orientation in fixture coordinates)

Curve

#he angular deviation bet!een the regionGs -axis and the o%%osing boundary line)

SetditRegion ut%uts

/eturns



8>7?7820=


1


0


!


!2


Page 02 of 01=

SetditRegion xam%le 0) Insert an ditRegion function in cell A1 !ith the default settings) Assume cell A1 is %o%ulated as follo!s& A  Edit/egion=0F0F0F1F1F1F1FF0?

An ditRegion

control* along !ith a corres%onding results table is created in the adHacent cells to the right)

8) "sing the telnet client* issue the follo!ing command&E( SetEdit/egion=AF100F100F0F0F0F0?

#he ditRegion results table is u%dated to reflect the SetditRegion in%ut values)

SetIPSingleAttribute


Configures In-Sight therNet7IP Class and Instance Attributes)


8>7?7820=


Page 002 of 01=

Syntax: ." Set.I0Sin!le*tt+i$ute3Class5Instance5*tt+i$ute5"alue4

Note& #he SetIPSingleAttribute Native Mode command is only su%%orted on sensors !ith firm!are version 1)0)2 - 1)8)?) /or sensors !ith firm!are version 1)1)2 and higher* if the im%licit connection times out* the sensor automatically deletes the im%licit connection and session)

SetIPSingleAttribute In%uts

n+ut

*escri+tion

Class

#he identifier assigned to the Control and Information Protocol Class)

Instance

#he value of the Instance being referenced) Note& #he Instance should be eual to 2 if changing an Attribute of the Class)

Attribute

#he identifier of the Attribute being modified)

;alue

#he value to assign to the Attribute)

Su%%orted Parameters&

Class

Instance

Attribute

;alue

4escri%tion

?

2

08

2Q#ransitionto#imedut

6atchdogGtimeoutGaction&

0 Q Auto 4elete

4efines the class 3atchdog timeout action for all ne! connections)

 denotes default value SetIPSingleAttribute ut%uts

/eturns


1


0


!


!2


SetIPSingleAttribute xam%le #o configure the IP I7 3atchdog #imeout Action to Auto 4elete* issue the follo!ing command&E( SetEPSingleAttribute=F0F1F1?


8>7?7820=


Page 000 of 01=


Setxternal$ightMode


S%ecifies the ty%e of external strobe device connected to the In-Sight =222 series vision system)

Syntax: ." Set.xte+nalLi!ht/%)e3-ut'ut/%)e4

Setxternal$ightMode In%uts *escri+tion

Input 0 Q 4isabled )ut+utMode 1 Q PNP +Sourcing,  Q NPN +Sin(ing,

0 Q Settings are not saved in the %roc)set file the settings do not %ersist if the In-Sight vision system is %o!er cycled)

3riteProcSet 1 Q Settings are saved in the %roc)set file the set tings %ersist after the In-Sight vision system is %o!er cycled)

4enotes default value)

Setxternal$ightMode ut%uts

/eturns


1


0


!


!2


SetExternal-ightMode Exam+le #o s%ecify that an NPN +sin(ing, external strobe device is connected to the vision system and to save the setting to the %roc)set file* issue the follo!ing command& E( SetExternal-ightMode=F1?


8>7?7820=


Page 008 of 01=

#he vision system res%onds !ith a status code +1,* indicating the command !as successfully executed* follo!ed by the number of characters* in bytes +1,) /inally* the float value +0, is returned)

Set/avorDost#able


nables or disables the Favor Host Table over DNS o%tion found in the In-Sight Dost #able)

Syntax: ." SetFa,%+(%stTa$le3Fa,%+(%stTa$le4

Note& "se the Store Settings +#S, native mode command to save changes to the %roc)set file) If not saved to the %roc)set file* the changes !ill be lost after %o!er-cycling the In-Sight vision system)

Set/avorDost#able In%uts

n+ut

*escri+tion

/avorDost#able

0  4isabled 1  nabled

 denotes default value Set/avorDost#able ut%uts

/eturns


1


0


!


!2


Set/avorDost#able xam%le

#o enable the /avor Dost #able over 4NS o%tion* issue the follo!ing command& E( Set%avor;ost#able=1?


8>7?7820=


Page 001 of 01=

After issuing the Set/avorDost#able command* the In-Sight sensor res%onds !ith a status c ode 1 + ,* follo!ed by the number of characters* in bytes +1,) /inally* the results in M$ format)

Set/#PSettings


Configures settings that are found in the/#P Settings dialog)

Syntax: ." SetFT0Settin!s 3I)leTime%ut5Rea)Time%ut5C%nnecti%nRet+y5L%cal0%+t5Rem%te0%+t50assi,e4


Set/#PSettings In%uts

n+ut

*escri+tion =0 to 10000? * 082

Idle#imeout

=0 to 10000? * 082

Read#imeout

=1 to 10? * 0

ConnectionRetry

=1 to 2?* 80

$ocalPort

=1 to 2?* 80

RemotePort

Passive

0  4isabledK 1  nabled



8>7?7820=


Page 00> of 01=

Set/#PSettings ut%uts

/eturns


1


0


!


!2


Set/#PSettings xam%le

#o configure the follo!ing settings& dle#imeout& 0J2 /ead#imeout& 0J2 Connection/etry& 0 -ocalPort& 80 /emotePort& 80 Passive& 2

Issue the follo!ing command& E( S et%#PSettings=10F10F1F1F1F0?


SetDost#able


Configures settings that are found in theIn-Sight Dost #able dialog)


8>7?7820=


Page 00? of 01=

Syntax: ." Set(%stTa$le3(%stID5#Name#5#I0*))+ess#4


SetDost#able In%uts

n+ut

DostI4

*escri+tion =0 to 1? /irst Dost Name in table Q 2* Second Dost Name in table Q 0* ))) seuentially u% to 10)

#he In-Sight sensor host name) 5Name5 #he In-Sight sensor IP address) 5IPAddress5

SetDost#able ut%uts

/eturns


1


0


!


!2


SetDost#able xam%les

xam%le 0& Add a Dost #able ntry xam%le 8& dit a Dost #able ntry

Exam+le 18 Add a ;ost #able Entry #o add a sensor !ith the host name of 5PR4"C#IN05 and the IP Address of 508)0,12,1,1?

#o add a sensor !ith the host name of 5PR4"C#IN85 and the IP Address of 508)0,12,1,?)


8>7?7820=


Page 00< of 01=

Exam+le 8 Edit a ;ost #able Entry #o edit the IP address of the second Dost #able entry* issue the follo!ing command& E( Set;ost#able=1FP/)*"C#)NF1>,12,1,?

SetNet!or( xtended Native Mode Commands - valuate In-Sight Communications Reference

Configures settings that are found in the Net!or( Settings dialog)

Syntax: ." SetNet&%+k 31seD(C05#(%stName#5#I0*))+ess#5#Su$net/ask#5#De6aultGate&ay#5#DNSSe+,e+#5#D%mainName#4


SetNet!or( In%uts

In%ut

4escri%tion

"se4DCP

0 Q 4isabled 1 Q nabled

#he In-Sight sensor host name) 5DostName5 #he In-Sight sensor IP address) 5IPAddress5 #he In-Sight sensor subnet mas() 5SubnetMas(5 #he In-Sight sensor default gate!ay) 54efault:ate!ay5


8>7?7820=


Page 00= of 01=

#he IP address of the gate!ay host) 54NSServer5 #he net!or( domain for the In-Sight sensor) 54omainName5

Note& #he !#0ddress* Subnet/as'* De+aultatea"* DNSServer* and DomainName %arameters modify the static fields* not the current fields* as sho!n in the returns from the:etNet!or( command)

SetNet!or( ut%uts

/eturns


1


0


!


!2


SetNet!or( xam%le

#o configure the follo!ing settings& "se*;CP& 2 ;ostName& is?022O202821 PAddress& 08)0 *NSServer& 08)0
Issue the follo!ing command& E( SetNetwor5 =0Fis100G0100F1>,12,0,1F,,,0F1>,12,0,@F1>,12,0,Fyourdomain,com?



8>7?7820=


Page 00J of 01=

SetSerialPort


Configures settings that are found in theSerial Port Settings dialog)

Syntax: ." SetSe+ial0%+t 3Se+ial0%+tNum5/%)e5au)Rate5Dataits5St%'its50a+ity5(an)shake5In'ut0acketSize5-ut'ut0acketSize5 In'utTe+minat%+5-ut'utTe+minat%+5Fixe)In'ut/%)e5Fixe)In'utLen!th5De,iceNetT+i!!e+4

Notes&

' #he In-Sight system must be ffline) ' 4eviceNet is only available on In-Sight vision systems using In-Sight firm!are >)x)x* and is not available on In-Sight vision systems running In-Sight firm!are ?)0)2 and later) Refer to /irm!are ;ersions for a com%lete list of models and su%%orted firm!are versions) ' In-Sight Micro 0222 series vision systems only su%%ort serial communication !hen connected to the CI-MICR or CI-MICR-CC I7 module) ' #here are t!o o%tions for enabling serial communication for the In-Sight =222 series vision system& using the Brea(out cable or using the CI-MICR or CI-MICR-CC I7 module) 3hen connected to the Brea(out cable +and there is no connection to an I7 module,* the vision system allo!s one discrete in%ut line and one discrete out%ut line to be configured asSerial -eceive and Serial Transmit* res%ectively) Refer to Do! to nable Serial Communication for the In-Sight =222 ;ision Systemfor more information) ' In-Sight J222 series vision systems only su%%ort serial communication !hen connected to the CI-MICR I7 module) ' #he CI-3N# thernet I7 module does not su%%ort serial communication) ' "se the Store Settings +#S, native mode command to save changes to the %roc)set file) If not saved to t he %roc)set file* the changes !ill be lost after %o!er-cycling the In-Sight vision system) SetSerialPort In%uts n+ut SerialPortNum

Mode

*escri+tion 1 1 Q "nused +Closed, 2 Q #ext 3 Q Native  Q 4eviceNet > Q Motoman 10 Q Tu(a

BaudRate 100 @00 @00 >200 1>00 @00 3200 1100K

4ataBits

@ Q = 4ata Bits  Q J 4ata Bits

Sto%Bits

1 Q 0 Sto% Bit @ Q 8 Sto% Bits

Parity

2 Q None 1 Q dd 10@ Q ven 0 Q None 1 Q Dard!are

Dandsha(e


8>7?7820=


n+ut

Page 00 of 01=

*escri+tion  Q on7off =1 to ? * 0

In%utPac(etSi6e +4eviceNet nly, ut%utPac(etSi6e +4eviceNet nly, In%ut#erminator +#ext and Native nly, ut%ut#erminator +#ext and Native nly,

=1 to ? * 0 =1 to ? * 01 !1 Q CR$/ 0 Q No terminator =1 to ? * 01 0 Q 4isabled 1 Q nabled =1 to ? * 0

/ixedIn%utMode +#ext and Native nly, /ixedIn%ut$ength +#ext and Native nly, 4eviceNet#rigger +4eviceNet nly,  denotes default value

0 Q 4isabled 1 Q nabled

SetSerialPort ut%uts

/eturns


1


0


!


!2


SetSerialPort xam%le

#o configure the follo!ing settings& SerialPortNum& 0 Mode& = BaudRate& 00?822 4ataBits& J Sto%Bits& 0 Parity& 8?< Dandsha(e& 2 In%utPac(etSi6e& 2 ut%utPac(etSi6e& 2 In%ut#erminator& 01 ut%ut#erminator& 01 /ixedIn%utMode& 2 /ixedIn%ut$ength& 2 4eviceNet#rigger& 0

Issue the follo!ing command& E( SetSerialPort=1F3F1100FF1F2F0F0F0F1F1F0F0F1?


8>7?7820=


Page 082 of 01=

#he In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +1,) /inally* the results are returned in M$ format)

SetStartu%


Configures settings that are found in theStartu% dialog)

Syntax: ." SetSta+tu'3#J%$Name#5-nline4


SetStartu% In%uts

n+ut

*escri+tion

#he name of Hob to load automatically on startu%) 5obName5

nline

0 Q Start ffline 1 Q Start nline

 denotes default value SetStartu% ut%uts

/eturns


1


0


!


!2


SetStartu% xam%le

#o configure the sensor load the Hob 5Sorting,.ob5 on startu% and boot into nline mode* issue the follo!ing command&E( SetStartu+ =Sorting,.obF1?


8>7?7820=


Page 080 of 01=


SetSystemConfig


#hese %arameters are used i n conHunction !ith the SetSystemConfig valuate Native Mode command to configure system %arameters) Note& Any in%uts enclosed in uotation mar(s must be enclosed by uotes !hen sent to the In-Sight vision system)

' ' ' ' ' ' ' ' ' ' ' ' ' ' '

Active Cells $imit 4DCP #imeout #elnet Port Net!or( Reuested $in( Mode $ive Image nline Image Services nabled Audit nable Settings Audit IP Settings #rigger #imestam% Increase Image Buffers AdHust xtractBlobs Memory Allocation 4efault /ocus Position Start Strobe Position PulseobChange#iming

Active Cells -imit Configures the number of available s%readsheet cells settings that are found in theActive Cells $imit dialog)

Syntax: ." SetSystemC%n6i!3#*cti,eCellLimit#5Limit5W+ite0+%cSet4

n+uts n+ut

*escri+tion

5ActiveCell$imit5Refe rences the Active Cells $imit dialog settings)

#he active cell limit* in units of cells) =0@ to 10@00? * <0>> $imit Note& #he active cell limit for the In-Sight ?222 vision system is >*2< cells and cannot be modified)



8>7?7820=


n+ut

Page 088 of 01=

*escri+tion

3riteProcSet

0 Q Settings are not saved in the %roc)set file the settings do not %ersist if the In-Sight vision system is %o!er cycled) 1 Q Settings are saved in the %roc)set file the settings %ersist aft er the In-Sight vision system is %o!er cycled)


)ut+uts /eturns

A status code* follo!ed by the number of characters +in bytes, f or the results* then the results inM$ format)

1 #he command !as executed successfully)

0 "nrecogni6ed command)

! #he command could not be executed)

!2 "ser does not have /ull Access to execute the command)

Exam+le #o s%ecify an active cell limit of J*08* issue the follo!ing command&E( SetSystemConF1?

#he In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +0,) /inally* a result code is returned that either contains a 1* indicating that the limit !as set* or a0* indicating the limit !as not set) #he In-Sight vision system must be %o!er cycled for the changes to ta(e effect)

*;CP #imeout Configures the 4DCP #imeout settings that are found in theNet!or( Settings dialog)

Syntax: ." SetSystemC%n6i!3#D(C0Time%ut#5Time%ut5W+ite0+%cSet4

n+uts n+ut

*escri+tion

54DCP#imeout5

References the 4DCP #imeout settings)

#imeout

= to 10?* <2



8>7?7820=


n+ut

Page 081 of 01=

*escri+tion


3riteProcSet 1 Q Settings are saved in the %roc)set file the settings %ersist after the In-Sight vision system is %o!er cycled)


)ut+uts /eturns






Exam+le #o s%ecify a 4DCP #imeout of 12 seconds* issue the follo!ing command& E( SetSystemCon
#he In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +1,) /inally* the 4DCP #imeout setting +0, is returned)

#elnet Port Configures the #elnet Port settings that are found in theNet!or( Settings dialog)

Syntax: ." SetSystemC%n6i!3#Telnet0%+t#50%+t5W+ite0+%cSet4

n+uts n+ut

*escri+tion

5#elnetPort5

References the #elnet Port Settings)

Port

=1 to 2?* 81



8>7?7820=


n+ut

Page 08> of 01=

*escri+tion

3riteProcSet

1 Q Settings are saved in the %roc)set file the settings %ersist after the In-Sight vision system is %o!er cycled)


Notes&

' A valid %ort assignment is any unused number bet!een 0 and >J0J and ?2222 +reserved for In-Sight communications,) ' #he vision system must be rebooted before the #elnet Port settings ta(e effect)

)ut+uts /eturns






Exam+le #o s%ecify a #elnet Port of 8222* issue the follo!ing command& E( SetSystemCon
#he In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +1,) /inally* the #elnet Port setting +000, is returned)

Networ5 /euested -in5 Mode Configures the $in( S%eed setting found in the Net!or( Settings dialog) After the command is issued* the vision system must be rebooted for the changes to ta(e effect) 6arning& If the net!or( device is not configured to su%%ort the s%ecified lin( s%eed* the vision system !ill not be r eachable configure the net!or( deviceGs thernet settings to match that of the vision system)

Syntax: ." SetSystemC%n6i!3#Net&%+k7Re8ueste)Link/%)e#5LinkS'ee)5W+ite0+%cSet4

n+uts


8>7?7820=


n+ut

Page 08? of 01=

*escri+tion

5Net!or()Reuested$in(Mode5 References the in' Speed Settings)

0 Q Auto-Negotiate 100 Q 02 Mb%s Dalf 4u%lex 101 Q 02 Mb%s /ull 4u%lex

$in(S%eed 10 Q 022 Mb%s Dalf 4u%lex 10 Q 022 Mb%s /ull 4u%lex 10@ Q 0222 Mb%s /ull 4u%lex

3riteProcSet

1 Q Settings are saved in the %roc)set file the settings %ersist after the In-Sight vision system is %o!er cycled)


Notes&

' #he 1000 Mb+s %ull *u+lex o%tion is only available for vision systems that su%%ort 0222 Mb%s thernet s%eeds) /or In-Sight ?<22 series vision systems* it is only available on models !ith 08JMB non-volatile flash memory or higher) ' "se the :etSystemConfig command to determine the lin( s%eeds and du%lex modes su%%orted by the vision system)

)ut+uts /eturns






Exam+le #o configure the vision system to use 022 Mb%s /ull 4u%lex* issue the follo!ing command& E( SetSystemCon
#he In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +0,) /inally* the current lin( s%eed +10, is returned)


8>7?7820=


Page 08< of 01=

-ive mage Configures the $ive Acuisition settings that are found in theImage Settings dialog)

Syntax: ." SetSystemC%n6i!3#Li,eIma!e#5Res%luti%n5/axF+ameRate4

n+uts n+ut

5$iveImage5

*escri+tion

References the $iveImage settings)

1 Q /ull

Resolution

0 or  Q Dalf  Q Uuarter

Max/rameRate

=0,012 to 100? * 2


)ut+uts /eturns






Exam+le #o configure the vision system to use half resolution for live images !ith a maximum rate of 2)2<> frames7sec* issue the f ollo!ing command&E( SetSystemCon
#he In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +1,) /inally* the $ive Acuisition settings +1 0,02@, are returned)


8>7?7820=


Page 08= of 01=

)nline mage Configures the nline Resolution settings that are found in theImage Settings dialog)

Syntax: ." SetSystemC%n6i!3#-nlineIma!e#5Res%luti%n5/axF+ameRate4

n+uts n+ut

5nlineImage5

*escri+tion

References the nlineImage settings)

0 Q %timi6ed 1 Q /ull

Resolution  Q Dalf  Q Uuarter

Max/rameRate

=0,012 to 100? * 2


)ut+uts /eturns






Exam+le #o configure the vision system to use half resolution for nline images !ith a maximum rate of 2)2<> frames7sec* issue the follo!ing command& E( SetSystemCon
#he In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +1,) /inally* the $ive Acuisition settings + 0,02@, are returned)


8>7?7820=


Page 08J of 01=

Services Enabled Configures the Protocol Services settings that are found in the Net!or( Settings dialog) Note& #he therNet7IP and ProfiN# services are mutually exclusive* therefore both services cannot be enabled at the same time)

Syntax: ." SetSystemC%n6i!3#Se+,ices.na$le)#5Se+,ices5/ask4

n+uts

n+ut

*escri+tion

ServicesEnabled References the #rotocolServices settings) Services

S%ecifies all services to be enabled on the vision system) #he Services %arameter is a binary value that is converted into its decimal euivalent)

Service

Binary

*ecimal Euivalent

ProfiN#

022

>

therNet7IP

202

8

Modbus Server

220

None

0

222

2

#o enable more than one service* determine the binary value for the enabled services * then convert the value to its decimal euivalent) Exam+le

Mas5

S%ecifies the services to be modified on the vision system) #he Mas( %arameter is a binary value that i s converted into its decimal euivalent)

Service

Binary*e cimal Euivalent

ProfiN#

022

>

therNet7IP

202

8

ModbusS erver2 20

0

None

2

222

#o modify more than one service* determine the binary value for the services to be modified* then convert the value to its decimal euivalent) Exam+le  denotes default value

)ut+uts /eturns




8>7?7820=


Page 08 of 01=




Exam+les #o Enable and Modi
If no services are currently enabled* and you !ant to enable the ProfiN# service) Issue the follo!ing command&E( SetSystemCon
#he In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +0,) /inally* the enabled service+s, +@, are returned)

*isable All Services

Since !e !ant all services to be disabled* !e (no! that the Service %arameter is0) 0) 4etermine the binary value used to modify the services)

Service Pro
Binary 0

0

0

8) Convert the binary value to its decimal euivalent) #his gives you the Mas( %arameter value 111  3

1) Issue the follo!ing command& E( SetSystemCon
#he In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +0,) /inally* the enabled service+s, +0, are returned)

Audit Enable Settings nables or disables automatic audit messages for the active vision system and s%ecifies the ty%es of events for !hich audit messages !ill be generated)


8>7?7820=


Page 012 of 01=

Syntax: ." SetSystemC%n6i! 3#*u)it.na$leSettin!s#5.na$le)5System.,ents5Ta!!e)Cells5SystemSettin!s5W+ite0+%cSet4

n+uts n+ut

*escri+tion

5AuditnableSettings5 References the Audit nable Settings)

0 Q 4isable automatic audit messages for the active vision system)

nabled

1 Q nable automatic audit messages for the active vision system)

0 Q 4isable)

Systemvents

1 Q If an In-Sight system event occurs +logging on or off of a vision system* loading or saving a Hob file* tr ansitioning from nline to ffline mode* system startu% and firm!are u%dates,* an audit message is generated) 0 Q 4isable)

#aggedCells

1 Q If a symbolically tagged cell is edited +e)g)* changes are made to the cellGs formula or interactive control value, using InSight x%lorer* a custom a%%lication* ;ision;ie! or a P$C* an audit message is generated) 0 Q 4isable)

SystemSettings

1 Q If a system setting +any setting stored in the %roc)set file, is modified* an audit message is generated)




)ut+uts /eturns


1 #he command was executed success
0 "nrecogni4ed command,

! #he command could not be executed,

!2 "ser does not have %ull Access to execute the command,

Exam+le #o enable audit messages for the active vision system) generate audit messages !hen system settings are changed and save the settings to the %roc)set file* issue the follo!ing command& E( SetSystemCon

8>7?7820=


Page 010 of 01=

#he In-Sight vision system res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +0,) /inally* the results are returned in M$ format)

Audit P Settings S%ecifies the IP address and #CP7IP %ort of the audit message server)

Syntax: ." SetSystemC%n6i!3#*u)itI0Settin!s#5#I0*))+ess#50%+t5W+ite0+%cSet4

n+uts n+ut

*escri+tion

5AuditIPSettings5Refe rences the Audit IP Settings)

5IPAddress5

S%ecifies the IP ad dress of th e audit message server) S%ecifies the #CP7IP %ort of the audit message server) +default Q ?=?1,

Port

Note& A valid %ort assignment is any unused number bet!een 0 and



)ut+uts /eturns






Exam+le #o s%ecify the IP address and #CP7IP %ort of the audit message server and save the settings to the %roc)set file* issue the follo!ing command&E( SetSystemCon,12,0,1F3F1?


8>7?7820=


Page 018 of 01=


#rigger #imestam+ If an In-Sight vision system has been configured to communicate over CIP- Sync and the Precision #ime Protocol +P#P,* the SetSystemConfig command is used to set the system configuration variable* 5IP)#rigger#imestam%In%utffset5* to the offset in the user data field* !here the timestam% !ill be !ritten from the P$C)

Syntax: ." SetSystemC%n6i!3#.i'7T+i!!e+Timestam'In'ut-66set#5-66set4

n+uts n+ut

*escri+tion

Sets the offset into the therNet7IP in%ut assembly* to ca%ture the <>-bit timestam% in microseconds* follo!ed 5i%)#rigger#imestam%In%utffset5by a <>-bit system time offset in microseconds +for a total of 0< bytes,* !hich is used to trigger the vision system)

ffset

S%ecifies the offset* 2 to ?22 to disable this setting* set the variable to -0)

)ut+uts /eturns






ncrease mage Bu<
Syntax: ." SetSystemC%n6i!3#Sta+tu'Ima!eu66e+s#5Num$e+%6u66e+s5W+ite0+%cSet4


8>7?7820=


Page 011 of 01=

n+uts n+ut

*escri+tion

5Startu%ImageBuffers5 Sets the number of image buffers that !ill be allocated to t he vision system at startu%)

S%ecifies the number of buffers that !ill be allocated to the vision system) NumberofBuffers Note& If NumberofBuffers is set to 2* the de fault number of buffers !ill be used)





/eturns





Ad.ust ExtractBlobs Memory Allocation Allo!s the memory allocation for thextractBlobs function to be set manually) 3hen using this setting* the value s%ecified should be no more than half the number of %ixels in the xtractBlobs functionGs region of interest +RI,) 6arning& #his setting should only be a%%lied if an xtractBlobs function is returning RR due to a lac( of memory) 3hen assigning the amount of memory to the function* be conservative) ver allocating memory to the xtractBlobs function may cause memory %roblems for the entire InSight vision system)

Syntax: ." SetSystemC%n6i!3#.xt+actl%$s/em%+y#5k4

n+uts n+ut

*escri+tion

5xtractBlobsMemory5Sets the amount of memory that !ill be allocated to the vision system at startu% for the xtractBlobs function)

(

S%ecifies the amount of memory that !ill be allocated to the vision system for the xtractBlobs function the value of V(W de%ends u%on the si6e of the RI being used* as !ell as the uality of the image) Begin !ith a smaller value* and then increment above that value) /or exam%le* !ith a RI Q <>2 x >J2 and a s%ec(led image* begin !ith a value of J*222 and increment the value by 0*222 !ith a RI Q 0<22 x 0822* begin !ith a value of 18*222 and increment the value by 0*222 or !ith a RI Q 8>>J x 82>J* begin !ith a value of 08J*222 and increment the value by 0*222) Note& #o restore the default memory allocation for xtractBlobs* enter 2)

)ut+uts /eturns



8>7?7820=


Page 01> of 01=





*e
Syntax: ." SetSystemC%n6i!3#De6aultF%cus0%siti%n#50%siti%n5*''ly5W+ite0+%cSet4

Note& #he 4efault/ocusPosition function is used to save a focus %osition value only* and does not move the lens)

n+uts n+ut

*escri+tion

54efault/ocusPosition5Sets the default focus %osition that the vision system !ill use at startu%)

Position

S%ecifies the default focus %osition* 2 to 022 to disable this setting* set the variable to -0)

0 Q Settings are a%%lied after the In-Sight vision system is %o!er cycled)

A%%ly 1 Q Settings are a%%lied immediately)




)ut+uts /eturns



0 "nrecogni6ed command) ! #he command could not be executed)


Strobe Start Position Configures the Strobe Start Position setting that are found in theut%ut 4etails dialog)


8>7?7820=


Page 01? of 01=

Syntax: ." SetSystemC%n6i!3#St+%$eSta+t0%siti%n#50%siti%n5W+ite0+%cSet4

Note& #o configure the Str obe7$ight Control #rigger setting* use theSet4iscreteut%ut native mode command +refer to the xam%le 8,)

n+uts n+ut

*escri+tion

5StrobeStartPosition5S%ecifies ! hen the strobe should begin) 0 Q Acuisition Start) #he strobe !ill %ulse as the In-Sight vision system begins its acuisition) Su%%orted on all vision

system models exce%t the In-Sight J>2? vision system) 1 Q Camera #rigger) #he strobe !ill %ulse u%on receiving a camera trigger event) Su%%orted on all vision system models exce%t the In-Sight J>2? vision system) Position

 Q All Ro!s x%osed) #he strobe !ill %ulse only !hen all %ixel ro!s are ex%osed) Su%%orted on the In-Sight J>2? vision system only) Note& If using a strobe !ith the In-Sight J>2? vision system* a minimumx%osure of =8ms is recommended for a full frame image ca%ture* to ensure that all %ixel ro!s are ex%osed !hen the strobe is %ulsed) Refer toRolling Shutter %eration for more information)




)ut+uts /eturns






Exam+le #o s%ecify that the strobe !ill begin as the I n-Sight vision system begins its acuisition* issue the follo!ing command&E( SetSystemCon


8>7?7820=


Page 01< of 01=

Pulse'obChange#iming S%ecifies the !idths of the in%ut %ulses for changing the Hob on the In-Sight 8222 series sensor via discrete in%ut line 2* !hen configured as a9ob %hange :#ulsed; signal ty%e) #he Hob change is initiated based on the detection of in%ut %ulses* differentiated by the !idth of the %ulses) #he %ulses are generated by an external device +such as a P$C,* and sent to the In-Sight 8222 sensor) /irst* the external device issues a start %ulse) Next* the external device issues count %ulses* !ith a %ulse ga% bet!een each count %ulse) /inally* the external devices issues a sto% %ulse) 3hen all %ulses and %ulse ga%s match the s%ecified %ulse lengths* the Hob change reuest is successful and the Hob is loaded to the sensor) If any of the conditions fail +i)e)* an incorrect %ulse or incorrect %ulse ga% timing,* the Hob change reuest !ill fail and no Hob change !ill ta(e %lace)

Syntax: ." SetSystemC%n6i! 3#0ulseJ%$Chan!eTimin!#5Sta+t0ulse5St%'0ulse5C%unt0ulse50ulseGa'5T%le+ance5W+ite0+%cSet4

n+uts n+ut

*escri+tion

5PulseobChange#iming5 S%ecifies the 9ob %hange :#ulsed; timing) S%ecifies the !idth of the start %ulse) StartPulse3idth 0ms - 88222ms =de
S%ecifies the !idth of the sto% %ulse) Sto%Pulse3idth 0ms - 88222ms =de
S%ecifies the !idth of the count %ulse+s,) CountPulse3idth 0ms - 88222ms =de
S%ecifies the !idth of the %ulse ga%) Pulse:a%3idth 0ms - 88222ms =de
S%ecifies the %ulse !idth tolerance) #olerance F2ms

0 Q Settings are not saved in the %roc)set file the settings do not %ersist if the In-Sight sensor is %o!er cycled)

3riteProcSet 1 Q Settings are saved in the %roc)set file t he settings %ersist after the In-Sight sensor is %o!er cycled)

 denotes default value Note& Issuing E( SetSystemCon
)ut+uts /eturns







8>7?7820=


Page 01= of 01=

Exam+les S+eci
#o s%ecify the %ulse Hob change timing and save the settings to the %roc)set file* issue the follo!ing command& E( SetSystemCon
#he In-Sight sensor res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +0,) /inally* the results are returned in  M$ format)

/etrieve Current Pulse 6idth (alues

#o retrieve the current %ulse !idth values* issue the follo!ing command&E( S etSystemCon
#he In-Sight sensor res%onds !ith a status code +1,* follo!ed by the number of characters* in bytes +@,) /inally* the results are returned in  M$ format)


8>7?7820=

Native Mode Commands

Recommend Documents