Differences

This shows you the differences between two versions of the page.

--- en:provisioning [2021/05/26 17:43]
Виталий Журавлев [IPTV/OTT protocol setup]
+++ en:provisioning [2023/10/11 16:02]
Виталий Журавлев [Display setup]
@@ Line 80: / Line 80: @@
 //<!-- Modules -->// defines modules described in the following chapters.
-=====Modules=====
+=====Modules and filtering=====
+The module is a direct inheritor of the tag   //provision//. \\
+Starting with firmware version 5.0.33, it became possible to provide different provisioning modules for different devices.
+For this an additional section is created. \\
+Example:
+<code xml>
+<tv_protocols devices="s605,s530"  override="true" default="jsonapi"  autostart="true"   >
+     <protocol type="jsonapi" server="http://example.com" />
+</tv_protocols>
+<tv_protocols devices=""  override="true"  default="jsonapi"  autostart="true" >
+      <protocol type="jsonapi" server="https//example2.com" />
+</tv_protocols>
+</code>
+* device -model of TVIP box \\
+In this example, the boxes s605 and s530 will get the address of the server middleware  example.com, all others are example2.com.\\
+:!: Set-top boxes with firmware version earlier than 5.0.33 will receive the last middleware server address.
 ====Update server information====
@@ Line 87: / Line 102: @@
 <code xml>
-<update_server name="update.tvip.ru" />
+<update_server name="update.tvip.tv" />
 </code>
@@ Line 94: / Line 109: @@
   * [[provider_mirror|priorities]] of update server addresses
   * Defined address will be written to /var/tvip/update_server.prov
-  * All official updates are always avaliable on //update.tvip.ru// web server
+  * All official updates are always avaliable on //update.tvip.tv// web server
 ====TR-069 server (ACS) information====
@@ Line 275: / Line 290: @@
 <code xml>
-<time tz="Europe/Moscow" ntp="ru.pool.ntp.org" time_format="12" />
+<time tz="Asia/Singapore" ntp="pool.ntp.org" time_format="12" />
 </code>
 //tz// defines time zone in [[http://ru.wikipedia.org/wiki/Tz_database|zoneinfo]] format.\\
@@ Line 297: / Line 312: @@
   <vod enabled="false" />
   <timeshift enabled="false"/>
+  <appstore enabled="false"/>
 </features>
 </code>
@@ Line 302: / Line 318: @@
 Tag attribute //timeshift enabled// allow enable (//true//) or disable (//false//) local timeshift.
+:!: The tag //appstore// - allowed for 7xx models only
@@ Line 309: / Line 327: @@
 This allows to add custom Web applications and hide default installed applications
-<code>
+<code xml>
-<webapps override="true">
+<webapps>
-   <app name="youtube" title="YouTube" uiwidth="1280" uiheight="720" url="https://apps.tvip.ru/apps/youtube/" api="tvip" />
    <app name="lk" title="User Account" icon="account" uiwidth="1280" uiheight="720" url="http://private.provider.com" api="mag"/>
+     <app name="plex"/>
+   <app name="youtube" hidden="true" />
 </webapps>
 </code>
 This code hides all default Web applications and adds YouTube and operator's User Account page.
-If //override// attribute is //true//, all default apps will be hidden; if attribute is //false//, custom apps will be added to default apps.
+If //override// attribute is //true//, all default apps will be hidden; if attribute is //false//, custom apps will be added to default apps.\\
+:!: Since version 5.0.33, the //override// attribute has been deprecated and do not recommend to use. Instead, you need to use the attribute //hidden// for system applications.
+If //reordering// attribute is //true//, it's allow move WEB applications with //menu// button, supported from firmware 5.0.48
 Web app attributes: \\
-//name// is an unique app name (a-z characters, no spaces), it should not be the same as a reserved name or as other web app's name;\\ //title// is user readable name for Main menu display; \\
+  * //name// is an unique app name (a-z characters, no spaces), it should not be the same as a reserved name or as other web app's name;\\
-//icon// icon codename; \\
+  * //title// is user readable name for Main menu display; \\
-//uiwidth// and //uiheight// define UI resolution; \\
+  * //hidden// - to hide the system application (//from fw 5.0.33//)
-//bgr// - URL of an PNG image, that will be used instead of the app default banner. Width: 330 px. Height: 185 px (//from fw. 4.0.11//)\\
+  * //icon// icon codename; \\
-//url// defines web application URL; \\
+  * //uiwidth// and //uiheight// define UI resolution; \\
-//api// defines STB API type (tvip/mag/html5/youtube/blink); \\
+  * //bgr// - URL of an PNG image, that will be used instead of the app default banner. Width: 320 px. Height: 180 px (//from fw. 4.0.11//)\\
-//proxy// defines HTTP/HTTPS proxy (if required).\\
+  * //url// defines web application URL; \\
-//dial_origin// - use DIAL protocol to launch this application over second screen app with defined //origin// (//from fw. 4.0.19//).\\
+  * //api// defines STB API type (tvip/mag/html5/youtube/blink); \\
-//dial_title// - name of application when multicasted over DIAL.\\
+  * //proxy// defines HTTP/HTTPS proxy (if required).\\
-//search_script// - address of a special JavaScript code containing implementation of system search logic for current app.(//from fw. 4.1.4//).\\
+  * //dial_origin// - use DIAL protocol to launch this application over second screen app with defined //origin// (//from fw. 4.0.19//).\\
+  * //dial_title// - name of application when multicasted over DIAL.\\
+  * //search_script// - address of a special JavaScript code containing implementation of system search logic for current app.(//from fw. 4.1.4//).\\
@@ Line 336: / Line 361: @@
 \\
+:!: For system applications allowed attribute //hidden// only\\
+Reserved application names for //name// attributes:\\
+  * "tvplayer" (Watch TV),\\
+  *  "dvr" (DVR),\\
+  *  "mediaplayer" (Mediaplayer),\\
+  *  "vod" (Movies),\\
+  *  "cctv" (CCTV),\\
+  *  "preferences" (Settings),\\
+  *  "allapps" (Android's All apps).\\
-Reserved application names for //name// attributes: "tvplayer" (Watch TV), "dvr" (DVR), "mediaplayer" (Mediaplayer), "vod" (Movies), "cctv" (CCTV), "preferences" (Settings), "allapps" (Android's All apps).
-Default app names: "account" for Operator's User Account page, "youtube" for YouTube app, "kodi" for Kodi app.
-For customer's app, you can use any avaliable icon.\\
-Default web application configuraton:\\
+Default app names:\\
-<code xml>
+    *  "account" for Operator's User Account page,\\
-<webapps>
+    *  "youtube" for YouTube app,\\
-    <app name="youtube" title="YouTube" uiwidth="1280" uiheight="720" url="https://apps.tvip.ru/apps/youtube/?referrer=about:back" api="youtube" dial_title="YouTube" dial_origin="*.youtube.com" search_script="https://apps.tvip.ru/searchjs/youtube.js"/>
+    * "Plex" for Plex\\
-    <app name="youtube_kids" title="YouTube Kids" uiwidth="1280" uiheight="720" url="https://apps.tvip.ru/apps/youtube_kids/?referrer=about:back" api="youtube" />
+    *  "kodi" for Kodi app.\\
-    <app name="plex" title="Plex" uiwidth="1280" uiheight="720" url="http://apps.tvip.ru/apps/plex/" api="html5" />
+For customer's app, you can use any available icon.\\
-</webapps>
-</code>
-The default configuration in the firmware is in the file: /home/tvip/profiles/<profile>/tvip_webapps.xml \\
-:!: You should use HTTPS protocol and api="youtube" for YouTube apps to work correct in firmwares 4.2.x and above.\\
+:!: Since version 5.0.33, you can't to change the configuration (URL, icon, etc.) of reserved applications. If you need to replace the system application, you need to hide it and create your own with a different //name//.\\
+By default path to config file at firmware:  /home/tvip/profiles/<profile>/tvip_webapps.xml\\
-If an app needs "Go to Main Menu" function, it should redirect to "about:back" page.
+:!: Pay attention, that for "Youtube" app since 4.2.x firmware need use HTTPS and api="youtube" \\
+To return to the main menu, the application must go to the "about: back" page when exiting.
 To disable ALL webapps, use the following code:
-<code>
+<code xml>
 <webapps override="true">
 </webapps>
@@ Line 397: / Line 427: @@
 <code xml>
-<tv_stream type="udpxy" server="http://user:pwd@host.ru:4022" />
+<tv_stream type="udpxy" server="http://user:pwd@host.tv:4022" />
 </code>
@@ Line 427: / Line 457: @@
   * //stalker// for Stalker Middleware (TVIP UI).
   * //browser// for web application (portal) middleware.
+  * //androidapp// use Android application as content source (Supported only with Android OS)
@@ Line 473: / Line 504: @@
 //server// attribute defines portal URL (middleware); //api// defines JavaScript API for the portal ("tvip", "mag", "html5").\\
-If //noui// attribute is //true// then all TVIP user interface is replaced by Web portal ("Whole system" mode), if //false//, then Web-portal only replaces Watch TV app ("TV only" mode). If //combined// attribute is //true// and //noui// is //false//, then "Combined" mode is used (from v.4.0.23).
+If //noui// attribute is //true// then all TVIP user interface is replaced by Web portal ("Whole system" mode), if //false//, then Web-portal only replaces Watch TV app ("TV only" mode). If //combined// attribute is //true// and //noui// is //false//, then "Combined" mode is used (from v.4.0.23).\\ \\
+ :!: "Whole system mode" is now deprecated and will be removed in future updates. Use "Combined" mode instead. If you need to block long press of Home button, use //home_uri// tag with value //tvplayer// inside //appearance// tag.
 Optional attributes: \\
@@ Line 484: / Line 517: @@
 For selection portal use "dafault" parameter : "<nowiki>server1=Server 1 Name|http://server1.domain/path|default&server2=Server 2 Name|http://server2.domain/path</nowiki>" \\
 //force_retry// - enable (//true//) force retries connect to portal at any network or others issues. (from v.5.0.16);\\
+//waiting_animation// - for disable use //false// it's allow to disable "boot animation" at time when portal loading. (:!: the attribute allowed at AndroidOS from fw 5.1.10 ) \\
 === Application as the content source ===
- :!: //This module allowed only with Android OS (supported from firmware 5.0.25).//\\
+ :!: //This module allowed only with Android OS.//\\
 This allow use Application as the content source.
 <code xml>
@@ Line 494: / Line 528: @@
 Attribute:\\
 //package// - the package name in system; \\
-//autostart// - Allow to automatically start the  application at value //"true"// ; \\
+//autostart// - Allow to automatically start the  application at value //"true"//, supported from firmware 5.0.25 \\
 ==== Security ====
@@ Line 529: / Line 563: @@
   <cec value="false" force="true" />
   <sync_standby value="true" />
+  <cec_name value="anyName" />
 </display>
 </code>
@@ Line 537: / Line 572: @@
 //cec// - enable HDMI-CEC.\\
 //aspect// - Default aspect ratio (box,zoom,full), to set default, use empty value="".\\
-//sync_standby// - STB goes to Sleep/Wake, when TV goes to sleep/wake. (do not supported by all mediacenters and TVs, from fw. 4.0.13).
+//sync_standby// - STB goes to Sleep/Wake, when TV goes to sleep/wake. (do not supported by all mediacenters and TVs, from fw. 4.0.13).\\
+//cec_name// - Allows you to set the device name via HDMI on compatible TVs. Format [Aa-Zz,-,,_,0-9] up to 14 characters (supported from firmware 5.1.26).\\
 To force some settings to apply use attribute force with value="true"
@@ Line 565: / Line 601: @@
   <display_channel_has_archive value="true" />
   <background_picture value="Custom" force="true">
-    <picture name="Custom" url="http://domain/Custom.png"/>
+  <picture name="Custom" url="http://domain/Custom.png"/>
   </background_picture>
   <media_freeze_animation value="false" />
+  <back_as_recall value="true" />
+  <menu_as_home value="true" />
 </appearance>
 </code>
@@ Line 583: / Line 621: @@
   * //background_picture// - defines monochrome background image for the home screen (and some other apps). //value// - sets up identifier for the image. Identifier can be internal (like: //waves//, //triangles//) or one of the list of <picture> tags. <picture> tag attributes: //name// - background identifier, //url// - URL of 8-bit monochrome PNG image. Supported from firmware 4.2.16.
   * //media_freeze_animation// - Disabling animation «freeze» video (false) - enable (true) - disable (Supported from firmware: 4.2.33). \\
+  * //back_as_recall// - allows you to assign to the //back// button the function to return to the previous channel (supported since firmware 5.0.67).
+  * //menu_as_home// - allows you to use the //menu// button to call the //home// action, except when used for its intended purpose, this functionality only works in the TV application (supported since firmware 5.0.67).
 To force some settings to apply use attribute force with value="true"
@@ Line 670: / Line 710: @@
   <media>
     <default_audio_language force="true" value="bul bg eng en" />
-    <default_subtitle_language force="true" value="ru rus" />
+    <default_subtitle_language force="true" value="en eng" />
   </media>
 </code>
@@ Line 720: / Line 760: @@
 ===="Cable TV" mode over provisioning ====
-//**Supported from firmware: 3.2.33**// \\
+//**Supported from firmware: 4.2.33**// \\
 This option allow playback of a single stream without UI
@@ Line 727: / Line 767: @@
 <system_locks>
-        <ctv enabled="false" url="http://your_stream.com" volume="30" />
+        <ctv enabled="true" url="http://your_stream.com" volume="30" />
 </system_locks>
@@ Line 767: / Line 807: @@
 ====Restrict access to mediacenter settings====
-{{ :settings.png?300|}}
 You can hide or disable almost any setting in Settings app.
 Note: this does not set setting values. It just control user's access to settings!
@@ Line 828: / Line 868: @@
 //pref_network_iface// - Interface type (Eth/WiFi)\\
+//pref_network_iface_enabled// - Network interface enable\\
 //pref_network_wlan_ssid// - WiFi Access point\\
 //pref_network_config// - Config (DHCP/Manual)\\
@@ Line 893: / Line 934: @@
 ==== TVIP App Store server URL ====
-:!: //**Supported only for OS Android, firmware 4.4.1**// \\
+:!: //**Supported only for OS Android, firmware 4.4.1+**// \\
 This defines various server URL for Tvip App Store.
@@ Line 912: / Line 953: @@
  <!-- Update server setup -->
- <update_server name="update.tvip.ru" />
+ <update_server name="update.tvip.tv" />
  <!-- Logo setup -->

TVIP Wiki

User Tools

Site Tools

Differences

Page Tools