Native Mode Commands

Basic Native Mode Commands

Note:

The In-Sight 2000 series sensor supports the following basic native commands:

  • File & Job commands: Load File (LF), Store File (TF), Read File (RF), Write File (WF), Delete File (DF), Get File (GF), Set Job (SJ), Store Job (TJ), Read Job (RJ), Write Job (WJ), Delete Job (DJ), and Get Job (GJ)
  • Image Commands: Read BMP (RB), and Write BMP (WB)
  • Settings & Cell Value Commands: Set Integer (SI), Set Float (SF), Get Info (GI), Read Settings (RS), Write Settings (WS), Store Settings (TS), Set IP Address Lock (SL), and Get IP Address Lock (GL)
  • Execution & Online Commands: Set Online (SO), Get Online (GO), Set Event 8 (SE8), Set Event and Wait 8 (SW8), and Reset System (RT).
  • The Get Value (GV) command is only supported for Serial Native.

File & Job Commands

  • Load File: (LF) Loads the specified job from flash memory on the In-Sight vision system, making it the active job. For more information, see Load File.
  • Store File: (TF) Saves the current job in flash memory on the vision system. For more information, see Store File.
  • Read File: (RF) Reads a job from the flash memory on the vision system. For more information, see Read File.
  • Write File: (WF) Sends a job to the flash memory on the vision system. For more information, see Write File.
  • Delete File: (DF) Deletes the specified job or cell data file (.cxd) from flash memory on the vision system. For more information, see Delete File.
  • Get File: (GF) Returns the filename of the active job on the vision system. For more information, see Get File.
  • Set Job: (SJ) Loads a job from one of the job slots in flash memory on the vision system, making it the active job. For more information, see Set Job.
  • Store Job: (TJ) Saves the current job into the specified slot in flash memory on the vision system. For more information, see Store Job.
  • Read Job: (RJ) Reads a job from the specified In-Sight job slot. For more information, see Read Job.
  • Write Job: (WJ) Sends a job to the specified job slot in flash memory on the vision system. For more information, see Write Job.
  • Delete Job: (DJ) Deletes the job from the specified slot in flash memory on the vision system. For more information, see Delete Job.
  • Get Job: (GJ) Gets the currently loaded job's ID number. For more information, see Get Job.

Image Commands

  • Read BMP: (RB) Sends the current image, in ASCII hexadecimal format, from a vision system to an external device. For more information, see Read BMP.
  • Read Image: (RI) Sends the current image, in ASCII hexadecimal format, from a vision system to an external device. For more information, see Read Image.
  • Write BMP: (WB) Sends image data from an external device to the vision system. For more information, see Write BMP.
  • Write Image: (WI) Sends image data from an external device to the vision system. For more information, see Write Image.

Settings & Cell Value Commands

  • Get Value: (GV) Returns the value in a specified cell or symbolic tag. For more information, see Get Value.
  • Set Integer: (SI) Sets an integer value in a specified cell or symbolic tag. For more information, see Set Integer.
  • Set Float: (SF) Sets a floating point value in a specified cell or symbolic tag. For more information, see Set Float.
  • Set Region: (SR) Sets the values of an EditRegion cell or symbolic tag. For more information, see Set Region.
  • Set String: (SS) Sets a string value in a specified cell or symbolic tag. For more information, see Set String.
  • Get Info: (GI) Returns system information about the In-Sight vision system. For more information, see Get Info.
  • Read Settings: (RS) Reads the system settings data from a vision system. For more information, see Read Settings.
  • Write Settings: (WS) Sends the system settings data from an external device to the vision system. For more information, see Write Settings.
  • Store Settings: (TS) Stores the vision system settings to the proc.set file. For more information, see Store Settings.
  • Set IP Address Lock: (SL) Prevents unauthorized changes to a vision system's IP address. For more information, see Set IP Address Lock.
  • Get IP Address Lock: (GL) Returns the security status of the IP address on a vision system. For more information, see Get IP Address Lock.

Execution & Online Commands

  • Set Online: (SO) Sets the vision system into Online or Offline mode. For more information, see Set Online.
  • Get Online: (GO) Returns the Online state of the vision system. For more information, see Get Online.
  • Set Event: (SE) Triggers a specified event. For more information, see Set Event.
  • Set Event and Wait: (SW) Triggers a specified event and waits until the command is completed to return a response. For more information, see Set Event and Wait.
  • Reset System: (RT) Resets the vision system (similar to physically power cycling the vision system). For more information, see Reset System.
  • Send Message: (SM) Sends a string to the spreadsheet over a Native Mode connection, and optionally, triggers a spreadsheet Event. For more information, see Send Message.

Extended Native Mode Commands

  • Get: Used to receive information from the In-Sight vision system and its spreadsheet. For more information, see Get.
  • Put: Used to send information to a vision system and its spreadsheet. For more information, see Put.
Note: The In-Sight 2000 series vision sensor does not support extended native mode commands, except where noted.

Evaluate

Evaluate: (EV) Executes In-Sight functions as well as inserts formulas into the In-Sight spreadsheet; used to retrieve information and make changes to In-Sight vision systems. For more information, see Evaluate.

Note: All In-Sight functions may be used with the EV command; the commands listed below are some of the most common functions to be executed using the EV command.
  • GetCellName: Returns the cell location of a specified symbolic tag name, or the symbolic tag name of a specified cell. For more information, see GetCellName.
  • GetCellValue: Returns the contents of a specified symbolic tag or spreadsheet cell in XML format. For more information, see GetCellValue.
  • GetDeEnergizeOutputs: Returns the De-Energize Outputs While Offline setting configured in the Discrete I/O Settings dialog. For more information, see GetDeEnergizeOutputs.
  • GetDiagnosticLog: Returns a log of information used to diagnose errors on the In-Sight vision system. For more information, see GetDiagnosticLog.
  • GetDiscreteInput: Returns information that is configured in the Discrete I/O Settings dialog. For more information, see GetDiscreteInput.
  • GetDiscreteOutput: Returns information that is configured in the Discrete I/O Settings dialog. For more information, see GetDiscreteOutput.
  • GetDiscreteOutputDelay: Returns delay settings that are configured in the Discrete I/O Settings dialog. For more information, see GetDiscreteOutputDelay.
  • GetEasyBuilderTag: Returns the EasyBuilder Tag for the specified symbolic tag name or cell location. For more information, see GetEasyBuilderTag.
  • GetFTPSettings: Returns information that is configured in the FTP Settings dialog. For more information, see GetFTPSettings.
  • GetHostTable: Returns information contained in the In-Sight Host Table dialog. For more information, see GetHostTable.
  • GetMSBuffer: Returns the Machine Status data stored in one of 8 indexed buffers (zero-based) within the Machine Status stack. For more information, see GetMSBuffer.
  • GetNetwork: Returns information that is configured in the Network Settings dialog. For more information, see GetNetwork.
  • GetSerialPort: Returns information that is configured in the Serial Port Settings dialog. For more information, see GetSerialPort.
  • GetStartup: Returns information that is configured in the Startup dialog. For more information, see GetStartup.
  • GetSystemConfig: Various commands that return system information. For more information, see GetSystemConfig.
  • GetUserList: Returns information that is configured in the User List dialog. For more information, see GetUserList.
  • SetCellName: Sets the symbolic tag name of a specified cell. For more information, see SetCellName.
  • SetCellValue: Sets the value of specific cell appended with an EasyBuilder Tag. For more information, see SetCellValue.
  • SetDeEnergizeOutputs: Configures the De-Energize Outputs While Offline setting found in the Discrete I/O Settings dialog. For more information, see SetDeEnergizeOutputs.
  • SetDiscreteInput: Configures settings that are found in the Discrete I/O Settings dialog. For more information, see SetDiscreteInput.
  • SetDiscreteOutput: Configures settings in the Discrete I/O Settings dialog and the Output Details dialog. For more information, see SetDiscreteOutput.
  • SetDiscreteOutputDelay: Configures delay settings that are found in the Output Details dialog. For more information, see SetDiscreteOutputDelay.
  • SetEditRegion: Configures settings for a cell that contains an EditRegion function. For more information, see SetEditRegion.
  • SetFavorHostTable: Enables or disables the Favor Host Table over DNS option found in the In-Sight Host Table. For more information, see SetFavorHostTable.
  • SetFTPSettings: Configures settings that are found in the FTP Settings dialog. For more information, see SetFTPSettings.
  • SetHostTable: Configures settings that are found in the In-Sight Host Table dialog. For more information, see SetHostTable.
  • SetNetwork: Configures settings that are found in the Network Settings dialog. For more information, see SetNetwork.
  • SetSerialPort: Configures settings that are found in the Serial Port Settings dialog. For more information, see SetSerialPort.
  • SetStartup: Configures settings that are found in the Startup dialog. For more information, see SetStartup.
  • SetSystemConfig: Various commands that configure system parameters. For more information, see SetSystemConfig.