Set Binning | Advanced API documentation

Set Binning

GET /equipment/camera/set-binning

This endpoint sets the binning of the camera, if the specified binning is supported

Query parameters

binning string Required

The binning mode

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- Response string
- Error string
- StatusCode integer
- Success boolean
- Type string
409 application/json

Camera not connected / Invalid binning mode
Hide response attributes Show response attributes object
- Response string
- Error string
  
  Values are Camera not connected, Invalid binning mode, or Binning must be specified.
- 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 /equipment/camera/set-binning

curl \
 --request GET 'http://localhost:1888/v2/api/equipment/camera/set-binning?binning=2x2'

Response examples (200)

{
  "Response": "Binning set",
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}

Response examples (409)

{
  "Response": "string",
  "Error": "Camera not connected",
  "StatusCode": 409,
  "Success": false,
  "Type": "API"
}

Response examples (500)

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