Changes for page get_fms.php

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

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.yf-dominic
1 +XWiki.YellowFox_RD
Content
... ... @@ -1,21 +1,14 @@
1 1  (% class="box" %)
2 -(((
3 -Table of Contents
4 -)))
5 -
2 +(((Table of Contents)))
6 6  {{toc/}}
7 7  
8 8  Returns FMS data for a vehicle.
9 -
10 10  = Description =
11 -
12 -(% class="green mark" %)**GET**(%%)** get_fms.php?company**=//COMPANY_RTIKEY//**&vehicle**=//VEHICLE_RTIKEY//**&start**=//YYYYMMDDHHMMSS//**&end**=//YYYYMMDDHHMMSS**&format**=csv//
13 -
7 +**(% class="green mark" %)GET(%%) get_fms.php****?company**=//COMPANY_RTIKEY//**&vehicle**=//VEHICLE_RTIKEY//**&start**=//YYYYMMDDHHMMSS//**&end**=//YYYYMMDDHHMMSS**&format**=csv//
14 14  = Parameter =
15 -
16 16  |=Parameter|=Description|=Type|=Note|=Mandatory
17 -|company|RTI company key|string| |yes
18 -|vehicle|RTI vehicle key|string| |yes
10 +|company|RTI company key|string||yes
11 +|vehicle|RTI vehicle key|string||yes
19 19  |start|start of interval|datestring|format: YYYYMMDDHHMMSS|no
20 20  |end|end of interval|datestring|format: YYYYMMDDHHMMSS
21 21  Max. 24 hours between start and end of interval|no
... ... @@ -22,13 +22,9 @@
22 22  |format|return format|string|csv (standard), xml or json|no
23 23  
24 24  = Return =
25 -
26 26  Return a **string**. In case of error "(% class="error" %)**ERROR:Description**(%%)" will be returned.
27 -
28 28  == CSV format ==
29 -
30 30  === Meta data ===
31 -
32 32  |=Delimiter|semicolon( ; )
33 33  |=Text delimiter|double quote ( " )
34 34  |=Line end|0x0D 0x0A (CarriageReturn LineFeed)
... ... @@ -35,40 +35,36 @@
35 35  |=Header|first line
36 36  
37 37  === Columns ===
38 -
39 -|=Column|=Description|=
40 -|VEHICLE|license plate|
27 +|=Column|=Description|=
28 +|VEHICLE|license plate|
41 41  |DATE|gps date when measurement was created|format: YYYY-MM-DD HH:MM:SS
42 42  |LAT|latitude|example.: 51.03659
43 43  |LON|longitude|example.: 13.59967
44 44  |PTO_STATE|secondary engine on/ off|0 = off, 1 = on
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|
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|
49 49  |CRUISE_CONTROL_ACTIVE|cruise control on/ off|0 = off, 1 = on
50 50  |OVERSPEED|overspeed warning on/ off|0 = off, 1 = on
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|
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|
61 61  
62 62  === Example ===
63 -
64 64  == CSV format ==
65 -
66 66  **return in csv**
67 67  {{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"
68 68  "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}}
69 69  
70 70  == XML format ==
71 -
72 72  **return in xml**
73 73  {{code language="java"}}<?xml version="1.0" encoding="ISO-8859-1"?>
74 74  <!DOCTYPE yf_fms SYSTEM "http://map.yellowfox.de/rti/dtd/yf_fms.dtd">
... ... @@ -92,14 +92,13 @@
92 92   <TOTAL_FUEL_USED>89833</TOTAL_FUEL_USED>
93 93   <TOTAL_ENGINE_HOURS>5563</TOTAL_ENGINE_HOURS>
94 94   <VEHICLE_DISTANCE>333903</VEHICLE_DISTANCE>
95 - <RTI_IDENT>Ident1</RTI_IDENT>
96 - <ADBLUE_LEVEL>81</ADBLUE_LEVEL>
80 + <RTI_IDENT>Ident1</RTI_IDENT>
81 + <ADBLUE_LEVEL>81</ADBLUE_LEVEL>
97 97   <TOTAL_LPG_USED>4280</TOTAL_LPG_USED>
98 98       </ENTRY>
99 99  </yf_fms>{{/code}}
100 100  
101 101  == JSON format ==
102 -
103 103  **return json**
104 104  {{code language="java"}}[{
105 105   "VEHICLE":"DD-YF 2015",
... ... @@ -120,13 +120,12 @@
120 120   "TOTAL_FUEL_USED":"89834",
121 121   "TOTAL_ENGINE_HOURS":"5563",
122 122   "VEHICLE_DISTANCE":"333909",
123 - "RTI_IDENT":"Ident1",
124 - "ADBLUE_LEVEL":"81",
107 + "RTI_IDENT":"Ident1",
108 + "ADBLUE_LEVEL":"81",
125 125   "TOTAL_LPG_USED":"4280"
126 126  }]{{/code}}
127 127  
128 128  = Example calls =
129 -
130 130  **most current FMS data of a vehicle in CSV format**
131 131  {{code language="java"}}https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY
132 132