Acquisition control

Acquisition control related API functions.

GHS.ghs_start_preview() → str[source]

Starts preview mode.

The system needs to be idle before calling this function.

Returns

  • GHSReturnValue - Start preview status.

GHS.ghs_stop_preview() → str[source]

Stops preview mode.

The system needs to be in preview mode before calling this function.

Returns

  • GHSReturnValue - Stop preview status.

GHS.ghs_start_recording() → str[source]

Start recording on local storage.

The system needs to be idle before calling this function. Note that the connected mainframe will generate a recording name. This command can be executed only successfully when the local storage is set.

Returns

  • GHSReturnValue - Start recording status.

GHS.ghs_pause_recording() → str[source]

Pauses a started recording.

The system needs to be recording before calling this function.

Returns

  • GHSReturnValue - Pause recording status.

GHS.ghs_resume_recording() → str[source]

Resumes a paused recording.

The system needs to be paused before calling this function.

Returns

  • GHSReturnValue - Resume recording status.

GHS.ghs_stop_recording() → str[source]

Stops a started recording.

The system needs to be recording before calling this function.

Returns

  • GHSReturnValue - Stop recording status.

GHS.ghs_trigger() → str[source]

Issues a trigger.

Results in error when the trigger cannot be issued.

Returns

  • GHSReturnValue - Trigger status.

GHS.ghs_get_acquisition_state() → tuple[str, str | None][source]

Returns the Acquisition State of the Mainframe.

Returns

  • GHSReturnValue - API return status

  • GHSAcquisitionState - acquisition state of the mainframe.

GHS.ghs_get_acquisition_time() → tuple[str, float | None][source]

Retrieves the current acquisition time relative to the start of acquistion.

Returns

  • GHSReturnValue - API return status

  • acquisition_time - The acquisition time in seconds.

GHS.ghs_get_acquisition_start_time() → tuple[str, int | None, int | None, float | None][source]

Retrieves the absolute time of the start of acquisition.

Returns

  • GHSReturnValue - API return status

  • year - The year

  • day - The day number in the year

  • seconds -The number of seconds since midnight.

Note: Storage locations needs to be set to local mainframe storage for recording.