Changes for page TCP Communication

Last modified by csp on 2025/01/30 12:05
<
From version < 18.1 >
edited by nbw
on 2014/07/18 12:47
To version < 11.1 >
edited by nbw
on 2014/07/10 18:36
>
Change comment: Updated sample state

Summary

Details

Page properties
Content
... ... @@ -30,21 +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
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 +** **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
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 42  ** **currentIndex** -an integer describing the current position in the schedule
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 -{{status colour="Yellow" title="CHANGED"/}}
47 -
48 48  |=(((
49 49  Number
50 50  )))|=(((
... ... @@ -67,75 +67,75 @@
67 67  Track
68 68  )))
69 69  |(((
70 -9
67 +1
71 71  )))|(((
72 72  KH_ST_1
73 73  )))|(% colspan="1" %)(% colspan="1" %)
74 74  (((
75 -17
72 +6
76 76  )))|(% colspan="1" %)(% colspan="1" %)
77 77  (((
78 78  KH_ST_1 (reverse)
79 79  )))|(((
80 -25
77 +11
81 81  )))|(((
82 -IC_ST_1
79 +IC_ST_3
83 83  )))|(% colspan="1" %)(% colspan="1" %)
84 84  (((
85 -33
82 +14
86 86  )))|(% colspan="1" %)(% colspan="1" %)
87 87  (((
88 -OC_ST_1
85 +OC_ST_3
89 89  )))
90 90  |(((
91 -10
88 +2
92 92  )))|(((
93 93  KH_ST_2
94 94  )))|(% colspan="1" %)(% colspan="1" %)
95 95  (((
96 -18
93 +7
97 97  )))|(% colspan="1" %)(% colspan="1" %)
98 98  (((
99 99  KH_ST_2 (reverse)
100 100  )))|(((
101 -26
98 +12
102 102  )))|(((
103 103  IC_ST_2
104 104  )))|(% colspan="1" %)(% colspan="1" %)
105 105  (((
106 -34
103 +15
107 107  )))|(% colspan="1" %)(% colspan="1" %)
108 108  (((
109 109  OC_ST_2
110 110  )))
111 111  |(((
112 -11
109 +3
113 113  )))|(((
114 114  KH_ST_3
115 115  )))|(% colspan="1" %)(% colspan="1" %)
116 116  (((
117 -19
114 +8
118 118  )))|(% colspan="1" %)(% colspan="1" %)
119 119  (((
120 120  KH_ST_3 (reverse)
121 121  )))|(((
122 -27
119 +13
123 123  )))|(((
124 -IC_ST_3
121 +IC_ST_1
125 125  )))|(% colspan="1" %)(% colspan="1" %)
126 126  (((
127 -35
124 +16
128 128  )))|(% colspan="1" %)(% colspan="1" %)
129 129  (((
130 -OC_ST_3
127 +OC_ST_1
131 131  )))
132 132  |(((
133 -12
130 +4
134 134  )))|(((
135 135  KH_ST_4
136 136  )))|(% colspan="1" %)(% colspan="1" %)
137 137  (((
138 -20
135 +9
139 139  )))|(% colspan="1" %)(% colspan="1" %)
140 140  (((
141 141  KH_ST_4 (reverse)
... ... @@ -151,12 +151,12 @@
151 151  
152 152  )))
153 153  |(((
154 -13
151 +5
155 155  )))|(((
156 156  KH_ST_5
157 157  )))|(% colspan="1" %)(% colspan="1" %)
158 158  (((
159 -21
156 +10
160 160  )))|(% colspan="1" %)(% colspan="1" %)
161 161  (((
162 162  KH_ST_5 (reverse)
... ... @@ -173,34 +173,22 @@
173 173  )))
174 174  )))
175 175  * **locks** - a JSON Array containing the current value of the track permissions, ordered by the default encoding (Hoermann API)
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].
178 178  
179 -
180 -
181 181  {{code title="Sample status" language="js" collapse="true"}}
182 182  {"msgType":"status",
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]}
176 + "data":{
177 + "debug":false,
178 + "cleanup":false,
179 + "pause":false,
180 + "trainCount":8,
181 + "trains":[
182 + {"trainNum":0, "waiting":false, "waitTime":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":2, "schedule":[8, 10, 25, 29, 41, 43]},
183 + {"trainNum":1, "waiting":true, "waitTime":1234545667, "spdSlow":50, "spdCaution":70, "spdNormal":100, "currentIndex":0, "schedule":[8]},
184 + ... ],
185 + "locks":[-1, -1, -1, 5, -1, -1, 2, 10, -1, -1, ..., -1]}}
201 201  
202 202  [One line to test via netcat]
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]}
188 +{"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]}}
204 204  {{/code}}
205 205  
206 206  == Messages received by controller ==
... ... @@ -210,29 +210,28 @@
210 210  
211 211  === Valid commands ===
212 212  
213 -* //STATUS// - Poll for the current status, should trigger a status reply message
214 214  * //SHUTDOWN// - Causing the controller to end the program and close all sockets
215 215  * //LOGOUT// - Closing the connection, leaving the controller running
200 +* //STATUS// - Poll for the current status, should trigger a status reply message
201 +* //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks
202 +* //DEBUG// - enable or disable verbose output, must supply additional payload
203 +** **state** - boolean value, true if verbose output should be activated
216 216  * //PAUSE// - suspend or resume the controller, must supply additional payload
217 217  ** **state** - boolean value, true if controller should be suspended
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
221 -** **state** - boolean value, true if verbose output should be activated
222 -* //LIGHT (write//) - activate or deactivate the lights on the railway, must supply additional payload\\
206 +* //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
223 223  ** **state** - boolean value, true if lights should be lit
224 -* //WAIT// (//write//) - Force a train to wait in the next station, must supply additional payload
208 +* //WAIT// - Force a train to wait in the next station, must supply additional payload
225 225  ** **train** - integer train identification
226 -* //START (write//) - Force a waiting train to immediately abort the waiting timer, must supply additional payload
210 +* //START// - Force a waiting train to immediately abort the waiting timer, must supply additional payload
227 227  ** **train** - integer train identification
228 -* //SCHEDULE// (//write//) - Set the new schedule for a train, needs additional payload
212 +* //SCHEDULE// - Set the new schedule for a train, needs additional payload
229 229  ** **train** - integer train identification
230 230  ** **currentIndex** - current integer position in the schedule array
231 231  ** **tracks** - a JSON Array of integer values, representing the station tracks in encoding above
232 -* //SPEED (write//) - Change the speed settings of a train, needs additional payload
216 +* //SPEED// - Change the speed settings of a train, needs additional payload
233 233  ** **train** - integer train identification
234 234  ** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
235 -* //TIME// (//write//) - Change the waiting times for a train
219 +* //TIME// - Change the waiting times for a train
236 236  ** **train** - integer train identification
237 237  ** **times** -
238 238  
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9471597
1 +9471534
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471597/TCP Communication
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471534/TCP Communication

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage