Advanced API

Cooling

GET /equipment/camera/cool

This endpoint cools the camera.

Query parameters

  • temperature number(double) Required

    The temperature to cool the camera to.

  • minutes number(double) Required

    The minimum duration to cool the camera. -1 for default duration

  • cancel boolean

    Whether to cancel the cooling process.

Responses

GET /equipment/camera/cool 
curl \
 --request GET 'http://localhost:1888/v2/api/equipment/camera/cool?temperature=42.0&minutes=42.0'
Response examples (200) 
{
  "Response": "Cooling started",
  "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"
}