Shock detection API

Shock detection is available in Axis products with built-in orientation devices such as accelerometers or gyroscopes. When shock detection is enabled, the camera’s position and acceleration is monitored. If the camera is tilted or displaced from its current position, or if the camera is subject to punches, hard blows or similar, an alarm is triggered and the Axis product emits a shock detection event.

The alarm is triggered immediately when the camera is punched or displaced. There is no pre-trigger time. After the alarm, position and acceleration monitoring continues from the camera’s new position. To prevent multiple events for the same displacement, a new shock detection event will not be emitted until 5 seconds has passed.

Shock detection sensitivity can be set to an integer between 0 and 100. Low sensitivity means that a hit must be quite powerful to trigger an alarm. High sensitivity means that very small displacements, including vibrations, will be trigger alarms.

The Shock detection API is used to enable, disable and adjust the Axis product’s shock detection functionality.

Supported functionality:

• Enable and disable shock detection

• Control the sensitivity level

Identification

Use shockdetection/getenabled.cgi to check if shock detection is enabled.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/shockdetection/getenabled.cgi?<argument>=<value>&[<argument>=<value>]

with the following arguments and values:

Response

Responses from shockdetection/getenabled.cgi

Success

A successful request returns true is shock detection is enabled and false if shock detection is disabled.

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="utf-8"?>
<ShockDetectionResponse xmlns="http://www.axis.com/vapix/http_cgi/shockdetection1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.axis.com/vapix/http_cgi/shockdetection1 http://www.axis.com/vapix/http_cgi/shockdetection1" SchemaVersion="1.0">
  <Success>
    <GetEnabledSuccess>
      <Enabled>[true|false]</Enabled>
    </GetEnabledSuccess>
  </Success>
</ShockDetectionResponse>

Supported elements, attributes and values:

Error

If an error occurred, a GeneralError response is returned. See General error response.

Error codes: 10, 20, 40

Use shockdetection/setenabled.cgi to enable and disable shock detection.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/shockdetection/setenabled.cgi?<argument>=<value>&[<argument>=<value>]

with the following arguments and values:

Response

Responses from shockdetection/setenabled.cgi

Success

If the request is successful, shock detection is enabled and a GeneralSuccess response is returned. See General success response.

Error

If an error occurred, a GeneralError response is returned. See General error response.

Error codes: 10, 20, 40

Use shockdetection/getsensitivitylevel.cgi to retrieve the current sensitivity level.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/shockdetection/getsensitivitylevel.cgi?<argument>=<value>&[<argument>=<value>]

with the following arguments and values:

Response

Responses from shockdetection/getsensitivitylevel.cgi

Success

A successful request returns the current sensitivity level.

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="utf-8"?>
<ShockDetectionResponse xmlns="http://www.axis.com/vapix/http_cgi/shockdetection1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.axis.com/vapix/http_cgi/shockdetection1 http://www.axis.com/vapix/http_cgi/shockdetection1" SchemaVersion="1.0">
  <Success>
    <GetSensitivityLevelSuccess>
      <SensitivityLevel>
        <Level>[level]</Level>
      </SensitivityLevel>
    </GetSensitivityLevelSuccess>
  </Success>
</ShockDetectionResponse>

Supported elements, attributes and values:

Error

If an error occurred, a GeneralError response is returned. See General error response.

Error codes: 10, 20, 40

Use shockdetection/setsensitivitylevel.cgi to set the shock detection sensitivity level.

Shock detection sensitivity can be set to an integer between 0 and 100. Low sensitivity means that a hit must be quite powerful to trigger an alarm. High sensitivity means that very small displacements, including vibrations, will be trigger alarms.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/shockdetection/setsensitivitylevel.cgi?<argument>=<value>&[<argument>=<value>]

with the following arguments and values:

Response

Responses from shockdetection/setsensitivitylevel.cgi

Success

If the request is successful, the sensitivity level is set to the submitted value and a GeneralSuccess response is returned. See General success response.

Error

If an error occurred, a GeneralError response is returned. See General error response.

Error codes: 10, 20, 30, 40

Use shockdetection/getschemaversion.cgi to retrieve the supported XML schema versions.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/shockdetection/getschemaversion.cgi

This CGI has no arguments

Response

Responses from shockdetection/getschemaversion.cgi

Success

A successful request returns the supported schema version.

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="utf-8"?>
<ShockDetectionResponse xmlns="http://www.axis.com/vapix/http_cgi/shockdetection1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.axis.com/vapix/http_cgi/shockdetection1 http://www.axis.com/vapix/http_cgi/shockdetection1" SchemaVersion="1.0">
  <Success>
    <GetSchemaVersionsSuccess>
      <SchemaVersion>
        <VersionNumber>[major.minor]</VersionNumber>
        <Deprecated>[true/false]</Deprecated>
      </SchemaVersion>
    </GetSchemaVersionsSuccess>
  </Success>
</ShockDetectionResponse>

Supported elements, attributes and values:

Error

If an error occurred, a GeneralError response is returned. See General error response.

Error codes: 10, 20, 40

General success response in Shock Detection API.

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<ShockDetectionResponse xmlns="http://www.axis.com/vapix/http_cgi/shockdetection1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.axis.com/vapix/http_cgi/shockdetection1 http://www.axis.com/vapix/http_cgi/shockdetection1" SchemaVersion="1.0">
  <Success>
    <GeneralSuccess></GeneralSuccess>
  </Success>
</ShockDetectionResponse>

Supported elements, attributes and values:

General error response in Shock detection API.

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="utf-8"?>
<ShockDetectionResponse xmlns="http://www.axis.com/vapix/http_cgi/shockdetection1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.axis.com/vapix/http_cgi/shockdetection1 http://www.axis.com/vapix/http_cgi/shockdetection1" SchemaVersion="1.0">
  <Error>
    <GeneralError>
      <ErrorCode>[error code]</ErrorCode>
      <ErrorDescription>[description]</ErrorDescription>
    </GeneralError>
  <Error>
</ShockDetectionResponse>

Supported elements, attributes and values:

The shock detection event tns1:Device/tnsaxis:Tampering/ShockDetected is a stateless event.

To retrieve the event declaration, use aev:GetEventInstances.

<tns1:Device aev:NiceName="Device">
  <tnsaxis:Tampering aev:NiceName="Tampering">
    <ShockDetected wstop:topic="true" aev:NiceName="Shock Detected">
      <aev:MessageInstance>
        <aev:SourceInstance>
          <aev:SimpleItemInstance aev:NiceName="Channel" Type="xsd:int" Name="channel">
            <aev:Value>1</aev:Value>
          </aev:SimpleItemInstance>
        <aev:DataInstance />
      </aev:MessageInstance>
    </ShockDetected>
  </tnsaxis:Tampering>
</tns1:Device>

The topic is tns1:Device/tnsaxis:Tampering/ShockDetected. Channel is the video channel and is intended for future use.