SpinetiX Diva, Technical Documentation Manual

Page 1: ...HMP Configuration API SpinetiX Technical Documentation Document version 3 1 Related firmware 4 2 ...

Page 2: ...re 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 2 1 A...

Page 3: ...LIERS ARE PROVIDED AS IS WITH ALL FAULTS SPINETIX DISCLAIMS 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 LIMI...

Page 4: ...enerate secret key 13 Display settings 13 display video mode 13 display custom video mode 14 screen aspect ratio 15 display orientation 16 display power save 16 display power schedule 16 underscan supported 17 vga power mode 17 vga dc offset 17 overscan percentage 18 hdmi link type 18 enable audio 18 audio power save 19 splash 19 Network settings 21 ethernet dhcp 21 ethernet static 21 modem 3g sim...

Page 5: ...led 29 disable secondary network port 30 SNMP settings 31 snmp local 31 snmp limited 31 snmp all 31 snmp rocommunity 32 Credentials 32 credential reset 32 credential 32 Network API 34 network api enabled 34 network api port 34 Interactivity settings 35 accepts events 35 maximum latency 35 reduce interactive latency 35 touchscreen 36 Date time settings 37 timezone 37 time manual 37 time ntp restore...

Page 6: ... 46 pull mode static 46 pull mode file 47 pull mode remote 48 pullmode logs level 49 Firmware Update 49 firmware update uri 49 firmware update auto 49 I O Automation 51 protocol disabled 51 protocol system 51 protocol file reset 51 protocol file 52 com port settings 52 Others 54 screen id 54 reboot 54 shutdown temperature 54 cockpit 55 cockpit disabled 55 Firmware release notes 56 Firmware 2 2 56 ...

Page 7: ...HMP Configuration API SpinetiX Technical Documentation v3 1 SpinetiX SA All rights reserved Page 7 of 58 Firmware 4 1 58 Firmware 4 2 58 ...

Page 8: ...on backup within the config xml Via RPC within the xmlconfig string provided to the set_config command XML configuration string Structure The HMP Configuration API uses an XML based format where one or more configuration commands are encapsulated within a configuration element The XML configuration string must have the following structure xml version 1 0 configuration version 2 1 command 1 command...

Page 9: ...figuration commands Compatibility Some configuration may be compatible both with version 1 2 and 2 0 has they only use command present in both version and based on the same syntax In this case it is possible to indicate to a device based on version 2 0 that it should also accept the configuration This can be done using the compatible attribute xml version 1 0 configuration version 1 2 compatible 2...

Page 10: ...ernet static address 192 168 1 10 address netmask 255 255 255 0 netmask ethernet static ethernet dhcp configuration After applying the following XML configuration string the HMP will use a fixed IP address xml version 1 0 configuration version 2 1 ethernet dhcp ethernet static address 192 168 1 10 address netmask 255 255 255 0 netmask ethernet static configuration Example 2 The credential reset co...

Page 11: ...l the player The passphrase needs to be configured only once This can be done using Control Center or using a backup file In this later case the passphrase command can be used When the player is generating a backup file the passphrase command in never stored in the backup by the player it must be manually added by the user If no passphrase is configured on the player the secret information will be...

Page 12: ...ter it is usually provided within the text content of the element If it requires more parameters these are usually provided as inner XML elements For instance to configure the HMP to use DHCP a simple XML element is used ethernet dhcp To change the time zone setting the time zone name is specified within the text content of the element timezone Europe Zurich timezone To set the HMP device to use a...

Page 13: ...et key Added in 4 2 firmware release Force the player to re generate a new secret key and clear all previously set passphrase Warning When using this command all previously generated backup will no longer be compatible with this player For instance to generate a new secret key and clear the passphrase use regenerate secret key Display settings This section describes all the parameters related to t...

Page 14: ...e Note Device must be rebooted for this parameter 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 display custom video mode HMP350 only Control the video mode used by the display The custom video mode...

Page 15: ...l integer In VESA standard this is known as the horizontal back porch RM Right margin number of pixel clocks between the last active pixel and the end 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 b...

Page 16: ...ntation to horizontal use display orientation horizontal display orientation display power save Allows the HMP to send power save information using the VGA or DVI signal 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 ...

Page 17: ... when connected to the screen using HDMI The possible values are yes 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 vga power mode 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...

Page 18: ...instance to set the overscan percentage to 3 use overscan percentage 3 overscan percentage hdmi link type 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 connect...

Page 19: ...g restarting or updating the firmware This commands can be used to set new images 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 pres...

Page 20: ...HMP Configuration API SpinetiX Technical Documentation v3 1 SpinetiX SA All rights reserved Page 20 of 58 splash name boot name file splash jpg file splash ...

Page 21: ...c Configure the player to use a fixed IP address This 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...

Page 22: ...hen it is plugged or the HMP reboots Note that an incorrect PIN will 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 ...

Page 23: ... used to initialize the modem and enter the data communication parameters dial number 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 To use a specific APN instead of the subscriber s default enter AT CGDCONT cid IP apn as an init string where cid is the context ID usually 1 and apn is the...

Page 24: ...e to its defaultvalue 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 network watchdog HMP300 and HMP350 only Controls the network watchdog parameters If set to a value other than 0 the network watchdog is activated When activated...

Page 25: ...ddr 2m max time no addr min time keep addr 90s min time keep addr network watchdog proxy Configure proxy settings needed to access the internet 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 tru...

Page 26: ...r up to firmware 2 2 4 This settings is disabled by default on all players The possible values are yes no Note Device must be rebooted for this parameter to be applied For instance to enable the verification of HTTPS certificates use https validate certificates yes https validate certificates certificate Added in 3 0 0 firmware release Add SSL TLS certificate to the device This is necessary if you...

Page 27: ...uV9e90rLSkeqRs2 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 previo...

Page 28: ...4 and 32 characters and contains only number letter and any of the following _ Note that the self signed certificate is automatically added to the backup configuration created by the player However the private key is not included in the backup and it will be ignored when applied to another player Note that that only RSA 1024 2048 3072 and 4096 bits certificates are supported For instance to add a ...

Page 29: ...er the player web server shall accept unsecure HTTP connection By default all players accept insecure HTTP connection to the web interface The possible values are allow insecure Both secure and insecure HTTP connection are possible redirect insecure All insecure HTTP connection are automatically redirected to the secure HTTP disable insecure Insecure HTTP connections are disabled The player will n...

Page 30: ...0 only Added in 4 2 firmware release Controls whether the secondary network port is disabled or not The secondary network port is enabled by default on all players The possible values are yes no Note Device must be rebooted for this parameter to be applied For instance to disable the secondary network port on the device use disable secondary network port yes disable secondary network port For inst...

Page 31: ...use snmp local snmp limited HMP300 and HMP350 only Enable connections to the SNMP service from remote hosts as long as they are within the given address range This command is composed of the following 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 25...

Page 32: ...information available to the device credential reset Remove all previous credentials on the device including any credential instruction before it For instance to remove all credential from the device use credential reset credential Add credential to the 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...

Page 33: ...ere set the encrypted password can only be restored on the HMP used to generate the backup 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...

Page 34: ...twork 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 network api port HMP350 only Controls the port used by the network API to listen to incoming connections The default value is 1234 The values sh...

Page 35: ... the player The player always renders some images in advance to improve the playback smoothness By using this buffering strategy it can ensure that the quality of the rendering will only depend on the average time needed 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 in...

Page 36: ...ontent played by the HMP contains audio 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 touchscreen HMP300 and HMP350 only Calibration parameters of the connected touchscreen Contains 6 parameter xx xy yx yy tx ty Parameters of the ...

Page 37: ...ew 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 Note this parameter will override settings done using time ntp For instance to set the time to manual using the time currently set use time manual To set the time to manual and set a new time use...

Page 38: ... device Note that only server 1 is compulsory 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...

Page 39: ...ll rights reserved Page 39 of 58 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: ...t monitoring If no other parameter is present then the command removes the protection for the specified user password optional Specify a password in clear text for the specified user If not set the password is not modified unless crypt was used crypt optional Specify an encrypted password for the specified user CRYPT_MD5 or CRYPT_BLOWFISH can be used to encode the password Password encoded by the ...

Page 41: ...rd j379dbh8 user username john username password j379dbh8 password content yes content monitoring no monitoring admin no admin user Changing the access rights for the user paul Note that the user must already exist otherwise an error is returned user username paul username content yes content monitoring yes monitoring user user reset Added in 4 0 0 firmware release Remove all configured users exce...

Page 42: ... only Added in 4 0 0 firmware release Enforce low level HTTP password protection for content publishing If disabled any user can publish content to the player To insure content publisg is password protected secure content yes secure content To let any user publish to the player secure content no secure content secure monitoring HMP300 and HMP350 only Added in 4 0 0 firmware release Enforce low lev...

Page 43: ...ng parameter spx api key must be present in the request and the content of the query must be set to the value of the rpc api key i e rpc spx api key rpc api key It is possible to clear the rpc api key in this case CORS RPC request are not possible This is the default setting of the HMP To clear the RPC API key use the following rpc api key To set an RPC API key it is recommending to use an UUID Un...

Page 44: ...the source to download This URI can either be a folder for WebDAV enabled server or an XML file describing the content of the project for regular HTTP servers update Update rule for the download Can be one of the following manual hourly daily time Time of the update HH MM in case daily update is performed dest optional Destination folder of the downloaded files By default the files are downloaded ...

Page 45: ...es live source reset live source add HMP300 and HMP350 only Added in 4 0 0 firmware release name 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 sour...

Page 46: ...m the device Possible value are yes no If a value of yes is used then the logs parameters 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 rpc parameter must be present If not present a default value of no is used project ...

Page 47: ...PC concentrator to be used by the device It must include 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 E...

Page 48: ... mode file pull mode remote HMP300 and HMP350 only Configure Pull Mode settings using an ICS file located on a remote server The ICS file will be checked and downloaded from the server at regular interval as specified in the command The following parameters must be used 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...

Page 49: ...possible to trigger a firmware upgrade using a configuration backup file firmware update uri HMP300 and HMP350 only 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 upd...

Page 50: ...iX Technical Documentation v3 1 SpinetiX SA All rights reserved Page 50 of 58 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 ...

Page 51: ...ameter will override settings done using protocol disabled protocol system or protocol file For instance to disable a protocol file previously set use protocol disabled protocol system HMP300 and HMP350 only Modified in 3 0 0 firmware release Enable the usage of one of the internal protocol files available in the device Currently the following protocols are available inside the device LG LF65 fsm ...

Page 52: ...vice 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 protocol file which can be created using the tool available at http www spinetix com support fsm use protocol file sample fsm protocol file com port settings HMP300 and...

Page 53: ...ed Page 53 of 58 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 parity none parity stop bits 1 stop bits com port settings ...

Page 54: ...he reboot command within is necessary for the parameters to be applied This instruction can appear anywhere in the XML configuration string It will only be executed once all other commends have been executed and verified In case of errors the device will not reboot For instance to force the device to reboot at the end of the installation use reboot shutdown temperature Controls the shutdown temper...

Page 55: ...parameters must be used uri URI of the Cockpit concentrator The following parameters may be used options Additional concentrator options following the pull mode syntax time Time offset in seconds This must be a random value between 0 and the polling time typically 300 to insure that not all players will contact Cockpit at the same time For instance to enable Cockpit on the HMP cockpit uri https co...

Page 56: ...2 3 Support for getting and setting the HMP configuration through RPC calls 2 2 4 New configuration options vga dc offset fusion startup 2 2 5 New configuration option https validate certificates Firmware 3 0 3 0 0 New configuration options wizard splash certificate Other changes The syntax of the protocol system and protocol file commands has been modified Because of this the version attribute of...

Page 57: ...ttings for monitoring and content users The syntax of the com port settings has been extended 3 1 1 New allowed value for project time of the pull mode static option Firmware 3 2 3 2 0 New configuration options cockpit cockpit disabled Firmware 3 4 3 4 0 New configuration options rpc api key Firmware 4 0 4 0 0 Backup API version updated to 2 0 Removed configuration options primary source secondary...

Page 58: ...mware 4 1 4 1 0 New configuration options ssdp upnp enabled pullmode logs level Firmware 4 2 4 2 0 Backup API version updated to 2 1 Secret information such as passwords are now encrypted in the backup A passphrase must be set to use the same backup on multiple players New configuration options passphrase regenerate secret key disable secondary network port server certificate server certificates r...