Export and Import Settings

This guide explains how to export the current PULSE settings to a JSON file and import them back into the device.

Before You Start

PULSE implements the sbgInsRestApi protocol over a serial interface. All available settings and commands are described on the Digital interfaces page. All examples use the sbgEComApi command-line tool.

In this guide, we consider a PULSE connected to a Windows computer on serial port COM12, using the default baud rate of 921600 bps.

Export the Current Settings to a JSON File

Default Command

You can export the current device settings to a JSON file named ExportConfig.json using the following command:

sbgEComApi.exe -s COM12 -r 921600 /api/v1/settings/export -o ExportConfig.json

This command generates a JSON file containing the device settings. You can then review and modify the desired settings directly in the file.

Query Parameters

Two optional query parameters are available to customize the exported JSON file: format and delta.

Parameter	Value	Description
`format`	`compact`	Exports the settings as a compact JSON file without unnecessary whitespace.
`format`	`pretty`	Exports the settings as a human-readable, indented JSON file.
`delta`	`true`	Exports only device settings that differ from the default configuration.

Examples

Compact Format

Export the settings using a compact JSON format:

sbgEComApi.exe -s COM12 -r 921600 -q "format=compact" /api/v1/settings/export -o ExportConfig.json

Pretty Format

Export the settings using a human-readable, indented JSON format:

sbgEComApi.exe -s COM12 -r 921600 -q "format=pretty" /api/v1/settings/export -o ExportConfig.json

Export All Settings

Export all device settings, including those matching the default configuration:

sbgEComApi.exe -s COM12 -r 921600 -q "delta=true" /api/v1/settings/export -o ExportConfig.json

Combining Query Parameters

Query parameters can also be combined. For example, the following command exports all device settings using the human-readable JSON format:

sbgEComApi.exe -s COM12 -r 921600 -q "format=pretty&delta=true" /api/v1/settings/export -o ExportConfig.json

Import Settings from a JSON File

Import Command

You can import device settings from a JSON file using the following command:

sbgEComApi.exe -s COM12 -r 921600 -p /api/v1/settings/import -B .\ExportConfig.json

If the settings are successfully imported, the device should return:

{"title":"request successful","needReboot":true}

Info

A device reboot is required to apply the imported settings.

Download PDF