Changes for page TCP Communication

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

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.als
1 +XWiki.nbw
Content
... ... @@ -2,6 +2,10 @@
2 2  
3 3  {{toc/}}
4 4  
5 +
6 +
7 +{{status colour="Red" title="Work in progress - Might bE subject to change"/}}
8 +
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).
7 7  For more information or a complete grammar see [[http:~~/~~/www.json.org/>>url:http://www.json.org/||shape="rect"]].
... ... @@ -26,18 +26,21 @@
26 26  * **debug** - true if the controller is set to verbose debug output, false otherwise
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
33 +* **write** - true if receiving client has write access, 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 -** **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
35 +* **trains** - a JSON Array with the data of all trains, each entry is a JSON Object with these values\\
36 +** **trainNum** - the individual controller number of the train
37 +** --**waiting** - boolean value, true if the train is waiting in a station, false otherwise --
38 +** **{{status colour="Red" title="Removed"/}}waitTime** - (integer) remaining milliseconds until departure (0 if not waiting) 
39 +** **{{status colour="Yellow" title="changed"/}}spdSlow** - the integer PWM value of this train while driving slow
34 34  ** **spdCaution** - the integer PWM value of this train while driving caution
35 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
42 +** **currentIndex** -an integer describing the current position in the schedule
38 38  ** (((
39 39  **schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
40 40  
46 +{{status colour="Yellow" title="CHANGED"/}}
47 +
41 41  |=(((
42 42  Number
43 43  )))|=(((
... ... @@ -166,42 +166,40 @@
166 166  )))
167 167  )))
168 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].
176 +* **tickTime** - Time consumption of tick function. 3 element array [min,avg,max].
177 +* **overallTime** -  Time consumption of overall controller loop. 3 element array [min,avg,max].
171 171  
172 172  
173 173  
174 174  {{code title="Sample status" language="js" collapse="true"}}
175 175  {"msgType":"status",
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]}}
183 + "data":{
184 + "debug":false,
185 + "cleanup":false,
186 + "pause":false,
187 + "trainCount":8,
188 + "trains":[
189 + {"trainNum":0, "waitTime":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":1, "schedule":[9,13,17,21,25,27,33,35]},
190 + {"trainNum":1, "waitTime":2500, "spdSlow":41, "spdCaution":61, "spdNormal":101, "currentIndex":2, "schedule":[9,13,17,21,25,27,33,35]},
191 + {"trainNum":2, "waitTime":0, "spdSlow":42, "spdCaution":62, "spdNormal":102, "currentIndex":3, "schedule":[9,13,17,21,25,27,33,35]},
192 + {"trainNum":3, "waitTime":0, "spdSlow":43, "spdCaution":63, "spdNormal":103, "currentIndex":4, "schedule":[9,13,17,21,25,27,33,35]},
193 + {"trainNum":4, "waitTime":0, "spdSlow":44, "spdCaution":64, "spdNormal":104, "currentIndex":5, "schedule":[9,13,17,21,25,27,33,35]},
194 + {"trainNum":5, "waitTime":10000, "spdSlow":45, "spdCaution":65, "spdNormal":105, "currentIndex":6, "schedule":[9,13,17,21,25,27,33,35]},
195 + {"trainNum":6, "waitTime":0, "spdSlow":46, "spdCaution":66, "spdNormal":106, "currentIndex":7, "schedule":[9,13,17,21,25,27,33,35]},
196 + {"trainNum":7, "waitTime":0, "spdSlow":47, "spdCaution":67, "spdNormal":107, "currentIndex":8, "schedule":[9,13,17,21,25,27,33,35]},
197 + ],
198 + "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]},
199 + "tickTime":[50, 60, 70],
200 + "overallTime":[70, 80, 90]}
194 194  
195 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]}}
203 +{"msgType":"status","data":{"debug":false,"cleanup":false,"pause":false,"trainCount":8,"trains":[{"trainNum":0, "waitTime":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":1, "schedule":[9,13,17,21,25,27,33,35]},{"trainNum":1, "waitTime":2500, "spdSlow":41, "spdCaution":61, "spdNormal":101, "currentIndex":2, "schedule":[9,13,17,21,25,27,33,35]},{"trainNum":2, "waitTime":0, "spdSlow":42, "spdCaution":62, "spdNormal":102, "currentIndex":3, "schedule":[9,13,17,21,25,27,33,35]},{"trainNum":3, "waitTime":0, "spdSlow":43, "spdCaution":63, "spdNormal":103, "currentIndex":4, "schedule":[9,13,17,21,25,27,33,35]},{"trainNum":4, "waitTime":0, "spdSlow":44, "spdCaution":64, "spdNormal":104, "currentIndex":5, "schedule":[9,13,17,21,25,27,33,35]},{"trainNum":5, "waitTime":10000, "spdSlow":45, "spdCaution":65, "spdNormal":105, "currentIndex":6, "schedule":[9,13,17,21,25,27,33,35]},{"trainNum":6, "waitTime":0, "spdSlow":46, "spdCaution":66, "spdNormal":106, "currentIndex":7, "schedule":[9,13,17,21,25,27,33,35]},{"trainNum":7, "waitTime":0, "spdSlow":47, "spdCaution":67, "spdNormal":107, "currentIndex":8, "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]}
197 197  {{/code}}
198 198  
199 199  == Messages received by controller ==
200 200  
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.
208 +* Every message must contain the key **command**.
209 +* Depending on the command, additional keys might be required.
205 205  
206 206  === Valid commands ===
207 207  
... ... @@ -210,24 +210,25 @@
210 210  * //LOGOUT// - Closing the connection, leaving the controller running
211 211  * //PAUSE// - suspend or resume the controller, must supply additional payload
212 212  ** **state** - boolean value, true if controller should be suspended
213 -* //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks
214 -* //DEBUG// - enable or disable verbose output, must supply additional payload
218 +* //WRITE// - Acquire write access mutex to the controller
219 +* //CLEANUP// (//write//) - Start the cleanup procedure, sending the trains back to their home tacks
220 +* //DEBUG// (//write//) - enable or disable verbose output, must supply additional payload
215 215  ** **state** - boolean value, true if verbose output should be activated
216 -* //ECHO// - Prints message as log message on the server (will be broadcasted to all clients)\\
217 -** **message** - string, message text
218 -* //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
222 +* //LIGHT (write//) - activate or deactivate the lights on the railway, must supply additional payload\\
219 219  ** **state** - boolean value, true if lights should be lit
220 -* //WAIT// - Force a train to wait in the next station, must supply additional payload
224 +* //WAIT// (//write//) - Force a train to wait in the next station, must supply additional payload
221 221  ** **train** - integer train identification
222 -* //START// - Force a waiting train to immediately abort the waiting timer, must supply additional payload
226 +* //START (write//) - Force a waiting train to immediately abort the waiting timer, must supply additional payload
223 223  ** **train** - integer train identification
224 -* //SCHEDULE// - Set the new schedule for a train, needs additional payload
228 +* //SCHEDULE// (//write//) - Set the new schedule for a train, needs additional payload
225 225  ** **train** - integer train identification
226 226  ** **currentIndex** - current integer position in the schedule array
227 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
232 +* //SPEED (write//) - Change the speed settings of a train, needs additional payload
229 229  ** **train** - integer train identification
230 230  ** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
231 -* //TIME// - Change the waiting times for a train
235 +* //TIME// (//write//) - Change the waiting times for a train
232 232  ** **train** - integer train identification
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.
237 +** **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.
238 +
239 +{{status colour="Yellow" title="New definition"/}}
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9471685
1 +9471605
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471685/TCP Communication
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471605/TCP Communication

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage