SpinetiX HMP series, Technical Documentation Manual

Page: 7 / 42

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. Further changes and improvements of the HMP configuration API were regularly
done in subsequent firmware releases.
There are two methods to send configuration commands to an HMP for execution:

Via a configuration backup - within the config.xml.

Via RPC - within the
xmlconfig
string provided to the
set_config()
command.
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="1.1">
<command-1>...</command-1>
...
<command-n>...</command-n>
</configuration>

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).

The XML configuration string can be used either as the content of the config.xml file (which
gets included into a configuration backup) or as the value of the
xmlconfig
parameter of the
set_config()
RPC command (in this case make sure to properly encode the XML string).

The
<configuration>
element has a "version" attribute whose value changed from "1.0"
to "1.1" within 3.0.0 release of firmware (because of a syntax change of two existing
configuration commands).