twistactivation

Usage

>> twistactivation [ enabled | state ]

Security

Unsafe.

Description

Reports or sets the parameters which control twist-activation-gated sampling. The <parameter>s currently supported are:

enabled [= true | false ]
- true, enables the twist activation gating feature.
- false, disables the twist activation gating feature.
state is a read-only parameter which shows whether logging is currently paused or running due to the position of the end cap. The state may also be reported as n/a because
- Twist activation is not enabled.
- The logger has not yet been enabled for sampling.
- The logger is enabled but still before the start time (deployment status = pending).

The basic validity checks on parameters indicated above are performed immediately. Further checks may result in error messages at the time the logger is enabled; for example, thresholding and twist activation gating features may not be enabled simultaneously.

Examples

CODE

>> twistactivation
<< twistactivation enabled = false, state = n/a

Twist-activation-gated logging is not enabled. If it were, the logger would sample data depending on the position of the end cap.

CODE

>> twistactivation enabled = true
<< twistactivation enabled = true, state = n/a
>> enable
<< enable status = gated, warning = none
>> twistactivation
<< twistactivation enabled = true, state = paused

Twist-activation-gated control of sampling is enabled, and logging is paused pending twist activation.

Errors

Error E0105 command prohibited while logging
Settings may not be modified while logging is in progress; reading them is permitted.

Error E0108 invalid argument to command: '<invalid-argument>'
The command was given with an argument which is unrecognized or has an invalid value; for example "twistactivation enabled = yes".

Error E0109 feature not available
The logger is not configured to support twist-activation-gated control of sampling.