SpinetiX HMP Series Technical Documentation Manual
Configuration api
Hide thumbs
Also See for HMP Series:
- Quick install manual (9 pages) ,
- Manual (2 pages) ,
- Technical documentation manual (42 pages)
Subscribe to Our Youtube Channel
Related Manuals for SpinetiX HMP Series
Summary of Contents for SpinetiX HMP Series
- Page 1 HMP Configuration SpinetiX Technical Documentation Document version: 3.1 Related firmware: 4.2...
- Page 2 H MP Conf iguration API - SpinetiX Technical Documentation v3.1 www.spinetix.com Revision history Revision Revision Author Summary of changes number date Apr 22, 2011 Julien Reichel Original “HMP Configuration Backup” document. Jan 23, 2012 Julien Reichel Changes related to 2.2.4 firmware release.
- Page 3 SPINETIX OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. "SpinetiX" and “HMP Hyper Media Player” are registered trademarks, and all logo and graphic designs are trademarks of SpinetiX SA Other product and company names appearing in SpinetiX SA products and materials are used for identification purposes only and may be trademarks or registered trademarks of their respective companies.
-
Page 4: Table Of Contents
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Table of Contents Introduction............................8 XML configuration string ........................8 Structure ............................8 Order of execution..........................9 Encryption ............................ 11 Configuration commands ........................12 Encryption ............................ 13 <passphrase> ........................... 13 <regenerate-secret-key> ......................13 Display settings ..........................13 <display-video-mode>... - Page 5 H MP Conf iguration API - SpinetiX Technical Documentation v3.1 <https-validate-certificates> ..................... 26 <certificate> ..........................26 <certificates-reset> ........................27 <server-certificate> ........................27 <server-certificates-reset> ......................28 <active-certificate> ........................29 <http-server-security-access> ....................29 <ssdp-upnp-enabled> ....................... 29 <disable-secondary-network-port> ................... 30 SNMP settings ..........................31 <snmp-local>...
- Page 6 H MP Conf iguration API - SpinetiX Technical Documentation v3.1 <secure-monitoring> ........................ 42 <rpc-api-key> ........................... 43 Content ............................44 <scheduled-download-reset> ....................44 <scheduled-download-add> ..................... 44 <live-source-reset> ........................44 <live-source-add> ........................45 Pull Mode ............................. 46 <pull-mode-disabled> ....................... 46 <pull-mode-static> ........................46 <pull-mode-file>...
- Page 7 H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Firmware 4.1 ..........................58 Firmware 4.2 ..........................58 © SpinetiX SA All rights reserved. Page 7 of 58...
-
Page 8: Introduction
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Introduction The HMP Configuration API defines the XML format and all the configuration commands that can be used to modify different settings on the HMP devices. The HMP Configuration API is available since 2.2.1 firmware release, when the configuration backup &... -
Page 9: Order Of Execution
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Notes 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 limited number of settings (in this case, the settings not found in the configuration string will keep their current value). - Page 10 H MP Conf iguration API - SpinetiX Technical Documentation v3.1 For instance, the command sets the player to DHCP, whereas the <ethernet-dhcp/> <ethernet- command sets it to use a fixed IP address. If both commands are present in the XML static>...
-
Page 11: Encryption
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 <?xml version="1.0"?> <configuration version="2.1"> <credential> <server>http://demo.spinetix.com/</server> <password>spinetix</password> <username>spinetix</username> <realm>demo</realm> </credential> <credential-reset/> </configuration> Encryption Starting with version 2.1 of the backup (firmware 4.2) the passwords and other secret information retrieved in the backup are encrypted using either a configured passphrase or a secret key only valid on the player where the backup has been generated. -
Page 12: Configuration Commands
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Configuration commands This section describes the structure and the parameters of the configuration commands that can be sent to an HMP for execution. A configuration command is represented within the XML configuration string through an XML element, direct descendant of the element. -
Page 13: Encryption
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Encryption This section describes all the parameters related to the encryption of the secret information present in the backup file. <passphrase> Added in 4.2 firmware release. Set the passphrase to be used to encode the passwords and other secrets present in the backup. This command can be used to set or to clear the passphrase. -
Page 14: Display-Custom-Video-Mode
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Force the player to use only modes supported by its internal standards database. Those mode are the most common modes supported by most displays. Possible values are yes or no. If no is selected, then the player is allowed to use modes not in the internal database, but reported to any screen attached to the player through the DDC signal. -
Page 15: Screen-Aspect-Ratio
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 , use one of the following: type o "cvt-R" for CVT with "reduced blanking", normally OK with LCD or plasma. o "cvt" for the CVT compatible with CRT tech we need a longer blanking. -
Page 16: Display-Orientation
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Select the aspect ratio of the screen. The HMP can update the rendered content to match the aspect ratio of the screen, regardless of the signal actually sent to the display. For instance, if you use a 640x480 signal, you can force the aspect ratio to 16:9 so that your content is displayed correctly in your screen. -
Page 17: Underscan-Supported
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 <off-time> Time at which the screen must be turned off. The format expected is HH:MM, where HH is the time express in 24 hour format. If omitted the value of 24:00 will be used. A value of 24:00 is equivalent to the value 00:00. -
Page 18: Overscan-Percentage
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 The possible values are: yes, no. Note: Device must be rebooted for this parameter to be applied. For instance, to disable the DC offset on the VGA output, use: <vga-dc-offset>no</vga-dc-offset>... -
Page 19: Audio-Power-Save
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 <enable-audio>no</enable-audio> <audio-power-save> Added in 3.1.0 firmware release. Controls whether the player shall output audio or not when the screen is in power save. If set to yes, no audio will be decoded when the screen is power off using RS232 or the power save feature of the device. - Page 20 H MP Conf iguration API - SpinetiX Technical Documentation v3.1 <splash> <name>boot</name> <file>splash.jpg</file> </splash> © SpinetiX SA All rights reserved. Page 20 of 58...
-
Page 21: Network Settings
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Network settings This section describes all the parameters related to network configuration of the device. <ethernet-dhcp> Configure the player to use a DHCP assigned address for its IP configuration. If no DHCP servers are available on the network, the device will use a zeroconf IP address chosen randomly. -
Page 22: Modem-3G-Simple
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 <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> <domain></domain> </ethernet-static> <modem-3g-simple> HMP350 only Configure the player to use 3G modem as network connection using simplified settings. This should work for most modems and providers. -
Page 23: Modem-3G-Advanced
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 <modem-3g-advanced> HMP350 only Configure the player to use 3G modem as network connection using advanced settings. This command is composed of the following parameters: <pin> Pin of the SIM card. The PIN number, if required, is passed to the modem when it is plugged or the HMP reboots. -
Page 24: Device-Name
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 <modem-3g-advanced> <pin>1234</pin> <init-string-1>AT Z</init-string-1> <init-string-2>AT Q0 V1 E1 &C1 &D2 +CMEE=2</init-string-2> <init-string-3>AT +CR=1</init-string-3> <init-string-4>AT +CGDCONT=1,"IP",""</init-string-4> <init-string-5></init-string-5> <init-string-6></init-string-6> <dial-number>*99**1*1#</dial-number> <username></username> <password></password> <auth-protocol>pap</auth-protocol> </modem-3g-advanced> <device-name> Name of the device to be used in network discovery protocols (Bonjour). This is the name shown in Elementi when discovering the devices. -
Page 25: Proxy
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Both parameters can be configured using a time in second (10s), minute (10m) or hour (1h). For instance, to disable the network watchdog, use: <network-watchdog> <max-time-no-addr>0s</max-time-no-addr> <min-time-keep-addr>0s</min-time-keep-addr> </network-watchdog> To enable the network watchdog, use: <network-watchdog>... -
Page 26: Https-Validate-Certificates
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 <proxy> <server>proxy.spinetix.com</server> <port>8080</port> <bypass-proxy-local>true</bypass-proxy-local> <username>demo</username> <password>xxxx</password> </proxy> <https-validate-certificates> 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 firmware 2.2.4. -
Page 27: Certificates-Reset
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 <certificate><![CDATA[-----BEGIN CERTIFICATE----- MIIDBzCCAe+gAwIBAgIJAN7CITVNRuunMA0GCSqGSIb3DQEBBQUAMBoxGDAWBgNV BAMMD3d3dy5leGFtcGxlLmNvbTAeFw0xMzAyMTkxODU0MzdaFw0yMzAyMTcxODU0 MzdaMBoxGDAWBgNVBAMMD3d3dy5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEB BQADggEPADCCAQoCggEBALxzvTcN7B6n7xXYxsKGXi67OBkc1Q/qWss8zXLPQgoP GpWgJqQ54vVPQ8avQK5E+iC61fiWO7lHumqshWX8sF3pIAlTLwYehR40zxH+m0vn dJ5nn2WcIs/yOBmpK9v/X6MIy5tp3Ki+oMooqmSn8T2YZ9xJl8TPfBZ3ayYgxRPE KvIyV82fD/OqhAvS1APmrRGyk6EuEnwvCwIRWI7j3zsB1vs1yFm+MFvc8Pb7OaNY ag2eKh2EAfI6nVKC5YhT65HeQR5Ux7unY3nHV8wkgunmDJKY5EFFGOUH9ibJD8bq X6TyFdo/1hv6XWhAjv+/fG95M1Mq/qASswJ1udu4wwECAwEAAaNQME4wHQYDVR0O BBYEFHt1ZqqM7ZEtTLj8TgUlVDcZlySmMB8GA1UdIwQYMBaAFHt1ZqqM7ZEtTLj8 TgUlVDcZlySmMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEFBQADggEBAJfF6qFO KcOCh3Ap0WUp8NCBDj01Tb4JkRy4ilEnqAi4fAFJ7HiCPFTsOtLogvgd7EENnuc2 l8HgBE2KxVayS3LQuWY3uCPb1GijxUDDKrIQTRzlwYx1YA2ivibvq0utkA80ZVRE JhLIseiJ+iXHwSLHVeDuV9e90rLSkeqRs2+gRctDO7/KAdDtV2gYZN63O+3XY3Q3 6GVrjUTLLCGbVtAWhIUknsEyoZN/fIQ8xQ6CBa9FUnX3fBmNz2FExTvkpQkYJ/qw sp1Dt16AqEOAiQSlpqJLgihkbc997XbaxP9SrYbr8M8Y6zCtnkT7XdN4WvSabpJm z8eyJ7ovx9+p85s= -----END CERTIFICATE----- ]]></certificate> <certificates-reset> Added in 3.0.3 firmware release. Remove all SSL/TLS certificates that are present on the device. This will also remove certificates that might have been set previously in the save configurations file. -
Page 28: Server-Certificates-Reset
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 The encrypted private key automatically generated by Control Center. Note that for user generated backup the clear text version described below should be used. <privatekey> <privatekey> The PEM encoded certificate private key. Encrypted key are not supported in the backup. This parameter is never generated automatically by Control Center. -
Page 29: Active-Certificate
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 given set of certificates is available and only this set, you must precede the first <server- command by certificate> <server-certificates-reset/> For instance, to remove all server certificates from the device, use: <server-certificates-reset/>... -
Page 30: Disable-Secondary-Network-Port
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 The possible values are: yes, no. Note: Device must be rebooted for this parameter to be applied. For instance, to enable SSDP / UPnP discovery, use: <ssdp-upnp-enabled>yes</ssdp-upnp-enabled> <disable-secondary-network-port> HMP350 only Added in 4.2 firmware release... -
Page 31: Snmp Settings
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 SNMP settings This section describes all the parameters related to the configuration of SNMP. <snmp-local> HMP300 and HMP350 only Disable SNMP connection from the outside. PHP scripts running on the device are still allowed to connect to the SNMP service, but no external connections are accepted. -
Page 32: Snmp-Rocommunity
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Note: This setup should be used with care, as it is easy to create a DoS on the player by executing a large number of SNMP queries to the device. - Page 33 For instance, to add credential to connect to the demo site of the spinetix.com server, use: <credential> <server>http://demo.spinetix.com/</server> <password>spinetix</password> <username>spinetix</username> <realm>demo</realm> </credential> To add credential to connect to the demo site of the spinetix.com server, making sure that all previously set credential are removed, use: <credential-reset/> <credential> <server>http://demo.spinetix.com/</server> <password>spinetix</password> <username>spinetix</username>...
-
Page 34: Network Api
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Network API This section describes all the parameters related to Shared Variables Network API. <network-api-enabled> HMP350 only Controls weather the API is enabled or disabled. When enabled, the player will listen on the <network- api-port>... -
Page 35: Interactivity Settings
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Interactivity settings This section describes all the parameters related to the interactivity settings on the device. <accepts-events> HMP300 and HMP350 only Controls whether the player accepts interactive events from the USB connector or not. This must be enabled when the player shall receive input from a touch screen for instance. -
Page 36: Touchscreen
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Note that when the first event is received, the device will take approximately 1.5 seconds to respond. If no events are received for 90 seconds, the device will switch back to the maximum latency. -
Page 37: Date / Time Settings
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Date / time settings This section describes how to configure the date and time settings of the player. <timezone> Controls the time zone used by the device. For instance, to set the time zone to the Zurich time zone, use: <timezone>Europe/Zurich</timezone>... -
Page 38: Time-Ntp
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 <time-ntp-restore/> <time-ntp> HMP300 and HMP350 only Configure the device to use NTP configuration. When using this command, at least one NTP server must be configured. This command is composed of the following parameters. - Page 39 H MP Conf iguration API - SpinetiX Technical Documentation v3.1 <time-ntp> <boot-delay>120</boot-delay> <server-1>192.168.1.11</server-1> <monitor-only-1>no</monitor-only-1> </time-ntp> Note that the boot delay is increased to 120s in order to ensure that in case of loss of power the master is started before the slave.
-
Page 40: Security Settings
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Security settings This section describes how to configure the user access to the device. Each user has the following parameters An username A password Zero, one or more user rights <user>... -
Page 41: User-Reset
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 <user> <username>admin</username> <password>xxxx</password> </user> Removing the ‘monitoring’ user. <user> <username>monitoring</username> </user> Creating a new user “john” with access rights limited to the content and encoded password "j379dbh8". <user> <username>john</username> <password>j379dbh8</password>... -
Page 42: Secure-Content
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Enforce low level (HTTP) password protection for remote admin action (RPC). If disabled any user can use RPC to administrate the player. To insure RPC are password protected: <secure-admin>yes</secure-admin> To let any user execute RPC command (not recommended) <secure-admin>no</secure-admin>... -
Page 43: Rpc-Api-Key
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 <secure-monitoring>no</secure-monitoring> <rpc-api-key> HMP100, HMP130, HMP200, HMP350 only Added in 3.4 and 4.2 firmware release The RPC API key protects the HMP against CSRF (Cross-site request forgery) when using CORS (Cross- origin resource sharing). -
Page 44: Content
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Content This section describes how to configure options related to the content displayed by the player.. <scheduled-download-reset> HMP300 and HMP350 only Added in 4.0.0 firmware release Remove all scheduled download set for the player. -
Page 45: Live-Source-Add
Name of the live source as used in the interface <uri> URI of the live source. This must be a folder containing the index.svg used by the player. For example to add a new live source on SpinetiX demo folder: <live-source-add> <name>Cinema</name> <uri>http://demo.spinetix.com/servermode/SpinetiX_Cinema/</uri> </live-source-add>... -
Page 46: Pull Mode
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Pull Mode This section describes how to configure the Pull Mode settings of the device. <pull-mode-disabled> HMP300 and HMP350 only Disable Pull Mode. This is the default setting. Note: this parameter will override settings done using <pull-mode-file>... -
Page 47: Pull-Mode-File
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Parameters for the logs to be pushed by the device. It must include the following inner parameters: <log-source> Destination URI where the log must be uploaded. The server must be a WebDAV enabled server. -
Page 48: Pull-Mode-Remote
(30s), minutes (10m) or hours (3h). Note: this parameter will override settings done using <pull-mode-disabled<pull-mode-file> <pull-mode-remote> For instance, to configure Pull Mode to use an ICS file from the SpinetiX web site, which should be checked for modifications every 6 hours, use: <pull-mode-remote> <schedule-uri>http://demo.spinetix.com/pull.ics</schedule-uri>... -
Page 49: Pullmode-Logs-Level
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: <firmware-update- uri>http://download.spinetix.com/hmp200/updates/</firmware-update-uri> <firmware-update-auto>... - Page 50 H MP Conf iguration API - SpinetiX Technical Documentation v3.1 <firmware-update-auto>no</firmware-update-auto> To set the automatic update of the firmware daily at 19:00, use: <firmware-update-auto>19</firmware-update-auto> © SpinetiX SA All rights reserved. Page 50 of 58...
-
Page 51: I/O Automation
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 I/O Automation This section describes how to configure the FSM protocol files and serial port settings. There are three different ways to specify which FSM protocol file is used by the device: <protocol-... -
Page 52: Protocol-File
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Remove all FSM files that are present on the device. If you want to ensure that a given set of FSM files are available and only this set, you must proceed in two steps. - Page 53 H MP Conf iguration API - SpinetiX Technical Documentation v3.1 <stop-bits> Configure the value of the stop bits, as 0 or 1. For instance, to set the default parameters, use: <com-port-settings/> To set custom parameters, use: <com-port-settings> <baud-rate>9600</baud-rate> <byte-size>8</byte-size>...
-
Page 54: Others
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Others This section describes all the commands that don’t fit in the categories above. <screen-id> HMP350 only Controls the screen id needed in case of multi-screen content. If the command is left empty, then the default ID (i.e. -
Page 55: Cockpit
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 <shutdown-temperature></shutdown-temperature> To set the shutdown temperature to its maximum value, use: <shutdown-temperature>70</shutdown-temperature> <cockpit> Added in 3.2.0 firmware release. Enable Cockpit monitoring on the device. Note that cockpit itself will reconfigure this parameter once the player is being monitored. -
Page 56: Firmware Release Notes
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Firmware release notes The functionality of the HMP configuration API is improved with each firmware release. This section lists the modifications per firmware release. Firmware 2.2 2.2.1 Initial version of the HMP Configuration API to support the configuration backup feature. -
Page 57: Firmware 3.1
H MP Conf iguration API - SpinetiX Technical Documentation v3.1 <certificates-reset> Firmware 3.1 3.1.0 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. - Page 58 H MP Conf iguration API - SpinetiX Technical Documentation v3.1 Modified configuration options: <user>, <pull-mode-static> New configuration options: <time-ntp-restore> < touchscreen> <user-reset>, <secure-admin>, <secure-content>, <secure-monitoring> <scheduled-download-reset>, <scheduled-download-add> <live-source-reset>, <live-sources-add> Firmware 4.1 4.1.0 New configuration options: ...
Need help?
Do you have a question about the HMP Series and is the answer not in the manual?
Questions and answers