Skip to main content

Tracking Events API 1.0.0 documentation

AsyncAPI documentation for the Tracking events stream. Tracking events represent real-time vehicle telemetry data including GPS position, speed, fuel levels, driver information, tachograph data, TPMS sensors, and EBS brake system data.

Table of Contents

Servers

kafka Server

  • URL: kafka-secure://{brokerHost}:{brokerPort}/
  • Protocol: kafka-secure

URL Variables

NameDescriptionDefault valueAllowed values
brokerHostKafka broker hostnamelocalhostAny
brokerPortKafka broker port9092Any

Security

Security Requirement 1
  • security.protocol: SASL_SSL
  • sasl.mechanism: OAUTHBEARER

Operations

RECEIVE mn_tracking_events Operation

Receive tracking events
  • Operation ID: receiveTrackingEvent
Channel for real-time vehicle tracking events Receives real-time vehicle tracking events containing GPS position, telemetry data, and various sensor readings.

Message Tracking Event TrackingEvent

A real-time vehicle tracking event
Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstringUnique identifier of the tracking event--required
cidstringCustomer identifier--required
esnstringDevice serial number---
aidstringAsset (vehicle) identifier--required
anstringAsset name---
amkstringAsset make---
amdstringAsset model---
atstringAsset type---
edtintegerEvent date time in epoch milliseconds-format (int64)required
ngpsintegerNumber of GPS satellites---
hdopnumberHorizontal Dilution of Precision-format (float)-
ecastringEvent category---
ecostringEvent code---
esstringEvent status---
dkstringDriver key---
pidstringPerson (driver) identifier---
pnstringPerson name---
opidstringOriginal person identifier---
pidebdkbooleanPerson ID enriched by driver key---
phnidstringPerson hierarchy node identifier---
phpstringPerson hierarchy path---
arstringAsset registration---
ahnidstringAsset hierarchy node identifier---
ahpstringAsset hierarchy path---
ahnnstringAsset hierarchy node name---
aslknumberAsset speed limit in kph-format (float)-
ddnumberDirection in degrees-format (float)-
sknumberSpeed in kph-format (float)-
dsintegerDuration in seconds-format (int64)-
dkmsnumberDistance in kilometers-format (double)-
tripKmnumberCumulative journey distance in km-format (double)-
sidintegerSequence identifier-format (int64)-
pribooleanWhether the location is private---
hjbooleanWhether to hide journey---
synbooleanWhether the event is synthetic (generated missing start or end of journey event)---
ctiintegerCreated time in epoch milliseconds-format (int64)-
lmtintegerLast modified time in epoch milliseconds-format (int64)-
otstringOdometer typeallowed ("GPS", "CAN")--
coord.longnumberCoordinate longitude-format (double)-
coord.latnumberCoordinate latitude-format (double)-
ad.fastringFormatted address---
ad.rdstringRoad name---
ad.rnstringRoad number---
ad.ctystringCity---
ad.pcstringPostcode---
ad.ctrystringCountry---
ad.rsknumberRoad speed limit in kph-format (float)-
ad.rtstringRoad type---
ad.sltstringSpeed limit type---
ad.cicstringCountry ISO code---
ad.dvstringDivision---
ad.sdvstringSubdivision---
ad.dvicstringDivision ISO code---
ad.sdvicstringSubdivision ISO code---
carcintegerCumulative asset runtime in seconds-format (int64)-
captsintegerCumulative asset PTO time in seconds-format (int64)-
caitsintegerCumulative asset idle time in seconds-format (int64)-
cafunumberCumulative asset fuel used-format (double)-
cadkmnumberCumulative asset distance in km-format (double)-
fclnumberFuel cumulative liters (journey)-format (double)-
ctystringCost type (section)---
conumberCost value-format (double)-
ccstringCost currency---
blnumberBattery level-format (float)-
athnumberAsset total hours-format (float)-
ethnumberEngine total hours-format (float)-
erpmintegerEngine RPM---
fllnumberFuel level in litres-format (float)-
flpnumberFuel level percentage-format (float)-
evrknumberEV range in km-format (float)-
evrkebooleanEV range km is estimated---
evsocpnumberEV state of charge percentage-format (float)-
evsocpebooleanEV state of charge percentage is estimated---
ecrmintegerEV charge remaining minutes---
ecmstringEV charging mode---
isstringIgnition status---
bvnumberBattery voltage-format (float)-
epvnumberExternal power voltage-format (float)-
psstringPower source---
emvnumberEvent max value (behaviour alert)-format (float)-
edsintegerEvent duration in milliseconds-format (int64)-
plarray<object>Places---
pl.idstringPlace identifier---
pl.nmstringPlace name---
pl.plcidstringPlace category identifier---
pl.plcnmstringPlace category name---
in.idstringInput identifier---
in.tmintegerInput time-format (int64)-
in.tystringInput type---
in.vstringInput value---
insarray<object>Multiple inputs---
ins.idstringInput identifier---
ins.tmintegerInput time-format (int64)-
ins.tystringInput type---
ins.vstringInput value---
ietstringInput event type---
charray<object>Input channels---
ch.chitstringChannel input type---
ch.chivstringChannel input value---
ch.chicvstringChannel input calculated value---
ch.chilutintegerChannel input last updated time-format (int64)-
ch.chicatstringChannel input category---
ch.chisnpstringChannel input serial number probe---
dfsarray<object>Device defects---
dfs.dftystringDefect type---
dfs.dfcostringDefect code---
dfs.dfststringDefect status---
dfs.dfedtintegerDefect event date time-format (int64)-
dfs.dfdestringDefect details---
enrgobjectEnergy data--additional properties are allowed
pftstringPrimary fuel type---
pfcnumberPrimary fuel capacity-format (double)-
pacnumberPrimary average consumption-format (double)-
parkmnumberPrimary average range in km-format (double)-
sftstringSecondary fuel type---
sfcnumberSecondary fuel capacity-format (double)-
sacnumberSecondary average consumption-format (double)-
sarkmnumberSecondary average range in km-format (double)-
tagsarray<string>Tags---
tags (single item)string----
aftarray<string>Asset feature tags---
aft (single item)string----
ipidsarray<string>Interested parties IDs---
ipids (single item)string----
iptagsarray<string>Interested parties tags---
iptags (single item)string----
btarray<string>Box types---
bt (single item)string----
psrobjectPeriodic sample raw data--additional properties are allowed
dimbooleanDevice is mirror---
lanstringLinked asset name---
laidstringLinked asset identifier---
larstringLinked asset registration---
deidstringDriver external identifier---
ta.tdintegerTachograph time date-format (int64)-
ta.vidstringTachograph vehicle ID number---
ta.vrnstringTachograph vehicle registration number---
ta.hrtvdnumberTachograph high resolution total vehicle distance-format (double)-
ta.mvstringTachograph make version---
ta.imsstringTachograph issuing member state---
ta.cdidstringTachograph current driver ID---
ta.castringTachograph current activity---
ta.ltointegerTachograph local time offset---
ta.ooscstringTachograph out of scope condition---
ta.cdnstringTachograph current driver name---
ta.cattsintegerTachograph current activity total time in seconds-format (int64)-
ta.trsstringTachograph time related states---
ta.cdtsintegerTachograph continuous driving time in seconds-format (int64)-
ta.ddtsintegerTachograph daily driving time in seconds-format (int64)-
ta.wdtsintegerTachograph weekly driving time in seconds-format (int64)-
ta.pctdtsintegerTachograph previous and current total drive time in seconds-format (int64)-
ta.rdtsintegerTachograph remaining driving time in seconds-format (int64)-
ta.rddtsintegerTachograph remaining daily driving time in seconds-format (int64)-
ta.rwdtsintegerTachograph remaining weekly driving time in seconds-format (int64)-
ta.tlundrsintegerTime left until next daily rest in seconds-format (int64)-
ta.ndrmdsintegerNext daily rest min duration in seconds-format (int64)-
ta.tlunwrsintegerTime left until next weekly rest in seconds-format (int64)-
ta.nwrmdsintegerNext weekly rest min duration in seconds-format (int64)-
ta.ldreintegerLast daily rest end-format (int64)-
ta.lwreintegerLast weekly rest end-format (int64)-
ta.rdedtpintegerRemaining daily extended drive time periods---
ta.rdsrtpintegerRemaining daily shortened rest time periods---
ta.wtslbsintegerWorking time since last break in seconds-format (int64)-
ta.rwtsintegerRemaining working time in seconds-format (int64)-
ta.dwtsintegerDaily working time in seconds-format (int64)-
ta.rdwtsintegerRemaining daily working time in seconds-format (int64)-
ta.wwtsintegerWeekly working time in seconds-format (int64)-
ta.rwwtsintegerRemaining weekly working time in seconds-format (int64)-
ta.dbtsintegerDaily break time in seconds-format (int64)-
ta.dpstringDriving prediction---
ta.wpstringWorking prediction---
ta.dcedintegerDriver card expiry date-format (int64)-
ta.dcnmddintegerDriver card next mandatory download date-format (int64)-
ta.tlunrpsintegerTime left until next rest period in seconds-format (int64)-
ta.nrdsintegerNext rest duration in seconds-format (int64)-
ta.dcibooleanDriver card inserted---
ta.visstringVehicle ignition state---
ta.vsnumberVehicle speed-format (float)-
ta.esnumberEngine speed-format (float)-
ta.rcpwsintegerRest compensation previous week in seconds-format (int64)-
ta.rcspwsintegerRest compensation second previous week in seconds-format (int64)-
ta.rctpwsintegerRest compensation third previous week in seconds-format (int64)-
ta.rtocrsintegerRemaining time of current rest in seconds-format (int64)-
ta.docrsintegerDuration of current rest in seconds-format (int64)-
ta.tutstringTimes update type---
ta.dsstringDriver slot---
ta.rmsstringRegistration member state---
ta.odidstringOther driver ID---
ta.oimsstringOther driver issuing member state---
tpms.tstringTPMS type---
tpms.dpstringTPMS device position---
tpms.recobjectTPMS receiver information--additional properties are allowed
tpms.rec.macstringMAC address---
tpms.rec.lrtintegerLast received time-format (int64)-
tpms.repsarray<object>TPMS repeaters---
tpms.reps.macstringMAC address---
tpms.reps.lrtintegerLast received time-format (int64)-
tpms.sensarray<object>TPMS sensors---
tpms.sens.iintegerSensor index---
tpms.sens.sstringSensor status---
tpms.sens.macstringMAC address---
tpms.sens.pstringPosition---
tpms.sens.aintegerAxle number---
tpms.sens.asstringAxle side---
tpms.sens.wpstringWheel position---
tpms.sens.ppanumberPressure in Pa---
tpms.sens.tcnumberTemperature in °C---
tpms.sens.lsstringLocation status---
tpms.sens.lrtintegerLast received time-format (int64)-
ebs.aatgtintegerEBS ABS active towing transitions---
ebs.bltintegerEBS brake light transitions---
ebs.sbdminnumberEBS service brake demand min Pa---
ebs.sbdmaxnumberEBS service brake demand max Pa---
ebs.sbdmeannumberEBS service brake demand mean Pa---
ebs.vatgtintegerEBS VDC active towing transitions---
ebs.rstintegerEBS ROP system transitions---
ebs.ystintegerEBS YC system transitions---
ebs.aotintegerEBS ABS off road transitions---
ebs.wbstgminnumberEBS wheel based speed towing min m/s---
ebs.wbstgmaxnumberEBS wheel based speed towing max m/s---
ebs.wbstgmeannumberEBS wheel based speed towing mean m/s---
ebs.aatdtintegerEBS ABS active towed transitions---
ebs.sbtintegerEBS service brake transitions---
ebs.atvbtintegerEBS auto towed vehicle brake transitions---
ebs.vatdtintegerEBS VDC active towed transitions---
ebs.laminnumberEBS lateral acceleration min m/s²---
ebs.lamaxnumberEBS lateral acceleration max m/s²---
ebs.lameannumberEBS lateral acceleration mean m/s²---
ebs.wbstdminnumberEBS wheel based speed towed min m/s---
ebs.wbstdmaxnumberEBS wheel based speed towed max m/s---
ebs.wbstdmeannumberEBS wheel based speed towed mean m/s---
ebs.alsminnumberEBS axle load sum min kg---
ebs.alsmaxnumberEBS axle load sum max kg---
ebs.alsmeannumberEBS axle load sum mean kg---
ebs.vestintegerEBS vehicle electrical supply transitions---
ebs.rwstintegerEBS red warning signal transitions---
ebs.awstintegerEBS amber warning signal transitions---
ebs.lrtintegerEBS loading ramp transitions---
ebs.slbtintegerEBS supply line braking transitions---
ebs.blgtintegerEBS brake lining transitions---
ebs.btstintegerEBS brake temperature status transitions---
ebs.vpstintegerEBS vehicle pneumatic supply transitions---
ebs.blminnumberEBS brake lining min percentage---
ebs.blmaxnumberEBS brake lining max percentage---
ebs.blmeannumberEBS brake lining mean percentage---
ebs.btminnumberEBS brake temperature min °C---
ebs.btmaxnumberEBS brake temperature max °C---
ebs.btmeannumberEBS brake temperature mean °C---
ebs.psminnumberEBS pneumatic supply min Pa---
ebs.psmaxnumberEBS pneumatic supply max Pa---
ebs.rlap1stringEBS RGE21 lift axle position 1---
ebs.rlap2stringEBS RGE21 lift axle position 2---
ebs.vvdnumberEBS VHDR vehicle distance in meters---
Examples of payload (generated)
{
  "id": "string",
  "cid": "string",
  "esn": "string",
  "aid": "string",
  "an": "string",
  "amk": "string",
  "amd": "string",
  "at": "string",
  "edt": 0,
  "ngps": 0,
  "hdop": 0.1,
  "eca": "string",
  "eco": "string",
  "es": "string",
  "dk": "string",
  "pid": "string",
  "pn": "string",
  "opid": "string",
  "pidebdk": true,
  "phnid": "string",
  "php": "string",
  "ar": "string",
  "ahnid": "string",
  "ahp": "string",
  "ahnn": "string",
  "aslk": 0.1,
  "dd": 0.1,
  "sk": 0.1,
  "ds": 0,
  "dkms": 0.1,
  "tripKm": 0.1,
  "sid": 0,
  "pri": true,
  "hj": true,
  "syn": true,
  "cti": 0,
  "lmt": 0,
  "ot": "GPS",
  "coord.long": 0.1,
  "coord.lat": 0.1,
  "ad.fa": "string",
  "ad.rd": "string",
  "ad.rn": "string",
  "ad.cty": "string",
  "ad.pc": "string",
  "ad.ctry": "string",
  "ad.rsk": 0.1,
  "ad.rt": "string",
  "ad.slt": "string",
  "ad.cic": "string",
  "ad.dv": "string",
  "ad.sdv": "string",
  "ad.dvic": "string",
  "ad.sdvic": "string",
  "carc": 0,
  "capts": 0,
  "caits": 0,
  "cafu": 0.1,
  "cadkm": 0.1,
  "fcl": 0.1,
  "cty": "string",
  "co": 0.1,
  "cc": "string",
  "bl": 0.1,
  "ath": 0.1,
  "eth": 0.1,
  "erpm": 0,
  "fll": 0.1,
  "flp": 0.1,
  "evrk": 0.1,
  "evrke": true,
  "evsocp": 0.1,
  "evsocpe": true,
  "ecrm": 0,
  "ecm": "string",
  "is": "string",
  "bv": 0.1,
  "epv": 0.1,
  "ps": "string",
  "emv": 0.1,
  "eds": 0,
  "pl": [
    {
      "id": "string",
      "nm": "string",
      "plcid": "string",
      "plcnm": "string"
    }
  ],
  "in.id": "string",
  "in.tm": 0,
  "in.ty": "string",
  "in.v": "string",
  "ins": [
    {
      "id": "string",
      "tm": 0,
      "ty": "string",
      "v": "string"
    }
  ],
  "iet": "string",
  "ch": [
    {
      "chit": "string",
      "chiv": "string",
      "chicv": "string",
      "chilut": 0,
      "chicat": "string",
      "chisnp": "string"
    }
  ],
  "dfs": [
    {
      "dfty": "string",
      "dfco": "string",
      "dfst": "string",
      "dfedt": 0,
      "dfde": "string"
    }
  ],
  "enrg": {},
  "pft": "string",
  "pfc": 0.1,
  "pac": 0.1,
  "parkm": 0.1,
  "sft": "string",
  "sfc": 0.1,
  "sac": 0.1,
  "sarkm": 0.1,
  "tags": [
    "string"
  ],
  "aft": [
    "string"
  ],
  "ipids": [
    "string"
  ],
  "iptags": [
    "string"
  ],
  "bt": [
    "string"
  ],
  "psr": {},
  "dim": true,
  "lan": "string",
  "laid": "string",
  "lar": "string",
  "deid": "string",
  "ta.td": 0,
  "ta.vid": "string",
  "ta.vrn": "string",
  "ta.hrtvd": 0.1,
  "ta.mv": "string",
  "ta.ims": "string",
  "ta.cdid": "string",
  "ta.ca": "string",
  "ta.lto": 0,
  "ta.oosc": "string",
  "ta.cdn": "string",
  "ta.catts": 0,
  "ta.trs": "string",
  "ta.cdts": 0,
  "ta.ddts": 0,
  "ta.wdts": 0,
  "ta.pctdts": 0,
  "ta.rdts": 0,
  "ta.rddts": 0,
  "ta.rwdts": 0,
  "ta.tlundrs": 0,
  "ta.ndrmds": 0,
  "ta.tlunwrs": 0,
  "ta.nwrmds": 0,
  "ta.ldre": 0,
  "ta.lwre": 0,
  "ta.rdedtp": 0,
  "ta.rdsrtp": 0,
  "ta.wtslbs": 0,
  "ta.rwts": 0,
  "ta.dwts": 0,
  "ta.rdwts": 0,
  "ta.wwts": 0,
  "ta.rwwts": 0,
  "ta.dbts": 0,
  "ta.dp": "string",
  "ta.wp": "string",
  "ta.dced": 0,
  "ta.dcnmdd": 0,
  "ta.tlunrps": 0,
  "ta.nrds": 0,
  "ta.dci": true,
  "ta.vis": "string",
  "ta.vs": 0.1,
  "ta.es": 0.1,
  "ta.rcpws": 0,
  "ta.rcspws": 0,
  "ta.rctpws": 0,
  "ta.rtocrs": 0,
  "ta.docrs": 0,
  "ta.tut": "string",
  "ta.ds": "string",
  "ta.rms": "string",
  "ta.odid": "string",
  "ta.oims": "string",
  "tpms.t": "string",
  "tpms.dp": "string",
  "tpms.rec": {
    "mac": "string",
    "lrt": 0
  },
  "tpms.reps": [
    {
      "mac": "string",
      "lrt": 0
    }
  ],
  "tpms.sens": [
    {
      "i": 0,
      "s": "string",
      "mac": "string",
      "p": "string",
      "a": 0,
      "as": "string",
      "wp": "string",
      "ppa": 0,
      "tc": 0,
      "ls": "string",
      "lrt": 0
    }
  ],
  "ebs.aatgt": 0,
  "ebs.blt": 0,
  "ebs.sbdmin": 0,
  "ebs.sbdmax": 0,
  "ebs.sbdmean": 0,
  "ebs.vatgt": 0,
  "ebs.rst": 0,
  "ebs.yst": 0,
  "ebs.aot": 0,
  "ebs.wbstgmin": 0,
  "ebs.wbstgmax": 0,
  "ebs.wbstgmean": 0,
  "ebs.aatdt": 0,
  "ebs.sbt": 0,
  "ebs.atvbt": 0,
  "ebs.vatdt": 0,
  "ebs.lamin": 0,
  "ebs.lamax": 0,
  "ebs.lamean": 0,
  "ebs.wbstdmin": 0,
  "ebs.wbstdmax": 0,
  "ebs.wbstdmean": 0,
  "ebs.alsmin": 0,
  "ebs.alsmax": 0,
  "ebs.alsmean": 0,
  "ebs.vest": 0,
  "ebs.rwst": 0,
  "ebs.awst": 0,
  "ebs.lrt": 0,
  "ebs.slbt": 0,
  "ebs.blgt": 0,
  "ebs.btst": 0,
  "ebs.vpst": 0,
  "ebs.blmin": 0,
  "ebs.blmax": 0,
  "ebs.blmean": 0,
  "ebs.btmin": 0,
  "ebs.btmax": 0,
  "ebs.btmean": 0,
  "ebs.psmin": 0,
  "ebs.psmax": 0,
  "ebs.rlap1": "string",
  "ebs.rlap2": "string",
  "ebs.vvd": 0
}

Download AsyncAPI Specification

Tracking Events AsyncAPI Specification