Changes for page TCP Communication

Last modified by csp on 2025/01/30 12:05
<
From version < 24.1 >
edited by nbw
on 2014/07/30 14:14
To version < 12.1 >
edited by Alexander Schulz-Rosengarten
on 2014/07/14 16:27
>
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
... ... @@ -30,16 +30,18 @@
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
33 33  * **trainCount** - an integer with the number of active trains on the railway
34 34  * **trains** - a JSON Array with the data of all trains, each entry is a JSON Object with these values\\
35 -** **waitTime** - (integer) remaining milliseconds until departure (0 if not waiting)
36 -** **spdSlow** - the integer PWM value of this train while driving slow
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="Green" title="NEW"/}}waitTime** - (integer) timestamp, when the train is allowed to depart, should only be interpreted if **waiting** is true 
39 +** **{{status colour="Green" title="NEW"/}}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 -** **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.
40 -** **currentIndex** - an integer describing the current position in the schedule
42 +** **currentIndex** -an integer describing the current position in the schedule
41 41  ** (((
42 -**schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
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 +1
67 67  )))|(((
68 68  KH_ST_1
69 69  )))|(% colspan="1" %)(% colspan="1" %)
70 70  (((
71 -17
73 +6
72 72  )))|(% colspan="1" %)(% colspan="1" %)
73 73  (((
74 74  KH_ST_1 (reverse)
75 75  )))|(((
76 -25
78 +11
77 77  )))|(((
78 -IC_ST_1
80 +IC_ST_3
79 79  )))|(% colspan="1" %)(% colspan="1" %)
80 80  (((
81 -33
83 +14
82 82  )))|(% colspan="1" %)(% colspan="1" %)
83 83  (((
84 -OC_ST_1
86 +OC_ST_3
85 85  )))
86 86  |(((
87 -10
89 +2
88 88  )))|(((
89 89  KH_ST_2
90 90  )))|(% colspan="1" %)(% colspan="1" %)
91 91  (((
92 -18
94 +7
93 93  )))|(% colspan="1" %)(% colspan="1" %)
94 94  (((
95 95  KH_ST_2 (reverse)
96 96  )))|(((
97 -26
99 +12
98 98  )))|(((
99 99  IC_ST_2
100 100  )))|(% colspan="1" %)(% colspan="1" %)
101 101  (((
102 -34
104 +15
103 103  )))|(% colspan="1" %)(% colspan="1" %)
104 104  (((
105 105  OC_ST_2
106 106  )))
107 107  |(((
108 -11
110 +3
109 109  )))|(((
110 110  KH_ST_3
111 111  )))|(% colspan="1" %)(% colspan="1" %)
112 112  (((
113 -19
115 +8
114 114  )))|(% colspan="1" %)(% colspan="1" %)
115 115  (((
116 116  KH_ST_3 (reverse)
117 117  )))|(((
118 -27
120 +13
119 119  )))|(((
120 -IC_ST_3
122 +IC_ST_1
121 121  )))|(% colspan="1" %)(% colspan="1" %)
122 122  (((
123 -35
125 +16
124 124  )))|(% colspan="1" %)(% colspan="1" %)
125 125  (((
126 -OC_ST_3
128 +OC_ST_1
127 127  )))
128 128  |(((
129 -12
131 +4
130 130  )))|(((
131 131  KH_ST_4
132 132  )))|(% colspan="1" %)(% colspan="1" %)
133 133  (((
134 -20
136 +9
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 +5
151 151  )))|(((
152 152  KH_ST_5
153 153  )))|(% colspan="1" %)(% colspan="1" %)
154 154  (((
155 -21
157 +10
156 156  )))|(% colspan="1" %)(% colspan="1" %)
157 157  (((
158 158  KH_ST_5 (reverse)
... ... @@ -169,34 +169,22 @@
169 169  )))
170 170  )))
171 171  * **locks** - a JSON Array containing the current value of the track permissions, ordered by the default encoding (Hoermann API)
172 -* **tickTime** - Time consumption of tick function. 3 element array [min,avg,max].
173 -* **overallTime** -  Time consumption of overall controller loop. 3 element array [min,avg,max].
174 174  
175 -
176 -
177 177  {{code title="Sample status" language="js" collapse="true"}}
178 178  {"msgType":"status",
179 - "data":{
180 - "debug":false,
181 - "cleanup":false,
182 - "pause":false,
183 - "trainCount":8,
184 - "trains":[
185 - {"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]},
186 - {"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]},
187 - {"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]},
188 - {"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]},
189 - {"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]},
190 - {"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]},
191 - {"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]},
192 - {"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":8, "schedule":[9,13,17,21,25,27,33,35]},
193 - ],
194 - "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]},
195 - "tickTime":[50, 60, 70],
196 - "overallTime":[70, 80, 90]}
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]}}
197 197  
198 198  [One line to test via netcat]
199 -{"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]}
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 200  {{/code}}
201 201  
202 202  == Messages received by controller ==
... ... @@ -206,27 +206,30 @@
206 206  
207 207  === Valid commands ===
208 208  
209 -* //STATUS// - Poll for the current status, should trigger a status reply message
199 +* //STATUS// - Poll for the current status, should trigger a status reply message\\
210 210  * //SHUTDOWN// - Causing the controller to end the program and close all sockets
211 211  * //LOGOUT// - Closing the connection, leaving the controller running
212 212  * //PAUSE// - suspend or resume the controller, must supply additional payload
213 213  ** **state** - boolean value, true if controller should be suspended
214 -* //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks
215 -* //DEBUG// - enable or disable verbose output, must supply additional payload
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
216 216  ** **state** - boolean value, true if verbose output should be activated
217 -* //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
208 +* //LIGHT (write//) - activate or deactivate the lights on the railway, must supply additional payload\\
218 218  ** **state** - boolean value, true if lights should be lit
219 -* //WAIT// - Force a train to wait in the next station, must supply additional payload
210 +* //WAIT// (//write//) - Force a train to wait in the next station, must supply additional payload
220 220  ** **train** - integer train identification
221 -* //START// - Force a waiting train to immediately abort the waiting timer, must supply additional payload
212 +* //START (write//) - Force a waiting train to immediately abort the waiting timer, must supply additional payload
222 222  ** **train** - integer train identification
223 -* //SCHEDULE// - Set the new schedule for a train, needs additional payload
214 +* //SCHEDULE// (//write//) - Set the new schedule for a train, needs additional payload
224 224  ** **train** - integer train identification
225 225  ** **currentIndex** - current integer position in the schedule array
226 226  ** **tracks** - a JSON Array of integer values, representing the station tracks in encoding above
227 -* //SPEED //- Change the speed settings of a train, needs additional payload
218 +* //SPEED (write//) - Change the speed settings of a train, needs additional payload
228 228  ** **train** - integer train identification
229 229  ** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
230 -* //TIME// - Change the waiting times for a train
221 +* //TIME// (//write//) - Change the waiting times for a train
231 231  ** **train** - integer train identification
232 -**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.
223 +** **times** -
224 +
225 +{{status colour="Yellow" title="Define a format for this"/}}
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9471612
1 +9471544
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471612/TCP Communication
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471544/TCP Communication

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage