cordova-sectv-orsay

cordova-sectv-orsay is an application library that allows for Cordova-based projects to be built for the Legacy Samsung Smart TV (A.K.A Orsay) Platform. Cordova based applications are, at the core, applications written with web technology: HTML, CSS and JavaScript.

Supported Platform

• Legacy Samsung Smart TV (sectv-orsay)

Supported cordova plugins

There are 3 cordova plugins which are supported on TOAST

• cordova-plugin-device
• cordova-plugin-globalization
• cordova-plugin-network-information

If you want more details, please refer Supported Cordova Plugin

Project Structure

    ./
     |-cordova-js-src/ .... cordova-js sectv-orsay platform implementation
     |  |-plugin/ ......... cordova plugin implementations
     |  |-exec.js ......... cordova/exec module
     |  `-platform.js ..... cordova/platform module having platform definition and bootstrap
     |-www/ ............... Project template for Orsay platform
     |-package.json ....... NPM package configuration
     '-README.md .......... this file

How to Build

This section describes the build process which creates cordova.js file for the sectv-orsay cordova platform. Please see Cordova-js for more detail of compile task.

1. Clone the Cordova-js project as sibling of this project.

   $ git clone https://github.com/Samsung/cordova-sectv-orsay.git
   $ git clone https://github.com/apache/cordova-js.git

   Repositories will be created like below directory structure.

   ./
    |-cordova-js
    `-cordova-sectv-orsay
   

2. Add "sectv-orsay" as a target of "compile" task on Gruntfile.js in the cordova-js project.

   ...
   grunt.initConfig({
       pkg: grunt.file.readJSON('package.json'),
       "compile": {
           ...,
           "sectv-orsay": {}
       },
       "compile-browserify": {
       ...
   });

3. Add "sectv-orsay" property to "cordova-platforms" object in the cordova-js project's package.json with path to this project's repository as its value.

   "cordova-platforms": {
       ...,
       "cordova-sectv-orsay": "../cordova-sectv-orsay"
   }

4. In the cordova-js directory's root, run below command to create cordova-js/pkg/cordova.sectv-orsay.js file.

   $ grunt compile:sectv-orsay

5. We recommend to copy the created file to the www directory which is including Orsay Application project templates for further use. In the cordova-js directory:

   $ cp ./pkg/cordova.sectv-orsay.js ../cordova-sectv-orsay/www/cordova.js

How to use

For creating application package for Orsay TV:

1. Copy your Cordova project's www directory which includes your application implementation to a new directory for the orsay project.

   Assuming we've developed a Cordova project named as "MyProject" and it is located as a sibling of cordova-sectv-orsay.

   ./
    |-cordova-js
    |-cordova-sectv-orsay
    `-MyProject
      |- platforms
      |- plugins
      |- www
      |  |- index.html
      |  `- ...
      `- config.xml
   

   $ cd MyProject
   $ cp -rf ./www ./orsayprj

2. Create the Orsay config.xml file in the orsay project.

3. Copy the built cordova-js/pkg/cordova.sectv-orsay.js to your new orsay project root with name cordova.js.

   $ cp ../cordova-js/pkg/cordova.sectv-orsay.js ./orsayprj/cordova.js

4. Zip the orsay project directory to package.

   $ zip -r MyProject_sectv-orsay.zip ./orsayprj

• We recommand to use the grunt-cordova-sectv Grunt task to automate these process.

Known Issues

Not yet