Skip to Content

Wiki source code of TCP Communication

Version 24.1 by nbw on 2014/07/30 14:14
Show last authors
1
2
3 {{toc/}}
4
5
6
7 {{status colour="Red" title="Work in progress - Might bE subject to change"/}}
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
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 ** **waitTime** - (integer) remaining milliseconds until departure (0 if not waiting)
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 ** **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.
40 ** **currentIndex** - an integer describing the current position in the schedule
41 ** (((
42 **schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
43
44 |=(((
45 Number
46 )))|=(((
47 Track
48 )))|=(% colspan="1" %)(% colspan="1" %)
49 (((
50 Number
51 )))|=(% colspan="1" %)(% colspan="1" %)
52 (((
53 Track
54 )))|=(((
55 Number
56 )))|=(((
57 Track
58 )))|=(% colspan="1" %)(% colspan="1" %)
59 (((
60 Number
61 )))|=(% colspan="1" %)(% colspan="1" %)
62 (((
63 Track
64 )))
65 |(((
66 9
67 )))|(((
68 KH_ST_1
69 )))|(% colspan="1" %)(% colspan="1" %)
70 (((
71 17
72 )))|(% colspan="1" %)(% colspan="1" %)
73 (((
74 KH_ST_1 (reverse)
75 )))|(((
76 25
77 )))|(((
78 IC_ST_1
79 )))|(% colspan="1" %)(% colspan="1" %)
80 (((
81 33
82 )))|(% colspan="1" %)(% colspan="1" %)
83 (((
84 OC_ST_1
85 )))
86 |(((
87 10
88 )))|(((
89 KH_ST_2
90 )))|(% colspan="1" %)(% colspan="1" %)
91 (((
92 18
93 )))|(% colspan="1" %)(% colspan="1" %)
94 (((
95 KH_ST_2 (reverse)
96 )))|(((
97 26
98 )))|(((
99 IC_ST_2
100 )))|(% colspan="1" %)(% colspan="1" %)
101 (((
102 34
103 )))|(% colspan="1" %)(% colspan="1" %)
104 (((
105 OC_ST_2
106 )))
107 |(((
108 11
109 )))|(((
110 KH_ST_3
111 )))|(% colspan="1" %)(% colspan="1" %)
112 (((
113 19
114 )))|(% colspan="1" %)(% colspan="1" %)
115 (((
116 KH_ST_3 (reverse)
117 )))|(((
118 27
119 )))|(((
120 IC_ST_3
121 )))|(% colspan="1" %)(% colspan="1" %)
122 (((
123 35
124 )))|(% colspan="1" %)(% colspan="1" %)
125 (((
126 OC_ST_3
127 )))
128 |(((
129 12
130 )))|(((
131 KH_ST_4
132 )))|(% colspan="1" %)(% colspan="1" %)
133 (((
134 20
135 )))|(% colspan="1" %)(% colspan="1" %)
136 (((
137 KH_ST_4 (reverse)
138 )))|(((
139
140 )))|(((
141
142 )))|(% colspan="1" %)(% colspan="1" %)
143 (((
144
145 )))|(% colspan="1" %)(% colspan="1" %)
146 (((
147
148 )))
149 |(((
150 13
151 )))|(((
152 KH_ST_5
153 )))|(% colspan="1" %)(% colspan="1" %)
154 (((
155 21
156 )))|(% colspan="1" %)(% colspan="1" %)
157 (((
158 KH_ST_5 (reverse)
159 )))|(((
160
161 )))|(((
162
163 )))|(% colspan="1" %)(% colspan="1" %)
164 (((
165
166 )))|(% colspan="1" %)(% colspan="1" %)
167 (((
168
169 )))
170 )))
171 * **locks** - a JSON Array containing the current value of the track permissions, ordered by the default encoding (Hoermann API)
172 * **tickTime** - Time consumption of tick function. 3 element array [min,avg,max].
173 * **overallTime** -  Time consumption of overall controller loop. 3 element array [min,avg,max].
174
175
176
177 {{code title="Sample status" language="js" collapse="true"}}
178 {"msgType":"status",
179 "data":{
180 "debug":false,
181 "cleanup":false,
182 "pause":false,
183 "trainCount":8,
184 "trains":[
185 {"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]},
186 {"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]},
187 {"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]},
188 {"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]},
189 {"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]},
190 {"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]},
191 {"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]},
192 {"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]},
193 ],
194 "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]},
195 "tickTime":[50, 60, 70],
196 "overallTime":[70, 80, 90]}
197
198 [One line to test via netcat]
199 {"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]}
200 {{/code}}
201
202 == Messages received by controller ==
203
204 * Every message must contain the key **command**.
205 * Depending on the command, additional keys might be required.
206
207 === Valid commands ===
208
209 * //STATUS// - Poll for the current status, should trigger a status reply message
210 * //SHUTDOWN// - Causing the controller to end the program and close all sockets
211 * //LOGOUT// - Closing the connection, leaving the controller running
212 * //PAUSE// - suspend or resume the controller, must supply additional payload
213 ** **state** - boolean value, true if controller should be suspended
214 * //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks
215 * //DEBUG// - enable or disable verbose output, must supply additional payload
216 ** **state** - boolean value, true if verbose output should be activated
217 * //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
218 ** **state** - boolean value, true if lights should be lit
219 * //WAIT// - Force a train to wait in the next station, must supply additional payload
220 ** **train** - integer train identification
221 * //START// - Force a waiting train to immediately abort the waiting timer, must supply additional payload
222 ** **train** - integer train identification
223 * //SCHEDULE// - Set the new schedule for a train, needs additional payload
224 ** **train** - integer train identification
225 ** **currentIndex** - current integer position in the schedule array
226 ** **tracks** - a JSON Array of integer values, representing the station tracks in encoding above
227 * //SPEED //- Change the speed settings of a train, needs additional payload
228 ** **train** - integer train identification
229 ** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
230 * //TIME// - Change the waiting times for a train
231 ** **train** - integer train identification
232 **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.