For the complete documentation index, see llms.txt. This page is also available as Markdown.

Parking detection

How the Navixy platform decides a tracker has stopped, which is what splits a trajectory into trips.

Parking detection is how the platform decides that a tracker has stopped moving. That decision does two jobs:

  • It splits a continuous trajectory into separate trips, which is what makes a track legible on a map and a tabular report readable.

  • It raises the trip start and trip end events that rules can notify on.

The settings here are the thresholds behind that decision, and they are per tracker, because what counts as a stop differs between a delivery van and a crane.

API actions

API base path: /tracker/settings/trip_detection.


Read parking detection settings

post
/tracker/settings/trip_detection/read

Get how the platform decides this tracker has stopped. These settings split a trajectory into trips and drive the trip start and end events. Available to demo accounts.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
tracker_idintegerRequired

ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked.

Example: 123456
Responses
200

The parking detection settings

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
min_idle_duration_minutesintegerOptional

Minutes the device must stay idle before a trip counts as finished.

Example: 5
idle_speed_thresholdintegerOptional

Speed in km/h below which the device counts as idle.

Example: 3
ignition_awarebooleanOptional

Whether the ignition state is considered.

motion_sensor_awarebooleanOptional

Whether the motion sensor is considered.

post/tracker/settings/trip_detection/read
POST /v2/tracker/settings/trip_detection/read HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "tracker_id": 123456
}
{
  "success": true,
  "min_idle_duration_minutes": 5,
  "idle_speed_threshold": 3,
  "ignition_aware": true,
  "motion_sensor_aware": true
}

Errors

These errors come in addition to the general error codes:

  • 204 - No tracker with this ID belongs to the account.

  • 208 - The tracker exists but is blocked, normally because its tariff ended.


Required sub-user rights: tracker_update.

Change parking detection settings

post
/tracker/settings/trip_detection/update

Change how the platform decides this tracker has stopped.

min_idle_duration_minutes and idle_speed_threshold are both required; ignition_aware and motion_sensor_aware are optional.

Requires the tracker_update right.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
tracker_idintegerRequired

ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked.

Example: 123456
min_idle_duration_minutesinteger · min: 1 · max: 1440Required

Minutes the device must stay idle before a trip counts as finished.

Example: 5
idle_speed_thresholdinteger · max: 200Required

Speed in km/h below which the device counts as idle. 0 means it never counts as idle.

Example: 3
ignition_awarebooleanOptional

Optional. Consider the ignition state when detecting a trip.

motion_sensor_awarebooleanOptional

Optional. Consider the motion sensor when detecting a trip.

Responses
200

The settings were changed

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/tracker/settings/trip_detection/update
POST /v2/tracker/settings/trip_detection/update HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "tracker_id": 123456,
  "min_idle_duration_minutes": 5,
  "idle_speed_threshold": 3,
  "ignition_aware": true,
  "motion_sensor_aware": true
}
{
  "success": true
}

Errors

These errors come in addition to the general error codes:

  • 204 - No tracker with this ID belongs to the account.

  • 208 - The tracker exists but is blocked, normally because its tariff ended.

Last updated

Was this helpful?