The configuration file is plain JSON. This page describes its structure, which units can receive it and what each import type does. You do not need to edit the file; it is useful when you check one or build one by script.
An export writes one JSON object with three keys:
| Key | Holds |
|---|---|
version |
The file version. Always "1.0". |
export_details |
source_device_name: the name of the device you exported from. export_date_utc: when, in UTC. device_protocol: the manufacturer name of the source device, for example Wialon IPS. |
configurations |
A list of the setting groups you ticked. |
The import reads configurations and export_details.device_protocol. The other keys are for people. The app removes display-only keys from each setting before it writes the file.
Each entry of configurations has a type:
type |
Holds | Matched on import by |
|---|---|---|
sensor |
children: one entry per sensor, with its name, its sensor type such as FUEL, its fields and other settings |
The sensor name (Merge); the sensor type (Append) |
commands |
children: one entry per command, with its code, enable, params and description |
The command code |
trip_detector |
The trip detector settings as keys on the entry itself | Not matched: replaces the unit's trip detector |
filters |
children: a pre list of raw-data filters, each with its key, type and options, and one sensor entry per sensor filter |
The filter type and key |
fuel_config |
children: one entry per fuel setting: fuel_theft, fuel_refill, filtering, fuel_calc |
The setting name: replaces the unit's one of that name |
The groups carry the names of the app's own data and are not translated. For what the sensor types mean, see Sensor types.
export_details.device_protocol. The Destination Object list greys out all other rows and you cannot choose them.| Part | Needs on the destination |
|---|---|
trip_detector and filters |
A GPS sensor |
fuel_config |
A FUEL sensor |
| Commands to start and stop a video stream | A VIDEO_STREAM sensor |
All three modes leave alone any settings kind you did not tick. For example, a file with only fuel settings never touches the unit's sensors.
| Setting | Replace | Merge | Append |
|---|---|---|---|
| Sensors | The unit's sensor list becomes the file's list. Sensors the file lacks are gone. | A sensor with the same name is overwritten with the file's. Other sensors stay. New names are added. | A sensor is added only if the unit has no sensor of that type. Types that allow several sensors take every new name. Existing sensors stay as they are. |
| Commands | The unit's commands become the file's. | A command with the same code is overwritten. Others stay. New codes are added. | A command is added only if the unit lacks its code. |
| Trip detector | Overwritten by the file's. | Overwritten by the file's. | Overwritten by the file's. |
| Fuel settings | Each fuel setting in the file overwrites the unit's setting of that name. | Same as Replace. | Same as Replace. |
| Raw-data filters | The unit's filters become the file's. | Filters with the same type and key are overwritten. Others stay. | A filter is added only if the unit lacks that type and key. |
| Message | Cause |
|---|---|
| "Please select a valid JSON file" | The file name does not end in .json and its type is not JSON. |
| "File Parse Error" | The text is not valid JSON. |
| "No Configurations Found" | configurations is missing or empty. |
When a destination unit fails, the Import Summary dialog gives the server's reason for that unit. The import of the other units goes on.