Information

GET /equipment/guider/info

Get guider information

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- Response object Required
  
  Hide Response attributes Show Response attributes object
  
  Connected boolean Required
  
  Name string
  
  DisplayName string
  
  Description string
  
  DriverInfo string
  
  DriverVersion string
  
  DeviceId string
  
  CanClearCalibration boolean Required
  
  CanSetShiftRate boolean Required
  
  CanGetLockPosition boolean Required
  
  SupportedActions array
  
  RMSError object
  
  Hide RMSError attributes Show RMSError attributes object
  
  RA object Required
  
  Hide RA attributes Show RA attributes object
  
  Pixel integer Required
  
  Arcseconds integer Required
  
  Dec object Required
  
  Hide Dec attributes Show Dec attributes object
  
  Pixel integer Required
  
  Arcseconds integer Required
  
  Total object Required
  
  Hide Total attributes Show Total attributes object
  
  Pixel integer Required
  
  Arcseconds integer Required
  
  PeakRA object Required
  
  Hide PeakRA attributes Show PeakRA attributes object
  
  Pixel integer Required
  
  Arcseconds integer Required
  
  PeakDec object Required
  
  Hide PeakDec attributes Show PeakDec attributes object
  
  Pixel integer Required
  
  Arcseconds integer Required
  
  PixelScale number Required
  
  LastGuideStep object
  
  Hide LastGuideStep attributes Show LastGuideStep attributes object
  
  RADistanceRaw number Required
  
  DECDistanceRaw number Required
  
  RADuration number Required
  
  DECDuration number Required
  
  State string
  
  Values are Looping, LostLock, Guiding, Stopped, or Calibrating.
- 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/guider/info

curl \
 --request GET 'http://localhost:1888/v2/api/equipment/guider/info'

Response examples (200)

{
  "Response": {
    "Connected": true,
    "Name": "string",
    "DisplayName": "string",
    "Description": "string",
    "DriverInfo": "string",
    "DriverVersion": "string",
    "DeviceId": "string",
    "CanClearCalibration": true,
    "CanSetShiftRate": true,
    "CanGetLockPosition": true,
    "SupportedActions": [],
    "RMSError": {
      "RA": {
        "Pixel": 42,
        "Arcseconds": 42
      },
      "Dec": {
        "Pixel": 42,
        "Arcseconds": 42
      },
      "Total": {
        "Pixel": 42,
        "Arcseconds": 42
      },
      "PeakRA": {
        "Pixel": 42,
        "Arcseconds": 42
      },
      "PeakDec": {
        "Pixel": 42,
        "Arcseconds": 42
      }
    },
    "PixelScale": 42.0,
    "LastGuideStep": {
      "RADistanceRaw": 42.0,
      "DECDistanceRaw": 42.0,
      "RADuration": 42.0,
      "DECDuration": 42.0
    },
    "State": "Looping"
  },
  "Error": "string",
  "StatusCode": 42,
  "Success": true,
  "Type": "string"
}

Response examples (500)

{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}