IMDTouchKnowledge BaseShop main store

How-to

How to Find the Right HMI Manual for Your Panel

HMI and touchscreens Published 8 min read

Short answer

The right HMI manual is the one that matches the panel's full order identifier from the nameplate plus the engineering software and project version that built the running screen. Capture those three facts first, then choose the documentation type — installation, configuration, operation, integration or troubleshooting — that matches the layer that is failing.

On this page
  1. What three facts identify the right HMI manual?
  2. Where do I read the panel's exact order identifier?
  3. How do I find the software and project version behind the panel?
  4. Which manual type matches the problem I have?
  5. How do I use the manual to split a symptom across panel, project, comms and data?
  6. What steps take a fault from symptom to the correct manual page?
  7. What do I do when no manual matches the panel?
  8. Questions asked

The fix is three facts and one comparison: copy the panel's full order identifier from the nameplate (every character, for example a 20-digit string like a 6AV2-series number), record the engineering software and the project version actually loaded, and compare a wrong value at the screen with the controller register behind it — 452 L on the screen against 4520 in the register with a scaling of ÷10 already tells you the fault is in the project, not the panel, so you open the configuration guide's numeric-format section, not the panel's troubleshooting chapter. Capture those three facts before you search, then pick the documentation type that matches the failing layer: installation, configuration, operation, integration or troubleshooting. Most wrong-manual mistakes come from matching on screen size, enclosure shape or a similar machine, because a project built for one device or one software release does not transfer to a near neighbor. The procedure below takes the identifier first, splits your symptom across panel, project, communication and data layers, and ends with a worked value comparison and the decision for each outcome.

What three facts identify the right HMI manual? #

Three facts decide it: the panel's full order identifier from the nameplate or its device information screen, the name and version of the engineering software, and the project version loaded in the panel; miss any one and the manual you find may not describe your device.

The order identifier is the key because vendors split documentation by device family. Siemens publishes separate operating instructions for its Unified Comfort Panels and for its Unified Basic Panels; the family inside your identifier decides which document is yours, and the glass alone does not.

The software and project version matter because the same panel family is programmed by different tool generations over its life, and the configuration chapters are written against the tool, not against the panel. Add a fourth note when the panel talks to a controller: the controller model and the communication method configured in the project — PROFINET, Modbus TCP over the panel's Ethernet port, or a serial link on an RS-232 or RS-485 port — because that pair selects the integration documentation.

Where do I read the panel's exact order identifier? #

Read it from the nameplate on the housing, usually the rear or the inside of the mounting flange, or when the panel still runs from the device information page in its control menu, and copy every character.

Photograph the nameplate before you clean it; grease and wear take characters with them. If the panel still boots, the device information page shows the identifier, usually with the product version beside it — record both, because the product version is the second thing a documentation library filters on. If the panel is dead and the plate is unreadable, the identifier survives in the purchase documentation and in the target-device entry of the project built for that panel.

A description narrows a catalog search, not a documentation search. A size and a port count read off the bezel does not reach a wiring diagram; the identifier does.

How do I find the software and project version behind the panel? #

Open the project in the engineering tool on the workstation that maintains the machine, and record the software name and version from its own version display plus the project version from the project properties or the panel's information page, and verify the two agree.

The workstation and the panel can disagree: panels keep running old projects after workstations move to newer tools, so confirm what is actually loaded — the procedure in how to verify the HMI project version running on a panel makes that check. The software generation also decides which panels a tool can target at all, and which HMI software works with which HMI panel hardware maps that by manufacturer; read it before concluding a panel is unsupported.

Expect the documentation to be split the way the system is. The panel's operating instructions describe what runs on the glass, while project configuration lives in the engineering environment's documentation: Siemens covers configuring HMI devices for S7-1500R redundant systems in the controller documentation collection, not in the panel manual, and other vendors draw the same line.

Which manual type matches the problem I have? #

Match the documentation type to the failing layer: five types cover the field — installation, configuration, operation, integration and troubleshooting — and the symptom, not the manual you already have, decides which one to open.

What you see Documentation to open What it gives you
Panel will not start, or the display is blank or dim Installation instructions Power wiring on the 24 V DC supply terminals, protective-earth connection, startup sequence, status indications
Screens or controls missing, wrong or misplaced Configuration or programming guide Loaded project, target device, object behavior, version compatibility
Values absent, stale or wrong Integration notes and the troubleshooting chapter Connection settings, tag mapping, diagnostics toward the controller
Alarms missing or not acknowledging Operating instructions Alarm display behavior and the acknowledgement procedure
Component-level faults Service or maintenance manual Part replacement and engineering-component installation

The types overlap inside single documents, so document size tells you nothing. Siemens' operating instructions for the Unified Comfort Panels run 178 pages, from the safety notices through troubleshooting; Honeywell's HMI user guide is 38 pages and spends its settings chapter on operator-facing items like lock screen time; the Compact HMI 800 tutorial for an IndustrialIT system runs 192 pages, because system integration is where pages come from. Use the table of contents as the selector. Service manuals run the other way — one PC-based operator panel service manual walks through installing engineering components such as an OPC server, work no operating instructions touch.

How do I use the manual to split a symptom across panel, project, comms and data? #

Compare the HMI indication with the corresponding controller value: if the controller value is also wrong, the fault is upstream of the HMI; if the controller is right and the display differs, the fault sits in the communication or the tag mapping — that one comparison routes you to the right chapter.

Worked example with illustrative numbers, not a measured test: an operator reports a tank level reads wrong. The screen shows 452 L. The controller register behind that tag holds 4520 and the project scales the tag by 10, so 4520 ÷ 10 = 452 — the screen shows exactly what the controller holds, the data path is intact, and the fault class is project configuration. Open the configuration guide's numeric-format section for that tag; the panel's troubleshooting chapter has nothing for you.

Second branch: if the screen showed 45.2 L with the register still at 4520, then 4520 ÷ 100 = 45.2 says the scaling in the project is one power of ten off — still configuration, still fixed in the project. Third branch: register correct, screen stale or empty — communication; open the troubleshooting chapter's connection and tag diagnostics. Fourth branch: the register itself is wrong — upstream of the HMI entirely, and the controller's documentation is the next manual you open, not the panel's.

Decision list:

  • Controller value wrong: fix upstream; open the controller documentation.
  • Controller value right and the screen matches the scaling: configuration guide, numeric formats and scaling of the tag.
  • Controller value right and the screen differs or is stale: troubleshooting chapter, connection settings and tag mapping.

One caution, in place: test any operator action under the machine's own lockout and established procedure — a screen that accepts a command is not evidence of a safe machine state, and the warning-notice block at the front of the Unified Comfort Panels instructions exists for exactly those notices.

What steps take a fault from symptom to the correct manual page? #

Work the list in order — identifier, software and project version, controller context, symptom class, document retrieval, one-change fix, verification — and do not skip the first three, because every later step depends on them.

  1. Copy the full order identifier from the nameplate or the device information screen, character for character, with the product version beside it.
  2. Record the engineering software name and version, and the project version actually loaded, and check the two against each other before trusting either.
  3. Record the controller model and the communication method the project uses, down to the port — PROFINET or Modbus TCP on the Ethernet port, serial on RS-485.
  4. Write the symptom as one sentence: which screen, which tag or alarm, when it appears, whether it repeats.
  5. Split the fault with the controller-versus-screen comparison and select the documentation type from the table above.
  6. Retrieve the document matching your identifier and software generation from the vendor's support area, and read its scope statement against your three facts before following any instruction.
  7. Change one setting or one project element, record the change, and retest the affected screen, tag, alarm or action.
  8. Verify the result: the intended screen opens as configured, the value tracks the controller, the alarm appears and acknowledges, and the command produces the intended controller response.

One change at a time is what makes steps 7 and 8 mean anything: a single change with a single observed result is evidence, and several changes together are only a story you tell yourself afterward.

What do I do when no manual matches the panel? #

Search the vendor's support area with the full order identifier, not the family marketing name, and if that returns only archived material, the model is discontinued and the working order becomes recover-then-replace.

Documentation libraries are indexed on the identifier, so a partial or marketing name returns the wrong family. When the identifier leads only to archived documents, stop treating the fault as a documentation problem and treat the panel as end-of-life: recover the running project first — reading an old HMI program before panel replacement covers that pull — and where the engineering software is the missing piece, how to find configuration software for a legacy TP070 touch panel shows the search pattern. When the repair path is closed, the migration lands on industrial panel PCs running your HMI runtime at the machine.

Decision: an archived manual that matches your identifier still works, with any version mismatch treated as a stop sign; no matching document and no recoverable project means replacement, with the project read before the panel comes off the machine.

Questions asked

Can I use the manual for a similar panel or an older revision?

Use a near-model manual for orientation only — screen structure, terminology, where settings live — and treat it as reference, not procedure. Any mismatch between its described menus, connectors or status indications and what your panel shows is a stop sign: stop, find the revision that matches your full order identifier, and only then change configuration. An older revision of the correct model is safer than a current manual of the wrong model.

Is a generic HMI guide ever enough?

Yes, for concepts. A general HMI guide explains what tags, alarms, recipes and screen navigation are, and how a project is structured, and that background speeds up every later search. It is never enough for terminal assignments, wiring, menu paths or diagnostic routines, because those belong to the device family and generation. It is also the wrong place to look when a value reads wrong — that needs the comparison against the controller, not more definitions.

What does the scope statement at the front of a manual tell me?

It names the device, the product version and the software generation the document describes. If all three match what you recorded — order identifier, panel product version, engineering software — the procedures apply as written. If any one differs, use the document for background only until you find the revision that lists your combination; vendors publish document revisions alongside product versions, so a mismatch usually means the right file exists.

Which documentation do I open to change one screen on a working panel?

Open the configuration or programming guide for the exact software generation that maintains the project, not the panel's operating instructions. The change happens in the project on the engineering workstation, so the guide that matters is the one matching your engineering tool version. The operating instructions matter afterwards, to confirm how the changed object behaves on the panel for the operator.

Keep reading

  • How-to

    Matching Crimson software version to HMI firmware

    Read the installed firmware on the panel before installing anything: the latest Crimson 3.2 release requires firmware 3.2.0050.0 or later. If the panel is older, update the firmware through Crimson or install the older Crimson release from the same download page. The Panasonic FP7 PLC side is separate: Control FPWIN Pro7 is a purchased license, ordered under AFPSPR7A or AFPSPR7AS.

    HMI and touchscreens

  • Comparison

    Which HMI Software Works With Which HMI Panel Hardware

    Match the terminal's exact model and firmware to its engineering tool. PanelView 800 uses Connected Components Workbench, PanelView Plus uses FactoryTalk View Studio for Machine Edition, and PanelView 5000 uses Studio 5000 View Designer. Check PLC driver support separately.

    HMI and touchscreens

  • How-to

    How to find configuration software for a legacy TP070 touch panel

    A TP070 is configured with TP Designer, the add-on that shipped in the STEP 7 Micro/WIN Toolbox era and runs under Micro/WIN V4 — not with WinCC flexible, ProTool or TIA Portal. Read the order number on the rear label to match the toolset to the panel's firmware generation, source the package through the manufacturer's own channels, and transfer over PPI at 9.6 kbit/s.

    HMI and touchscreens