Changes for page TCP Communication

Last modified by csp on 2025/01/30 12:05
<
From version < 25.1 >
edited by nbw
on 2014/07/30 14:20
To version < 17.1 >
edited by nbw
on 2014/07/18 11:26
>
Change comment: Adjusted station track encoding to fit bit masking

Summary

Details

Page properties
Content
... ... @@ -30,18 +30,21 @@
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 -* **trains** - a JSON Array with the data of all trains, each entry is a JSON Object with these values
35 -** **state** - integer value for current train state (0 = travelling, 1 = waiting, 2 = forced travel, 3 = forced wait)
36 -** **waitTime** - (integer) remaining milliseconds until departure (0 if not waiting)
37 -** **spdSlow** - the integer PWM value of this train while driving slow
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
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 -** **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 +** **currentIndex** -an integer describing the current position in the schedule
42 42  ** (((
43 43  **schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
44 44  
46 +{{status colour="Yellow" title="CHANGED"/}}
47 +
45 45  |=(((
46 46  Number
47 47  )))|=(((
... ... @@ -176,28 +176,22 @@
176 176  
177 177  
178 178  {{code title="Sample status" language="js" collapse="true"}}
182 +<<OUTDATED>>
183 +
179 179  {"msgType":"status",
180 - "data":{
181 - "debug":false,
182 - "cleanup":false,
183 - "pause":false,
184 - "trainCount":8,
185 - "trains":[
186 - {"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]},
187 - {"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]},
188 - {"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]},
189 - {"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]},
190 - {"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]},
191 - {"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]},
192 - {"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]},
193 - {"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]},
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]}
185 + "data":{
186 + "debug":false,
187 + "cleanup":false,
188 + "pause":false,
189 + "trainCount":8,
190 + "trains":[
191 + {"trainNum":0, "waiting":false, "waitTime":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":2, "schedule":[8, 10, 25, 29, 41, 43]},
192 + {"trainNum":1, "waiting":true, "waitTime":1234545667, "spdSlow":50, "spdCaution":70, "spdNormal":100, "currentIndex":0, "schedule":[8]},
193 + ... ],
194 + "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]}
197 +{"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]}}
201 201  {{/code}}
202 202  
203 203  == Messages received by controller ==
... ... @@ -212,22 +212,25 @@
212 212  * //LOGOUT// - Closing the connection, leaving the controller running
213 213  * //PAUSE// - suspend or resume the controller, must supply additional payload
214 214  ** **state** - boolean value, true if controller should be suspended
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
212 +* //WRITE// - Acquire write access mutex to the controller
213 +* //CLEANUP// (//write//) - Start the cleanup procedure, sending the trains back to their home tacks
214 +* //DEBUG// (//write//) - enable or disable verbose output, must supply additional payload
217 217  ** **state** - boolean value, true if verbose output should be activated
218 -* //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
216 +* //LIGHT (write//) - activate or deactivate the lights on the railway, must supply additional payload\\
219 219  ** **state** - boolean value, true if lights should be lit
220 -* //WAIT// - Force a train to wait in the next station, must supply additional payload
218 +* //WAIT// (//write//) - Force a train to wait in the next station, must supply additional payload
221 221  ** **train** - integer train identification
222 -* //START// - Force a waiting train to immediately abort the waiting timer, must supply additional payload
220 +* //START (write//) - Force a waiting train to immediately abort the waiting timer, must supply additional payload
223 223  ** **train** - integer train identification
224 -* //SCHEDULE// - Set the new schedule for a train, needs additional payload
222 +* //SCHEDULE// (//write//) - Set the new schedule for a train, needs additional payload
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
226 +* //SPEED (write//) - 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 -* //TIME// - Change the waiting times for a train
229 +* //TIME// (//write//) - 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.
231 +** **times** -
232 +
233 +{{status colour="Yellow" title="Define a format for this"/}}
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9471614
1 +9471580
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471614/TCP Communication
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471580/TCP Communication

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage