Zum Inhalt springen

Wiki-Quellcode von positions/get_fms_data.php

Version 8.1 von YellowFox_RD am 2025/11/27 07:59
Zeige letzte Bearbeiter
1 Inhaltsverzeichnis
2
3 {{toc/}}
4
5 Gibt die FMS Daten eines Fahrzeuges oder einer Fahrzeuggruppe zurück.
6 Wird keine Zeitraumsbegrenzung mitgegeben, wird der aktuellste Datensatz pro Fahrzeug zurück geliefert.
7
8 = Beschreibung =
9
10 (% class="green mark" %)**GET**(%%)** ** positions/get_fms_data.php?company**=//COMPANY_RTIKEY//**&vehicle**=//VEHICLE_RTIKEY//**&start**=//YYYY-MM-DDTHH:MM:SS+HH:mm//**//&end//**=//YYYY-MM-DDTHH:MM:SS+HH:mm//**
11
12 = Parameter =
13
14 |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
15 |company|RTI Firmenschlüssel|string| |ja
16 |vehicle|RTI Fahrzeugschlüssel|string|(% colspan="1" rowspan="3" %)Es muss entweder vehicle, group oder import angegeben werden.| (ja)
17 |group|RTI Gruppenschlüssel|string| (ja)
18 |import|RTI Importschlüssel|string|(ja)
19 |start|Anfang des Abfragezeitraum|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|nein
20 |end|Ende des Abfragezeitraum|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|nein
21 |query_date|Datum zu welchen Zeitpunkt die jeweilige Position angezeigt werden soll|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|nein
22 |offset|Die Anfrage liefert maximal 5000 Datensätze zurück. Durch ein Offset können Sie den nächsten Block anfragen.|int| |nein
23
24 {{info}}
25 **Hinweis zur Datumseingrenzung**
26 Sie können 3 verschiedene Modi nutzen:
27 a) Sie geben start und end an und erhalten damit alle Positionen innerhalb dieser Zeitspanne (diese beiden Zeitangaben dürfen maximal 24 Stunden auseinander liegen)
28 b) Sie geben nur query_date an und erhalten damit pro Fahrzeug die zu diesem Zeitpunkt aktuellste Meldung
29 c) Sie geben keinen Datumsparameter an und erhalten damit die derzeit aktuellste Position pro Fahrzeug
30
31
32 Wir empfehlen zu Gunsten einer verkürzten Ausfrührungszeit ins besondere bei der Abfrage historischer Daten die Anzahl der Fahrzeuge möglichst gering zu halten.
33 {{/info}}
34
35 = Rückgabe =
36
37 Es wird ein **string** zurückgegeben. Im Fehlerfall wird "**ERROR:Beschreibung**" zurückgegeben.
38
39 == Feldbeschreibung ==
40
41 Diese Funktion setzt sich dynamisch zusammen. Sie gibt nur die FMS Werte zurück, die für mindestens eines Ihrer abgefragten Fahrzeuge existieren. Das bedeutet, dass möglicherweise nicht alle dokumentierten Schlüssel in Ihrer Rückgabe vorhanden sind. Welche FMS Werte für Sie verfügbar sind, hängt an Ihrem Fahrzeug, der Art der eingebauten Telematikbox und Ihrem gebuchten Fahrzeugtarif. Sollten Sie einen Wert für Ihr Fahrzeug vermissen, kontaktieren Sie gern unseren Support.
42
43 FMS Werte werden zyklisch vom Fahrzeug in einer gesammelten Meldung übertragen. Diese Meldungen können Sie mit dieser Funktion abfragen. Bei einigen Werten kann es vorkommen, dass diese nicht in jeder Meldung vorhanden sind. Wenn Sie historische Daten abfragen (d.h. Sie haben ein konkretes Datum übergeben) können Datensätze daher auch NULL Werte enthalten. Wenn Sie ohne Datum anfragen erhalten Sie den aktuellen Stand der Fahrzeuge. Hier erhalten Sie pro FMS Wert den aktuellsten bekannten Wert. Die einzelnen Werte sind aber möglicherweise unterschiedlich alt. Daher enthält die Rückgabe dieser Funktion für jeden einzelnen FMS Wert einen eigenen Zeitstempel.
44
45 === Kopfdaten ===
46
47 |=Feld|=Beschreibung
48 |_date|Gesetzte Datumseinschränkung
49 |_links|Sollte Ihre Anfrage das Limit übersteigen, finden Sie hier einen Link zum nächsten Teil der Ergebnismenge.
50 |has_more|Flag ob es noch mehr Daten zu holen gibt.
51
52 === Items ===
53
54 ==== Statische Werte ====
55
56 Diese Felder sind immer enthalten.
57
58
59 |=Feld|=Beschreibung
60 |unit|Fahrzeug mit Kennzeichen und RTI Ident
61
62 ==== FMS Werte ====
63
64 FMS Werte sind immer ein Objekt aus value und gpsDate. Value und gpsDate können jedoch NULL sein wenn das Fahrzeug diesen Wert nicht unterstützt oder nicht sendet. Bei den Werten handelt es sich um Rohdaten aus der offiziellen FMS Schnittstelle. Es kann daher nötig sein, die Werte nach Abruf zu interpretieren und zu formatieren.
65
66 |=Feld|=Beschreibung
67 |(((
68 acceleratorPedalPosition
69 )))|Gaspedalposition in Prozent
70 |(((
71 adblueLevel
72 )))|AdBlue Füllstand in Prozent
73 |(((
74 ambientAirTemperature
75 )))|Außentemperatur in °C
76 |(((
77 atLeastOnePtoActive
78 )))|Ist wenigstens ein Nebenantrieb aktiv?
79 |(((
80 axleWeight
81 )))|Achslast
82 |(((
83 brakeSwitch
84 )))|Bremse betätigt seit der letzten Meldung
85 |(((
86 clutchSwitch
87 )))|Kupplung betätigt seit der letzten Meldung
88 |(((
89 cruiseControlActive
90 )))|Ist der Tempomat an?
91 |(((
92 directionIndicator
93 )))|Richtung des Fahrzeuges
94 |(((
95 engineCoolantTemp
96 )))|Temperatur Motor in °C
97 |(((
98 enginePercentLoad
99 )))|Motordrehmoment in Prozent
100 |(((
101 enginePercentTorque
102 )))|Drehmoment
103 |(((
104 engineSpeed
105 )))|Motorumdrehungen
106 |(((
107 fuelLevel1
108 )))|Tankfüllstand 1 in Prozent
109 |(((
110 fuelLevel2
111 )))|Tankfüllstand 2 in Prozent
112 |(((
113 fuelLiter
114 )))|(((
115 Tankinhalt in Litern
116 )))
117 |(((
118 fuelRate
119 )))|Kraftstoffverbauch pro Stunde
120 |(((
121 instantaneousFuelEconomy
122 )))|Kraftstoffverbrauch in Kilometern pro Liter
123 |(((
124 overspeed
125 )))|Übergeschwindigkeitswarnung
126 |(((
127 ptoState
128 )))|Status Nebenantrieb
129 |(((
130 serviceBrakeAirPressure1
131 )))|Luftdruck Betriebsbremse 1
132 |(((
133 serviceBrakeAirPressure2
134 )))|Luftdruck Betriebsbremse 2
135 |(((
136 serviceDistanceKm
137 )))|Kilometer bis zum nächsten Service
138 |(((
139 serviceIntervalDays
140 )))|Tage bis zum nächsten Service
141 |(((
142 serviceIntervalKm
143 )))|Kilometerintervall Service
144 |(((
145 tachoUnitSpeed
146 )))|Geschwindigkeit
147 |(((
148 totalEngineHours
149 )))|Gesamtlaufleistung
150 |(((
151 totalFuelUsed
152 )))|Gesamtmenge des verbauchten Treibstoffs in Litern
153 |(((
154 totalGasUsed
155 )))|Gesamtmenge des verbrauchten Gas
156 |(((
157 vehicleDistance
158 )))|Gesamtmenge der zurückgelegten Kilometer
159 |(((
160 vehicleMotionDetect
161 )))|Ist das Fahrzeug in Bewegung?
162 |(((
163 ignitionStatus
164 )))|Ist di Zündung an?
165 |(((
166 batteryVoltage
167 )))|(((
168 Batteriespannung in Volt
169 )))
170 |(((
171 batteryWarning
172 )))|Gibt es eine Batteriewarnung?
173 |(((
174 batteryStatus
175 )))|Batteriestatus
176 |(((
177 drivingEcoScoreFreewheel
178 )))|Eco-Score im Freilauf in Prozent
179 |(((
180 drivingEcoScoreConstancy
181 )))|Eco-Score Beständigkeit in Prozent
182 |(((
183 drivingEcoScoreBonusRange
184 )))|Eco-Score Bonusdistanz in Prozent
185 |(((
186 drivingEcoScoreAcceleration
187 )))|Eco-Score Beschleunigung in Prozent
188 |(((
189 drivingConsumptionElectricalSinceReset
190 )))|E-Verbrauch ab Reset in kWh/100km
191 |(((
192 drivingConsumptionElectricalSinceStart
193 )))|E-Verbrauch ab Start in kWh/100km
194 |(((
195 drivingConsumptionFuelSinceReset
196 )))|Kraftstoffverbrauch seit Reset in l/100km
197 |(((
198 drivingRangeElectrical
199 )))|E-Reichweite in km
200 |(((
201 drivingRangeElectricalMax
202 )))|Maximale E-Reichweite in km
203 |(((
204 drivingRangeFuel
205 )))|Kraftstoffreichweite in km
206 |(((
207 fuelLevelWarning
208 )))|Gibt es eine Kraftstoffstand Warnung?
209 |(((
210 drivingRangeAdblue
211 )))|AdBlue Reichweite in km
212 |(((
213 drivingConsumptionFuelSinceStart
214 )))|Kraftstoffverbrauch seit Start in l/100km
215 |(((
216 drivingRangeFuelWarning
217 )))|Gibt es eine Warnung bezüglich der Reichweite mit Kraftstoff?
218 |(((
219 brakeFluidWarning
220 )))|Gibt es eine Warnung bezüglich der Bremsflüssigkeit?
221 |(((
222 washWaterLevelWarning
223 )))|Gibt es eine Warnung bezüglich des Wischwassers?
224 |(((
225 brakePadsWarning
226 )))|Gibt es eine Warnung bezüglich des Bremsbelags?
227 |(((
228 engineCoolantWarning
229 )))|Gibt es eine Warnung bezüglich des Kühlwassers?
230 |(((
231 brakePadsPrewarning
232 )))|Gibt es eine Vorwarnung bezüglich des Bremsbelags?
233 |(((
234 engineLimpModeActive
235 )))|Gibt es eine Warnung bezüglich des Motors?
236 |(((
237 engineOilLevel
238 )))|Füllstand Motoröl in Prozent
239 |(((
240 engineOilLevelWarning
241 )))|Gibt es eine Warnung bezüglich des Motoröls?
242 |(((
243 drivingDistanceZeroEmissionsSinceReset
244 )))|Emissionsfrei zurückgelegte Kilometer seit Reset
245 |(((
246 drivingDistanceZeroEmissionsSinceStart
247 )))|Emissionsfrei zurückgelegte Kilometer seit Start
248 |(((
249 drivingTimeSinceStart
250 )))|Fahrzeit seit Start in Minuten
251 |(((
252 drivingDistanceElectricalSinceReset
253 )))|Elektrisch zurückgelegte Kilometer seit Reset
254 |(((
255 drivingDistanceElectricalSinceStart
256 )))|Elektrisch zurückgelegte Kilometer seit Start
257 |(((
258 drivingDistanceFuelSinceReset
259 )))|Durch Kraftstoff zurückgelegte Kilometer seit Reset
260 |(((
261 drivingDistanceFuelSinceStart
262 )))|Durch Kraftstoff zurückgelegte Kilometer seit Start
263 |(((
264 parkingBrakeIsEngaged
265 )))|Ist die Parkbremse aktiviert?
266 |(((
267 lightsInteriorFrontOn
268 )))|Ist das Innenraumlicht vorne an?
269 |(((
270 lightsInteriorReadingLampFrontLeftOn
271 )))|Ist die Leselampe vorne links an?
272 |(((
273 lightsInteriorReadingLampFrontRightOn
274 )))|Ist die Leselampe vorne rechts an?
275 |(((
276 lightsInteriorRearOn
277 )))|Ist das Innenraumlicht hinten an?
278 |(((
279 lightsLightSwitchStatus
280 )))|Lichtmodus
281 |(((
282 electricalDriveChargingActive
283 )))|Ist ein Ladevorgang für den elektrischen Antrieb aktiv?
284 |(((
285 electricalDriveChargingPower
286 )))|E-Ladestrom in kW
287 |(((
288 electricalDriveChargingStatus
289 )))|E-Ladestatus
290 |(((
291 highVoltageBatteryStateOfCharge
292 )))|E-Ladestand in Prozent
293 |(((
294 drivingStateOfChargeDeparture
295 )))|E-Ladestand bei Abfahrt in Prozent
296 |(((
297 electricalDriveChargingEndOfChargingTime
298 )))|E-Ladedauer in Minuten
299 |(((
300 chargingEndOfChargingTimeWeekday
301 )))|E-Laden bis
302 |(((
303 chargingSmartChargingStatus
304 )))|Status Smart-Charging
305 |(((
306 batteryChargeLevel
307 )))|Ladestatus Batterie in Prozent
308 |(((
309 drivingElectrical
310 )))|Fährt das Fahrzeug aktuell elektrisch?
311 |(((
312 batteryPowerConsumptionTotal
313 )))|Gesamt-E-Verbrauch in kWh
314 |(((
315 batteryPowerRecupTotal
316 )))|E-Power durch Rückkopplung in kWh
317 |(((
318 batteryPowerUsed
319 )))|Verbrauch Batterie in kW
320 |(((
321 tyrePressureIso
322 )))|(((
323 Reifendruck gemäß ISO 11992
324
325 Diese Norm stellt die Reifen in einem Koordinatensystem dar. Der Schlüssel des Ergebnisobjektes ist die Koordinate dieses Reifens.
326
327 Beispiel:
328
329 {
330
331 "17": { "gpsDate": [...], "value": 4.3},
332
333 "29": { "gpsDate": [...], "value": 4.2},
334
335 [...]
336
337 }
338 )))
339 |mainPowerVoltage|Hauptspannung in Volt
340
341 ==== Fenster und Türen ====
342
343 (% style="width:620px" %)
344 |=(% style="width: 270px;" %)Feld|=(% style="width: 347px;" %)Beschreibung
345 |(% style="width:270px" %)(((
346 windowsFrontLeftOpen
347 )))|(% style="width:347px" %)Ist das Fenster vorne links offen?
348 |(% style="width:270px" %)(((
349 windowsFrontRightOpen
350 )))|(% style="width:347px" %)Ist das Fenster vorne rechts offen?
351 |(% style="width:270px" %)(((
352 windowsRearLeftOpen
353 )))|(% style="width:347px" %)Ist das Fenster hinten links offen?
354 |(% style="width:270px" %)(((
355 windowsRearRightOpen
356 )))|(% style="width:347px" %)Ist das Fenster hinten rechts offen?
357 |(% style="width:270px" %)(((
358 doorsFrontLeftLocked
359 )))|(% style="width:347px" %)Ist die Tür vorne links abgesperrt?
360 |(% style="width:270px" %)(((
361 doorsFrontLeftOpen
362 )))|(% style="width:347px" %)Ist die Tür vorne links offen?
363 |(% style="width:270px" %)(((
364 doorsFrontRightLocked
365 )))|(% style="width:347px" %)Ist die Tür vorne rechts abgesperrt?
366 |(% style="width:270px" %)(((
367 doorsFrontRightOpen
368 )))|(% style="width:347px" %)Ist die Tür vorne rechts offen?
369 |(% style="width:270px" %)(((
370 doorsRearLeftLocked
371 )))|(% style="width:347px" %)Ist die Tür hinten links abgesperrt?
372 |(% style="width:270px" %)(((
373 doorsRearLeftOpen
374 )))|(% style="width:347px" %)Ist die Tür hinten links offen?
375 |(% style="width:270px" %)(((
376 doorsRearRightLocked
377 )))|(% style="width:347px" %)Ist die Tür hinten rechts abgesperrt?
378 |(% style="width:270px" %)(((
379 doorsRearRightOpen
380 )))|(% style="width:347px" %)Ist die Tür hinten rechts offen?
381 |(% style="width:270px" %)(((
382 doorsTrunkLocked
383 )))|(% style="width:347px" %)Ist der Kofferraum abgesperrt?
384 |(% style="width:270px" %)(((
385 doorsTrunkOpen
386 )))|(% style="width:347px" %)Ist der Kofferraum offen?
387 |(% style="width:270px" %)(((
388 doorsSunroofStatus
389 )))|(% style="width:347px" %)Status Schiebedach
390 |(% style="width:270px" %)(((
391 doorsTankCapOpen
392 )))|(% style="width:347px" %)Ist der Tankdeckel offen?
393 |(% style="width:270px" %)(((
394 doorsVehicleLocked
395 )))|(% style="width:347px" %)Sind die Türen abgesperrt?
396
397 ==== Werte EBS ====
398
399 (% style="width:568px" %)
400 |=(% style="width: 273px;" %)(((
401 Feld
402 )))|=(% style="width: 294px;" %)(((
403 Beschreibung
404 )))
405 |(% style="width:273px" %)(((
406 ebsAxleLoadSum
407 )))|(% style="width:294px" %)Achslast Summe in kg
408 |(% style="width:273px" %)(((
409 ebsLoaded
410 )))|(% style="width:294px" %)Handelt es sich um eine Leerfahrt?
411 |(% style="width:273px" %)(((
412 ebsRedWarningSignal
413 )))|(% style="width:294px" %)Gibt es ein rotes Warnsignal?
414 |(% style="width:273px" %)(((
415 ebsAmberSignal
416 )))|(% style="width:294px" %)Gibt es ein gelbes Warnsignal?
417 |(% style="width:273px" %)(((
418 ebsOverload
419 )))|(% style="width:294px" %)Ist das Fahrzeug überladen?
420
421 ==== Werte ECT Pumpen ====
422
423 |=Feld|=Beschreibung
424 |(((
425 ectAvgCellTemperature
426 )))|Durchschnittliche Zelltemperatur
427 |(((
428 ectAvgCellVoltage
429 )))|Durchschnittliche Zellspannung
430 |(((
431 ectBatteryManagementAmperage
432 )))|Stromaufnahme/-abgabe des BMS
433 |(((
434 ectErrorCodeCount
435 )))|Anzahl der Fehlercodes
436 |(((
437 ectGeneratorActiveDuration
438 )))|Dauer des Active-Status des Generators
439 |(((
440 ectGeneratorControllerTemperature
441 )))|Temperatur des Generator-Controllers
442 |(((
443 ectGeneratorRuntime
444 )))|Laufzeit des Generators
445 |(((
446 ectGeneratorTemperature
447 )))|Temperatur des Generators
448 |(((
449 ectHighPressurePumpControllerTemperature
450 )))|Temperatur des Controllers der Hochdruckpumpe
451 |(((
452 ectHighPressurePumpDuration
453 )))|Dauer des Active-Status der Hochdruckpumpe
454 |(((
455 ectHighPressurePumpEngineTemperature
456 )))|Temperatur des Hochdruckpumpenmotors
457 |(((
458 ectHighPressurePumpRuntime
459 )))|Laufzeit der Hochdruckpumpe
460 |(((
461 ectHighestCellTemperature
462 )))|Höchste Zelltemperatur
463 |(((
464 ectHighestCellVoltage
465 )))|Höchste Zellspannung
466 |(((
467 ectLastErrorCode
468 )))|Letzter Fehlercode
469 |(((
470 ectLowestCellTemperature
471 )))|Niedrigste Zelltemperatur
472 |(((
473 ectLowestCellVoltage
474 )))|Niedrigste Zellspannung
475 |(((
476 ectPumpSystemReadyDuration
477 )))|Dauer des Ready-Status des Pumpensystems
478 |(((
479 ectStateOfCharge
480 )))|Ladezustand des Akkus
481 |(((
482 ectTotalBatteryVoltage
483 )))|Gesamtspannung des Akkus
484 |(((
485 ectVacuumPumpControllerTemperature
486 )))|Temperatur des Controllers der Vakuumpumpe
487 |(((
488 ectVacuumPumpDuration
489 )))|Dauer des Active-Status der Vakuumpumpe
490 |(((
491 ectVacuumPumpEngineTemperature
492 )))|Temperatur des Vakuumpumpenmotors
493 |(((
494 ectVacuumPumpRuntime
495 )))|Laufzeit der Vakuumpumpe
496
497 == JSON ==
498
499 {{code language="json"}}
500 {
501 "_date": {
502 "query_date": "2025-11-07T13:07:23+01:00"
503 },
504 "_links": {
505 "next": {
506 "href": null
507 }
508 },
509 "has_more": false,
510 "items": [
511 {
512 "unit": {
513 "licensePlate": "FTL YF 123",
514 "rtiIdent": null
515 },
516 "engineCoolantTemp": {
517 "gpsDate": "2025-11-07T11:55:40+01:00",
518 "value": 79
519 },
520 "totalFuelUsed": {
521 "gpsDate": "2025-11-07T11:55:40+01:00",
522 "value": 44105
523 },
524 "tachoUnitSpeed": {
525 "gpsDate": "2025-11-07T11:55:40+01:00",
526 "value": 0
527 },
528 "cruiseControlActive": {
529 "gpsDate": "2025-11-07T11:55:40+01:00",
530 "value": 0
531 },
532 "vehicleDistance": {
533 "gpsDate": "2025-11-07T11:55:40+01:00",
534 "value": 158169
535 },
536 "fuelLevel1": {
537 "gpsDate": "2025-11-07T11:55:40+01:00",
538 "value": 46
539 },
540 "engineSpeed": {
541 "gpsDate": "2025-11-07T11:55:40+01:00",
542 "value": 598
543 },
544 "ptoState": {
545 "gpsDate": null,
546 "value": null
547 },
548 "vehicleMotionDetect": {
549 "gpsDate": "2025-11-07T11:55:40+01:00",
550 "value": 0
551 },
552 "acceleratorPedalPosition": {
553 "gpsDate": "2025-11-07T11:55:40+01:00",
554 "value": 0
555 },
556 "totalEngineHours": {
557 "gpsDate": "2025-11-07T11:55:40+01:00",
558 "value": 2674
559 },
560 "overspeed": {
561 "gpsDate": "2025-11-07T11:55:40+01:00",
562 "value": 0
563 },
564 "axleWeight": {
565 "gpsDate": "2025-11-07T11:45:33+01:00",
566 "value": 14680
567 },
568 "serviceDistanceKm": {
569 "gpsDate": "2025-11-07T11:55:40+01:00",
570 "value": 136490
571 },
572 "directionIndicator": {
573 "gpsDate": "2025-11-07T11:55:40+01:00",
574 "value": 1
575 },
576 "fuelLevel2": {
577 "gpsDate": null,
578 "value": null
579 },
580 "enginePercentTorque": {
581 "gpsDate": "2025-11-07T11:55:40+01:00",
582 "value": 11
583 }
584 }
585 ]}
586 {{/code}}
587
588 = Beispielaufrufe =
589
590 **Abfrage Zeitraum für eine Gruppe**
591 {{code language="java"}}https://map.yellowfox.de/rti/positions/get_fms_data.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&start=2022-09-22T13:23:00%2B00:00:00&end=2022-09-22T14:23:00%2B00:00:00{{/code}}
592
593 **Abfrage fester Zeitpunkt für ein Fahrzeug**
594 {{code language="java"}}https://map.yellowfox.de/rti/positions/get_fms_data.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&query_date=2022-09-22T13:23:00%2B00:00:00{{/code}}
595
596 **Abfrage jetziger Zeitpunkt für ein Fahrzeug mit RTI Ident**
597 {{code language="java"}}https://map.yellowfox.de/rti/positions/get_fms_data.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}{{/code}}