Phase External Request (PXRQ)
This instruction applies to the Compact GuardLogix 5370 and Compact GuardLogix 5380, CompactLogix 5370, CompactLogix 5380, and CompactLogix 5480, ControlLogix 5570 and ControlLogix 5580, and GuardLogix 5570 and GuardLogix 5580 controllers.
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 phase program are not scheduled in the highest priority task.
FactoryTalk®
Batch software.
IMPORTANT:
When the PXRQ instruction is used in an
Equipment Sequence
, only the Download All (1000) request and the Upload All (2000) request are supported. All other PXRQ instruction requests are ignored.The PXRQ instruction sends a request to
FactoryTalk
Batch software.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.
Ladder Diagram
Function Block
This instruction is not available in function block.
Structured Text
PXRQ (Phase_Instruction, External_Request, Data_Value);
Operands
Ladder Diagram
Operand | Type | Format | Description |
---|---|---|---|
Phase Instruction | PHASE_INSTRUCTION | tag | Tag that controls the operation. |
External Request | request | enumeration value | Type of request. |
Data Value | DINT | array tag | Parameters of the request. |
Structured Text
The operands are the same as those for the Ladder Diagram PXRQ instruction.
PHASE_INSTRUCTION Data Type
If want to: | Then check or set this member: | Data type | Notes | |
---|---|---|---|---|
Determine if a false-to-true transition caused the instruction to execute | EN | BOOL | Refer to the timing diagram below. | |
Determine if the request failed | ER | BOOL | Refer to the timing diagram below. To diagnose the error, refer to the ERR and EXERR values. | |
Determine if the FactoryTalk Batch software completed its processing of the request | PC | BOOL | Refer to the timing diagram below. | |
Determine if the FactoryTalk Batch software is processing the request | IP | BOOL | Refer to the timing diagram below. | |
Determine if the instruction sent the request but FactoryTalk Batch software has not yet acknowledged it | WA | BOOL | Refer to the timing diagram below. WA also = 0 if:
| |
Cancel the request | ABORT | BOOL | To abort (cancel) the request, set the ABORT bit = 1. When the controller aborts the instruction:
| |
| ERR | INT | If ER = 1, the error code gives diagnostic information. To interpret the error code, see PXRQ Error Codes . | |
EXERR | INT | If ER = 1, the extended error code gives additional diagnostic information for some errors. To interpret the extended error code, see PXRQ Error Codes . | ||
Use one member for the various status bits of the tag | STATUS | DINT | For this member: | Use this bit: |
EN | 31 | |||
ER | 28 | |||
PC | 27 | |||
IP | 26 | |||
WA | 25 | |||
ABORT | 24 |
Timing Diagram
Guidelines for using the PXRQ Instruction
Guideline | Details |
---|---|
Make sure to use an array for the Data Values operand. | The Data Values operand requires a DINT array, even if the array contains only 1 element (that is, the data type is DINT[1]). |
In Ladder Diagram, condition the instruction to execute on a transition. | This is a transitional instruction. Each time the instruction executes, toggle the EnableIn from false to true |
In Structured Text, use a construct to condition the execution of the instruction. | When programming a PXRQ instruction in structured text, consider:
|
Configure the PXRQ Instruction
If you want to: | Then configure the PXRQ instruction as follows: | ||
---|---|---|---|
External request | Data Value Array Element | Value | |
Download all input parameters | Download Input Parameters | DINT[0] | 0 |
Download a single input parameter | Download Input Parameters | DINT[0] | parameter ID |
Download a range of input parameters | Download Input Parameters | DINT[0] | parameter ID of the first parameter |
DINT[1] | Number of parameters to download | ||
Download the input parameters configured for automatic download on start or transfer of control | Download Input Parameters Subset | DINT[0] | start = 1 transfer of control = 2 |
Download all output parameters | Download Output Parameter Limits | DINT[0] | 0 |
Download a single output parameter | Download Output Parameter Limits | DINT[0] | parameter ID |
Upload all reports | Upload Output Parameters | DINT[0] | 0 |
Upload a single report | Upload Output Parameters | DINT[0] | report ID |
Upload a range of reports | Upload Output Parameters | DINT[0] | report ID of the first report |
DINT[1] | Number of reports to download | ||
Upload the output parameters configured for automatic upload on terminal state or transfer of control | Upload Output Parameters Subset | DINT[0] | terminal = 1 transfer of control = 2 |
Send a message to an operator | Send Message to Operator | DINT[0] | message ID |
Clear a message from an operator | Clear Message to Operator | DINT[0] | 0 |
Acquire a resource | Acquire Resources | DINT[0] | equipment ID |
Upload the output parameters configured for automatic upload on terminal state or transfer of control | Upload Output Parameters Subset | DINT[0] | terminal = 1 transfer of control = 2 |
Send a message to an operator | Send Message to Operator | DINT[0] | message ID |
Clear a message from an operator | Clear Message to Operator | DINT[0] | 0 |
Acquire a resource | Acquire Resources | DINT[0] | equipment ID |
Acquire multiple resources | Acquire Resources | DINT[0] | equipment ID |
DINT[1] | equipment ID | ||
... | |||
Release a single resource | Release Resources | DINT[0] | equipment ID |
Release multiple resources | Release Resources | DINT[0] | equipment ID |
DINT[1] | equipment ID | ||
... | |||
Release all resources | Release Resources | DINT[0] | 0 |
Send a message (and optional data) to another phase | Send Message to Linked Phase | DINT[0] | message ID |
DINT[1] | Number of phases to receive message | ||
DINT[2] | Message Value | ||
DINT[3] | Message Value | ||
... | |||
Send a message (and optional data) to another phase and wait for the phase to receive the message | Send Message to Linked Phase and Wait | DINT[0] | message ID |
DINT[1] | Number of phases to receive message | ||
DINT[2] | Message Value | ||
DINT[3] | Message Value | ||
... | |||
Wait to receive a message from another phase | Receive Message From Linked Phase | DINT[0] | message ID |
DINT[1] | Message Value | ||
DINT[2] | Message Value | ||
... | |||
Cancel a message to another phase | Cancel Message to Linked Phase | DINT[0] | message ID |
Cancel all messages to another phase | Cancel Message to Linked Phase | DINT[0] | 0 |
Download customer's batch ID | Download Batch Data | DINT[0] | 1 |
DINT[1] | parameter ID in which to store the value | ||
Download unique batch ID | Download Batch Data | DINT[0] | 2 |
DINT[1] | parameter ID in which to store the value | ||
Download phase ID | Download Batch Data | DINT[0] | 3 |
DINT[1] | parameter ID in which to store the value | ||
Download recipe control versus manual phase control | Download Batch Data | DINT[0] | 4 |
DINT[1] | parameter ID in which to store the value | ||
Download current mode of the phase | Download Batch Data | DINT[0] | 5 |
DINT[1] | parameter ID in which to store the value | ||
Download the low limit of an input parameter | Download Batch Data | DINT[0] | 6 The input parameter tag stores the low limit. |
Download the high limit of an input parameter | Download Batch Data | DINT[0] | 7 The input parameter tag stores the high limit. |
Download the high limit of an input parameter | Download Batch Data | DINT[0] | 7 The input parameter tag stores the high limit. |
Download data about the container currently in use | Download Material Manager Data Container In Use | DINT[0] | 1 |
DINT[1] | Attribute ID (specify the single attribute) | ||
DINT[2] | Phase parameter ID (specify the parameter tag to download the value to) | ||
Download data about the current material inside the container currently in use | Download Material Manager Data Container In Use | DINT[0] | 2 |
DINT[1] | Attribute ID (specify the single attribute) | ||
DINT[2] | Phase parameter ID (specify the parameter tag to which to download the value) | ||
Download data about the current lot inside the container currently in use | Download Material Manager Data Container In Use | DINT[0] | 3 |
DINT[1] | Attribute ID (specify the single attribute) | ||
DINT[2] | Phase parameter ID (specify the parameter tag to which to download the value) | ||
Upload data about the container currently in use | Upload Material Manager Data Container In Use | DINT[0] | 1 |
DINT[1] | Attribute ID (specify the single attribute) | ||
DINT[2] | Phase parameter ID (specify the parameter tag from which to upload the value) | ||
Upload data about the current material inside the container currently in use | Upload Material Manager Data Container In Use | DINT[0] | 2 |
DINT[1] | Attribute ID (specify the single attribute) | ||
DINT[2] | Phase parameter ID (specify the parameter tag from which to upload the value) | ||
Upload data about the current lot inside the container currently in use | Upload Material Manager Data Container In Use | DINT[0] | 3 |
DINT[1] | Attribute ID (specify the single attribute) | ||
DINT[2] | Phase parameter ID (specify the parameter) | ||
Download the current binding's container priority | Download Container Binding Priority | DINT[0] | parameter ID in which to store the value |
Upload a new container priority for the current binding | Upload Container Binding Priority | DINT[0] | parameter ID that has value |
Download information regarding the availability of sufficient material | Download Sufficient Material | DINT[0] | parameter ID in which to store the value In the result value:
|
Generate a signature | Generate E Signature | DINT[0] | ID of the signature template |
DINT[1] | |||
Download material attribute | Download Material Manager Database Data | DINT[0] | 0 |
DINT[1] | Phase parameter ID (specify the parameter tag to which to download the value) | ||
DINT[2] | Material controller ID | ||
DINT[3] | Attribute ID (specify the single attribute) | ||
Download lot attribute | Download Material Manager Database Data | DINT[0] | 1 |
DINT[1] | Phase parameter ID (specify the parameter tag to which to download the value) | ||
DINT[2] | Material controller ID | ||
DINT[3] | Attribute ID (specify the single attribute) | ||
Download container attribute | Download Material Manager Database Data | DINT[0] | 3 |
DINT[1] | Phase parameter ID (specify the parameter tag to which to download the value) | ||
DINT[2] | Material controller ID | ||
DINT[3] | Attribute ID (specify the single attribute) | ||
Download container priority assignment | Download Material Manager Database Data | DINT[0] | 4 |
DINT[1] | Phase parameter ID (specify the parameter tag to which to download the value) | ||
DINT[2] | Material controller ID | ||
DINT[3] | Attribute ID (specify the single attribute) | ||
DINT[4] | |||
Upload material attribute | Upload Material Manager Database Data | DINT[0] | 5 |
DINT[1] | Phase report ID (specify the phase report tag from which to upload) | ||
DINT[2] | Material controller ID | ||
DINT[3] | Attribute ID (specify the single attribute) | ||
Upload lot attribute | Upload Material Manager Database Data | DINT[0] | 6 |
DINT[1] | Phase report ID (specify the phase report tag from which to upload) | ||
DINT[2] | Material controller ID | ||
DINT[3] | Attribute ID (specify the single attribute) | ||
Upload container attribute | Upload Material Manager Database Data | DINT[0] | 8 |
DINT[1] | Phase report ID (specify the phase report tag from which to upload) | ||
DINT[2] | Material controller ID | ||
DINT[3] | Attribute ID (specify the single attribute) | ||
Download container priority assignment | Download Material Manager Database Data | DINT[0] | 9 |
DINT[1] | Phase parameter ID (specify the parameter tag to which to download the value) | ||
DINT[2] | Material controller ID | ||
DINT[3] | Attribute ID (specify the single attribute) | ||
DINT[4] |
PXRQ Error Codes
ERR (hex) | EXERR (hex) | Description | Recommended Action |
---|---|---|---|
00 | 0000 | The PXRQ instruction was aborted before it sent the request to FactoryTalk Batch software.The PXRQ instruction sent to Sequence was aborted for one of these reasons:
| None |
01 | 0000 | The PXRQ instruction was aborted after it sent the request to FactoryTalk Batch software.The PXRQ instruction sent to Sequence was aborted because the abort set before PXRQ completed. | None |
02 | 0000 | Two or more PXRQ instructions executed at the same time using the same request type. | Limit execution to one PXRQ instruction at a time. |
03 | 0110 | Communication error. The request was not delivered because there is no subscriber to the phase. | Check that FactoryTalk Batch software is connected and running. |
0210 | Communication error. The request was not delivered because there is no connection to the Notify object. | ||
0410 | Communication error. Delivery failed. | ||
1020 | FactoryTalk Batch software is not attached to the phase. | ||
2020 | Communication error. This indicates that the subscription is delete pending. | ||
04 | 0002 | The FactoryTalk Batch software encountered an error while processing the request. | Check the connection and communication path to FactoryTalk Batch software. |
0003 | The PXRQ instruction contains an invalid value. | ||
0004 | FactoryTalk Batch software is not in the proper state to process the request. | ||
0005 | Two or more PXRQ instructions executed at the same time using different request types. | ||
0006 | Error storing to parameter tags at end of request processing. | ||
05 | 0000 | FactoryTalk Batch software received the request but passed back an invalid cookie. | Check the connection and communication path to FactoryTalk Batch software. |
06 | 0001 | PXRQ sent an invalid request type/parameter to External Sequencer: Acquire Resources passed too many data values (>=100). | |
002 | PXRQ sent an invalid request type/parameter to External Sequencer: Download Batch Data needs two parameters data values. | ||
0003 | PXRQ sent an invalid request type/parameter to External Sequencer: Download Batch Data, Download Material Track Data Container In Use: Batch Parameter out of range (0< <8). | ||
0004 | PXRQ sent an invalid request type/parameter to External Sequencer: Parameter Id out of range (0<= <=99). | ||
0005 | PXRQ sent an invalid request type/parameter to External Sequencer: Request type is not supported. | ||
07 | 0000 | Communication lost while PXRQ is waiting for response from the external sequencer. | Check the connection and communication path to FactoryTalk Batch software. |
08 | 0000 | The Execution State of the Equipment Phase associated Sequence Step is not Connected. | |
09 | 0000 | Un-supported request type send to Sequence. | |
0A | 0000 | Equipment Phase has no sequencing Input parameters defined. | |
0B | 0000 | Equipment Phase has no sequencing Output parameters defined. | |
0C | 0000 | Equipment Phase is overridden. | |
0D | 0000 | Sequence is not attached to Equipment Phase. | |
0E | 0000 | At least one of Sequence Step Input tag value is invalid. |
Affects Math Status Flags
No
Major/Minor Faults
None. See
Index Through Arrays
for operand-related faults.Execution
Condition/State | Action Taken |
---|---|
Prescan | No action taken. |
Postscan | No action taken. |
EnableIn is false | No action taken. |
EnableIn is true | The instruction executes. |
Example
Ladder Diagram
Structured Text
Provide Feedback