Device Settings Module¶
The Device Settings Module provides functionality for saving and loading device settings to and from file. The file is saved in XML format.
Important
In general, users are recommended to use the utility functions provided by the APIs instead of using the Device Settings module directly. These are convenient wrappers to the Device Settings module for loading settings synchronously, i.e., these functions block until loading or saving has completed, the desired behavior in most cases. Advanced users can use the Device Settings module directly if they need to implement loading or saving asynchronously (non-blocking).
Node Documentation¶
This section describes all the nodes in the Device Settings Module node tree organized by branch.
command¶
/command ¶
| Properties: | Read, Write |
| Type: | String |
| Unit: | None |
The command to execute: 'save' = Read device settings and save to file; 'load' = Load settings from file an write to device; 'read' = Read device settings only (no save).
device¶
/device ¶
| Properties: | Read, Write |
| Type: | String |
| Unit: | None |
Comma separated list of devices that should be used for loading/saving device settings, e.g. 'dev1000,dev2000'.
errortext¶
filename¶
finished¶
path¶
/path ¶
| Properties: | Read, Write |
| Type: | String |
| Unit: | None |
Directory where settings files should be located. If not set, the default settings location of the LabOne software is used.
throwonerror¶
/throwonerror ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
Throw an exception is there was error executing the command.