User Tools

Site Tools


doc:tools_quickscript

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
doc:tools_quickscript [2015/02/14 21:01]
admin
doc:tools_quickscript [2015/02/21 09:15] (current)
admin
Line 17: Line 17:
 ===== How it Works ===== ===== How it Works =====
  
-When opening the page, you'll find a first template and a menu bar in the middle of the screen. When clicking onto the items in the menu bar, another menu opens where you can select the functionality you need. While all the other menu items only contain standard lua function, we'll concentrate on the OOBD menu with its related functions here.+When opening the page, you'll find a menu bar and a initial template. When clicking onto the items in the menu bar, another menu opens where you can select the functionality you need. While all the other menu items only contain standard lua function, we'll concentrate on the OOBD menu with its related functions here.
  
  
 +===== The Buttons =====
  
 +In the upper right corner you find some buttons. These are
 +  * **Clear Canvas** : This cleans the whole drawing area
 +  * **Import QS-Template** : Loads a template from a file. **Please note** This loads the file into the existing content to allow to merge several templates into one program without deleting something before. But by importing things twice you can easily overlay one block with the same, which would cause faulty programs. So make sure that unwanted content is deleted first. When start from scratch, you should clean everything with the "Clear Canvas"​ button first
 +  * **Save QS Template** : Saves the actual content as a Template file
 +  * **View Lua Source** : Shows the actual content in its Lua representation
 +  * **Download as compiled OOBD Script** : This takes the actual content in its Lua representation,​ starts the build in Lua compiler, links it with the integrated runtime library and downloads the compiled lua file. This file can directly run in OOBD.
  
-===== The Main Menu =====+ 
 +===== The OOBD Fuctions ===== 
 + 
 + 
 +==== The Main Menu ====
  
 {{:​doc:​qs_mainmenu.png |}} {{:​doc:​qs_mainmenu.png |}}
Line 28: Line 39:
 This is the starting point for your program. The program execution starts here, so here you can put the initialisation stuff in here (like setting the bus- and module parameters). Here you also need to place your main menu (in case you want to have one) with its menu items. This is the starting point for your program. The program execution starts here, so here you can put the initialisation stuff in here (like setting the bus- and module parameters). Here you also need to place your main menu (in case you want to have one) with its menu items.
  
-===== The Menu =====+==== The Menu ====
  
 {{:​doc:​qs_menu.png |}} {{:​doc:​qs_menu.png |}}
Line 37: Line 48:
  
  
-===== The Menu Item=====+==== The Menu Item ====
  
 {{:​doc:​qs_menuitem.png |}} {{:​doc:​qs_menuitem.png |}}
Line 50: Line 61:
  
  
-===== The Item Procedure ​=====+==== The Item Procedure ====
  
 {{:​doc:​qs_procedure.png |}} {{:​doc:​qs_procedure.png |}}
Line 59: Line 70:
  
  
-===== Set the Dongle ​=====+==== Set the Dongle ====
  
 {{:​doc:​qs_dongle.png |}} {{:​doc:​qs_dongle.png |}}
Line 69: Line 80:
   * Protocol: Here you decide between the Real Time Data (RDT) listening or the UDS communication protocol   * Protocol: Here you decide between the Real Time Data (RDT) listening or the UDS communication protocol
  
-===== Define the Module ​=====+==== Define the Module ====
  
  
Line 76: Line 87:
 This tells which module address to be used and how much time in milliseconds we'll give for a module answer. ​ This tells which module address to be used and how much time in milliseconds we'll give for a module answer. ​
  
-===== Request a Service ​=====+==== Request a Service ====
  
 {{:​doc:​qs_service.png |}} {{:​doc:​qs_service.png |}}
Line 87: Line 98:
  
  
-===== Evaluate a Result ​=====+==== Evaluate a Result ====
  
 {{:​doc:​qs_measure.png |}} {{:​doc:​qs_measure.png |}}
Line 104: Line 115:
   * Offset & Multiplier: Used in case of a numeric value: First the received bit sequence (defined by Startbit and Length) is transformed into an integer value. Then this value is multiplied with the multiplier and finally added by the offset.   * Offset & Multiplier: Used in case of a numeric value: First the received bit sequence (defined by Startbit and Length) is transformed into an integer value. Then this value is multiplied with the multiplier and finally added by the offset.
   * Unit: In case of a numeric value, the Unit is attached to the numeric value to define its unit. In case of a bit value, the unit contains the textual description of the low ans high value of that bit, seperated by an |   * Unit: In case of a numeric value, the Unit is attached to the numeric value to define its unit. In case of a bit value, the unit contains the textual description of the low ans high value of that bit, seperated by an |
- 
- 
doc/tools_quickscript.txt · Last modified: 2015/02/21 09:15 by admin