User Tools

Site Tools


**The OOBD Book** Download as [[epub|eBook]] \\ Download as [[|PDF / Mobi]] * [[start|Documentation]] * Installation * [[startup_javame|OOBD-ME (Mobile Phones)]] * [[startup_android|OOBD-Android]] * [[startup_windows|Windows OOBDesk]] * [[startup_embedded|Raspi & Co]] * [[startup_usage|Start the programs]] * [[startup_oobdscript|First Success: Run the OOBD script]] * [[lua_start|Lua in OOBD]] * [[tools_quickscript|Click your Script: Quick Script]] * [[lua_make-your-own-scripts|Make your own OOBD Scripts]] * [[lua_tutorial|The OOBD Lua Tutorial]] * [[lua_make|Lua Build Enviroment]] * Web UI * [[:de:doc:webui_tutorial|Web User Interface Tutorial(German)]] * [[webui_guide|Web UI Package structure]] * [[:de:doc:webui_simulator|UI Emulator for development(German)]] * [[hw_start|The OOBD Hardware]] * [[hw_quickstart|OOBD Cup Quick Start]] * [[hw_assembly-cupv5|Build your own Dongle]] * [[hw_busswitch|Add a second Bus to DXM]] * [[hw_bootloader|Flash the Bootloader]] * [[hw_firmware|Flash the Firmware]] * [[hw_flash-from-usb-stick|Flash the Firmware from USB-Stick]] * [[hw_commands|The Firmware Commands]] * [[tools_start|The OOBD Utilities]] * [[tools_kadaver|Kadaver]] * [[tools_quickscript|Quick Script]] * [[tools_cortex-crc32|Cortex-CRC32]] * [[tools_filelist|Filelist]] * [[tools_olp|OLP]] * [[tools_oobdcopyshop|OOBDCopyShop]] * [[tools_oobdtemple|oobdtemple]] * [[tools_oodbcreate|OODBCreate]] * [[tools_opendiagx|OpenDiagX]] * [[tools_oobdcmd|OOBDcmd]] * [[tools_oobdflash|OOBDFlash]] * PGP * [[pgp_setup|Install PGP Keys]] * [[dev_start|Development]] * [[dev_googlesetup|Join the News]] * Setup your Developer Environment * [[dev_cygwininstall|CygWin Environment]] * [[dev_setupswing|Java Swing]] * [[dev_setupme|Java ME]] * [[dev_setupandroid|Android]] * [[dev_androidlivecd|The Android Debug Live CD]] * [[dev_setupfirmware|Firmware]] * [[dev_clientdesignguide|User Interface Design Guide]] * [[dev_systemspec|The OOBD System Spec]] * [[dev_readotherformats|Import XML files]] * [[dev_links|Link Collection]] * [[dev_roadmap|Road Map]] * [[rfc_start|Specifications (RFC)]] * [[rfc_firmware_syntax|OOBD Firmware: General Command Syntax]] * [[rfc_canuds-mode|OOBD Firmware: Protocol : UDS (P 6 ..)]] * [[rfc_canraw-mode|OOBD Firmware: Protocol : CANraw (P 6 ..)]] * [[rfc_rtd-real-time-data-protocol-for-the-oobd-firmware|OOBD Firmware: Protocol : Real Time Data (RTD) (P 6 ..)]] * [[rfc_pgp-encrypting-sensible-data-with-pgp|PGP Principle]] * [[rfc_onion|The ONION Message Format]] * [[faq|Frequently Asked Questions]]


User Interface Design Guide

To have a common look & feel on all the platforms OOBD is supposed to run,its been planned to have a similar behavior as a web browser, which means in general to have a single, stateless page, from where you can move away by selecting something, or you can jump one page back using a back - button.

When the program starts, at first it is shown

  • the OODB logo
  • the OOBD URL
  • optional: A selection method of the script engine to use, if the implementation supports more as one engine
  • a start button (to start straight with the actual settings)
  • a menu entry for configuration

When a script engine is started, a page is generated containing all the visualizers of that page.

Each visualizer shows at least 3 different information:

  • the actual value (that can be e.g. text, a symbol, a analog bar graph etc.)
  • the meaning of that value (text, an image, the tool tip of an icon etc.)
  • a set of flags, where up to now 3 are defined:
    • reprents that visualizer another submenu
    • is that visualizer update-able?
    • is that visualizer auto- refresh-able?
    • is that visualizer loggable?

The flags are splited into system and user flags. 8 flags (0-7) are reserved for system, 8 free for the application.

The meaning of the system flags and their appearance are defined as follow:

System Flag appearance
Nr Meaning Textual Symbol
0 Sub-Menu >
1 Update U
2 Auto-Refresh (Timer) T
3 Log L
3 Back to previous Menu <

Where of course the size of the symbols are driven by the available space.

If a flag is not set, it either shown textual as a dot . or the symbol is grayed out.


On these pages there's either a “hardwired” Back- Key on the device itself or a Back- Button to go back to the previous page.

The value of on visualizer is been updated (or the action of such visualizer) is been started by

  • selecting the entry and press the main “ok” button on devices with key controls
  • tap on the visualizer on devices with touchscreen
  • double click on that visualizer on mouse controlled device

Each visualizer also has a context menu containing the following function calls:

  • Detail (optional): If the whole text might not fit onto the screen, this function opens a scrollable text area to show the complete visualizer output
  • toogle flags: Each available flag (see above) can be toggled on or of separately

The next three function can either be also in the page menu or on the page itself, that's up to the application:

  • Update: Starts the “update value” process for all visualizers of that page, which are marked as update-able
  • Refresh: Toggles the auto refresh timer on/off, which starts, when active the regular “update value” process for all visualizers of that page, which are marked as refresh-able
  • Output: Brings the output text area in front

The Output Textview

The application also has a text output area belongs to for collecting all text outputs the script engines do. For these text area the following rules applies:

  • normally the “text window” is hidden in the background. It comes to front, when a new output is made
  • the text area is not cleared when the page is rebuild with different content
  • the text area supports the following buttons
    • Clear: clears the content
    • Save (optional): Save the content to a file
    • Hide: brings the text area back into background
This website uses cookies for visitor traffic analysis. By using the website, you agree with storing the cookies on your computer.More information
doc/dev_clientdesignguide.txt · Last modified: 2014/03/10 08:41 by admin