Skip to Content

Wiki source code of get_fms.php

Last modified by Dominic Lippmann on 2025/01/23 10:33
Show last authors
1 (% class="box" %)
2 (((
3 Table of Contents
4 )))
5
6 {{toc/}}
7
8 Returns FMS data for a vehicle.
9
10 {{warning}}
11 This function is deprecated! Please use the function position/get_fms_data.php instead.
12 {{/warning}}
13
14 = Description =
15
16 (% class="green mark" %)**GET**(%%)** get_fms.php?company**=//COMPANY_RTIKEY//**&vehicle**=//VEHICLE_RTIKEY//**&start**=//YYYYMMDDHHMMSS//**&end**=//YYYYMMDDHHMMSS**&format**=csv//
17
18 = Parameter =
19
20 |=Parameter|=Description|=Type|=Note|=Mandatory
21 |company|RTI company key|string| |yes
22 |vehicle|RTI vehicle key|string| |yes
23 |start|start of interval|datestring|format: YYYYMMDDHHMMSS|no
24 |end|end of interval|datestring|format: YYYYMMDDHHMMSS
25 Max. 24 hours between start and end of interval|no
26 |format|return format|string|csv (standard), xml or json|no
27
28 = Return =
29
30 Return a **string**. In case of error "(% class="error" %)**ERROR:Description**(%%)" will be returned.
31
32 == CSV format ==
33
34 === Meta data ===
35
36 |=Delimiter|semicolon( ; )
37 |=Text delimiter|double quote ( " )
38 |=Line end|0x0D 0x0A (CarriageReturn LineFeed)
39 |=Header|first line
40
41 === Columns ===
42
43 |=Column|=Description|=
44 |VEHICLE|license plate|
45 |DATE|gps date when measurement was created|format: YYYY-MM-DD HH:MM:SS
46 |LAT|latitude|example.: 51.03659
47 |LON|longitude|example.: 13.59967
48 |PTO_STATE|secondary engine on/ off|0 = off, 1 = on
49 |ENGINE_SPEED|engine speed in rpm|
50 |TACHOGRAPH_VEHICLE_SPEED|tachograph speed in km/h|
51 |CLUTCH_SWITCH|clutch usage within measurement interval|
52 |BRAKE_SWITCH|breake usage within measurement interval|
53 |CRUISE_CONTROL_ACTIVE|cruise control on/ off|0 = off, 1 = on
54 |OVERSPEED|overspeed warning on/ off|0 = off, 1 = on
55 |ACCELATOR_PEDAL_POSITION|position of accelator pedal in %|
56 |AXLE_WEIGHT|axle weight in kg|
57 |FUEL_LEVEL|fuel level in %|
58 |ENGINE_COOLANT_TEMP|engin coolant temperature in °C|
59 |TOTAL_FUEL_USED|total fuel used in liter|
60 |TOTAL_ENGINE_HOURS|total engine hours in h|
61 |VEHICLE_DISTANCE|total vehicle distance in km|
62 |RTI_IDENT|RTI Ident|
63 |ADBLUE_LEVEL|AdBlue fuel level in %|
64 |TOTAL_LPG_USED|total LPG(gas) used in kg|
65
66 === Example ===
67
68 == CSV format ==
69
70 **return in csv**
71 {{code language="java"}}"VEHICLE";"DATE";"LAT";"LON";"PTO_STATE";"ENGINE_SPEED";"TACHOGRAPH_VEHICLE_SPEED";"CLUTCH_SWITCH";"BRAKE_SWITCH";"CRUISE_CONTROL_ACTIVE";"OVERSPEED";"ACCELATOR_PEDAL_POSITION";"AXLE_WEIGHT";"FUEL_LEVEL";"ENGINE_COOLANT_TEMP";"TOTAL_FUEL_USED";"TOTAL_ENGINE_HOURS";"VEHICLE_DISTANCE";"RTI_IDENT";"ADBLUE_LEVEL";"TOTAL_LPG_USED"
72 "DD-YF 2015";"2015-10-20 16:58:25";"52.5317";"11.71469";"0";"1093";"17";"11";"2";"0";"0";"44";"0";"98";"82";"89843";"5563";"333941";"Ident1";"81";"4280"{{/code}}
73
74 == XML format ==
75
76 **return in xml**
77 {{code language="java"}}<?xml version="1.0" encoding="ISO-8859-1"?>
78 <!DOCTYPE yf_fms SYSTEM "http://map.yellowfox.de/rti/dtd/yf_fms.dtd">
79 <yf_fms>
80 <ENTRY>
81 <VEHICLE>DD-YF 2015</VEHICLE>
82 <DATE>2015-10-20 16:24:57</DATE>
83 <LAT>52.5718</LAT>
84 <LON>11.21184</LON>
85 <PTO_STATE>0</PTO_STATE>
86 <ENGINE_SPEED>1208</ENGINE_SPEED>
87 <TACHOGRAPH_VEHICLE_SPEED>83</TACHOGRAPH_VEHICLE_SPEED>
88 <CLUTCH_SWITCH>0</CLUTCH_SWITCH>
89 <BRAKE_SWITCH>0</BRAKE_SWITCH>
90 <CRUISE_CONTROL_ACTIVE>1</CRUISE_CONTROL_ACTIVE>
91 <OVERSPEED>0</OVERSPEED>
92 <ACCELATOR_PEDAL_POSITION>0</ACCELATOR_PEDAL_POSITION>
93 <AXLE_WEIGHT>0</AXLE_WEIGHT>
94 <FUEL_LEVEL>100</FUEL_LEVEL>
95 <ENGINE_COOLANT_TEMP>82</ENGINE_COOLANT_TEMP>
96 <TOTAL_FUEL_USED>89833</TOTAL_FUEL_USED>
97 <TOTAL_ENGINE_HOURS>5563</TOTAL_ENGINE_HOURS>
98 <VEHICLE_DISTANCE>333903</VEHICLE_DISTANCE>
99 <RTI_IDENT>Ident1</RTI_IDENT>
100 <ADBLUE_LEVEL>81</ADBLUE_LEVEL>
101 <TOTAL_LPG_USED>4280</TOTAL_LPG_USED>
102     </ENTRY>
103 </yf_fms>{{/code}}
104
105 == JSON format ==
106
107 **return json**
108 {{code language="java"}}[{
109 "VEHICLE":"DD-YF 2015",
110 "DATE":"2015-10-20 16:29:00",
111 "LAT":52.5496,
112 "LON":11.13903,
113 "PTO_STATE":0,
114 "ENGINE_SPEED":1196,
115 "TACHOGRAPH_VEHICLE_SPEED":"83",
116 "CLUTCH_SWITCH":0,
117 "BRAKE_SWITCH":0,
118 "CRUISE_CONTROL_ACTIVE":1,
119 "OVERSPEED":0,
120 "ACCELATOR_PEDAL_POSITION":"0",
121 "AXLE_WEIGHT":"0",
122 "FUEL_LEVEL":"99",
123 "ENGINE_COOLANT_TEMP":"82",
124 "TOTAL_FUEL_USED":"89834",
125 "TOTAL_ENGINE_HOURS":"5563",
126 "VEHICLE_DISTANCE":"333909",
127 "RTI_IDENT":"Ident1",
128 "ADBLUE_LEVEL":"81",
129 "TOTAL_LPG_USED":"4280"
130 }]{{/code}}
131
132 = Example calls =
133
134 **most current FMS data of a vehicle in CSV format**
135 {{code language="java"}}https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY
136
137 https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}{{/code}}
138
139 **FMS data of a vehicle within a certain time range in XML format**
140 {{code language="java"}}https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&start=20210401000000&end=20210401235959&format=xml
141
142 https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&start=20210401000000&end=20210401235959&format=xml{{/code}}
143
144 **FMS data of a vehicle within a certain time range in XML format**
145 {{code language="java"}}https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&start=20210401000000&end=20210401235959&format=json
146
147 https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&start=20210401000000&end=20210401235959&format=json{{/code}}
148