Note

For a description of the style convention and how JSON structures are documented see section JSON Data Structures.

Named JSON structures are indicated as {JSON}.

Start DAQ v1

Download JSON Schema.

This schema is a composite schema that defines the properties parameter that is provided for the StartDaq() command.

It is foreseen that all parameters to StartDaq() will be provided as part of the following structure, in a future version of OCM.

Note

All time durations are specified in seconds.

Example:

{
  "awaitInterval": 5.0,
  "keywords": [
    {
      "type": "valueKeyword",
      "name": "OBJECT",
      "value": "OBJECT,SKY"
    },
    {
      "type": "esoKeyword",
      "name": "OBS TPLNO",
      "value": 2
    }
  ]
}

StartDaqV1Properties {JSON}

Specifies the properties parameter in daqif.OcmDaqControl.StartDaq().

(object)
awaitInterval (Optional[float]) [default: 5.0]

This is the interval and maximum duration, in (fractional) seconds, used when awaiting the completion of primary sources. If this number exceed the MAL timeout it will stop working.

This is not a polling interval where shorter time will be more responsive. If await condition is fulfilled the reply will be sent immediately.

keywords (Optional[List[FitsKeyword]]) [default: []]

These are the initial FITS keywords that will eventually be provided with the FITS file created by OCM primary HDU. See FitsKeyword {JSON} for detail.