Add-On Instruction syntax

FactoryTalk Design Studio Help Center

Getting started

Introduction

FactoryTalk Design Studio Help

Before you begin

Basic concepts

Become familiar with FactoryTalk Design Studio

Welcome

About

Toolbar

Object icons

Explorer bar

System explorer

Devices explorer

Execution explorer

Library explorer

Pane bar

View panes

Set layout

Reset layout

View tabs

Properties pane

View messages and status with the Output pane

View messages for the tags and logic in the project

View the status of operations

Quick start

Getting started

Design considerations

Element scopes

Resolving element references

Formats of element references

What's new?

Managing user roles and access

Entitlements and timed trials

FactoryTalk Design Studio Copilot

Enable FactoryTalk Design Studio Copilot - Project Access

FactoryTalk Design Studio Live chat

FactoryTalk Design Studio Provide feedback

Using the software

Create a project

Open a project

Import a Logix Designer project

Select a FactoryTalk Vault solution

Add a shared project to the FactoryTalk Vault

Save as

Delete a project

Close a project

Convert a project to the Logix Designer application

Project version control

Pull changes from the remote repository

Push changes to the remote project

View changes to a project

View uncommitted changes

Change history tab

Restore

FactoryTalk Smart Object

Create a FactoryTalk Smart Object

Create a definition from a FactoryTalk Smart Object

Create a definition from a modified instance

Update the definition of a FactoryTalk Smart Object from an instance

Override a program of an instance

Remove a FactoryTalk Smart Object instance from the definition

Cut, copy, and paste project elements

Allocate FactoryTalk Smart Object or program to a controller and task

Ladder Editor

Ladder diagram components

Ladder Diagram Properties pane

Keyboard navigation in ladder diagram

Ladder Editor Toolbox

Keyboard navigation in Ladder Editor Toolbox

Add a ladder diagram rung to a routine

Edit a ladder diagram rung

Move a ladder diagram rung

Cut, copy, and paste a ladder diagram element

Add a rung comment

Edit a rung comment

Delete a rung comment

Delete a ladder diagram rung

Add a ladder diagram branch to a routine

Move a ladder diagram branch rail

Resize a ladder diagram branch

Delete a ladder diagram branch

Add a ladder diagram branch level

Move a ladder diagram branch level

Delete a ladder diagram branch level

Add a ladder diagram instruction to a routine

Change a ladder diagram instruction

Reference a tag in a ladder diagram instruction

Move a ladder diagram instruction

Delete a ladder diagram instruction

Toggle a BIT instruction

Add an input parameter to an instruction

Add a return operand to an instruction

Remove a parameter from an instruction

Code Editor

Open the code editor

Code actions

Update a tag style to delete an invalid NULL_STYLE

Tasks

Create a continuous task

Create a periodic task

Create an event task

Edit task properties

Programs

Create a program

Create FaultHandler program

Create Power Up Handler program

Allocate FactoryTalk Smart Object or program to a controller and task

Monitor program and task properties

Delete a program

Routines

Create a routine

Open a routine

Add a tag to an element in a routine

Change the properties of a routine

Delete a routine

Close a routine

Tag Editor

Tag Editor contents

Tag Editor validation errors

Delete a tag

Base and notation for tag styles

Configure a grid

Sort tags

Cross-references

Search for cross-references

Tag references tab

Tags

Create a tag

Edit a tag

Edit the properties of a tag

Create a tag using the Create new tag dialog

Create a controller-scoped tag

Data types

Program parameters

Add a connection to a program parameter

Delete a connection to a program parameter

Parameter types for program connections

Program parameter reuse

Rules for adding a connection to a program parameter

Connections tab

User-defined data types

Create a user-defined data type

Add a member to a user-defined data type

Edit a user-defined data type

Edit a member to a user-defined data type

Reorder rows in the user-defined data type grid

Delete a user-defined data type

Delete a member from a user-defined data type

Add-On Instructions

Define a new Add-On Instruction

Add a local tag to the definition of an Add-On Instruction

Add a parameter to the definition of an Add-On Instruction

EnableIn and EnableOut parameters

EnableIn parameter and ladder diagrams

Required and visible parameters

Nested Add-On Instructions

Edit the definition of an Add-On Instruction

Create a prescan routine

Create an EnableInFalse routine

Edit the parameters for the definition of an Add-On Instruction

Edit the logic for the definition of an Add-On Instruction

Delete the definition of an Add-On Instruction

Add an instance of an Add-On Instruction to a routine

Create and assign a main tag to an instance to an Add-On Instruction

Edit parameters for an instance of an Add-On Instruction

Edit the logic for an instance of an Add-On Instruction

Language examples for Add-On Instruction instances

Tips for using instances of Add-On Instructions

Add-On Instruction invocation

Data Context

Add-On Instruction Tag Editor

Add-On Instruction Routine Editor

Manage devices

Supported devices

Add a controller

Change controller properties

Monitor controller capacity

Monitor ethernet node capacity

Delete a controller

Add multiple devices

Unassign a device

Add and assign devices

Change device properties

Delete a device

View a device profile

View tags and parameters for a device

Import Stratix device configuration

Export Stratix device configuration

Device List

IntelliCENTER

Import an MCC lineup

Manage import merge conflicts

Import Sections

Replace units

Elevation view

Edit the MCC lineup in the Elevation view

View and open MCC lineup documentation

IntelliCENTER supported devices

Export an MCC lineup

IntelliCENTER Dashboard

Network paths

Set Network Path in IntelliCENTER explorer

Set Network Path in Elevation view

Set Network Path in IntelliCENTER Dashboard

Unit Profile

Launch the Unit Profile from the IntelliCENTER explorer

Launch the Unit Profile from the Elevation view

Deploy and monitor

FactoryTalk Remote Access

Enable FactoryTalk Remote Access for FactoryTalk Design Studio

Connect FactoryTalk Design Studio to FactoryTalk Remote Access

Deploy a project to a controller

Go online or offline with a controller

Online and offline indicators in the Explorer pane

Monitor controller status

Select the controller mode

Add a VPN driver

Correct a controller application name mismatch

Instructions

Toolbox

Array concepts

Bit Overlay

Specify bits within arrays

Memory allocation for arrays

Data conversions

Math status flags

Immediate values

Index through arrays

Common Attributes

Bit Addressing

Data types

Elementary data types

Define a new Add-On Instruction

Floating Point Values

Updated instruction mnemonics

Duplicate destructive bit detection

Use duplicate destructive bit detection

Instruction set

Advanced Math Instructions

Log Base 10 (LOG)

Natural Log (LN)

X to the Power of Y (EXPT)

Array (File)/Misc Instructions

Copy File (COP), Synchronous Copy File (CPS)

File Arithmetic and Logic (FAL)

File Average (AVE)

File Fill (FLL)

File Search and Compare (FSC)

File Sort (SRT)

File Standard Deviation (STD)

Size In Elements (SIZE)

Array (File)/Shift Instructions

Bit Shift Left (BSL)

Bit Shift Right (BSR)

FIFO Load (FFL)

FIFO Unload (FFU)

LIFO Load (LFL)

LIFO Unload (LFU)

ASCII Conversion Instructions

Lower Case (LOWER)

REAL to String (RTOS)

DINT to String (DTOS)

String to DINT (STOD)

String to REAL (STOR)

Upper Case (UPPER)

ASCII String Instructions

Find String (FIND)

Insert String (INSERT)

Middle String (MID)

String Concatenate (CONCAT)

String Delete (DELETE)

Bit Instructions

Examine If Closed (XIC)

Examine If Open (XIO)

One Shot (ONS)

One Shot Falling (OSF)

One Shot Rising (OSR)

Output Energize (OTE)

Output Latch (OTL)

Output Unlatch (OTU)

Compare Instructions

Compare (CMP)

Equal To (EQ)

Greater Than (GT)

Greater Than or Equal To (GE)

Less Than (LT)

Less Than or Equal To (LE)

Limit (LIMIT)

Mask Equal To (MEQ)

Not Equal To (NE)

Valid Operators

What is zero fill?

Compute/Math Instructions

Absolute Value (ABS)

Add (ADD)

Compute (CPT)

Divide (DIV)

Modulo (MOD)

Multiply (MUL)

Negate (NEG)

Square Root (SQRT)

Subtract (SUB)

For/Break Instructions

Break (BRK)

For (FOR)

Math Conversion Instructions

Convert to BCD (TO_BCD)

Convert to Integer (BCD_TO)

Degrees (DEG)

Radian (RAD)

Truncate (TRUNC)

Move/Logical Instructions

Bit Field Distribute (BTD)

Bitwise And (AND)

Bitwise Exclusive Or (XOR)

Bitwise Inclusive Or (OR)

Bitwise Not (NOT)

Clear (CLR)

Masked Move (MVM)

Move (MOVE)

Swap Byte (SWPB)

Program Control Instructions

Always False (AFI)

JSR Flow Chart (True)

Jump to Label (JMP) and Label (LBL)

Jump to Subroutine (JSR), Subroutine (SBR), and Return (RET)

Master Control Reset (MCR)

MCR Flow Chart (False)

No Operation (NOP)

Temporary End (TND)

Trigger Event Task (EventTrigger)

User Interrupt Disable (UID)/User Interrupt Enable (UIE)

Special Instructions

Anti-reset Windup and Bumpless Transfer From Manual To Auto (PID)

Bumpless Restart (PID)

Cascading Loops (PID)

Controlling a Ratio (PID)

Data Transition (DTR)

Derivative Smoothing (PID)

Diagnostic Detect (DDT)

Feedforward or Output Biasing (PID)

File Bit Comparison (FBC)

Proportional Integral Derivative (PID)

PID Instruction Timing

Setting the Deadband (PID)

Using Output Limiting (PID)

Using PID Instructions

Sequencer Instructions

Sequencer Input (SQI)

Sequencer Load (SQL)

Sequencer Output (SQO)

Timer and Counter Instructions

Count Down (CTD)

Count Up (CTU)

Reset (RES)

Retentive Timer On (RTO)

Timer Off Delay (TOF)

Timer On Delay (TON)

Trigonometric Instructions

Arc Cosine (ACOS)

Arc Sine (ASIN)

Arc Tangent (ATAN)

Two-Argument Arctangent (ATAN2)

Cosine (COS)

Sine (SIN)

Tangent (TAN)

Code Editor Domain Specific Language Syntax

FactoryTalk Design Studio Project Source Code Syntax

Syntax rules

Keywords in syntax

Controller applications

File name extensions

Add comments in Code Editor

Smart Object syntax

Smart Object structure

Smart Object attributes

Smart Object properties

Specify unique Smart Object instance values

Override Smart Object elements

Device syntax

Device syntax guidelines

Device structure in a project

BusType object

Device definition

deviceCategory

timeSynch object

port object

physicalPort object

device tags

Controller example

Device example

Topology in a project

bus object

connections object

Data type syntax

Data type structure

Data type attributes

Data type properties

Data type members

Data type member structure

Data type member attributes

Data type member properties

Data type bit members

Data type member example

Data type guidelines

Data type examples

Task syntax

Task structure

Task attributes

Task properties

Task guidelines

Task example

Program syntax

Program structure

Program attributes

Program properties

Inline and external routines

Program guidelines

Program example

Ladder routine syntax

Ladder routine structure

Ladder routine attributes

Ladder routine elements

Ladder routine example

Rungs

Rung structure

Rung attributes

Rung guidelines

Branches

Branch structure

Add-On Instruction syntax

Add-On Instruction structure

Add-On Instruction elements

Add-On Instruction attributes

Add-On Instruction guidelines

Add-On Instruction examples

Routines in Add-On Instructions

Add-On Instruction routine structure

Add-On Instruction routine attributes

Add-On Instruction routine elements

Guidelines for routines in Add-On Instructions

Add-On Instruction routine examples

Local tags in Add-On Instructions

Local tag attributes

Controller-scoped tag syntax

Tag structure

Tag attributes

Tag qualifiers

Tag syntax guidelines

Tag syntax examples

Program parameter connection syntax

Parameter connection structure

Parameter connection guidelines

Parameter connection examples

Element scopes and references

Element scope definitions

Resolution of element references

Element reference formats

Neutral text for ladder instructions

Add-On Instruction syntax

This section describes the syntax for add-on instructions.

An add-on instruction component defines an add-on instruction.

Code Editor Domain Specific Language Syntax

Add-On Instruction structure

Add-On Instruction elements

Add-On Instruction attributes

Add-On Instruction guidelines

Add-On Instruction examples

Routines in Add-On Instructions

Local tags in Add-On Instructions

Provide Feedback

Have questions or feedback about this documentation? Please submit your feedback here.

Normal