Changes for page TCP Communication

Last modified by csp on 2025/01/30 12:05
<
From version < 40.2 >
edited by csp
on 2023/07/13 12:23
To version < 16.1 >
edited by Alexander Schulz-Rosengarten
on 2014/07/16 14:49
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,0 @@
1 -SS14Railway.Railway Project (summer term 2014).Documentation.C Controller.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.csp
1 +XWiki.als
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,20 +26,18 @@
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 -* (((
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
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
40 +** **spdCaution** - the integer PWM value of this train while driving caution
41 +** **spdNormal** - the integer PWM value of this train while driving normally
42 +** **currentIndex** -an integer describing the current position in the schedule
43 +** (((
44 +**schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
43 43  
44 44  |=(((
45 45  Number
... ... @@ -63,75 +63,75 @@
63 63  Track
64 64  )))
65 65  |(((
66 -9
68 +0
67 67  )))|(((
68 68  KH_ST_1
69 69  )))|(% colspan="1" %)(% colspan="1" %)
70 70  (((
71 -17
73 +8
72 72  )))|(% colspan="1" %)(% colspan="1" %)
73 73  (((
74 74  KH_ST_1 (reverse)
75 75  )))|(((
76 -25
78 +16
77 77  )))|(((
78 78  IC_ST_1
79 79  )))|(% colspan="1" %)(% colspan="1" %)
80 80  (((
81 -33
83 +24
82 82  )))|(% colspan="1" %)(% colspan="1" %)
83 83  (((
84 84  OC_ST_1
85 85  )))
86 86  |(((
87 -10
89 +1
88 88  )))|(((
89 89  KH_ST_2
90 90  )))|(% colspan="1" %)(% colspan="1" %)
91 91  (((
92 -18
94 +9
93 93  )))|(% colspan="1" %)(% colspan="1" %)
94 94  (((
95 95  KH_ST_2 (reverse)
96 96  )))|(((
97 -26
99 +17
98 98  )))|(((
99 99  IC_ST_2
100 100  )))|(% colspan="1" %)(% colspan="1" %)
101 101  (((
102 -34
104 +25
103 103  )))|(% colspan="1" %)(% colspan="1" %)
104 104  (((
105 105  OC_ST_2
106 106  )))
107 107  |(((
108 -11
110 +2
109 109  )))|(((
110 110  KH_ST_3
111 111  )))|(% colspan="1" %)(% colspan="1" %)
112 112  (((
113 -19
115 +10
114 114  )))|(% colspan="1" %)(% colspan="1" %)
115 115  (((
116 116  KH_ST_3 (reverse)
117 117  )))|(((
118 -27
120 +18
119 119  )))|(((
120 120  IC_ST_3
121 121  )))|(% colspan="1" %)(% colspan="1" %)
122 122  (((
123 -35
125 +26
124 124  )))|(% colspan="1" %)(% colspan="1" %)
125 125  (((
126 126  OC_ST_3
127 127  )))
128 128  |(((
129 -12
131 +3
130 130  )))|(((
131 131  KH_ST_4
132 132  )))|(% colspan="1" %)(% colspan="1" %)
133 133  (((
134 -20
136 +11
135 135  )))|(% colspan="1" %)(% colspan="1" %)
136 136  (((
137 137  KH_ST_4 (reverse)
... ... @@ -147,12 +147,12 @@
147 147  
148 148  )))
149 149  |(((
150 -13
152 +4
151 151  )))|(((
152 152  KH_ST_5
153 153  )))|(% colspan="1" %)(% colspan="1" %)
154 154  (((
155 -21
157 +12
156 156  )))|(% colspan="1" %)(% colspan="1" %)
157 157  (((
158 158  KH_ST_5 (reverse)
... ... @@ -168,43 +168,35 @@
168 168  
169 169  )))
170 170  )))
171 -)))
172 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].
174 +* **tickTime** - Time consumption of tick function. 3 element array [min,avg,max].
175 +* **overallTime** -  Time consumption of overall controller loop. 3 element array [min,avg,max].
175 175  
176 176  
177 177  
178 178  {{code title="Sample status" language="js" collapse="true"}}
180 +<<OUTDATED>>
181 +
179 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]}}
183 + "data":{
184 + "debug":false,
185 + "cleanup":false,
186 + "pause":false,
187 + "trainCount":8,
188 + "trains":[
189 + {"trainNum":0, "waiting":false, "waitTime":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":2, "schedule":[8, 10, 25, 29, 41, 43]},
190 + {"trainNum":1, "waiting":true, "waitTime":1234545667, "spdSlow":50, "spdCaution":70, "spdNormal":100, "currentIndex":0, "schedule":[8]},
191 + ... ],
192 + "locks":[-1, -1, -1, 5, -1, -1, 2, 10, -1, -1, ..., -1]}}
193 +
198 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]}}
195 +{"msgType":"status", "data":{"debug":false, "cleanup":false, "pause":false, "trainCount":8, "trains":[ {"trainNum":0, "waiting":false, "waitTime":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":2, "schedule":[1, 1, 11, 14, 6]}, {"trainNum":1, "waiting":true, "waitTime":9999999999, "spdSlow":51, "spdCaution":71, "spdNormal":101, "currentIndex":0, "schedule":[2, 1, 11, 14, 6]}, {"trainNum":2, "waiting":false, "waitTime":0, "spdSlow":52, "spdCaution":72, "spdNormal":102, "currentIndex":1, "schedule":[3, 1, 11, 14, 6]}, {"trainNum":3, "waiting":false, "waitTime":0, "spdSlow":53, "spdCaution":73, "spdNormal":103, "currentIndex":1, "schedule":[4, 1, 11, 14, 6]}, {"trainNum":4, "waiting":false, "waitTime":0, "spdSlow":54, "spdCaution":74, "spdNormal":104, "currentIndex":2, "schedule":[5, 1, 11, 14, 6]}, {"trainNum":5, "waiting":false, "waitTime":0, "spdSlow":55, "spdCaution":75, "spdNormal":105, "currentIndex":3, "schedule":[6, 1, 11, 14, 6]}, {"trainNum":6, "waiting":false, "waitTime":0, "spdSlow":56, "spdCaution":76, "spdNormal":106, "currentIndex":1, "schedule":[7, 1, 11, 14, 6]}, {"trainNum":7, "waiting":false, "waitTime":0, "spdSlow":57, "spdCaution":77, "spdNormal":107, "currentIndex":0, "schedule":[8, 1, 11, 14, 6]}], "locks":[-1, -1, -1, 5, -1, -1, 2, 3, -1, -1, -1, -1, 6, -1, -1, -1, -1, -1, -1, 4, -1, -1, -1, -1, 0, -1, -1, -1, -1, -1, -1, -1, 1, -1, -1, -1, -1, -1, -1, -1, -1, 7, -1, -1, -1, -1, -1, -1]}}
200 200  {{/code}}
201 201  
202 202  == Messages received by controller ==
203 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.
200 +* Every message must contain the key **command**.
201 +* Depending on the command, additional keys might be required.
208 208  
209 209  === Valid commands ===
210 210  
... ... @@ -213,24 +213,25 @@
213 213  * //LOGOUT// - Closing the connection, leaving the controller running
214 214  * //PAUSE// - suspend or resume the controller, must supply additional payload
215 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
210 +* //WRITE// - Acquire write access mutex to the controller
211 +* //CLEANUP// (//write//) - Start the cleanup procedure, sending the trains back to their home tacks
212 +* //DEBUG// (//write//) - enable or disable verbose output, must supply additional payload
218 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\\
214 +* //LIGHT (write//) - activate or deactivate the lights on the railway, must supply additional payload\\
222 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
216 +* //WAIT// (//write//) - Force a train to wait in the next station, must supply additional payload
224 224  ** **train** - integer train identification
225 -* //START// - Force a waiting train to immediately abort the waiting timer, must supply additional payload
218 +* //START (write//) - Force a waiting train to immediately abort the waiting timer, must supply additional payload
226 226  ** **train** - integer train identification
227 -* //SCHEDULE// - Set the new schedule for a train, needs additional payload
220 +* //SCHEDULE// (//write//) - Set the new schedule for a train, needs additional payload
228 228  ** **train** - integer train identification
229 229  ** **currentIndex** - current integer position in the schedule array
230 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
224 +* //SPEED (write//) - Change the speed settings of a train, needs additional payload
232 232  ** **train** - integer train identification
233 233  ** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
234 -* //TIME// - Change the waiting times for a train
227 +* //TIME// (//write//) - Change the waiting times for a train
235 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.
229 +** **times** -
230 +
231 +{{status colour="Yellow" title="Define a format for this"/}}
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9471477
1 +9471578
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471477/TCP Communication
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471578/TCP Communication

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage