Difference between revisions of "Device configuration"

From A-SMIL.org
Jump to: navigation, search
(Undo revision 377 by SMIL T.A. (talk))
Line 1: Line 1:
A-SMIL players can have their configurations set using [[maintenance tasks]].
+
A configuration file is used with the [[device configuration]] maintenance job to update the settings of a player. It can also be applied using the USB stick as a file named "config.xml" placed in the root directory.
  
== The updateSettings Task Schedule ==
+
It is an XML file, and format can be different depends on SMIL appliance's capability.
  
To initiate device configuration, the player must be issued a SMIL script with a TaskSchedule subscription (see [[maintenance tasks]]) in the head section. The subscription contains a URL that points to a <tt>taskSchedule.xml</tt> file that looks like the following:
+
==For IAdea XMP-2200 series==
 +
 
 +
If the player is password protected, <tt>security</tt> section is required to authenticate the user. The password is set from the media player's configuration menu.<br>
 +
If the player is not password protected, <tt>security</tt> section is still required, but simply leave the password tag blank.
 +
 
 +
The configuration file only need to contains the parameter that need to be changed, it it not required to include all parameters.
  
 
<source lang="xml">
 
<source lang="xml">
<taskSchedule xmlns="http://schemas.adfotain.org/adapi-1.0">
+
<configuration xmlns="http://schemas.adfotain.org/config-1.0">
   <timedTaskList at="0" abortOnError="false">
+
   <security>
     <updateSettings id="123">
+
    <user>admin</user>
      <sourceURI>http://server/config.xml</sourceURI>
+
    <password>your_pwd</password>
      <contentType>x-configuration/xml</contentType>
+
  </security>
      <contentLength>12345</contentLength>
+
  <userPref>
      <contentChecksum>A72f43a7e0a5507923653f9a70260E70</contentChecksum>
+
    <prop name="net.wifi.enabled" value="true"/>
      <checksumMethod>MD5</checksumMethod>
+
     <prop name="net.wifi.ssid" value="your ssid"/>
     </updateSettings>
+
    <prop name="net.wifi.authentication" value="OPEN|WEP|WPAPSK|WPA2PSK"/>
   </timedTaskList>
+
    <prop name="net.wifi.password" value="your ap password"/>
</taskSchedule>
+
 
 +
    <prop name="net.ethernet.dhcp.enabled" value="true|false"/>
 +
    <prop name="net.ethernet.ip" value="ip"/>
 +
    <prop name="net.ethernet.netmask" value="ip"/>
 +
    <prop name="net.ethernet.gateway" value="ip"/>
 +
    <prop name="net.ethernet.dnsServers" value="ip"/>
 +
 
 +
    <prop name="time.tzDescription" value="string"/>
 +
    <!-- Timezone string list - http://www.a-smil.org/index.php/Timezone_List -->
 +
 
 +
    <prop name="hardware.videoOut.0.format" value="CEA_720p60 "/>
 +
    <!--supported output mode - PANEL|NTSC|NTSC_M|PAL|PAL_BG|CEA_720p50|CEA_720p60|CEA_1080i50|CEA_1080i60|CEA_1080p50|CEA_1080p60-->
 +
 
 +
    <prop name="hardware.audioOut.0.masterSoundLevel" value="0~100%"/>
 +
 
 +
    <prop name="content.bootFromServer" value="true"/>
 +
    <prop name="content.serverUrl" value="server-uri"/>
 +
 
 +
     <prop name="schedule.reboot.days" value="Sunday|Monday|Tuesday|Wednesday|Thursday|Friday|Saturday"/>
 +
    <prop name="schedule.reboot.time" value="HH:MM in 24-hr format"/>
 +
 
 +
   </userPref>
 +
</configuration>
 +
 
 
</source>
 
</source>
  
Here several lines need to have proper values filled.
 
  
* '''updateSettings id''': the ID is used by the player to register if a particular task has already be applied. The player will not apply the task if its ID is the same as the one most recently applied. In other words, if you wish you re-apply a task, make sure you change its ID
+
==For IAdea XMP-120 , XMP-3250 series==
* '''sourceURI''': a URL that points to a [[Configuration file|configuration file]]
+
 
* '''contentLength''': size of the configuration file in bytes
+
If the player is password protected, <tt>security</tt> section is required to authenticate the user. The password is set from the media player's configuration menu.<br>
* '''contentChecksum''': MD5 checksum of the configuration file
+
If the player is not password protected, whole <tt>security</tt> section can be ignored.  
 +
The configuration file only need to contains the parameter that need to be changed, it it not required to include all parameters.
 +
 
 +
<source lang="xml">
 +
<configuration xmlns="http://schemas.adfotain.org/config-1.0">
 +
  <security>
 +
    <user>admin</user>
 +
    <password>your_pwd</password>
 +
  </security>
 +
  <userPref>
 +
    <prop name="info.playerName" value="string"/>
 +
 
 +
    <prop name="net.proxy.type" value="HTTP|HTTP_1_0|SOCKS4|SOCKS5"/>
 +
    <prop name="net.proxy.host" value="ip,domain-name"/>
 +
    <prop name="net.proxy.port" value="integer"/>
 +
    <prop name="net.proxy.user" value="string"/>
 +
    <prop name="net.proxy.password" value="string"/>
 +
 
 +
    <prop name="net.wifi.ssid" value="string"/>
 +
    <prop name="net.wifi.authentication" value="WEPAUTO|WPAPSK|WPA2PSK|OPEN"/>
 +
    <prop name="net.wifi.encryption" value="WEP|TKIP|AES|NONE"/>
 +
    <prop name="net.wifi.password" value="string"/>
 +
 
 +
    <prop name="net.ethernet.dhcp.enabled" value="true|false"/>
 +
    <prop name="net.ethernet.dhcp.vendorClass" value="string"/>
 +
    <prop name="net.ethernet.ip" value="ip"/>
 +
    <prop name="net.ethernet.netmask" value="ip"/>
 +
    <prop name="net.ethernet.gateway" value="ip"/>
 +
    <prop name="net.ethernet.domain" value="domain-name"/>
 +
    <prop name="net.ethernet.dnsServers" value="list-of{ip}"/>
 +
 
 +
    <prop name="time.tzDescription" value="string"/>
 +
    <prop name="time.tzCode" value="posix-rule (http://www.gnu.org/s/libc/manual/html_node/TZ-Variable.html)"/>
 +
    <prop name="time.autoUpdate.protocol" value="content|rdate|http"/>
 +
    <prop name="time.autoUpdate.server" value="ip,domain-name,uri"/>
 +
 
 +
    <prop name="display.format" value=""/>
 +
      <!-- auto,
 +
          VESA_640x480x60, VESA_800x600x60, VESA_1024x768x60, VESA_1280x1024x60, VESA_1600x1200x60,
 +
          VESA_1360x768x60, VESA_1366x768x60, VESA_1440x900x60, VESA_1680x1050x60, VESA_1920x1200x60,
 +
          CEA_640x480x60, CEA_720p50, CEA_720p60, CEA_1080i50, CEA_1080i60, CEA_1080p50, CEA_1080p60,
 +
          NTSC_M, NTSC_M_Japan, PAL_BG, PAL_M, PAL_N, PAL_Nc
 +
      -->
 +
    <prop name="display.brightness" value="0-100%"/>
 +
    <prop name="audio.soundLevel" value="mute,{min}-{max}db,0-{max}%"/>
 +
 
 +
    <prop name="content.bootFromServer" value="true|false"/>
 +
    <prop name="content.serverUrl" value="server-uri"/>
 +
 
 +
    <prop name="task.scheduledReboot.days"
 +
      value="list-of{Sunday,Sun,Monday,Mon,Tuesday,Tue,Wednesday,Wed,Thursday,Thu,Friday,Fri,Saturday,Sat}"/>
 +
    <prop name="task.scheduledReboot.time" value="HH:MM in 24-hr format"/>
 +
 
 +
  </userPref>
 +
</configuration>
 +
 
 +
</source>

Revision as of 08:36, 30 August 2013

A configuration file is used with the device configuration maintenance job to update the settings of a player. It can also be applied using the USB stick as a file named "config.xml" placed in the root directory.

It is an XML file, and format can be different depends on SMIL appliance's capability.

For IAdea XMP-2200 series

If the player is password protected, security section is required to authenticate the user. The password is set from the media player's configuration menu.
If the player is not password protected, security section is still required, but simply leave the password tag blank.

The configuration file only need to contains the parameter that need to be changed, it it not required to include all parameters.

<configuration xmlns="http://schemas.adfotain.org/config-1.0">
  <security>
    <user>admin</user>
    <password>your_pwd</password>
  </security>
  <userPref>
    <prop name="net.wifi.enabled" value="true"/>
    <prop name="net.wifi.ssid" value="your ssid"/>
    <prop name="net.wifi.authentication" value="OPEN|WEP|WPAPSK|WPA2PSK"/>
    <prop name="net.wifi.password" value="your ap password"/>
 
    <prop name="net.ethernet.dhcp.enabled" value="true|false"/>
    <prop name="net.ethernet.ip" value="ip"/>
    <prop name="net.ethernet.netmask" value="ip"/>
    <prop name="net.ethernet.gateway" value="ip"/>
    <prop name="net.ethernet.dnsServers" value="ip"/>
 
    <prop name="time.tzDescription" value="string"/>
    <!-- Timezone string list - http://www.a-smil.org/index.php/Timezone_List -->
 
    <prop name="hardware.videoOut.0.format" value="CEA_720p60 "/>
    <!--supported output mode - PANEL|NTSC|NTSC_M|PAL|PAL_BG|CEA_720p50|CEA_720p60|CEA_1080i50|CEA_1080i60|CEA_1080p50|CEA_1080p60-->
 
    <prop name="hardware.audioOut.0.masterSoundLevel" value="0~100%"/>
 
    <prop name="content.bootFromServer" value="true"/>
    <prop name="content.serverUrl" value="server-uri"/>
 
    <prop name="schedule.reboot.days" value="Sunday|Monday|Tuesday|Wednesday|Thursday|Friday|Saturday"/>
    <prop name="schedule.reboot.time" value="HH:MM in 24-hr format"/>
 
  </userPref>
</configuration>


For IAdea XMP-120 , XMP-3250 series

If the player is password protected, security section is required to authenticate the user. The password is set from the media player's configuration menu.
If the player is not password protected, whole security section can be ignored. The configuration file only need to contains the parameter that need to be changed, it it not required to include all parameters.

<configuration xmlns="http://schemas.adfotain.org/config-1.0">
  <security>
    <user>admin</user>
    <password>your_pwd</password>
  </security>
  <userPref>
    <prop name="info.playerName" value="string"/>
 
    <prop name="net.proxy.type" value="HTTP|HTTP_1_0|SOCKS4|SOCKS5"/>
    <prop name="net.proxy.host" value="ip,domain-name"/>
    <prop name="net.proxy.port" value="integer"/>
    <prop name="net.proxy.user" value="string"/>
    <prop name="net.proxy.password" value="string"/>
 
    <prop name="net.wifi.ssid" value="string"/>
    <prop name="net.wifi.authentication" value="WEPAUTO|WPAPSK|WPA2PSK|OPEN"/>
    <prop name="net.wifi.encryption" value="WEP|TKIP|AES|NONE"/>
    <prop name="net.wifi.password" value="string"/>
 
    <prop name="net.ethernet.dhcp.enabled" value="true|false"/>
    <prop name="net.ethernet.dhcp.vendorClass" value="string"/>
    <prop name="net.ethernet.ip" value="ip"/>
    <prop name="net.ethernet.netmask" value="ip"/>
    <prop name="net.ethernet.gateway" value="ip"/>
    <prop name="net.ethernet.domain" value="domain-name"/>
    <prop name="net.ethernet.dnsServers" value="list-of{ip}"/>
 
    <prop name="time.tzDescription" value="string"/>
    <prop name="time.tzCode" value="posix-rule (http://www.gnu.org/s/libc/manual/html_node/TZ-Variable.html)"/>
    <prop name="time.autoUpdate.protocol" value="content|rdate|http"/>
    <prop name="time.autoUpdate.server" value="ip,domain-name,uri"/>
 
    <prop name="display.format" value=""/>
      <!-- auto,
           VESA_640x480x60, VESA_800x600x60, VESA_1024x768x60, VESA_1280x1024x60, VESA_1600x1200x60,
           VESA_1360x768x60, VESA_1366x768x60, VESA_1440x900x60, VESA_1680x1050x60, VESA_1920x1200x60,
           CEA_640x480x60, CEA_720p50, CEA_720p60, CEA_1080i50, CEA_1080i60, CEA_1080p50, CEA_1080p60,
           NTSC_M, NTSC_M_Japan, PAL_BG, PAL_M, PAL_N, PAL_Nc
      -->
    <prop name="display.brightness" value="0-100%"/>
    <prop name="audio.soundLevel" value="mute,{min}-{max}db,0-{max}%"/>
 
    <prop name="content.bootFromServer" value="true|false"/>
    <prop name="content.serverUrl" value="server-uri"/>
 
    <prop name="task.scheduledReboot.days" 
      value="list-of{Sunday,Sun,Monday,Mon,Tuesday,Tue,Wednesday,Wed,Thursday,Thu,Friday,Fri,Saturday,Sat}"/>
    <prop name="task.scheduledReboot.time" value="HH:MM in 24-hr format"/>
 
  </userPref>
</configuration>