AS3 Ethernet IP Basic Tutorial
AS3 Application Note 3.2.1
Connecting an AS3 to a PLC over Ethernet for command and feedback.
Estimated Time: 30 Minutes
Level: 3
Prerequisite: AS3 Application Note 1.1.1 Navigating Menus & Parameters
1. Introduction
This tutorial is intended for use as a learning aid with basic localized setup and ASD run/stop examples. For the complete guide, please visit www.toshiba.com/tic/ to download the latest ASD Instruction Manuals and Ethernet Function Manuals.
This setup uses an Allen Bradley CompactLogix L24ER-QBFC1B controller (revision 28) with a Toshiba AS3 typeform VFAS3-2007P (230V, 1HP) revision V108 and Windows 7 PC. The fundamental setup is similar for all Toshiba ASDs, though the programming tutorial may vary slightly depending on your specific setup.
Referenced manuals:
- E6582125 - AS3 Embedded Ethernet Function Manual
- E6582062 - AS3 Instruction Manual
For advanced users, proceed to section 3 (Setting Up Network IP Addresses) to begin setting up the AS3 IP address and create an Ethernet Module in Studio (RSLogix) 5000.
2. Local Connection Setup
A typical local connection setup involves a PC, a PLC, and an ASD connected via an Ethernet switch.
3. Assigning a Local PC Static IP Address (If applicable)
To configure the IP address and subnet mask on the PC:
- Open the Windows Start menu and click Control Panel.
- From the Control Panel, click Network and Sharing Center.
- Click Change adapter settings.
- Right-click Local Area Connection and click Properties.
- Click Internet Protocol Version 4 (TCP/IPv4) and click Properties.
- Select 'Use the following IP address:' and enter the IP address and Subnet mask. For example, use 192.168.1.2 for the PC IP address and 255.255.255.0 for the Subnet mask. Click OK.
a. Setting Up Allen Bradley Controller Static IP Address
To set the Allen Bradley controller's static IP address, connect an RS232 or USB cable to the controller and use RSLinx.
- Connect a USB cable to the controller and open RSLinx.
- Right-click the controller and select Module Configuration.
- Select the Port Configuration tab, click 'Manually configure IP settings', and enter the IP Address and Network Mask. For this example, use 192.168.1.100 for the controller IP Address and 255.255.255.0 for the Network Mask. Disconnect the USB cable once the static IP addresses are set.
b. Setting Up Toshiba AS3 Static IP Address (Advanced users start here)
To change the AS3 IP address, access the Embedded Ethernet interface through the keypad's Guidance Function. The Toshiba AS3 ASD can also be remotely found via the BootP-DHCP Server tool, as the default AS3 IP Setting Parameter (C610) is set to DHCP.
- Accessing the Embedded Ethernet interface on the AS3 keypad: Press the ESC key to access the Setting Mode programming menu.
- Scroll down to 'Guidance function' and press OK.
- Press OK on the first highlighted menu item ('Embedded Ethernet').
- Change IP setting to 'Fixed' and enter the AS3 IP address and Mask. For this example, use 192.168.1.3 for the IP Address and 255.255.255.0 for the Mask.
- To apply these changes, cycle power to the drive or perform a soft reset with parameter F899: Communication function reset.
4. Creating a New Studio (RSLogix) 5000 Project and Ethernet Module
- Open a new Studio (RSLogix) 5000 project in Logix Designer and select the appropriate controller. For this example, the CompactLogix L24ER-QBFC1B controller is located under 'CompactLogix™ 5370 Controller'.
- From the Controller Organizer view, right-click the connected Ethernet module and select 'New Module...'.
- Scroll down or type “generic” in the filter box to find and create a 'Generic ETHERNET-MODULE'. Click 'Create'.
- Provide a Name (e.g., ASD_AS3) and the appropriate IP Address (e.g., 192.168.1.3) of the AS3. Enter the following information and click OK:
- Input Assembly Instance: 150
- Output Assembly Instance: 100
- Configuration: 1
- Input Size: 2
- Output Size: 2
- Configuration Size: 0
- Comm Format: Data - INT
5. Setting the Project Path and Going Online
The network and module are now configured. The next step is to go online with the controller.
- Open the Communications menu and select 'Who Active'.
- From the 'Who Active' screen, select the appropriate controller and set the Project Path and/or Go Online to download the new project to the controller. The 'Unrecognized Device, VF-AS3' connected in the Ethernet tab can be remedied by adding the AS3's .EDS file. This step is optional but recommended.
- The controller compares the project to the current offline project. If they differ, a prompt will appear to download the offline project to the controller.
- Once online, set the controller to Run Mode via the front controller switch or go to the Communications menu and select 'Run Mode'.
Note: An error may occur in a new project during download if there are no rungs or logic. Create a generic rung in the MainRoutine as shown in the example. A more complete rung example is shown in section 8, Example: Basic Start Stop Rung, page 28.
6. Toshiba AS3 Assembly Instance 150/100
The most common I/O Assembly Instances for the Toshiba AS3 ASD are 100/150 and 102/152. Instance 102/152 allows customization of I/O data using drive parameters C641 through C660. Refer to www.toshiba.com/tic/ for more information on AS3 Embedded Ethernet functionality and other I/O Assembly Instances.
The Ethernet module configuration in this document uses Instance 100/150, allocating 2 Words (16 Bits) each for Output Control and Input Feedback.
Instance 100 Mapping (Controller Output - ASD Input)
Instance 100 utilizes 2 Words (0,1), labeled from Bit 0 to Bit 15. It is primarily used for Run/Stop and Speed Reference to the ASD.
- The first Word (Instance 100) provides basic drive control: preset speeds, forward/reverse, run/stop, emergency stop, fault reset, and communication override. For example, activating Word 0, Bit 10 sends a Run command to the ASD.
- The second Word provides the speed reference to the ASD in decimal format (Hz). For example, entering “6000” in decimal format in Word 1 results in a 60.00 Hz speed reference.
Bit 0 | Bit 1 | Bit 2 | Bit 3 | Bit 4 | Bit 5 | Bit 6 | Bit 7 | |
---|---|---|---|---|---|---|---|---|
Word 0 | Preset Speed 1 | Preset Speed 2 | Preset Speed 3 | Preset Speed 4 | V/f Switching | PID Off | AccDec 1/ AccDec 2 | DC Braking |
Bit 8 | Bit 9 | Bit 10 | Bit 11 | Bit 12 | Bit 13 | Bit 14 | Bit 15 | |
Jog Run | Forward/ Reverse | Run/Stop | Free Run (ST) | Emergency Stop | Reset Trip | Speed Ref Override | Control Ref Override | |
Word 1 | Drive Speed Reference in Hz (decimal format) |
Instance 150 Mapping (Controller Input - ASD Output)
Instance 150 utilizes 2 Words (0,1), labeled from Bit 0 to Bit 15. It is primarily used for Status Feedback and Speed Feedback.
- The first Word (Instance 150) provides basic ASD status feedback: fault status, alarm status, undervoltage, running forward/reverse, and ready to run. For example, an active Word 0, Bit 0 indicates the ASD is faulted.
- The second word provides speed feedback from the ASD in decimal format (Hz). For example, receiving “6000” in decimal format in Word 1 indicates the drive is running at 60.00 Hz.
Bit 0 | Bit 1 | Bit 2 | Bit 3 | Bit 4 | Bit 5 | Bit 6 | Bit 7 | |
---|---|---|---|---|---|---|---|---|
Word 0 | Faulted | Emergency Stopped | Alarm | Under Voltage | V/F 2 | PID | AccDec Mode | DC Braking |
Bit 8 | Bit 9 | Bit 10 | Bit 11 | Bit 12 | Bit 13 | Bit 14 | Bit 15 | |
Jog Running | Forward/ Reverse | Run/Stop | Free Run (ST) | Emergency Stopping | Ready with ST | Ready without ST | Hand/Auto | |
Word 1 | Drive Speed Feedback in Hz (decimal format) |
7. Testing with Controller Tags
a. Example: Input Fault Status
The Studio (RSLogix) 5000 controller tags display the Input Instance 150 mapping as Word 0 and Word 1, each labeled from Bit 0 to Bit 15. The first word in the Controller Tags window under ASD_AS3.I.Data can be expanded to show the 16 Bits.
For example: ASD_AS3:I.Data[0] indicates Word 0 from Instance 100 mapping and is expanded to display all 16 Bits. ASD_AS3:I.Data[0].14 (Bit 14) is active and indicates the ASD is Ready to Run. The example screenshot shows Controller Tags ASD_AS3:I.Data[0].0, ASD_AS3:I.Data[0].1 and ASD_AS3:I.Data[0].12 (Bits 0, 1 and 12) are active, indicating that the ASD is Faulted, Emergency Stopped, and Emergency Stopping.
b. Example: Output Run and Communication Override
The example below shows Output Controller Tags for an AS3 drive running at 60.00 Hz. Expand the first Word under ASD_AS3.O.Data in the Controller Tags window to show the 16 Bits from the Output Instance 150 mapping.
To run the drive using the embedded Ethernet connection, parameters CMod (Run command select) and FMod (Freq command select 1) need to be changed to 'Embedded Ethernet'. By default, these parameters are set to 'Terminal' and 'Terminal RR'.
Writing 6000 into the second Word ASD_AS3:O.Data[1] sends a 60.00 Hz speed command to the ASD via Ethernet IP.
8. Example: Basic Start Stop Rung Example
Using the same project, add 3 coils and a MOV block into the Start Stop rung in the Main-Routine ladder logic.
Point each coil to ASD_AS3.O.Data(0).10, ASD_AS3.O.Data(0).14 and ASD_AS3.O.Data(0).15, which correlate with Run/Stop, Speed Ref Override, and Control Ref Override from Instance 150 mapping.
Move a speed reference value into destination ASD_AS3:O.Data(1), which correlates to the second speed reference Word from Instance 150 mapping.
Once Online, toggle the Start Contact bits to send a run command and a speed reference to the drive.
9. Adding the AS3 .EDS File (Optional)
a. Finding the AS3 CPU Version Number
EDS files are used by the network as configuration files to identify unknown objects for commissioning. Loading an EDS file is not required but is recommended.
To add an EDS file, download the correct EDS file version from www.toshiba.com/tic/. EDS files are ASD CPU version specific. An entire directory may be downloaded, and the network will automatically identify the correct EDS file.
To find the AS3 CPU version number:
- Press the i button on the keypad to access the Information menu.
- Press and select 'Model information'. The drive CPU version number is located next to 'CPU1 version'. Note this version number and download the correct EDS file(s) from www.toshiba.com/tic/.
b. Adding an .EDS File in Studio (RSLogix) 5000
- Open the Tools menu and select 'EDS Hardware Installation Tool'.
- Click 'Next'.
- Select 'Register an EDS file(s)' and click 'Next'.
- Select 'Register a single file' or 'Register a directory of EDS files' to download multiple EDS files. Click 'Browse' and select the file or folder directory containing the EDS file downloaded from www.toshiba.com/tic/. The network will automatically select the correct EDS file if the directory downloaded contains the correct file. Click 'Next'.
- Click 'Next'.
- The newly registered device and icon will populate. Click 'Next' and 'Finish'.
- A quick final check can be done by opening RSLinx and verifying the 'Unrecognized Device' is registered as VF-AS3 with the appropriate icon.