Changes for page positions/get_fms_data.php

Last modified by YellowFox_RD on 2025/11/27 08:21

From 2.1 to 3.1

From version 1.1

edited by YellowFox_RD
on 2025/11/10 08:17

Change comment: There is no comment for this version

To version 2.1

edited by YellowFox_RD
on 2025/11/10 08:40

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -1,8 +1,5 @@
  {{toc/}}
--Gibt die FMS Daten eines Fahrzeuges oder einer Fahrzeuggruppe zurück.
--Wird keine Zeitraumsbegrenzung mitgegeben, wird der aktuellste Datensatz pro Fahrzeug zurück geliefert.
--
  Returns the FMS values of a vehicle or vehicle group.
  If no given date range, the most recent data per vehicle will be returned.
@@ -15,41 +15,46 @@
  |=Parameter|=Description|=Type|=Hint|=Mandatory
  |company|RTI company key|string| |yes
--|vehicle|RTI vehicle key|string|(% colspan="1" rowspan="3" %)Es muss entweder vehicle, group oder import angegeben werden.|(yes)
++|vehicle|RTI vehicle key|string|(% colspan="1" rowspan="3" %)You need to set one of vehicle, group or import.|(yes)
  |group|RTI group key|string|(yes)
  |import|RTI import key|string|(yes)
--|start|Anfang des Abfragezeitraum|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|no
--|end|Ende des Abfragezeitraum|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|no
--|query_date|Datum zu welchen Zeitpunkt die jeweilige Position angezeigt werden soll|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|no
--|offset|Die Anfrage liefert maximal 5000 Datensätze zurück. Durch ein Offset können Sie den nächsten Block anfragen.|int| |no
++|start|Start of query date range|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|no
++|end|End of query date range|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|no
++|query_date|(((
++Date of dataset
++)))|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|no
++|offset|This query will return 5000 entries at max. Use an offset to get the next block.|int| |no
  {{info}}
--**Hinweis zur Datumseingrenzung**
--Sie können 3 verschiedene Modi nutzen:
--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)
--b) Sie geben nur query_date an und erhalten damit pro Fahrzeug die zu diesem Zeitpunkt aktuellste Meldung
--c) Sie geben keinen Datumsparameter an und erhalten damit die derzeit aktuellste Position pro Fahrzeug
++**Note on date restrictions**
++You can use 3 different modes:
++a) You specify start and end and receive all positions within this time period (these two times may be no more than 24 hours apart)
++b) You only specify query_date and receive the most recent report for each vehicle at that time
++c) You do not specify a date parameter and receive the most recent position for each vehicle
--
--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.
++We recommend keeping the number of vehicles as low as possible in order to shorten the execution time, especially when querying historical data.
  {{/info}}
  = Return value =
--Es wird ein **string** zurückgegeben. Im Fehlerfall wird "**ERROR:Beschreibung**" zurückgegeben.
++A **string** will be returned. On error "**ERROR:Description**" will be returned.
  == Field description ==
--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.
++This functions result builds dynamically. It will only return fms values which are available for at least one of your requested vehicles. This means you might not get all documented result keys. Which FMS values are available, depends on your vehicle, the type of installed telematic box and the booked tariff. If you are missing a value, please contact our support.
--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.
++FMS values are transmitted cyclically by the vehicle in a collected message.
++You can use this function to query these messages. Some values may not be present in every message. If you query historical data (i.e., you have entered a specific date), data records may therefore also contain NULL values. If you query without a date, you will receive the current status of the vehicles. Here you will receive the latest known value for each FMS value. However, the individual values may be of different ages. Therefore, the return value of this function contains a separate timestamp for each individual FMS value.
++
  === Header ===
--|=Feld|=Beschreibung
--|_date|Gesetzte Datumseinschränkung
--|_links|Sollte Ihre Anfrage das Limit übersteigen, finden Sie hier einen Link zum nächsten Teil der Ergebnismenge.
--|has_more|Flag ob es noch mehr Daten zu holen gibt.
++|=Field|=Description
++|_date|set date restriction
++|_links|(((
++If the query result exceeds the data limit, this is the link to next part of result.
++)))
++|has_more|Flag if there is more data
  === Items ===
@@ -59,185 +59,195 @@
  (% style="background-color:#ffffff" %)
--|=Feld|=Beschreibung
++|=Field|=Description
  |unit|Fahrzeug mit Kennzeichen und RTI Ident
  ==== FMS values ====
--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.
++FMS values are always an object of value and gpsDate. They both might be NULL if the vehicle does not support or send a value.
--|=Feld|=Beschreibung
++|=Field|=Description
  |(((
  acceleratorPedalPosition
--)))|Gaspedalposition in Prozent
++)))|accelerator pedal positions in percent
  |(((
  adblueLevel
--)))|AdBlue Füllstand in Prozent
++)))|AdBlue level in percent
  |(((
  ambientAirTemperature
--)))|Außentemperatur in °C
++)))|ambient air temperature in °C
  |(((
  atLeastOnePtoActive
--)))|Ist wenigstens ein Nebenantrieb aktiv?
++)))|Is at least one auxiliary drive active?
  |(((
  axleWeight
--)))|Achslast
++)))|axle weight
  |(((
  brakeSwitch
--)))|Bremse betätigt seit der letzten Meldung
++)))|Brake applied since last report
  |(((
  clutchSwitch
--)))|Kupplung betätigt seit der letzten Meldung
++)))|Clutch applied since last report
  |(((
  cruiseControlActive
--)))|Ist der Tempomat an?
++)))|Is cruise control active?
  |(((
  directionIndicator
--)))|Richtung des Fahrzeuges
++)))|direction of vehicle
  |(((
  engineCoolantTemp
--)))|Temperatur Motor in °C
++)))|engine temperature in °C
  |(((
  enginePercentLoad
--)))|Motordrehmoment in Prozent
++)))|engine torque in percent
  |(((
  enginePercentTorque
--)))|Drehmoment
++)))|engine torque
  |(((
  engineSpeed
--)))|Motorumdrehungen
++)))|engine speed
  |(((
  fuelLevel1
--)))|Tankfüllstand 1 in Prozent
++)))|fuel level 1 in percent
  |(((
  fuelLevel2
--)))|Tankfüllstand 2 in Prozent
++)))|fuel level 2 in percent
  |(((
  fuelLiter
  )))|(((
--Tankinhalt in Litern
++fuel level in liter
  )))
  |(((
  fuelRate
--)))|Kraftstoffverbauch pro Stunde
++)))|fuel consumption per hour
  |(((
  instantaneousFuelEconomy
--)))|Kraftstoffverbrauch in Kilometern pro Liter
++)))|fuel consumption in kilometres per liter
  |(((
  overspeed
--)))|Übergeschwindigkeitswarnung
++)))|overspeed warning
  |(((
  ptoState
--)))|Status Nebenantrieb
++)))|Status of auxiliary drive
  |(((
  serviceBrakeAirPressure1
--)))|Luftdruck Betriebsbremse 1
++)))|air pressure service brake 1
  |(((
  serviceBrakeAirPressure2
--)))|Luftdruck Betriebsbremse 2
++)))|air pressure service brake 2
  |(((
  serviceDistanceKm
--)))|Kilometer bis zum nächsten Service
++)))|kilometres till next service
  |(((
  serviceIntervalDays
--)))|Tage bis zum nächsten Service
++)))|days till next service
  |(((
  serviceIntervalKm
--)))|Kilometerintervall Service
++)))|kilometre interval service
  |(((
  tachoUnitSpeed
--)))|Geschwindigkeit
++)))|speed
  |(((
  totalEngineHours
--)))|Gesamtlaufleistung
++)))|total engine hours
  |(((
  totalFuelUsed
--)))|Gesamtmenge des verbauchten Treibstoffs in Litern
++)))|total used fuel in liter
  |(((
  totalGasUsed
--)))|Gesamtmenge des verbrauchten Gas
++)))|total used gas
  |(((
  vehicleDistance
--)))|Gesamtmenge der zurückgelegten Kilometer
++)))|total milage
  |(((
  vehicleMotionDetect
--)))|Ist das Fahrzeug in Bewegung?
++)))|Is the vehicle moving?
--==== Werte ECT Pumpen ====
++==== Values ECT pumps ====
--|=Feld|=Beschreibung
++|=Field|=Description
  |(((
  ectAvgCellTemperature
--)))|Durchschnittliche Zelltemperatur
++)))|average cell temperature
  |(((
  ectAvgCellVoltage
--)))|Durchschnittliche Zellspannung
++)))|average cell voltage
  |(((
  ectBatteryManagementAmperage
--)))|Stromaufnahme/-abgabe des BMS
++)))|Current consumption/output of the BMS
  |(((
  ectErrorCodeCount
--)))|Anzahl der Fehlercodes
++)))|number of errors
  |(((
  ectGeneratorActiveDuration
--)))|Dauer des Active-Status des Generators
++)))|duration active state of generator
  |(((
  ectGeneratorControllerTemperature
--)))|Temperatur des Generator-Controllers
++)))|temperature generator controller
  |(((
  ectGeneratorRuntime
--)))|Laufzeit des Generators
++)))|runtime generator
  |(((
  ectGeneratorTemperature
--)))|Temperatur des Generators
++)))|temperature generator
  |(((
  ectHighPressurePumpControllerTemperature
--)))|Temperatur des Controllers der Hochdruckpumpe
++)))|(((
++temperature high pressure pump controller
++)))
  |(((
  ectHighPressurePumpDuration
--)))|Dauer des Active-Status der Hochdruckpumpe
++)))|(((
++duration active state of high pressure pump
++)))
  |(((
  ectHighPressurePumpEngineTemperature
--)))|Temperatur des Hochdruckpumpenmotors
++)))|(((
++temperature high pressure pump engine
++)))
  |(((
  ectHighPressurePumpRuntime
--)))|Laufzeit der Hochdruckpumpe
++)))|runtime high pressure pump
  |(((
  ectHighestCellTemperature
--)))|Höchste Zelltemperatur
++)))|highest cell temperature
  |(((
  ectHighestCellVoltage
--)))|Höchste Zellspannung
++)))|highest cell voltage
  |(((
  ectLastErrorCode
--)))|Letzter Fehlercode
++)))|last error code
  |(((
  ectLowestCellTemperature
--)))|Niedrigste Zelltemperatur
++)))|lowest cell temperature
  |(((
  ectLowestCellVoltage
--)))|Niedrigste Zellspannung
++)))|lowest cell voltage
  |(((
  ectPumpSystemReadyDuration
--)))|Dauer des Ready-Status des Pumpensystems
++)))|(((
++duration ready state of pump system
++)))
  |(((
  ectStateOfCharge
--)))|Ladezustand des Akkus
++)))|state of charge
  |(((
  ectTotalBatteryVoltage
--)))|Gesamtspannung des Akkus
++)))|total battery voltage
  |(((
  ectVacuumPumpControllerTemperature
--)))|Temperatur des Controllers der Vakuumpumpe
++)))|temperature vacuum pump controller
  |(((
  ectVacuumPumpDuration
--)))|Dauer des Active-Status der Vakuumpumpe
++)))|(((
++duration active state of vacuum pump
++)))
  |(((
  ectVacuumPumpEngineTemperature
--)))|Temperatur des Vakuumpumpenmotors
++)))|temperature vacuum pump engine
  |(((
  ectVacuumPumpRuntime
--)))|Laufzeit der Vakuumpumpe
++)))|vacuum pump runtime
  == JSON ==
@@ -330,13 +330,13 @@
  ]}
  {{/code}}
--= Beispielaufrufe =
++= Example cals =
--**Abfrage Zeitraum für eine Gruppe**
++**Date range for a group**
  {{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}}
--**Abfrage fester Zeitpunkt für ein Fahrzeug**
++**Query date for vehicle**
  {{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}}
--**Abfrage jetziger Zeitpunkt für ein Fahrzeug mit RTI Ident**
++**Latest data for vehicle by RTI Ident**
  {{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}}