Advanced API

Sky flats

GET /flats/skyflat

Start capturing sky flats. This requires the camera and mount to be connected. Any omitted parameter will default to the instruction default.

Query parameters

  • count integer Required

    The number of flats to capture

    Minimum value is 0.

  • minExposure number

    The minimum exposure time to use for the flats, in seconds

    Minimum value is 0.

  • maxExposure number

    The maximum exposure time to use for the flats, in seconds

    Minimum value is 0.

  • histogramMean number

    The mean to use for the histogram

    Minimum value is 0, maximum value is 1.

  • meanTolerance number

    The tolerance to use for the histogram

    Minimum value is 0, maximum value is 1.

  • dither boolean

    Whether to dither the flats

  • filterId integer

    The filter to use for the flats. The current filter will be used if this is not specified

    Minimum value is 0.

  • binning string

    The binning to use for the flats

  • gain integer

    The gain to use for the flats. The camera gain will be used if this is not specified

    Minimum value is 0.

  • offset integer

    The offset to use for the flats. The camera offset will be used if this is not specified

    Minimum value is 0.

Responses

GET /flats/skyflat 
curl \
 --request GET 'http://localhost:1888/v2/api/flats/skyflat?count=1'
Response examples (200) 
{
  "Response": "Process started",
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}
Response examples (400) 
{
  "Response": "string",
  "Error": "Process already running",
  "StatusCode": 400,
  "Success": false,
  "Type": "API"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}