Changes for page TCP Communication

Last modified by csp on 2025/01/30 12:05
<
From version < 21.1 >
edited by nbw
on 2014/07/30 13:48
To version < 10.1 >
edited by nbw
on 2014/07/09 13:56
>
Change comment: Added waiting times

Summary

Details

Page properties
Content
... ... @@ -33,14 +33,14 @@
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 35  ** **trainNum** - the individual controller number of the train
36 -** **waitTime** - (integer) remaining milliseconds until departure (0 if not waiting)
37 -** **spdSlow** - the integer PWM value of this train while driving slow
36 +** **waiting** - boolean value, true if the train is waiting in a station, false otherwise 
37 +** **{{status colour="Green" title="NEW"/}}waitTime** - (integer) timestamp, when the train is allowed to depart, should only be interpreted if **waiting** is true 
38 +** **{{status colour="Green" title="NEW"/}}spdSlow** - the integer PWM value of this train while driving slow
38 38  ** **spdCaution** - the integer PWM value of this train while driving caution
39 39  ** **spdNormal** - the integer PWM value of this train while driving normally
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.
41 +** **currentIndex** -an integer describing the current position in the schedule
42 42  ** (((
43 -**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
44 44  
45 45  |=(((
46 46  Number
... ... @@ -64,75 +64,75 @@
64 64  Track
65 65  )))
66 66  |(((
67 -9
67 +1
68 68  )))|(((
69 69  KH_ST_1
70 70  )))|(% colspan="1" %)(% colspan="1" %)
71 71  (((
72 -17
72 +6
73 73  )))|(% colspan="1" %)(% colspan="1" %)
74 74  (((
75 75  KH_ST_1 (reverse)
76 76  )))|(((
77 -25
77 +11
78 78  )))|(((
79 -IC_ST_1
79 +IC_ST_3
80 80  )))|(% colspan="1" %)(% colspan="1" %)
81 81  (((
82 -33
82 +14
83 83  )))|(% colspan="1" %)(% colspan="1" %)
84 84  (((
85 -OC_ST_1
85 +OC_ST_3
86 86  )))
87 87  |(((
88 -10
88 +2
89 89  )))|(((
90 90  KH_ST_2
91 91  )))|(% colspan="1" %)(% colspan="1" %)
92 92  (((
93 -18
93 +7
94 94  )))|(% colspan="1" %)(% colspan="1" %)
95 95  (((
96 96  KH_ST_2 (reverse)
97 97  )))|(((
98 -26
98 +12
99 99  )))|(((
100 100  IC_ST_2
101 101  )))|(% colspan="1" %)(% colspan="1" %)
102 102  (((
103 -34
103 +15
104 104  )))|(% colspan="1" %)(% colspan="1" %)
105 105  (((
106 106  OC_ST_2
107 107  )))
108 108  |(((
109 -11
109 +3
110 110  )))|(((
111 111  KH_ST_3
112 112  )))|(% colspan="1" %)(% colspan="1" %)
113 113  (((
114 -19
114 +8
115 115  )))|(% colspan="1" %)(% colspan="1" %)
116 116  (((
117 117  KH_ST_3 (reverse)
118 118  )))|(((
119 -27
119 +13
120 120  )))|(((
121 -IC_ST_3
121 +IC_ST_1
122 122  )))|(% colspan="1" %)(% colspan="1" %)
123 123  (((
124 -35
124 +16
125 125  )))|(% colspan="1" %)(% colspan="1" %)
126 126  (((
127 -OC_ST_3
127 +OC_ST_1
128 128  )))
129 129  |(((
130 -12
130 +4
131 131  )))|(((
132 132  KH_ST_4
133 133  )))|(% colspan="1" %)(% colspan="1" %)
134 134  (((
135 -20
135 +9
136 136  )))|(% colspan="1" %)(% colspan="1" %)
137 137  (((
138 138  KH_ST_4 (reverse)
... ... @@ -148,12 +148,12 @@
148 148  
149 149  )))
150 150  |(((
151 -13
151 +5
152 152  )))|(((
153 153  KH_ST_5
154 154  )))|(% colspan="1" %)(% colspan="1" %)
155 155  (((
156 -21
156 +10
157 157  )))|(% colspan="1" %)(% colspan="1" %)
158 158  (((
159 159  KH_ST_5 (reverse)
... ... @@ -170,34 +170,22 @@
170 170  )))
171 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. 3 element array [min,avg,max].
174 -* **overallTime** -  Time consumption of overall controller loop. 3 element array [min,avg,max].
175 175  
176 -
177 -
178 178  {{code title="Sample status" language="js" collapse="true"}}
179 179  {"msgType":"status",
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]}
176 + "data":{
177 + "debug":false,
178 + "cleanup":false,
179 + "pause":false,
180 + "trainCount":8,
181 + "trains":[
182 + {"trainNum":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":2, "schedule":[8, 10, 25, 29, 41, 43]},
183 + {"trainNum":1, "spdSlow":50, "spdCaution":70, "spdNormal":100, "currentIndex":0, "schedule":[8]},
184 + ... ],
185 + "locks":[-1, -1, -1, 5, -1, -1, 2, 10, -1, -1, ..., -1]}}
198 198  
199 199  [One line to test via netcat]
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]}
188 +{"msgType":"status", "data":{"debug":false, "cleanup":false, "pause":false, "trainCount":8, "trains":[ {"trainNum":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":2, "schedule":[1, 1, 11, 14, 6]}, {"trainNum":1, "spdSlow":51, "spdCaution":71, "spdNormal":101, "currentIndex":0, "schedule":[2, 1, 11, 14, 6]}, {"trainNum":2, "spdSlow":52, "spdCaution":72, "spdNormal":102, "currentIndex":1, "schedule":[3, 1, 11, 14, 6]}, {"trainNum":3, "spdSlow":53, "spdCaution":73, "spdNormal":103, "currentIndex":1, "schedule":[4, 1, 11, 14, 6]}, {"trainNum":4, "spdSlow":54, "spdCaution":74, "spdNormal":104, "currentIndex":2, "schedule":[5, 1, 11, 14, 6]}, {"trainNum":5, "spdSlow":55, "spdCaution":75, "spdNormal":105, "currentIndex":3, "schedule":[6, 1, 11, 14, 6]}, {"trainNum":6, "spdSlow":56, "spdCaution":76, "spdNormal":106, "currentIndex":1, "schedule":[7, 1, 11, 14, 6]}, {"trainNum":7, "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]}}
201 201  {{/code}}
202 202  
203 203  == Messages received by controller ==
... ... @@ -207,14 +207,14 @@
207 207  
208 208  === Valid commands ===
209 209  
210 -* //STATUS// - Poll for the current status, should trigger a status reply message
211 211  * //SHUTDOWN// - Causing the controller to end the program and close all sockets
212 212  * //LOGOUT// - Closing the connection, leaving the controller running
213 -* //PAUSE// - suspend or resume the controller, must supply additional payload
214 -** **state** - boolean value, true if controller should be suspended
200 +* //STATUS// - Poll for the current status, should trigger a status reply message
215 215  * //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks
216 216  * //DEBUG// - enable or disable verbose output, must supply additional payload
217 217  ** **state** - boolean value, true if verbose output should be activated
204 +* //PAUSE// - suspend or resume the controller, must supply additional payload
205 +** **state** - boolean value, true if controller should be suspended
218 218  * //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
219 219  ** **state** - boolean value, true if lights should be lit
220 220  * //WAIT// - Force a train to wait in the next station, must supply additional payload
... ... @@ -225,11 +225,11 @@
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
216 +* //SPEED// - 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 231  * //TIME// - 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.
221 +** **times** -
234 234  
235 -{{status colour="Yellow" title="New definition"/}}
223 +{{status colour="Yellow" title="Define a format for this"/}}
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9471606
1 +9471528
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471606/TCP Communication
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471528/TCP Communication

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage