How-to
Upgrading the Crimson 3 L5K Driver to Version 2.00
Short answer
The performance gain in Crimson 3 build 530.000 only arrives after you select L5K driver version 2.00, reload the L5K export, and re-enter each tag in the new Program: reference format. Plan the remap at roughly 500 HMI-bound tags, 20 start/stop loops, or two controllers per panel; below that, version 1.04 keeps working.
On this page
- What did build 530.000 change in the L5K driver?
- When is version 1.04 no longer fast enough?
- How do I export a usable L5K file from Studio 5000?
- How do I switch the device to driver version 2.00?
- How do I remap tags from [PLC.Program.Tag] to Program:Program.Tag?
- How long does a 1,000-tag remap take, and how do I keep it accurate?
- Why do alias tags fail to import?
- How do I prove the remap before the panel goes back to production?
- Questions asked
Crimson 3 build 530.000 added an enhanced L5K driver for ControlLogix and CompactLogix data, and the speed gain is real but not automatic: you must select driver version 2.00 on the device, load a fresh L5K export, and re-enter every tag in the new Program: reference format, because the old [PLC.Program.Tag] bindings do not carry over. The work is tedious, with tags going in one at a time, but it cures the symptom that pushes every large project to this upgrade: start/stop buttons that hesitate. Below are the trigger points that decide when the remap is worth it, the export and switch procedure, the address mapping, and the checks that prove the result.
What did build 530.000 change in the L5K driver? #
Build 530.000 of Crimson 3 added an enhanced version 2.00 of the L5K driver, and it speeds nothing up until you select it: the legacy version 1.04 stays installed for backward compatibility and keeps its old behavior.
The L5K driver talks to Logix-family controllers over EtherNet/IP and resolves the controller's native tag names, taken from an L5K ASCII export of the RSLogix 5000 or Studio 5000 project. Version 1.04 imports the tag names and services every operation in turn, so a button write waits behind the periodic read sweep. Version 2.00 loads and validates the tag information straight from the L5K file, exposes only the tags you select, and pushes those writes ahead of the sweep. That reordering is the speed gain.
The build notes credit L5K driver performance enhancements without saying the gain requires the new version, so a panel updated to 530.000 keeps running 1.04 at 1.04 speed until someone changes the driver version by hand. The choice lives with the device, and the older version remains selectable specifically so existing applications keep running.
When is version 1.04 no longer fast enough? #
Plan the migration when a project passes any one of three field marks: roughly 500 HMI-bound tags, about 20 start/stop control loops driven from the panel, or a second controller sharing the same HMI.
These marks come from multi-panel deployments, not from a vendor datasheet; treat them as planning numbers and treat hesitant buttons as the real signal. The case that set them: about 80 motors run by 2 CompactLogix controllers with 2 G310 panels on one network and roughly 1,000 tags, where start/stop presses were reported to work only every other time.
Planning calculation, labeled as such rather than measured: a field rule of thumb puts the version 1.04 full-sweep period near 250 ms × (tag count ÷ 100). At 1,000 tags, 250 ms × (1,000 ÷ 100) = 250 ms × 10 = 2,500 ms, a 2.5 s sweep. A write queued behind that sweep waits up to 2.5 s, which an operator reads as a dead button.
The decision: at or past any one mark, schedule the remap. Below all three, stay on 1.04, because the sweep is short, the buttons answer, and the remap hours buy nothing.
How do I export a usable L5K file from Studio 5000? #
Export the controller project as an ASCII source file with a .L5K extension: in RSLogix 5000 or Studio 5000 Logix Designer, open the project, choose Save As from the File menu, and set the type to L5K (ASCII source).
- Save to a path with no spaces in any folder name; the import in build 530.000 is happier without them.
- Open the file in a text editor and confirm it starts with a PROJECT ... END_PROJECT block and carries at least one TAG ... END_TAG block. An empty export means the project was read-only or the controller state blocked it.
- Confirm the extension is .L5K, not the .L5X XML export, because the driver wants the ASCII source.
- Where the export can be scoped, leave out programs the HMI never touches; a shorter pick list later means fewer wrong picks per hour.
How do I switch the device to driver version 2.00? #
Back up the .cdb3 project file, open it in Crimson 3 build 530.000 or later, then change the L5K device's driver version from 1.04 to 2.00 and accept the warning that existing tag bindings are invalidated.
- Copy the .cdb3 to a versioned backup folder and leave the original untouched.
- Open the copy in build 530.000 or later.
- Under Communications, open the device using the Native Tags via L5K driver.
- Select driver version 2.00 in the device settings; version 1.04 stays on the list.
- Accept the warning that tag bindings will be invalidated, and stop there. Do not edit tags before the L5K file is loaded.
- Load the L5K file into the driver so the validated tag list is in place before any remapping.
Do the switch with the machine stopped or the panel's writes disabled: mid-migration the buttons command nothing, and one wrong pick afterward can command the wrong output.
How do I remap tags from [PLC.Program.Tag] to Program:Program.Tag? #
Program-scoped references change from [PLC.Machines.Motor_1.Running] to Program:Machines.Motor_1.Running: the leading [PLC. becomes Program:, the closing bracket goes away, and controller-scoped tags drop the wrapper entirely, while module I/O keeps its own form.
| Version 1.04 reference | Version 2.00 reference | What it is |
|---|---|---|
| [PLC.Machines.Motor_1.Running] | Program:Machines.Motor_1.Running | Program-scoped UDT member |
| [PLC.Machines.Motor_1.Speed] | Program:Machines.Motor_1.Speed | Same UDT, REAL member; dot notation carried over verbatim |
| [PLC.Alarm.AlarmLog[0].Active] | Program:Alarm.AlarmLog[0].Active | Array element; the inner brackets stay |
The rules: program-scoped tags take Program: in place of the [PLC. wrapper; controller-scoped tags lose the wrapper and keep the bare name; module I/O references keep their own form with the wrapper removed; UDT members and array elements inside a name are carried over character for character. A blind find-and-replace that only strips brackets leaves those cases inconsistent, so apply the rules and spot-check one tag of each kind. The vendor's version 2 driver document, G3-ABL5Kv2, covers the same mapping. In the Crimson database the tags arrive from the driver's flat, filterable list: no folder tree and no multi-select, one pick per tag, each pick carrying the new syntax automatically. That is the sharpest break from other workflows, where importing a PLC tag CSV into an existing HMI tag database moves dozens of references at once; here the discipline is one name, one pick. Note also that these are L5K references into controller data, not Crimson's internal G3 tags, which is the same split behind how G3 and L5K tag references differ when one tag feeds more than one protocol.
How long does a 1,000-tag remap take, and how do I keep it accurate? #
Budget three to four hours for a 1,000-tag remap and treat accuracy, not speed, as the real risk: each tag is re-entered by hand from a long validated list, and one wrong pick writes to the wrong address.
The hours are a reported field estimate, not a benchmark. Before touching the driver, capture what exists, the same first move as reading an old HMI program before panel replacement, because the old bindings are the only cross-check once the switch invalidates them. Then:
- Sort the Crimson tag database and the driver's validated list the same way: by program, then by name.
- Remap one program's tags at a time and mark them done in the old database.
- Keep the pre-migration .cdb3 open in a second window as the reference for what each tag pointed at.
- After each program, spot-check one tag of each kind: a UDT member, an array element, a controller-scoped name.
Why do alias tags fail to import? #
Alias tags do not import with the L5K driver at this time, so reference the base tag the alias points to, or map the physical I/O to a controller tag in the PLC program and read that instead.
The limitation is stated in the vendor's current L5K material, and the workaround is the route field engineers settled on when aliases would not resolve: move the physical I/O onto an internal controller tag and point the HMI at that. Nothing else about the migration changes.
How do I prove the remap before the panel goes back to production? #
Test the remapped project in simulation against the live controller, then confirm the project version actually running on the panel before it returns to the machine.
- Run the migrated project against the live controller the way testing HMI simulation against a live PLC walks through, and watch the data move before any download.
- Press every start/stop button once and confirm the controller bit changes on the first press, not the second.
- Compare a few remapped values of each kind, meaning a UDT member, an array element and a controller-scoped name, against the controller's own tag monitor.
- After downloading, verify the HMI project version running on the panel so nobody troubleshoots the old project by mistake.
Questions asked
Does updating Crimson to build 530.000 break existing L5K projects?
No. Version 1.04 of the driver remains installed and selectable, so projects built on it open and run unchanged after the update to build 530.000. Version 2.00 is something you opt into per device; nothing forces the remap until you want the speed gain.
Can a project mix L5K driver version 1.04 and version 2.00 devices?
Yes. Each device keeps its own driver version and each tag binds to exactly one driver, so you can migrate one panel or one controller at a time. Avoid pointing both drivers at the same PLC tag, or the controller gets polled twice and you add traffic for nothing.
If the PLC program changes after the migration, do I need a new L5K export?
Only when tags are renamed, moved between programs, or deleted. Re-export the L5K file from Studio 5000, load it into the driver, and re-point the affected references. Tags whose names and scope did not change keep working as loaded.
Do graphics and buttons need rebuilding after the remap?
No. Pages, buttons, actions and logging reference the HMI tags in the Crimson database; what breaks in the switch is the PLC binding inside each tag. Re-point each existing tag's data source to its new version 2.00 reference and the graphics pick it up unchanged.