Changes for page TCP Communication

Last modified by csp on 2025/01/30 12:05
<
From version < 6.1 >
edited by nbw
on 2014/07/05 12:40
To version < 38.1 >
edited by Alexander Schulz-Rosengarten
on 2014/08/18 11:57
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.nbw
1 +XWiki.als
Content
... ... @@ -2,10 +2,6 @@
2 2  
3 3  {{toc/}}
4 4  
5 -
6 -
7 -{{status colour="Red" title="Work in progress - Might by subject to change"/}}
8 -
9 9  Both the controller and the client GUI send their data as JSON Objects.
10 10  In JSON every Object is an unordered set of key/value pairs. The values of these pairs can be a JSON Object, a JSON Array or a primitive value (integer, string, boolean or null).
11 11  For more information or a complete grammar see [[http:~~/~~/www.json.org/>>url:http://www.json.org/||shape="rect"]].
... ... @@ -31,44 +31,194 @@
31 31  * **cleanup** - true after cleanup mode has been engaged, false before that point
32 32  * **pause** - true while the controller is paused, false otherwise
33 33  * **trainCount** - an integer with the number of active trains on the railway
34 -* **trains** - a JSON Array with the data of all trains, each entry is a JSON Object with these values\\
35 -** **trainNum** - the individual controller number of the train
30 +* **trains** - a JSON Array with the data of all trains, each entry is a JSON Object with these values
31 +** **state** - integer value for current train state (0 = travelling, 1 = waiting, 2 = travelling until next station, 3 = forced wait, 4 = no schedule)
32 +** **waitTime** - (integer) remaining milliseconds until departure (0 if not waiting)
36 36  ** **spdSlow** - the integer PWM value of this train while driving slow
37 37  ** **spdCaution** - the integer PWM value of this train while driving caution
38 38  ** **spdNormal** - the integer PWM value of this train while driving normally
39 -** **currentIndex** -an integer describing the current position in the schedule
40 -** **schedule** - a JSON Array of integer values, representing the station tracks in the normal encoding (Hoermann API)
41 -* **{{status colour="Yellow" title="Need to change this to enable KH-Reverse tracks"/}}locks** - a JSON Array containing the current value of the track permissions, ordered by the default encoding (Hoermann API)
36 +** **stationTimes** - a flat array of the form [station1_minTime, station1_maxTime, station2_minTime, station2_maxTime, ...]. The order of the stations is defined by the order in the table below but the KH (reverse) tracks are omitted.
37 +** **currentIndex** - an integer describing the current position in the schedule
38 +** (((
39 +**schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
42 42  
41 +|=(((
42 +Number
43 +)))|=(((
44 +Track
45 +)))|=(% colspan="1" %)(% colspan="1" %)
46 +(((
47 +Number
48 +)))|=(% colspan="1" %)(% colspan="1" %)
49 +(((
50 +Track
51 +)))|=(((
52 +Number
53 +)))|=(((
54 +Track
55 +)))|=(% colspan="1" %)(% colspan="1" %)
56 +(((
57 +Number
58 +)))|=(% colspan="1" %)(% colspan="1" %)
59 +(((
60 +Track
61 +)))
62 +|(((
63 +9
64 +)))|(((
65 +KH_ST_1
66 +)))|(% colspan="1" %)(% colspan="1" %)
67 +(((
68 +17
69 +)))|(% colspan="1" %)(% colspan="1" %)
70 +(((
71 +KH_ST_1 (reverse)
72 +)))|(((
73 +25
74 +)))|(((
75 +IC_ST_1
76 +)))|(% colspan="1" %)(% colspan="1" %)
77 +(((
78 +33
79 +)))|(% colspan="1" %)(% colspan="1" %)
80 +(((
81 +OC_ST_1
82 +)))
83 +|(((
84 +10
85 +)))|(((
86 +KH_ST_2
87 +)))|(% colspan="1" %)(% colspan="1" %)
88 +(((
89 +18
90 +)))|(% colspan="1" %)(% colspan="1" %)
91 +(((
92 +KH_ST_2 (reverse)
93 +)))|(((
94 +26
95 +)))|(((
96 +IC_ST_2
97 +)))|(% colspan="1" %)(% colspan="1" %)
98 +(((
99 +34
100 +)))|(% colspan="1" %)(% colspan="1" %)
101 +(((
102 +OC_ST_2
103 +)))
104 +|(((
105 +11
106 +)))|(((
107 +KH_ST_3
108 +)))|(% colspan="1" %)(% colspan="1" %)
109 +(((
110 +19
111 +)))|(% colspan="1" %)(% colspan="1" %)
112 +(((
113 +KH_ST_3 (reverse)
114 +)))|(((
115 +27
116 +)))|(((
117 +IC_ST_3
118 +)))|(% colspan="1" %)(% colspan="1" %)
119 +(((
120 +35
121 +)))|(% colspan="1" %)(% colspan="1" %)
122 +(((
123 +OC_ST_3
124 +)))
125 +|(((
126 +12
127 +)))|(((
128 +KH_ST_4
129 +)))|(% colspan="1" %)(% colspan="1" %)
130 +(((
131 +20
132 +)))|(% colspan="1" %)(% colspan="1" %)
133 +(((
134 +KH_ST_4 (reverse)
135 +)))|(((
136 +
137 +)))|(((
138 +
139 +)))|(% colspan="1" %)(% colspan="1" %)
140 +(((
141 +
142 +)))|(% colspan="1" %)(% colspan="1" %)
143 +(((
144 +
145 +)))
146 +|(((
147 +13
148 +)))|(((
149 +KH_ST_5
150 +)))|(% colspan="1" %)(% colspan="1" %)
151 +(((
152 +21
153 +)))|(% colspan="1" %)(% colspan="1" %)
154 +(((
155 +KH_ST_5 (reverse)
156 +)))|(((
157 +
158 +)))|(((
159 +
160 +)))|(% colspan="1" %)(% colspan="1" %)
161 +(((
162 +
163 +)))|(% colspan="1" %)(% colspan="1" %)
164 +(((
165 +
166 +)))
167 +)))
168 +* **locks** - a JSON Array containing the current value of the track permissions, ordered by the default encoding (Hoermann API)
169 +**tickTime** - Time consumption of tick function in milliseconds. 3 element double-array [min,avg,max]. 
170 +**overallTime** -  Time consumption of overall controller loop in milliseconds. 3 element double-array [min,avg,max].
171 +
172 +
173 +
43 43  {{code title="Sample status" language="js" collapse="true"}}
44 44  {"msgType":"status",
45 - "data":{
46 - "debug":false,
47 - "cleanup":false,
48 - "pause":false,
49 - "trainCount":8,
50 - "trains":[
51 - {"trainNum":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":2, "schedule":[8, 10, 25, 29, 41, 43]},
52 - {"trainNum":1, "spdSlow":50, "spdCaution":70, "spdNormal":100, "currentIndex":0, "schedule":[8]},
53 - ... ],
54 - "locks":[-1, -1, -1, 5, -1, -1, 2, 10, -1, -1, ..., -1]}}
176 +"data":{
177 + "debug":false,
178 + "cleanup":false,
179 + "pause":false,
180 + "trainCount":8,
181 + "trains":[
182 + {"state":3,"waitTime":0,"spdSlow":40,"spdCaution":60,"spdNormal":100,"stationTimes":[5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10],"currentIndex":1,"schedule":[9,13,17,21,25,27,33,35]},
183 + {"state":1,"waitTime":2500,"spdSlow":41,"spdCaution":61,"spdNormal":101,"stationTimes":[5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10],"currentIndex":2,"schedule":[9,13,17,21,25,27,33,35]},
184 + {"state":0,"waitTime":0,"spdSlow":42,"spdCaution":62,"spdNormal":102,"stationTimes":[5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10],"currentIndex":3,"schedule":[9,13,17,21,25,27,33,35]},
185 + {"state":0,"waitTime":0,"spdSlow":43,"spdCaution":63,"spdNormal":103,"stationTimes":[5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10],"currentIndex":4,"schedule":[9,13,17,21,25,27,33,35]},
186 + {"state":0,"waitTime":0,"spdSlow":44,"spdCaution":64,"spdNormal":104,"stationTimes":[5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10],"currentIndex":5,"schedule":[9,13,17,21,25,27,33,35]},
187 + {"state":1,"waitTime":10000,"spdSlow":45,"spdCaution":65,"spdNormal":105,"stationTimes":[5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10],"currentIndex":6,"schedule":[9,13,17,21,25,27,33,35]},
188 + {"state":2,"waitTime":0,"spdSlow":46,"spdCaution":66,"spdNormal":106,"stationTimes":[5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10],"currentIndex":7,"schedule":[9,13,17,21,25,27,33,35]},
189 + {"state":0,"waitTime":0,"spdSlow":47,"spdCaution":67,"spdNormal":107,"stationTimes":[5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10],"currentIndex":4,"schedule":[9,13,17,21,25,27,33,35]}
190 + ],
191 + "locks":[-1,-1,-1,-1,-1,0,-1,-1,2,-1,-1,1,1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,4,-1,-1,-1,-1,-1,5,-1,-1,-1,3,3,7,7,-1,-1,-1,-1,-1,-1,6,-1,-1],
192 + "tickTime":[50,60,70],
193 + "overallTime":[70,80,90]}}
194 +
195 +[One line to test via netcat]
196 +{"msgType":"status","data":{"debug":false,"cleanup":false,"pause":false,"trainCount":8,"trains":[{"state":3,"waitTime":0,"spdSlow":40,"spdCaution":60,"spdNormal":100,"stationTimes":[5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10],"currentIndex":1,"schedule":[9,13,17,21,25,27,33,35]},{"state":1,"waitTime":2500,"spdSlow":41,"spdCaution":61,"spdNormal":101,"stationTimes":[5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10],"currentIndex":2,"schedule":[9,13,17,21,25,27,33,35]},{"state":0,"waitTime":0,"spdSlow":42,"spdCaution":62,"spdNormal":102,"stationTimes":[5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10],"currentIndex":3,"schedule":[9,13,17,21,25,27,33,35]},{"state":0,"waitTime":0,"spdSlow":43,"spdCaution":63,"spdNormal":103,"stationTimes":[5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10],"currentIndex":4,"schedule":[9,13,17,21,25,27,33,35]},{"state":0,"waitTime":0,"spdSlow":44,"spdCaution":64,"spdNormal":104,"stationTimes":[5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10],"currentIndex":5,"schedule":[9,13,17,21,25,27,33,35]},{"state":1,"waitTime":10000,"spdSlow":45,"spdCaution":65,"spdNormal":105,"stationTimes":[5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10],"currentIndex":6,"schedule":[9,13,17,21,25,27,33,35]},{"state":2,"waitTime":0,"spdSlow":46,"spdCaution":66,"spdNormal":106,"stationTimes":[5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10],"currentIndex":7,"schedule":[9,13,17,21,25,27,33,35]},{"state":0,"waitTime":0,"spdSlow":47,"spdCaution":67,"spdNormal":107,"stationTimes":[5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10,5,10],"currentIndex":4,"schedule":[9,13,17,21,25,27,33,35]}],"locks":[-1,-1,-1,-1,-1,0,-1,-1,2,-1,-1,1,1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,4,-1,-1,-1,-1,-1,5,-1,-1,-1,3,3,7,7,-1,-1,-1,-1,-1,-1,6,-1,-1],"tickTime":[50,60,70],"overallTime":[70,80,90]}}
55 55  {{/code}}
56 56  
57 57  == Messages received by controller ==
58 58  
59 -* Every message must contain the key **command**.
60 -* Depending on the command, additional keys might be required.
201 +* Every message must contain the keys **command **and **data**.
202 +* Valid values for **command **are the following uppercase commands.
203 +* Depending on the command, the **data**-object contains the described infos.
204 +** If a command doesn't require any additional information, the data-object may be omitted or empty.
61 61  
62 62  === Valid commands ===
63 63  
208 +* //STATUS// - Poll for the current status, should trigger a status reply message
64 64  * //SHUTDOWN// - Causing the controller to end the program and close all sockets
65 65  * //LOGOUT// - Closing the connection, leaving the controller running
66 -* //STATUS// - Poll for the current status, should trigger a status reply message
211 +* //PAUSE// - suspend or resume the controller, must supply additional payload
212 +** **state** - boolean value, true if controller should be suspended
67 67  * //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks
68 68  * //DEBUG// - enable or disable verbose output, must supply additional payload
69 69  ** **state** - boolean value, true if verbose output should be activated
70 -* //PAUSE// - suspend or resume the controller, must supply additional payload
71 -** **state** - boolean value, true if controller should be suspended
216 +* //ECHO// - Prints message as log message on the server (will be broadcasted to all clients)\\
217 +** **message** - string, message text
72 72  * //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
73 73  ** **state** - boolean value, true if lights should be lit
74 74  * //WAIT// - Force a train to wait in the next station, must supply additional payload
... ... @@ -78,12 +78,10 @@
78 78  * //SCHEDULE// - Set the new schedule for a train, needs additional payload
79 79  ** **train** - integer train identification
80 80  ** **currentIndex** - current integer position in the schedule array
81 -** **tracks** - a JSON Array of integer values, representing the station tracks in the normal encoding (Hoermann API)
82 -* //{{status colour="Yellow" title="Need to change this to enable KH-Reverse tracks"/}}SPEED// - Change the speed settings of a train, needs additional payload
227 +** **tracks** - a JSON Array of integer values, representing the station tracks in encoding above
228 +* //SPEED //- Change the speed settings of a train, needs additional payload
83 83  ** **train** - integer train identification
84 84  ** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
85 85  * //TIME// - Change the waiting times for a train
86 86  ** **train** - integer train identification
87 -** **times** -
88 -
89 -{{status colour="Yellow" title="Define a format for this"/}}
233 +**times** - a flat array of the form [station1_minTime, station1_maxTime, station2_minTime, station2_maxTime, ...]. The order of the stations is defined by the order in the table above but the KH (reverse) tracks are omitted.
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9471509
1 +9471685
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471509/TCP Communication
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471685/TCP Communication

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage