Skip to Content

Wiki source code of TCP Communication

Version 20.1 by nbw on 2014/07/25 09:01
Hide last authors
nbw 1.1 1
2
nbw 6.1 3 {{toc/}}
4
5
6
csp 7.1 7 {{status colour="Red" title="Work in progress - Might bE subject to change"/}}
nbw 1.1 8
9 Both the controller and the client GUI send their data as JSON Objects.
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 For more information or a complete grammar see [[http:~~/~~/www.json.org/>>url:http://www.json.org/||shape="rect"]].
12
13 == Messages sent by Controller ==
14
15 * Every message must provide the keys **msgType** and **data**.
16 * Valid values for **msgType** are// log//, //error// or// status//.
17
18 === Log messages ===
19
20 For //log// messages the **data** segment consists of a JSON Array, containing zero or more strings.
21
22 === Error messages ===
23
24 For //error// messages the **data** segment consists of one single string, describing the error.
25
26 === Status messages ===
27
28 In //status// messages the **data** segment is a JSON Object which must contain the following key/value pairs.
29
30 * **debug** - true if the controller is set to verbose debug output, false otherwise
31 * **cleanup** - true after cleanup mode has been engaged, false before that point
32 * **pause** - true while the controller is paused, false otherwise
Alexander Schulz-Rosengarten 12.1 33 * **write** - true if receiving client has write access, false otherwise
nbw 1.1 34 * **trainCount** - an integer with the number of active trains on the railway
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
csp 13.1 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
nbw 1.1 40 ** **spdCaution** - the integer PWM value of this train while driving caution
41 ** **spdNormal** - the integer PWM value of this train while driving normally
42 ** **currentIndex** -an integer describing the current position in the schedule
nbw 8.1 43 ** (((
nbw 17.1 44 **schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
nbw 4.1 45
nbw 17.1 46 {{status colour="Yellow" title="CHANGED"/}}
47
nbw 8.1 48 |=(((
49 Number
50 )))|=(((
51 Track
52 )))|=(% colspan="1" %)(% colspan="1" %)
53 (((
54 Number
55 )))|=(% colspan="1" %)(% colspan="1" %)
56 (((
57 Track
58 )))|=(((
59 Number
60 )))|=(((
61 Track
62 )))|=(% colspan="1" %)(% colspan="1" %)
63 (((
64 Number
65 )))|=(% colspan="1" %)(% colspan="1" %)
66 (((
67 Track
68 )))
69 |(((
nbw 17.1 70 9
nbw 8.1 71 )))|(((
72 KH_ST_1
73 )))|(% colspan="1" %)(% colspan="1" %)
74 (((
nbw 17.1 75 17
nbw 8.1 76 )))|(% colspan="1" %)(% colspan="1" %)
77 (((
78 KH_ST_1 (reverse)
79 )))|(((
nbw 17.1 80 25
nbw 8.1 81 )))|(((
Alexander Schulz-Rosengarten 15.1 82 IC_ST_1
nbw 8.1 83 )))|(% colspan="1" %)(% colspan="1" %)
84 (((
nbw 17.1 85 33
nbw 8.1 86 )))|(% colspan="1" %)(% colspan="1" %)
87 (((
Alexander Schulz-Rosengarten 15.1 88 OC_ST_1
nbw 8.1 89 )))
90 |(((
nbw 17.1 91 10
nbw 8.1 92 )))|(((
93 KH_ST_2
94 )))|(% colspan="1" %)(% colspan="1" %)
95 (((
nbw 17.1 96 18
nbw 8.1 97 )))|(% colspan="1" %)(% colspan="1" %)
98 (((
99 KH_ST_2 (reverse)
100 )))|(((
nbw 17.1 101 26
nbw 8.1 102 )))|(((
103 IC_ST_2
104 )))|(% colspan="1" %)(% colspan="1" %)
105 (((
nbw 17.1 106 34
nbw 8.1 107 )))|(% colspan="1" %)(% colspan="1" %)
108 (((
109 OC_ST_2
110 )))
111 |(((
nbw 17.1 112 11
nbw 8.1 113 )))|(((
114 KH_ST_3
115 )))|(% colspan="1" %)(% colspan="1" %)
116 (((
nbw 17.1 117 19
nbw 8.1 118 )))|(% colspan="1" %)(% colspan="1" %)
119 (((
120 KH_ST_3 (reverse)
121 )))|(((
nbw 17.1 122 27
nbw 8.1 123 )))|(((
Alexander Schulz-Rosengarten 15.1 124 IC_ST_3
nbw 8.1 125 )))|(% colspan="1" %)(% colspan="1" %)
126 (((
nbw 17.1 127 35
nbw 8.1 128 )))|(% colspan="1" %)(% colspan="1" %)
129 (((
Alexander Schulz-Rosengarten 15.1 130 OC_ST_3
nbw 8.1 131 )))
132 |(((
nbw 17.1 133 12
nbw 8.1 134 )))|(((
135 KH_ST_4
136 )))|(% colspan="1" %)(% colspan="1" %)
137 (((
nbw 17.1 138 20
nbw 8.1 139 )))|(% colspan="1" %)(% colspan="1" %)
140 (((
141 KH_ST_4 (reverse)
142 )))|(((
143
144 )))|(((
145
146 )))|(% colspan="1" %)(% colspan="1" %)
147 (((
148
149 )))|(% colspan="1" %)(% colspan="1" %)
150 (((
151
152 )))
153 |(((
nbw 17.1 154 13
nbw 8.1 155 )))|(((
156 KH_ST_5
157 )))|(% colspan="1" %)(% colspan="1" %)
158 (((
nbw 17.1 159 21
nbw 8.1 160 )))|(% colspan="1" %)(% colspan="1" %)
161 (((
162 KH_ST_5 (reverse)
163 )))|(((
164
165 )))|(((
166
167 )))|(% colspan="1" %)(% colspan="1" %)
168 (((
169
170 )))|(% colspan="1" %)(% colspan="1" %)
171 (((
172
173 )))
174 )))
175 * **locks** - a JSON Array containing the current value of the track permissions, ordered by the default encoding (Hoermann API)
Alexander Schulz-Rosengarten 16.1 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].
nbw 8.1 178
Alexander Schulz-Rosengarten 16.1 179
180
nbw 4.1 181 {{code title="Sample status" language="js" collapse="true"}}
182 {"msgType":"status",
nbw 18.1 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]}
nbw 9.1 201
202 [One line to test via netcat]
nbw 18.1 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]}
nbw 4.1 204 {{/code}}
nbw 5.1 205
206 == Messages received by controller ==
207
208 * Every message must contain the key **command**.
209 * Depending on the command, additional keys might be required.
210
211 === Valid commands ===
212
csp 13.1 213 * //STATUS// - Poll for the current status, should trigger a status reply message
nbw 5.1 214 * //SHUTDOWN// - Causing the controller to end the program and close all sockets
215 * //LOGOUT// - Closing the connection, leaving the controller running
216 * //PAUSE// - suspend or resume the controller, must supply additional payload
nbw 6.1 217 ** **state** - boolean value, true if controller should be suspended
Alexander Schulz-Rosengarten 12.1 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\\
nbw 5.1 223 ** **state** - boolean value, true if lights should be lit
Alexander Schulz-Rosengarten 12.1 224 * //WAIT// (//write//) - Force a train to wait in the next station, must supply additional payload
nbw 5.1 225 ** **train** - integer train identification
Alexander Schulz-Rosengarten 12.1 226 * //START (write//) - Force a waiting train to immediately abort the waiting timer, must supply additional payload
nbw 5.1 227 ** **train** - integer train identification
Alexander Schulz-Rosengarten 12.1 228 * //SCHEDULE// (//write//) - Set the new schedule for a train, needs additional payload
nbw 5.1 229 ** **train** - integer train identification
230 ** **currentIndex** - current integer position in the schedule array
nbw 8.1 231 ** **tracks** - a JSON Array of integer values, representing the station tracks in encoding above
Alexander Schulz-Rosengarten 12.1 232 * //SPEED (write//) - Change the speed settings of a train, needs additional payload
nbw 5.1 233 ** **train** - integer train identification
234 ** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
Alexander Schulz-Rosengarten 12.1 235 * //TIME// (//write//) - Change the waiting times for a train
nbw 5.1 236 ** **train** - integer train identification
nbw 20.1 237 ** **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.
nbw 5.1 238
nbw 19.1 239 {{status colour="Yellow" title="New definition"/}}