Differences

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

--- doc:usage [2014/01/18 09:28] – admin
+++ doc:usage [2014/03/02 08:28] (current) – removed admin
@@ Line 1: / Line 1: @@
-====== Usage ======
-We've tried to give both Android and Windows versions the same look & feel. So the handling instructions work for both
-===== Pairing =====
-On both Android and Windows the Bluetooth dongle needs to paired once before it can be used. Please follow the standard Android or Windows instructions about how to pair a Bluetooth device. The PIN number of the OOBD bluetooth devices is 1234.
-==== Windows COM port ====
-Under Windows the App does not directly connect to the BT dongle like on Android, it uses the COM port instead which Windows assigns to that device. That's allows also other programs like terminal programs or third parties applications to talk to the OOBD dongle.
-Which COM port is assigned can be found in the Bluetooth device settings:
-{{:pics:windows-bt-devices.png?200|}} {{:pics:windows-bt-properties.png?200|}}{{:pics:windows-bt-comport.png?200|}}
-===== Settings =====
-{{:pics:oobdesk-settings-menu.png?200|}}
-Under Menu/Settings please select your OBD device. If it not appears in the list then you've forgotten to pair it before ;-)
-Under Windows select the COM- port, which is assigned to the dongle (as descripted above)
-{{:pics:settings.png?150|}}{{:pics:oobdesk-settings.png?400|}}
-In Android, the scripts are fixed stored in /sdcard/OOBD. Under Windows, you can choose the script directory. The installation default directory is (your Documents)/OOBD-Scripts, but you are free to choose another one.
-==== PGP- Settings ====
-In case you want or you have to use PGP encrypted scripts (e.g. because of company policies), you have to import the keyfiles to be able to decrypt the encrypted scripts.
-    - From the key generation process and from your Key adminstrator you've received several files, including ''groupkey.sec'' and ''userkey.sec''. **Before starting the settings**, place these two files into the script folder you want to use as script folder in this setup process.
-    - When going into the settings then, OOBD will detect the existence of these two files and flags this by naming the button as "Import Keys now". When pressing the button, the both files will then be imported and removed from the script directory. The button text changes to "Delete keys"
-    - Now the "Use PGP" checkbox is not grayed out and can be selected. Please select. This is important to make OOBD to ask for your personal passphrase at startup. Without this passphrase you could not open any PGP file
-{{:pics:oobdesk-enter_passphrase.png?200|}}
-Because of the functionality behind, you might get a new ''groupkey.sec'' from your key administrator from time to time. When this happens, copy the ''groupkey.sec'' into your script folder again and go again into settings. The button then shows "Import new group key". By press the button, the new group keys will be imported into OOBD.
-When having both ''groupkey.sec'' and ''userkey.sec'' imported, the button text says "Delete keys now". By doing this, both keys get been deleted and would need to be re-imported again as described above to be able to use PGP again.
-===== Mainscreen =====
-Select the script you want to run and press the round Button to start
-{{:pics:oobdesk-selectscipt.png?400|}}{{:pics:mainscreen.png?150|}}
-===== The Diagnose Screen =====
-{{:pics:diagnose.png?150|}}{{:pics:oobdesk-diagnosewindow2.png?400|}}
-The Diagnose screen consists of two tabbed panes, the Diagnose pane  and the Output pane
-==== The Diagnose Pane ====
-The Diagose Pane {{:pics:oobd_32.png|}} contains two buttons and a list of items.
-==== The Item list ====
-In the Item list you'll find the description of the item, the actual value and a set of flags
-==== The Item flags ====
-^  Symbol  ^  Name  ^  Meaning  ^
-| {{:pics:back.png|}}     |  Back              |  Indicates the jump back to the previous menu  |
-| {{:pics:update.png|}}   |  Update            |  Item will be updated when the Update Button is pressed  |
-| {{:pics:timer.png|}}    |  Permanent Update  |  Item will be updated permanently as long the Timer Toggle Button is active  |
-| {{:pics:text.png|}}     |  Log Changes       |  When value changes, new value  will be written to output\\ Combined with Permanent Update, this will create a continious log  |
-| {{:pics:forward.png|}}  |  Submenu           |  No function, just a visual indicator for a further sub menu  |
-==== The Update Button  ====
-The Update Button {{:pics:update.png|}} starts an update of all actual visible items, which are marked with the update flag {{:pics:update.png?16|}}
-==== The Timer Button  ====
-The Timer Button {{:pics:timer.png|}} updates all actual visible items permanently, which are marked with the timer flag {{:pics:timer.png?16|}}
-==== The Back- Button ====
-If the user selects the Back- Button, which is part of the mobile phone itself, it is checked if the item list contains any items which are marked with the Back flag {{:pics:back.png?16|}}. If yes, the first found item is called, which then jumps back to the previous menu.
-If no such item is found, the program jumps back to the main screen.
-==== Changing the item flags ====
-{{:pics:togglemenu.png?150|}}
-The Update, Timer and Log flag on an item can be changed by the user. Just hold the list item on Android or press the RMB on Windows. A context menu which will you to toggle the flag and by that the behaviour of this list item.
-===== The Output Pane =====
-{{:pics:output.png?150|}}
-The Output Pane {{:pics:text.png|}} contains a button row and a text field. The textfield is editable, so an output can be changed before saving or sending.
-The Output functions:
-^  Symbol  ^  Name  ^  Meaning  ^
-| {{:pics:cancel.png|}}     |  Clear              |  Clears the textfield  |
-|  -    |  Logging Active   |  If inactive, no futher text will be added to the output  |
-| {{:pics:disk.png|}}    |  Store  |  Allows to save the text or send it by one of the available message channels like Email, Twitter etc., depenting on the actual Android device settings  |
-====== First Success: Trying out the OOBD Standard Script ======
-After you have now reached this point after going through the process of installing and setup and understanding the screens of OOBD, it's now time to have a first real touch with a real vehicle with OOBD with [[oobdscript|the OOBD standard script]].
-====== Bugs ======
-As said, AndroidOOBD is still in beta state. If something seems to be wrong or is not working as expected, please check the [[http://code.google.com/p/oobd/issues/list|OOBD- Bugtracker]] is this is a known problem. Please feel free to add comments to the known bugs or raise new ones. Please respect that bugs reported just by email or only verbaly will not be considered.