Configuration backup

From SpinetiX Support Wiki

Jump to: navigation, search

This page is about the configuration backup feature present in Control Center. For advanced users, there's an HMP Configuration API page.
For other backup features, see Fusion backup and Archive pages.

Introduction

The configuration backup feature allows the user to generate an archive file (7z) containing the complete configuration of that player. It can be easily generated from Control Center and contains:

  • A config.xml fille describing the current settings of the player.
  • Any custom splash screen images (jpg or png) previously uploaded onto the device.
  • Custom fsm protocol files previously uploaded onto the device.

It is possible to modify a configuration backup file to create a custom configuration - you can also add splash screen images, fsm protocol files and even default content for Fusion interface.

The configuration backup file can be used to:

The configuration backup feature is present in Control Center since 2.2.1 firmware release.

Generate a configuration backup

HMP350, HMP300, DiVA

System > Configuration Backup

To generate a configuration backup from the player, follow these steps:

  1. Open Control Center and go to System > Configuration Backup.
  2. If the configuration backup should include credentials used on the player, make sure to enable "Include users and passwords" option.
    • By default, the sensitive information will be encrypted with a secret key and can only be restored on this player. If it should be used onto other players, then click the "Change Encryption" button and set a custom passphrase for encryption.
  3. Click the "Get Config" button to generate a configuration backup containing the current settings of the player.
  4. Download the "config-Serial_number.cfg" file on your PC.

HMP200, HMP130, HMP100

Maintenance > Backup tab

To generate a configuration backup from the HMP, follow these steps:

  1. Open HMP Control Center and go to Maintenance > Backup tab.
  2. If the configuration backup should include credentials used on the player, make sure to enable "Backup users and passwords" option.
  3. Click on the "Backup" button to generate a configuration backup containing the current settings of the HMP device.
  4. Download the "config-Serial_number.cfg" file on your PC.
Note Notes:
  • Before 3.1.1 firmware release, the configuration backup file extension was .spx.
  • Before 3.0.0 firmware release, the configuration backup file was just the current config.xml fille.

Restore a configuration backup

HMP350, HMP300, DiVA

Note  
The configuration backup file can have one of the following extensions: cfg, spx, xml, 7z, or zip.
Control Center home page

To restore a configuration backup generated from the same player, follow these steps:

  1. Open Control Center.
  2. Click the "Restore Config" button and select a configuration backup file from your PC.
  3. Wait for the player to reboot in order to apply the configuration. A short list with the modified parameters is displayed.
System > Configuration Backup

To restore a configuration backup generated from another player, follow these steps:

  1. Open Control Center and go to System > Configuration Backup.
  2. Click the "Change Encryption" button and enter the same passphrase used for encryption on the source player.
  3. Click the "Restore Config" button and select a configuration backup file from your PC.
  4. Wait for the player to reboot in order to apply the configuration. A short list with the modified parameters is displayed.

HMP200, HMP130, HMP100

Maintenance > Backup tab

To restore a configuration backup, follow these steps:

  1. Open HMP Control Center and go to Maintenance > Backup tab.
  2. Click on the "Browse" button to select a configuration backup file from your PC.
    • The configuration backup file can have one of the following extensions: cfg, spx, xml, 7z, and zip.
  3. Click on the "Restore" button to apply the configuration onto the HMP.
  4. Wait for the HMP to reboot in order to apply the configuration. A short list with the modified parameters is displayed.

Troubleshooting

  • The touch screen calibration settings are currently not available in the backup file and thus these cannot be restored.
  • When restoring a configuration backup generated from a player having the default device name (which is the player serial number), the device name of the target player remains unchanged. Otherwise, that custom device name is set on the target player as well.

Custom configuration

The custom configuration backup file can be generated manually or starting from a configuration backup file generated by the player. For that, follow these steps:

  1. Open the configuration backup file (with 7-Zip or similar) or extract its contents somewhere.
  2. Edit the config.xml file and remove the settings that don't need to be restored. Eventually, change some of the settings, like static IP address or device name, as these should be unique on the network. Only the settings within the config.xml file will be modified when restored, all the other are not changed.
  3. Add the modified file back to the archive.
  4. To include splash screen images into the configuration backup archive, add one or more images named as: splash (for boot screen), shutdown, firmware-upd, followed by jpg or png extension.
  5. To include custom protocol files into the configuration backup archive, add one or more files ending with .fsm .
  6. Done - the configuration backup file can be restored as explained above.
Note Notes:
  • The maximum size of the configuration backup file is 10 Mb.
  • Although not strictly required, having the same firmware version on both the source and destination players assures that there are no problems restoring the configuration backup.

config.xml

See full article about the config format on the HMP Configuration API page.

The config.xml file contains an XML string composed of one or more configuration commands to be executed by the player when restoring it.

The config.xml file included into the configuration backup generated by the player contains the complete configuration of that player. It can be modified to contain less configuration settings (see below) so that it can be applied on multiple players - in this case, the settings not present in the config.xml file will keep their current value.

Fusion default content

Applies to HMP200, HMP130, HMP100.

If the configuration backup contains a 7z file called "fusion-default.7z", and Fusion is enabled, the default content provided will automatically be restored the first time a user logs into the Fusion interface.

The configuration backup generated from HMP Control Center doesn't include any Fusion content; instead such a Fusion backup file must must be generated from Fusion interface under Settings page.

See also

This page was last modified on 10 October 2018, at 17:29.