Wiki source code of TCP Communication

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