Advanced API

Auto Brightness Flats

GET /flats/auto-brightness

Start capturing auto brightness flats. This requires the camera to be connected. NINA will pick the best flat panel brightness for a fixed exposure time. Any omitted parameter will default to the instruction default.

Query parameters

  • count integer Required

    The number of flats to capture

    Minimum value is 0.

  • exposureTime number Required

    The exposure time to use for the flats, in seconds

    Minimum value is 0.

  • minBrightness integer

    The minimum flat panel brightness to use for the flats

    Minimum value is 0, maximum value is 99.

  • maxBrightness integer

    The maximum flat panel brightness to use for the flats

    Minimum value is 1, maximum value is 100.

  • 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.

  • 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.

  • keepClosed boolean

    Whether to keep the flat panel closed after taking the flats

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 400 application/json

    Could not start the process

    Hide response attributes Show response attributes object

    • Response string | array[string]

      One of:
      string-1 string array-2 array[string]
    • Error string

      Values are Process already running, Filter not available, Binning not available, Invalid gain, Invalid offset, or Issues found.

    • StatusCode integer
    • Success boolean
    • Type string
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /flats/auto-brightness 
curl \
 --request GET 'http://localhost:1888/v2/api/flats/auto-brightness?count=1&exposureTime=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"
}