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 (58 pages)
Table of Contents
Advertisement
Advertisement
Table of Contents
Related Manuals for SpinetiX HMP Series
Summary of Contents for SpinetiX HMP Series
- Page 1 www.spinetix.com...
- Page 2 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. Sep 07, 2012 Julien Reichel Changes related to 2.2.5 firmware release. Apr 19, 2013 Julien Reichel Changes related to 3.0.0 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 A.G. Other product and company names appearing in SpinetiX A.G. 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
Introduction............................7 XML configuration string ........................7 Structure ............................7 Order of execution..........................8 Configuration commands ........................10 Display settings ..........................10 <display-video-mode> ......................10 <display-custom-video-mode>....................11 <screen-aspect-ratio> ....................... 12 <display-orientation> ....................... 13 <display-power-save> ....................... 13 <display-power-schedule> ......................13 <underscan-supported> ......................14 <vga-power-mode> ........................14 <vga-dc-offset>... - Page 5 <snmp-local> ..........................23 <snmp-limited> ........................23 <snmp-all>..........................23 <snmp-rocommunity> ......................24 Credentials ........................... 24 <credential-reset> ........................24 <credential> ..........................24 Network API ..........................25 <network-api-enabled> ......................25 <network-api-port> ........................25 Interactivity settings ........................26 <accepts-events> ........................26 <maximum-latency> ......................... 26 <reduce-interactive-latency>...
- Page 6 I/O Automation ..........................37 <protocol-disabled>........................37 <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 ..........................
-
Page 7: Structure
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 & restore feature was introduced in HMP Control Center, and extended in 2.2.3 release to be used through RPC calls. - Page 8 A configuration command is an XML element in the XML configuration string. It may be single XML element, an XML element containing some text content parameters, or a more complex XML structure to modify more than one parameter with a single command. The next chapter describes in detail all the available configuration commands.
- Page 9 HMP device, whereas the configuration command adds a new one. <credential> <?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.
- Page 10 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. <configuration>...
-
Page 11: Display-Video-Mode
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 12 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. o "cvt-Rom" is like "cvt-R" but with margins and more around the active part of the image, to try if "cvt-R"...
-
Page 13: Screen-Aspect-Ratio
640x480 signal, you can force the aspect ratio to 16:9 so that your content is displayed correctly in your screen. An empty value will use the default aspect ratio matching the screen resolution. The possible values are: 4:3, 16:9, 16:10. Note: Device must be rebooted for this parameter to be applied. -
Page 14: Display-Power-Schedule
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. For instance, to clear a fixed scheduling previously set, use: <display-power-schedule/>... -
Page 15: Vga-Dc-Offset
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> Controls the percentage of overscan done by the screen attached to the player. The player will automatically add some black border around the content to compensate the overscan done by the screen. -
Page 16: 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 17 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 DNS used by the player. This parameter is optional.
-
Page 18: Ethernet-Static
<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> Configure the player to use 3G modem as network connection using simplified settings. This should work for most modems and providers. This command is composed of 5 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 19: Modem-3G-Advanced
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 20: Device-Name
hyphen. Using an empty device name will reset the name to its default value, which is the serial number of the HMP device. For instance, to reset the device name to the default value, use: <device-name></device-name> To setting the device name to a given value, use: <device-name>office-screen</device-name>... -
Page 21: Proxy
This command is composed of the following parameters: <server> Name of the server. Example proxy.spinetix.com. <port> Optional port of the proxy server. <bypass-proxy-local> Indicate if the proxy should also be used for local addresses or not. Possible values are true and false. -
Page 22: Certificate
Added in 3.0.0 firmware release. Add SSL/TLS certificate to the device. This is necessary if you want the device to be able to access an HTTPS server, having a certificate that is not in the list of trusted certificates of Firefox 18, in order to retrieve content (directly or through Pull Mode). -
Page 23: Snmp-Local
This section describes all the parameters related to the configuration of SNMP. 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. This is the default setting. Note: this parameter will override settings done using <snmp-local>, <snmp-limited>... -
Page 24: Snmp-All
Username to be used to connect to this server <realm> Optional realm for this username and password combination. This can be used to differentiate different area on the same server. For instance, to add credential to connect to the demo site of the spinetix.com server, use:... -
Page 25: Credential
<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> </credential> This section describes all the parameters related to Shared Variables Network API. -
Page 26: Accepts-Events
This section describes all the parameters related to the interactivity settings on the device. 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. This setting is disabled by default on all players. -
Page 27: Reduce-Interactive-Latency
The possible values are: yes, no. Note: Device must be rebooted for this parameter to be applied. For instance, to enable the “reduce interactive latency” option, use: <reduce-interactive-latency>yes</reduce-interactive-latency> This section describes how to configure the date and time settings of the player. Controls the time zone used by the device. -
Page 28: Time-Ntp
<time-manual> <time>15:43:00</time> <date>21-02-2015</date> </time-manual> 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. <boot-delay> Additional delay in starting up the device, ensuring that the NTP servers are running before the device boots. - Page 29 <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. This section describes how to configure the user access to the device. There are 3 different levels of user access available: ...
-
Page 30: User
The digest of a password for a realm is obtained by taking the MD5 hash of the concatenation of the user string, a colon, the realm, a colon and the password. As an example to obtain the digest of password "j379dbh8" for user "admin" and realm "Administrative Area"... -
Page 31: Primary-Source
This source will only 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>... -
Page 32: Pull Mode
This section describes how to configure the Pull Mode settings of the device. Disable Pull Mode. This is the default setting. Note: this parameter will override settings done using <pull-mode-static>, <pull-mode-file> <pull-mode-remote> For instance, to disable Pull Mode settings previously configured, use: <pull-mode-disabled/>... -
Page 33: Pull-Mode-Static
Configure the player to pull a project from a WebDAV enabled server, without uploading logs. <pull-mode-static> <push-logs>no</push-logs> <pull-project>yes</pull-project> <project> <project- source>http://demo.spinetix.com/pullmode/SpinetiX_Hotel.xml</project- source> <project-time>12:30</project-time> </project> </pull-mode-static> Configure the player to pull a hypermedia project from an HTTP server using an xml file to describe the... - Page 34 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> <pull-mode-remote> For instance, to pull a project daily, between 8 AM and 9 AM, from SpinetiX WebDAV server, use:...
-
Page 35: Pull-Mode-File
Note: this parameter will override settings done using <pull-mode-disabled>, <pull-mode- static>, <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 36: Enable-Fusion
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> Controls whether the device should automatically check and upgrade its firmware on a daily basis or not. -
Page 37: Firmware-Update-Auto
For instance, to disable the automatic update of the firmware, use: <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> 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 38: Protocol-System
<protocol-disabled>, <protocol-system> <protocol-file> For instance, to enable a "sample" protocol file (which can be created using the tool available at http://www.spinetix.com/support/fsm), use: <protocol-file>sample.fsm</protocol-file> Controls the settings of the serial port, or reset them to their default values. This command can be used without any parameters to reset all the settings to their default value, or with the following list of parameters: ... -
Page 39: Com-Port-Settings
Configure the baud rate of the serial port, as: 110, 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200, 128000, or 256000. <byte-size> Configure the byte size of the serial port, as 7 or 8. <parity> Configure the parity, as: none, even, or odd. -
Page 40: Screen-Id
<screen-id></screen-id> To set the screen id to “screen-1-1”, use: <screen-id>screen-1-1</screen-id> Instruct the device to reboot once all the settings have been applied successfully. If this is not set, then the device will put itself automatically in "Installation mode". A manual reboot or the application of another configuration, having the command within, is necessary for the parameters to be <reboot/>... -
Page 41: Wizard
For instance, to disable the wizard use: <wizard>no</wizard> The functionality of the HMP configuration API is improved with each firmware release. This section lists the modifications 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. - Page 42 The syntax of the <protocol-system> and <protocol-file> commands has been modified. <configuration> Because of this, the version attribute of the element also changed from "1.0" to "1.1". The syntax of the <pull-mode-static> has been extended to support RPC concentrators. 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