Skip headerBackNext
User's Manual
 Environment Setting Part > Chapter 10 - How To Connect & Communicate With External Devices > Serial Interface > Instruction List (Serial Interface)

Instruction List (Serial Interface)

This section explains input format of each command used in the Serial Normal method.
Commands can be input in ASCII code, case-insensitive.
Table: Command List
Command
Abbreviation
Function
Please see
CLRMEAS
No
Empties all the Value of the current scenes
BKDLOAD
No
Loads System + Scene group 0 data
BKDSAVE
No
Saves System + Scene Group 0 data in a file
DATASAVE
No
Saves System + Scene group data in the controller's memory
DATE
No
Sets up/obtain the current date/time
DISPCOND
No
Acquires current view state of images
Changes the view state of images
IMGSAVE
No
Saves the image data
MEASURE
M
Performs 1 measurement
RESET
No
Restarts the controller
SCENE
S
Acquires in-use Scene No.
Scene Switch No.
SCNGROUP
SG
Acquires in-use scene group No.
Switch scene group No.
SCNLOAD
No
Loads the Scene data
SCNSAVE
No
Saves the Scene data
SCRSWITCH
No
Switches ADJUST window/RUN window
SGRLOAD
No
Loads the scene group data
SGRSAVE
No
Saves the scene group data
SYSDATA
No
Gets current system data
Sets system data
SYSLOAD
No
Loads system data
SYSSAVE
No
Saves system data
UNITDATA
UD
Gets the parameters and/or measurement values of specified processing unit
Sets the parameters of specified processing unit
VERGET
No
Acquires system version information

CLRMEAS -CLeaR MEASurement value-

Function ... Empties all the Value of the scenes that are being used.
 Command 
CLRMEAS  delimiter 
 Response 
Performed correctly
:OK  delimiter 
Failure to perform
:ER  delimiter 
The values after emptying are as follows.
Table: View State of Screens
Item
Description
Judgement result
Unmeasured (0)
Value
0
Character string
Text

BKDLOAD

Function ... Loads System + Scene group 0 data
 Command 
BKDLOAD <File name of System + Scene group data> delimiter 
Specifies <System + Scene group data file name> using an absolute path like \USBDisk\abc.bkd.
 Response 
When executed properly: OK  delimiter 
When not executed properly: ER  delimiter 
Note
  • The following cases result in failure.
    • When a file with a different extension (other than "***.BKD") is specified:
    • When a file that does not exist is specified.
  • Do not turn off the power of the controller until a response is returned.
(Example)
 Command 
:
BKDLOAD \USBDisk2\IMG01\LABEL1.BKD  delimiter 
Loads "LABEL.KBD" in the "IMG01" folder of the USB memory drive labeled "USBDisk2" onto the controller.
 Response 
:
OK  delimiter 

BKDSAVE

Function ... Saves in a file the System + Scene Group 0 data, which is currently used in the controller
 Command 
BKDSAVE <File name of System + Scene group data> delimiter 
Specifies <System + Scene group data file name> using an absolute path like \USBDisk\abc.bkd.
 Response 
When executed properly: OK  delimiter 
When not executed properly: ER  delimiter 
Note
  • The following cases result in failure.
    • When a file with a different extension (other than "***.BKD") is specified:
  • Do not turn off the power of the controller until a response is returned.
(Example)
 Command 
:
BKDSAVE \USBDisk2\IMG01\LABEL1.BKD  delimiter 
Saves the currently used System + Scene Group 0 data to a file named "LABEL1.BKD" in the "IMG01" folder of the USB memory drive "USBDisk2".
 Response 
:
OK  delimiter 

DATASAVE

Function ... Saves system data and scene group data on the controller's flash memory
 Command 
DATASAVE delimiter 
Saves system data and scene group data on the controller's flash memory.
 Response 
Performed correctly
:OK  delimiter 
Failure to perform
:ER  delimiter 
Note
  • When using Scene Group 1 to 31, if you execute DATASAVE command, system data is saved on the controller's flash memory and scene group data is saved to the USB memory. If a USB memory device is not plugged in, ER is returned.
  • Do not turn off the power of the controller until a response is returned.
(Example)
 Command 
:
DATASAVE  delimiter 
Saves a System + Scene group data of System + Scene group No. 3 with the file name "LABEL1.BKD" in the "IMG01" folder of the USB memory drive labeled "USBDisk2".
 Response 
:
OK  delimiter 

DATE

Function 1 ... Obtains the current date/time
 Command 
DATE delimiter 
 Response 
Performed correctly
:Year/month/day/hour/minute/second  delimiter 

OK  delimiter 
Failure to perform
:ER  delimiter 
(Example)
 Command 
:
DATE  delimiter 
 Response 
:
20070830123000
OK  delimiter 
30.08.07/12h/30min/00s
Function 2 ... Sets the date/time
 Command 
<Western calendar 4 digits> <month 2 digits><day 2 digits><hour 2 digits> <minute 2 digits><second 2 digits>  delimiter 
 Response 
Performed correctly
:OK  delimiter 
Failure to perform
:ER  delimiter 
Note
  • The <hour 2 digits><minute 2 digits><second 2 digits> can be omitted when setting up. They can not be updated when being omitted and the previous time will be kept unchanged.
    The available omitting options include "omitting <second> only", "omitting <hour><minute><second>," cannot "omit <hour> only" and "omit <minute> only."
(Example)
 Command 
:
DATE 20070830123000  delimiter 
Set to 8/30/2007 12:30:00 am.
 Response 
:
OK  delimiter 

DISPCOND - DISPlay CONDition -

Function 1 ... Acquires current view state of images
 Command 
DISPCOND delimiter 
 Response 
Performed correctly
:View state  delimiter 
:OK  delimiter 
Failure to perform
:ER  delimiter 
View state is shown below.
Table: View State of Screens
View State
Description
0
Image mode is "Through".
1
Image mode is either "Freeze" or mixture of "Freeze" and "Last NG".
2
Image modes of all the windows are "Last NG".
(Example)
 Command 
:
DISPCOND  delimiter 
 Response 
:
0
OK  delimiter 
Current images are shown with full state.
Function 2 ... Changes the view state of images
 Command 
DISPCOND <view image model No> delimiter 
Select 0 to 2 from the Image Mode Number.
  • 0: Changes the image modes of all the windows to "Through"
  • 1: Changes the image modes of all the windows to "Freeze"
  • 2: Changes the image modes of all the windows to "Last NG"
 Response 
Performed correctly
:OK  delimiter 
Failure to perform
:ER  delimiter 
(Example)
 Command 
:
DISPCOND 2  delimiter 
Viewed images are changed to Last NG images.
 Response 
:
OK  delimiter 

IMGSAVE - IMaGe SAVE -

Function ... Saves image data into the external devices
 Command 
IMGSAVE <Image Data Number> <Save to Destination Address> delimiter 
For <Image data No.>, specify 0 to I_MAX. For I_MAX, see Number of Logged Images.
Select the following from the <Save to Destination Address>
  • \USBDisk\...
    When the destination folder is in the USB memory, it will be Saved to the USB memory. The file extension is "***.IFZ".
 Response 
Executed correctly
:OK  delimiter 
Executed correctly
:ER  delimiter 
Note
  • Cannot be executed correctly in case of the following.
    • When an extension other than "ifz" is specified for the name of the file to be saved
    • When a non-existing folder is selected in the destination address
  • In the case the specified file name has existed, the existing file will be overwritten
  • Do not cut off power of controller before the response.
(Example)
 Command 
:
IMGSAVE 3 \USBDisk2\IMG01\LABEL1.IFZ  delimiter 
The image data of the No.3 image, namely the "LABEL1.IFZ" file, will be Saved into the "IMG01" folder in the USB memory of the "USBDisk2" drive.
 Response 
:
OK  delimiter 

MEASURE or M

Function 1 ... Performs a measurement
 Command 
MEASURE delimiter 
Performed correctly
:OK  delimiter 
:Measurement Result
Failure to perform
:ER  delimiter 
Function 2 ... Starts continuous measurement
 Command 
MEASURE /C delimiter 
When executed properly
:OK  delimiter 
:Measurement result
:Measurement result
:Measurement result
When not executed properly
:ER  delimiter 
Function 3 ... Stops continuous measurement
 Command 
MEASURE /E delimiter 
When executed properly
:OK  delimiter 
When not executed properly
:ER  delimiter 
:Measurement result
:Measurement result
(Measurement continues.)
Note

RESET

Function ... Restarts the controller
 Command 
RESET delimiter 
 Response 
No

SCENE or S

Function 1 ... Acquires in-use Scene No.
 Command 
SCENE delimiter 
 Response 
Performed correctly
:Scene No.  delimiter 
:OK  delimiter 
Failure to perform
:ER  delimiter 
(Example)
 Command 
:
SCENE  delimiter 
 Response 
:
0
OK  delimiter 
Scene 0 is being used
Function 2 ... Scene Switch No.
 Command 
SCENE <Scene No.> delimiter 
Point at the code number 0 to 31.
 Response 
Performed correctly
:OK  delimiter 
Failure to perform
:ER  delimiter 
(Example)
 Command 
:
SCENE 2  delimiter 
Switches to scene 2
 Response 
:
OK  delimiter 

SCNGROUP or SG - SceNe GROUP -

Function 1 ... Acquires in-use scene group No.
 Command 
SCNGROUP delimiter 
 Response 
Performed correctly
:scene group No.  delimiter 
:OK  delimiter 
Failure to perform
:ER  delimiter 
(Example)
 Command 
:
SCNGROUP  delimiter 
 Response 
:
0
OK  delimiter 
Scene Group 0 is being used.
Function 2 ... Switches the scene group number
 Command 
SCNGROUP <scene group No.> delimiter 
Scene group No. shall be set within 0 to 31.
 Response 
Performed correctly
:OK  delimiter 
Failure to perform
:ER  delimiter 
(Example)
 Command 
:
SCNGROUP 2  delimiter 
:
Switches to Scene Group 2.
 Response 
OK  delimiter 
Important
  • When parallel continuous measuring is engaged and continuous STEP signal is inputted, switching of scene group should be avoided. To switch a scene group, uncheck "Save scene group when switching" by either of the following methods.

SCNLOAD - SCeNe LOAD -

Function ... Loads the Scene data from the external devices
 Command 
SCNLOAD <Scene No.> <Load Resource> delimiter 
Point at the <code number> 0 to 31.
Select the following from the <Load Resource>
  • \USBDisk\...
    When a file in the USB memory is selected, this file will be loaded. The file extension is "***.SCN".
 Response 
Executed correctly
:OK  delimiter 
Executed correctly
:ER  delimiter 
(Example)
 Command 
:
SCNLOAD 2 \USBDisk2\IMG01\LABEL.SCN  delimiter 
Load the "LABEL.SCN" file, namely Scene 2, in the "IMG01" folder in the USB memory of the "USBDisk2" drive onto the controller.
 Response 
:
OK  delimiter 
Note
  • Cannot be executed correctly in case of the following.
    • Select the files with other extension names (other than "***.SCN")
    • When non-existing files are used
  • Please do not Cut off power of controller before the response.

SCNSAVE - SCeNe SAVE -

Function ... Saves a scene data into the external device
 Command 
SCNSAVE <Scene No.> <Save to Destination Address> delimiter 
Point at the code number 0 to 31.
Select the following from the <Save to Destination Address>
  • \USBDisk\...
    When the destination folder is in the USB memory, it will be Saved to the USB memory. The file extension is "***.SCN".
 Response 
Executed correctly
:OK  delimiter 
Executed correctly
:ER  delimiter 
Note
  • Cannot be executed correctly in case of the following.
    • Select the files with other extension names (other than "***.SCN")
    • When a non-existing folder is selected in the destination address
    • In the case the specified file name has existed, the existing file will be overwritten
  • Please do not Cut off power of controller before the response.
(Example)
 Command 
:
SCNSAVE 3 \USBDisk2\SCN01\LABEL.SCN  delimiter 
The image data of the No.3 image, namely the "LABEL.SCN" file, will be Saved into the "SCN01" folder in the USB memory of the "USBDisk2" drive.
 Response 
:
OK  delimiter 

SCRSWITCH - SCReen SWITCH -

Function ... Switches ADJUST window/RUN window
 Command 
SCRSWITCH delimiter 
 Response 
When executed properly
:OK  delimiter 
When not executed properly
:ER  delimiter 
(Example)
 Command 
:
SCRSWITCH  delimiter 
Swiches to the ADJUST window if the current window is the RUN window
Swiches to the RUN window if the current window is the ADJUST window
 Response 
:
OK  delimiter 

SGRLOAD - Scene GRoup LOAD -

Function ... Loads the scene group data from the external devices
 Command 
SGRLOAD<Scene No.> <Load Resource> delimiter 
Scene group No. shall be set within 0 to 31.
Selects the following from the <Load Resource>
  • \USBDisk\...
    When a file in the USB memory is selected, this file will be loaded. The file extension is "***.SGP".
 Response 
Executed correctly
:OK  delimiter 
Executed correctly
:ER  delimiter 
Note
  • Cannot be executed correctly in case of the following.
    • Select the files with other extension names (other than "***.SGP")
    • When non-existing files are used
  • Please do not Cut off power of controller before the response.
(Example)
 Command 
:
SGRLOAD 3 \USBDisk2\IMG01\LABEL.SGP  delimiter 
The "LABEL.SGP" file, namely Scene Group 2, in the "IMG01" folder in the USB memory of the "USBDisk2" drive is loaded onto Scene Group 3.
 Response 
:
OK  delimiter 
Note

SGRSAVE - Scene GRoup SAVE -

Function ... Saves scene group data into the external devices
 Command 
SGRSAVE<Scene No.><Save to Destination Address>  delimiter 
Scene group No. shall be set within 0 to 31.
Selects the following from the <Save to Destination Address>
  • \USBDisk\...
    When the destination folder is in the USB memory, it will be Saved to the USB memory. The file extension is "***.SGP".
 Response 
Executed correctly
:OK  delimiter 
Executed correctly
:ER  delimiter 
(Example)
 Command 
:
SGRSAVE 3 \USBDisk2\IMG01\LABEL.SGP  delimiter 
The image data of the No.3 image, namely the "LABEL.SGP" file, will be Saved into the "IMG01" folder in the USB memory of the "USBDisk2" drive.
 Response 
:
OK  delimiter 
Note
  • Cannot be executed correctly in case of the following.
    • Select the files with other extension names (other than "***.SGP")
    • When a non-existing folder is selected in the destination address
    • In the case the specified file name has existed, the existing file will be overwritten
  • Please do not Cut off power of controller before the response.

SYSDATA - SYStem DATA -

Function 1 ... Gets current system data
 Command 
SYSDATA <Identifier 0> <Identifier 1> delimiter 
 Response 
When executed properly
:Set Value  delimiter 
:OK  delimiter 
When not executed properly
:ER  delimiter 
Identifier 0 is "Logging".
Identifier 1 and values are as follows.
Table: Identifier 1 and values
Setting data
Identifier 1
Set Value
Image logging
imageLogging
  • 0: None
  • 1: Only NG
  • 2: All
Folder name as the destination to save image logging
imageLoggingDirectory
Folder name as the destination (one-byte alphanumeric character)
Prefix of image logging file name
imageLoggingHeader
Prefix of image logging file name (one-byte alphanumeric character)
Data logging
dataLogging
  • 0: None
  • 1: Only NG
  • 2: All
Name as the destination folder to save data logging
dataLoggingDirectory
Folder name as the destination (one-byte alphanumeric character)
(Example)
 Command 
:
SYSDATA Logging imageLogging  delimiter 
Gets current image logging setting
 Response 
:
1  delimiter 
OK  delimiter 
The current image logging setting is 1 (Only NG).
Function 2 ... Sets system data
 Command 
SYSDATA <Identifier 0> <Identifier 1> <Set Value> delimiter 
 Response 
When executed properly
:OK  delimiter 
When not executed properly
:ER  delimiter 
Identifier 0 is "Logging".
Identifier 1 and values are as follows.
Table: Identifier 1 and values
Setting data
Identifier 1
Set Value
Image logging
imageLogging
  • 0: None
  • 1: Only NG
  • 2: All
Folder name as the destination to save image logging
imageLoggingDirectory
Folder name as the destination (one-byte alphanumeric character)
Prefix of image logging file name
imageLoggingHeader
Prefix of image logging file name (one-byte alphanumeric character)
Data logging
dataLogging
  • 0: None
  • 1: Only NG
  • 2: All
Name as the destination folder to save data logging
dataLoggingDirectory
Folder name as the destination (one-byte alphanumeric character)
(Example 1)
 Command 
:
SYSDATA Logging imageLogging 1  delimiter 
Sets image logging to be performed only if NG.
 Response 
:
OK  delimiter 
(Example 2)
 Command 
:
SYSDATA Logging imageLoggingDirectory \RAMDisk  delimiter 
Sets RAM Disk as the destination to save image logging.
 Response 
:
OK  delimiter 

SYSLOAD - SYStem LOAD -

Function ... Loads system data from an external device
 Command 
SYSLOAD <Source data>  delimiter 
Specifies the content of the following location as the <Source data>.
  • \USBDisk\...
    If specifying the files on USB memory as the source, those files are loaded. The file extension is "***.INI".
 Response 
Performed correctly
:OK  delimiter 
Failure to perform
:ER  delimiter 
Note
  • The following cases result in failure.
    • When a file with extension other than "***.INI" is specified.
    • When a file that does not exist is specified.
  • Do not turn off the power of the controller until a response is returned.
(Example)
 Command 
:
SYSLOAD \USBDisk2\IMG01\LABEL.INI  delimiter 
Loads "LABEL.INI" in the "IMG01" folder of the USB memory drive labeled "USBDisk2".
 Response 
:
OK  delimiter 

SYSSAVE - SYStem SAVE -

Function ... Saves system data to an external device
 Command 
SYSSAVE <Destination>  delimiter 
Specifies the following location as the <Destination>.
  • \USBDisk\...
    When the destination folder is in the USB memory, it will be Saved to the USB memory. The file extension is "***.INI".
 Response 
Perform correctly
:OK  delimiter 
Failure to perform
:ER  delimiter 
(Example)
 Command 
:
SYSSAVE \USBDisk2\IMG01\LABEL.INI  delimiter 
The image data of the No.3 image, namely the "LABEL.INI" file, will be Saved into the "IMG01" folder in the USB memory of the "USBDisk2" drive.
 Response 
:
OK  delimiter 
Note
  • Cannot be executed correctly in case of the following.
    • Select the files with other extension names (other than "***.INI")
    • When a non-existing folder is selected in the destination address
    • In the case the specified file name has existed, the existing file will be overwritten
  • Please do not Cut off power of controller before the response.

UNITDATA or UD

Function 1 ... Obtains the parameters set in or the values measured by the processing unit that is set in the current scene.
 Command 
UNITDATA <Processing Unit No.> <External Reference Table No.>  delimiter 
  • Specifies 0 to 9999 for <processing unit No.>.
  • <External Reference Table No.> varies depending on the specified processing unit items.
    For details, see the "External Reference Table" of the processing items registered in the processing unit.
    Processing item List
  • Only numerical data is available.
 Response 
Performed correctly
:value  delimiter 
:OK  delimiter 
Failure to perform
:ER  delimiter 
(Example)
 Command 
:
UNITDATA 5 0  delimiter 
Retrieves the judgement result of the Search in the sixth processing unit with its number "5" (the value of the external reference table is "0").
 Response 
:
0
OK  delimiter 
Function 2 ... Set the parameters of the processing unit set in the current scene
 Command 
UNITDATA <Processing Unit No.> <External Reference Table No.> <Data to Set> delimiter 
  • Specifies 0 to 9999 for <processing unit No.>.
  • <External Reference Table No.> varies depending on the specified processing unit items.
    For details, see the "External Reference Table" of the processing items registered in the processing unit. Processing item List
  • Only value data can be set.
 Response 
Performed correctly
:OK  delimiter 
Failure to perform
:ER  delimiter 
(Example)
 Command 
:
UNITDATA 5 124 10 delimiter 
Sets "Skipping angle" (the external reference table value: "124") of "Search" to "10", which was set to the 6th processing unit (Unit No. "5") .
 Response 
:
OK  delimiter 

VERGET - VERsion GET -

Function ... Acquires system version information
 Command 
VERGET delimiter 
 Response 
Performed correctly
: version information YYYY/MM/DD
:OK  delimiter 
Failure to perform
:ER  delimiter 
(Example)
 Command 
:
VERGET delimiter 
Obtains system information.
 Response 
:
FZ2-XXX Ver.1.00 2007/07/30
:
OK  delimiter 
The controller type is "FZ2-XXX", the version is "1.00", and the date is "July 30th, 2007".
Top
BackNext
Copyright© 2007 OMRON Corporation All Rights Reserved.