Configuration backup

From SpinetiX Support Wiki

Jump to: navigation, search

This page is about the configuration backup feature present in HMP Control Center. For other uses, see Fusion backup and Archive pages.

Introduction

The HMP Control Center interface is very useful in configuring a single HMP, yet, whenever multiple HMP devices need to be deployed very fast, doing a manual configuration of each HMP device is not very convenient; instead, being able to save the configuration of an HMP and restore it on a non-configured one, provides much faster results. A configuration backup can also be used to restore a previously saved configuration to undo some unwanted changes.

The configuration backup & restore feature was introduced in 2.2.1 firmware release, allowing the user to generate a configuration backup from HMP Control Center and, if needed, to restore that backup on the same HMP device or to use it to configure other HMP devices.

  • The configuration backup, named "config-{HMPSerialNumber}.spx", was in fact an XML document (i.e. the config.xml).
  • Starting with 3.0.0 release, the configuration backup file format has been changed from XML to 7z to include additional files within.
  • Starting with 3.1.1 release, the configuration backup file name has been changed to "config-{HMPSerialNumber}.cfg", since the .spx extension might be used by other programs.
  • Complete description of the backup file can be found in the HMP Configuration API page

Generate a configuration backup

The configuration backup file can be generated from HMP Control Center:

The configuration backup file could also be generated manually, following the indications about the configuration backup file content, though usually it's better to use a configuration backup file generated by the HMP and, if required, just modify some parts.


The resulted file can be used afterwards to restore the configuration on another or on the same HMP device. Be aware that some parameters, like the IP address (in case of fixed configuration) or the device name should normally be unique on the network, and they should be modified before restoring the configuration backup on another HMP device.

Note Note: The touch screen calibration settings are currently not available in the backup file and thus these cannot be restored.

DiVA, HMP300 and HMP350

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

  1. Open HMP Control Center and go to System > Configuration Backup.
  2. Click on the "Get Config" button to generate a configuration backup containing all the current settings of the HMP device.
    • If the "Include users and passwords" option is enabled, then the credentials saved on that HMP are included in the backup.
  3. Download the "config-{HMPSerialNumber}.cfg" file on your PC.

HMP200, HMP130, and HMP100

Maintenance > Backup tab

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

  1. Open HMP Control Center and go to System.
  2. Click on the "Backup" button to generate a configuration backup containing all the current settings of the HMP device.
    • If the "Backup users and passwords" option is enabled, then the credentials saved on that HMP are included in the backup.
  3. Download the "config-{HMPSerialNumber}.cfg" file on your PC.

Configuration backup content

Starting with 3.0.0 release, the configuration backup file format has been changed from XML to 7z archive to include additional files within.

A configuration backup generated from HMP Control Center contains at least one file named "config.xml", describing the current settings of the HMP device. Other files might also be present within the configuration backup archive file, like custom splash screen images (jpg or png) and protocol files (custom fsm files stored on the device).

It is possible to alter the archive content and manually add / modify splash screen images, protocol files and even Fusion default content.

Note Note: The maximum size of the configuration backup file is 10 Mb.

config.xml

The config.xml file is an XML document containing an XML configuration string, as described on the HMP Configuration API page, composed of one or more configuration commands to be executed by the HMP restoring it. The config.xml file may contain configuration commands for all HMP device settings (as it is the case for when the configuration backup is generated from HMP Control Center) or just for some of the settings (in this case, the settings not found in the file will keep their current value).

Fusion default content

Only for HMP200 and HMP130

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.

Restore a configuration backup

DiVA, HMP300 and HMP350

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

  1. Open HMP Control Center
  2. Click on the "Restore Config" button to select a configuration backup file from your PC.
    • You can also drag & drop the configuration file on the Control Center page directly.
    • The configuration backup file can have one of the following extensions: cfg, spx, xml, 7z, and zip.
  3. Wait for the HMP to reboot in order to apply the configuration. A short list with the modified parameters is displayed.

HMP200, HMP130, and HMP100

Maintenance > Backup tab

To restore a configuration backup from the HMP, 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.

Custom configuration

The configuration backup file created by the HMP contains all the configurable settings of the device. To restore a partial configuration containing only some of the settings, follow these steps:

  1. Open the configuration backup file with 7-Zip (or similar) and extract its contents.
  2. Open and edit config.xml file and remove the settings that don't need to be restored.
  3. Eventually, change some of the settings, like the IP address (in case of fixed configuration) or the device name.
  4. Add the modified file to the archive (.cfg).
  5. Restore the configuration backup file as explained above. Only the settings present in the config.xml file will be modified, all the other being left untouched.

Note Note: Although not strictly required, having the same firmware version on both the source and destination HMP devices assures that there are no problems restoring the configuration backup.

Troubleshooting

  • 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.
This page was last modified on 15 August 2017, at 20:27.