Changes for page TCP Communication

Last modified by csp on 2025/01/30 12:05
<
From version < 3.1 >
edited by nbw
on 2014/07/05 12:02
To version < 40.2 >
edited by csp
on 2023/07/13 12:23
>
Change comment: Update document after refactoring.

Summary

Details

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

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage