@tizentv/witstest v1.0.4

Wits

Wits is a useful development tool for helping to run and develop your Tizen web application easily on your 2017+ Samsung TV. It is the fastest way to get your local code running on the TV device during development. Saving you from having to build, package, and reinstall your application every time you want to see how it will run on device. We call it a LIVE RELOAD. Wits is helpful to continue your developing context.

Installing and Configuring Wits

For developers using npm

1. Install wits npm globally

    $ npm install -g @tizentv/wits

For developers using Git repository

1. Clone Wits git repository.

    $ git clone https://github.com/Samsung/Wits.git

2. Install Wits Dependencies

    $ cd ~/{path-to}/Wits
    $ npm install

3. Modify .witsconfig.json within Wits directory.

Configure Tizen Studio Certificate Profile Name and the path of your profiles.xml to .witsconfig.json The default path is tizen-studio-data/profile/profiles.xml on Mac and Windows both. The name should be your pre-configured certificate profile name which is foundable at the one of these locations:

-Tizen Studio (Recommended) Tools > Certificate Manager > Certificate Profile (Actived one)

For details, How to get your profile information

System Requirements

Wits needs the following prerequisites on your local development machine.

1. Open Terminal on MacOS / Linux or CMD / PowerShell on Windows

2. Install Node.js and Git (recommend v7.10.1 for Wits)

We will not describe how to do these installations as there are many ways to do it and its developer preference. We recommend using something like nvm or asdf to manage different versions of Node.js across your code projects.

3. Install the Latest Version of Samsung Tizen Studio.

4. Tizen Studio CLI binaries should be added to your $PATH for accessing to tizen and sdb command-line utilities.

For details, How to add System environment path for Wits

5. Developer Mode is enabled on your Samsung TV.

• 1 With your Samsung Remote, press the Home button.

• 2 Navigate to the Apps button and press Enter/OK.

• 3 When on the Apps screen, press 1 2 3 4 5 in order on the remote to open the Developer Mode Dialog. If this doesn't work, try it again.

• 4 When the Developer Mode Dialog appears, toggle the switch to On and enter the IP address of your development machine.

Wits details

The Project Structure for using wits

.witsconfig.json, .witsignore files are only added at the your tizen web application.

Wits command options

1. wits

For showing which options you can use

2. wits -i / wits --init

For configuring wits Please note that, It should be run when you use first time on your tizen application project. .witsconfig.json and .witsignore files are generated on your tizen app project. After then, you can modify your information to them.

3. wits -s / wits --start

All in one. For connecting to TV, installing and launching your app and using Live Reload If wits -i hasn't run before, It is not allowed to run.

4. wits -w / wits --watch

For conneting to TV, using Live Reload After connecting, every time you make changes on your tizen app project, It is reflected to TV device instantly.

.witsconfig.json of Wits

For details, Sample data for .witsconfig.json on Windows and MacOS both, Wits recognises path segment only one separator(/).

• connectionInfo (mandatory)
  • recentlyBaseAppPath string : Recently using project path. Let it be as a default. Wits is mainly run on your current project ex) "."
  • baseAppPaths array : Paths of your working projects
  • width string : Resolution
  • ip string : TV Ip address
  • port integer : TV port. It is generated randomly in Wits.
  • isDebugMode boolean : Setting true, chrome inspector is launched automatically. / Setting false, nothing happened.
• profileInfo (mandatory)
  • name string : Tizen Studio Certificate Profile name
  • path string : Tizen Studio Certificate Profile path
• optionalInfo (optional)
  • proxyServer string : In case you are behind proxy ex) http://192.168.250.250:8080
  • hostIp string : Basically wits gets your pc ip address automatically, but use it in case you need to use your custom pc Ip.

.witsignore of Wits

Sometimes there are a few files what you do not want to push to your TV device such as .git or node_modules. If you input unnecessary files or directories on .witsignore file before pushing files to the TV device, It would be pushed except them to your TV. You can use it optionally. This works exactly same as .gitignore.

Example of .witsignore:

node_modules
.git
deprecated
stglib

Running Your App

If you want to follow Step by Step. Please refer Running Your App using Wits

FAQ

• Wits FAQ
• How to use debug mode on Wits with Chrome inspector
• What if being behind a proxy
• How to get your TV IP Address

Supported Platforms

• 2017 Samsung Smart TV (Tizen 3.0)
• 2018 Samsung Smart TV (Tizen 4.0)
• 2019 Samsung Smart TV (Tizen 5.0)