Advanced API

Information

GET /equipment/camera/info

This endpoint returns relevant information about the camera.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response object Required
      Hide Response attributes Show Response attributes object
      • TargetTemp number
      • AtTargetTemp boolean
      • CanSetTemperature boolean
      • HasShutter boolean
      • Temperature integer
      • Gain integer
      • DefaultGain integer
      • ElectronsPerADU integer
      • BinX integer
      • BitDepth integer
      • BinY integer
      • CanSetOffset boolean
      • CanGetGain boolean
      • OffsetMin integer
      • OffsetMax integer
      • Offset integer
      • DefaultOffset integer
      • USBLimit integer
      • IsSubSampleEnabled boolean
      • CameraState string

        Values are NoState, Idle, Waiting, Exposing, Reading, Download, Error, or LoadingFile.

      • XSize integer
      • YSize integer
      • PixelSize integer
      • Battery integer
      • GainMin integer
      • GainMax integer
      • CanSetGain boolean
      • Gains array
      • CoolerOn boolean
      • CoolerPower integer
      • HasDewHeater boolean
      • DewHeaterOn boolean
      • CanSubSample boolean
      • SubSampleX integer
      • SubSampleY integer
      • SubSampleWidth integer
      • SubSampleHeight integer
      • TemperatureSetPoint integer
      • ReadoutModes array[string]
      • ReadoutMode integer
      • ReadoutModeForSnapImages integer
      • ReadoutModeForNormalImages integer
      • IsExposing boolean
      • ExposureEndTime string
      • LastDownloadTime integer
      • SensorType string

        Values are Monochrome, Color, RGGB, CMYG, CMYG2, LRGB, BGGR, GBRG, GRBG, GRGB, GBGR, RGBG, or BGRG.

      • BayerOffsetX integer
      • BayerOffsetY integer
      • BinningModes array[object]
        Hide BinningModes attributes Show BinningModes attributes object
        • Name string Required
        • X integer Required
        • Y integer Required
      • ExposureMax integer
      • ExposureMin integer
      • LiveViewEnabled boolean
      • CanShowLiveView boolean
      • SupportedActions array[string]
      • CanSetUSBLimit boolean
      • USBLimitMin integer
      • USBLimitMax integer
      • Connected boolean
      • Name string
      • DisplayName string
      • DeviceId string
    • Error string Required
    • StatusCode integer Required
    • Success boolean Required
    • Type string Required
  • 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 /equipment/camera/info 
curl \
 --request GET 'http://localhost:1888/v2/api/equipment/camera/info'
Response examples (200) 
{
  "Response": {
    "TargetTemp": 42.0,
    "AtTargetTemp": true,
    "CanSetTemperature": true,
    "HasShutter": true,
    "Temperature": 42,
    "Gain": 42,
    "DefaultGain": 42,
    "ElectronsPerADU": 42,
    "BinX": 42,
    "BitDepth": 42,
    "BinY": 42,
    "CanSetOffset": true,
    "CanGetGain": true,
    "OffsetMin": 42,
    "OffsetMax": 42,
    "Offset": 42,
    "DefaultOffset": 42,
    "USBLimit": 42,
    "IsSubSampleEnabled": true,
    "CameraState": "NoState",
    "XSize": 42,
    "YSize": 42,
    "PixelSize": 42,
    "Battery": 42,
    "GainMin": 42,
    "GainMax": 42,
    "CanSetGain": true,
    "Gains": [],
    "CoolerOn": true,
    "CoolerPower": 42,
    "HasDewHeater": true,
    "DewHeaterOn": true,
    "CanSubSample": true,
    "SubSampleX": 42,
    "SubSampleY": 42,
    "SubSampleWidth": 42,
    "SubSampleHeight": 42,
    "TemperatureSetPoint": 42,
    "ReadoutModes": [
      "string"
    ],
    "ReadoutMode": 42,
    "ReadoutModeForSnapImages": 42,
    "ReadoutModeForNormalImages": 42,
    "IsExposing": true,
    "ExposureEndTime": "string",
    "LastDownloadTime": 42,
    "SensorType": "Monochrome",
    "BayerOffsetX": 42,
    "BayerOffsetY": 42,
    "BinningModes": [
      {
        "Name": "string",
        "X": 42,
        "Y": 42
      }
    ],
    "ExposureMax": 42,
    "ExposureMin": 42,
    "LiveViewEnabled": true,
    "CanShowLiveView": true,
    "SupportedActions": [
      "string"
    ],
    "CanSetUSBLimit": true,
    "USBLimitMin": 42,
    "USBLimitMax": 42,
    "Connected": true,
    "Name": "string",
    "DisplayName": "string",
    "DeviceId": "string"
  },
  "Error": "string",
  "StatusCode": 42,
  "Success": true,
  "Type": "string"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}