Device configuration

From A-SMIL.org
Jump to: navigation, search

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/XMP-6200 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. Please note <user> must always to be "admin".

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.autoTime.enabled" value="true|false"/> 
    <prop name="time.autoTime.server" value="ntp|sntp|http://ip,domain-name,uri"/>
    <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 "/>
    <!--XMP-2200 : PANEL|NTSC|NTSC_M|PAL|PAL_BG|CEA_720p50|CEA_720p60|CEA_1080i50|CEA_1080i60|CEA_1080p50|CEA_1080p60-->
    <!--XMP-6200 : auto|CEA_720p50|CEA_720p60|CEA_1080p50|CEA_1080p60-->   
 
    <prop name="hardware.videoOut.0.rotation" value="0|90|180|270|auto"/>
 
    <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="tzDescription"/>
    <prop name="time.tzCode" value="tzCode"/>
 
    <!-- download tzCode and tzDescription here - http://www.digisignage.net/sites/default/files/Timezone_List_20131227.pdf -->
 
    <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>

The Update Player Setting Task Schedule

To update player setting via maintenance task, 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 taskSchedule.xml file that looks like the following:

<taskSchedule xmlns="http://schemas.adfotain.org/adapi-1.0">
  <timedTaskList at="0" abortOnError="false">
     <updateSettings id="2011011301">
         <sourceURI>http://your_server_ip/config.xml</sourceURI>
         <contentType>x-configuration/xml</contentType>
	 <contentLength>1737</contentLength>
         <contentChecksum>4248E25934DE144670FB3C89BAEEE2D2</contentChecksum>
         <checksumMethod>MD5</checksumMethod>
    </updateSettings>
  </timedTaskList>
</taskSchedule>

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