doc/readme.txt

   1 * Introduction
   2   ================
   3   smartDeviceCore is an application which manages the transport, connection and communication between a head unit and mobile device.
   4
   5 * OS and Hardware
   6   =========
   7   Ubuntu 12.04.1 LTS 32-bit OS on the PC with USB-dongle
   8   Application has been tested using 2 types of USB-dongle:
   9   D-Link DBT-122
  10   STLab B-121mini
  11
  12   * External components
  13   ===================
  14   For start application we need:
  15   libbluetooth3, the BlueZ library
  16   Install library:
  17   sudo apt-get install libbluetooth3
  18   To start web-based HMI we need web-browser with web-socket RFC6455 support.
  19   For example Google Chromium. Install it using:
  20   sudo apt-get install chromium-browser
  21   In current implementation Chromium is required for autostart HMI feature.
  22   For HMI autostart please create in the executable folder file named hmi_link.
  23   This file should contain one string with full path to HMI index.html file.
  24   For example:
  25   /home/user/projects/smart_device_link/src/components/HMI/index.html
  26
  27 * Running application
  28   ====================
  29   Plug USB-dongle in.
  30   Switch Bluetooth on a mobile device ON and make the device discoverable.
  31   Pair mobile device with PC using Ubuntu tools.
  32   Device should contain SmartDeviceLink compatible application installed.
  33   Start application with command:
  34   ./smartDeviceLinkCore
  35   Application starts to search devices and starts HMI in cromium-browser.
  36   In case HMI has not been started please start web-based HMI manually in browser opening src/components/HMI/index.html.
  37   SmartDeviceLinkCore is searching Bluetooth devices with a correspondibg service.
  38   Go to info menu in HMI and press App button.
  39   Press change Devices button.
  40   Select the device from a list.
  41   Application opens all available ports on devices and starts communication.
  42   Returning to the App menu all applications will be shown in a list.
  43
  44 * Colorized logs
  45   ==============
  46   You can have colorized log output of smartDeviceLinkCore's messages in the terminal with the help of grc:
  47
  48   1. Make sure grc is installed:
  49   sudo apt-get install grc
  50
  51   2. Copy the config files from the grc/ directory into ~/.grc/ directory:
  52   mkdir ~/.grc
  53   cp grc/* ~/.grc/
  54
  55   3. Add an alias to your shell's config (usually, ~/.bashrc or ~/.zshrc):
  56   alias grca='grc -es --colour=auto'
  57
  58   Either restart the shell session or source the edited file:
  59   source ~/.bashrc
  60   or
  61   source ~/.zshrc
  62
  63   4. Start the smartDeviceLink core with the following command:
  64   grca ./smartDeviceLinkCore
  65
  66   5. PROFIT
  67