pause

• Usage

>> pause

Security

Open.

Availability

v2.2.0

Description

This command pauses an enabled deployment.

If successful, the command reports its status:

• status, will be "paused".

The only error condition which would prevent the successful execution of the command is if the instrument had not been enabled for deployment.

When a pause is issued, the following will happen:

• Streaming is immediately suspended if any schedule in the deployment was configured to do so.

• The current acquisition, if any, is terminated.  For averages/tides, this means that the current sample will be thrown away and not recorded in memory or streamed. For bursts/waves the burst will terminate before the expected number of samples. In regimes mode, any open bin will be closed.

• An event of type EVENT_PAUSE (0x2B) is stored in the active dataset.

• No further acquisitions will be scheduled until a resume command is received.

Examples

>> pause
<< pause status=paused

Deployment is now paused and no more samples will be taken once the current acquisition, if any, finishes.

>> pause
<< ERR-406 cannot 'pause' while not logging

Cannot pause deployment if the instrument has not been enabled.