Changes for page TCP Communication

Last modified by csp on 2025/01/30 12:05
<
From version < 15.1 >
edited by Alexander Schulz-Rosengarten
on 2014/07/16 14:31
To version < 21.1 >
edited by nbw
on 2014/07/30 13:48
>
Change comment: Removed write lock, Added station times

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.als
1 +XWiki.nbw
Content
... ... @@ -30,18 +30,17 @@
30 30  * **debug** - true if the controller is set to verbose debug output, false otherwise
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 -* **write** - true if receiving client has write access, false otherwise
34 34  * **trainCount** - an integer with the number of active trains on the railway
35 35  * **trains** - a JSON Array with the data of all trains, each entry is a JSON Object with these values\\
36 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
36 +** **waitTime** - (integer) remaining milliseconds until departure (0 if not waiting)
37 +** **spdSlow** - the integer PWM value of this train while driving slow
40 40  ** **spdCaution** - the integer PWM value of this train while driving caution
41 41  ** **spdNormal** - the integer PWM value of this train while driving normally
42 -** **currentIndex** -an integer describing the current position in the schedule
40 +** **currentIndex** - an integer describing the current position in the schedule
41 +** **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.
43 43  ** (((
44 -**schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
43 +**schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
45 45  
46 46  |=(((
47 47  Number
... ... @@ -65,75 +65,75 @@
65 65  Track
66 66  )))
67 67  |(((
68 -0
67 +9
69 69  )))|(((
70 70  KH_ST_1
71 71  )))|(% colspan="1" %)(% colspan="1" %)
72 72  (((
73 -8
72 +17
74 74  )))|(% colspan="1" %)(% colspan="1" %)
75 75  (((
76 76  KH_ST_1 (reverse)
77 77  )))|(((
78 -16
77 +25
79 79  )))|(((
80 80  IC_ST_1
81 81  )))|(% colspan="1" %)(% colspan="1" %)
82 82  (((
83 -24
82 +33
84 84  )))|(% colspan="1" %)(% colspan="1" %)
85 85  (((
86 86  OC_ST_1
87 87  )))
88 88  |(((
89 -1
88 +10
90 90  )))|(((
91 91  KH_ST_2
92 92  )))|(% colspan="1" %)(% colspan="1" %)
93 93  (((
94 -9
93 +18
95 95  )))|(% colspan="1" %)(% colspan="1" %)
96 96  (((
97 97  KH_ST_2 (reverse)
98 98  )))|(((
99 -17
98 +26
100 100  )))|(((
101 101  IC_ST_2
102 102  )))|(% colspan="1" %)(% colspan="1" %)
103 103  (((
104 -25
103 +34
105 105  )))|(% colspan="1" %)(% colspan="1" %)
106 106  (((
107 107  OC_ST_2
108 108  )))
109 109  |(((
110 -2
109 +11
111 111  )))|(((
112 112  KH_ST_3
113 113  )))|(% colspan="1" %)(% colspan="1" %)
114 114  (((
115 -10
114 +19
116 116  )))|(% colspan="1" %)(% colspan="1" %)
117 117  (((
118 118  KH_ST_3 (reverse)
119 119  )))|(((
120 -18
119 +27
121 121  )))|(((
122 122  IC_ST_3
123 123  )))|(% colspan="1" %)(% colspan="1" %)
124 124  (((
125 -26
124 +35
126 126  )))|(% colspan="1" %)(% colspan="1" %)
127 127  (((
128 128  OC_ST_3
129 129  )))
130 130  |(((
131 -3
130 +12
132 132  )))|(((
133 133  KH_ST_4
134 134  )))|(% colspan="1" %)(% colspan="1" %)
135 135  (((
136 -11
135 +20
137 137  )))|(% colspan="1" %)(% colspan="1" %)
138 138  (((
139 139  KH_ST_4 (reverse)
... ... @@ -149,12 +149,12 @@
149 149  
150 150  )))
151 151  |(((
152 -4
151 +13
153 153  )))|(((
154 154  KH_ST_5
155 155  )))|(% colspan="1" %)(% colspan="1" %)
156 156  (((
157 -12
156 +21
158 158  )))|(% colspan="1" %)(% colspan="1" %)
159 159  (((
160 160  KH_ST_5 (reverse)
... ... @@ -171,22 +171,34 @@
171 171  )))
172 172  )))
173 173  * **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. 3 element array [min,avg,max].
174 +* **overallTime** -  Time consumption of overall controller loop. 3 element array [min,avg,max].
174 174  
176 +
177 +
175 175  {{code title="Sample status" language="js" collapse="true"}}
176 176  {"msgType":"status",
177 - "data":{
178 - "debug":false,
179 - "cleanup":false,
180 - "pause":false,
181 - "trainCount":8,
182 - "trains":[
183 - {"trainNum":0, "waiting":false, "waitTime":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":2, "schedule":[8, 10, 25, 29, 41, 43]},
184 - {"trainNum":1, "waiting":true, "waitTime":1234545667, "spdSlow":50, "spdCaution":70, "spdNormal":100, "currentIndex":0, "schedule":[8]},
185 - ... ],
186 - "locks":[-1, -1, -1, 5, -1, -1, 2, 10, -1, -1, ..., -1]}}
180 + "data":{
181 + "debug":false,
182 + "cleanup":false,
183 + "pause":false,
184 + "trainCount":8,
185 + "trains":[
186 + {"trainNum":0, "waitTime":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":1, "schedule":[9,13,17,21,25,27,33,35]},
187 + {"trainNum":1, "waitTime":2500, "spdSlow":41, "spdCaution":61, "spdNormal":101, "currentIndex":2, "schedule":[9,13,17,21,25,27,33,35]},
188 + {"trainNum":2, "waitTime":0, "spdSlow":42, "spdCaution":62, "spdNormal":102, "currentIndex":3, "schedule":[9,13,17,21,25,27,33,35]},
189 + {"trainNum":3, "waitTime":0, "spdSlow":43, "spdCaution":63, "spdNormal":103, "currentIndex":4, "schedule":[9,13,17,21,25,27,33,35]},
190 + {"trainNum":4, "waitTime":0, "spdSlow":44, "spdCaution":64, "spdNormal":104, "currentIndex":5, "schedule":[9,13,17,21,25,27,33,35]},
191 + {"trainNum":5, "waitTime":10000, "spdSlow":45, "spdCaution":65, "spdNormal":105, "currentIndex":6, "schedule":[9,13,17,21,25,27,33,35]},
192 + {"trainNum":6, "waitTime":0, "spdSlow":46, "spdCaution":66, "spdNormal":106, "currentIndex":7, "schedule":[9,13,17,21,25,27,33,35]},
193 + {"trainNum":7, "waitTime":0, "spdSlow":47, "spdCaution":67, "spdNormal":107, "currentIndex":8, "schedule":[9,13,17,21,25,27,33,35]},
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]}
187 187  
188 188  [One line to test via netcat]
189 -{"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 +{"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]}
190 190  {{/code}}
191 191  
192 192  == Messages received by controller ==
... ... @@ -201,25 +201,24 @@
201 201  * //LOGOUT// - Closing the connection, leaving the controller running
202 202  * //PAUSE// - suspend or resume the controller, must supply additional payload
203 203  ** **state** - boolean value, true if controller should be suspended
204 -* //WRITE// - Acquire write access mutex to the controller
205 -* //CLEANUP// (//write//) - Start the cleanup procedure, sending the trains back to their home tacks
206 -* //DEBUG// (//write//) - enable or disable verbose output, must supply additional payload
215 +* //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks
216 +* //DEBUG// - enable or disable verbose output, must supply additional payload
207 207  ** **state** - boolean value, true if verbose output should be activated
208 -* //LIGHT (write//) - activate or deactivate the lights on the railway, must supply additional payload\\
218 +* //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
209 209  ** **state** - boolean value, true if lights should be lit
210 -* //WAIT// (//write//) - Force a train to wait in the next station, must supply additional payload
220 +* //WAIT// - Force a train to wait in the next station, must supply additional payload
211 211  ** **train** - integer train identification
212 -* //START (write//) - Force a waiting train to immediately abort the waiting timer, must supply additional payload
222 +* //START// - Force a waiting train to immediately abort the waiting timer, must supply additional payload
213 213  ** **train** - integer train identification
214 -* //SCHEDULE// (//write//) - Set the new schedule for a train, needs additional payload
224 +* //SCHEDULE// - Set the new schedule for a train, needs additional payload
215 215  ** **train** - integer train identification
216 216  ** **currentIndex** - current integer position in the schedule array
217 217  ** **tracks** - a JSON Array of integer values, representing the station tracks in encoding above
218 -* //SPEED (write//) - Change the speed settings of a train, needs additional payload
228 +* //SPEED //- Change the speed settings of a train, needs additional payload
219 219  ** **train** - integer train identification
220 220  ** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
221 -* //TIME// (//write//) - Change the waiting times for a train
231 +* //TIME// - Change the waiting times for a train
222 222  ** **train** - integer train identification
223 -** **times** -
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.
224 224  
225 -{{status colour="Yellow" title="Define a format for this"/}}
235 +{{status colour="Yellow" title="New definition"/}}
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9471570
1 +9471606
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471570/TCP Communication
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471606/TCP Communication

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage