Attach to Equipment Sequence (SATT)

This instruction applies to the
Logix Designer
 5580 P-controllers. The
Logix Designer
 5580 P-controllers also support controller redundancy.
TIP:
When using this instruction with
ControlLogix
 redundancy system, outputs controlled by this instruction may not be bumpless during redundancy switchover, if the instruction and sequence program are not scheduled in the highest priority task.
WARNING:
When using redundancy with an
Equipment Sequence
, sequence execution may not be as expected after switchover if the phase and sequence are not scheduled on the same task.
Use the Attach to
Equipment Sequence
 (SATT) instruction to take ownership of an
Equipment Sequence
. An
Equipment Sequence
 may be commanded by a program if the program either owns the
Equipment Sequence
 or the
Equipment Sequence
 has no owners. A tag must be assigned to store the result code of an SATT instruction.
The SATT instruction returns one of five result codes. Result code 0 indicates that the SATT instruction ran successfully. The other four codes indicate that the instruction did not run successfully and provide additional information about the reason for the instruction failure.
This is a transitional instruction. Follow these steps when using it:
  • In ladder logic, insert an instruction to toggle the rung-condition-in from false to true each time the instruction should execute.
  • In a Structured Text routine, insert a condition for the instruction to cause it to execute only on a transition.
Available Languages
Ladder Diagram
L5K_SATT_LD_avail_v34
Function Block Diagram
This instruction is not available in function block.
Structured Text:
SATT(Sequence Name, Result)
Operands
Ladder Diagram
Operand
Data Type
Format
Description
Sequence Name
SEQUENCE
name of the
Equipment Sequence
Equipment Sequence
 that you want to change to own (attach) to command.
Result
DINT
Tag
For the instruction to return a success or failure code, enter a DINT tag where the result code is to be stored. Otherwise, enter 0.
Structured Text
The operands are the same as for the Ladder Diagram.
Guidelines for using the SATT Instruction
Guideline
Details
Remember that the
Logix Designer
 application overrides ownership of the
Equipment Sequence
.
Regardless of whether a program or
FactoryTalk Batch
 software owns an
Equipment Sequence
, the option exists to use
Logix Designer
 to override ownership and command the
Equipment Sequence
.
The
Equipment Sequence
 must be either owned by the program to command it or have no owners for the program to command it.
The ownership instructions are
Attach
(SATT) and
Detach
(SDET).
Internal Sequencers (programs), external sequencers (
FactoryTalk Batch
), and operators use an
Attach
command to command an
Equipment Sequence
.
When the
Equipment Sequence
 is done, relinquish ownership.
To relinquish ownership, use a Detach from
Equipment Sequence
 (SDET) instruction.
Avoid making unnecessary command requests if the
Equipment Sequence
 is generating sequence events.
Unnecessary command requests can flood the event processing buffers and cause you to miss significant events.
Use the
Result
code to verify ownership, and include steps that should take place if the attachment fails because the
Equipment Sequence
 is owned by another program or operator.
Use the
Result
operand to get a code that shows the success or failure of the SATT instruction.
On each execution, the SATT instruction tries to take ownership of the
Equipment Sequence
. When a program or operator owns an
Equipment Sequence
, another execution of the SATT instruction fails and produces result code 24582. When you use the SATT instruction, either:
  • Limit its execution to a single scan to avoid the 24582 result code
    • Include this in your conditions for ownership:
      result code = 24582
SATT Result Codes
Code (Dec)
Description
0
The command was successful.
24579
The
Equipment Sequence
 cannot be commended.
Logix Designer
 already owns the
Equipment Sequence
. The caller attached to the
Equipment Sequence
, but it is not the current commanding owner.
  • This program now also owns the
    Equipment Sequence
    .
    • Since the
      Logix Designer
       is a higher priority, the program cannot command the
      Equipment Sequence
      .
24582
The program already owns the
Equipment Sequence
.
24593
One of these already owns the
Equipment Sequence
.
  • An external Sequencer such as
    FactoryTalk Batch
     software.
    • Another program in the controller.
      • An HMI operator
24594
The
Equipment Sequence
 is unscheduled, inhibited, or in a task that is inhibited.
Affects Math Status Flags
No
Major/Minor Faults
None specific to this instruction. See Index Through Arrays[1] for operand related faults.
Execution
At instruction execution, the SATT instruction attempts to take ownership of the
Equipment Sequence
.
Ladder Diagram
Condition
Action Taken
Prescan
No action taken
Rung-condition-in is false
No action taken
Rung-condition-in is true
  • The instruction executes
  • The rung-condition-out is set to true
Postscan
No action taken
Structured Text
Condition
Action Taken
Prescan
No action taken
Rung-condition-in is false
No action taken
Rung-condition-in is true
The instruction executes
Postscan
No action taken
Example
L5K_LD_Example_SATT_v34
Structured Text
if (AttachControl) then
SATT(Make_Product_101, Result);
end_if
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.