Changes for page TCP Communication

Last modified by csp on 2025/01/30 12:05
<
From version < 9.1 >
edited by nbw
on 2014/07/08 14:59
To version < 40.1 >
edited by csp
on 2014/08/19 13:20
>
Change comment: train has currentDestination attribute

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.nbw
1 +XWiki.csp
Content
... ... @@ -2,10 +2,6 @@
2 2  
3 3  {{toc/}}
4 4  
5 -
6 -
7 -{{status colour="Red" title="Work in progress - Might bE subject to change"/}}
8 -
9 9  Both the controller and the client GUI send their data as JSON Objects.
10 10  In JSON every Object is an unordered set of key/value pairs. The values of these pairs can be a JSON Object, a JSON Array or a primitive value (integer, string, boolean or null).
11 11  For more information or a complete grammar see [[http:~~/~~/www.json.org/>>url:http://www.json.org/||shape="rect"]].
... ... @@ -31,15 +31,22 @@
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 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 -** **trainNum** - the individual controller number of the train
36 -** **spdSlow** - the integer PWM value of this train while driving slow
37 -** **spdCaution** - the integer PWM value of this train while driving caution
38 -** **spdNormal** - the integer PWM value of this train while driving normally
39 -** **currentIndex** -an integer describing the current position in the schedule
40 -** (((
41 -**schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
30 +* (((
31 +**trains** - a JSON Array with the data of all trains, each entry is a JSON Object with these values* **state** - integer value for current train state (0 = travelling, 1 = waiting, 2 = travelling until next station, 3 = forced wait, 4 = no schedule)
32 +* **waitTime** - (integer) remaining milliseconds until departure (0 if not waiting)
33 +* **spdSlow** - the integer PWM value of this train while driving slow
34 +* **spdCaution** - the integer PWM value of this train while driving caution
35 +* **spdNormal** - the integer PWM value of this train while driving normally
36 +* **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.
37 +* **currentIndex** - an integer describing the current position in the schedule
38 +* (((
39 +**schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
40 +)))
41 +* (((
42 +**currentDestination** - the current destination track, encoded in the following fashion 
42 42  
44 +{{status colour="Green" title="NEW"/}}
45 +
43 43  |=(((
44 44  Number
45 45  )))|=(((
... ... @@ -62,75 +62,75 @@
62 62  Track
63 63  )))
64 64  |(((
65 -1
68 +9
66 66  )))|(((
67 67  KH_ST_1
68 68  )))|(% colspan="1" %)(% colspan="1" %)
69 69  (((
70 -6
73 +17
71 71  )))|(% colspan="1" %)(% colspan="1" %)
72 72  (((
73 73  KH_ST_1 (reverse)
74 74  )))|(((
75 -11
78 +25
76 76  )))|(((
77 -IC_ST_3
80 +IC_ST_1
78 78  )))|(% colspan="1" %)(% colspan="1" %)
79 79  (((
80 -14
83 +33
81 81  )))|(% colspan="1" %)(% colspan="1" %)
82 82  (((
83 -OC_ST_3
86 +OC_ST_1
84 84  )))
85 85  |(((
86 -2
89 +10
87 87  )))|(((
88 88  KH_ST_2
89 89  )))|(% colspan="1" %)(% colspan="1" %)
90 90  (((
91 -7
94 +18
92 92  )))|(% colspan="1" %)(% colspan="1" %)
93 93  (((
94 94  KH_ST_2 (reverse)
95 95  )))|(((
96 -12
99 +26
97 97  )))|(((
98 98  IC_ST_2
99 99  )))|(% colspan="1" %)(% colspan="1" %)
100 100  (((
101 -15
104 +34
102 102  )))|(% colspan="1" %)(% colspan="1" %)
103 103  (((
104 104  OC_ST_2
105 105  )))
106 106  |(((
107 -3
110 +11
108 108  )))|(((
109 109  KH_ST_3
110 110  )))|(% colspan="1" %)(% colspan="1" %)
111 111  (((
112 -8
115 +19
113 113  )))|(% colspan="1" %)(% colspan="1" %)
114 114  (((
115 115  KH_ST_3 (reverse)
116 116  )))|(((
117 -13
120 +27
118 118  )))|(((
119 -IC_ST_1
122 +IC_ST_3
120 120  )))|(% colspan="1" %)(% colspan="1" %)
121 121  (((
122 -16
125 +35
123 123  )))|(% colspan="1" %)(% colspan="1" %)
124 124  (((
125 -OC_ST_1
128 +OC_ST_3
126 126  )))
127 127  |(((
128 -4
131 +12
129 129  )))|(((
130 130  KH_ST_4
131 131  )))|(% colspan="1" %)(% colspan="1" %)
132 132  (((
133 -9
136 +20
134 134  )))|(% colspan="1" %)(% colspan="1" %)
135 135  (((
136 136  KH_ST_4 (reverse)
... ... @@ -146,12 +146,12 @@
146 146  
147 147  )))
148 148  |(((
149 -5
152 +13
150 150  )))|(((
151 151  KH_ST_5
152 152  )))|(% colspan="1" %)(% colspan="1" %)
153 153  (((
154 -10
157 +21
155 155  )))|(% colspan="1" %)(% colspan="1" %)
156 156  (((
157 157  KH_ST_5 (reverse)
... ... @@ -167,40 +167,56 @@
167 167  
168 168  )))
169 169  )))
173 +)))
170 170  * **locks** - a JSON Array containing the current value of the track permissions, ordered by the default encoding (Hoermann API)
175 +* **tickTime** - Time consumption of tick function in milliseconds. 3 element double-array [min,avg,max].
176 +* **overallTime** -  Time consumption of overall controller loop in milliseconds. 3 element double-array [min,avg,max].
171 171  
178 +
179 +
172 172  {{code title="Sample status" language="js" collapse="true"}}
173 173  {"msgType":"status",
174 - "data":{
175 - "debug":false,
176 - "cleanup":false,
177 - "pause":false,
178 - "trainCount":8,
179 - "trains":[
180 - {"trainNum":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":2, "schedule":[8, 10, 25, 29, 41, 43]},
181 - {"trainNum":1, "spdSlow":50, "spdCaution":70, "spdNormal":100, "currentIndex":0, "schedule":[8]},
182 - ... ],
183 - "locks":[-1, -1, -1, 5, -1, -1, 2, 10, -1, -1, ..., -1]}}
184 -
182 +"data":{
183 + "debug":false,
184 + "cleanup":false,
185 + "pause":false,
186 + "trainCount":8,
187 + "trains":[
188 + {"state":3,"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],"currentDestination":9},
189 + {"state":1,"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],"currentDestination":13},
190 + {"state":0,"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],"currentDestination":13},
191 + {"state":0,"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],"currentDestination":13},
192 + {"state":0,"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],"currentDestination":27},
193 + {"state":1,"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],"currentDestination":9},
194 + {"state":2,"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],"currentDestination":10},
195 + {"state":0,"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":4,"schedule":[9,13,17,21,25,27,33,35],"currentDestination":21}
196 + ],
197 + "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],
198 + "tickTime":[50,60,70],
199 + "overallTime":[70,80,90]}}
185 185  [One line to test via netcat]
186 -{"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 +{"msgType":"status","data":{"debug":false,"cleanup":false,"pause":false,"trainCount":8,"trains":[{"state":3,"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],"currentDestination":9},{"state":1,"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],"currentDestination":13},{"state":0,"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],"currentDestination":13},{"state":0,"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],"currentDestination":13},{"state":0,"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],"currentDestination":27},{"state":1,"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],"currentDestination":9},{"state":2,"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],"currentDestination":10},{"state":0,"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":4,"schedule":[9,13,17,21,25,27,33,35],"currentDestination":21}],"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]}}
187 187  {{/code}}
188 188  
189 189  == Messages received by controller ==
190 190  
191 -* Every message must contain the key **command**.
192 -* Depending on the command, additional keys might be required.
206 +* Every message must contain the keys **command **and **data**.
207 +* Valid values for **command **are the following uppercase commands.
208 +* Depending on the command, the **data**-object contains the described infos.
209 +** If a command doesn't require any additional information, the data-object may be omitted or empty.
193 193  
194 194  === Valid commands ===
195 195  
213 +* //STATUS// - Poll for the current status, should trigger a status reply message
196 196  * //SHUTDOWN// - Causing the controller to end the program and close all sockets
197 197  * //LOGOUT// - Closing the connection, leaving the controller running
198 -* //STATUS// - Poll for the current status, should trigger a status reply message
216 +* //PAUSE// - suspend or resume the controller, must supply additional payload
217 +** **state** - boolean value, true if controller should be suspended
199 199  * //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks
200 200  * //DEBUG// - enable or disable verbose output, must supply additional payload
201 201  ** **state** - boolean value, true if verbose output should be activated
202 -* //PAUSE// - suspend or resume the controller, must supply additional payload
203 -** **state** - boolean value, true if controller should be suspended
221 +* //ECHO// - Prints message as log message on the server (will be broadcasted to all clients)\\
222 +** **message** - string, message text
204 204  * //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
205 205  ** **state** - boolean value, true if lights should be lit
206 206  * //WAIT// - Force a train to wait in the next station, must supply additional payload
... ... @@ -211,11 +211,9 @@
211 211  ** **train** - integer train identification
212 212  ** **currentIndex** - current integer position in the schedule array
213 213  ** **tracks** - a JSON Array of integer values, representing the station tracks in encoding above
214 -* //SPEED// - Change the speed settings of a train, needs additional payload
233 +* //SPEED //- Change the speed settings of a train, needs additional payload
215 215  ** **train** - integer train identification
216 216  ** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
217 217  * //TIME// - Change the waiting times for a train
218 218  ** **train** - integer train identification
219 -** **times** -
220 -
221 -{{status colour="Yellow" title="Define a format for this"/}}
238 +**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.
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9471522
1 +9471739
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471522/TCP Communication
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471739/TCP Communication

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage