reference guide for dension in-store digital players...in-store digital players (isr & mpx)...

39
In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v 2.8 Revision Date Modified by Change Rev. 1.01 2011-07-07 Jozsef Lukacs First public release Rev. 1.02 2011-07-15 Jozsef Lukacs Ready to implement Rev. 1.03 2011-09-09 Balint Viragh Configuration script syntax Rev. 1.04 2012-01-06 Jozsef Lukacs Significant changes in all sections, according to potential customers request Rev. 1.05 2012-07-20 Bence Galambos All, structure, content, added chapters Rev. 1.06 2012-11-16 Bence Galambos Post development clarifications Rev. 1.99 2013-02-20 Zoltan Puskas Separate Dension Sherpa documentation, rewrite of main sections, add MPX Rev. 2.0 2013-04-29 Zoltan Puskas Release first public version. Some images are still missing! Rev. 2.1 2013-05-23 Zoltan Puskas, Bence Galambos Minor fixes and formatting. Rev. 2.2 2013-06-03 Zoltan Puskas Add content update file format and related descriptions. Rev. 2.3 06/24/13 Balint Viragh Add couple of tested video formats Rev. 2.4 2014-02-11 Balint Viragh Add config: max_time_diff Rev. 2.5 2014-02-17 Balint Viragh Extend online_url documentation with serial substitution feature Rev. 2.6 2014-09-16 Imre Dobany Proxy feature documentation Fix: linein_timeout in msec, not sec Rev. 2.7 2015-09-22 Zoltán Gépész Add documentation of new features Rev. 2.8 2016-02-04 Zoltán Gépész Add config: spot_offset and documentation of new features

Upload: others

Post on 10-Mar-2020

23 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

Reference Guidefor Dension

In-Store Digital Players (ISR & MPX)

v 2.8

Revision Date Modified by ChangeRev. 1.01 2011-07-07 Jozsef Lukacs First public releaseRev. 1.02 2011-07-15 Jozsef Lukacs Ready to implementRev. 1.03 2011-09-09 Balint Viragh Configuration script syntaxRev. 1.04 2012-01-06 Jozsef Lukacs Significant changes in all sections, according to potential customers

requestRev. 1.05 2012-07-20 Bence Galambos All, structure, content, added chaptersRev. 1.06 2012-11-16 Bence Galambos Post development clarificationsRev. 1.99 2013-02-20 Zoltan Puskas Separate Dension Sherpa documentation, rewrite of main sections,

add MPXRev. 2.0 2013-04-29 Zoltan Puskas Release first public version. Some images are still missing!Rev. 2.1 2013-05-23 Zoltan Puskas,

Bence GalambosMinor fixes and formatting.

Rev. 2.2 2013-06-03 Zoltan Puskas Add content update file format and related descriptions.Rev. 2.3 06/24/13 Balint Viragh Add couple of tested video formatsRev. 2.4 2014-02-11 Balint Viragh Add config: max_time_diffRev. 2.5 2014-02-17 Balint Viragh Extend online_url documentation with serial substitution featureRev. 2.6 2014-09-16 Imre Dobany Proxy feature documentation

Fix: linein_timeout in msec, not secRev. 2.7 2015-09-22 Zoltán Gépész Add documentation of new featuresRev. 2.8 2016-02-04 Zoltán Gépész Add config: spot_offset and documentation of new features

Page 2: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

Serial number MAC address Part number

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

Copyright© 2015 Dension Audio Systems Kft. All rights reserved.The trademarks mentioned in this manual are legally registered to their respective owners!

DisclaimerInformation in this manual is protected by copyright laws and is the property of Dension AudioSystem. Changes to the specifications and features in this manual may be made by Dension AudioSystems without prior notice. No part of this manual may be reproduced, copied, translated,transmitted,or published in any form or by any means without Dension Audio Systems prior writtenpermission.

Documentation ClassificationIn order to assist in the use of these products, Dension Audio Systems provides the followingdocumentation:For detailed product information, carefully read this Reference Guide.For instructions on using the Dension Sherpa service, carefully read the Dension Sherpa ReferenceGuide.For product-related information, check our website at:http://ids.dension.com/

Device informationYour device's part number, option identifier, unique serial number and MAC address can be foundon the bottom of the device. The option identifier is the first four digits of the serial number.Example:

II

Page 3: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

Table of Contents

Table of ContentsIntroduction .......................................................................................................................................... 1

About this document ......................................................................................................................... 1

Product line features ......................................................................................................................... 1

Product line ....................................................................................................................................... 1

ISR-1 ............................................................................................................................................. 1

ISR-100 ......................................................................................................................................... 1

MPX-1 .......................................................................................................................................... 2

MPX-100 ...................................................................................................................................... 2

Installation Manual ............................................................................................................................... 3

Installation precautions ..................................................................................................................... 3

Content of the Package ..................................................................................................................... 3

Optional items .................................................................................................................................. 3

Product specifications ....................................................................................................................... 3

Front view ......................................................................................................................................... 4

Rear view .......................................................................................................................................... 5

Side view .......................................................................................................................................... 6

Installation ........................................................................................................................................ 6

Operation .............................................................................................................................................. 7

Powering up the device .................................................................................................................... 7

Block diagram of the devices ........................................................................................................... 7

Series-1 devices ............................................................................................................................ 7

Series-100 devices ........................................................................................................................ 8

Flash Storage .................................................................................................................................... 8

Content playback .............................................................................................................................. 8

On-line streaming ......................................................................................................................... 9

Store & forward mode .................................................................................................................. 9

Spot playback ............................................................................................................................... 9

Directory structure for stored content ........................................................................................... 9

Program files .............................................................................................................................. 10

Content playback timing ............................................................................................................. 11

Spot playback timing .................................................................................................................. 12

Device configuration and firmware updates ................................................................................... 13

Updates via Dension Sherpa ....................................................................................................... 13

III

Page 4: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

Updates via USB dongle ............................................................................................................ 13

Configuration update via the built in web interface ................................................................... 13

Concluding updates .................................................................................................................... 14

Configuration file format ............................................................................................................ 15

Content update file format .......................................................................................................... 15

Time and date management ............................................................................................................ 17

Restoring factory settings ............................................................................................................... 17

Configuration Settings ........................................................................................................................ 18

Playback settings ............................................................................................................................ 18

Streaming playback .................................................................................................................... 18

Store & Forward playback .......................................................................................................... 19

Audio volume settings .................................................................................................................... 19

Video settings ................................................................................................................................. 21

Display settings .............................................................................................................................. 22

Network settings ............................................................................................................................. 22

Ethernet ....................................................................................................................................... 22

Proxy ........................................................................................................................................... 23

Wi-Fi ........................................................................................................................................... 24

3G Internet .................................................................................................................................. 25

Remote management settings ......................................................................................................... 26

Accessories ......................................................................................................................................... 27

USB keyboard control .................................................................................................................... 27

GPIO control .................................................................................................................................. 27

Remote management (Dension Sherpa) ............................................................................................. 29

Appendix ............................................................................................................................................ 30

Configuration parameter summary ................................................................................................ 30

Script description ............................................................................................................................ 31

Keyboard scan codes ...................................................................................................................... 32

Log description ............................................................................................................................... 32

Supported Video Formats ............................................................................................................... 32

IV

Page 5: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

Introduction

1.1About this documentThe purpose of this current Reference Guide is to give an insight into the depth of the operation andtechnical aspects of Dension’s In-store Audio and Digital Signage family devices. It provides allinformation related to the installation, operation and maintenance of the products, rendering the useof the products easy and simple.

This document is intended for technical staff who will install and operate these devices.

1.2Product line features1

State of the Art Technologies

•Low power consumption

•Fast Ethernet, Wi-Fi or 3G network connection

•8GB+ flash storage for off-line operation•Plays full HD (1080p) digital video and high-enddigital audio

Flexible and comprehensive

•Streams Internet Radios as well as offline con-tent in multiple formats•Plays multiple video formats as well as image formats and even HTML

•Amplified and non-amplified audio output

Sophisticated operation and functions

•Device configuration at installation from USB device or built-in web interface•Efficient web-based remote management via Dension Sherpa•Touch-proof as there are no pressable buttons•Advanced music, video & audio spot management with categories and day parting•No need for professional IT support

Easy to install

•Plug & Play installation•Low maintenance•Custom company design on the cover availability

1.3Product line

1.3.1ISR-1

1.3.2ISR-100

1 Some features may not be available on certain devices. For details please refer to chapter 2.4.1

Page 6: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

1.3.3MPX-1Photos are not available, the product is very similar to the ISR-1 model (plus HDMI connector).

1.3.4MPX-100Photos are not available, the product is very similar to the ISR-100 model (plus HDMI connector).

2

Page 7: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

2Installation Manual

2.1Installation precautionsHandle the device with care.Do not place the device on an uneven surface.Do not place the device in a high-temperature environment.Do not place the device in a wet environment.Under no circumstances open the device. Doing so will void the warranty and put you under the risk of electric shock or damaging your device.

2.2Content of the PackageDension ISR/MPX DeviceMains cable or power adapter (EU/UK/US)Quick Installation ManualDipole Wi-Fi antenna

2.3Optional items19” Rack mount for the 100 series devicesHDMI cableEthernet cable

2.4Product specificationsThe table below describes the various audio and video In-Store player devices, and their main features.

Specifications ISR-1 ISR-100 MPX-1 MPX-100

Hardware

ARM CPU 240 MHz 240 MHz 720 MHz 720 MHz

RAM 32 MB 32 MB 256 MB 256 MB

Firmware flash 4 MB 4 MB 32 MB 32 MB

Audio codec16 bit @44.1kHz

16 bit @44.1kHz

16 bit @44.1kHz

16 bit @44.1kHz

Internal flash storage 4GB+ 4GB+ 8GB+ 8GB+

Power amplifier 1x70W 1x70W

Controls and Connectors

LED indicators ✔ ✔ ✔ ✔

Ethernet 10/100 ✔ ✔ ✔ ✔

RCA stereo line out ✔ ✔ ✔ ✔

USB 2.0 full speed ✔ ✔ ✔ ✔

Volume knob ✔ ✔

3

Page 8: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

Specifications ISR-1 ISR-100 MPX-1 MPX-100

Loudspeaker connector Mono Mono

Line in optional optional

Headphone out optional optional

HDMI ✔ ✔

Wi-Fi antenna ✔ ✔ ✔ ✔

Power supply 9-16V DC 110-230V AC 9-16V DC 110-230V AC

Formats

MP3 ✔ ✔ ✔ ✔

WMA ✔ ✔ ✔ ✔

AAC optional optional optional optional

MPEG4 ✔ ✔

MPEG1/2 ✔ ✔

H264 ✔ ✔

WMV9 ✔ ✔

JPG ✔ ✔

PNG ✔ ✔

GIF ✔ ✔

HTML ✔ ✔

Features

Playlist management ✔ ✔ ✔ ✔

Spot management ✔ ✔ ✔ ✔

Timing management ✔ ✔ ✔ ✔

Sophisticated fail-over ✔ ✔ ✔ ✔

Logging ✔ ✔ ✔ ✔

Features

Remote bulk management ✔ ✔ ✔ ✔

Fix IP/DHCP ✔ ✔ ✔ ✔

3G modem support optional optional optional optional

WiFi support ✔ ✔ ✔ ✔

Sound quality

S/N ratio (audio codec) 90 dB 90 dB 90 dB 90 dB

Line out level 2.8 Vpp 2.8 Vpp 2.8 Vpp 2.8 Vpp

Line in level 3.3 Vpp 3.3 Vpp

Parameters

Power consumption 6W 75W 6W 75W

Weight (g) 131 1350 131 1350

Diemnsions (w x h x d) 120x22x67 256x45x150 120x22x67 256x45x150

Grounding Class 2 Class 2

OEM logo optional optional optional optional

Dension is glad to meet your OEM demands. Please contact us for further details.

4

Page 9: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

2.5Front view•LEDSPower: light is on, if device is connected to power supply and turned onNetwork: light is on, if the device is connected to networkInternet: light is on, if internet can be accessed (successful heartbeat to Dension Sherpa)Status: light is on if operating normally, light is off if not playing content, slow

blinking (0.5Hz) means the device is playing from fallback source, fast blinking (2Hz) means the device is in limited mode, very fast blinking (10Hz) means the device encountered an error and is not playing, but according to the current settings it should

•USBThe USB socket serves for configuration settings, firmware update or 3G modem connection.•2.5” Headphone2

Stereo jack socket for 6.35mm headphones for control purposes.•VOLUME KNOB2

The volume knob sets the headphone and amplified audio volume.

2.6Rear view

•ETHERNETThe ethernet plug is used for hosting RJ45 cables to connect to a wired network.•USBThe USB socket serves for configuration settings, firmware update or 3G modem connection.

2 On -100 series devices only5

Page 10: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

•MAINS2

Electricity plug in for 110-230 V power line.•POWER SWITCH2

Switch to turn the device on/off.•AMPLIFIED MONO OUT2

Mono, amplified analogue audio output•STEREO LINE OUTStereo, line level analogue audio output•HDMI VIDEO3

HDMI digital video output interface

2.7Side view•WiFi ANTENNA CONNECTOROn WiFi capable devices the external antenna should be connected here.

2.8Installation1.Plug the network cable into the Ethernet port2.Plug audio cables into the desired signal source3.Connect the power supply and the device will automatically start up4.Configure the device over the built-in web interface or through the Dension Sherpa service. The

device is set to DHCP mode by default. Please refer to the Dension Sherpa reference manual onobtaining the IP address of the device.

2 On -100 series devices only3 On video capable MPX devices only.

6

Page 11: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

3Operation

3.1Powering up the deviceThe -1 series devices (small box) are powered by the included 12V AC/DC mains adapter. These devices have no power switch, simply connect or disconnect the DC plug, or better the mains adapter.

The -100 series devices (amplifier versions) are powered directly from the 110-230V AC mains. These devices have an on/off switch located on the rear side.

After power-on the power LED lights up and the device boots up taking about 40 seconds to reach fully functional state.

The device starts playback automatically, unless configured otherwise or if no content isavailable. Playback options can be set using various configuration settings via the Dension SherpaSystem or the web interface of the device.4 For detailed information on configuration parameterssee details below. For details on configuration over the Dension Sherpa service please refer to theDension Sherpa Reference Manual.

3.2Block diagram of the devices

3.2.1Series-1 devices

4 The web interface of the device has only a subset of settings available. For all configuration options please use the Dension Sherpa service.

7

Page 12: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

3.2.2Series-100 devices

For optimal operation the devices have an internal flash storage.

Please refer to the product guide for the actual size of flash storage installed on your device.

Although the internal storage is removable in some models, we do not recommend changing the storage on your own, as it will void your warranty.

The internal flash storage can be either a built in USB connected flash drive or a microSD card. ISRdevices use FAT file system while MPX devices run on EXT4.

Configuration parameters are stored on a separate flash on ISR devices, and on the microSD card onMPX devices.

3.4Content playbackAll Dension In-Store devices support stereo audio playback, while video capable devices provide upto 1080p Full HD video, still images and HTML pages.

Supported audio and visual formats are listed in the summary table of chapter 3.

Streaming playback has priority over store & forward mode.

Devices are factory configured to automatically start playback of available content. For further settings on playback source refer to section 4.

8

Page 13: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

3.4.1On-line streamingAudio content may also be directly streamed on-line from a configured location. This requires continuous internet connection with appropriate bandwidth and reliability.

If the internet connection is lost, the device automatically plays locally stored backup content - if any. As soon as the connection is available the device returns to the on-line stream again. The fall-back/return procedure is widely configurable, for details please see section 4.1.1.

The on-line playback always has priority over store & forward mode, thus if an on-line stream is configured and is available, it is played regardless of store & forward settings.

3.4.2Store & forward modeAudio and video content may be downloaded via internet and stored locally on the internal flash storage of the device. This is called store & forward mode.

In this case content is played from the storage, and an active on-line connection is required only for the duration of content updates.

3.4.3Spot playbackIn both playback modes so called spots - locally stored (short) audio or visual content files - may beplayed based on a schedule or triggered by other events (e.g.: keyboard).

Audio spots may be mixed over normal audio content, while visual spots interrupt and replace the actual video content.

The exact behavior of the different spot mechanisms is precisely configurable by a range of settings (eg. audio fade in and out parameters, immediate spot playback etc.). Spots may be scheduled to be played immediately or following the end of the current content. For details please see section 3.4.7.

It is important to consider that spots cannot be interrupted by another spot. This means that if two spots overlap, then the second spot is thrown away.

3.4.4Directory structure for stored contentIn Store & Forward mode content is played from the internal storage. Please note that on the EXT4 file system the directory and file names are case sensitive! The directory structure to be used looks like the following:

content/ Top level directory in the flash file system root that contains the directories below.

content/config/ This directory contains the timing information for the player. This includes the program timetable, category validity and the spot event time table.

content/music/ This directory contains the content to be played in off-line mode. The subdirectories of the music/ directory are considered as categories, which may be maximally 32 chars long. (For example: ‘music/top40’, ‘music/pop’, ‘music/jazz’, eg.). The music folder may have any number of subdirectory depth with the following limitations: only the first level of directories are considered to be categories (for example:

9

Page 14: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

music/rock/heavy_metal and music/rock/symphonic_metal are both rock categories), the path including the mp3 file cannot be longer then 255 characters and there may be maximally 100 categories and 1000 tracks per category.

content/program/ This directory contains the program descriptors.

content/video_program/5 This directory contains the video program desciptors.

content/spot/ This directory contains the spot files. The same rules and limitations apply as in the music/directory.

content/video/6 This directory contains the video content. The same rules and limitations apply as in the music/directory.

content/video_spot/6 This directory contains the video spot files. The same rules and limitations apply as in the music/ directory.

3.4.5Program filesPrograms referenced in the program timetable are stored in the content/program and content/video_program directories. The program files may be either M3U lists or category lists.

3.4.5.1Category program filesThe program file may be a category list, in which case it must contain one category name each line. The device will search the given category directory and play tracks from it. If no shuffle is specified(for playback settings see section 4.1.2) the files are played in the order they are stored in the file system, which is not guaranteed to be alphabetical. An example program file using categories:

#comment linetop40top40kpoptop40technorock

One track is played from each category. When the end of the program file is reached the playback wraps around and continues from the beginning. The first category to be played on start-up is randomized.

Whenever a category is played the position within the category is remembered, so that, referring to the example above, despite having several category repetitions, tracks will not be repeated until all tracks from the given category have been played.

3.4.5.2M3U program filesThe program file may also be an M3U file, in which case it is a text file containing one file to play each line. The path to the file is relative to the content directory. An example M3U program file:

music/top40/adele.mp3music/top40/monsters.mp3music/kpop/gg/oh.mp3

5 On video capable MPX devices only.10

Page 15: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

music/top40/scooter.mp3music/rock/acdc/little_lover.mp3

Tracks are played in the order specified by the M3U, unless shuffle is enabled. For shuffle details see section 4.1.2.

3.4.6Content playback timingThe device has no built-in permanent real time clock by default6, so for timing to work the device must be connected to the internet, as the device receives current time and time zone settings over the network! For more details see section 3.6.

The program files shall be stored in the “program“ or “video_program” folder. The program fileshall contain the name of the categories (immediate folder names in the “music“/”video” folder),one per line. At most 1000 categories are allowed per program file.

Additionally a program timetable is provided where you can specify what kind of backup programto play from the internal storage in case of a network outage. It has to be uploaded to the “config”directory under the name of “program_timetable”/”video_program_timetable”. An example isshown below:

#[year month dom dow hour min][year month dom dow hour min]prog[ * * * * 17 * ] [ * * * * 20 * ]late_afternoon[ * * * * 20 * ] [ * * * * * * ]::STOP::[ * * * * * * ] [ * * * * 6 * ]::STOP::[ * * * * * * ] [ * * * * * * ]default

The detailed explanation of a program timetable line is as follows:

•Each line contains one time frame and a program name in the following form:

•[From][To] Program_name

•The [From] and [To] parameters contain the two dates and times between which the program will be active. These intervals include the opening, but do not include the closing time.

•The player uses the ‘program/program_name’ file as a program file if the actual time is within the specified interval.

•The format of [From] and [To] parameters is the following (the fields must be separated by spaces or tabulators):

•[year month day-of-month day-of-week hour minute]

•where the valid values are:

•1970-2038 1-12 1-31 0-6 0-23 0-59

•where in all fields ‘*’ can appear as an arbitrary value, and

6 Real Time Clock is offered as an ordering option.11

Page 16: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

•day of week: 0: Sunday 1: Monday, etc…

•When composing a program, disjoint time intervals shall be provided. If two intervals overlap, the player will decide which program to consider valid (first match).

In the example above a simple program timetable is provided. Three programs are defined to use incase of an outage. “late_afternoon” shall be played if the time is between 5pm and 8pm, no contentis played from 8pm till 6am and “default” every other time.

There is a special program name as seen in the example, which makes the device stop playback forthe given time period. This is the STOP mode and the ::STOP:: string has to be used as the programname.

3.4.7Spot playback timingSpot playback event timing is done according to a standard crontab. The file has to be placed in the config directory under the name spot_cron. Since there is a single cron file for all spots, make sure that spot category names are unique across the device.

* * * * * spot command

┬ ┬ ┬ ┬ ┬│ │ │ │ ││ │ │ │ ││ │ │ │ └───── day of week (0 - 7) (0 or 7 are Sunday, or use names)│ │ │ └────────── month (1 - 12)│ │ └─────────────── day of month (1 - 31)│ └──────────────────── hour (0 - 23)└───────────────────────── min (0 – 59)

Asterix “*” symbol means match anytime. The cron file is checked every minute and all lines matching the current time are executed.

Periodic events should be supplied using */n format where n is a number in the specified range. Forexample to execute a spot command every 5 minutes the following line must be used:

*/5 * * * * spot command

The format of a spot command is the following:

echo “SPOT_CMD IMMEDIATE_FLAG CATEGORY_NAME” > /tmp/fifo/controller.fifo

The details of the spot command parameters are described below:

•SPOT_CMD: can be either SPOT or VIDEO_SPOT for audio and video spots respectively.

•IMMEDIATE_FLAG: is an integer number (either 0 or 1). If it is set to 0 the spot will be played after the current track ends. If it is set to 1 the spot is played immediately. The immediate flag has no effect and the spot is played immediately, if the audio source is an on-line stream, since a streams are continuous and have no end.Immediate audio spots are mixed over the current audio content, for detailed settings see section 4.1. If the current video content is interrupted by immediate video spots, then the interrupted video content is not resumed and the following video content is played instead.

•CATEGORY_NAME: category of the spot to be played. For categories in detail see section 3.4.4.

12

Page 17: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

For example the following command would play an audio spot from the promo category every hour:

* */1 * * * echo “SPOT 0 promo” > /tmp/fifo/controller.fifo

3.5Device configuration and firmware updatesConfiguration settings may be updated in three ways. Each of them are available for all of thedevices. The configuration is stored securely in the device's internal flash, separately from the store& forward content.

There are various options which enable the device to be configured for your individual needs. Onupdating configuration settings or device firmware see section 3.5.

3.5.1Updates via Dension SherpaThe most convenient way is using the Dension Sherpa web service to manage the devices remotely.The main feature of it is to deliver content, configuration and firmware update files to the device.Once you create a firmware update task or configuration files, it can be addressed to multipledevices at the same time, making mass management easy. The order of configuration updates aredefined by the server.

For more details please refer to the Dension Sherpa Reference Manual.

3.5.2Updates via USB dongleThe Digital Player devices read the following files located at the root location of a FAT-formatted USB memory dongle:

xxxx.den Firmware file. The file contains the internal firmware running in the Digital Player devices. It is Dension’s exclusive right to modify and release newer versions of device firmware.

xxxx.cfg A file in ASCII text format containing the configuration parameters. Each line consists of a parameter and a value. (Parameter = Value) After ‘#’ mark comments may be added.

The device reads all the *.cfg extension files in the root directory in alphabetic order, and applies them sequentially.

Configuration files are left unchanged on the USB dongle making multiple device configurations possible.

Firmware updates are available through the Sherpa system. In special cases, when devices need to be updated manually, please contact Dension's support for the update files.

3.5.3Configuration update via the built in web interfaceThe devices have a built in web interface, which allows setting the most important configuration settings. It is recommended to be used for testing and on-site installation purposes, because the device might not be available to the broader internet if it is installed behind a router or firewall.

The default password to the device is: “password” (without quotation marks). It is highlyrecommended to change the default password after installation or at least to place the devicebehind a firewall!

13

Page 18: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

The interface consists of two pages:

•Configuration: this page contains the most essential playback and network configuration optionsrequired for quick adjustments and device setup needs.

After power up the following procedure is executed by the digital signage devices:

1.Logging in to Dension Sherpa system and sending logs since last connection.

14

Page 19: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

2.Updating system time and date.

3.Looking up and executing *.den and *.cfg files on the USB dongle. Once processed, the firmware filenames will be extended by ‘Updated_’ prefix. If necessary, a reboot will take place. Files starting with the prefix will not be considered, and the system initiates the next task in the order. Note that files with *.cfg extension are not renamed.This cycle lasts until there are no files remaining to be processed.

4.Checking Dension Sherpa for tasks that were assigned to the device.

During the process of updates and configuration settings the Internet, Network and Status LEDs are flashing! WARNING! It is strictly forbidden to disconnect the device from the electric power supply during this time, because it might lead to major breakdown issues.

3.5.5Configuration file formatConfiguration settings of the device can be stored as human readable txt file with the extension: .cfg(eg. volume.cfg)

Once a device receives such a file (from an USB flash drive, or from the Dension Sherpa) it parses the content, and applies the configuration settings one by one.

The configuration file format is simple:

# comment linestring_parameter = "string value"bool_parameter = true # could be falseint_parameter = 10 # can be negative in some cases

The following rules shall be kept when editing configuration files:

•The configuration values may contain only ISO-8859-1 alphanumerical characters (English letters), and most punctuations.

•Do not use the “&” character!

• A parameter value shall not contain “#”, as it is the comment marker and every character on the line after the hash mark symbol (including the symbol itself) will be thrown away.

A configuration file can be generated by editing in a text editor of your choice (e.g. Notepad++, vim).

A configuration file may contain all the parameters, or just a subset of it – whatever is more convenient.

The available configuration parameters and their values are described in the following chapters, where the various features are explained in detail.

There is a special configuration option that allows arbitrary command execution on the device. It can only be used via an USB dongle and has the following format:

shell = "some shell command"

Usage of this configuration option is recommended only for advanced users. Incorrect usage of this option may cause erroneous behavior of the device or full breakage! Use it at your own risk!

15

Page 20: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

3.5.6Content update file formatContent update files contain lines in the following format:

+filename;MD5hash;URL-filename2;MD5hash;URL

The ISR devices save the resource pointed to by “URL7” to the internal storage under “filename”. Download-validation is provided by using MD5 hash8 . The MD5 hash serves to avoid duplicate downloads of already present content and to validate new downloads. Filenames are relative to the content/ folder. For example you need to specify music/rock/acdc.mp3.

Filenames should not contain the following characters: &?#<>()[]$:,"'. Content update files are executed line by line in the order specified in the update file.

Lines beginning with “+” will be downloaded to the device, while lines beginning with “-” will be removed from the device.

For mass deletion the following two commands may be used:

---directory

The “--” command will delete all files on the device that are not mentioned anywhere in the content update file. The -directory command will delete everything in the given directory that is not mentioned in the content update file.

Firmware versions starting form 3.0 also support in-line configuration updates in the content updatefiles.

In this case the format is +config_file;<<<;EOFfirst line contentsecond line content….last line contentEOF

An example would be:

+config/program_timetable;<<<;EOF#[year month dom dow hour min] [year month dom dow hour min]Program[ * * * * * * ] [ * * * * * * ]default.m3uEOF

RECONFIG

A reconfiguration event may also be asked by the last line.

Content updates have the following statuses on Dension Sherpa:

•Waiting for deployment: the content update is pending.

•Deployed to device: the content update file has been sent to the device.

7 SSL is supported.8 Pre 2.18 firmwares support only lower case MD5 checksums!

16

Page 21: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

•Running: the device is commencing with the content update.

•Done: the content update completed successfully.

•Partially done: the content update was only completed partially due to some error.

•Canceled: the content update task has been manually canceled.

The content update progress is also observable in the functional log.

3.6Time and date managementThe devices do not have an internal clock9. Time and date are provided on software basis from the first login to the Dension Sherpa system, which provides the actual UTC time for the device.

Before the first valid heartbeat communication to Dension Sherpa, the time counter runs from 1 January 1970, 0 hour 0 minute.

Summer time is recognized.

3.7Restoring factory settingsISR devices support restoring the factory default settings.

To restore factory values, press the reset button placed on the back side of the device continuously for 20 seconds. After 20 seconds, the device will reload its factory configuration. This process is indicated by the flashing of the Internet, Stream and Status LEDs. The device automatically reboots after this procedure.

The factory-set values can be found in 7.1.

9 Built-in RTC (real time clock) is offered as a separate ordering option17

Page 22: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

4Configuration Settings

4.1Playback settingsMany different settings are available for the devices in order to make their operation flexible and highly customizable.

4.1.1Streaming playbackIn stream playback mode the device plays live stream content, however, in case of network downtimes it switches to internal off-line content (store & forward mode). During store & forward mode the network connection is continuously observed, and if the device becomes on-line it switches back to streaming. On-line playback is controlled by the following options:

online_url: [string] [default = “”]This parameter stores the URL of the stream to be played or it must point to an m3u list that has regular stream URL-s listed in it. If this parameter is set to empty, store & forward playback is enabled. The URL-s contained in the m3u are for backup purposes. If the first stream is not available then the next stream is tried. This is done until all URL-s are exhausted, then it starts over.

The '${serial}' string in the online_url parameter is substituted with the serial number of the device. This is an easy way to distinguish streaming devices at server side. For example if the online_url field is “http://stream.example.com?device=${serial}” and the serial number is 100000000, then thedevice connects using the “http://stream.example.com?device=100000000” URL.

online_format: [string] [default = “”]This is the format specifier for the on-line URL to play. Currently it interprets:

◦m3u: M3U list containing a set of stream URLs (preferably to the same stream, as URLs act as backup if the previous ones fail).

◦mp3: MP3 format stream

◦aac: AAC format stream10

Any other value, including the empty string means that the URL provided in the online_url is a direct stream URL. The encoding of the audio stream is auto detected.

online_try_count: [integer] [default = 3]This parameter sets how many times the on-line stream (including the backup streams, if m3u is set)will be tried to play before the device falls back to off-line playback. If set to 0 the device will not try to play the on-line stream again.

online_sw_lock_mins: [integer] [default = 0]This parameter sets the waiting time in minutes before the device attempts on-line playback after falling back to off-line mode.

10 AAC decoding is available upon request, not enabled by default.18

Page 23: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

immediate_online_sw: [integer] [default = 1]This parameter sets whether the device should switch back to on-line mode immediately as soon as the stream is available again (1), or should wait until the current off-line track has finished playing (0).

Example:online_url = "http://streamlink.com/stream"online_format = "mp3"online_try_count = 3online_sw_lock_mins = 0immediate_online_sw = 1

4.1.2Store & Forward playbackIn Store&forward mode the device plays off-line content and uses the network connection only for maintenance and content update purposes. The store & forward mode is controlled by the following options:

shuffle: [bool] [default = true]This flag decides whether the content list for playback is shuffled or not. If shuffle is turned off, the tracks are played in the order given in the M3U list or in the order in which the files are stored on the filesystem (not guaranteed to be alphabetical).

shuffle_norepeat: [integer] [default = 30]Tells what percentage of items in the previous shuffle list won't be present at the beginning of the recently generated shuffle list.

immediate_prog_sw: [integer] [default = 0]This switch defines how time based program switches are handled.

◦0: the device will wait for the current track to finish before switching.

◦1: the device will switch program immediately interrupting the currently played track.

•limited_mode: [integer] [default = 0]If set to 1 the player enters limited mode immediately. In this mode the limited.m3u program is played all the time. If such a program does not exist the player will stop playing. Set this option to 0to disable it.

•limited_mode_hours: [integer] [default = 0]If the device cannot successfully heartbeat for the specified hours it enters limited mode. If the parameter is set to 0 the device never enters limited mode automatically.

•program_timetable: [string] [default=”program_timetable”]

The program timetable to be used for store & forward audio playback scheduling.

4.2Audio volume settingsThe devices have a wide set of audio options. The following diagram explains the audio signal paths and control options.

19

Page 24: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

When playing from different audio sources (including video sound for the MPX product line), the audio signals are mixed as shown on the figure above. When the audio source changes (e.g. going from off-line playback to on-line playback) the audio streams are faded into each other, providing a seamless experience. The fade operation is configurable in terms of duration and characteristic (see fade_ms, fade_table, spot_fade_ms, spot_fade_table parameters below).

Some devices also feature an analogue input, including a built-in level detector.

In this case if an audio signal is detected on the input, the signal is automatically faded in, while the currently played audio content is faded out. The configured playback is resumed if a given timeout passes on the input without a significant signal. This may be used for announcements or other device play through.

Furthermore, the device is capable of lowering the background audio volume, if an audio spot is played from the storage. The volume level of the spot audio is always 0dB, the volume level of the background audio (online stream, or stored music content) may be decreased up to -40dB. The volume of the music relative to spots is also configurable.

For MP3 streams the audio volume level is affected by the mp3 stream gain setting.

The following parameters define the audio volume:

•volume_mode11: [string] [default = “Fixed”]Defines the type of volume settings for the amplified analogue output.

◦Manual: Volume level is set by the position of the potentiometer.

◦Startup: The initial volume level is defined by the Startup_Volume parameter, but this may be changed manually by the volume knob.

◦Fixed: The Startup_Volume parameter defines the volume level, which cannot be altered manually.

•startup_volume12: [integer] [default = -20] [range: -40 .. 0]The initial volume level, when the device is turned on (in dB). Value range: -40dB and 0 dB, where

11 Setting has effect only on 100 series devices12 Setting has effect only on 100 series devices

20

Page 25: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

0dB (+6dB for 100 series) is full power volume. Above 0dB digital volume settings the analogue output may suffer distortion depending on the signal.

•volume_right: [integer] [default = 0] [range: -12 .. 12]Relative volume of the right channel in dB. Value range is between +/-12 dB. In case of mono systems, 0dB value shall be set. Please consider the possible distortion, if startup_volume + volume_right is greater than 0 dB.

•volume_left: [integer] [default = 0] [range: -12 .. 12]Relative volume of the left channel in dB. Value range is between +/-12 dB. In case of mono systems the value is ineffective. Please consider the possible distortion if startup_volume + volume_left is greater than 0 dB.

•volume_max11: [integer] [default = -6] [range: -40 .. 0]The volume level in manual mode, if the potentiometer is set to the maximum position.

•music_offset13: [float] [default = 0.00] [range: -40 .. 0]Digital volume offset of the music tracks (in dB) compared to 0 dB level. This may be used to emphasize spots by having a volume boost compared to music content.

•spot_offset13: [float] [default = 0.00] [range: -40 .. 0]Digital volume offset of spots (in dB) compared to 0 dB level. This may be used to set maximum spot volume level.

•music_spot_offset13: [float] [default = -40.00] [range: -40 .. 0]Digital volume of the music tracks during spot playback (in dB) compared to 0 dB level. -40 dB is quasi muted

•fade_ms13: [integer] [default = 4000] [range: 500 .. 8000]Length of audio cross fading in ms. If set to less than 500ms then 500ms is used.

•fade_table13: [string] [default = “linear”] [range: linear, log, nofade]This parameter sets the fade characteristic curve to be used when fading audio content. If empty, “linear” is used by default.

•spot_fade_ms13: [integer] [default = 1000] [range: 500 .. 8000]Length of audio spot cross fading in ms. If set to less than 500ms, then 500ms is used.

•spot_fade_table13: [string] [default = “linear”] [range: linear, log, nofade]This parameter sets the fade characteristic curve to be used when fading audio spot content. If empty, “linear” is used by default.

•linein_timeout11: [integer] [default = 0]If the device is shipped with an analogue input, the parameter specifies the length of silence in milliseconds required to switch back to the original content playback. If set to 0 the device never uses the analogue input. For devices without analogue input 0 must be configured.

Example:

13 Changing this setting might require reboot. Please note that volume offset parameters are integer values on all MPXdevices and ISR devices with firmware versions below 4.5. The spot_offset parameter is available only on ISR devices with firmware 4.5 or higher. Applying changes to the marked parameters does not require reboot on ISR devices with firmware 4.5 or higher.

21

Page 26: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

volume_mode = "Manual"startup_volume = 0volume_right = 0volume_left = 0music_spot_offset = -20linein_timeout = 0

4.3Video settings14

•video_program_timetable: [string] [default=”video_program_timetable”]The program timetable to be used for store & forward video playback scheduling15.

•slideshow_fade_ms: [integer] [default = 2000] [range: 0 .. 8000]Length of image content cross fading in ms. If set to 0 immediate switching without fade will be used. Please note that videos are not faded.

•slideshow_delay_s: [integer] [default = 10] [range: 0 .. 32765]Length of time to show a still video/image content before switching to the next one. It contains one length of slideshow fade-time.

4.4Display settingsThese settings may be used to fine tune the image quality of the device if it is connected to a specific display. These settings should be set for each device depending on the display used.

Changes to these settings require reboot.

•hue: [float] [default = 0] [range: -30.0 .. 30.0]Hue setting for the video output.

•brightness: [integer] [default = 0] [range: -128 .. 127]Brightness setting for the video output.

•contrast: [float] [default = 1.0] [range: -4.0 .. 4.0]Contrast setting for the video output.

The gamma correction settings describe a profile. The value of these fields is an integer array containing the coefficient values of the curve at the following indexes: 0, 16, 32, 48, 64, 80, 96, 112,144, 160, 176, 192, 208, 224, 240, 255. The value for the index 128 is the average of the values found in 112 and 144. Each coefficient in the array is in the range of [-8 .. 7], but the real value of it will be COEFFx4.

•red_gamma: [integer array] [default = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}]Red gamma correction curve

•green_gamma: [integer array] [default = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}]Green gamma correction curve

•blue_gamma: [integer array] [default = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}]Blue gamma correction curve

14 Only for video content capable MPX devices.15 Not available in earlier firmware versions.

22

Page 27: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

•dynamic_backlight: [bool] [default = false]Switch to enable dynamic backlight setting it ambient light sensor is present.

•backlight_level: [integer] [default = 100] [range = 0 .. 100]Level of the backlight if no ambient light sensor is present.

•rotation: [integer] [default = 0] [range = 0, 90, 180, 270]Rotation of the displayed image. This setting is useful when the screen is in portrait mode.

•y2r_mode: [integer] [default = 0] [range = 0 .. 3]YUV2RGB mode setting.

4.5Network settings

4.5.1EthernetIn case the internet access is supplied via the 10/100 Mb ethernet connector two settings are possible for the device:

DHCP: The device receives an IP address from the router of the network. Related configuration:

•eth_dhcp: [bool] [ default = true ] The parameter is used to enable or disable DHCP mode.

◦true: DHCP mode, network settings are acquired automatically. If set, the manual options below are ignored.

◦false: manual network settings are used.

Fix IP An IP address may be given directly to the device along with other network settings.

eth_ip: [srting] [ default = "" ]IPv4 address of the device in decimal format. Example: 192.168.0.1

eth_netmask: [srting] [ default = "" ]IPv4 netmask of the device in decimal format. Example: 255.255.255.0

eth_gw: [srting] [ default = "" ]Gateway address for the device. Example: 192.168.0.100. fully qualified domain name.

eth_dns1: [srting] [ default = "" ]First domain name server address. Example 192.168.0.253. Can be fully qualified domain name.

eth_dns2: [srting] [ default = "" ]Second domain name server address. Example 192.168.0.254. Can be fully qualified domain name.

Example:

eth_dhcp = falseeth_ip = "192.168.0.48" #set IP addresseth_netmask = "255.255.255.0"eth_gw = "192.168.0.3" #default gatewayeth_dns1 = "192.168.0.3" #name resolutioneth_dns2 = "8.8.8.8"

23

Page 28: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

4.5.2Proxy

Setting up the proxy feature is useful if you put the device behind a proxy server. See chapter “Configuration update via the built in web interface“ and please set up the proxy parameters which are described below.

Setting “proxy_host” and “proxy_type” is mandatory if you desire to use proxy.

Related configurations:

proxy_host: [string] [ default = "" ]IPv4 address of the device in decimal format and port number with colon. Example: 192.168.0.1:8080

proxy_type [string] [ default = "http" ]

Store and forward mode: May be set to

“http”, “http_1_0”, “socks4”, “socks5”, “socks4a”, “socks5h”.

Stream mode: Only “http” is available.

proxy_auth [string] [ default = "basic" ]

Store and forward mode: May be set to “basic”, “digest”, “negotiate”, “ntlm”, “anyauth”.

Stream mode: Only “basic” is available.

proxy_user [string] [ default = "" ]

Store and forward mode: Available.

Stream mode: Not available, stream is to be used only without authorization.

Warning! Please pay attention to whether your proxy server is set to case sensitive mode or not.

proxy_pass [srting] [ default = "" ]

Store and forward mode: Available.

Stream mode: Not available, stream may be used only without authorization.

Example of Store and Forward mode:

proxy_host = "192.168.0.48:8080" proxy_type = "http"proxy_auth = "basic" proxy_user = "username" proxy_pass = "password"

Example of Stream mode:

proxy_host = "192.168.0.48:8080" proxy_type = "http"proxy_auth = "basic" proxy_user = "" proxy_pass = ""

24

Page 29: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

4.5.3Wi-FiThe built-in or USB connected WiFi module may be configured with the settings below. AP mode iscurrently not supported, the options are reserved for future use and are mentioned here only for completeness.

wifi_enabled: [bool] [ default = "false" ]Switch to enable or disable WiFi connectivity.

wifi_mode: [string] [ default = “sta”]

◦sta: Standard client mode for connecting to existing WiFi networks.

◦Ap (not supported) : Access point mode for creating the own WiFi network of the device.

wifi_ssid: [string] [ default = “Dension MPX” ]SSID of the WiFi network.

wifi_pass: [string] [ default = “12345678”]Password of the WiFi network.

wifi_security: [bool] [ default = false ]Switch to enable WiFi network WPA/PSK2 security mode.

4.5.3.1Settings for access point mode ( not supported )wifi_ap_channel: [integer] [ default = 3 ]Channel number to operate on.

wifi_ap_countrycode: [string] [ default = “US” ]ISO standard two letter country code for network operation.

wifi_ip: [string] [ default = “192.168.1.1” ]IPv4 address of the device in decimal format, when in AP mode.

wifi_netmask: [string] [ default = “” ]IPv4 netmask for the device's network in decimal format, when in AP mode.

wifi_dhcp_range_start: [string] [ default = “192.168.1.2” ]First available IPv4 address in the range available to the clients when operating in AP mode.

wifi_dhcp_range_last: [string] [ default = “192.168.1.99” ]Last available IPv4 address in the range available to the clients when operating in AP mode.

The WiFi DHCP range must not contain the IP address of the device itself.

4.5.43G InternetTo use mobile internet connection a USB 3G modem dongle must be connected to one of the USB ports of the device. In case of xxx-100 devices the internal USB ports may also be used, with an antenna cable toward the back side of the device.

The device shall be configured according to the network provider. The following parameters may beset int the configuration:

25

Page 30: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

gsm_pin: [string] [ default = "" ]Pin code for the SIM card.

gsm_has_apn: [bool] [ default = false ]Set to true if custom APN has to be used.

gsm_apn: [string] [ default = "" ]Address of the APN. May be fully qualified domain name or IP address.

gsm_user: [string] [ default = "" ]User name for the network service.

gsm_pass: [string] [ default = "" ]Password for the network service.

gsm_dns1: [string] [ default = "" ]First domain name server address. May be fully qualified domain name or IP address.

gsm_dns2: [string] [ default = "" ]Second domain name server address. May be fully qualified domain name or IP address.

gsm_gw: [string] [ default = "" ]Gateway address for the 3G service. May be fully qualified domain name or IP address.

gsm_roaming: [bool] [ default = false ]Switch to enable roaming over 3G.

gsm_country: [string]Country of the GSM provider. Used by the built-in web interface for informational purposes. Pleasedo not alter it manually!

gsm_provider: [string]GSM provider name. Used by the built-in web interface for informational purposes. Please do not alter it manually!

Regular networks ask for pin and apm, country and provider fields are provided for informational purposes.

4.6Remote management settingsRemote management of the devices is granted by regular communication (so called heartbeat) between the device and the Sherpa server.

Once the device is on (and the network connection is established), it connects to the Sherpa server, reports its status and logs, and acquires the scheduled tasks from the server. These tasks are used to maintain internal content, or describe downloads of content, configuration and Firmware updates. This heartbeat procedure is repeated regularly, according to the configuration settings:

heartbeat_period: [integer] [ default = 300 ]The parameter defines the heartbeat period time in seconds. If the value is set to 0, there are no heartbeats, only one heartbeat is sent to the Dension Sherpa system (upon startup). This is not recommended, because it makes maintenaning the device remotely impossible.

26

Page 31: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

heartbeat_window_start: [integer] [ default = 0 ]Defines the minute of the day after which heartbeat is allowed.

heartbeat_window_length: [integer] [ default = 0 ]This is the length of the time frame, in minutes, for the heartbeat mechanism to operate after the window started. The 0 value means sending heartbeats is allowed until the end of the day. The X-Link Pro device connects to the Dension Sherpa every day in the period defined by this window parameter and the window start parameter above. As long as there is no valid internal time in the device, connection requests to Dension Sherpa are enabled.

heartbeat_url: [string] [ default = “"http://sherpa.dension.com/interface/heartbeat/"”]The URL address of the Dension Sherpa server for heartbeats. Do not set this variable unless you are absolutely sure what is the correct value for your conditions!

The ‘Internet’ light goes off only in case there is no answer from the Dension Sherpa server. This may happen if the ethernet-line has been disconnected, network settings have been changed or communication has been blocked by a firewall.

max_time_diff: [integer] [ default = 300]Maximal time difference (expressed in seconds) between the internal clock of the device and the time received from Dension Sherpa server. If the difference exceeds this limit the device clock is setto the time received from the server. If this config value is 0 the device clock is set after every heartbeat.

5AccessoriesThe devices are capable of handling a range of external devices to maximize the performance of an in-store application.

5.1USB keyboard controlThe devices support external numeric pads through the USB port. This enables special-case user interaction and custom behavior of the devices if necessary. This may be used primarily to play custom spots out of order, independently from timetable settings when required.

Actions for the numeric pad are stored in the config/keyboard_events file. This file has the following format:

EVENT;COMMAND

where an event might be a decimal number in quotes or a scan code.

If a decimal number in quotes is provided, the number must be entered followed by an enter on the numeric pad to execute the command. Backspace may be used for correcting typos.

If a scan code is used, the event will occur on pressing the specified key on the numeric pad, in this case pressing enter is not necessary.

The command has the same format as the format used in the spot crontab file. For details see section 3.4.6.

Example:

"10";echo "SPOT 1 short " > /tmp/fifo/controller.fifo27

Page 32: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

"2";echo "SPOT 1 spot2 " > /tmp/fifo/controller.fifo0x49;echo "SPOT 1 manu_chao" > /tmp/fifo/controller.fifo

In the first example, '1' '0' is typed in. By pressing 'Enter', the device starts playing spots from the folder content/spot/short.

By typing '2' and pressing 'Enter' , a spot is played from the content/spot/spot2/ folder.

In the third case, since the Numpad 9 has the scan code ’0x49’, it is enough to press No. 9 (without Enter) and in this case a song would be played from the folder content/spot/manu_chao/. It would take around 20 secs to play (opening plus buffering).

See appendix 7.3 for a table of available scan codes.

5.2GPIO controlThe devices may be extended with an additional GPIO capability via the USB port. Dension's relay extension cable provides a 230VAC/2A capable relay contact to control an external device's power.

The GPIO is controlled by the relay_timetable file in the config directory, which has the same format as program timetables. For details see section 3.4.6.The difference from program timetables is that here instead of program names one of the following 2 commands should be used: RELAY_ON, RELAY_OFF, which commands turn the relay swtich on or off respectively.

Example:#[year month dom dow hour min] [year month dom dow hour min]Relay_state[ * * * * 8 * ] [ * * * * 9 30 ]RELAY_ON[ * * * * 17 * ] [ * * * * 20 * ]RELAY_ON[ * * * * * * ] [ * * * * * * ]RELAY_OFF

This example script switches the relay on between 8 AM and 9:30 AM and between 5 PM and 8 PM, otherwise the relay is turned off. If no internet connection is available16 (and therefore there is no time information for the device) the relay is turned off.

By default the relay is switched on.

16 This restriction does not apply to devices equipped with a real time clock.28

Page 33: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

6Remote management (Dension Sherpa)The Dension Sherpa is a Web2.0 based application developed for the maintenance and operation of the ISR and MPX devices over the internet. It runs as a cloud service, hosted on Dension's servers and all devices are connected to it.

The Dension Sherpa service collects and presents device logs, status and configuration information submitted by ISR and MPX devices. Each customer has their devices assigned to their user account,where they may view and configure them. Dension Sherpa also provides an interface for content as well as firmware updates.

For detailed information please refer to the Dension Sherpa reference guide.

Remote management - Dension Sherpa API

The API is a low level interface for programmers to access Dension Sherpa's functionality.

Service descriptor WSDL URL: http://isrs.dension.com/api/soap/?wsdl

UAK: User Access Key is a system generated access key required to authenticate the user. It can be generated at the Dension Sherpa website.

For detailed information please refer to the Dension Sherpa reference guide.

29

Page 34: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

7Appendix

7.1 Configuration parameter summaryParameter Type Short description Range

online_url string On-line stream ULR -

online_format string On-line stream format mp3, wma, aac

shuffle bool Playlist shuffling list true, false

shuffle_norepeat integer Percent of last items from previous shuffle list not repeated in the new shuffle list beginning.

0 .. 50

volume_mode string Mode of the volume setting manual, startup, fixed

startup_volume integer When using „startup” or „fixed”, then the volume in dB -40 .. 0

volume_right integer Relative volume of the right channel in dB -12 .. 12

volume_left integer Relative volume of the left channel in dB -12 .. 12

volume_max integer Maximum volume when in manual mode and knob is at maximum position in dB

-40 .. 0

gsm_pin string 3G modem PIN code -

gsm_country string Country of the 3G network provider -

gsm_provider string Name of the 3G provider -

gsm_has_apn bool Flag to indicate APN useage by the mobile provider true, false

gsm_apn string Address of the APN -

gsm_user string User name for the 3G network service -

gsm_pass string Password for the 3G network service -

gsm_dns1 string 3G network primary DNS address -

gsm_dns2 string 3G network seconday DNS address -

gsm_gw string 3G network gateway address -

gsm_roaming logikai Switch to enable roaming mode true, false

heartbeat_period integer Heartbeat frequency to the Dension Sherpa seconds Positive integersbo

heartbeat_win_start integer Minute of the day after which heartbeat is allowed 0 .. 1439

heartbeat_win_length integer Number of minutes allowed for heartbeat after window start 0 .. 1439

heartbeat_URL string URL of the Dension Sherpa server to heartbeat to -

program_timetable string Name of the audio program timetable to use -

eth_dhcp bool Switch between DHCP and fix IP mode. true, false

eth_ip string IP address of the device -

eth_netmask srting Net mask of the network the device is connected to -

eth_gw string IP address of the default gateway -

eth_dns1 string IP address of the primary DNS server -

eth_dns2 string IP address of the secondary DNS server -

linein_timeout integer Silence on the analogue input before switching back in seconds Positive integers

immediate_prog_sw integer Switch to define whether to wait for track end before switching back to on-line content

0,1

limited_mode integer Switch to enable limited mode. 0,1

30

Page 35: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

music_offset float Music volume offset compared to 0dB level. -40.00 … 0

spot_offset float Spot volume offset compared to 0dB level. -40.00 … 0

music_spot_offset float Music volume in the background while spot is played -40.00 .. 0

fade_table string Fade table characteristic linear, log, nofade

fade_ms integer Audio cross-fade time in milliseconds 500-8000

spot_fade_table string Audio spot fade table characteristic linear, log, nofade

spot_fade_ms integer Audio spot cross-fade time in milliseconds 500-8000

limited_mode_hours integer Time without heartbeat before, entering limited mode Positive numbers

online_try_count integer Try count of the on-line stream before starting backup Positive numbers

online_sw_lock_mins integer Wait time in minutes trying on-line stream after fallback Positive numbers

immediate_online_sw integer Switch for immediate switch back to online 0,1

slideshow_fade_ms integer Crossfade time of still images in milliseconds 0 .. 8000

slideshow_delay_s integer Time in seconds to show a still image/website. 0 .. 32765

wifi_enabled bool Switch to enable WiFi module true, false

wifi_mode string Access point or client mode ap, sta

wifi_ssid string SSID of the WiFi network -

wifi_pass string Password to the WiFi network -

wifi_security bool Switch to enable WPA/PSK secutiry true, false

wifi_ap_channel integer Channel number to use in AP mode 1 .. 13

wifi_ap_countrycode string Country code for AP mode ISO 2 letter codes

wifi_ip sting IP address of the device in AP mode -

wifi_netmask string Netmask of the device's network in AP mode -

wifi_dhcp_range_start string First available IP address to clients in AP mode -

wifi_dhcp_range_last string Last available IP address to clients in AP mode -

hue float Video output hue setting -30.0 .. 30.0

brightness integer Video output rightness setting -128 .. 127

contrast float Video output contrast -4.0 .. 4.0

red_gamma integer array

Red gamma curve -8 .. 7

green_gamma integer array

Green gamma curve -8 .. 7

blue_gamma integer array

Blue gamma curve -8 .. 7

dynamic_backlight bool Switch to enable dynamic backlight true, false

backlight_level integer Backlight level if there is no ambient light sensor 0 .. 100

rotation integer Rotation of the screen image 0, 90, 180, 270

y2r_mode integer YUV2RGB mode setting 0 .. 3

max_time_diff Integer Time difference limit in seconds between local device time and server time received in heartbeat. Above this limit the local timeis adjusted to server time.

Non-negative integers

shell string Internal shell command -

31

Page 36: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

7.2Script descriptionShell commands may be executed only in config files, that are uploaded via an USB drive.

Using shell command configuration files may render your device unusable! Only use this option if you are absolutely sure what you are doing!

Shell commands execute regular Unix shell commands, that can be found in a typical busybox installation.

7.3Keyboard scan codes

System logs are accessible via the Dension Sherpa web service. Playlists consist of an already condensed version of these logs.

A regular system log line has the following format:

DATE TIME DEVICE_ID INFO.TYPE COMPONENT MESSAGE

•DATE: date of the log in YYYY MON DD format

•TIME: time of the log in hh:mm:ss format

•DEVICE_ID: the serial number of the device itself

•INFO.TYPE: the info field that might be either local0 or user. Local0 log lines are functional log lines that can be seen in the regular logs. User log lines can be found in the debug log, if enabled.The type of the log line might either be info, warn or err which stand for information, warning and error respectively. Not all errors shall be treated as fatal, as some of them may appear during normaloperation (e.g. signaling the end of a track ).

•COMPONENT: name of the internal component presenting the message. This is important for reading the debug logs.

•MESSAGE: the message of the log. This field contains the relevant information of the log event.

Logs are reported to the Dension Sherpa service during heartbeats. For this reason it is important to allow the device to report to the Dension Sherpa service periodically. If the device is not network enabled for a long time some logs might be lost, due to limited storage on the device.

7.5Supported Video FormatsOutput of the mediainfo (http://mediainfo.sourceforge.net) for some tested video files:

32

Page 37: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

General

Complete name : nature1.mp4Format : MPEG-4Format profile : Base Media / Version 2Codec ID : mp42File size : 85.2 MiBDuration : 3mn 57sOverall bit rate : 3 004 KbpsEncoded date : UTC 2012-09-04 08:37:26Tagged date : UTC 2012-09-04 08:37:26

00:00:00:00

Video

ID : 1Format : AVCFormat/Info : Advanced Video CodecFormat profile : [email protected] settings, CABAC : YesFormat settings, ReFrames : 3 framesCodec ID : avc1Codec ID/Info : Advanced Video CodingDuration : 3mn 57sBit rate mode : VariableBit rate : 3 002 KbpsWidth : 1 920 pixelsHeight : 1 080 pixelsDisplay aspect ratio : 16:9Frame rate mode : ConstantFrame rate : 25.000 fpsStandard : PALColor space : YUVChroma subsampling : 4:2:0Bit depth : 8 bitsScan type : ProgressiveBits/(Pixel*Frame) : 0.058Stream size : 85.1 MiB (100%)Language : English

33

Page 38: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

General

Complete name : Darago_final_09_avc.mp4Format : MPEG-4Format profile : Base MediaCodec ID : isomFile size : 4.37 MiBDuration : 34s 528msOverall bit rate : 1 061 KbpsEncoded date : UTC 2013-03-21 14:22:08Tagged date : UTC 2013-03-21 14:22:08Writing application : FormatFactory : www.pcfreetime.com

Video

ID : 1Format : AVCFormat/Info : Advanced Video CodecFormat profile :

[email protected]

Format settings, CABAC :

No

Format settings, ReFrames :

1 frame

Codec ID : avc1Codec ID/Info :

Advanced Video Coding

Duration : 34s 400msBit rate mode : VariableBit rate : 1 017 KbpsNominal bit rate :

1 200 Kbps

Maximum bit rate :

9 797 Kbps

Width : 1 920 pixelsHeight : 1 080 pixelsDisplay aspect ratio :

16:9

Frame rate mode :

Constant

34

Page 39: Reference Guide for Dension In-Store Digital Players...In-Store Digital Players (ISR & MPX) Reference Guide V 2.8 Reference Guide for Dension In-Store Digital Players (ISR & MPX) v

In-Store Digital Players (ISR & MPX)Reference Guide V 2.8

Frame rate : 25.000 fpsColor space : YUVChroma subsampling :

4:2:0

Bit depth : 8 bitsScan type : ProgressiveBits/(Pixel*Frame) :

0.020

Stream size : 4.17 MiB (95%)Writing library:

x264 core 116 r2019 9cc407d

Encoding settings :

cabac=0 / ref=1 / deblock=1:0:0 / analyse=0x3:0x113 / me=hex / subme=7 / psy=1/ psy_rd=1.00:0.00 / mixed_ref=0 / me_range=16 / chroma_me=1 / trellis=1 / 8x8dct=1 / cqm=0 / deadzone=21,11 / fast_pskip=1 / chroma_qp_offset=-2 / threads=6 / sliced_threads=0 / nr=0 / decimate=1 / interlaced=0 / bluray_compat=0/ constrained_intra=0 / bframes=0 / weightp=2 / keyint=250 / keyint_min=25 / scenecut=40 / intra_refresh=0 / rc_lookahead=40 / rc=abr / mbtree=1 / bitrate=1200 / ratetol=1.0 / qcomp=0.60 / qpmin=0 / qpmax=69 / qpstep=4 / ip_ratio=1.40 / aq=1:1.00

Encoded date : UTC 2013-03-21 14:22:08Tagged date : UTC 2013-03-21 14:22:08

Audio

ID : 2Format : AACFormat/Info : Advanced Audio CodecFormat profile : LCCodec ID : 40Duration : 34s 528msBit rate mode : VariableBit rate : 48.0 KbpsMaximum bit rate : 192 KbpsChannel(s) : 2 channelsChannel positions : Front: L RSampling rate : 44.1 KHzCompression mode : LossyStream size : 194 KiB (4%)Encoded date : UTC 2013-03-21 14:22:08Tagged date : UTC 2013-03-21 14:22:08

35