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.
Always welcome, if you contribute WITs guide in your language! Guides should be placed in "doc" directory. Please pull-request and join it!
$ npm install -g @tizentv/wits
$ git clone https://github.com/Samsung/Wits.git
$ cd ~/{path-to}/Wits
$ npm install -g
WITs needs the following prerequisites on your local development machine.
Terminal
on MacOS / Linux or CMD
/ PowerShell
on WindowsWe 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.
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.
Certification(Tizen / Samsung) is required for packaging your tizen web application.
Using Editor
Tizen Studio Install the latest version of Tizen Studio.
VSCode Install the latest version of VSCode. And download the extension "tizensdk.tizentv".
Atom Install the latest version of Atom. And download the package "atom-tizentv-2"
Using WITs
.witsconfig.json, .witsignore files are only added at the your tizen web application.
wits
For showing which options you can use
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.
wits -c
/ wits --certificate
For creating a certification(Supported Tizen certification only).
As following steps, you can create a certification on ~/{path-to}/wits/resource/profiles.xml
.
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.
# Run wits --start
$ wits -s
# Run wits --start with deviceIp. Available to switch the device Ip easily.
$ wits -s deviceIp=192.168.250.250
# Run wits --start with deviceIp. Available to switch the device Ip easily. For debugging, add --verbose option. It should be at the end of command.
$ wits -s deviceIp=192.168.250.250 --verbose
wits -w
/ wits --watch
For connecting to TV, using Live Reload
After connecting, every time you make changes on your tizen app project
, It is reflected to TV device instantly.
# Run wits --watch
$ wits -w
# Run wits --watch with deviceIp. Available to switch the device Ip easily.
$ wits -w deviceIp=192.168.250.250
# Run wits --watch with deviceIp. Available to switch the device Ip easily. For debugging, add --verbose option. It should be at the end of command.
$ wits -w deviceIp=192.168.250.250 --verbose
WITs supports the following APIs
For detail, check whole APIs in How to use WITs as APIs.
For details, Sample data for .witsconfig.json
on Windows
and MacOS
both, WITs recognises path segment only one separator(/
).
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