DayNight API

API Discovery

id=daynight

List all capabilities and check the day and night configurations on a device.

Example

1. Use getCapabilities to check the current day night capabilities for a channel.

2. Use getConfiguration to check the current day night configuration for a channel.

Change the day to night and/or night to day shift level configuration.

• Increasing the value of DayNightShiftLevel will make the channel switch from day to night when it is darker.

• If the night to day switch is unsatisfactory it is possible to set Autotune to true. This will let an algorithm take control of the NightDayShiftLevel parameter to obtain optimal night to day performance.

• If the Autotune algorithm is unsatisfactory it is possible to set it to false and modify the value of NightDayShiftLevel.

• Increasing the value of NightDayShiftLevel will make the channel switch from night to day when it is darker. Please note that increasing the value of NightDayShiftLevel too much might lead to day night oscillations and should be carefully handled.

Example

1. Use setConfiguration to set the DayNightShiftLevel for a channel.

2. Use setConfiguration to set the boolean value of the parameter Autotune for a channel. This is only possible if AutotuneSupport is true (see getCapabilities).

3. Use setConfiguration to set the NightDayShiftLevel for a channel. Please note that this is only possible if Autotune is false and NightDayShiftLevelSupport is true (see getCapabilities).

Change the day to night and/or night to day dwell time configuration. A dwell time will always occur when a camera and a corresponding channel switch from day to night or night to day. Dwell time are the number of seconds that should pass until the day night algorithm make the switch, which by default is between 3–5 seconds and can be changed depending on use case:

• If a channel is observing a highway where there is temporary light sources passing by in the night for a short period of time. This can make the day night algorithm believe that it is bright and switch from night to day just because the headlights shine into the channel longer time than the night to day dwell time. The channel will switch back to night-mode once the car has left the scene. This means that it would be wise to change the NightDayDwellTime to be more than 20 seconds in order to avoid switches every time a car pass.

• If, on the other hand, the camera and a corresponding channel is located next to a motion triggered light source with visible light it would be wise to switch to day-mode as fast as possible when that light source turns on. In this case NightDayDwellTime should be set to 1–3 seconds.

Example

1. Use setConfiguration to set the DayNightDwellTime for a channel.

2. Use setConfiguration to set the NightDayDwellTime for a channel.

This method should be used when you want to request a list of all day and night capabilities for a specific channel on your device.

Request

Security level

Admin, Operator, Viewer

Method

POST

http://<servername>/axis-cgi/daynight.cgi#getCapabilities

{
  "apiVersion": "1.0",
  "context": "my context",
  "method": "getCapabilities",
  "params": {
    "channel": 0
  }
}

Return value – Success

HTTP Code

200 OK

Content-Type

application/json

{
  "apiVersion": "1.0",
  "context": "my context",
  "method": "getCapabilities",
  "data": [
    {
      "channel": 0,
      "AutotuneSupport": true,
      "NightDayShiftLevelSupport": true
    }
  ]
}

Return value – Failure

See Error responses for a complete list of potential errors.

This method should be used when you want to request configuration information for a channel.

Request

Security level

Admin, Operator, Viewer

Method

POST

http://<servername>/axis-cgi/daynight.cgi#getConfiguration

{
  "apiVersion": "1.0",
  "context": "my context",
  "method": "getConfiguration",
  "params": {
    "channel": 0
  }
}

Return value – Success

HTTP Code

200 OK

Content-Type

application/json

{
  "apiVersion": "1.0",
  "context": "my context",
  "method": "getConfiguration",
  "data": [
    {
      "channel": 0,
      "DayNightDwellTime": 3,
      "DayNightShiftLevel": 50,
      "NightDayDwellTime": 3,
      "NightDayShiftLevel": 50,
      "Autotune": true
    }
  ]
}

Return value – Failure

See Error responses for a complete list of potential errors.

This method should be used when you want to apply configurations to a channel.

Request

Security level

Admin, Operator, Viewer

Method

POST

http://<servername>/axis-cgi/daynight.cgi#setConfiguration

{
  "apiVersion": "1.0",
  "context": "my context",
  "method": "setConfiguration",
  "params": {
    "channel": 0,
    "DayNightDwellTime": 3,
    "DayNightShiftLevel": 50,
    "NightDayDwellTime": 3,
    "NightDayShiftLevel": 50,
    "Autotune": true
  }
}

Return value – Success

HTTP Code

200 OK

Content-Type

application/json

{
  "apiVersion": "1.0",
  "context": "my context",
  "method": "setConfiguration",
  "data": [
    {
      "channel": 0,
      "DayNightDwellTime": 3,
      "DayNightShiftLevel": 50,
      "NightDayDwellTime": 3,
      "NightDayShiftLevel": 50,
      "Autotune": true
    }
  ]
}

Return value – Failure

See Error responses for a complete list of potential errors.

This method should be used when you want to check which major and minor API versions that are supported on your device.

Request

Security level

Admin, Operator, Viewer

Method

POST

http://<servername>/axis-cgi/daynight.cgi#getSupportedVersions

{
  "apiVersion": "1.0",
  "context": "my context",
  "method": "getSupportedVersions"
}

Return value – Success

HTTP Code

200 OK

Content-Type

application/json

{
  "apiVersion": "1.0",
  "context": "my context",
  "method": "getSupportedVersions",
  "data": {
    apiVersions: [
      "1.0",
      "2.0"
    ]
  }
}

Return value – Failure

See Error responses for a complete list of potential errors.

200 API version not supported

HTTP Code

200

Content-Type

application/json

{
  "apiVersion": "1.0",
  "context": "my context",
  "method": "method",
  "error": {
    "code": 2100,
    "message": "API version not supported."
  }
}

400 Bad request

HTTP Code

400

Content-Type

application/json

{
  "apiVersion": "1.0",
  "context": "my context",
  "method": "method",
  "error": {
    "code": 2101,
    "message": "Invalid JSON."
  }
}

200 Method not supported

HTTP Code

200

Content-Type

application/json

{
  "apiVersion": "1.0",
  "context": "my context",
  "method": "method",
  "error": {
    "code": 2102,
    "message": "Method not supported."
  }
}

500 Missing parameter

HTTP Code

500

Content-Type

application/json

{
  "apiVersion": "1.0",
  "context": "my context",
  "method": "method",
  "error": {
    "code": 2103,
    "message": "Required parameter missing."
  }
}

500 Invalid parameter

HTTP Code

500

Content-Type

application/json

{
  "apiVersion": "1.0",
  "context": "my context",
  "method": "method",
  "error": {
    "code": 2104,
    "message": "Invalid parameter value specified."
  }
}

403 Authorization failed

HTTP Code

403

Content-Type

application/json

{
  "apiVersion": "1.0",
  "context": "my context",
  "method": "method",
  "error": {
    "code": 2105,
    "message": "Authorization failed."
  }
}

401 Authentication failed

HTTP Code

401

Content-Type

application/json

{
  "apiVersion": "1.0",
  "context": "my context",
  "method": "method",
  "error": {
    "code": 2106,
    "message": "Authentication failed."
  }
}

405 Method not allowed

HTTP Code

405

Content-Type

application/json

{
  "apiVersion": "1.0",
  "context": "my context",
  "method": "method",
  "error": {
    "code": 2107,
    "message": "Transport level error."
  }
}

500 Internal error, NightDayShiftLevel Autotune not supported

HTTP Code

500

Content-Type

application/json

{
  "apiVersion": "1.0",
  "context": "my context",
  "method": "method",
  "error": {
    "code": 1100,
    "message": "Internal error, NightDayShiftLevel Autotune not supported."
  }
}

500 Internal error, autotune set to true

HTTP Code

500

Content-Type

application/json

{
  "apiVersion": "1.0",
  "context": "my context",
  "method": "method",
  "error": {
    "code": 1100,
    "message": "Internal error, autotune set to true."
  }
}