--- /dev/null
+Author: Michal Horn
+Date: 18.2.2015
+
+The Demo application for Skoda Auto Mlada Boleslav
+==================================================
+1. Introduction
+----------------
+This demo application is available for Google Glass with XE22 firmware (Android 4.4.4)
+and tablets and smart phones with Android at least 4.1.6.
+The demo application is designed for viewing PDF documentation for components. The user
+scans the QR code containing an identifier of the component. The application views a picture
+of the component with a menu with all available documents for it.
+The user then select the document he wants to view and the application opens the
+PDF file.
+
+The demo consists of two applications. Both of them have to be installed on the device in
+order to run the demo.
+
+1.1 BarCodeScanner
+------------------
+This is a standalone application based on zxing library for scanning 2D codes. The repository with the original versions of the application can be accessed from https://github.com/zxing/zxing.
+This version is slightly modified to work better with our codes and devices and is tuned to not conflict with the original one. The application does not create any icon in the launcher. You
+can check and ininstall it from the Applicatinos settings dialog.
+The BarCodeScanner is invoked from QRScanner as an intent from mobile version or through the
+Integration layer from glass version.
+
+1.2 QRScanner
+-------------
+This is the main application that invokes the code scanning, creates preview, open PDF files and
+interacts with the user.
+In order to work properly, the BarCodeScanner application is required to be installed on the
+device.
+
+2. Installation
+===============
+2.1 BarCodeScanner
+------------------
+To run properly, the BarCodeScanner from this repository is required to be installed. To install
+the BarCodeScanner application run this command:
+./adb install /path_to_package/mobile-debug.apk for smart phones and tablets or
+./adb install /path_to_package/glass-debug.apk for Google Glass.
+
+This application does not create any launcher application.
+
+2.2 QRScanner
+-------------
+This application needs a database of te documents to be created to work correctly. The
+database is a simple file structure stored in /storage/sdcard0/Pictures/skoda/components/ on
+the device. This root folder contains subfolders named as the component ID. Every one
+of this subfolders contains pdf files with documents available for the particular component.
+
+To install the database, which source is present in /repository/QRScanner/database run this command:
+./adb shell mkdir -P /storage/sdcard0/Pictures/skoda/components/
+./adb push /repository/QRScanner/database /storage/sdcard0/Pictures/skoda/components/
+
+To install the application itself run this command
+./adb install /path_to_package/mobile-debug.apk for smart phones and tablets or
+./adb install /path_to_package/glass-debug.apk for Google Glass.
+
+3. Usage of the Google Glass version
+====================================
+3.1 Launch the application
+--------------------------
+The application can be launched by taping on SkoMan item in the menu. A fullscreen Skoda logo
+will appear once the application is loaded and running.
+
+You can exit the application from this screen by the slide down gesture on the touchpad.
+
+3.2 Scanning QR codes
+---------------------
+The application retrieves the component ID by scanning the QR code. The scanning can be
+started by one tap on the touchpad, when the fullscreen Skoda logo is displayed.
+The scanner provides a preview image from the camera to the display. To capture the code,
+aim the code to the middle of the display. The Code should be recognized in a second or two.
+and once the code is recognized, the application switches to a component preview activity.
+
+You can abort recognizing in every time and return back to the start screen by the slide down gesture on the touchpad.
+
+If the recognition process takes significantly longer, check:
+ 1) If the code in the camera preview is too large, try the recognition from bigger distance.
+ 2) If the code in the preview is too small, try the recognition closer. Keep in mind though, that the Google Glass camera does not have autofocus, so the recognition distance should not be lower than 30cm.
+ 3) Look at the code directly, not from an angle.
+ 4) Check that the QR code is at least 25x25 mm large.
+ 5) Check that the background is not disturbing
+ 6) Check the light conditions.
+
+3.3 Selection of a document to be viewed
+----------------------------------------
+After a successful QR code recognition the application will switch to a component preview mode, where you can see a picture of the component.
+
+You may go back to the start screen by the slide down gesture on the touchpad.
+
+Tap the touchpad to open the application menu. Use gestures slide forward and backward to find the desired document or to return back to the start screen (Stop menu item). Tap on the touchpad to select the menu item.
+
+If a document has been selected, it will be opened in the PDF viewer.
+
+3.4 PDF Viewer control
+----------------------
+When the Component document was selected in the component preview screen, it will be loaded and viewed by a PDF file viewer, designed especially for Google Glass.
+When the PDF viewer launches, you will see a status panel in the top of the screen and a progress bar, indicating that the document is loading, in the middle of the screen.
+
+The status bar contains three information. Page number in format actual_page/total_pages, zoom in percents and viewer state. The viewer has two states:
+ 1) Viewing - this is default state when the viewer launches. In this state you can comfortably read the fragment of the document without any interruptions.
+ 2) Scrolling - This state enables scrolling in the document and zooming in and out.
+
+To switch between those the viewer states, tap the touchpad.
+
+Once the document is loaded, you will se a fragment of it, because the Glass display is not big enough to view most of the documents at one. To move in the document, switch to the scrolling state and gently move your head to scroll the document.
+
+To zoom in or out, switch the viewer to scrolling state and use slide forward and slide backward gestures respectively.
+
+To close the document, use the slide down gestures on the touchpad.
+
+4. Usage of the Tablet and smart phone version
+==============================================
+4.1 Launch the application
+--------------------------
+The application can be launched from launcher on the smart phone or tablet by clicking on the Skoda Manufacture Helper icon. Once the application is loaded and running a fullscreen Skoda logo is displayed on the screen. Touch the screen anywhere or select Scan item in the application menu to start QR code recognition.
+
+4.2 Scanning QR codes
+---------------------
+The application retrieves the component ID by scanning the QR code. When the fullscreen Skoda logo is displayed, touch the screen anywhere or select Scan item in the application menu to start QR code recognition.
+The scanner provides a preview image from the camera to the display. To capture the code,
+aim the code to the middle of the display. The code should be recognized in a second or two.
+and once the code is recognized, the application switches to a component preview activity.
+
+You can abort recognizing in every time and return back to the start screen by touching the back button.
+
+If the recognition process takes significantly longer, check:
+ 1) If the code in the camera preview is too large, try the recognition from bigger distance.
+ 2) If the code in the preview is too small, try the recognition closer. Keep in mind that if your device does not have autofocus, the recognition may not work perfectly for codes smaller than 25x25mm and from distance lower than 30cm.
+ 3) Look at the code directly, not from an angle.
+ 4) Check that the background is not disturbing
+ 5) Check the light conditions.
+
+4.3 Selection of a document to be viewed
+----------------------------------------.
+After a successful QR code recognition the application will switch to a component preview mode, where you can see a picture of the component.
+
+You may go back to the start screen by touching the back button and you may rotate the screen if enabled on the device.
+
+Next to the component preview image is a menu with documents available fr the component. To open the document in a PDF viewer, just click on the button.
+
+4.4 PDF Viewer control
+----------------------
+The application is distributed with an embadded PDF document viewer based on MuPDF library. This viewer has an ability to highlight text, search for words, reflow, scroll and zoom the document.
+
+You can scroll the document by your finger, use two finger gesture to zoom in and out.
+
+To cloce the document and go back just click the back button.
+
projects / hornmich / skoda-qr-demo.git / commitdiff