verify

Usage

>> verify config=<configuration_label> dataset=<dataset_label> [ storagemode=normal | calibration ]

Security

Open.

Description

This command performs all the same deployment consistency checks which the enable command performs. It then reports the same response which the enable command would produce, whether this is an updated instrument state, a warning or an error message. It does not, however, actually enable the instrument for sampling.

In other words, it performs a "dry run" of the enable command to allow the programmed schedule parameters to be verified.

The required parameters are as follows:

config=<configuration_label> specifies the configuration which will define this deployment. The configuration must be valid.

dataset=<dataset_label> gives the deployment's dataset a user-specified label. The <dataset_label> must satisfy all naming constraints.

The labels for all datasets existing in the logger's memory at any given time must be unique. A <dataset_label> may be reused, but only if the associated dataset is deleted from memory first. The <dataset_label> can not be changed after the enable command has been executed; if it is important, choose carefully.

There is also one optional parameter:

storagemode=normal | calibration determines whether calibration equations will be applied to all channel data (normal), or not (calibration). The setting applies only to the current deployment, and will default to normal if not specified. When storagemode=calibration, all data values are stored as IEEE double precision floating point numbers in the nominal range 0.0 to 1.0, regardless of what the normal storage format is.

If any of the deployment consistency checks fail, an error message is sent. The most severe error found causes immediate failure of the command; a single attempt to verify the configuration will not detect multiple errors.

If successful, the command reports these parameters in its response:

config=<configuration_label>, confirming the configuration that will be used for this deployment.
state=<instrument_state> the instrument state which would be assumed by the instrument if the enable command were issued. The actual state of the instrument does not change.

dataset=<dataset_label>, confirming the label of the dataset for this deployment.
storagemode=normal | calibration, confirming the data storage mode to be used.

The command may succeed, but have a warning to report; in such a case the warning code appears at the start of the response. Refer to the examples below.

Examples

TEXT

>> verify config=profiling dataset=test
<< verify config=profiling dataset=test storagemode=normal state=enabled

The programmed schedules are valid and the instrument would be enabled. The label test is a valid dataset label.

TEXT

>> verify dataset=Trial_2 config=tides
<< verify config=tides dataset=DeepCove storagemode=normal state=enabled

The programmed schedules are valid and the instrument would be enabled. The label Trial_2 is a valid dataset label.

TEXT

>> instrumemnt state
<< instrument state=enabled
>> verify dataset=DeepCove config=tides
<< WRN-408 instrument was already enabled

The instrument is already in an enabled state and using the same configuration as what is specified.

TEXT

>> instrumemnt state
<< instrument state=enabled
>> verify dataset=ShallowCove config=tides
<< ERR-128 instrument was already enabled with different settings

The instrument is already in an enabled state using settings which do not match the input. The existing deployment will continue on as it was. Attempting to enable using these parameters will provoke the same error.