DMD0518

CTPLSADD - CTRIO2 Add Entry to PLS

Note: The CTPLSADD instruction can only be used with the CTRIO2 modules.

The CTRIO2 Add Entry to PLS (CTPLSADD) instruction is used to add an entry to a PLS table that is currently loaded for the specified CTRIO2 Discrete Output and/or create a new PLS on-the-fly and add the first entry.

Note: Changes made to CTRIO2 PLS tables using this instruction do not change any of the PLS tables configured in the System Configuration for the CTRIO2. They are temporary and are lost on a power-cycle of the CTRIO2 or if some other table is loaded in their place. The changes cannot be viewed, for example, in the PLC --> System Configuration.

Entries in the PLS table must be sorted into numerical order. At the conclusion of the Add PLS Entry process, the CTRIO2 will resort the PLS table. This could result in entry Numbers moving within the PLS table.

The red triangle in the upper left corner indicates the CTRIO2 Add Entry to PLS (CTPLSADD) is a Fully Asynchronous instruction.

Inputs:

The input is edge-triggered, meaning that each time this input logic transitions from OFF to ON, the CTRIO2 Add Entry to PLS (CTPLSADD) will:
 

• add an entry to the currently loaded PLS table on the CTRIO2 Discrete Output Device

• run to completion, even if the input logic goes OFF before the operation is complete.

Parameters:

Note: Use the F9 key (Element Browser) at any time to see a complete list of the memory locations that are valid in the current field of the instruction.

Discrete Output Device - designates which of the pre-configured CTRIO2 Discrete Output Devices to interact with. Before this instruction can select a Discrete Output Device, a CTRIO2 Device must be configured with at least one of its output channels setup for Discrete output mode.

Part of the configuration for a device is assigning a name to the device. It is that name which will show up in the Discrete Output Device selection drop-down menu. For more information on configuring CTRIO2 devices go to the Module Configuration Section under System Configuration.

Note: no devices available - indicates that there are no CTRIO2 Devices that have been pre-configured to perform this instruction.

Discrete Output Structure -  This field displays the name of the Discrete Output Structure that will be used by this instruction. This structure was created when the CTRIO2 module was configured during the Module Configuration phase.

Initialize First - optionally clear any entries in the currently loaded PLS table before adding the preset specified in this instruction

Initial Output State - (only valid with Initialize First) - designates the initial state of the output:

• ON

• OFF

Output ON when Greater than or Equal to - Specifies the beginning pulse count of the next Limit position in the PLS table. The Output will be ON when the count value is greater than or equal to this value. This can be any constant value, or any readable numeric location.

AND Less Than - Specifies the ending pulse count of the next Limit position in the PLS table.  The Output will be OFF when the count value is less than this value. This can be any constant value, or any readable numeric location.

On Success - designates which of the following actions to take if the CTRIO2 Add Entry to PLS operation is successful.

• SET BIT - The specific BIT location will turn OFF when the CTRIO2 Add Entry to PLS (CTPLSADD) instruction is first enabled, and then SET ON if the operation is successful. This value can be any writable bit location.
   

• JMP to Stage - JMP to the specified Stage. The target Stage must be in the same Program code block as the CTRIO2 Add Entry to PLS (CTPLSADD) instruction, you cannot specify a Stage in a different Program code block. This selection will function like a standalone Jump to Stage instruction. Click here for more information on the Jump To Stage instruction.

On Error - designates which of the following two actions to take if the CTRIO2 Add Entry to PLS operation is unsuccessful.

• SET BIT - The specific BIT location will turn OFF when the CTRIO2 Add Entry to PLS (CTPLSADD) instruction is first enabled, and then SET ON if the operation is unsuccessful. This value can be any writable bit location.
   

• JMP to Stage - JMP to the specified Stage. The target Stage must be in the same Program code block as the CTRIO2 Add Entry to PLS (CTPLSADD) instruction, you cannot specify a Stage in a different Program code block. This selection will function the same as a standalone Jump to Stage instruction. Click here for more information on the Jump To Stage instruction.

Note: any time the On Error condition occurs, the CTRIO2 generates an Error Code that can be read in the <Module Name>.ErrorCode (Module Name is the name assigned to the CTRIO2 in the Module Configuration). The List of Error Code values (in decimal) follows:

Status Display:

The Status display of the CTRIO2 Add Entry to PLS (CTPLSADD) instruction shows:

• Values: Greater than or equal to, AND less than
   

• Highlights: .OutputEnabled bit
   

• ON/OFF: On Success, On Error bits

CTRIO2 Structure Field Care-Abouts:

The following is a list of the"dot" fields of the CTRIO2 structure that are programmatically used with the CTRIO2 Add Entry to PLS (CTPLSADD) instruction. To see a complete listing of all CTRIO structures and members, goto the Project Browser --> Configuration --> Memory --> I/O --> Specialty.

COLOR KEY

Blue: CTRIO Input

Maroon: CTRIO Output

Black: CTRIO Module

Silver: Not used for this instruction

Note: The red "x" is the digit 0, 1, 2, or 3.

See Also:

• CTDYNPOS - CTRIO Run Dynamic Position Mode
   

• CTDYNVEL - CTRIO Run Dynamic Velocity Mode
   

• CTUPDLVL - CTRIO Update Level
   

• CTPLSADD - CTRIO2 Add Entry to PLS
   

• CTPLSEDT - CTRIO2 Edit PLS Entry
   

• CTREGRD - CTRIO Read Register
   

• CTREGWR - CTRIO Write Register
   

• CTRUNPOS - CTRIO Run Position Mode
   

• CTRUNVEL - CTRIO Run Velocity Mode
   

• CTTBLADD - CTRIO Add Entry to Preset Table
   

• CTTBLCLR - CTRIO Clear Table
   

• CTTBLEDT - CTRIO Edit Preset Table Entry
   

• CTTBLLD - CTRIO Load Table

Example 1 of 2:

Description of a Typical CTRIO2 Add Entry to PLS (CTPLSADD) Stage Diagram:

To the right is a stage diagram of a stage that will all the adding of any number of entries to either an existing PLS table or a newly created one.

In the Init stage the decision is made as to whether to create a new PLS table on-the-fly, or load a pre-existing one. Before the decision is made the parameters for the entry must be prepared (a lower limit value and an upper limit value). Then, if create is chosen, one is created and transition is made to the AddFin stage. If a pre-existing one is chosen, then it is loaded and transition is made to the AddEntry stage.

The AddEntry adds an entry (with the prepared lower limit and upper limit values) and when finished transitions to the AddFin stage.

In the AddFin stage the decision is made as to whether this was the last entry or to add another one. If another one is desired the lower limit and upper limit values must be prepared and then transition is made back to the AddEntry stage. If this was the last entry, then transition is made to the EnOut stage.

The EnOut stage enables the CTRIO2 discrete output for use with the table and then transitions to the Done stage.

The Done stage exists this Program code block.

Description of a Typical CTRIO2 Add Entry to PLS (CTPLSADD) Stage Ladder:

To the right is the ladder equivalent of the above stage diagram that uses the CTPLSADD instruction to create and/or add any number of entries to either a pre-existing PLS table or a newly created one.

This example presupposes the existence of the following System Configuration for the CTRIO2 (PLC --> System Configuration --> Module Configuration(s) --> CTRIO_000 -->):

• Configure I/O -->

• Channel 1 --> Quad Counter.

• Outputs --> Out2 --> Discrete on Ch1/Fn1.

• Discrete Tables --> Add PLS Table (CTRIO2): with the following parameters:
  File Number: 9
  Name: PLS
  Scales: Unscaled
  Default Output State: Off
  Entry: ON when >= 2500 counts and < 7500 counts.

• A quadrature encoder is wired to CTRIO2's Channel 1 Input A & B.

• A discrete device that utilizes the CTRIO2's Output is wired to CTRIO2's Output 2.

In the Init stage the decision is made whether to create a PLS table on-the-fly or load a pre-existing one. Before making this decision the LowerLimit and UpperLimit values should be prepared. Once these values are set then if CreatePLS is turned ON the CTPLSADD instruction will execute and create a new temporary PLS table complete with its first entry for $CTRIO_000_Out2 because of the parameter Initialize to OFF with the Greater than or equal to value of LowerLimit and the AND less than value of UpperLimit and then, if successful, transition to the AddFin stage. If LoadPLS is turned ON instead, then then CTTBLLD instruction (for more information on this instruction click here) will load a the pre-existing PLS table "9:PLS(Prg Limit Switch Tbl)" for $CTRIO_000_Out2 and if successful will transition to the AddEntry stage where the new entry will be added.

If either the CTPLSADD or the CTTBLLD instructions get errors then transition is immediately made to the ErrorStage where logic (not shown here) should exist to properly handle and report the error code now stored in $CTRIO_000.ErrorCode.

Note: The newly created PLS table nor any new entry in a pre-existing PLS table are permanently stored in the CTRIO2 configuration. They are temporary and are lost on a power-cycle of the CTRIO2 or if some other table is loaded in their place. The changes cannot be viewed, for example, in the PLC --> System Configuration.

The AddEntry stage executes the CTPLSADD instruction to add a new temporary PLS entry to either the newly created PLS or a pre-existing PLS. If successful transition is made to the AddFin stage. If there is an error transition is made to the ErrorStage.

In the AddFin stage the decision is made whether to add another entry to the PLS table or finish the adds. If it is decided that another entry is required then the LowerLimit and UpperLimit values should first be prepared and then the Add bit turned ON. If Add bit is turned ON this will reset itself (in preparation for another possible entry) and transition to the AddEntry to do the work. If it did not reset itself then it would be left ON and this would cause the process to oscillate between the AddEntry and AddFin stages. If this was the last entry to be added, then the FinishedAdds bit is turned ON. This bit resets itself and transitions to the EnOut stage where the CTRIO2's output will be enabled for use with the new PLS table.

The EnOut stage sets the $CTRIO_000_Out2.EnableOutput bit and waits for the feedback bit ($CTRIO_000_Out2.OutputEnabled) to come ON. When it does transition is made to the Done stage.

The Done stage exists this Program code block.

Example 2 of 2: