Changes for page get_fms.php

Last modified by YellowFox_RD on 2025/03/12 14:22
From version 1.1
edited by YellowFox_RD
on 2024/12/19 10:11
Change comment: Imported from XAR
To version 4.1
edited by Dominic Lippmann
on 2025/01/23 10:34
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.YellowFox_RD
1 +XWiki.yf-dominic
Content
... ... @@ -1,14 +1,21 @@
1 1  (% class="box" %)
2 -(((Table of Contents)))
2 +(((
3 +Table of Contents
4 +)))
5 +
3 3  {{toc/}}
4 4  
5 5  Returns FMS data for a vehicle.
9 +
6 6  = Description =
7 -**(% class="green mark" %)GET(%%) get_fms.php****?company**=//COMPANY_RTIKEY//**&vehicle**=//VEHICLE_RTIKEY//**&start**=//YYYYMMDDHHMMSS//**&end**=//YYYYMMDDHHMMSS**&format**=csv//
11 +
12 +(% class="green mark" %)**GET**(%%)** get_fms.php?company**=//COMPANY_RTIKEY//**&vehicle**=//VEHICLE_RTIKEY//**&start**=//YYYYMMDDHHMMSS//**&end**=//YYYYMMDDHHMMSS**&format**=csv//
13 +
8 8  = Parameter =
15 +
9 9  |=Parameter|=Description|=Type|=Note|=Mandatory
10 -|company|RTI company key|string||yes
11 -|vehicle|RTI vehicle key|string||yes
17 +|company|RTI company key|string| |yes
18 +|vehicle|RTI vehicle key|string| |yes
12 12  |start|start of interval|datestring|format: YYYYMMDDHHMMSS|no
13 13  |end|end of interval|datestring|format: YYYYMMDDHHMMSS
14 14  Max. 24 hours between start and end of interval|no
... ... @@ -15,9 +15,13 @@
15 15  |format|return format|string|csv (standard), xml or json|no
16 16  
17 17  = Return =
25 +
18 18  Return a **string**. In case of error "(% class="error" %)**ERROR:Description**(%%)" will be returned.
27 +
19 19  == CSV format ==
29 +
20 20  === Meta data ===
31 +
21 21  |=Delimiter|semicolon( ; )
22 22  |=Text delimiter|double quote ( " )
23 23  |=Line end|0x0D 0x0A (CarriageReturn LineFeed)
... ... @@ -24,36 +24,41 @@
24 24  |=Header|first line
25 25  
26 26  === Columns ===
27 -|=Column|=Description|=
28 -|VEHICLE|license plate|
38 +
39 +|=Column|=Description|=
40 +|VEHICLE|license plate|
29 29  |DATE|gps date when measurement was created|format: YYYY-MM-DD HH:MM:SS
30 30  |LAT|latitude|example.: 51.03659
31 31  |LON|longitude|example.: 13.59967
32 32  |PTO_STATE|secondary engine on/ off|0 = off, 1 = on
33 -|ENGINE_SPEED|engine speed in rpm|
34 -|TACHOGRAPH_VEHICLE_SPEED|tachograph speed in km/h|
35 -|CLUTCH_SWITCH|clutch usage within measurement interval|
36 -|BRAKE_SWITCH|breake usage within measurement interval|
45 +|ENGINE_SPEED|engine speed in rpm|
46 +|TACHOGRAPH_VEHICLE_SPEED|tachograph speed in km/h|
47 +|CLUTCH_SWITCH|clutch usage within measurement interval|
48 +|BRAKE_SWITCH|breake usage within measurement interval|
37 37  |CRUISE_CONTROL_ACTIVE|cruise control on/ off|0 = off, 1 = on
38 38  |OVERSPEED|overspeed warning on/ off|0 = off, 1 = on
39 -|ACCELATOR_PEDAL_POSITION|position of accelator pedal in %|
40 -|AXLE_WEIGHT|axle weight in kg|
41 -|FUEL_LEVEL|fuel level in %|
42 -|ENGINE_COOLANT_TEMP|engin coolant temperature in °C|
43 -|TOTAL_FUEL_USED|total fuel used in liter|
44 -|TOTAL_ENGINE_HOURS|total engine hours in h|
45 -|VEHICLE_DISTANCE|total vehicle distance in km|
46 -|RTI_IDENT|RTI Ident|
47 -|ADBLUE_LEVEL|AdBlue fuel level in %|
48 -|TOTAL_LPG_USED|total LPG(gas) used in kg|
51 +|ACCELATOR_PEDAL_POSITION|position of accelator pedal in %|
52 +|AXLE_WEIGHT|axle weight in kg|
53 +|FUEL_LEVEL|fuel level in %|
54 +|ENGINE_COOLANT_TEMP|engin coolant temperature in °C|
55 +|TOTAL_FUEL_USED|total fuel used in liter|
56 +|TOTAL_ENGINE_HOURS|total engine hours in h|
57 +|VEHICLE_DISTANCE|total vehicle distance in km|
58 +|RTI_IDENT|RTI Ident|
59 +|ADBLUE_LEVEL|AdBlue fuel level in %|
60 +|TOTAL_LPG_USED|total LPG(gas) used in kg|
49 49  
50 50  === Example ===
63 +
51 51  == CSV format ==
65 +
52 52  **return in csv**
53 -{{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"
67 +{{code language="java"}}
68 +"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"
54 54  "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}}
55 55  
56 56  == XML format ==
72 +
57 57  **return in xml**
58 58  {{code language="java"}}<?xml version="1.0" encoding="ISO-8859-1"?>
59 59  <!DOCTYPE yf_fms SYSTEM "http://map.yellowfox.de/rti/dtd/yf_fms.dtd">
... ... @@ -77,13 +77,14 @@
77 77   <TOTAL_FUEL_USED>89833</TOTAL_FUEL_USED>
78 78   <TOTAL_ENGINE_HOURS>5563</TOTAL_ENGINE_HOURS>
79 79   <VEHICLE_DISTANCE>333903</VEHICLE_DISTANCE>
80 - <RTI_IDENT>Ident1</RTI_IDENT>
81 - <ADBLUE_LEVEL>81</ADBLUE_LEVEL>
96 + <RTI_IDENT>Ident1</RTI_IDENT>
97 + <ADBLUE_LEVEL>81</ADBLUE_LEVEL>
82 82   <TOTAL_LPG_USED>4280</TOTAL_LPG_USED>
83 83       </ENTRY>
84 84  </yf_fms>{{/code}}
85 85  
86 86  == JSON format ==
103 +
87 87  **return json**
88 88  {{code language="java"}}[{
89 89   "VEHICLE":"DD-YF 2015",
... ... @@ -104,18 +104,20 @@
104 104   "TOTAL_FUEL_USED":"89834",
105 105   "TOTAL_ENGINE_HOURS":"5563",
106 106   "VEHICLE_DISTANCE":"333909",
107 - "RTI_IDENT":"Ident1",
108 - "ADBLUE_LEVEL":"81",
124 + "RTI_IDENT":"Ident1",
125 + "ADBLUE_LEVEL":"81",
109 109   "TOTAL_LPG_USED":"4280"
110 110  }]{{/code}}
111 111  
112 112  = Example calls =
130 +
113 113  **most current FMS data of a vehicle in CSV format**
114 -{{code language="java"}}https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY
132 +{{code language="java"}}
133 +https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY
115 115  
116 116  https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}{{/code}}
117 117  
118 -** FMS data of a vehicle within a certain time range in XML format**
137 +**FMS data of a vehicle within a certain time range in XML format**
119 119  {{code language="java"}}https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&start=20210401000000&end=20210401235959&format=xml
120 120  
121 121  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}}