Cat. Nos. 1203-GD1,
1203-GK1, or 1336-GM1
Firmware 1.xx – 4.xx
User Manual
Important User Information
Because of the variety of uses for the products described in this
publication, those responsible for the application and use of this
control equipment must satisfy themselves that all necessary steps
have been taken to assure that each application and use meets all
performance and safety requirements, including any applicable laws,
regulations, codes and standards.
The illustrations, charts, sample programs and layout examples
shown in this guide are intended solely for purposes of example.
Since there are many variables and requirements associated with any
particular installation, Rockwell Automation does not assume
responsibility or liability (to include intellectual property liability) for
actual use based upon the examples shown in this publication.
Rockwell Automation publication SGI-1.1, Safety Guidelines for the Application, Installation, and Maintenance of Solid-State Control
(available from your local Rockwell Automation office or online at
www.ab.com/manuals/gi), describes some important differences
between solid-state equipment and electromechanical devices that
should be taken into consideration when applying products such as
those described in this publication.
Reproduction of the contents of this copyrighted publication, in
whole or in part, without written permission of Rockwell
Automation, is prohibited.
Throughout this manual we use notes to make you aware of safety
considerations:
ATTENTION: Identifies information about practices
or circumstances that can lead to personal injury or
!
Attention statements help you to:
•Identify a hazard.
•Avoid the hazard.
•Recognize the consequences.
Important: Identifies information that is critical for successful
application and understanding of the product.
death, property damage or economic loss.
Summary of Changes
The information below summarizes the changes made to this manual
since the last release.
Updated Information
Updates and Additions
This manual incorporates the information found in the following two
manuals:
•Bulletin 1203 Remote I/O Communication Module Getting Started Manual, Publication 1203-5.1.
The information below summarizes the changes to this manual since
its last release:
PageDescription
2-5Important statement added:
Injury or equipment damage can result from loss of PLC or Controller Logic
Commands (Stop, Start, etc.) when all these conditions are true:
- module firmware 3.04 or lower.
- 230.4k baud rate.
- block transfer is enabled (DIP switch SW3-1 is ON).
- block transfers to the module are used (in the ladder program or by DriveTools/
DriveTools32 using a Remote I/O pass thru connection).
Do not use the 230.4k baud rate if you are using a module with 3.04 or earlier
firmware and your program uses block transfers. Use the 57.6k or 115.2k baud
rate instead.
2-6Attention statement added:
Due to an anomaly in firmware release 4.01, Remote I/O modules that are used
only for block transfer messages require the following configuration: switches for
block transfer and reference/feedback should both be enabled (SW 3.1 and SW
3.3 are ON. SW 3.2 and SW 3.4 through 3.8 are OFF).
This configuration prevents a fault on power up. It does not affect rack I/O
allocation or the ladder logic program because it still fits within 1/4 rack I/O space.
The drive will, however, generate a serial fault if the communications module is
disconnected or loses power.
Read this preface to familiarize yourself with the rest of the manual.
In this preface, you will read about the following:
•Intended audience for this manual.
•Purpose of this manual.
•Firmware supported by this manual.
•Terms and abbreviations.
•Safety precautions.
•Rockwell Automation support.
Use this manual if you are responsible for setting up and using a
Remote I/O communications module (Bulletin numbers 1203-GD1,
1203-GK1, or 1336-GM1). You must have previous experience with
and a basic understanding of communications terminology,
configuration procedures, required equipment, and safety precautions.
To use this Remote I/O communications module efficiently, you must
be able to program and operate programmable controllers as well as
have a basic understanding of the parameter settings and functions of
the SCANport™ product with which you are communicating.
Purpose of This Manual
Firmware Support
This manual is an installation and user guide for the Remote I/O
communications module. The 1203 Remote I/O communications
modules are available for products that include SCANport.
This manual provides the following information:
•An overview of the Remote I/O communications module.
•Procedures that you need to install, configure, and troubleshoot
the Remote I/O communications module.
•Example ladder logic programs for controlling a product and
using block transfer messages.
Important:
This manual supports firmware versions 1.xx to 4.xx (the “xx”
designator may vary). Features that work with specific firmware
versions will be identified.
You should read this manual in its entirety before
configuring, installing, operating, or troubleshooting the
Remote I/O communications module.
P–2Using This Manual
Contents of this Manual
ChapterTitleContents
PrefaceUsing This ManualDescriptions of the audience, purpose, back-
ground, and scope of this manual.
1OverviewFeatures of the Remote I/O communications
module.
2Configuring the ModuleProcedures for setting DIP switches.
3Installing the ModuleProcedures for mounting, connecting cables, and
connecting power.
4Creating Ladder Logic
Programs
5Using Block Transfer
Messages
6TroubleshootingInformation about troubleshooting the module.
ASpecificationsEnvironmental, electrical, and communication
BSupported Block Transfer
Messages
Information about addressing, information transfer, and sample programs.
Information about messaging and sample programs.
specifications.
Information about block transfer messages.
Related Documentation
You can obtain documentation about Allen-Bradley products,
including PLC controllers, SLC controllers, Logix5550 controllers,
and drives, from your local Rockwell Automation office or
distributor. You can also access documents online at
http://www.ab.com/manuals
Terms and Abbreviations
Application notes are available at
http://www.ab.com/drives/stddrives/faxback/faxback.htm
The following terms are specific to this product. For a complete
listing of automation terminology, refer to the Rockwell Automation Industrial Automation Glossary, Publication Number AG-7.1.
TermsDefinition
ControllerA solid-state control system that has a user-programmable memory for
storage of instructions to implement specific functions such
as I/O control, logic, timing, counting, report generation, communication, arithmetic, and data file manipulation. A controller is also called a
“programmable logic controller” or “processor.”
Remote I/OI/O connected to a processor across a serial link. With a serial link,
Remote I/O
Communications
Module
SCANportA standard peripheral communications interface for various
SCANport
Peripheral
SCANport
Product
remote I/O can be located long distances from the processor.
This module connects a SCANpor t product to a Remote I/O link. There
are three types of Remote I/O communications modules: 1203-GD1
module, 1203-GK1 module, and 1336-GM1 board. The Remote I/O
module is also referred to as “adapter,” “module,” and communications
module.”
Allen-Bradley drives and power products.
A device that provides an interface between SCANport and a commu-
nications system such as Remote I/O. It is often referred to as an
adapter or communications module. For example, the Remote I/O
module is a SCANport peripheral.
A device that uses the SCANport communications interface to communicate with one or more peripheral devices. For example, a motor drive
such as a 1336 PLUS is a SCANport product.
Safety Precautions
Using This ManualP–3
ATTENTION: Only personnel familiar with SCANport
!
!
!
devices and associated machinery should plan or implement
the installation, start-up, configuration, and subsequent
maintenance of the Remote I/O communications module.
Failure to comply may result in personal injury and/or
equipment damage.
ATTENTION: The 1336-GM1 board contains Electrostatic Discharge (ESD) sensitive parts and assemblies. Static
control precautions are required when handling this assembly. Component damage may result if ESD control procedures are not followed. If you are not familiar with static
control procedures, refer to Allen-Bradley Publication
8000-4.5.2, Guarding Against Electrostatic Damage or any
other applicable ESD protection handbook.
ATTENTION: Injury or equipment damage can result
from loss of PLC or Controller Logic Commands (Stop,
Start, etc.) when all these conditions are true:
•module firmware 3.04 or lower.
•230.4k baud rate.
•block transfer is enabled (DIP switch SW3-1 is ON).
•block transfers to the module are used (in the ladder
program or by DriveTools/DriveTools32 using a
Remote I/O pass thru connection).
Do not use the 230.4k baud rate if you are using a module
with 3.04 or earlier firmware and your program uses block
transfers. Use the 57.6k or 115.2k baud rate instead.
ATTENTION: Hazard of equipment damage exists. If
!
!
block transfer messages are programmed to frequently
write parameter data, the EEPROM (Non-Volatile Storage)
will quickly exceed its life cycle and cause the product to
malfunction. Do not create a program that frequently uses
block transfer messages to write parameter data to a
product. Datalinks do not write to the EEPROM and should
be used for frequently changed parameters.
ATTENTION: Hazard of equipment damage exits.
Firmware version 3.04 has the following anomaly: If DIP
Switch 2-5 is OFF (No Fault), the product remains in its last
state after a communications loss occurs no matter how DIP
Switch 2-4 is set. If you must use zero data, contact
Rockwell Automation Technical Support.
P–4Using This Manual
Rockwell Automation Support
Rockwell Automation offers support services worldwide, with more
than 75 sales/support offices, more than 500 authorized distributors,
and more than 250 authorized systems integrators located throughout
the United States alone. In addition, Rockwell Automation
representatives are in every major country in the world.
Local Product Support
Contact your local Rockwell Automation representative for:
•Sales and order support.
•Product technical training.
•Warranty support.
•Support service agreements.
Technical Product Support
If you need to contact Rockwell Automation for technical assistance,
please call your local Rockwell Automation representative.
Overview
Chapter
1
Chapter Objectives
Description of the Remote I/O
Communications Modules
Chapter 1 provides an overview of the Remote I/O communications
module (1203-GD1 module, 1203-GK1 module, and 1336-GM1
board). In this chapter, you will read about the following:
•Function of the module.
•Features of the module.
•Compatible SCANport products and programmable controllers.
•Parts and hardware of the module.
•Steps for setting up the module.
•Required tools and equipment.
The Remote I/O communications module is an optional interface
designed to provide a direct, digital link between an Allen-Bradley
programmable controller and any one Allen-Bradley SCANport
product. A module is required for each product that you want to
connect to Remote I/O. There are three types of Remote I/O
communications modules:
Catalog NumberEnclosureRequired Power Supply
1203-GD1NEMA Type 185 – 264V AC
1203-GK1NEMA Type 124V DC +/- 10%
1336-GM1Open Drive Supplied
1203-GD1 Module
and
1203-GK1 Module
Figure 1.1Module and Board
1336-GM1 Board
1–2Overview
The 1203-GD1 and 1203-GK1 modules mount on a DIN rail. They
connect to a SCANport product using a SCANport cable and to the
Remote I/O link using a Remote I/O cable. The 1336-GM1 board
mounts directly onto selected SCANport products. It connects to a
SCANport product using an internal SCANport connector and to the
Remote I/O link using a Remote I/O cable.
Figure 1.2 shows how the modules connect SCANport products to the
Remote I/O link.
Figure 1.2Remote I/O Link with Remote I/O Communications Modules
Features of the
Communications Module
PLC-51305 DriveSMC
1203-GD1
Remote I/O Link
The 1203-GD1 module, 1203-GK1 module, and 1336-GM1 board let
you connect SCANport products to Remote I/O links and devices.
These modules feature the following:
•DIP switches let you configure how the Remote I/O module
operates before connecting it to the link.
•User-configurable fault action DIP switches let you customize the
module actions when communication errors occur.
•LEDs report link, module, and SCANport product health.
•Datalinks are supported in the module. Datalinks are a SCANport
mechanism for transferring information between a controller and
SCANport device. Each enabled datalink uses two words in the
I/O image table unless it is truncated.
PLUS Drive
1336-
GM1
1203-GK1
Overview1–3
Compatibility
SCANport Products
Remote I/O modules are compatible with many SCANport products,
including the following:
Number of
Peripherals
Product
1305 AC MICRO Drive
1336 IMPACT™ Drive6
1336 PLUS AC Drive6
1336 PLUS II Drive6
1336 FORCE™ Drive6
1336 REGEN Line Regeneration Package202
1336 SPIDER Drive6
1394 AC Mult-Axis Motion Control System508YesNo
SMC Dialog Plus™102
SMP-3 Smart Motor Protector202
1397 Digital DC Drive508YesNo
1557 Medium Voltage Drive508YesNo
2364F Regenerative DC Bus Supply Unit 608YesNo
The Remote I/O modules are compatible with 1305 drives using firmware release 2.xx or greater.
➀
Lower horsepower products may not support a sixth peripheral. To connect multiple peripherals to a SCANport product, a port expander may be required. Refer to
➁
the product user manual to verify that it supports a sixth peripheral.
Many SCANport products support 10 words of I/O (Command/Logic, Speed Reference, and four datalinks). Remote I/O, however, supports only 8 words of I/O.
➂
Drive must be B-frame or larger. If it is a 1336 FORCE drive, it must use a standard adapter board.
➃
Datalinks are not supported by this product.
➄
➀
Supported
508YesNo
➁
➁
➁
➁
➁
I/O WordsModule Use
1203-GD1 or
MinimumMaximum
08YesYes
08YesYes
08YesYes
08YesYes
08YesYes
➂
1203-GK11336-GM1
➃
➃
➃
➄
➄
➄
Ye sN o
Ye sN o
Ye sN o
If you intend to use datalinks to communicate with and control your
SCANport product, verify that your SCANport product supports
datalinks before enabling them in the module.
Controllers
This Remote I/O communications module is compatible with many
programmable controllers, including the following:
•Logix5550
•PLC-2/30
•PLC-3
•PLC Classic Family, including the PLC-5/10 (only with 1771-SN
in Discrete Mode), PLC-5/15
•PLC Enhanced family, including the PLC-5/20
PLC-5/40
PLC-5/60L
•PLC-5/250
•PLC scanner modules and subscanners
•SLC 500
®
with SD2 (module version 1.02 or later)
®
™
, PLC-5/25™ family
™
, PLC-5/40L™, PLC-5/60™,
™
family, PLC-5/80
™
™
with 1747-SN scanner
™
™
, PLC-5/30,
1–4Overview
Hardware Description
The hardware included with the module depends on the module that
you have.
1203-GD1 and 1203-GK1 Modules
The 1203-GD1 module and 1203-GK1 module share the same parts.
Figure 1.3 illustrates these parts.
Figure 1.3Parts of the 1203-GD1 and 1203-GK1 Module
1
2
3
4
6
5
#PartDescription
1SCANport ConnectionStandard SCANport 8-pin mini-DIN connector for the
SCANport cable.
2Power Supply ConnectionsConnections for the power supply. Multiple connec-
The 1203-GK1 module uses 24V DC.
3Remote I/O ConnectionStandard 3-pin Remote I/O connector.
4LEDsStatus indicators for the module, SCANport connec-
tion, and Remote I/O connection. Refer to Chapter 6.
5DIP SwitchesSwitches used to configure the module. Refer to
6DIN Rail MountMount for securely attaching and electrically ground-
Not
Remote I/O connectorOne 3-pin connector for connecting the Remote I/O
Shown
Not
Termination ResistorsTwo termination resistors for terminating the I/O link at
Shown
Chapter 2.
ing the module to a DIN rail.
cable to the module.
its physical ends. Refer to Chapter 3.
Overview1–5
1336-GM1 Board Hardware
Figure 1.4 illustrates the main parts of a 1336-GM1 board.
Figure 1.4Parts of the 1336-GM1 Board
4
3
2
1
#PartDescription
1SCANport ConnectionInternal 14-pin female SCANport connector.
2Remote I/O ConnectionStandard 3-pin Remote I/O connector.
3LEDsStatus indicators for the module, SCANport connection,
4DIP SwitchesSwitches used to configure the module. Refer to
Not
KitMaterials for mounting the board to the SCANport prod-
Shown
and Remote I/O connection. Refer to Chapter 6.
Chapter 2.
uct. These material include one grounding wrist strap,
four Phillips mounting screws, four stand-off nylon headers, one 3-pin Remote I/O connector, one snap-in comm
housing with mounting instructions, and termination
resistors.
1–6Overview
Required Tools and Equipment
The tools and equipment required, depend on if you are using a
1203-GD1 module, 1203-GK1 module, or 1336-GM1 board.
1203-GD1 or 1203-GK1 Module
To install and configure a 1203-GD1 module or 1203-GK1 module,
you need the following:
•Remote I/O communications module (1203-GD1 or 1203-GK1).
•35 x 7.5 mm DIN rail.
•Termination resistor(s).
•Power source.
•1/8" flathead screwdriver.
•Appropriate cables for SCANport and Remote I/O connections.
Refer to Chapter 3.
•Software such as RSLogix5, RSLogix500, or RSLogix5000 for
programming the controller.
1336-GM1 Board
To install and configure a 1336-GM1 board, you need the following:
•Remote I/O communications board (1336-GM1).
•A kit that includes one grounding wrist strap, four Phillips
mounting screws, four stand-off nylon headers, one 3-pin
connector, and one snap-in comm housing with mounting
instructions (supplied with board).
•#1 Phillips screwdriver.
•Appropriate cable for the Remote I/O connection. Refer to
Chapter 3.
•Software such as RSLogix5, RSLogix500, or RSLogix5000 for
programming the controller.
Overview of Setting Up the
Module
To set up the Remote I/O communications module, you must perform
the following tasks:
1. Read the safety precautions in this manual.
2. Configure the module using the DIP switches. Refer to Chapter 2.
3. Install the module or mount the board. Refer to Chapter 3.
4. Create a ladder logic program to control the SCANport product
(Chapter 4) or send messages to it (Chapter 5).
Configuring the Module
Chapter
2
Chapter Objectives
Safety Precautions and
Important Information
Chapter 2 provides instructions and information for configuring the
Remote I/O communications module (1203-GD1, 1203-GK1, or
1336-GM1). In this chapter, you will read about the following:
•Factory-default settings.
•Recording the I/O image table.
•Configuring the module.
Important:
Please observe the following safety precautions:
!
!
The communications module is not compatible with
complementary I/O configurations because it uses both
output and input image words for proper product control.
ATTENTION: Hazard of equipment damage exists. When
you make changes to the switch settings, use a blunt, pointed
instrument. Do not use a pencil or pen.
ATTENTION: Hazard of injury or equipment damage
exists. Failure to check connections and switch settings for
compatibility with your application could result in
unintended or undesirable operation. Verify the
configuration is correct for your application.
!
Important:
ATTENTION: Hazard of injury or equipment damage
exists. Unintended or incorrect machine motion can result
from the initial configuration. When a system is configured
for the first time, the motor must be disconnected from the
machine or process during initial system testing.
Due to an anomaly in firmware release 4.01, Remote I/O
modules that are used only for block transfer messages
require the following configuration: switches for block
transfer and reference/feedback should both be enabled
(SW 3.1 and SW 3.3 are ON. SW 3.2 and SW 3.4 through
3.8 are OFF).
This configuration prevents a fault on power up. It does not
affect rack I/O allocation or the ladder logic program
because it still fits within 1/4 rack I/O space. The drive will,
however, generate a serial fault if the communications
module is disconnected or loses power.
2–2Configuring the Module
Locating the DIP Switches
SW3.1 = Block Transfer
SW3.2 = Logic Command/Status
SW3.3 = Reference/Feedback
SW3.4 = Datalink A Settings
SW3.5 = Datalink B Settings
SW3.6 = Datalink C Settings
SW3.7 – Datalink D Settings
SW3.8 = Truncate Last Datalink
Figure 2.1Switches on the 1203-GD1 and 1203-GK1 Modules
SW2.1 – SW2.2 = Starting Module Group
SW2.3 = Last Rack Setting
SW2.4 = Hold Last State/Zero Data
SW2.5 = Communications Loss
SW2.6 = Reset/Program/Test
SW2.7 – SW2.8 = RIO Baud Rate
Bottom View
SW1.1 – SW1.2 = Not Used
SW1.3 – SW1.8 = Rack Address
= Open = Off = 0
= Closed = On = 1
SW3.1 = Block Transfer
SW3.2 = Logic Command/Status
SW3.3 = Reference/Feedback
SW3.4 = Datalink A Settings
SW3.5 = Datalink B Settings
SW3.6 = Datalink C Settings
SW3.7 – Datalink D Settings
SW3.8 = Truncate Last Datalink
Figure 2.2Switches on the 1336-GM1 Board
SW2.1 – SW2.2 = Starting Module Group
SW2.3 = Last Rack Setting
SW2.4 = Hold Last State/Zero Data
SW2.5 = Communications Loss
SW2.6 = Reset/Program/Test
SW2.7 – SW2.8 = RIO Baud Rate
8
8
1
SW1.1 – SW1.2 = Not Used
SW1.3 – SW1.8 = Rack Address
8
1
1
= Open = Off = 0
= Closed = On = 1
Front View
Configuring the Module2–3
Factory-Default Settings
Quick Configuration
The module is shipped with the following settings:
FeatureSwitch(es) Default Setting
Block Transfer3.1Enabled
Logic Command/Status3.2Enabled
Reference/Feedback3.3Enabled
Datalinks3.4 – 3.7Datalinks A and B are Enabled
Datalinks C and D are Disabled
Truncate Last Datalink3.8Disabled
Starting Group2.1 – 2.20
Last Rack2.3Not Last Rack
Fault Action2.4 – 2.6Fault on communications loss
Baud Rate2.7 – 2.857.6K
Not Used1.1 – 1.2Not Used
Rack Address1.3 – 1.82
Hold last state on reset/program/test
For detailed switch information, refer to pages 2–4 through 2–13.
SwitchSetting Description
3.101Disable block transfer
Off = 0
On = 1
Off = 0
On = 1
Off = 0
On = 1
3.201Disable Logic Command/Status
3.301Disable Reference/Feedback
3.401Disable Datalink A (A1 and A2)
3.501Disable Datalink B (B1 and B2)
3.601Disable Datalink C (C1 and C2)
3.701Disable Datalink D (D1 and D2)
3.801Disable truncate last datalink
2.1 – 2.2 2.2
1
0
1
0
2.301Not last rack
2.401Hold last state
2.501No fault. Use action of switch 2.4
2.601No fault. Use action of switch 2.4
2.7 – 2.8 2.8
0
0
1
1.1 – 1.2Not Used
1.3 – 1.8 VariesSee “Setting the Rack Address” on
Enable block transfer
Enable Logic Command/Status
Enable Reference/Feedback
Enable Datalink A (A1 and A2)
Enable Datalink B (B1 and B2)
Enable Datalink C (C1 and C2)
Enable Datalink D (D1 and D2)
Enable truncate last datalink
2.1
1
Starting group 0
1
Starting group 2
0
Starting group 4
0
Starting group 6
Last rack with this address
Zero data
Fault drive on communications loss
Fault drive on Reset/Program/Test
2.7
0
57.6 kbps
1
115.2 kbps
0
230.4 kbps
page 2-13
2–4Configuring the Module
Configuring the module
As you configure your module, you should complete the I/O image
table. First, size the I/O using switch SW3. Next, set the rack address
using switch SW1. Finally, select the starting group, last rack setting,
fault action, and baud rate using switch SW2. For more information
on the I/O image table, refer to the example below and Chapter 4.
I/O Image Table
Remote
I/O
Address
Reserved For:Minimum
Required
Rack Size
1/4 Rack0, 2, 4, or 6
1/2 Rack0, 2, or 4
3/4 Rack0 or 2
Full Rack0 only
Starting
GroupOutput ImageInput Image
Example I/O Image Table
In this example, we use the factory-default settings. We use rack 2,
and record it as our address. Because we are using a full rack, we use
starting group 0, so block transfer starts at word 0.
Remote
I/O
Address
020Block TransferBlock Transfer1/4 Rack0, 2, 4, or 6
021Logic CommandLogic Status
022ReferenceFeedback1/2 Rack0, 2, or 4
023Datalink ADatalink A
024Datalink ADatalink A3/4 Rack0 or 2
025Datalink BDatalink B
026Datalink BDatalink BFull Rack0 only
027
Reserved For:Minimum
Required
Rack Size
Starting
GroupOutput ImageInput Image
Switch
Off = 0
On = 1
Off = 0
On = 1
Off = 0
On = 1
Settings
8 ---> 1Description
00011111Block transfer is enabled.
Logic command/status is enabled.
Reference/feedback is enabled.
Datalink A is enabled.
Datalink B is enabled.
Truncate last datalink is disabled.
00011011Starting group is 0.
This is not the last rack.
Drive will fault when communications
are disrupted, and it will hold last state
when the controller is placed in
program/reset/test.
Remote I/O baud rate is 57.6K.
10111100Rack address is 2.
Setting Switches on SW3
ATTENTION: Injury or equipment damage can result
!
from loss of PLC or Controller Logic Commands (Stop,
Start, etc.) when all these conditions are true:
•module firmware 3.04 or lower.
•230.4k baud rate.
•block transfer is enabled (DIP switch SW3-1 is ON).
•block transfers to the module are used (in the ladder
program or by DriveTools/DriveTools32 using a
Remote I/O pass thru connection).
Do not use the 230.4k baud rate if you are using a module
with 3.04 or earlier firmware and your program uses block
transfers. Use the 57.6k or 115.2k baud rate instead.
Setting Block Transfer
Configuring the Module2–5
SW 3.1 enables or disables block transfer. Enable block transfer if
you are using messages (refer to Chapter 5) in your ladder logic
program or if you are using DriveTools32 software.
Important:
You cannot use both messages and DriveTools32 software
at the same time.
Block transfer uses the first module group (word) in the rack and
group.
Figure 2.3Block Transfer Switch
Off = 0
On = 1
Use SW 3.1 for setting the
block transfer
To edit the block transfer setting, you need to:
1. Refer to the following table to determine the setting for SW 3.1:
Block TransferSW 3.1
Disabled0
Enabled1
2. Slide the switch to its appropriate position.
3. If Block Transfer is enabled, record “Block Transfer” in the first
module group (word) of your I/O image table on page 2–4.
Settings take effect when a module or board first receives power.
When you change a setting, you must remove and then reapply power
for the new setting to take effect.
2–6Configuring the Module
Important:
Due to an anomaly in firmware release 4.01, Remote I/O
modules that are used only for block transfer messages
require the following configuration: switches for block
transfer and reference/feedback should both be enabled
(SW 3.1 and SW 3.3 are ON. SW 3.2 and SW 3.4 through
3.8 are OFF).
This configuration prevents a fault on power up. It does
not affect rack I/O allocation or the ladder logic program
because it still fits within 1/4 rack I/O space. The drive will,
however, generate a serial fault if the communications
module is disconnected or loses power.
Setting Logic Command and Status
SW 3.2 enables or disables the word used for logic command and
status (e.g., start, stop, direction). Logic command/status uses one
word in the rack and group.
Figure 2.4Logic Command/Status Switches
Off = 0
On = 1
Use SW 3.2 for setting logic/
status word.
To edit the command/status setting, you need to:
1. Refer to the following table to determine the setting for SW 3.2:
Command I/OSW 3.2
Disabled0
Enabled1
2. Slide the switch to its appropriate position.
3. If Logic Command/Status is enabled, record “Logic Cmd” in the
first available module group (word) of the output column and
“Logic Sts” in the first available module group (word) of the
input column of your I/O image table on page 2–4.
Settings take effect when a module or board first receives power.
When you change a setting, you must remove and then reapply power
for the new setting to take effect.
Setting the Reference and Feedback
SW 3.3 enables or disables the word used for reference and feedback
(e.g., speed reference, torque reference). Reference/feedback uses one
word in the rack and group.
Configuring the Module2–7
Figure 2.5Reference/Feedback Switch
Off = 0
On = 1
Use SW 3.3 for setting the
command I/O
To edit the reference/feedback setting, you need to:
1. Refer to the following table to determine the setting for SW 3.3:
Reference/FeedbackSW 3.3
Disabled0
Enabled1
2. Slide the switch to its appropriate position.
3. If Reference/Feedback is enabled, record “Reference” in the first
available module group (word) of the output column and
“Feedback” in the first available module group (word) of the
input column of your I/O image table on page 2–4.
Settings take effect when a module or board first receives power.
When you change a setting, you must remove and then reapply power
for the new setting to take effect.
2–8Configuring the Module
Setting Datalinks
SW 3.7 through SW 3.4 enable or disable datalinks. A datalink is a
type of pointer used by some SCANport products to transfer data to
and from a controller. You can use datalinks to change or monitor the
value of parameters without using block transfer messages. Each
datalink consists of two 16-bit words of input and two 16-bit words of
output. You can enable up to four datalinks (eight words in and out).
Refer to Chapter 4 for detailed datalink information and examples.
Figure 2.6Datalink Switches
Off = 0
On = 1
Use SW 3.7 through SW 3.4 for
setting the datalinks.
Important:
Ensure that datalinks are supported and enabled in the
SCANport product before you enable them in the Remote
I/O module. You do not have to use datalinks. If you do
use them, remember that a datalink in a drive can be used
by only one communications module. Datalinks do not
write to the EEPROM.
To edit the datalinks, you need to:
1. Refer to the following table to determine the settings for SW 3.7
through SW 3.4:
Datalink D
Function
Disable0000
Enable1111
SW 3.7
Datalink C
SW 3.6
Datalink B
SW 3.5
Datalink A
SW 3.4
2. Slide the switches to their appropriate positions.
3. For each enabled datalink, record “Datalink [A, B, C, or D]” in
the first two available module groups (words) of the output and
input columns of your I/O image table on page 2–4.
Settings take effect when a module or board first receives power.
When you change a setting, you must remove and then reapply power
for the new setting to take effect.
Setting the Truncate Last Datalink Feature
SW 3.8 enables or disables the truncate last datalink feature. All
datalinks are two words. If this feature is enabled, the second word of
the last datalink is deleted. For example, if datalinks A and B are
enabled and this feature is enabled, Data In B2 and Data Out B2 are
truncated. This feature can save rack space by maintaining an even
number of words in your rack.
Important:
This feature is available only on modules with firmware
1.02 or later.
Configuring the Module2–9
Figure 2.7Truncate Last Datalink Switch
Off = 0
On = 1
Use SW 3.8 for truncating the
last datalink.
To set the truncate last datalink feature, you need to:
1. Refer to the following table to determine the setting for SW 3.8:
Duplicate Message DetectionSW 3.8
Disable0
Enable1
2. Slide the switch to its appropriate position.
3. If the switch is enabled, cross out the second module group
(word) of the last datalink in your I/O image table on page 2–4.
Settings take effect when a module or board first receives power.
When you change a setting, you must remove and then reapply power
for the new setting to take effect.
Setting Switches on SW2
Setting the Starting Group
SW 2.2 and SW 2.1 set the starting group. A starting group is the
word in a rack at which the group starts. The starting group depends
on the rack size. To determine the starting group, you must set the
switches on SW3 and calculate the rack size. A full rack is 8 words.
For example, if we enabled the switches for Logic Command/Status,
Reference/Feedback, and datalink A, we use 4 words in the rack, so
we need a 1/2 rack. Using the table below as a guide, we could set the
starting group for word 0, 2, or 4 for our example.
Figure 2.8Starting Group Switches
Off = 0
On = 1
Use SW 2.2 and SW 2.1
for setting the starting group.
To edit the starting group, you need to:
1. Refer to the following table to determine starting groups that you
can use:
Rack SizeStarting Group
1/40, 2, 4, or 6
1/20, 2, or 4
3/40 or 2
Full0
2–10Configuring the Module
2. Refer to the following table to set SW 2.2 and SW 2.1:
Starting Group SW 2.2SW 2.1
011
201
410
600
3. Slide the switches to their appropriate positions.
Settings take effect when a module or board first receives power.
When you change a setting, you must remove and then reapply power
for the new setting to take effect.
Setting the Last Rack Switch
SW 2.3 lets you notify a controller that the connected product is the
last device with this rack address. You must set this switch if a
product is the last device with this rack address and you are using a
PLC-2 controller. It is recommended that you set this switch when
you are using other controllers.
Figure 2.9Last Rack Switch
Off = 0
On = 1
Use SW2.3 for setting the
last rack.
To edit the last rack settings, you need to:
1. Refer to the following table to determine the switch setting for
SW 2.3:
SettingSW2.3
Not Last Rack0
Last Rack1
2. Slide the switch to its appropriate position.
Settings take effect when a module or board first receives power.
When you change a setting, you must remove and then reapply power
for the new setting to take effect.
Configuring the Module2–11
Setting the Fault Action
SW 2.6 through SW 2.4 let you configure how a Remote I/O module
and connected product act when Remote I/O communications fail
(e.g., disconnected cable) or the controller is switched to program or
test mode. You can use fault, hold last state, or zero data. If you select
hold last state, a product continues in its present state after a
communications disruption. If you select zero data, the data output to
the product is zeroed. Zero data does not command a stop.
ATTENTION: Risk of bodily injury or equipment damage
!
!
exists. These switches allow the user to change the default
configuration that would fault the drive if communication
is lost. Precautions should be taken to ensure that settings
for these switches do not create a hazard of bodily injury or
equipment damage.
ATTENTION: Hazard of equipment damage exits.
Firmware version 3.04 has the following anomaly: If DIP
Switch 2.5 is OFF (No Fault), the product remains in its last
state after a communications loss occurs no matter how DIP
Switch 2.4 is set. If you must use zero data, contact
Rockwell Automation Technical Support.
Figure 2.10Fault Action Configuration Switches
Off = 0
On = 1
Use SW 2.6 through SW 2.4
for setting the fault action.
To change the fault action, you need to:
1. Refer to the following table to determine the setting for SW 2.6:
Fault on Reset/Program/TestSW 2.6
No Fault0
Fault Product1
Important:
Switch SW 2.6 is active only on modules with
firmware 2.xx and later
2. Refer to the following table to determine the setting for SW 2.5:
Fault on Communications LossSW 2.5
No Fault0
Fault Product1
3. If you set SW 2.6 or SW 2.5 to 0 (No Fault), set SW 2.4 to select
an action when a condition that normally causes a drive fault
occurs:
FunctionSW 2.4
Hold last state0
Zero data1
2–12Configuring the Module
4. Slide the switches to their appropriate positions.
Settings take effect when a module or board first receives power.
When you change a setting, you must remove and then reapply power
for the new setting to take effect.
Setting the Remote I/O Baud Rate
SW 2.8 and SW 2.7 set the baud rate at which the Remote I/O module
communicates.
ATTENTION: Injury or equipment damage can result
!
from loss of PLC or Controller Logic Commands (Stop,
Start, etc.) when all these conditions are true:
•module firmware 3.04 or lower.
•230.4k baud rate.
•block transfer is enabled (DIP switch SW3.1 ON).
•block transfers to the module are used (in the ladder
program or by DriveTools/DriveTools32 using a
Remote I/O pass thru connection).
Do not use the 230.4k baud rate if your module firmware
is 3.04 or earlier and if your program uses block transfers.
Use the 57.6k or 115.2k baud rate instead.
Figure 2.11Remote I/O Baud Rate Switches
Off = 0
On = 1
Use SW 2.8 and SW 2.7 for setting
the baud rate.
To change the baud rate, you need to:
1. Refer to the following table to determine settings for SW2.8 and
SW2.7:
Baud RateSwitch 2.8SW2.7
57.6 K00
115.2 K01
230.4 K10
2. Slide the switches to their appropriate positions.
Settings take effect when a module or board first receives power.
When you change a setting, you must remove and then reapply power
for the new setting to take effect.
Configuring the Module2–13
Setting Switches on SW1
Setting the Rack Address
DIP switches 8 through 3 on SW 1 set the rack address for the
Remote I/O module. Each Remote I/O device must have a rack
address that the controller can recognize. Each rack contains 8 words.
Important:
When using a PLC-2 family processor, add 1 to the rack
number set on the Remote I/O module DIP switches to
your PLC code. The PLC-2 cannot have a Remote I/O rack
numbered zero, so add a value of one to the rack number
value when writing your PLC code.
Figure 2.12Rack Address Switches
Off = 0
On = 1
Use DIP switches 8 through 3 on SW1
for setting the module address.
To edit the rack address, you need to:
1. Refer to the following table to determine the settings for SW1.8
Not all controllers support all of these node addresses.
Refer to the documentation for your controller. The
maximum number of devices on a Remote I/O link is 32.
2. Slide the switches to their appropriate positions.
Settings take effect when a module or board first receives power.
When you change a setting, you must remove and then reapply power
for the new setting to take effect.
2–14Configuring the Module
Installing the Module
Chapter
3
Chapter Objectives
Selecting Cables
Chapter 3 provides the information that you need to install the
module (1203-GD1 module, 1203-GK1 module, or 1336-GM1
board). In this chapter, you will read about the following:
•Selecting cables.
•Selecting a termination resistor.
•Installing a 1203-GD1 or 1203-GK1 module.
•Installing a 1336-GM1 board.
Refer to the following table to determine the required cables:
If Installing:Required Cables
1203-GD1, 1203-GK1SCANport and Remote I/O
1336-GM1Remote I/O
SCANport Cables
When selecting the SCANport cable to connect a module to the
SCANport product, you need to:
•Use an Allen-Bradley SCANport cable. Refer to the table below:
Male to Male ConnectionMale to Female Connection
LengthCatalog NumberLengthCatalog Number
Cables with male to female connections are generally used as extension cables.
➀
•Use 10 meters (33 feet) or less of cable between the SCANport
product and all peripherals.
•Keep SCANport cables away from high power cables to guard
against introducing noise into your system.
Important:
SCANport cables lock into a connection. To remove a
SCANport cable, you must push it in and then pull it out.
3–2Installing the Module
Remote I/O Cables
Remote I/O communications modules are connected to Remote I/O
links with twinaxial cable used for Remote I/O and Data Highway
Plus (DH+) communications. When selecting a cable, remember the
following:
•Only 1770-CD Belden #9463 is tested and approved for RIO and
DH+ installations. Using other cables is at your own risk.
•The total cable length depends on the baud rate that you are
using. Refer to the following table:
Baud RateMaximum Length
57.6 K3,048 m (10,000 ft)
115.2 K1524 m (5,000 ft)
230.4 K762 m (2,500 ft)
•All three of the following conductors must be connected at each
node.
ColorDescription
Blue1
ShieldSH
Clear2
Selecting a Termination
Resistor
•Do not use a star topology. Only two cables may be connected at
any wiring point. You can use a series topology and daisy-chain
two wires at a point.
You must terminate both ends of a Remote I/O link to ensure proper
operation. This termination is required only at the ends of the
physical cable. Each Remote I/O link should have exactly two
termination resistors.
If the device that you connect is an end device on the Remote I/O
link, it must be terminated. Refer to the following table to select a
resistor.
Important:
You must use an 82 ohm external termination resistor if
the link is operating at 230.4 kbps.
DeviceDescription
Programmable Controller Refer to its manual.
1336-GM1
(Using Jumpers)
1203-GD1, 1203-GK1, or
1336-GM1
(Using an external termi-
nation resistor)
Set J2 in position 1-2 for termination and 2-3 for no termination.
Refer to Figure 3.8. The jumper enables a 150 ohm resistor
Connect a resistor between terminals 1 and 2 on the Remote I/O
connector. Refer to Figure 3.4.
Use an 82 ohm termination resistor unless a device requires a
150 ohm termination resistor
➀
.
➀
.
➀
The following scanners require 150 ohm termination resistors on the RIO link: 1771-SN, 1772-SD,
1772-SD2, 1775-SR, 1775-S4A, 1775-S4B, 6008-SQH1, and 6008-SQH.
The following adapters require a 150 ohm termination resistors on the RIO link: 1771-AS, 1772-ASB
(Series A), 1771-DCM.
The following devices require a 150 ohm termination resistors on the RIO link: 1771-AF.
Installing the Module3–3
Installing a 1203-GD1 or
1203-GK1 Module
Required Tools and Equipment
To install your module, you need the following tools and equipment:
•Remote I/O communications module (1203-GD1 or 1203-GK1).
•35 x 7.5 mm DIN rail.
•Appropriate cables for SCANport and Remote I/O connections.
Refer to the “Selecting Cables” section in this chapter.
•Termination resistor (if necessary). Refer to the “Selecting a
Termination Resistor” section in this chapter.
•115 V/230 V AC or 24 V DC power supply.
Installing the 1203-GD1 or 1203-GK1 Module
1. Remove power from the Remote I/O link.
2. Hook the top lip of the module DIN rail mount onto the top of the
DIN rail and then rotate the module onto the DIN rail. It snaps
into a locked position.
Figure 3.1Mounting a Module onto the DIN Rail
3–4Installing the Module
3. Connect a SCANport cable (1202-Cxx) to a module and product.
Important:
For the location of the SCANport connector on your
product, refer to its user manual. If you are using a port
expander, refer to its documentation.
Figure 3.2Connecting the SCANport Cable
SCANport Product
.
Module
Blue
Shield
Clear
4. Connect a Remote I/O cable to the module and link or controller.
Figure 3.3Connecting the Remote I/O Cable
PLC Controller
.
1
SH
2
Module
.
.
Clear
Shield
Blue
SH
2
1
Installing the Module3–5
5. If the module is the last device on the Remote I/O link, connect
the termination resistor. If the Remote I/O link uses 230Kbps,
you must use an 82 ohm termination resistor.
Figure 3.4Connecting the Termination Resistor
6. Connect the power supply to the module.
Figure 3.5Connecting the Power Supply
1203-GD1 Module
To
Another Remote I/O
Link Device
Clear
Shield
Blue
2
Sh
1
1203-GK1 Module
I50 Ohm
or
82 Ohm
1 watt
+/-10%
Hi 115V/230V AC
Low 115V/230V AC
GND
L
N
G
24V DC
Supply
+
-
GND
7. Apply power to the Remote I/O link. The module is now
installed. Its LEDs are as follows:
LEDStatus
FaultRed (Blinking)
SCANport STSGreen or amber
HealthGreen or amber
➀ ➁
➁
Rem I/O ACTOff
Rem I/O STSOff
➀
This LED is off if the module use firmware 2.xx or lower.
➁
Early versions of the module use amber LEDs.
You are now ready to create a ladder logic program.
Important:
If your LEDs are different, refer to Chapter 6.
+
G
3–6Installing the Module
Installing a 1336-GM1 Board
Required Tools and Equipment
To install your 1336-GM1 board, you need the following tools and
equipment:
•Remote I/O communications board (1336-GM1).
•A kit that includes one grounding wrist strap, four Phillips
mounting screws, four stand-off nylon headers, and one snap-in
comm housing with mounting instructions (supplied with board).
•#1 Phillips screwdriver.
•Appropriate cable for the Remote I/O connection. Refer to the
“Selecting Cables” section in this chapter.
Installing the 1336-GM1 Communications Board
The following instructions explain how to physically install a Remote
I/O communications board.
ATTENTION: The 1336-GM1 communications board
!
contains ESD (Electrostatic Discharge) sensitive parts.
Static control precautions are required when installing, testing, or servicing this board. Device malfunction may occur
if you do not follow ESD control procedures. If you are not
familiar with static control procedures, refer to Rockwell
Automation Publication 8000-4.5.2, Guarding Against Electrostatic Damage, or other applicable ESD protection
handbook.
ATTENTION: Remove all power from the SCANport
!
Important:
1. Remove power from the SCANport product, and verify that it is
2. Remove power from the Remote I/O link.
3. Put on the grounding wrist strap.
product before installing the 1336-GM1 board. Failure to
disconnect power may result in death or serious injury. Verify all power is removed before installing the 1336-GM1
board.
If you are attaching the communications board to a 1336
PLUS II, refer to the one-page insert included with the kit
for mounting instructions.
not holding power.
Installing the Module3–7
4. Screw the four stand-off nylon headers into the appropriate
spaces on the drive main control board.
Figure 3.6Mounting the Open Style Communications Board
5. Insert the SCANport connector into the 14-pin SCANport header
on the control board. The DIP switches should be facing you.
6. Screw the board securely into place, being careful not to
overtighten the four screws.
7. Connect the Remote I/O cable.
Figure 3.7Connecting the Remote I/O Cable
PLC Controller
.
.
Blue
Shield
Clear
Blue
Shield
Clear
SH
1
2
J4
1
SH
2
.
SCANport Product
.
1336-GM1
Board
3–8Installing the Module
8. If the module is the last device on the Remote I/O link, either user
the internal termination resistor (J2) or an external termination
resistor. If the Remote I/O link uses 230Kbps, you must use an
external 82 ohm termination resistor.
Blue
Shield
Clear
To
Another
Remote I/O
Link Device
External Termination
1
Sh
2
I50 Ohm
or
82 Ohm
1 watt
+/-10%
Important:
Use only one type of termination (internal or external),
Figure 3.8Using a Termination Resistor
123
J2
Not Last Device,
(Factory Default)
Last Device on link,
Termination
Resistor Inserted
Enables 150 ohm
Termination Resistor
123
123
Internal Termination
9. Reapply power to the SCANport product.
10. Apply power to the Remote I/O link. The module is now
installed. Its LEDs are as follows:
LEDStatus
FaultRed (Blinking)
SCANport STSGreen or amber
HealthGreen or amber
➀ ➁
➁
Rem I/O ACTOff
Rem I/O STSOff
➀
This LED is off if the module use firmware 2.xx or lower.
➁ Early versions of the module use amber LEDs.
You are now ready to create a ladder logic program.
Important:
If your LEDs are different, refer to Chapter 6.
Chapter
Creating Ladder Logic Programs
4
Chapter Objectives
Chapter 4 provides information about ladder logic programs for
products connected to a Remote I/O communications module. In this
chapter, you will read about the following:
•I/O image table.
•Control Features.
•Datalinks.
•Example ladder logic programs for PLC, SLC, and Logix5550
controllers.
ATTENTION: When you configure a system for the first
!
!
time, you should disconnect the motor from the machine or
the process during the initial testing.
ATTENTION: The configurations and program examples
shown in this manual are intended solely for purposes of
example. Since there are many variables and requirements
associated with any particular installation, Rockwell Automation does not assume responsibility or liability (to include intellectual property liability) for actual use based
upon the examples shown in this publication.
Understanding the I/O Image
Tab le
The Remote I/O communications module allows a SCANport product
to look and act like a Remote I/O chassis when connected to a
programmable controller. Data contained in the input/output image
table is transferred between the programmable controller by the
Remote I/O scanner, the same as with any Remote I/O chassis. You
control the location of data transferred by setting the rack address and
starting group. You control the amount of data by setting the DIP
switches on SW3.
Important:
Important:
The communications module does not scale the data that
is transferred. Consequently, all scaling of the data must
be done in the controller. Refer to the user manual for your
SCANport product for details on device units.
The Remote I/O to SCANport conversion is asynchronous.
Data sent to the adapter for transfer to the drive must be
maintained until the drive has received data.
4–2Creating Ladder Logic Programs
DIP switches on SW3 determine how the data contained in the
programmable controller I/O image table is used in the drive. Figure
4.1 shows an I/O image table.
Figure 4.1I/O Image Table
Remote I/OSCANport
8 words maximum
8 words maximum
Controller
Image
Output Image
O:010
O:011
O:012
O:013
O:014
O:015
O:016
O:017
Input Image
I:010
I:011
I:012
I:013
I:014
I:015
I:016
I:017
1
Optionally enabled using DIP switches on the module. Refer to Chapter 2.
Message Handler
Logic Command
Reference
Data In A1
Data In A2
Data In B1
Data In B2
Data In C1
Data In C2
Data In D1
Data In D2
Message Handler
Logic Status
Feedback
Data Out A1
Data Out A2
Data Out B1
Data Out B2
Data Out C1
Data Out C2
Data Out D1
Data Out D2
Control Features
Datalinks
SW 3.1 through SW 3.3 select the basic control features: Block
Transfer, Logic Command/Status, and Reference/Feedback. When
enabled, each of these features adds one word to the input I/O image
table and one word to the output I/O image table.
SW 3.4 through SW 3.8 enable or disable the datalinks.
Description
A datalink is a type of pointer used by some SCANport products to
transfer data to and from the controller. Datalinks allow a parameter
value to be changed without using a block transfer message. When
enabled, each datalink consumes two 16-bit words in both the input
and output image table of the controller. When SW3.8 is ON, the last
datalink is truncated so that it uses only one word in the input and
output image table.
Creating Ladder Logic Programs4–3
Products That Support Datalinks
To use datalinks, your SCANport product must support them. Refer
to your product user manual.
Using Datalinks
The following are the rules for using datalinks:
•Normally, each enabled datalink reserves two words in both the
input and output image tables of the controller. This increases
your I/O image size. The starting module group on the module
must be set to support the size of the I/O image table. Truncation
can be used to minimize the required rack size used by the
Remote I/O module. Refer to Chapter 2.
•Each set of datalink parameters in a SCANport product can be
used by only one communications module. If more than one
module is connected to a single SCANport product, they must not
attempt to use the same datalink.
•Parameter settings in the SCANport product determine the data
passed through the datalink mechanism. Refer to the user manual
for your SCANport product for more information.
•When you use a datalink to change a value, the value is not
written to the EEPROM. The value is stored in volatile memory
and lost when the drive loses power.
•The 1336 FORCE and 1336 IMPACT drives use datalinks in a
special way. Refer to their user manuals for information.
Example Application 1
The simplest application of datalinks is to set a parameter number
into a Data In parameter. The controller output image table word
connected to this datalink will then control the value of the parameter
set into the Data In parameter.
For example, to change the value of parameter 27 in a 1336 PLUS
drive, you need to:
1. In the 1336 PLUS drive, set parameter 111 (Data In A1) to 27.
2. On the communications module, slide SW 3.4 to ON. See Figure
2.6.
3. If your communications module is configured like Figure 4.1,
word 3 (fourth word) in the output image will be the value that
parameter 27 uses. This value is stored in volatile memory and
lost when the drive loses power.
4–4Creating Ladder Logic Programs
Example Application 2
Another application for datalinks is to set a parameter into a Data Out
parameter. The controller input image table word connected to this
datalink will then receive the value of the parameter programmed into
the Data Out parameter.
For example, to monitor the value of parameter 27 in a 1336 PLUS
drive, you need to:
1. In the 1336 PLUS drive, set parameter 119 (Data Out A1) to 27.
2. On the module, slide SW 3.4 to ON. See Figure 2.6.
3. If your communications module is configured like Figure 4.1,
Example Application 3
A third application for datalinks is to change multiple parameters
with only two datalinks enabled. During each scan, this application
changes a parameter and then verifies that it has been changed.
word 3 (fourth word) in the input image would receive the value
of parameter 27.
For example, to change parameters 27, 28, and 29 in a 1336 PLUS
drive, you need to:
1. In the 1336 PLUS drive, set the following parameters:
Parameter:Setting
111 (Data In A1)112
119 (Data Out A1)112
113 (Data In B1)120
2. On the module, slide SW 3.4 and SW 3.5 to ON to enable
datalinks A and B (See Figure 2.6). Slide the other DIP switches
on SW3 to OFF.
A parameter number must be moved or copied into word 0 (first
word) and word 2 (third word) of the output image for each scan.
The new parameter value must be moved or copied into word 1
(second word) of the output image. In our example, we move the
following data into the input image table:
ScanWord 0 and 2Word 1Description
127123Parameter 27 will be set to 123.
228456Parameter 28 will be set to 456.
329789Parameter 29 will be set to 789.
A successful scan yields the following results in word 0 and 1 in
the input image table:
ScanWord 0Word 1Description
127123Parameter 27 has been set to 123.
228456Parameter 28 has been set to 456.
329789Parameter 29 has been set to 789.
Logic can be developed for the controller that uses the values in
word 0 (first word) and word 1 (second word) of the input image
to verify that the change was completed successfully.
Creating Ladder Logic Programs4–5
Figure 4.2 illustrates the first scan in Example Application 3.
Message Handler
Logic Command
Reference
P111 (Data In A1) = Sends "27" to P112
P112 (Data In A2) = Sends "123" to P27
P113 (Data In B1) = Sends "27" to P120
P114 (Data In B2)
P115 (Data In C1)
P116 (Data In C2)
P117 (Data In D1)
P118 (Data In D2)
Message Handler
Logic Status
Feedback
P119 (Data Out A1) = Gets "27" from P112
P120 (Data Out A2) = Gets "123" from P27
P121 (Data Out B1)
P122 (Data Out B2)
P123 (Data Out C1)
P124 (Data Out C2)
P125 (Data Out D1)
P126 (Data Out D2)
Settings for the Ladder Logic
Program Examples
The example ladder logic programs in this manual use the following
settings.
Remote I/O Communications Module Settings
The Remote I/O module used for examples in this manual is
connected to a 1336 PLUS drive. It is configured for the following:
•Rack Address = 2
•Rack Size = 1/2 Rack
•Starting Group = 0
DIP switches on SW3 are set as follows:
Settings
Switch
Off = 0
On = 1
8 ---> 1Description
00001110 Logic command/status, reference/
feedback, and datalink A are enabled. All
other features are disabled.
4–6Creating Ladder Logic Programs
SCANport Product Settings
Logic Command bits
In our example, we are using a 1336 PLUS drive. The Logic
Command bits for it are:
The 1305 drives, 1336 PLUS II drives, and 1336 Spider drives use the
same Logic Command and Logic Status data. For other drives, refer
to their user manuals.
Creating Ladder Logic Programs4–7
Logic Status Bits
The Logic Status bits for the 1336 PLUS drive that we use in our
example are as follows:
Logic Status Bits
FunctionDescription1514131211109876543210
XEnabled1=Enabled, 0=Not Enabled
XRunning1=Running, 0=Not Running
XCommand
Direction
XRotating Direction1=Forward, 0=Reverse
XAcceleration1=Accelerating, 0=Not
XDeceleration1=Decelerating, 0=Not
XWarning1=Warning Present, 0=Not
XFault1=Faulted, 0=Not Faulted
XAt Speed1=At Speed, 0=Not At Speed
XXXLocal000=Terminal I/O has Local
XXXXReference Source0000=External Reference 1
1=Forward, 0=Reverse
001=Port 1 has Local
010=Port 2 has Local
011=Port 3 has Local
100=Port 4 has Local
101=Port 5 has Local
110=Port 6 has Local
111=Multiplexed Control
The 1305 drives, 1336 PLUS II drives, and 1336 Spider drives use the
same Logic Command and Logic Status data. For other drives, refer
to their user manuals.
4–8Creating Ladder Logic Programs
<
<
<
<
Example PLC Ladder Logic
Program
Machine
START
Pushbutton
0000
0001
0002
0003
0004
0005
0006
0007
I:000
Machine
JOG
Pushbutton
I:000
Machine
Clear Faults
Pushbutton
I:000
Drive
Running
Status Bit
I:020
Drive
Faulted
Status Bit
I:020
Refer to page 4–5 for the settings of the module and the 1336 PLUS
drive used for this example.
Figure 4.3Example Ladder Logic Program for a PLC
0
Machine
STOP
Pushbutton
I:000
1
Drive
STOP
Command
O:020
0
2
3
1
7
Drive
Running
Status Bit
I:020
1
Drive
START
Command
O:020
1
Drive
STOP
Command
O:020
0
Drive Frequency
Command
MOV
MOV
Move
SourceN7:0
DestO:021
Drive
Clear Faults
Command
Drive Data In A1
(Data to Drive)
MOV
MOV
Move
SourceN7:1
DestO:022
16000
16000
Drive
JOG
Command
O:020
2
O:020
3
Machine
Running
Indicator
O:000
0
Machine
Faulted
Indicator
O:000
1
500
500
0008
END
Creating Ladder Logic Programs4–9
About the PLC Ladder Logic Program
RungDescription
0001When the machine Start push button is pressed, the PLC sends a START
command to the drive. The drive will start if no STOP command is being sent
by the PLC or any other control device. (Start button is a normally open
contact in this example.) SCANport products will start only if the start bit
transitions high while the stop bit is already low.
The address (O:020) is determined by the rack and starting group settings
on the module. In the example, we use rack 02 and starting group module
word 0.
0002When the machine Stop push button is pressed, the PLC sends a STOP
command to the drive. (Stop button is normally closed contact in this
example)
0003A frequency command is transferred from the PLC data table to the drive. A
0004When the machine Jog button is pressed, the PLC will send a JOG
0005When the machine Clear Faults push button is pressed, the PLC sends a
0006When the drive is running, the PLC will receive a Drive Running status bit.
0007When the drive is faulted, the PLC will receive a Drive Faulted status bit.
0008A value is moved from the PLC data table into the drive parameter specified
range of 0 to 32767 is equivalent to zero to maximum frequency. (In this
example, the drive frequency select parameters are set to receive a
frequency reference from the Remote I/O module.)
command to the drive. The drive will start and run at the programmed jog
frequency if no STOP command is being sent by the PLC or other control
device. (Jog button is normally open contact in this example.)
CLEAR FAULTS command to the drive. (Clear Faults button is a momentary
normally open contact in this example.)
by the Data In A1 parameter in the drive.
4–10Creating Ladder Logic Programs
MOV
<
<
<
<
Example SLC Ladder Logic
Program
Machine
START
Pushbutton
0000
0001
0002
0003
0004
0005
0006
0007
I:1
1747-SN
Machine
STOP
Pushbutton
Drive
STOP
Command
Machine
JOG
Pushbutton
I:1
1747-SN
Machine
Clear Faults
Pushbutton
I:1
1747-SN
Drive
Running
Status Bit
I:1
1747-SN
Drive
Faulted
Status Bit
I:1
1747-SN
128
I:1
129
1747-SN
O:1
256
1747-SN
130
131
257
263
Refer to page 4–5 for the settings of the module and the 1336 PLUS
drive used for this example.
Figure 4.4Example Ladder Logic Program for an SLC
Drive
START
Command
O:1
257
1747-SN
Drive
STOP
Command
O:1
256
Drive
Running
Status Bit
I:1
257
1747-SN
Drive Frequency
Command
MOV
Move
Drive Data In A1
SourceN7:0
DestO:1.17
(Data to Drive)
MOV
MOV
Move
SourceN7:1
DestO:1.18
1747-SN
16000
16000
Drive
JOG
Command
O:1
258
1747-SN
Drive
Clear Faults
Command
O:1
259
1747-SN
Machine
Running
Indicator
O:1
129
1747-SN
Machine
Faulted
Indicator
O:1
135
1747-SN
500
500
0008
END
Creating Ladder Logic Programs4–11
About the SLC Ladder Logic Program
RungDescription
0001When the machine Start push button is pressed, the SLC sends a START
command to the drive. The drive will start if no STOP command is being sent
by the SLC or any other control device. (Start button is a normally open
contact in this example.) SCANport products will start only if the start bit
transitions high while the stop bit is already low.
The address (O:1) is determined by the slot and word. It is displayed as a
continuous bit number. In the example, we use rack 02 and starting group
module word 0.
0002When the machine Stop push button is pressed, the SLC sends a STOP
command to the drive. (Stop button is normally closed contact in this
example)
0003A frequency command is transferred from the SLC data table to the drive. A
0004When the machine Jog button is pressed, the SLC will send a JOG
0005When the machine Clear Faults push button is pressed, the PLC sends a
0006When the drive is running, the SLC will receive a Drive Running status bit.
0007When the drive is faulted, the SLC will receive a Drive Faulted status bit.
0008A value is moved from the SLC data table into the drive parameter specified
range of 0 to 32767 is equivalent to zero to maximum frequency. (In this
example, the drive frequency select parameters are set to receive a
frequency reference from the Remote I/O module.)
command to the drive. The drive will start and run at the programmed jog
frequency if no STOP command is being sent by the SLC or other control
device. (Jog button is normally open contact in this example.)
CLEAR FAULTS command to the drive. (Clear Faults button is a momentary
normally open contact in this example.)
by the Data In A1 parameter in the drive.
About the SLC Display
When you are creating an SLC ladder logic program, you can display
information by slot and bit or by slot, word, and bit.
Figure 4.5SLC Displays
Drive
START
Command
O:1.16
1
1747-SN
slot = 1
bit = 257
Drive
START
Command
O:1
257
1747-SN
slot = 1
word = 16
bit = 1
4–12Creating Ladder Logic Programs
Example Logix5550 Ladder
Logic Program
0
1
2Move
3
4
5
6
7Move
Refer to page 4–5 for the settings of the module and the 1336 PLUS
drive used for this example.
Figure 4.6Example Ladder Logic Program for a Logix5550
Machine
Start
Pushbutton
Local:2:I.Data.1
Machine
Stop
Pushbutton
Local:2:I.Data.0
Drive
STOP
Command
Bit
PLUS_IO:O.Data[1].0
Machine
JOG
Pushbutton
Local:2:I.Data.2
Machine
CLEAR
FAULTS
Pushbutton
Local:2:I.Data.3
Drive
RUNNING
Status
Bit
PLUS_IO:I.Data[1].1
Drive
FAULTED
Status
Bit
PLUS_IO:I.Data[1].7
Drive
RUNNING
Status
Bit
PLUS_IO:I.Data[1].1
Frequency
Reference
SourceReference
0
DestPLUS_IO:O.Data[2]
2#0000_0000_0000_0000
Frequency
Feedback
Source PLUS_IO:I.Data[2]
2#0000_0000_0000_0000
DestFeedback
0
Drive
START
Command
Bit
PLUS_IO:O.Data[1].1
Drive
STOP
Command
Bit
PLUS_IO:O.Data[1].0
Drive
MOV
Drive
JOG
Command
Bit
PLUS_IO:O.Data[1].2
Drive
CLEAR
FAULTS
Command
Bit
PLUS_IO:O.Data[1].3
Machine
RUNNING
Indicator
Local:3:O.Data.0
Machine
FAULTED
Status
Local:3:O.Data.1
Drive
MOV
Lamp
Bit
(End)
Creating Ladder Logic Programs4–13
About the Logix5550 Ladder Logic Program
RungDescription
0001When the machine Start push button is pressed, the Logix5550 sends a START
command to the drive. The drive will start if no STOP command is being sent
by the Logix5550 or any other control device. (Start button is a normally open
contact in this example.) SCANport products will start only if the start bit
transitions high while the stop bit is already low.
In the example, we use rack 02 and starting group module word 0. The tags are
configured to represent this address.
0002When the machine Stop push button is pressed, the Logix5550 sends a STOP
0003A frequency command is transferred from the Logix5550 data table to the drive.
0004When the machine Jog button is pressed, the Logix5550 will send a JOG
0005When the machine Clear Faults push button is pressed, the Logix5550 sends a
0006When the drive is running, the Logix5550 will receive a Drive Running status
0007When the drive is faulted, the Logix5550 will receive a Drive Faulted status bit.
0008A value is moved from the Logix5550 data table into the drive parameter
command to the drive. (Stop button is normally closed contact in this example)
A range of 0 to 32767 is equivalent to zero to maximum frequency. (In this
example, the drive frequency select parameters are set to receive a frequency
reference from the Remote I/O module.)
command to the drive. The drive will start and run at the programmed jog
frequency if no STOP command is being sent by the Logix5550 or other control
device. (Jog button is normally open contact in this example.)
CLEAR FAULTS command to the drive. (Clear Faults button is a momentary
normally open contact in this example.)
bit.
specified by the Data In A1 parameter in the drive.
4–14Creating Ladder Logic Programs
End of Chapter 4
Chapter
Using Block Transfer Messages
5
Chapter Objectives
Chapter 5 provides information about Block Transfer messages. In
this chapter, you will read about the following:
•General information on block transfers.
•The Remote I/O status word.
•Data storage.
•Example ladder logic programs using Block Transfer messages.
ATTENTION: The sample programs and block transfer
!
!
examples shown in this manual are intended solely for purposes of example. Since there are many variables and requirements associated with any particular installation,
Rockwell Automation does not assume responsibility or liability (to include intellectual property liability) for actual
use based upon the examples shown in this publication.
ATTENTION: Hazard of equipment damage exists. If
block transfer messages are programmed to frequently
write parameter data, the EEPROM (Non-Volatile Storage)
will quickly exceed its life cycle and cause the product to
malfunction. Do not create a program that frequently uses
block transfer messages to write parameter data to a
product. Datalinks do not write to the EEPROM and should
be used for frequently changed parameters.
Understanding Block Transfer
Discrete transfer is the method used by a controller to transfer data to
and from the module during every rack scan. The module transfers
this data to and from the SCANport product.
Block transfer is the method used by a controller to transfer data that
does not require continuous updates. To perform this function, the
module provides a status word to the controller during the normal
discrete transfer scan. This status word occupies the first module
group (word) in the I/O image table for the designated rack
(communications module). The status word is then used by the ladder
program to control the controller Block Transfer Write (BTW) and
Block Transfer Read (BTR) functions.
Important:
The Remote I/O communications module does not scale
or manipulate data that is transferred between the
controller and SCANport product. The data in the
controller must be converted to device units before being
sent to the SCANport product.
5–2Using Block Transfer Messages
Understanding the Block
Transfer Status Word
Bit 16
Bit 15 Bit 14 Bit 13 Bit12 Bit 11 Bit 10
The block transfer status word is returned from the Remote I/O
module. It is the first word associated with the rack in the controller
input image table. This status word indicates the condition of the
Remote I/O module itself and is not part of the standard block transfer
instructions in the ladder program. Figure 5.1 details the individual
bits.
Figure 5.1Remote I/O Status Word
Bit 6
Bit 7
StatusDescription
Block Transfer
Ready
Block Transfer
Write in
Progress
Block Transfer
Read Available
Block Transfer
Wait
Block Transfer
Error
Block Transfer
Write Available
Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0Bit 17
Reserved for future use.
Block Transfer Ready (BT_READY)
Block Transfer Write in Progress (BTW_IN_PROG)
Block Transfer Read Available (BTR_AVAIL)
Block Transfer Wait (BT_WAIT)
Block Transfer Error (BT_ERROR)
Block Transfer Write Available (BTW_AVAIL)
Reserved for future use.
Reserved for future use.
The SCANport product and Remote I/O module are communicating and are
ready to process block transfers.
A block transfer write is in progress between the controller and Remote I/O
module. This bit is cleared when the data transfer to the module is complete.
The Remote I/O module has data available for the controller to read.
The Remote I/O module is communicating with the SCANport product. This
bit is cleared when the data transfer between the module and SCANport
product is complete.
An error has occurred during communications with the SCANpor t product, or
the BTW data is invalid.
The Remote I/O module is ready to receive a Block Transfer Write.
BT Write Available
Status Bit 15
BT Wait
Status Bit 13
BT Read Data Available
Status Bit 12
BT Write In Progress
Status Bit 11
Figure 5.2Bit Timing
BTW
Request
BTW data at
Remote I/O Module
BTW
Complete
BTR
Request
Using Block Transfer Messages5–3
Understanding Data Storage
Example PLC Block Transfers
This rung performs a Block Transfer Write to the 1203-GD1 at Rack Address 1, Starting Group 0
(the Module number is always 0 with these adapters). The data instructs the adapter to send a SCANport message.
When this message has completed, the response can be read with a BTR.
User
Logic
0000
B3:0
In order to use the block transfer instructions in the ladder program, it
is necessary to reserve several words for data storage. Some of these
words are required for internal use by the block transfer function, and
some contain the block transfer message information. Refer to
Appendix B for detailed information on the required data in data files
for different block transfer messages.
Figure 5.3 and Figure 5.4 are examples of block transfer
programming from PLC controllers to a Remote I/O communications
module. The BTW_AVAIL and BTR_AVAIL bits from the module
status word (I:010 in these examples) are used in these examples. The
examples also show how user logic can be used to enable or disable
the block transfer operations.
Figure 5.3Example for a PLC-5/15 or PLC-5/25
BTW
Available
I:010
0
BTR
Available
I:010
15
12
BTW
BTW
Block Transfer Write
Module Type Generic Block Transfer
Rack001
Group0
Module0
Control BlockN11:0
Data FileN12:0
Length64
ContinuousNo
EN
DN
ER
This rung performs a Block Transfer Read from the 1203-GD1 at Rack Address 1, Starting Group 0
(the Module number is always 0 with these adapters). The response contains the data read from the SCANport
Product (as instructed by the previous BTW).
BTR
0001
0002
Available
I:010
12
BTR
BTR
Block Transfer Read
Module Type Generic Block Transfer
Rack001
Group0
Module0
Control BlockN11:5
Data FileN12:70
Length64
ContinuousNo
EN
DN
ER
END
5–4Using Block Transfer Messages
Figure 5.4Example for a PLC-5/20, PLC-5/40, PLC-5/60, PLC-5/80
This rung performs a Block Transfer Write to the 1203-GD1 at Rack Address 1, Starting Group 0
(the Module number is always 0 with these adatpers). The data instructs the adapter to send a SCANport message.
When this message has completed, the response can be read with a BTR.
User
Logic
0000
B3:0
This rung performs a Block Transfer Read from the 1203-GD1 at Rack Address 1, Starting Group 0
(the Module number is always 0 with these adapters). The response contains the data read from the SCANport Product
(as instructed by the previous BTW).
BTR
Available
0001
0
I:010
12
BTW
Available
I:010
BTR
Available
I:010
15
12
BTW
BTW
Block Transfer Write
Module Type Generic Block Transfer
Rack001
Group0
Module0
Control BlockBT11:0
Data FileN12:0
Length64
ContinuousNo
BTR
BTR
Block Transfer Read
Module Type Generic Block Transfer
Rack001
Group0
Module0
Control BlockBT11:1
Data FileN12:70
Length64
ContinuousNo
EN
DN
ER
EN
DN
ER
0002
END
The following table defines the contents of the example PLC block
transfer messages (Figure 5.3 and Figure 5.4).
ContentDescription
RackThe rack address is determined by the switch settings on the Remote I/O module. (Refer to
Chapter 2.)
In Figure 5.3 and Figure 5.4, rack address 1 is used.
GroupThe group number is the first group in the rack associated with the Remote I/O module. This
ModuleThe module number is associated with the block transfer in the associated slot. This will
Control
Block
Data FileThe data file is the address of the message sent by the BTW or received by the BTR block. It
LengthLength specifies the length of the block transfer message in words. It varies depending on the
Continuous Continuous specifies whether the block transfer block is to be executed continuously or only
is called the starting group. It is determined by the size of the rack. (Refer to Chapter 2.)
In Figure 5.3, the rack has been set up as a full 8 group rack; therefore, the starting group 0 is
used.
always be 0.
The control block is a predefined set of words that contain bit information associated with the
block transfer function. In the PLC-5/15 and PLC-5/25, the control block requires 5
contiguous words. In the PLC 5/40 and 5/60 the control block may be either an integer type,
and would require 5 contiguous words, or a block transfer type and would require 1 element.
In Figure 5.3, words N11:0 through N11:4 have been reserved for the bit array in the BTW
block. Words N11:5 through N11:9 have been reserved for the BTR block.
In Figure 5.4, element BT11:0 has been reserved for the bit array in the BTW block. Element
BT11:1 has been reserved for the BTR block.
contains both header and data information. The number of words required for the data file is
dependent on the type of message being sent. Refer to Appendix B for information regarding
the header and data that must be included in the data file for each message.
In Figure 5.3 and Figure 5.4, N12:0 is the first word in the data file for the BTW block and
N12:70 is the first word for the BTR block.
type of message being sent. The BTW and BTR instruction lengths may be different. Refer to
the message examples in Appendix B for the minimum lengths required for each message.
when the rung is true. This should always be set to No.
Using Block Transfer Messages5–5
Example SLC Block Transfers
This rung clears the Virtual BT Command word on the first scan.
This ensures that the Block Transfer logic starts up reliably.
First Pass
0000
S:1
15
Figure 5.5 and the following data file illustrate an example block
transfer program from an SLC controller to a Remote I/O
communications module. This program uses the first block transfer
area in the scanner located in the first slot. It also uses data files N10
and B3.
The example data file contains the data needed to request a read full
of parameter 78. The length of the block transfer data file is loaded
into N10:1. The value 0 is loaded into N10:2 for the rack, group, slot
address for the block transfer because this address is 0, 0, 0 (refer to
page 5–7). Data for the BTW is loaded into N10:10. Once the data
has been loaded, the user enabled bit B3:0/0 is set. When the block
transfers have completed, the BTR data is copied into N10 starting at
N10:100 and B3:0/0 is cleared by the program.
Figure 5.5.Example for an SLC-500
MOV
MOV
Move
Source0
0<
DestN10:0
-32640<
This rung copies the BT Status buffer from the 1747-SN into the SLC into a
file that we will refer to as the Virtual BT Status Buffer.
0001
If the user logic is calling for a Block Transfer message to occur and the Gx1 is ready to receive a BTW,
this rung sets up the BT buffer for a BTW and then enables it.
13
Virtual
BT.EN
Bit
N10:0
15
User
Logic
0002
0003
B3:0
This rung turns off the Virtual BT_Enable bit when the BTW has completed.
When the Gx1 indicates that it is ready for a BTR, this rung sets up the BT buffer for a
BTR and enables it.
BTR
Available
0004
0005
I:1.0
10
1747-SN
This rung copies the BT Status data already received from the 1747-SN into an N file within
the SLC and then clears the Virtual BT_Enable and User Logic bits.
Virtual
BT.Type
Bit
0 = BTW
1 = BTR
N10:0
7
Virtual
BT.EN
Bit
N10:0
15
Virtual
BT.DN
Bit
N10:100
13
Virtual
BT.Type
Bit
0 = BTW
1 = BTR
N10:0
L
7
Virtual
BT.EN
Bit
N10:0
15
Virtual
BT.DN
Bit
N10:100
U
13
COP
COP
Copy File
Source#N10:100
Dest#N11:0
Length74
L
Virtual
BT.EN
Bit
N10:0
U
15
User
Logic
B3:0
U
0
This rung copies the BT information to the 1747-SN for execution.
The Rack, Group, Slot address for a block transfer is calculated as
shown in the table below.
Rack, Group, Slot AddressDecimal Value
0,0,00
1,0,0100
1,2,0120
2,4,0240
This value is needed as part of the data file that is copied to the
M0-file block transfer buffer in the 1747-SN RIO Scanner module.
Example Logix5550 Block
Transfers
Figure 5.6 is an example of block transfer programming from a
Logix5550 controller to a Remote I/O communications module.
5–8Using Block Transfer Messages
Figure 5.6Example for a Logix5550
Due to the asynchronous nature of the ControlLogix platform, input data may change during a program scan.
This rung makes a local copy of the Block Transfer Status word to ensure proper synchronization
between the ControlLogix program and the RIO Scanner.
0Move
This rung sends a BTW to the drive if the drive's RIO adapter is ready to accept a BTW and no response
from a previous BTW is available to be read with a BTR. The data instructs the RIO adapter to send
a SCANport message to the drive. When this message has completed, the response can be read with a BTR.
The BTW Available and BTR Available bits will not be set until the SCANport message has been completed.
BTW Available
GD1_LocalCopy.13
1
BTR Available
GD1_LocalCopy.10
Make a Local Copy
of the 1203-GD1's
Block Transfer
Status Word
MOV
SourcePLUS_IO:I.Data[0]
2#0000_0000_0000_0000
DestGD1_LocalCopy
2#0000_0000_0000_0000
Type - Block Transfer Write
Message ControlPLUS_BTW_Control
MSG
...
EN
DN
ER
This rung sends a BTR to the drive whenever the drive's RIO adapter indicates that it has a response
message available from a previous BTW. The data read contains the response to the SCANport
message sent by the previous BTW.
BTR Available
2
(End)
GD1_LocalCopy.10
Notes Regarding Block Transfer
Programming
Type - Block Transfer Read
Message ControlPLUS_BTR_Control
MSG
...
•A Block transfer subroutine can be used to transfer more data
than can be moved in a single block transfer. If this is done, the
block transfers must be carefully sequenced so that one Block
Transfer Write and one Block Transfer Read occur for each
portion of the sequence. One method of doing this is to set a latch
bit to enable the Block Transfer Write and unlatch this bit when
the Block Transfer Write is completed. When the Block Transfer
Read completes, the program can then set up the data for the next
transfer.
•The status bits from the BTW and BTR Control files (.EN, .DN,
.ER) may change at any time during a program scan. If they are
used by the program they should be copied to a file and the
program should use the copied versions.
EN
DN
ER
Troubleshooting
Chapter
6
Chapter Objectives
LEDs on the Remote I/O
Communications Module
5
4
3
Chapter 6 provides information about the LEDs on the Remote I/O
modules. It also provides basic troubleshooting procedures. In this
chapter, you will read about the following:
Early versions of Remote I/O modules may use amber LEDs instead of green.
➀
➀
➀
6–2Troubleshooting
FAU LT L ED
LED StatusCauseCorrective Action
Red (Steady)• Unrecoverable Fault• Replace the module.
Red (Blinking)• Recoverable Fault
• If Health LED is steady, a DIP switch is set incorrectly,
there is a bad cable, or an RIO connection between the
controller and adapter has not been made.
Off• Normal Operation• None
• Verify that the module is configured correctly.
• Verify that the SCANport and Remote I/O cables are correctly
wired and securely connected.
• Configure or auto-configure the controller.
➁
SCANport STS LED
LED Status➀CauseCorrective Action
Green (Steady)• Normal Operation• None
Green (Blinking)• If FAULT LED is also blinking, the connected device is
not compatible.
Off• No SCANport Connection.• Verify that the module is connected to the SCANport product.
• Verify that the connected product is compatible. Refer to Chapter 1.
• Verify that the SCANport product is powered.
• Cycle power to the module.
Health LED
LED Status➀CauseCorrective Action
Green (Steady)• Normal Operation
• If FAULT LED is steady, a DIP switch is set incorrectly,
there is a bad cable, or an RIO connection between
the controller and adapter has not been made.
Off• Internal module fault• Cycle power.
• None
• Verify that the module is correctly configured.
• Verify that SCANport and Remote I/O cables are correctly wired and
securely connected.
• Configure or auto-configure the controller.
Rem I/O ACT LED
LED Status➀CauseCorrective Action
Green (Steady)• Normal Operation• None
Off• No data is being received from the controller.• Verify that Remote I/O is online.
• Verify that the controller is in run mode.
• Verify that rack addressing is set correctly.
• Verify that the module is connected to the controller.
Rem I/O STS LED
LED StatusCauseCorrective Action
Green (Steady)• Normal Operation• None
Green (Blinking)• Controller is in reset, program, or test mode.
• Controller has more rack space allocated than is used.
Off• Module is not communicating with the controller.
• Module is not connected to the product.
➀
Early versions of Remote I/O modules use amber LEDs instead of green.
➁
The SCANport product should be powered to ensure a successful auto-configure.
• Return the controller to run mode.
• Configure or auto-configure the controller.
• Verify that the module is connected to the controller.
• Verify that the controller is configured to recognize the module.
• Verify that the module is connected to the SCANport product.
➁
➁
Specifications
Appendix
A
Appendix Objectives
1336-GM1 Board Specifications
ElectricalInput Voltage
EnvironmentalOperating Temperature
CommunicationsProduct
MechanicalHeight
Regulatory
Agencies
Appendix A provides the specifications for the 1203-GD1 module,
1203-GK1 module, and the 1336-GM1 board.
Important:
Remote I/O communications modules are non-repairable
units.
The following table gives the specifications for the 1336-GM1 board.
CategorySpecifications
Supplied by the drive
Input Current
Input Frequency
SCANport Load
Storage Temperature
Relative Humidity
Controller
Baud Rates
Rack Sizes
Width
Depth
Enclosure
UL
CSA
CE
Not Applicable
Not Applicable
60mA DC
C (32 to 122°F)
°
0 to +50
C (–40 to 185°F)
–40 to +85
0 – 95%, non-condensing
SCANport
Allen-Bradley Remote I/O
57.6K, 115.2K, 230.4K
1/4, 1/2, 3/4, full
71 mm (2.8")
114 mm (4.5")
127 mm (0.5")
Open (IP00)
°
ATTENTION: The 1336-GM1 communications board
!
contains ESD (Electrostatic Discharge) sensitive parts.
Static control precautions are required when installing
and removing this assembly. Device malfunction may
occur if you do not follow ESD control procedures. If
you are not familiar with static control procedures, refer
to Rockwell Automation Publication 8000-4.5.2,
Guarding Against Electrostatic Damage, or other applicable ESD protection handbook.
A–2Specifications
1203-GD1 Module
Specifications
The following table gives the specifications for the 1203-GD1
module.
CategorySpecifications
ElectricalInput Voltage
Input Current
Input Frequency
SCANport Load
EnvironmentalOperating Temperature
Storage Temperature
Relative Humidity
CommunicationsProduct
Controller
Baud Rates
Rack Sizes
MechanicalHeight
Width
Depth
Enclosure
DIN Rail Standard
Regulatory
Agencies
UL
CSA
CE
85 to 264 V AC, 1 phase
35 mA maximum
45 to 63 Hz
60mA DC
C (32 to 122°F)
°
0 to +50
C (–40 to 185°F)
–40 to +85
0 – 95%, non-condensing
SCANport
Allen-Bradley Remote I/O
57.6K, 115.2K, 230.4K
1/4, 1/2, 3/4, full
76 mm (3.0")
45 mm (1.8")
123 mm (4.8")
NEMA Type 1 (IP30)
35 x 7.5 mm (1.38 x 0.30 in)
°
1203-GK1 Module
Specifications
The following table gives the specifications for the 1203-GK1
module.
CategorySpecifications
ElectricalInput Voltage
Input Current
SCANport Load
EnvironmentalOperating Temperature
Storage Temperature
Relative Humidity
CommunicationsProduct
Controller
Baud Rates
Rack Sizes
MechanicalHeight
Width
Depth
Enclosure
DIN Rail Standard
Regulatory
Agencies
UL
CSA
CE
24 V DC, +/- 10%
0.4 A maximum
60mA DC
C (32 to 122°F)
°
0 to +50
–40 to +85°C (–40 to 185°F)
0 – 95%, non-condensing
SCANport
Allen-Bradley Remote I/O
57.6K, 115.2K, 230.4K
1/4, 1/2, 3/4, full
76 mm (3.0")
45 mm (1.8")
123 mm (4.8")
NEMA Type 1 (IP30)
35 x 7.5 mm (1.38 x 0.30 in)
Appendix
Supported Block Transfer
Messages
B
Appendix Objectives
Appendix B provides information about the Block Transfer messages
supported by the Remote I/O communications module. In this
appendix, you will read about the following:
•Block transfer status word.
•Setting up data files for block transfer messages.
•Examples of block transfer messages.
•Block transfer quick reference.
Important:
This appendix provides detailed examples of block transfer
messages. For information about block transfer messages,
also refer to Chapter 5.
ATTENTION: Hazard of equipment damage exists. If
!
block transfer messages are programmed to frequently
write parameter data, the EEPROM (Non-Volatile Storage) will quickly exceed its life cycle and cause the product to malfunction. Do not create a program that frequently uses block transfer messages to write parameter
data to a product. Datalinks do not write to the EEPROM
and should be used for frequently changed parameters.
Supported Block Transfer
Messages
The following table lists the examples of block transfer messages in
this chapter.
CommandPageCommandPage
➀
Parameter Value Read
Parameter Value Write
Parameter Read Full
Product ID Number Read
Scattered Parameter Value Read
Scattered Parameter Value Write
This function can be accessed in the module and product. The following examples describe
➀
how to access it in the product. To do so in the module, add 16384 to the decimal value of
header word 2.
These block transfer messages can be used for both faults and warnings. See details on
➁
the referenced page.
➀
➀
➀
B-3Continuous Parameter Value Read➀B-14
B-4Save/Recall/Initialize
B-5Fault Command Write
B-8Fault Queue Entry Read Full
➀
B-10 Fault Queue Size Read
➀
B-12 Trip Fault Queue Number
➀
➀ ➁
➀
➀
➀➁
B-16
B-17
B-18
B-20
B-21
Refer to the quick reference on page B-22 for a complete list of block
transfer messages.
B–2Supported Block Transfer Messages
Block Transfer Data Structure
Successful Messages
When an operation is successful, header word 1 of the drive response
contains a positive value (bit 15 = 0) and data follows.
Figure B.1Example Message Structure and Reply
PLC Request
Drive Response
Message Length
Decimal Value
Data
Data
Header Word 0
Header Word 1
Header Word 2
Data Word 3
Message Length
Decimal Value
(OK)
Data
Data
Header Word 0
Header Word 1
Header Word 2
Data Word 3
Unsuccessful Messages
When an operation is unsuccessful, header word 1 of the drive
response contains a negative value (bit 15 = 1).
If an error occurs, the drive also returns an error code to indicate the
reason for the failure. The location of the error code is typically data
word 3 in the drive response, but will depend on the message.
Figure B.2Example Message Structure and Error Message Reply
PLC Request
Drive Response
Message Length
Decimal Value
Data
Data
Header Word 0
Header Word 1
Header Word 2
Data Word 3
Message Length
Decimal Value
(Error)
Data
Error Code
(See Table Below)
Header Word 0
Header Word 1
Header Word 2
Data Word 3
The following table lists the error codes.
ValueDescription
0No error occurred.
1The service failed due to an internal reason, and the drive could not perform the
request.
2The requested service is not supported.
3An invalid value in the block transfer request header word 2.
4An invalid value in the block transfer request header word 3.
5An invalid value in the block transfer request header word 2.
6The data value is out of range.
7There is a drive state conflict. The drive is in an incorrect state to perform the func-
tion. The drive cannot be running when you perform certain functions.
Supported Block Transfer MessagesB–3
Parameter Value Read
Parameter Value Read reads the 16-bit parameter data value for the
selected parameter number.
PLC Block Transfer Instruction Data
PLC request instruction length: 3 words
Drive response instruction length: 4 words
Figure B.3Message Structure
PLC Request
Drive Response
Message Length
3
PLC Decimal Value
769
Parameter Number
(See Drive List)
Header Word 0
Header Word 1
Header Word 2
Message Length
4
PLC Decimal Value
769=OK –31999=Error
Parameter Number
Parameter Value or
Error Code
Message Operation
Header
Word 0
Header
Word 1
Header
Word 2
Data
Word 3
Parameter Value Read reads parameter values from the drive and
places that value (or an error code) in word 3 of the drive response
data file. The value is shown in device units. Device units are listed in
the user manual for the device you are using.
If an error occurs:
•Word 3 of the response contains the status code.
•The status area of the data file is non-zero.
Example
In this example, the value of parameter 20 was requested from a 1336
PLUS drive and a value of 4096 was returned. 4096 is the internal
drive unit value for Maximum Rated Voltage. This corresponds to a
value of 100% Drive Rated Volts in Display Units.
Data File Format
0123456789
PLC request376920*
Drive response476920*4069*
* Example only — These values vary depending on parameters and products.
B–4Supported Block Transfer Messages
Parameter Value Write
Parameter Value Write writes a 16-bit parameter data value to the
selected parameter number.
PLC Block Transfer Instruction Data
PLC request instruction length: 4 word
Drive response instruction length: 4 words
Figure B.4Message Structure
PLC Request
Drive Response
Message Length
4
PLC Decimal Value
–31999
Parameter Number
Parameter Data
➀
Header Word 0
Header Word 1
Data Word 2
Data Word 3
Message Length
4
PLC Decimal Value
769 — Message OK
–31999 — Message Error
Parameter Number
0 or Error Code
Header
Word 0
Header
Word 1
Data
Word 2
Data
Word 3
Message Operation
Parameter Value Write sends a new value to the specified
parameter. The value must be in device units. Units for each
parameter are listed in the device manual.
If an error has occurred, word 1 of the response returns a value of
–31999, and word 3 contains a status code.
Example
In this example, a value of 4096 was sent to Parameter 20. 4096 is in
drive units and indicates a value of 100% Drive Rated Volts, as
defined in P147, Drive Rated Volts.
Data File Format
0123456789
PLC request4–3199920*4096*
Drive response476920*0*
➀
For parameter values greater than 32,767, you may need to enter the value in hexadecimal.
* Example only — These values vary depending on parameters and products.
Supported Block Transfer MessagesB–5
Parameter Read Full
Parameter Read Full provides all known attributes for the
parameters requested. This information includes the parameter’s
current value, descriptor, multiply and divide value, base value, offset
value, text string, group element reference, minimum value,
maximum value, default value, and unit text string.
PLC Block Transfer Instruction Data
PLC request instruction length: 3 words
Drive response instruction length: 23 words
Figure B.5Message Structure
PLC Request
Drive Response
Message Length
3
PLC Decimal Value
768
Parameter Number
(See Drive List)
Header Word 0
Header Word 1
Header Word 2
Message Length
23
PLC Decimal Value
768 — Message OK
–31999 — Message Error
Parameter Number
Parameter Value
or Error Code
Descriptor
Multiply Value
Divide Value
Header
Word 0
Header
Word 1
Data
Word 2
Data
Word 3
Data
Word 4
Data
Word 5
Data
Word 6
Parameter
Tex t
Base Value
Offset Value
Char 2Char 1
Char 4Char 3
Char 6Char 5
Char 8Char 7
Char 10Char 9
Char 12Char 11
Char 14Char 13
Char 16Char 15
Data
Word 7
Data
Word 8
Data
Word 9
Data
Word 10
Data
Word 11
Data
Word 12
Data
Word 13
Data
Word 14
Data
Word 15
Data
Word 16
B–6Supported Block Transfer Messages
Message Structure (Continued)
Drive Response (cont.)
File, Group, Element
Minimum Value
Maximum Value
Default Value
Char 2Char 1
Unit Text
Char 4Char 3
Data
Word 17
Data
Word 18
Data
Word 19
Data
Word 20
Data
Word 21
Data
Word 22
Message Operation
Parameter Read Full retrieves the attributes of the specified
parameter. The attributes for each parameter include the data,
minimum and maximum values, and the parameter text. The response
message returns this information.
If an error has occurred in reading any of the values, word 3 contains
the status word.
The parameter text is returned with each data word containing two
ASCII characters per word. The first and second characters are in
opposite order.
Example
In this example, a Parameter Read Full was performed through
block transfer on a 1336 PLUS drive. N10:10 shows the header
message for the request. The data is returned in the response data file,
starting with word 3, for parameter 20. Word 3 shows the present
value in drive units. Word 4 through word 8 provide scaling
information, used to convert drive units to engineering units for the
Human Interface Module (HIM). Word 9 through word 16 provide
the parameter name.
0123456789
PLC request376820*
Supported Block Transfer MessagesB–7
This example shows the response message in both binary and ASCII.
Note the ASCII information beginning with word 9. The parameter
name characters return in reverse order for each word. Word 9 has the
ASCII value of (aM). To read this, reverse the word to read (Ma). The
next word (ix), reversed, gives you (xi). These words, along with the
following two words, form the word Maximum. You can see the
parameter name Maximum Voltage in word 9 through word 16 of the
response message. In addition, words 21 – 22 are also returned in this
format. These words provide the units in which the parameter is
defined. In this example it is vlts.
Word 17 contains the file, group, and element which are used to
reference the parameter.
Word s 18 – 20 contain the minimum, maximum, and default values of
this parameter.
\00\17\03\00\00\14\10\00\01 c\00\01\10\00\01\CC\00\00a M
i xu mmo Vt lg ae07 0204 00\13 0
\10\00l Vs t
* Example only — These values vary depending on parameters and products.
B–8Supported Block Transfer Messages
Product ID Number Read
Product ID Number Read returns the product ID of the device to
which the Remote I/O module is connected.
PLC Block Transfer Instruction Data
PLC request instruction length: 3 words
Drive response instruction length: 4 words
Figure B.6Message Structure
PLC Request
Drive Response
Message Length
3
PLC Decimal Value
256
0
Product Code
(Hex)
0x0221336S1336 PLUS 0.5 – 10 HP
0x0331336S1336 PLUS 7.5 – 800 HP
0x0771336F1336 PLUS II
0x10161336T1336 FORCE w/PLC Adapter Board
0x11172364F2364 RGU DC Bus Regen Front End
0x121813941394 Motion Drive
0x131915571557 Medium Voltage AC Drive
0x1420193SMP-3
0x1521150SMC Dialog Plus
0x172313051305 AC Drive
0x182413971397 DC Drive
0x19251336R1336 Line Regeneration Package
0x20321336T1336 FORCE w/Standard Adapter Board
0x22341336E1336 IMPACT
Header Word 0
Header Word 1
Data Word 2
Product Code
(Decimal)
Message Length
PLC Decimal Value
256 — Message OK
–32512 — Message Error
Product ID Number
or Error Code
Bulletin
NumberProduct
4
0
Header
Word 0
Header
Word 1
Header
Word 2
Data
Word 3
Message Operation
Product ID Number Read, through the drive response message
word 3, indicates the type of device the Remote I/O module is
connected to. This value is defined in the message response chart
shown above.
If an error has occurred, word 1 of the response returns a negative
value of –32512.
Example
In this example, the Product ID Number Read was requested. The
drive response contained a value of 3 in word 3 of its message
response, indicating a connection to a 1336 PLUS drive.
Data File Format
0123456789
PLC request32560
Drive Response425603*
* Example only — These values vary depending on parameters and products.
Supported Block Transfer MessagesB–9
B–10Supported Block Transfer Messages
Scattered Parameter Value
Read
Scattered Parameter Value Read reads a scattered list of
parameters.
PLC Block Transfer Instruction Data
PLC request instruction length: 5 – 64 words
Drive response instruction length: 5 – 64 words
Figure B.7Message Structure
PLC Request
Drive Response
Message Length
5 – 64
PLC Decimal Value
3
Number of Parameter
Values to Read
Parameter Number
1
0
Parameter Number
2
0
Parameter Number
3
0
•
•
•
•
•
•
30
Header Word 0
Header Word 1
Header Word 2
Data Word 3
Data Word 4
Data Word 5
Data Word 6
Data Word 7
Data Word 8
•
•
•
•
•
•
Data Word 62Parameter Number
Message Length
5 – 64
PLC Decimal Value
3 — Message OK
–32765 — Message Error
Number of Parameter
Values to Read
bit
Parameter Number
15
Parameter Value or
Error Code
Parameter Number
bit
15
Paramet er Value or
Error Code
2
bit
Parameter Number
15
Parameter Value or
Error Code
3
Header
Word 0
Header
Word 1
Data
Word 2
Data
1
1
2
3
•
•
•
•
•
•
Word 3
Data
Word 4
Data
Word 5
Data
Word 6
Data
Word 7
Data
Word 8
•
•
•
•
•
•
Data Word 630
Parameter Number
bit
15
Parameter Value or
30
Error Code
30
Data
Word 62
Data
Word 63
Message Operation
Scattered Parameter Value Read reads a pre-defined group of
parameter values, in any order, from the device. You define the
number of parameters to read in word 2 of the request. The
parameters to be read and their order is defined starting with word 3.
An unused word is left between each parameter request, so the drive
can respond with the parameter value, as shown.
Supported Block Transfer MessagesB–11
If an error has occurred in reading any of the parameters:
•Word 1 of the drive response returns a value of –32765.
•Bit 15 of the drive response word for the number of that
parameter is set.
•The drive response word for the value of that parameter returns a
status word instead of returning the parameter value.
Example
In this example, eight parameters were read from a 1336 PLUS drive,
as defined in word 2 of the request. Parameter numbers 5, 7, 8, 20, 18,
17, 19, and 36 were requested. The drive response returned the values
of these parameters in the data file. These values are in drive units.
Data File Format
0123456789
PLC request193 8*5*0 7*0 8*0 20*
018*0*17*019*036*0
Drive response1938*5*6*7*1000*8*1000*20*
4096*18*4096*17*51*19*60*36*6144*
* Example only — These values vary depending on parameters and products.
B–12Supported Block Transfer Messages
Scattered Parameter Value
Write
Scattered Parameter Value Write writes to a scattered list of
parameters and returns the status of each parameter. If any of the
states have errors, the parameter number is negative.
PLC Block Transfer Instruction Data
PLC request instruction length: 5 – 64 words
Drive response instruction length: 5 – 64 words
Figure B.8Message Structure
PLC Request
Drive Response
Message Length
5 – 64
PLC Decimal Value
–32765
Number of Parameter
Values to Write
Parameter Number
1
30
30
➀
1
2
2
3
3
•
•
•
•
•
•
Parameter Value
Parameter Number
Paramet er Value
Parameter Number
Paramet er Value
Parameter Number
Parameter Value
Header Word 0
Header Word 1
Header Word 2
Data Word 3
Data Word 4
Data Word 5
Data Word 6
Data Word 7
Data Word 8
•
•
•
•
•
•
Data Word 62
Data Word 63
Message Length
5 – 64
PLC Decimal Value
3 — Message OK
–32765 — Message Error
Number of Parameter
Values to Write
bit
Parameter Number
15
0 or Error Code
bit
15
0 or Error Code
bit
15
0 or Error Code
bit
15
0 or Error Code
1
Parameter Number
2
Parameter Number
3
•
•
•
•
•
•
Parameter Number
30
Header
Word 0
Header
Word 1
Data
Word 2
Data
Word 3
Data
Word 4
Data
Word 5
Data
Word 6
Data
Word 7
Data
Word 8
•
•
•
•
•
•
Data
Word 62
Data
Word 63
➀
For parameter values greater than 32,767, you may need to enter the value in hexadecimal.
Message Operation
Scattered Parameter Value Write writes data values to a
pre-defined group of device parameters in any order. You define the
number of parameters to write in word 2. The parameters to be
written to and their order is defined starting with word 3.
Supported Block Transfer MessagesB–13
If an error occurs while writing to any of the parameters:
•Word 1 of the drive response returns a value of –32765.
•Bit 15 of the drive response word for that parameter’s number is
set.
•The drive response word for that parameter’s status word is
non-zero.
If no error has occurred:
•Word 1 of the drive response returns a value of 3.
•Each of the drive response’s parameter numbers are the same as
in the request.
•Each of the drive response status words returns a value of 0.
Example
In this example, six parameters were written to in a 1336 PLUS drive.
Word 2 of the request defines the number of parameter values that are
transferred. Beginning with word 3, the message lists each parameter
number followed by the value of the parameter. The values are
entered in device units.
The drive response returns the status of each parameter write. If the
request was successful, a zero is returned. If an error has occurred, the
response returns a status word code for the error.
Data File Format
0123456789
PLC request15–327656*90*1*150*4*30*20*31*
10*10*2*12*5*
Drive response1536*90*0*150*0*30*0*31*
0*10*0*12*0*
* Example only — These values vary depending on parameters and products.
B–14Supported Block Transfer Messages
Continuous Parameter Value
Read
Continuous Parameter Value Read reads a continuous list of
parameters beginning with the starting parameter number.
PLC Block Transfer Instruction Data
PLC request instruction length: 4 words
Drive response instruction length: 5 – 64 words
Figure B.9Message Structure
PLC Request
Drive Response
Message Length
4
PLC Decimal Value
1
Number of Parameter
Values to Read
Starting Parameter
Number
Header Word 0
Header Word 1
Header Word 2
Data Word 3
Message Length
5 – 64
PLC Decimal Value
1 — Message OK
–32767 — Message Error
Number of Parameter
Values to Read
Starting Parameter
Number
Value 1
or Error Code
Value 2
or Error Code
Value 3
or Error Code
Header
Word 0
Header
Word 1
Data
Word 2
Data
Word 3
Data
Word 4
Data
Word 5
Data
Word 6
•
•
•
•
•
•
Value 60
or Error Code
•
•
•
•
•
•
Data
Word 63
Message Operation
This function specified in the request will read a consecutive group of
parameter values from the device, beginning with the starting
parameter number defined in Word 3 of the request. The number of
parameters to be read is defined in Word 2 of the request. The values
will return in the response, beginning with Word 4. If an error has
occurred in reading any of the parameters, Word 1 of the response
will return a value of -32767 and the response word for that parameter
will return a status word instead of a parameter value.
Supported Block Transfer MessagesB–15
Example
In this example, 60 parameters were read from a 1336 PLUS drive,
beginning with parameter 10. The values of these parameters are
returned in the response. The values are in Drive Units.
Data Format
0123456789
PLC request4160*10*
Drive response64160*10*0*0*0*0*0*100*
0*50*4096*60*4096*1*6*0*1000*0*
0*0*0*0*1000*1000*400*400*400*0*
6144*2*4710*1*1*0*0*0*0*2*
64*0*0*15*1024*0*0*5811*0*18*
0*0*0*3597*0*12808*6*0*0*17952*
0*0*0*0*
* Example only — These values vary depending on parameters and products.
B–16Supported Block Transfer Messages
Save/Recall/Initialize
Save/Recall/Initialize—NVS (Non-Volatile Storage) Functions—
activates the specified function. These functions are also referred to as
EEPROM functions.
PLC Block Transfer Instruction Data
PLC request instruction length: 4 words
Drive response instruction length: 4 words
Figure B.10Message Structure
PLC Request
Message Length
4
PLC Decimal Value
–31998
0
NVS Command
ValueNVS Command
00
01
02
03
Not Used
NVS Save
NVS Recall
NVS Default Initialize
Header Word 0
Header Word 1
Header Word 2
Data Word 3
Drive Response
Message Length
4
PLC Decimal Value
770 — Message OK
–31998 — Message Error
0
0 or Error Code
Header
Word 0
Header
Word 1
Header
Word 2
Data
Word 3
Message Operation
This function allows three different message requests:
•NVS Save saves parameter information from the working
memory or RAM to NVS Storage.
•NVS Recall retrieves the last saved data from NVS Storage and
places it in the working memory or RAM.
•NVS Default Initialize clears the RAM and NVS Storage and sets
all parameter values to default.
If an error has occurred, response word 1 returns a value of -31998.
Example
This example requests the NVS Storage Save function be performed.
Data File Format
0123456789
PLC request4–319980*0, 1, 2, or 3
Drive response47700*0*
* Example only — These values vary depending on parameters and products.
Supported Block Transfer MessagesB–17
Fault Command Write
Fault Command Write activates the Clear Fault, Clear Fault Queue,
and Drive Reset functions.
PLC Block Transfer Instruction Data
PLC request instruction length: 4 words
Drive response instruction length: 4 words
Figure B.11Message Structure
PLC Request
Drive Response
Message Length
4
PLC Decimal Value
–30976
0
ValueFault Command
00
01
02
03
Not Used
Clear Fault
Clear Fault Queue
Drive Reset (1336 FORCE Only)
➀
Header Word 0
Header Word 1
Header Word 2
Data Word 3Fault Command
Message Length
4
PLC Decimal Value
1792 — Message OK
–30976 — Message Error
0
0 or Error Code
Header
Word 0
➁
Header
Word 1
Header
Word 2
Data
Word 3
Message Operation
The specified fault command function sends a fault handling request
to the device.
•A Clear Fault request clears the last fault that occurred.
•A Clear Fault Queue clears the entire fault buffer. Certain devices
may store more than one fault.
•A Drive Reset is used with the 1336 FORCE drive product only.
This function resets the drive; it clears the fault queue and writes
the parameter information stored in NVS Storage to RAM.
Data File Format
0123456789
PLC request4–3097600, 1, 2, or 3
Drive response4179200*
➀
For Warning Clear messages, the PLC decimal value is -30720. You can use three values:
0 = Not used, 1 = Clear Warning, and 2 = Clear Warning Queue.
➁
For Warning Clear messages, a message OK returns 2048, and a message error returns
-30720.
* Example only — These values vary depending on parameters and products.
B–18Supported Block Transfer Messages
Fault Queue Entry Read Full
Fault Queue Entry Read Full reads the contents of the specified
fault queue entry. A message is returned which includes the fault text
and fault code associated with the fault. The 1336 FORCE drive also
returns the time stamp associated with the fault.
PLC Block Transfer Instruction Data
PLC request instruction length: 3 words
Drive response instruction length: 12 or 16 words
Figure B.12Message Structure
PLC Request
Drive Response
Message Length
3
PLC Decimal Value
1792
Fault Queue
Entry Number
➀
Header Word 0
Header Word 1
Header Word 2
Message Length
12 or 16
PLC Decimal Value
1792 — Message OK
–30976 — Message Error
Fau l t Queue
Entry Number
Char 2Char 1
Char 4Char 3
➁
Header
Word 0
Header
Word 1
Header
Word 2
Data
Word 3
Data
Word 4
Char 6Char 5
Char 8Char 7
Fau l t Text
1336 FORCE
Drive Only
➀
For Warning Queue Read Full messages, the PLC decimal value is 2048.
➁
For Warning Queue Read Full messages, a message OK returns 2048, and a message
error returns -30720.
➂
Other drives return zeros.
➂
Clock
Time
Char 10Char 9
Char 12Char 11
Char 14Char 13
Char 16Char 15
Fault Code Value
SESREF
HourMinute
DateDay
Ye a rM o n t h
Data
Word 5
Data
Word 6
Data
Word 7
Data
Word 8
Data
Word 9
Data
Word 10
Data
Word 11
Data
Word 12
Data
Word 13
Data
Word 14
Data
Word 15
Supported Block Transfer MessagesB–19
Message Operation
Fault Queue Entry Read Full reads the contents of the fault queue
specified in word 3 of the request. The response returns the fault text
which can be ASCII text. Every two characters of text are in reverse
order. Also, the 1336 FORCE drive returns a time stamp, indicating
the day and time the fault occurred.
If an error has occurred, word 1 of the response returns a negative
value.
Example
In this example, Fault Queue Entry number 3 was retrieved from a
1336 PLUS drive. The fault code for this example is 22, and the fault
name is Drive Reset Flt. The fault code (22) is word 11 (12th word) in
the decimal drive response. The fault name (Drive Reset Flt) is in the
ASCII drive response. Note that every other character is reversed.
Data File Format
0123456789
PLC request317923*
Drive response
(Decimal)
Drive response
(ASCII)
1217923*29252*20313*8293*25938*25971*8308*27718*
8303*22*
\00\12\07\00\03\00r Dv iee Re stl F
t\00\16
* Example only — These values vary depending on parameters and products.
B–20Supported Block Transfer Messages
Fault Queue Size Read
Fault Queue Size Read gets the number of fault entries allowed in
the fault queue.
PLC Block Transfer Instruction Data
PLC request instruction length: 3 words
Drive response instruction length: 4 words
Figure B.13Message Structure
PLC Request
Drive Response
Message Length
3
PLC Decimal Value
1793
0
Header Word 0
Header Word 1
Header Word 2
Message Length
4
PLC Decimal Value
1793 — Message OK
–30975 — Message Error
0
Fault Queue Size
or Error Code
Message Operation
Header
Word 0
Header
Word 1
Header
Word 2
Data
Word 3
Fault Queue Size Read reads back the size of the fault queue
available in the product. Each product may have a different number of
fault queue entries available for storage.
If an error has occurred, word 1 of the response returns a value of
-30975.
Example
In this example, a 1336 PLUS drive was used. This product has a fault
queue of four storage locations available to store faults. This value is
seen in word 3 of the response header message.
Data File Format
0123456789
PLC request317930
Drive response4179304*
* Example only — These values vary depending on parameters and products.
Supported Block Transfer MessagesB–21
Trip Fault Queue Number Read
Trip Fault Queue Number Read provides the fault queue number of
the fault that caused the device to trip.
PLC Block Transfer Instruction Data
PLC request instruction length: 3 words
Drive response instruction length: 4 words
Figure B.14Message Structure
PLC Request
Drive Response
Message Length
3
PLC Decimal Value
1794
0
Header Word 0
Header Word 1
Header Word 2
Message Length
4
PLC Decimal Value
1794 — Message OK
–30984 — Message Error
0
Number of Trip Fault
or Error Code
Message Operation
Header
Word 0
Header
Word 1
Header
Word 2
Header
Word 3
Trip Fault Queue Number Read provides the number of the entry in
the fault queue that tripped the device in word 3 of the drive response.
The fault queue number is 0 when the device is not faulted.
If an error has occurred in the block transfer, word 1 of the response is
negative.
Example
In this example, the device has stored a fault in the first entry of the
fault queue that caused the drive to trip. Word 3 of the response
indicates the entry number.
Data File Format
0123456789
PLC request317940
Drive response4179401*
* Example only — These values vary depending on parameters and products.
B–22Supported Block Transfer Messages
Block Transfer Quick Reference
The following table provides a list of block transfers and a
description of the data that is entered in the first few words.
Word 0Word 1Word 2Word 3Word 4Word 5Word 6
ClassMessage
Parameter
Read
Parameter
Write
Fault Queue Fault Command Write4-309760Fault
Warning
Queue
EE
Memory
Request
Link Read Continuous Parameter Link
Link WriteContinuous Parameter Link
This word is not used.
➀
Example not available in this manual. Refer to the 1336 FORCE PLC Communications Adapter User Manual, Publication 1336 FORCE -5.13.
➁
n x 4096 + offset (bits 0 – 11)
➂
Trending is a function of the 1336 FORCE drive with a PLC adapter board.
➃
Continuous Parameter Value
Read
Parameter Read Full3768Parameter
Parameter Value Read3769Parameter
Scattered Parameter Value
Read
Continuous Parameter Value
Write
Parameter Value Write 4-31999Parameter
Scattered Parameter Value
Write
Fault Queue Entry Read Full 31792Fault Queue
Fault Queue Size Read317930
Trip Fault Queue Number
Parameter Link Read32304Link Number
Scattered Parameter Link
Read
Write
Parameter Link Clear4-3046401
Parameter Link Write4-30464Link Number Link
Scattered Parameter Link
Write
Message
Length
41Number of
5 – 643Number of
5 – 64-32767Number of
5 – 64-32765Number of
317940
44Number of
5 – 645Number of
5 – 64-32764Number of
5 – 64-32763Number of
Decimal
ValueDataDataData Data Data
Parameters
Number
Number
Parameters
Parameters
Number
Parameters
Entry
Number
Queue Entry
Number
Links
Links
Links
Links
Starting
Parameter
➀ ➀➀➀
➀ ➀➀➀
First
Parameter
Starting
Parameter
Parameter
Value
First
Parameter
Command
➀ ➀➀➀
➀ ➀➀➀
➀ ➀➀➀
Command
➀ ➀➀➀
➀ ➀➀➀➁
mand
Starting
Link
Number
➀ ➀➀➀➁
First Link
Number
Starting
Link
Number
First Link
Number
➀➀➀
0 Second
Paramet er
First
Parameter
Valu e
➀➀➀
First
Parameter
Valu e
➀➀➀
➀➀➀
➀➀➀
➀➀➀➁
0Second
First
Link
Number
➀➀➀➁
➀➀➀➁
First LinkSecond
Second
Paramet er
Second
Paramet er
Link
Number
Second
Link
Number
Link
Number
Example
B-14
B-5
B-3
0B-10
Second
Parameter
Value
Second
Parameter
Value
0
Third
Link
Number
Second
Link
➁
B-4
B-12
B-17
B-18
B-20
B-21
B-17
B-18
B-16
➁
➁
➁
Supported Block Transfer MessagesB–23
Word 0Word 1Word 2Word 3Word 4Word 5Word 6
ClassMessage
User Text
String
Product ID
User Text String Read32610
User Text String Write 11-325070char 1/
Product ID Number Read32560
Message
Length
Decimal
ValueDataDataData Data Data
➀ ➀➀➀➁
char 0
char 3/
char2
char 5/
char4
➀ ➀➀➀
Number Read
Clock DataReal Time Clock Data Read 328160
➀ ➀➀➀➁
Real Time Clock Data Write 7-299520sec./100thhour/min.date/dayyear/month
Run Time
Accumulator
Clear Run Time Accumulator 3-299500
Run Time Accumulator Data
328170
➀➀➁
➀ ➀➀➀➁
Read
Time Stamp Load Clock Info Reference
Stamp
Reference Time Stamp Data
Read
Reference Time Stamp Data
Write
Trend FileAll Info 34098n x 4096
Maximum Trend Size Avail-
3-29950Time Stamp
Number
32816Time Stamp
Number
3-29952Time Stamp
Number
340970
➀ ➀➀➀➁
➀ ➀➀➀➁
➀ ➀➀➀➁
➀ ➀➀➀➁ ➃
➀ ➀➀➀➁ ➃
able
Number of Trends Available340960
Run File Data 34100
➂ ➀ ➀➀➀➁ ➃
Setup Data Full 15-28670n x 4096
Trend Command 4-28672n x 40961 – 3
Trend Parameter Definition 34102n x 4096
Trend Status44097n x 40961 – 4
Trend Triggered Setup
34103n x 4096
➀ ➀➀➀➁ ➃
➀ ➀➀➀➁ ➃
➀➀➀➁ ➃
➀ ➀➀➀➁ ➃
➀➀➀➁ ➃
➀ ➀➀➀➁ ➃
Parameter
Trigger Time34099n x 4096
This word is not used.
➀
Example not available in this manual. Refer to the 1336 FORCE PLC Communications Adapter User Manual, Publication 1336 FORCE -5.13.
➁
n x 4096 + offset (bits 0 – 11)
➂
Trending is a function of the 1336 FORCE drive with a PLC adapter board.
➃
➀ ➀➀➀➁ ➃
char 7/
char 6
Example
➁
B-8
➁
B–24Supported Block Transfer Messages
End of Appendix B
Index
Numerics
1203-GD1 module, see Remote I/O
communications module
1203-GK1 module, see Remote I/O
communications module
1336-GM1 board, see Remote I/O
communications module
A
address, 2-12
application notes, P-2
attentions, P-3, 2-1
audience, P-1
B
baud rate, 2-11
block transfer
data files, B-1
data structure, B-2
examples, 5-3, 5-5, 5-7, B-1
notes, 5-7
quick reference, B-22
setting switch for, 2-5
status word, 5-2
understanding, 5-1