Radar configuration

Configure all settings

This example will show you how to retrieve all parameters with their current configurations to change certain values and upload them back to the API.

1. Request the current radar event configuration:

http://myserver/axis-cgi/radar/control.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getConfiguration"
}

2. Parse the response.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getConfiguration",
  "data": {...}
}

3. Modify the configuration received in the data field and upload the modified configuration as params.

http://myserver/axis-cgi/radar/control.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "setConfiguration",
  "params": {...}
}

API references:

Test event functionality

This example will show you how to test a setup consisting of multiple radars with events from different radar profiles and check if they return the expected functions.

1. Send an alarm event for profile 1.

http://myserver/axis-cgi/radar/control.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "sendAlarmEvent",
  "params": {
    "profile": 1
  }
}

2. Parse the successful response with an empty data object to raise a temporarily stateful alarm on the given profile.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "sendAlarmEvent"
}

API references:

sendAlarmEvent

Determine configuration capabilities

This example will show you how to determine the default values and limits of the configuration parameters. This will be useful when you wish to update the user interface without needing to hard code the values.

1. Request the configuration capabilities of the API.

http://myserver/axis-cgi/radar/control.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getConfigurationCapabilities"
}

2. Parse the response.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getConfigurationCapabilities",
  "data": {...}
}

API references:

Enable the minimum speed filter

This example will show you how to detect objects based on their movement speed and track objects, such as fast-moving vehicles, by setting a minimum speed limit that the object must exceed to generate an alarm.

1. Request the configuration capabilities of the API.

http://myserver/axis-cgi/radar/control.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getConfigurationCapabilities"
}

2. Parse the response. This will provide the capabilities in the data object.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getConfigurationCapabilities",
  "data": {
    ...
    "filters": [
      ...
      {
        "type": "minimumSpeedLimit",
        "min": 0.0,
        "max": 70.0,
        "default": 69.444444444444443,
        "defaultActive": true
      }
      ...
    ]
    ...
  }
}

3. Request the current radar event configuration.

http://myserver/axis-cgi/radar/control.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getConfiguration"
}

4. Parse the response. The minimum speed filter will be set to off in this example.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getConfiguration",
  "data": {
    ...
    "profiles": [
      ...
      "filters": [
        ...
        {
          "type": "minimumSpeedLimit",
          "data": 0,
          "active": false
        }
        ...
      ]
    ]
    ...
  }
}

5. Enable the minimum speed filter by setting its properties described by the configuration capabilities. The following example will show you when the configuration is assumed to be unchanged, with the exception for the values in the minimum speed filter.

http://myserver/axis-cgi/radar/control.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "setConfiguration",
  "params": {
    ...
    "profiles": [
      ...
      "filters": [
        ...
        {
          "type": "minimumSpeedLimit",
          "data": 5.0,
          "active": true
        }
        ...
      ]
    ]
    ...
  }
}

6. Parse the response, which will contain an empty data response if the request is successful.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "setConfiguration",
  "data": {}
}

API references:

Parameter description

Set up a cross line

This example will show you how to generate an alarm event whenever an object crosses a pre-defined line in a specified direction.

1. Request the current configuration capabilities.

http://myserver/axis-cgi/radar/control.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getConfigurationCapabilities"
}

2. Parse the response, which will provide the capabilities in the data object.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getConfigurationCapabilities",
  "data": {
    ...
    "profiles": [
      ...
      {
        "type": "crossLine",
        "min": [-1, -1],
        "max": [1, 1],
        "minNbrVertices": 2,
        "maxNbrVertices": 100000,
        "minNbrInstances": 0,
        "maxNbrInstances": 100000,
        "alarmDirections": [
          "leftToRight",
          "rightToLeft"
        ],
        "detfaultInstance": [
          [-0.5, 0.0],
          [0.5, 0.0]
        ],
        "defaultAlarmDirection": "leftToRight"
      }
      ...
    ]
    ...
  }
}

3. Request the current event configuration.

http://myserver/axis-cgi/radar/control.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getConfigurationCapabilities"
}

4. Parse the current radar event configuration.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getConfiguration",
  "data": {
    ...
    "profiles": []
    ...
  }
}

5. Add a profile containing a cross line to the current configuration with the boundaries described by the configuration capabilities.

http://myserver/axis-cgi/radar/control.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "setConfiguration",
  "params": {
    ...
    "profiles": [
      {
        "name": "Zone",
        "uid": 1,
        "channel": 1,
        "filters": [...],
        "triggers": [
          {
            "type": "crossLine",
            "alarmDirection": "leftToRight",
            "data": [
              [-1.0, 0.0],
              [ 1.0, 0.0]
            ]
          }
        ]
      }
    ]
    ...
  }
}

6. Parse the response, which will contain an empty data object if the request is successful. This example shows what happens when the configuration is successfully set with the added crossline now in place, which will generate an alarm if an object crosses from left to right.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "setConfiguration",
  "data": {}
}

4. Parse the JSON response. In this example, the client’s configuration was successfully set and a cross line is now in place.

API references

Parameter description

Adjust detection sensitivity

This example will show you how to adjust the detection sensitivity of the radar. This is useful in noisy environments as it will decrease the frequency of false alarms and can be used as a complement to zone specific and global filters that are configured by setConfiguration and setGlobalFilters.

1. Request the configuration capabilities of the API.

http://myserver/axis-cgi/radar/radaranalytics.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getConfigurationCapabilities"
}

2. Parse the response, which will contain the allowed detection sensitivity levels.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getConfigurationCapabilities",
  "data": {
    ...
    "detectionSensitivity": {
      "values": [
        "low",
        "medium",
        "high"
      ],
      "default": "medium"
    },
    ...
  }
}

3. Apply a new valid detection sensitivity value according to the capabilities.

http://myserver/axis-cgi/radar/radaranalytics.cgi

Request

{
  "apiVersion": "2.1",
  "method": "setDetectionSensitivity",
  "params": {
    "sensitivity": "medium"
  }
}

4. Parse the response.

Response

{
  "apiVersion": "2.1",
  "method": "setDetectionSensitivity",
  "data": {}
}

API references

getDetectionSensitivity

setDetectionSensitivity

Adjust frequency channel

This example will show you how to set up two security radars to different frequency channels to avoid interference between them.

1. Find the current frequency channel for the first radar detector.

http://myserver/axis-cgi/radar/radaranalytics.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getFrequencyChannel",
  "params": {
    "channel": 1
  }
}

2. Parse the response to receive the current frequency channel.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method":  "getFrequencyChannel",
  "data": {
    "automatic": false,
    "value": 1,
  }
}

3. Find the current frequency channel for the second radar detector.

http://myserver/axis-cgi/radar/radaranalytics.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getFrequencyChannel",
  "params": {
    "channel": 1
  }
}

4. Parse the response to retrieve the current frequency channel.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getFrequencyChannel",
  "data": {
    "automatic": false,
    "value": 1,
  }
}

5. Find the allowed values for the first radar detector.

http://myserver/axis-cgi/radar/radaranalytics.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "setConfigurationCapabilities",
}

6. Parse the response to receive the currently supported frequency channels.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getConfigurationCapabilities",
  "data": {
    ...
    "frequencyChannel": {
      "minValue": 1,
      "maxValue": 2,
      "default": 1
    },
    ...
  }
}

7. Set a new value for the first radar detector.

http://myserver/axis-cgi/radar/radaranalytics.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "setFrequencyChannel",
  "params": {
    "value": 2,
    "channel": 1
  }
}

6. Parse the response to apply the chosen frequency channel.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "setFrequencyChannel",
  "data": {}
}

API references

getFrequencyChannel

setFrequencyChannel

Mounting height and tilt of radar

This example will show you how to, after mounting the radar the radar detector on different heights and tilt angles, inform the radar and update the analytical algorithm to the changes.

1. Find the currently configured mounting height.

http://myserver/axis-cgi/radar/radaranalytics.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getMountingHeight",
  "params": {
    "channel": 1
  }
}

2. Parse the response to receive the current mounting height and allowed values (in meter).

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getMountingHeight",
  "data": {
    "value": 3.5,
  }
}

3. Set a new value for the mounting height.

http://myserver/axis-cgi/radar/radaranalytics.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "setMountingHeight",
  "params": {
    "value": 5.1,
    "channel": 1
  }
}

4. Parse the response to apply the new mounting height.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "setMountingHeight",
  "data": {}
}

5. Find the currently configured mounting tilt angle.

http://myserver/axis-cgi/radar/radaranalytics.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getMountingTilt",
  "params": {
    "channel": 1
  }
}

6. Parse the response to receive the current mounting tilt as well as if the current value comes from an automatic or manual measurement.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getMountingTilt",
  "data": {
    "automatic": false,
    "value": 0
  }
}

7. Set a new value for the mounting tilt angle.

http://myserver/axis-cgi/radar/radaranalytics.cgi

The value of the field automatic will tell the application whether the measurement comes from an automatic source, such as an inclinometer, or a manual value. This is defined by the value object.

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "setMountingTilt",
  "params": {
    "automatic": false,
    "value": 10,
    "channel": 1
  }
}

8. Parse the response to apply the new mounting tilt.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "setMountingTilt",
  "data": {}
}

API references

Get status of radar data

This example will show you how to test if the security radar is working correctly.

1. Get the current radar data reception status.

http://myserver/axis-cgi/radar/radaranalytics.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getRadarDataStatus"
}

2. Parse the response to receive the current status as a boolean, where true signifies normal operation.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getRadarDataStatus",
  "data": {
    "value": true
  }
}

API references

getRadarDataStatus

Enable the swaying object filter

This example will show you how to reduce the number of false alarms from swaying objects such as trees or bushes. Unlike zone-specific filters that can be configured with setConfiguration, the swaying object filter is a global filter that requires a different setup.

1. Get the current configuration of the swaying object filter.

http://myserver/axis-cgi/radar/radaranalytics.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getGlobalFilters",
  "params": {
    "channel": 1
  }
}

2. Parse the response to receive a list containing available global filters and their respective status.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getGlobalFilters",
  "data": {
    "filters": [
      {
        "type": "swayingObjectFilter",
        "active": false
      }
    ]
  }
}

3. Enable the swaying objects filter.

http://myserver/axis-cgi/radar/radaranalytics.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "setGlobalFilters",
  "params": {
    "channel": 1,
    "filters": [
      {
        "type": "swayingObjectFilter",
        "active": true
      }
    ]
  }
}

4. Parse the response. The returning data object will be empty if the request was successful.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "setGlobalFilters",
  "data": {}
}

API references

setGlobalFilters

getGlobalFilters

Determine support for automatic mounting tilt measurement

This example will show you how to check if your device supports automatic mounting tilt measurement or if the numbers needs to be added manually.

1. Request the configuration capabilities of the application

http://myserver/axis-cgi/radar/radaranalytics.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getConfigurationCapabilities"
}

2. Parse the response. The value of data.mountingTilt.automatic will determine if your device supports automatic tilt measurement.

Response

{
  "apiVersion": "2.1",
  "method": "getConfigurationCapabilities",
  "data": {
    "coexistence": {
      "maxNeighboringRadars": {
        "values": [
          1,
          5
        ],
        "default": 1
      },
      "group": {
        "values": [
          1,
          2
        ],
        "default": 1
      }
    },
    "mountingHeight": {
      "default": 3.5,
      "maxValue": 100,
      "minValue": 0.3
    },
    "mountingTilt": {
      "automatic": true,
      "default": 0,
      "maxValue": 100,
      "minValue": -100
    }
  }
}

API references

Determine if the radar has been enabled

This example will show you how to check if the radar is enabled.

1. Request the current status of the radar.

http://myserver/axis-cgi/radar/control.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getEnabled"
}

2. Parse the response, where the object data.enabled will specify whether the radar is enabled.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getEnabled"
  "data": {
    "enabled": true
  }
}

API references

getEnabled

Turn off the radar

This example will show you how to temporarily turn off the radar.

1. Request that the radar is turned off.

http://myserver/axis-cgi/radar/control.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "setEnabled",
  "params": {
    "enabled": false
  }
}

2. Parse the response, which will contain an empty data object if the request was successful.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "setEnabled"
  "data": {}
}

API references

setEnabled

Set coexistence group

This example will show you how to install four to six radar detectors within the range of each other and how to make sure that they don’t interfere with each other.

1. Find the maximum number of neighboring radars and coexistence groups.

http://myserver/axis-cgi/radar/radaranalytics.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getConfigurationCapabilities"
}

2. Parse the response. This will return the currently supported maximum number of neighbors and coexistence groups, which in this example means a number of neighbors between 1 and 5, and coexistence groups 1 and 2.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getConfigurationCapabilities",
  "data": {
    ...
    "coexistence": {
      "maxNeighboringRadars": {
        "values": [
          1,
          5
        ],
        "default": 1
      },
      "group": {
        "values": [
          1,
          2
        ],
        "default": 1
      }
    },
    ...
  }
}

3. Find the current number of neighbors and the coexistence group.

http://myserver/axis-cgi/radar/radaranalytics.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getCoexistence"
}

4. Parse the response. This will return the current value of the maximum number of neighbors and coexistence group, which in this example is 2 and 1 by default.

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "getCoexistence",
  "data": {
    "maxNeighboringRadars": {
      "value": 2
    },
    "group": {
      "value": 1
    }
  }
}

5. Set the maximum number of neighboring radars to the new value. The current radar should be set to one of the groups if the number of detectors are higher than 3.

http://myserver/axis-cgi/radar/radaranalytics.cgi

Request

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "setCoexistence",
  "params": {
    "maxNeighboringRadars": 4,
    "group": 2
  }
}

6. Parse the reponse, which will contain an empty data response if the request is successful.

Response

{
  "apiVersion": "2.1",
  "context": "<client context>",
  "method": "setCoexistence",
  "data": {}
}

API references: