Load a Job or Recipe Through an Ethernet/IP PLC

Perform the following steps to change the job or recipe running on the vision system through an RSLogix PLC.

  1. If you are loading a new job, then first place the vision system to a Paused state by setting the Set Paused bit high.

    Note: You can skip this step when changing recipes.
    • See the below table when using an In-Sight ViDi PC device:

      Instance Byte Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0
      21 0 Set Paused Clear Error Reserved Execute Command Reserved Buffer Results Enable Trigger Enable
      1 Reserved
      2..3 Command ID
      4..7 External Event 0-31
      8..15 Reserved
      16 Reserved Set User Data 0 Clear Exposure Complete 0 Inspection Results Acknowledge 0 Trigger Camera 0
      17 Reserved Set User Data 1 Clear Exposure Complete 1 Inspection Results Acknowledge 1 Trigger Camera 1
      18 Reserved Set User Data 2 Clear Exposure Complete 2 Inspection Results Acknowledge 2 Trigger Camera 2
      19 Reserved Set User Data 3 Clear Exposure Complete 3 Inspection Results Acknowledge 3 Trigger Camera 3
      20..499 User Data 0...479
    • See the below table when using an In-Sight D900 series vision system:

      Instance Byte Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0
      23

      0

      Set Paused

      Reserved

      Execute Command

      Inspection Results Acknowledge

      Buffer Results Enable

      Trigger

      Trigger Enable

      1

      Reserved

      2

      Reserved

      Clear Exposure Complete

      Clear Error

      Reserved

      Set User Data

      3

      External Event 7

      External Event 6

      External Event 5

      External Event 4

      External Event 3

      External Event 2

      External Event 1

      External Event 0

      4 .. 5

      Command ID

      6 .. 7

      8 .. 495

      User Data 0 - 487

      Instance Byte
      23

      0

      1

      Reserved

  2. Use the applicable Command ID in the command block to initiate the job/recipe change.

    Name Command ID (Hex) Command ID (Dec)
    Load Job by Name 0x4000 16384
    Load Job by ID 0x0-0x3E7 0-999
    Load Recipe by Name 0x4001 16385
    Load Recipe by ID 0x3E8-0x7CF 1000-1999
    Tip: If you want to load a job from the SD card inserted into the vision system, then use the Load Job by Name method.
    • Write the Command ID of the selected action into bytes 2-3 when using an In-Sight ViDi PC device:

      Instance Byte Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0
      21 0 Set Paused Clear Error Reserved Execute Command Reserved Buffer Results Enable Trigger Enable
      1 Reserved
      2..3 Command ID
      4..7 External Event 0-31
      8..15 Reserved
      16 Reserved Set User Data 0 Clear Exposure Complete 0 Inspection Results Acknowledge 0 Trigger Camera 0
      17 Reserved Set User Data 1 Clear Exposure Complete 1 Inspection Results Acknowledge 1 Trigger Camera 1
      18 Reserved Set User Data 2 Clear Exposure Complete 2 Inspection Results Acknowledge 2 Trigger Camera 2
      19 Reserved Set User Data 3 Clear Exposure Complete 3 Inspection Results Acknowledge 3 Trigger Camera 3
      20..499 User Data 0...479
    • Write the Command ID of the selected action into bytes 4-5 or 6-7 when using an In-Sight D900 series vision system:

      Instance Byte Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0
      23

      0

      Set Paused

      Reserved

      Execute Command

      Inspection Results Acknowledge

      Buffer Results Enable

      Trigger

      Trigger Enable

      1

      Reserved

      2

      Reserved

      Clear Exposure Complete

      Clear Error

      Reserved

      Set User Data

      3

      External Event 7

      External Event 6

      External Event 5

      External Event 4

      External Event 3

      External Event 2

      External Event 1

      External Event 0

      4 .. 5

      Command ID

      6 .. 7

      8 .. 495

      User Data 0 - 487

      Instance Byte
      23

      0

      1

      Reserved

  3. If you perform the Load Job by Name or Load Recipe by Name action, then write the job name (without the *.jobx extension) or the recipe name into the User Data command block.

    Note: The job/recipe name must be null terminated (that is, a 0 must be added in the byte immediately following the job/recipe name).
    • If you use an In-Sight ViDi PC device, then write the job/recipe name into bytes 20-499 (User Data) of the command block:

      Instance Byte Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0
      21 0 Set Paused Clear Error Reserved Execute Command Reserved Buffer Results Enable Trigger Enable
      1 Reserved
      2..3 Command ID
      4..7 External Event 0-31
      8..15 Reserved
      16 Reserved Set User Data 0 Clear Exposure Complete 0 Inspection Results Acknowledge 0 Trigger Camera 0
      17 Reserved Set User Data 1 Clear Exposure Complete 1 Inspection Results Acknowledge 1 Trigger Camera 1
      18 Reserved Set User Data 2 Clear Exposure Complete 2 Inspection Results Acknowledge 2 Trigger Camera 2
      19 Reserved Set User Data 3 Clear Exposure Complete 3 Inspection Results Acknowledge 3 Trigger Camera 3
      20..499 User Data 0...479
    • If you use an In-Sight D900 series vision system, then write the job/recipe name into bytes 8-495 (User Data) of the command block:

      Instance Byte Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0
      23

      0

      Set Paused

      Reserved

      Execute Command

      Inspection Results Acknowledge

      Buffer Results Enable

      Trigger

      Trigger Enable

      1

      Reserved

      2

      Reserved

      Clear Exposure Complete

      Clear Error

      Reserved

      Set User Data

      3

      External Event 7

      External Event 6

      External Event 5

      External Event 4

      External Event 3

      External Event 2

      External Event 1

      External Event 0

      4 .. 5

      Command ID

      6 .. 7

      8 .. 495

      User Data 0 - 487

      Instance Byte
      23

      0

      1

      Reserved

  4. Set the Execute Command bit in the command block by triggering Bit 4 of Byte 0, as shown below.

    • See the below table when using an In-Sight ViDi PC device:

      Instance Byte Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0
      21 0 Set Paused Clear Error Reserved Execute Command Reserved Buffer Results Enable Trigger Enable
      1 Reserved
      2..3 Command ID
      4..7 External Event 0-31
      8..15 Reserved
      16 Reserved Set User Data 0 Clear Exposure Complete 0 Inspection Results Acknowledge 0 Trigger Camera 0
      17 Reserved Set User Data 1 Clear Exposure Complete 1 Inspection Results Acknowledge 1 Trigger Camera 1
      18 Reserved Set User Data 2 Clear Exposure Complete 2 Inspection Results Acknowledge 2 Trigger Camera 2
      19 Reserved Set User Data 3 Clear Exposure Complete 3 Inspection Results Acknowledge 3 Trigger Camera 3
      20..499 User Data 0...479
    • See the below table when using an In-Sight D900 series vision system:

      Instance Byte Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0
      23

      0

      Set Paused

      Reserved

      Execute Command

      Inspection Results Acknowledge

      Buffer Results Enable

      Trigger

      Trigger Enable

      1

      Reserved

      2

      Reserved

      Clear Exposure Complete

      Clear Error

      Reserved

      Set User Data

      3

      External Event 7

      External Event 6

      External Event 5

      External Event 4

      External Event 3

      External Event 2

      External Event 1

      External Event 0

      4 .. 5

      Command ID

      6 .. 7

      8 .. 495

      User Data 0 - 487

      Instance Byte
      23

      0

      1

      Reserved

  5. Wait for the Command Completed or Command Failed bit to be set (Bit 6 or 5 of Byte 1, respectively).

    • See the below table when using an In-Sight ViDi PC device:

      Instance Byte Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0
      11 0 Online Paused Reserved System Ready
      1 Error Command Failed Command Completed Command Executing Reserved
      2..3 Reserved
      4..5 Command Result Code
      6..7 Error ID
      8..11 External Event Acknowledge 0 - 31
      12..15 Reserved
      16 Results Buffer Overrun 0 Inspection Passed 0 Results Valid 0 Inspection Completed 0 Exposure Complete 0 Acquisition Error 0 Trigger Acknowledge Camera 0 Trigger Ready Camera 0
      17 Reserved Set User Data Acknowledge 0
      18..19 Acquisition ID 0
      20..21 Inspection Image ID 0
      22..23 Inspection Result Code 0
      24 Results Buffer Overrun 1 Inspection Passed 1 Results Valid 1 Inspection Completed 1 Exposure Complete 1 Acquisition Error 1 Trigger Acknowledge Camera 1 Trigger Ready Camera 1
      25 Reserved Set User Data Acknowledge 1
      26..27 Acquisition ID 1
      28..29 Inspection Image ID 1
      30..31 Inspection Result Code 1
      32 Results Buffer Overrun 2 Inspection Passed 2 Results Valid 2 Inspection Completed 2 Exposure Complete 2 Acquisition Error 2 Trigger Acknowledge Camera 2 Trigger Ready Camera 2
      33 Reserved Set User Data Acknowledge 2
      34..35 Acquisition ID 2
      36..37 Inspection Image ID 2
      38..39 Inspection Result Code 2
      40 Results Buffer Overrun 3 Inspection Passed 3 Results Valid 3 Inspection Completed 3 Exposure Complete 3 Acquisition Error 3 Trigger Acknowledge Camera 3 Trigger Ready Camera 3
      41 Reserved Set User Data Acknowledge 3
      42..43 Acquisition ID 3
      44..45 Inspection Image ID 3
      46..47 Inspection Result Code 3
      48..499 Inspection Results 0...451
    • See the below table when using an In-Sight D900 series vision system:

      Instance

      Byte

      Bit 7

      Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0
      14

      0

      Online

      Paused

      Reserved

      Acquisition Error

      Reserved

      Trigger Acknowledge

      Trigger Ready

      1

      Error

      Command Failed

      Command Completed

      Command Executing

      Results Valid

      Results Buffer Overrun

      Inspection Completed

      System Ready

      2

      Reserved

      Results Passed

      Exposure Complete

      Reserved

      Set User Data Acknowledge

      3

      External Event Acknowledge 7

      External Event Acknowledge 6

      External Event Acknowledge 5

      External Event Acknowledge 4

      External Event Acknowledge 3

      External Event Acknowledge 2

      External Event Acknowledge 1

      External Event Acknowledge 0

      4 .. 5

      Error ID (16-bit integer)

      6 .. 7

      Command Result Code (16-bit integer)

      8 .. 9

      Reserved (16-bit integer)

      10 .. 11

      Acquisition ID (16-bit integer)

      12 .. 13

      Inspection ID (16-bit integer)

      14 .. 15

      Inspection Result Code (16-bit integer)

      16 .. 499 Inspection Results 0 - 483
  6. Once either the Command Completed or Command Failed bit is detected, clear the Execute Command bit. Also, if you previously set the vision system to a Paused state, then clear the Set Paused bit as well to set the vision system Online.

    • See the below table when using an In-Sight ViDi PC device:

      Instance Byte Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0
      21 0 Set Paused Clear Error Reserved Execute Command Reserved Buffer Results Enable Trigger Enable
      1 Reserved
      2..3 Command ID
      4..7 External Event 0-31
      8..15 Reserved
      16 Reserved Set User Data 0 Clear Exposure Complete 0 Inspection Results Acknowledge 0 Trigger Camera 0
      17 Reserved Set User Data 1 Clear Exposure Complete 1 Inspection Results Acknowledge 1 Trigger Camera 1
      18 Reserved Set User Data 2 Clear Exposure Complete 2 Inspection Results Acknowledge 2 Trigger Camera 2
      19 Reserved Set User Data 3 Clear Exposure Complete 3 Inspection Results Acknowledge 3 Trigger Camera 3
      20..499 User Data 0...479
    • See the below table when using an In-Sight D900 series vision system:

      Instance Byte Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0
      23

      0

      Set Paused

      Reserved

      Execute Command

      Inspection Results Acknowledge

      Buffer Results Enable

      Trigger

      Trigger Enable

      1

      Reserved

      2

      Reserved

      Clear Exposure Complete

      Clear Error

      Reserved

      Set User Data

      3

      External Event 7

      External Event 6

      External Event 5

      External Event 4

      External Event 3

      External Event 2

      External Event 1

      External Event 0

      4 .. 5

      Command ID

      6 .. 7

      8 .. 495

      User Data 0 - 487

      Instance Byte
      23

      0

      1

      Reserved