Wiki source code of TCP Communication

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

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage