enable

Usage

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

Security

Open.

Description

Enables the logger to sample for a new deployment according to the specified configuration. The following parameters are required:

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.

Although the enable command is always available, a number of checks are made before logging is actually enabled. If any check fails, the logger is not enabled, and an error message is sent. The most severe error found causes immediate failure of the command; a single attempt to enable the logger will not detect multiple errors. To determine in advance whether the command should succeed, use the verify command to perform a dry run first.

If all required conditions are satisfied, the enable command may still fail in the event of a fault that prevents logging from being enabled; this also will provoke an error message.

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 state of the instrument; this <instrument_state> is also reported by the instrument command.

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

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

The programmed schedules are valid and the instrument has been enabled. The dataset has been assigned the user-supplied label test.

TEXT

>> enable dataset=Trial_2 config=tides 
<< enable config=tides dataset=Trial_2 storagemode=normal state=enabled

The programmed schedules are valid and the instrument has been enabled. The dataset has been assigned the user-supplied label Trial_2.

TEXT

>> enable config=pH_cal dataset=d_pHcal_20240401 storagemode=calibration
<< enable config=pH_cal dataset=d_pHcal_20240401 storagemode=calibration state=enabled

The programmed schedules are valid and the instrument has been enabled; the calibration storagemode is being used for calibration of a sensor. The dataset has been assigned the user-supplied label d_pHcal_20240401.

TEXT

>> instrument state
<< instrument state=enabled
>> enable config=pH_cal dataset=d_pHcal_20240401 storagemode=calibration
<< WRN-408 instrument was already enabled

The instrument was already enabled with those exact settings. The deployment will continue on as it was.

TEXT

>> instrument state
<< instrument state=enabled
>> enable config=pH_cal dataset=d_pHcal_20240401 storagemode=calibration
<< ERR-128 instrument was already enabled with different settings

The instrument was already enabled with settings which don’t match the input. The existing deployment will continue on as it was. The new deployment will not be enabled.