Wiki source code of get_rs232ext.php

Last modified by YellowFox_RD on 2024/12/19 10:11
Show last authors
1 (% class="box" %)
2 (((Table of Contents)))
3 {{toc/}}
4
5 Returns RS-232 Data with activated RS-232 Extension
6 = Description =
7 ****(% class="green mark" %)GET(%%) **get_rs232ext.php****?company**=//COMPANY_RTIKEY//**&vehicle**=//VEHICLE_RTIKEY//**&start**=//YYYYMMDDHHMMSS//**&end**=//YYYYMMDDHHMMSS//**&//format//**//=CSV//**&charset**//=ISO-8859-1//
8 = Parameters =
9 |=Parameter|=Description|=Type|=Note|=Mandatory
10 |company|RTI company key|string||yes
11 |vehicle|RTI vehicle key|string||yes
12 |start|start of requested time range|datestring|format: YYYYMMDDHHMMSS
13 between start and end maximum 7 days difference allowed|yes
14 |end|end of requested time range|datestring|format: YYYYMMDDHHMMSS
15 between start and end maximum 7 days difference allowed|yes
16 |format|return format|string|CSV (default) or CSV_B64|no
17 |charset|return charset|string|default: ISO-8859-1 (alltough a free defined charset code)|no
18
19 = Return =
20 Return a **string**. In case of error "(% class="error" %)**ERROR:Description**(%%)" will be returned.
21 == CSV Format ==
22 === Meta data ===
23 |=Delimiter|semicolon ( ; )
24 |=Text delimiter|double quote ( " )
25 |=Line end|0x0D 0x0A (CarriageReturn LineFeed)
26 |=Header|line 1
27
28 === Columns ===
29 |=Column|=Description|=
30 |DATE|GPS date when measurement was created|YYYY-MM-DD HH:MM:SS
31 |CAR|vehicle licence|string
32 |SERIALOUTPUT|RS-232 data|string
33 |LAT|Latitude|Example: 51.03659
34 |LON|Longitude|Example: 13.59967
35
36 === Example ===
37 **example in csv**
38 {{code language="java"}}"DATE";"CAR";"SERIALOUTPUT";"LAT";"LON"
39 "2014-03-20 11:43:01";"FLT017 (T34118.0110)";"Prop.Skalning Av";"50.83012";"13.41215"
40 "2014-03-20 11:43:02";"FLT017 (T34118.0110)";"Oputput Portt 1 Text";"50.83012";"13.41215"
41 "2014-03-20 11:43:03";"FLT017 (T34118.0110)";"Farvald Tara Av";"50.83012";"13.41215"{{/code}}
42
43 == CSV Base 64 Format ==
44 === Meta data ===
45 |=Delimiter|semicolon ( ; )
46 |=Text delimiter|double quote ( " )
47 |=Line end|0x0D 0x0A (CarriageReturn LineFeed)
48 |=Header|line 1
49
50 === Columns ===
51 |=Column|=Description|=
52 |DATE|GPS date when measurement was created|YYYY-MM-DD HH:MM:SS
53 |CAR|vehicle licence|string
54 |SERIALOUTPUT|RS-232 data|string
55 |LAT|Latitude|Example: 51.03659
56 |LON|Longitude|Example: 13.59967
57
58 === Example ===
59 **return SERIALOUTPUTB64**
60 {{code language="java"}}"DATE";"CAR";"SERIALOUTPUTB64";"LAT";"LON"
61 "2014-03-20 11:43:01";"FLT017 (T34118.0110)";"UHJvcC5Ta2FsbmluZyAgICAgQXY=";"50.83012";"13.41215"
62 "2014-03-20 11:43:02";"FLT017 (T34118.0110)";"T3B1dHB1dCBQb3J0dCAxICAgICAgICAgVGV4dA==";"50.83012";"13.41215"
63 "2014-03-20 11:43:03";"FLT017 (T34118.0110)";"RpRydmFsZCBUYXJhICBBdg==";"50.83012";"13.41215"{{/code}}
64
65 == JSON Format (RFC 4627) ==
66 **Rückgabe JSON**
67 {{code language="java"}}[{
68 "date":"2022-01-24 04:22:59"
69 ,"car":"FLT017 (T34118.0110)"
70 ,"serialoutput":"UHJvcC5Ta2FsbmluZyAgICAgQXY="
71 ,"lat":"50.83012"
72 ,"lon":"13.41215"
73 },
74 {
75 "date":"2022-01-24 04:23:01",
76 "car":"FLT017 (T34118.0110)",
77 "serialoutput":"T3B1dHB1dCBQb3J0dCAxICAgICAgICAgVGV4dA==",
78 "lat":"50.83012",
79 "lon":"13.41215"
80 }]{{/code}}
81
82 = Example calls =
83 **Request with default CSVformat and UTF-8 charset**
84 {{code language="java"}}https://map.yellowfox.de/rti/get_rs232ext.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&start=20140320000000&end=20140321000000&charset=utf-8
85
86 https://map.yellowfox.de/rti/get_rs232ext.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&start=20140320000000&end=20140321000000&charset=utf-8{{/code}}
87
88 **Request with format CSV Base 64**
89 {{code language="java"}}https://map.yellowfox.de/rti/get_rs232ext.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&start=20140320000000&end=20140321000000&format=csv_b64
90
91 https://map.yellowfox.de/rti/get_rs232ext.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&start=20140320000000&end=20140321000000&format=csv_b64{{/code}}
92