SpinetiX HMP series Technical Documentation Manual Download

Page: 2 / 42

Revision
number

Revision
date

Author

Summary of changes

1.0

Apr 22, 2011

Julien Reichel

Original “HMP Configuration Backup” document.

1.1

Jan 23, 2012

Julien Reichel

Changes related to 2.2.4 firmware release.

1.2

Sep 07, 2012 Julien Reichel

Changes related to 2.2.5 firmware release.

1.3

Apr 19, 2013

Julien Reichel

Changes related to 3.0.0 firmware release.

1.4

Jan 15, 2014

Julien Reichel

Changes related to 3.0.3 firmware release.

1.5

Oct 10, 2014

Julien Reichel

Changes related to 3.1.0 firmware release.

1.6

Dec 03, 2014 Julien Reichel

Changes related to 3.1.1 firmware release.

2.0

Mar 06, 2015 Nicusor Cheles

Document renamed to “HMP Configuration API”.
Formatting changes.

Summary of Contents for HMP series

Page 1: ...www spinetix com ...

Page 2: ...chel Changes related to 2 2 5 firmware release 1 3 Apr 19 2013 Julien Reichel Changes related to 3 0 0 firmware release 1 4 Jan 15 2014 Julien Reichel Changes related to 3 0 3 firmware release 1 5 Oct 10 2014 Julien Reichel Changes related to 3 1 0 firmware release 1 6 Dec 03 2014 Julien Reichel Changes related to 3 1 1 firmware release 2 0 Mar 06 2015 Nicusor Cheles Document renamed to HMP Config...

Page 3: ...S ALL WARRANTIES EXPRESSED OR IMPLIED INCLUDING WITHOUT LIMITATION THOSE OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING USAGE OR TRADE PRACTICE IN NO EVENT SHALL SPINETIX OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT SPECIAL CONSEQUENTIAL OR INCIDENTAL DAMAGES INCLUDING WITHOUT LIMITATION LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT ...

Page 4: ... display power save 13 display power schedule 13 underscan supported 14 vga power mode 14 vga dc offset 14 overscan percentage 15 hdmi link type 15 enable audio 15 audio power save 16 splash 16 Network settings 17 ethernet dhcp 17 ethernet static 17 modem 3g simple 18 modem 3g advanced 19 device name 19 network watchdog 20 proxy 20 https validate certificates 21 certificate 22 certificates reset 2...

Page 5: ...imum latency 26 reduce interactive latency 26 Date time settings 27 timezone 27 time manual 27 time ntp 28 Security settings 29 user 29 Content Settings 31 primary source 31 secondary source 31 allow usb sources 31 Pull Mode 32 pull mode disabled 32 pull mode static 32 pull mode file 34 pull mode remote 35 Fusion 35 enable fusion 35 fusion startup 36 Firmware Update 36 firmware update uri 36 firmw...

Page 6: ...7 protocol system 37 protocol file reset 38 protocol file 38 com port settings 38 Others 39 extended USB 39 screen id 39 reboot 40 shutdown temperature 40 wizard 40 Firmware release notes 41 Firmware 2 2 41 Firmware 3 0 41 Firmware 3 1 42 ...

Page 7: ... encapsulated within a configuration element The XML configuration string must have the following structure xml version 1 0 configuration version 1 1 command 1 command 1 command n command n configuration The XML configuration string can reflect a full configuration of the HMP device as it is the case for when the configuration backup is generated from HMP Control Center or it can update only a lim...

Page 8: ...e order provided within the XML configuration string Since different configuration commands can control the same HMP feature the order in which they are provided influences the end result For instance the ethernet dhcp command sets the player to DHCP whereas the ethernet static command sets it to use a fixed IP address If both commands are present in the XML configuration string the last one will ...

Page 9: ... one xml version 1 0 configuration version 1 1 credential reset credential server http demo spinetix com server password spinetix password username spinetix username realm demo realm credential configuration If the two configuration commands are provided in a reversed order all credentials are removed from the HMP device xml version 1 0 configuration version 1 1 credential server http demo spineti...

Page 10: ...e zone name is specified within the text content of the element timezone Europe Zurich timezone To set the HMP device to use a fixed IP address several parameters are needed each being provided as a separate XML element under the main command ethernet static address 192 168 1 10 address netmask 255 255 255 0 netmask gateway 192 168 1 1 gateway dns 192 168 1 1 dns ethernet static This section descr...

Page 11: ...meter to be applied For instance to set up the display to use 720p 60Hz video mode use display video mode resolution 1280x720 resolution vertical freq 60 vertical freq force std mode yes force std mode restrict type hdmi restrict type display video mode Control the video mode used by the display The custom video mode can be expressed either as a CVT mode or a full custom fixed mode specified by th...

Page 12: ...of the video line decimal integer In VESA standard this is known as the horizontal front porch UM Upper margin number of video lines between the vertical sync end the first active line decimal integer In VESA standard this is known as the vertical back porch BM Lower margin number of video lines between the last active line and the end of the video frame decimal integer In VESA standard this is kn...

Page 13: ...ignal to turn off attached screen When this feature is enabled it is possible either to use fixed scheduling to control the status of the screen or to include PowerON or PowerOFF commands in the hypermedia content for a finer tuning of the parameters of the screen The possible values are yes no Note Device must be rebooted for this parameter to be applied For instance to enable power save using VG...

Page 14: ... no Note Device must be rebooted for this parameter to be applied For instance to enable the underscan video mode if supported by the screen use underscan supported yes underscan supported Controls if the VGA connector is powered or not If this is set to auto the VGA will be powered only if a screen connected to the HMP using a VGA cable provides some DDC feedback If a VGA screen is connected to t...

Page 15: ... percentage Added in 3 0 3 firmware release Controls the type of signal sent in the HMDI connector By default the player automatically detects the type of device attached to the HDMI cable HDMI or DVI This settings can be used to override the automatic detection This setting will only be used when connected through HDMI The possible values are auto HDMI DVI For instance to set the HDMI link to DVI...

Page 16: ...s or the reset the images to the default values If new images are set then they must be provided as part of the restored backup This command takes two parameters name Name of the splash image to update Possible values are boot shutdown or firmware file Name of the file to be used as splash screen This file must be present in the compressed backup If this parameters is omitted or the file is not fo...

Page 17: ...is command takes 5 parameters address IP address of the player netmask Net mask used by the player gateway Gateway used by the player to communicate outside the LAN This parameter is optional but necessary to be able to connect to the Internet dns Domain Name Service used by the player This parameter is optional but necessary to be able to resolve names such as www spinetix com dns2 Alternative DN...

Page 18: ...ll lock the modem so check it is typed correctly apn Name of the apn to use Can be left empty unless specified otherwise by the 3G provider pdp type Possible values are IP PPP username Optional username to connect to the service password Optional password to connect to the service auth protocol Possible values are any none pap chap Note this parameter will override settings done using ethernet dhc...

Page 19: ...cid is the context ID usually 1 and apn is the desired APN and enter 99 1 cid as the dial string Contact your telecommunications operator for this kind of details Note this parameter will override settings done using ethernet dhcp ethernet static modem 3g simple or modem 3g advanced For instance to enable 3G modem using the advanced configuration mode use modem 3g advanced pin 1234 pin init string...

Page 20: ...es necessary to reset the 3G dongle by doing a reboot of the HMP to restore a lost connection This command is composed of the following parameters max time no addr Maximum time the device is allowed to stay without an assigned IP address min time keep addr Minimum amount of time an IP address should stay valid before a new one is assigned to the player Both parameters can be configured using a tim...

Page 21: ...rver proxy spinetix com server port 8080 port bypass proxy local true bypass proxy local username demo username password xxxx password proxy Added in 2 2 5 firmware release Controls whether the player shall accept only trusted HTTPS certificates The list of trusted certificates matches that of Firefox 13 If disabled the player will accept any valid HTTPS certificates This was the behavior up to fi...

Page 22: ... ag2eKh2EAfI6nVKC5YhT65HeQR5Ux7unY3nHV8wkgunmDJKY5EFFGOUH9ibJD8bq X6TyFdo 1hv6XWhAjv fG95M1Mq qASswJ1udu4wwECAwEAAaNQME4wHQYDVR0O BBYEFHt1ZqqM7ZEtTLj8TgUlVDcZlySmMB8GA1UdIwQYMBaAFHt1ZqqM7ZEtTLj8 TgUlVDcZlySmMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEFBQADggEBAJfF6qFO KcOCh3Ap0WUp8NCBDj01Tb4JkRy4ilEnqAi4fAFJ7HiCPFTsOtLogvgd7EENnuc2 l8HgBE2KxVayS3LQuWY3uCPb1GijxUDDKrIQTRzlwYx1YA2ivibvq0utkA80ZVRE JhLIseiJ i...

Page 23: ...owing parameter address range Range of the accepted address Can be of the following form Single address e g 192 168 1 100 Range using bit mask e g 192 168 1 0 24 Range using net mask e g 192 168 1 0 255 255 255 0 Note this parameter will override settings done using snmp local snmp limited or snmp all For instance to enable connections to the SNMP service from any device with an IP is in the range...

Page 24: ...device This is necessary if you want the device to access a password protected server The credential will be used by Pull Mode as well The HMP can connect to a protected server using basic or digest authorization method This command is composed of the following parameter server URI of the server for which the credential should be used password Password to be use to connect to this server username ...

Page 25: ...ters related to Shared Variables Network API Controls weather the API is enabled or disabled When enabled the player will listen on the network api port for incoming connections controlling the player remotely The possible values are yes and no Note Device must be rebooted for this parameter to be applied For instance to disable the Network API use network api enabled no network api enabled Contro...

Page 26: ...ded to render a frame In most applications it is recommended to leave this value to its maximum as this will ensure the best rendering of the content When using audio together with interactivity content set the latency to at least 500ms and make sure that reduce interactive latency is disabled The possible values are 1 5 1 0 5 and 0 25 For instance to set the rendering latency to the best renderin...

Page 27: ...zone use timezone Europe Zurich timezone Force the device to use manual time configuration and rely only on its internal clock This command is composed of the following optional parameter time New time to be used by the device The format is HH MM SS date New date to be used by the device The format is DD MM YYYY Note that if one of the parameter is present then the other one must also be present N...

Page 28: ... the other ones are optional monitor only 1 monitor only 5 Indicates whether the server is used for synchronization or if it is only watched for statistics Note this parameter will override settings done using time manual For instance to set up the default NTP configuration of the HMP use time ntp boot delay 0 boot delay server 1 0 pool ntp org server 1 server 2 1 pool ntp org server 2 server 3 2 ...

Page 29: ...rds can be changed by anyone having network access to the HMP Modified in 3 1 0 firmware release Removes or sets a new password for a user on the HMP Passwords can be set by sending them in clear text or by sending the digest This command must include the following parameter username Username to modify Must be one of the following admin content monitoring If no other parameter is present then the ...

Page 30: ...ss control for the monitoring user user username monitoring username user Setting up the access for the user content with password j379dbh8 The digest of the password is sent As there is only one possible realm the attribute may be omitted user username content username digest 35a89af39847f135ffbcd1042963d80e digest user Setting up the access for the user admin The digest of the password is sent A...

Page 31: ... be used if the first source is not available If left empty the local content is used Otherwise the HTTP location of the index svg must be provided For instance to set the secondary source to use a demo project on the SpinetiX web site use secondary source http demo spinetix com project default secondary source Allow USB storage to be used as local storage when plugged to the device If this option...

Page 32: ...ed pull project Enable or disable pulling a hypermedia project from an HTTP of WebDAV server Possible value are yes no If a value of yes is used then the project parameter must be present If not present a default value of no is used rpc concentrator Added in 3 0 0 firmware release Enable or disable the activation of an RPC concentrator Possible value are yes no If a value of yes is used then the r...

Page 33: ... the following inner parameters uri URI of the RPC concentrator pooling Frequency at which the player will send the ready notification to the server If not specified 60s is used notification only If set to yes the player will not accept RPC calls but will still send the ready notification at each polling interval If not specified no is used Note this parameter will override settings done using pul...

Page 34: ...0 log time log type alllogs log type logs pull mode static Configure Pull Mode settings using an ICS file embedded into the configuration file The following parameters must be used ics file The complete content of the ICS file copied inside a CDATA section Note this parameter will override settings done using pull mode disabled pull mode static pull mode file or pull mode remote For instance to pu...

Page 35: ... schedule uri URI of the ICS file used to control the Pull Mode check frequency Frequency at which the ICS file must be checked by the player The time can be expressed in seconds 30s minutes 10m or hours 3h Note this parameter will override settings done using pull mode disabled pull mode static pull mode file or pull mode remote For instance to configure Pull Mode to use an ICS file from the Spin...

Page 36: ... update can only be done using an RPC command it is not possible to trigger a firmware upgrade using a configuration backup file Configure the URI of the firmware repository If the URI is not provided then the default location will be used For instance to reset the firmware location to the default use firmware update uri firmware update uri To set the firmware location to the SpinetiX web site use...

Page 37: ...are present only the last one will be applied Disable the usage of FSM protocol file The device will no longer send commands on the serial or USB port Note this parameter will override settings done using protocol disabled protocol system or protocol file For instance to disable a protocol file previously set use protocol disabled Modified in 3 0 0 firmware release Enable the usage of one of the i...

Page 38: ...he protocols files can be uploaded to the device as part of the compressed backup file The protocol file selected by this command must either already be on the device or uploaded as part of the configuration backup otherwise the setting will not be applied Note this parameter will override settings done using protocol disabled protocol system or protocol file For instance to enable a sample protoc...

Page 39: ...is section describes all the commands that don t fit in the categories above Controls the maximum number of end points that can be connected to an HMP If the extended option is enabled the maximum number of end points is set to 16 otherwise it is reduced to 4 but a better compatibility with low speed devices is achieved The possible values are yes no Note Device must be rebooted for this parameter...

Page 40: ...ntrols the shutdown temperature of the HMP200 By default the HMP200 will shut down if its external temperature is too high to prevent injuries on user touching the device When setting the shutdown temperature to maximum it could result in the case temperature exceeding 50 C 120 F Touching the device case at this temperature might result in injury If the command is used without any value the defaul...

Page 41: ...odifications per firmware release Initial version of the HMP Configuration API to support the configuration backup feature Support for getting and setting the HMP configuration through RPC calls New configuration options vga dc offset fusion startup New configuration option https validate certificates New configuration options wizard splash certificate Other changes ...

Page 42: ...c has been extended to support RPC concentrators New configuration options hdmi link type certificates reset New configuration options audio power save protocol file reset Other changes The syntax of the user has been extended to support additional settings for monitoring and content users The syntax of the com port settings has been extended New allowed value for project time of the pull mode sta...

Search results

Summary of Contents for HMP series

Reviews:

Related manuals for HMP series

Brands by name

Popular brands

SpinetiX HMP series, Technical Documentation Manual

Search results

Summary of Contents for HMP series

Reviews:

Related manuals for HMP series

Brands by name

Popular brands