Skip to Content

Wiki source code of TCP Communication

Version 38.1 by Alexander Schulz-Rosengarten on 2014/08/18 11:57
Hide last authors
nbw 1.1 1
2
nbw 6.1 3 {{toc/}}
4
nbw 1.1 5 Both the controller and the client GUI send their data as JSON Objects.
6 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).
7 For more information or a complete grammar see [[http:~~/~~/www.json.org/>>url:http://www.json.org/||shape="rect"]].
8
9 == Messages sent by Controller ==
10
11 * Every message must provide the keys **msgType** and **data**.
12 * Valid values for **msgType** are// log//, //error// or// status//.
13
14 === Log messages ===
15
16 For //log// messages the **data** segment consists of a JSON Array, containing zero or more strings.
17
18 === Error messages ===
19
20 For //error// messages the **data** segment consists of one single string, describing the error.
21
22 === Status messages ===
23
24 In //status// messages the **data** segment is a JSON Object which must contain the following key/value pairs.
25
26 * **debug** - true if the controller is set to verbose debug output, false otherwise
27 * **cleanup** - true after cleanup mode has been engaged, false before that point
28 * **pause** - true while the controller is paused, false otherwise
29 * **trainCount** - an integer with the number of active trains on the railway
nbw 25.1 30 * **trains** - a JSON Array with the data of all trains, each entry is a JSON Object with these values
Alexander Schulz-Rosengarten 37.1 31 ** **state** - integer value for current train state (0 = travelling, 1 = waiting, 2 = travelling until next station, 3 = forced wait, 4 = no schedule)
nbw 21.1 32 ** **waitTime** - (integer) remaining milliseconds until departure (0 if not waiting)
33 ** **spdSlow** - the integer PWM value of this train while driving slow
nbw 1.1 34 ** **spdCaution** - the integer PWM value of this train while driving caution
35 ** **spdNormal** - the integer PWM value of this train while driving normally
nbw 23.1 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.
nbw 21.1 37 ** **currentIndex** - an integer describing the current position in the schedule
nbw 8.1 38 ** (((
nbw 17.1 39 **schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
nbw 4.1 40
nbw 8.1 41 |=(((
42 Number
43 )))|=(((
44 Track
45 )))|=(% colspan="1" %)(% colspan="1" %)
46 (((
47 Number
48 )))|=(% colspan="1" %)(% colspan="1" %)
49 (((
50 Track
51 )))|=(((
52 Number
53 )))|=(((
54 Track
55 )))|=(% colspan="1" %)(% colspan="1" %)
56 (((
57 Number
58 )))|=(% colspan="1" %)(% colspan="1" %)
59 (((
60 Track
61 )))
62 |(((
nbw 17.1 63 9
nbw 8.1 64 )))|(((
65 KH_ST_1
66 )))|(% colspan="1" %)(% colspan="1" %)
67 (((
nbw 17.1 68 17
nbw 8.1 69 )))|(% colspan="1" %)(% colspan="1" %)
70 (((
71 KH_ST_1 (reverse)
72 )))|(((
nbw 17.1 73 25
nbw 8.1 74 )))|(((
Alexander Schulz-Rosengarten 15.1 75 IC_ST_1
nbw 8.1 76 )))|(% colspan="1" %)(% colspan="1" %)
77 (((
nbw 17.1 78 33
nbw 8.1 79 )))|(% colspan="1" %)(% colspan="1" %)
80 (((
Alexander Schulz-Rosengarten 15.1 81 OC_ST_1
nbw 8.1 82 )))
83 |(((
nbw 17.1 84 10
nbw 8.1 85 )))|(((
86 KH_ST_2
87 )))|(% colspan="1" %)(% colspan="1" %)
88 (((
nbw 17.1 89 18
nbw 8.1 90 )))|(% colspan="1" %)(% colspan="1" %)
91 (((
92 KH_ST_2 (reverse)
93 )))|(((
nbw 17.1 94 26
nbw 8.1 95 )))|(((
96 IC_ST_2
97 )))|(% colspan="1" %)(% colspan="1" %)
98 (((
nbw 17.1 99 34
nbw 8.1 100 )))|(% colspan="1" %)(% colspan="1" %)
101 (((
102 OC_ST_2
103 )))
104 |(((
nbw 17.1 105 11
nbw 8.1 106 )))|(((
107 KH_ST_3
108 )))|(% colspan="1" %)(% colspan="1" %)
109 (((
nbw 17.1 110 19
nbw 8.1 111 )))|(% colspan="1" %)(% colspan="1" %)
112 (((
113 KH_ST_3 (reverse)
114 )))|(((
nbw 17.1 115 27
nbw 8.1 116 )))|(((
Alexander Schulz-Rosengarten 15.1 117 IC_ST_3
nbw 8.1 118 )))|(% colspan="1" %)(% colspan="1" %)
119 (((
nbw 17.1 120 35
nbw 8.1 121 )))|(% colspan="1" %)(% colspan="1" %)
122 (((
Alexander Schulz-Rosengarten 15.1 123 OC_ST_3
nbw 8.1 124 )))
125 |(((
nbw 17.1 126 12
nbw 8.1 127 )))|(((
128 KH_ST_4
129 )))|(% colspan="1" %)(% colspan="1" %)
130 (((
nbw 17.1 131 20
nbw 8.1 132 )))|(% colspan="1" %)(% colspan="1" %)
133 (((
134 KH_ST_4 (reverse)
135 )))|(((
136
137 )))|(((
138
139 )))|(% colspan="1" %)(% colspan="1" %)
140 (((
141
142 )))|(% colspan="1" %)(% colspan="1" %)
143 (((
144
145 )))
146 |(((
nbw 17.1 147 13
nbw 8.1 148 )))|(((
149 KH_ST_5
150 )))|(% colspan="1" %)(% colspan="1" %)
151 (((
nbw 17.1 152 21
nbw 8.1 153 )))|(% colspan="1" %)(% colspan="1" %)
154 (((
155 KH_ST_5 (reverse)
156 )))|(((
157
158 )))|(((
159
160 )))|(% colspan="1" %)(% colspan="1" %)
161 (((
162
163 )))|(% colspan="1" %)(% colspan="1" %)
164 (((
165
166 )))
167 )))
168 * **locks** - a JSON Array containing the current value of the track permissions, ordered by the default encoding (Hoermann API)
Alexander Schulz-Rosengarten 38.1 169 **tickTime** - Time consumption of tick function in milliseconds. 3 element double-array [min,avg,max]. 
170 **overallTime** -  Time consumption of overall controller loop in milliseconds. 3 element double-array [min,avg,max].
nbw 8.1 171
Alexander Schulz-Rosengarten 16.1 172
173
nbw 4.1 174 {{code title="Sample status" language="js" collapse="true"}}
175 {"msgType":"status",
nbw 28.1 176 "data":{
177 "debug":false,
178 "cleanup":false,
179 "pause":false,
180 "trainCount":8,
181 "trains":[
182 {"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]},
183 {"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]},
184 {"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]},
185 {"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]},
186 {"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]},
187 {"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]},
188 {"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]},
nbw 30.1 189 {"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]}
nbw 28.1 190 ],
191 "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],
192 "tickTime":[50,60,70],
193 "overallTime":[70,80,90]}}
nbw 9.1 194
195 [One line to test via netcat]
nbw 30.1 196 {"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]},{"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]},{"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]},{"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]},{"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]},{"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]},{"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]},{"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]}],"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]}}
nbw 4.1 197 {{/code}}
nbw 5.1 198
Alexander Schulz-Rosengarten 38.1 199 == Messages received by controller ==
nbw 5.1 200
csp 33.1 201 * Every message must contain the keys **command **and **data**.
202 * Valid values for **command **are the following uppercase commands.
203 * Depending on the command, the **data**-object contains the described infos.
204 ** If a command doesn't require any additional information, the data-object may be omitted or empty.
205
nbw 5.1 206 === Valid commands ===
207
csp 13.1 208 * //STATUS// - Poll for the current status, should trigger a status reply message
nbw 5.1 209 * //SHUTDOWN// - Causing the controller to end the program and close all sockets
210 * //LOGOUT// - Closing the connection, leaving the controller running
211 * //PAUSE// - suspend or resume the controller, must supply additional payload
nbw 6.1 212 ** **state** - boolean value, true if controller should be suspended
nbw 21.1 213 * //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks
214 * //DEBUG// - enable or disable verbose output, must supply additional payload
Alexander Schulz-Rosengarten 12.1 215 ** **state** - boolean value, true if verbose output should be activated
Alexander Schulz-Rosengarten 38.1 216 * //ECHO// - Prints message as log message on the server (will be broadcasted to all clients)\\
Alexander Schulz-Rosengarten 35.1 217 ** **message** - string, message text
nbw 21.1 218 * //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
nbw 5.1 219 ** **state** - boolean value, true if lights should be lit
nbw 21.1 220 * //WAIT// - Force a train to wait in the next station, must supply additional payload
nbw 5.1 221 ** **train** - integer train identification
nbw 21.1 222 * //START// - Force a waiting train to immediately abort the waiting timer, must supply additional payload
nbw 5.1 223 ** **train** - integer train identification
nbw 21.1 224 * //SCHEDULE// - Set the new schedule for a train, needs additional payload
nbw 5.1 225 ** **train** - integer train identification
226 ** **currentIndex** - current integer position in the schedule array
nbw 8.1 227 ** **tracks** - a JSON Array of integer values, representing the station tracks in encoding above
nbw 21.1 228 * //SPEED //- Change the speed settings of a train, needs additional payload
nbw 5.1 229 ** **train** - integer train identification
230 ** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
nbw 21.1 231 * //TIME// - Change the waiting times for a train
nbw 5.1 232 ** **train** - integer train identification
nbw 22.1 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.