Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vitalets/docker-tizen-webos-sdk
Docker image with Samsung Tizen CLI and LG webOS CLI
https://github.com/vitalets/docker-tizen-webos-sdk
Last synced: 12 days ago
JSON representation
Docker image with Samsung Tizen CLI and LG webOS CLI
- Host: GitHub
- URL: https://github.com/vitalets/docker-tizen-webos-sdk
- Owner: vitalets
- Created: 2020-08-01T15:30:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-01T09:30:30.000Z (9 months ago)
- Last Synced: 2024-10-04T11:22:25.589Z (about 1 month ago)
- Language: Dockerfile
- Size: 55.4 MB
- Stars: 93
- Watchers: 7
- Forks: 27
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# docker-tizen-webos-sdk
Docker image with [Samsung Tizen CLI](https://developer.samsung.com/smarttv/develop/getting-started/using-sdk/command-line-interface.html)
and [LG webOS CLI](http://webostv.developer.lge.com/sdk/tools/using-webos-tv-cli/).
Allows to develop, build, launch and debug Smart TV apps without installing Tizen Studio and webOS SDK.
Available CLI commands:
* `tizen`
* `sdb`
* `ares-*`
## Contents
- [Requirements](#requirements)
- [Usage](#usage)
- [Samsung Tizen TV CLI](#samsung-tizen-tv-cli)
- [Get info about TV](#get-info-about-tv)
- [Connect to TV](#connect-to-tv)
- [List connected TVs](#list-connected-tvs)
- [Get TV capabilities](#get-tv-capabilities)
- [Get list of installed apps](#get-list-of-installed-apps)
- [Launch app on TV](#launch-app-on-tv)
- [Pack app](#pack-app)
- [Install app](#install-app)
- [Debug app](#debug-app)
- [Close app](#close-app)
- [Uninstall app](#uninstall-app)
- [Pack, install and launch app on TV in single command](#pack-install-and-launch-app-on-tv-in-single-command)
- [LG WebOS TV CLI](#lg-webos-tv-cli)
- [Changelog](#changelog)
- [3.0](#30)
- [2.0](#20)
- [1.0](#10)
- [Development](#development)
- [Build container](#build-container)
- [Slow way](#slow-way)
- [Fast way](#fast-way)
- [Update webOS sdk](#update-webos-sdk)
- [Test](#test)
- [Debug](#debug)
- [Generate TOC](#generate-toc)
- [Publish to Docker Hub](#publish-to-docker-hub)
- [Remove unused images](#remove-unused-images)
## Requirements
The only requirement is docker:
* for Mac/Windows - [Docker Desktop](https://www.docker.com/products/docker-desktop)
* for Linux - [Docker Engine](https://docs.docker.com/engine/install/)
## Usage
Run `bash` session inside container:
```
docker run -it --rm -v tvdata:/home/developer vitalets/tizen-webos-sdk bash
```
> Named volume `tvdata` is important for saving your data between container runs.
Now you have Ubuntu with `sdb`, `tizen`, and `ares-*` commands available:
```
~# tizen version
Tizen CLI 2.5.21
~# sdb version
Smart Development Bridge version 4.2.12
~# ares-setup-device --version
Version: 1.10.4-j1703-k
```
Container is intentionally started under the `root` user. Starting under non-root user may cause [permissions issue](https://github.com/moby/moby/issues/2259) when attaching volumes. If you have problems with runnig tizen `package-manager` try to run container under `developer` user (see [#6](https://github.com/vitalets/docker-tizen-webos-sdk/issues/6)):
```bash
docker run --user developer -it --rm -v tvdata:/home/developer vitalets/tizen-webos-sdk bash
```
## Samsung Tizen TV CLI
### Get info about TV
If you have Samsung TV in the same network as your host machine,
you can get TV info from inside the container:
```
curl http://TV_IP:8001/api/v2/
```
> You may be asked on TV to allow external connections (once).
Example Output
{
"device":{
"FrameTVSupport":"false",
"GamePadSupport":"true",
"ImeSyncedSupport":"true",
"Language":"ru_RU",
"OS":"Tizen",
"PowerState":"on",
"TokenAuthSupport":"true",
"VoiceSupport":"false",
"WallScreenRatio":"0",
"WallService":"false",
"countryCode":"RU",
"description":"Samsung DTV RCR",
"developerIP":"192.168.1.64",
"developerMode":"1",
"duid":"uuid:88d68ee4-cffc-47c4-894f-6d46ca51333a",
"firmwareVersion":"Unknown",
"id":"uuid:88d68ee4-cffc-47c4-894f-6d46ca51333a",
"ip":"192.168.1.66",
"model":"19_MUSEL_UHD",
"modelName":"UE43RU7400UXRU",
"name":"[TV] Samsung 7 Series (43)",
"networkType":"wireless",
"resolution":"3840x2160",
"smartHubAgreement":"true",
"ssid":"94:4a:0c:86:c7:00",
"type":"Samsung SmartTV",
"udn":"uuid:88d68ee4-cffc-47c4-894f-6d46ca51333a",
"wifiMac":"B8:BC:5B:93:7E:D2"
},
"id":"uuid:88d68ee4-cffc-47c4-894f-6d46ca51333a",
"isSupport":"{\"DMP_DRM_PLAYREADY\":\"false\",\"DMP_DRM_WIDEVINE\":\"false\",\"DMP_available\":\"true\",\"EDEN_available\":\"true\",\"FrameTVSupport\":\"false\",\"ImeSyncedSupport\":\"true\",\"TokenAuthSupport\":\"true\",\"remote_available\":\"true\",\"remote_fourDirections\":\"true\",\"remote_touchPad\":\"true\",\"remote_voiceControl\":\"false\"}\n",
"name":"[TV] Samsung 7 Series (43)",
"remote":"1.0",
"type":"Samsung SmartTV",
"uri":"http://192.168.1.66:8001/api/v2/",
"version":"2.0.25"
}
### Connect to TV
Before running any `tizen` / `sdb` command you should connect to TV.
Please ensure that TV is in [Developer Mode](https://developer.samsung.com/smarttv/develop/getting-started/using-sdk/tv-device.html)
and Developer IP equals to your host IP (check `developerMode` and `developerIP` in curl response).
```bash
$ sdb connect 192.168.1.66
```
Output:
```
* Server is not running. Start it now on port 26099 *
* Server has started successfully *
connecting to 192.168.1.66:26101 ...
connected to 192.168.1.66:26101
```
### List connected TVs
```
$ sdb devices
```
Output:
```
List of devices attached
192.168.1.66:26101 device UE43RU7400UXRU
```
### Get TV capabilities
```
$ sdb -s 192.168.1.66 capability
```
Output:
```
secure_protocol:enabled
intershell_support:disabled
filesync_support:pushpull
...
```
### Get list of installed apps
```
$ sdb -s 192.168.1.66 shell 0 applist
```
Output:
```
Application List for user 5001
User's Application
Name AppID
=================================================
'HdmiCec' 'org.tizen.hdmicec'
'automation-app' 'org.tizen.automation-app'
...
```
### Launch app on TV
```
$ tizen run -s 192.168.1.66:26101 -p 9Ur5IzDKqV.TizenYouTube
```
Output:
```
Launching the Tizen application...
--------------------
Platform log view
--------------------
... successfully launched pid = 1656 with debug 0
Tizen application is successfully launched.
```
or
```
$ sdb -s 192.168.1.66:26101 shell 0 was_execute 9Ur5IzDKqV.TizenYouTube
```
### Pack app
Sample developer certificate is included, so you can pack your app without any setup (for development).
Author.p12 / distributor.p12 password is `developer`.
Run container with mounting app source `./src` into `/app`:
```
docker run -it --rm -v ./src:/app -v tvdata:/home/developer vitalets/tizen-webos-sdk bash
```
Create `wgt` package:
```
tizen package -t wgt -o /home/developer -- /app
```
Output:
```
The active profile is used for signing. If you want to sign with other profile, please use '--sign' option.
Author certficate: /home/developer/author.p12
Distributor1 certificate : /home/developer/tizen-studio/tools/certificate-generator/certificates/distributor/tizen-distributor-signer.p12
Excludes File Pattern: {.manifest.tmp, .delta.lst}
Ignore File: /app/.manifest.tmp
Package File Location: /home/developer/MyTvApp.wgt
```
### Install app
```
$ tizen install -s 192.168.1.66:26101 --name MyTvApp.wgt -- /home/developer
```
Output:
```
Transferring the package...
Transferred the package: /home/developer/MyTvApp.wgt -> /home/owner/share/tmp/sdk_tools/tmp
Installing the package...
--------------------
Platform log view
--------------------
install TESTABCDEF.MyTvApp
package_path /home/owner/share/tmp/sdk_tools/tmp/MyTvApp.wgt
was_install_app return WAS_TRUE
app_id[TESTABCDEF.MyTvApp] install start
...
app_id[TESTABCDEF.MyTvApp] install completed
spend time for wascmd is [1898]ms
cmd_ret:0
Installed the package: Id(TESTABCDEF.MyTvApp)
Tizen application is successfully installed.
Total time: 00:00:02.895
```
> You may need to rename wgt before installing
> because `tizen install` does not work properly with spaces and non-latin symbols in wgt filename
### Debug app
Launch app in debug mode:
```
$ sdb -s 192.168.1.66:26101 shell 0 debug TESTABCDEF.MyTvApp
```
Output:
```
... successfully launched pid = 12915 with debug 1 port: 34541
```
Then open in chrome url `http://{TV_IP}:{PORT}` using port from previous command.
### Close app
```
$ sdb -s 192.168.1.66:26101 shell 0 kill TESTABCDEF
```
Output:
```
Pkgid: TESTABCDEF is Terminated
spend time for pkgcmd is [246]ms
```
> Note using only `packageId` instead of full `appId`.
### Uninstall app
```
$ tizen uninstall -s 192.168.1.66:26101 -p TESTABCDEF.MyTvApp
```
Output:
```
--------------------
Platform log view
--------------------
uninstall TESTABCDEF.MyTvApp
app_id[TESTABCDEF.MyTvApp] uninstall start
...
app_id[TESTABCDEF.MyTvApp] uninstall completed
spend time for wascmd is [2027]ms
cmd_ret:0
Total time: 00:00:02.703
```
### Pack, install and launch app on TV in single command
App sources are in `./src`.
The following env variables are used:
- `TV_IP=192.168.1.66`
- `APP_ID=TESTABCDEF.MyTvApp` (from config.xml)
- `APP_NAME="My TV App"` (from config.xml)
```
docker run -it --rm \
-e TV_IP=192.168.1.66 \
-e APP_ID=TESTABCDEF.MyTvApp \
-e APP_NAME="My TV App" \
-v tvdata:/home/developer
-v ./src:/app \
vitalets/tizen-webos-sdk /bin/bash -c '\
tizen package -t wgt -o . -- /app \
&& mv "$APP_NAME.wgt" app.wgt \
&& sdb connect $TV_IP \
&& tizen install -s $TV_IP:26101 --name app.wgt -- . \
&& tizen run -s $TV_IP:26101 -p $APP_ID'
```
## LG WebOS TV CLI
tbd
## Changelog
#### 3.0
- update Tizen Studio to 5.5
- update webOS sdk to 1.12.4-j27
#### 2.0
- update Tizen Studio to 4.1.1
- update webOS sdk to 1.11.0
#### 1.0
Initial version
## Development
### Build container
##### Slow way
```bash
docker build -t vitalets/tizen-webos-sdk .
```
##### Fast way
1. Download Tizen Studio installer to `vendor` dir (change version if needed):
```bash
TIZEN_STUDIO_VERSION=5.5
wget http://download.tizen.org/sdk/Installer/tizen-studio_${TIZEN_STUDIO_VERSION}/web-cli_Tizen_Studio_${TIZEN_STUDIO_VERSION}_ubuntu-64.bin \
-O vendor/web-cli_Tizen_Studio_${TIZEN_STUDIO_VERSION}_ubuntu-64.bin
```
2. Build container using downloaded Tizen Studio installer (change version if needed):
```bash
TIZEN_STUDIO_VERSION=5.5
docker run -d --rm --name nginx-temp -p 8080:80 -v $(pwd)/vendor:/usr/share/nginx/html:ro nginx \
&& docker build -t vitalets/tizen-webos-sdk . \
--build-arg TIZEN_STUDIO_URL=http://172.17.0.1:8080/web-cli_Tizen_Studio_${TIZEN_STUDIO_VERSION}_ubuntu-64.bin \
; docker stop nginx-temp
```
### Update webOS sdk
1. Download [latest installer for linux](https://webostv.developer.lge.com/develop/tools/cli-installation) and move it to `vendor` folder
2. In `Dockerfile` change `WEBOS_CLI_VERSION` to corresponding version
3. Build docker image
### Test
```bash
./test.sh
```
### Debug
```
docker run -it --rm --platform linux/amd64 -v /home/developer vitalets/tizen-webos-sdk bash
```
And check sdk commands, e.g.:
```
tizen version
# or
ares-setup-device --version
```
### Generate TOC
```
docker run --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc --github README.md
```
### Publish to Docker Hub
1. Check [existing tags](https://hub.docker.com/repository/docker/vitalets/tizen-webos-sdk/tags?page=1&ordering=last_updated) on docker hub.
2. Set new tag and push to registry:
```bash
TAG=x.x
docker tag vitalets/tizen-webos-sdk:latest vitalets/tizen-webos-sdk:$TAG
docker push vitalets/tizen-webos-sdk:$TAG
```
### Remove unused images
```bash
docker rmi $(docker images --filter "dangling=true" -q --no-trunc)
```