This manual describes the OPUS Projektor, a software tool used to create and manage display projects for various devices. It covers the user interface, variable management, CAN communication protocols, object references, JavaScript functionalities, simulations, device software updates, and a "How To" section for common tasks.
The OPUS Projektor is a design tool that allows users to create graphical user interfaces (GUIs) for display devices. Projects are structured logically in a project tree, containing categories like Pages, Alarms, Virtual Keyboards, JavaScripts, and Images. Objects can be dragged and dropped from a palette onto the Page Editor to design the GUI.
User Interface Overview
The user interface includes a Menu Bar for file operations (New Project, Open Project, Save Project, Convert Project, Export Project, Project Properties), editing (Undo/Redo, Copy/Paste, Delete), simulation (PClient Simulation, Variable Simulation, Simulation Settings), updates (Project Update, OS/PClient Update), and view options (Toolbars, Show Breadcrumbs, Show Indent Guide Lines, Show Only Editor).
Key elements of the interface include:
- Project Tree: Shows the logical structure of the project, including pages, alarms, virtual keyboards, JavaScript files, and images. Objects are color-coded to indicate creation, modification, or problems.
- Page Editor: The main window for designing graphical content, with tools for enlarging/reducing view, aligning objects, moving objects, and configuring grid width. Objects can be locked in position and size to prevent accidental modifications.
- Satellite Window: Provides an overview of the entire display, useful for navigation when zoomed in.
- Variable View: Manages variables, allowing users to create, edit, and link them to objects via drag and drop. It supports filtering and searching for variables.
- Palette: Contains graphical objects (e.g., Frame, Container, Button, String Field, Numeric Field, Picture Graphic, Table, List, Meter, Gauge, Lamp, Power Switch, Push Switch, Rocker Switch, Multimedia Player) that can be dragged and dropped into the editor.
- Properties Window: Displays and allows editing of properties for selected objects.
- Output Window: Shows information, warnings, and errors during program use.
- Project Search: A powerful feature for searching across the entire project, including properties, events, and file content, with options for regular expressions and case matching.
- Symbol Library: Provides access to various symbol sets (ISO 7000, Material Design, Remix symbols) for use in projects.
- Image Library: Allows quick access to images from folders, supporting various formats and resolutions. It also includes an Image Pool to manage images used in the project, identify unused images, and rename/replace them.
- Undo/Redo: Supports reverting and re-applying changes made in the project.
Variables
Variables are central to adding dynamic behavior to the GUI. They can be owned by remote ECUs, internal processes (like the Hardware Daemon), or PClient. Variables have properties such as Name, Index, Subindex, Owner, Description, Data Type, Length, Access Type, Min/Max/Default Value, Initialize Value as Invalid, Remanent, and Force Writing.
- Variable Owner Menus: Configures ECUs and processes that own variables.
- Variable Menus: Manages data types, variable groups, and individual variables.
- Pre-Defined Variables: A comprehensive list of system variables for hardware states (I/O, CAN bus status), display properties (backlight, RTC), and GUI elements (virtual keyboards, alarms, visibility).
CAN Communication
The OPUS Projektor supports CANFreestyle, CANopen, and J1939 protocols.
- CANFreestyle: A proprietary protocol for sending and receiving CAN messages, allowing emulation of other protocols. It supports defining CAN ID masks and creating sequences of messages.
- CANopen: Implements the CiA 301 standard, supporting SDO and PDO communication.
- J1939: Based on SAE J1939, used for automotive applications. It defines SPNs (Suspect Parameter Numbers) combined into PGNs (Parameter Group Numbers) for message transmission. The tool allows configuring ECUs with static or dynamic addresses and defining PGN mappings.
- DBC File Import/Export: Facilitates importing and exporting CAN message definitions using DBC files, which is useful for integrating with other CAN tools.
Object Reference
Detailed descriptions of all available objects and their properties:
- General Objects: Page, Alarm, Virtual Keyboard, Softkey Frame, Softkey.
- Palette Objects:
- Containers: Frame, Container.
- Common Controls: Button, String Field, Numeric Field, Picture Graphic, Table, List.
- Measurement Controls: Meter, Gauge (various types), Arched Bargraph, Linear Bargraph, 2D Graph.
- Lamps and Switches: Lamp, Power Switch, Push Switch, Rocker Switch.
- Special Controls: Multimedia Player.
Each object has common properties (ID, Type ID, Name, X/Y Location, Width, Height, Dependency, Unit Group, Skin Properties, Visibility, Input Configuration, Value Related, Formatting) and specific properties.
Events and Actions
Objects can have dynamic behavior configured through events (e.g., OnPress, OnRelease, OnValueChange, OnPageInit) and actions (e.g., Execute Script, Jump To Page, Set Value, Scale Value, Set Media Player Command).
JavaScript
The JavaScript editor allows users to write custom scripts for device-specific functionality. It includes features like auto-completion, auto-formatting, error/warning hints, and debugging tools. Custom functions are provided for interacting with project variables and objects (e.g., print, getVariableValue, setVariableValue, getProperty, setProperty, readFile, writeToFile, createUSBDirectory, deleteFileOrDirectory, setFocus, showSoftkeyFrames, sendCANMessage, openPDFReader, runSystemCommand, getTriggerEvent, setVariableValid, startTouchscreenCalibration, writeEEPROM, readEEPROM).
Simulations
The OPUS Projektor offers PClient Simulation and Variable Simulation for testing projects on a PC without a physical device.
- PClient Simulation: Simulates the display device, allowing interaction via mouse/keyboard.
- Variable Simulation: Monitors and manually/automatically changes variable values, including value range generators, value switch generators, and value list generators.
- Simulation Settings: Configures connection settings for PClient and JavaScript debugging.
Device Software Update
The Updater tool facilitates transferring projects and OS/PClient updates to devices via USB, CAN, or Ethernet. It includes an Updater Wizard to guide the process and provides error codes for troubleshooting.
How To
This section provides practical solutions for common tasks, such as creating switch buttons with changing colors, using one script for multiple buttons, creating drop-down menus, using automatic backlight dimming, setting up SDO communication, remembering variable values when powered off, using power management, using digital outputs, processing CAN messages with a multiplexer bit, and creating dynamic icons.
Important Technical Specifications and Usage Features:
- Project Conversion: Projects can be converted between different device types, with options for scaling page content and handling softkeys.
- Image Handling: The tool automatically scales images to the device's resolution and manages an Image Pool to avoid duplicates. GIF animations are supported for Picture Graphic objects.
- Font Attributes: Users can define custom font attributes (size, style, color) for text display.
- Unit Systems: Supports various unit groups (metric, imperial) for displaying numeric values, with options for offset and scaling.
- Variable Logging: Allows capturing process and sensor data for analysis, with options for fixed-time or event-based logging.
- Device Software Update: Supports updating OS and PClient software on devices via USB, CAN, or Ethernet, with specific instructions for different device models (OPUS A3/A6 G1, A6 G2/A8, B3, ISO-V2).
- Touch Screen Calibration: Provides methods for calibrating resistive touchscreens on devices.
- Ethernet Camera Configuration: A dedicated tool for configuring ISO 17215-compliant Ethernet cameras, including IP settings, stream protocols, and image adjustments.
- Power Management: Devices support different power modes (On, Low Power, Sleep, Off) to save energy, with configurable timeouts and hardware element states.
- Error Reporting: Users can send crash, issue, and feedback reports to Topcon Electronics for support and product improvement.
Maintenance Features:
- Online Update: The software can receive online updates for bug fixes, new features, and device software.
- Project Versioning: A Git-based system for tracking project revisions, allowing users to revert to older states and manage tags.
- Clean Up Unused Images: The Image Pool helps identify and delete images not currently used in the project.
- Log File Management: Variable logging generates log files that can be copied to external media (e.g., USB stick) for analysis.
- Serial Console Access: Allows connecting to the device's Linux system for debugging, changing boot logos, and managing files.