User Tools

Site Tools


xw_common

COMMON

Summary

The common shared folder is for where the common components will reside. All WRT applications in the project use a common infrastructure which provides following functionality:

  • CarIndicator - Access to AMB properties
  • Configuration - Global application configuration
  • ThemeEngine - Application theming
  • IncomingCall- Handling of incoming calls
  • Speech - Text-to-speech and Voice recognition
  • Settings - Global Settings UI

Common components will include but not limited to various files format as listed below.

File types:

  • .css
  • .json
  • .js
  • .html
  • .png
  • .ttf
  • .svg

Resources

Source Code located on GitHub:

Access the Source for Common-app.

Access the Source for Common-native.

Location & File Structure

The “_common” repository is located in the source tree at the same level as the WRT applications (such as HomeScreen, HVAC, Dashboard, etc.).

File structure is as follows:

There are three folders off of the _common, css, and js.

The JS folder contains the following folders and files:

./js: services

./js/services: bootstrap.js – contain all plugins in a single file

This class provides unified way to boot up the HTML applications by loading shared components in proper order:

  • Configuration
  • ThemeEngine
  • CarIndicator
  • Speech
  • IncomingCall

carIndicator.js – contains car indicator information to access to AMB properties

Class provides AMB related functionality utilizing tizen.vehicle API for signals used in HTML applications. This component is usually initialized by Bootstrap class and can be later accessed using carIndicator property. Signals recognized by this class needs to be registered in property _mappingTable.

extends.js – provides functional Inheritance

speech.js – Speech class provides text to speech (TTS) and speech to text (STT)

Speech class provides text to speech (TTS) and speech to text (STT) or speech recognition functionality utilizing tizen.speech API. This component is usually initialized by Bootstrap class and can be later accessed using global Speech object.

themeengine.js – This class provides unified way to access available themes

This class provides unified way to access available themes, detection of theme changes and method of updating selected theme. This component is usually initialized by Bootstrap class and can be later accessed using themeEngine object. Component uses Configuration class to persist selected theme in key specified by selectedThemeKey.

The CSS folder contains the following folders and is used to apply the style to the application:

./css:

Car – Contains the fonts, images, spinner.css, and theme.json

User – Contains the details

xw_common.txt · Last modified: 2015/03/30 18:20 by FGraham