DMD0535

CTUPDLVL - CTRIO Update Level


The CTRIO Update Level (CTUPDLVL) instruction is used to change the Level configuration of one of the CTRIO's Discrete Outputs (for description of that function see Discrete Output For Input Function under (2) Level (button) bullet).

 

Note: Changes made to CTRIO Level parameter using this instruction does not change the Level parameter configured in the System Configuration for the CTRIO. It is temporary and is lost on a power-cycle of the CTRIO. The change cannot be viewed, for example, in the PLC --> System Configuration.

 

The red triangle in the upper left corner indicates the CTRIO Update Level (CTUPDLVL) is a Fully Asynchronous instruction.

 

Note: The CTUPDLVL instruction can be used with both the CTRIO and CTRIO2 module.

 

Inputs:

The ladder logic input for this instruction is dual mode:

 

It is edge-triggered, meaning that each time this input logic transitions from OFF to ON, the CTRIO Update Level (CTUPDLVL) will:

  • Load the specified Output Preset table on the CTRIO Discrete Output Device

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

 

After the level value is updated, the input transitions to a traditional Enable function, meaning that as long as the ladder logic input has power flow, the output will be enabled.

 

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 CTRIO Discrete Output Devices to interact with. Before this instruction can select a Discrete Output Device, a CTRIO 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 CTRIO devices go to the Module Configuration Section under System Configuration.

 

Note: no devices available - indicates that there are no CTRIO 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 CTRIO module configuration was read during the Module Configuration phase.

 

Output is - specifies the new Output state: ON  or  OFF

 

When Level is - specifies the level comparison operator: Greater than  or  Less than

 

Scaled Level - specifies the new Level value. This can be any constant value of any readable numeric location.
 

Deadband (tenths of %) - specifies the new deadband value in tenths of a percent. This can be any integer constant value in the range of 0 to 1000 or any readable numeric location.

 

On Success - designates which of the following actions to take if the CTRIO Update Level operation is successful.

 

  • SET BIT - The specific BIT location will be turned OFF when the CTRIO Update Level (CTUPDLVL) 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 CTRIO Update Level (CTUPDLVL) 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 CTRIO Update Level operation is unsuccessful. For example if the specified CTRIO Discrete output is not configured correctly.

 

  • SET BIT - The specific BIT location will be turned OFF when the CTRIO Update Level (CTUPDLVL) 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 CTRIO Update Level (CTUPDLVL) 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 CTRIO generates an Error Code that can be read in the <Module Name>.ErrorCode (Module Name is the name assigned to the CTRIO in the Module Configuration). The List of Error Code values (in decimal) follows:

 

Error Code

Description

000

No Error

100

Specified command code is unknown or unsupported

101

File number not found in the file system

102

File type is incorrect for specified output function

103

Profile type is unknown

104

Specified input is not configured as a limit on this output

105

Specified limit input edge is out of range

106

Specified input function is unconfigured or invalid

107

Specified input function number is out of range

108

Specified preset function is invalid

109

Preset table is full

110

Specified Table entry is out of range

111

Specified register number is out of range

112

Specified register is an unconfigured input or output

113

Specified output is not configured as a limit on this output

114

Specified preset function invalid in PLS table

115

Specified PLS function invalid in preset table

116

PLS table entries overlap

117

Attempted to use axis function when pulse output is not in Axis Mode

118

Specified output isn't a pulse output

 


Status Display:

The Status display of the CTRIO Update Level (CTUPDLVL) instruction shows:

 

  • Values: Scaled Level, Deadband (tenths of %), Pulse Time (ms)
     

  • Highlight: .OutputEnabled bit
     

  • ON/OFF: On Success, On Error bits
     


CTRIO Structure Field Care-Abouts:

The following is a list of the"dot" fields of the CTRIO structure that are programmatically used with the CTRIO Update Level (CTUPDLVL) 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.

 

CTRIO_000

CTUPDLVL

MEMBER

R/W

TYPE

DESCRIPTION

_CxFx.AtResetValue

RO

Bit

 ON if CxFx count is at reset value

_CxFx.CaptureComplete

 

 

 

_CxFx.CapturedStart

 

 

 

_CxFx.CountCaptured

 

 

 

_CxFx.EnableCapture

 

 

 

_CxFx.fReg1

RO

Dword

If floating-point scaling is configured for CxFx in CTRIO: Floating-point scaled value; otherwise, number has no meaning

_CxFx.fReg2

 

 

 

_CxFx.iReg1

RO

Dword

If integer or BCD scaling is configured for CxFx in CTRIO: Signed-integer or BCD scaled value; otherwise, signed-integer raw count

_CxFx.iReg2

RO

Dword

If any scaling is configured for CxFx in CTRIO: Signed-integer raw count; otherwise, number has no meaning

_CxFx.Output

 

 

 

_CxFx.Reset

R/W

Bit

Set ON to reset CxFx count

_CxFx.Timeout

 

 

 

_Outx.AtPosition

 

 

 

_Outx.AtVelocity

 

 

 

_Outx.Direction

 

 

 

_Outx.EnableOutput

R/W

Bit

Set ON to enable the CTRIO discrete output that will operate with the Preset Table

_Outx.GotoPosition

 

 

 

_Outx.Output

 

 

 

_Outx.OutputActive

 

 

 

_Outx.OutputEnabled

RO

Bit

ON when CTRIO output has been enabled

_Outx.OutputPosition

 

 

 

_Outx.OutputStalled

 

 

 

_Outx.OutputSuspended

 

 

 

_Outx.OutputVelocity

 

 

 

_Outx.TableComplete

RO

Bit

ON when the last entry in the Preset Table has been executed (i.e. the count is higher than the last preset in the table)

.ErrorCode

RO

Word

Last CTRIO error code

.Mode

RO

Word

Indicates CTRIO mode: 2 = RUN; 1 = PROGRAM

.ScanTime

RO

Word

CTRIO scantime in microseconds

.MaxScanTime

RO

Word

Maximum CTRIO scantime in microseconds

.InputState

RO

Word

Upper byte is not used. Lower byte's nibbles indicate CTRIO's channel's input's state in order: .ChxD, .ChxC, .ChxB, .ChxA. It is a composite of these members

.OutputState

RO

Word

Each nibble indicates a CTRIO output configuration and state: .OutxType, .OutxDiscOn, .OutxDiscEnabled, .OutxPulseActive. It is a composite of these members

.ChxA

RO

Bit

ON when CTRIO Channel x Input A is ON

.ChxB

RO

Bit

ON when CTRIO Channel x Input B is ON

.ChxC

RO

Bit

ON when CTRIO Channel x Input C is ON

.ChxD

RO

Bit

ON when CTRIO Channel x Input D is ON

.OutxType

RO

Bit

Configuration: ON if CTRIO output x is configured for pulse output

.OutxDiscOn

RO

Bit

Status: ON if CTRIO output x logic is ON (if output x is enabled then the physical output will also be ON)

.OutxDiscEnabled

RO

Bit

Configuration: ON if CTRIO output x is configured for discrete output

.OutxPulseActive

RO

Bit

Status: ON if CTRIO output x is generating pulses

 


See Also:

 


Example:


Copyright Host Engineering, Inc. ALL RIGHTS RESERVED