Changes for page TCP Communication

Last modified by csp on 2025/01/30 12:05
<
From version < 2.1 >
edited by nbw
on 2014/07/05 11:55
To version < 17.1 >
edited by nbw
on 2014/07/18 11:26
>
Change comment: Adjusted station track encoding to fit bit masking

Summary

Details

Page properties
Content
... ... @@ -1,7 +1,11 @@
1 1  
2 2  
3 -{{status colour="Red" title="Work in progress - Might by subject to change"/}}
3 +{{toc/}}
4 4  
5 +
6 +
7 +{{status colour="Red" title="Work in progress - Might bE subject to change"/}}
8 +
5 5  Both the controller and the client GUI send their data as JSON Objects.
6 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 7  For more information or a complete grammar see [[http:~~/~~/www.json.org/>>url:http://www.json.org/||shape="rect"]].
... ... @@ -26,10 +26,204 @@
26 26  * **debug** - true if the controller is set to verbose debug output, false otherwise
27 27  * **cleanup** - true after cleanup mode has been engaged, false before that point
28 28  * **pause** - true while the controller is paused, false otherwise
33 +* **write** - true if receiving client has write access, false otherwise
29 29  * **trainCount** - an integer with the number of active trains on the railway
30 30  * **trains** - a JSON Array with the data of all trains, each entry is a JSON Object with these values\\
31 31  ** **trainNum** - the individual controller number of the train
32 -** **spdSlow** - the integer PWM value of this train while driving slow
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
33 33  ** **spdCaution** - the integer PWM value of this train while driving caution
34 34  ** **spdNormal** - the integer PWM value of this train while driving normally
35 35  ** **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 +{{status colour="Yellow" title="CHANGED"/}}
47 +
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 +|(((
70 +9
71 +)))|(((
72 +KH_ST_1
73 +)))|(% colspan="1" %)(% colspan="1" %)
74 +(((
75 +17
76 +)))|(% colspan="1" %)(% colspan="1" %)
77 +(((
78 +KH_ST_1 (reverse)
79 +)))|(((
80 +25
81 +)))|(((
82 +IC_ST_1
83 +)))|(% colspan="1" %)(% colspan="1" %)
84 +(((
85 +33
86 +)))|(% colspan="1" %)(% colspan="1" %)
87 +(((
88 +OC_ST_1
89 +)))
90 +|(((
91 +10
92 +)))|(((
93 +KH_ST_2
94 +)))|(% colspan="1" %)(% colspan="1" %)
95 +(((
96 +18
97 +)))|(% colspan="1" %)(% colspan="1" %)
98 +(((
99 +KH_ST_2 (reverse)
100 +)))|(((
101 +26
102 +)))|(((
103 +IC_ST_2
104 +)))|(% colspan="1" %)(% colspan="1" %)
105 +(((
106 +34
107 +)))|(% colspan="1" %)(% colspan="1" %)
108 +(((
109 +OC_ST_2
110 +)))
111 +|(((
112 +11
113 +)))|(((
114 +KH_ST_3
115 +)))|(% colspan="1" %)(% colspan="1" %)
116 +(((
117 +19
118 +)))|(% colspan="1" %)(% colspan="1" %)
119 +(((
120 +KH_ST_3 (reverse)
121 +)))|(((
122 +27
123 +)))|(((
124 +IC_ST_3
125 +)))|(% colspan="1" %)(% colspan="1" %)
126 +(((
127 +35
128 +)))|(% colspan="1" %)(% colspan="1" %)
129 +(((
130 +OC_ST_3
131 +)))
132 +|(((
133 +12
134 +)))|(((
135 +KH_ST_4
136 +)))|(% colspan="1" %)(% colspan="1" %)
137 +(((
138 +20
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 +|(((
154 +13
155 +)))|(((
156 +KH_ST_5
157 +)))|(% colspan="1" %)(% colspan="1" %)
158 +(((
159 +21
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)
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].
178 +
179 +
180 +
181 +{{code title="Sample status" language="js" collapse="true"}}
182 +<<OUTDATED>>
183 +
184 +{"msgType":"status",
185 + "data":{
186 + "debug":false,
187 + "cleanup":false,
188 + "pause":false,
189 + "trainCount":8,
190 + "trains":[
191 + {"trainNum":0, "waiting":false, "waitTime":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":2, "schedule":[8, 10, 25, 29, 41, 43]},
192 + {"trainNum":1, "waiting":true, "waitTime":1234545667, "spdSlow":50, "spdCaution":70, "spdNormal":100, "currentIndex":0, "schedule":[8]},
193 + ... ],
194 + "locks":[-1, -1, -1, 5, -1, -1, 2, 10, -1, -1, ..., -1]}}
195 +
196 +[One line to test via netcat]
197 +{"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]}}
198 +{{/code}}
199 +
200 +== Messages received by controller ==
201 +
202 +* Every message must contain the key **command**.
203 +* Depending on the command, additional keys might be required.
204 +
205 +=== Valid commands ===
206 +
207 +* //STATUS// - Poll for the current status, should trigger a status reply message
208 +* //SHUTDOWN// - Causing the controller to end the program and close all sockets
209 +* //LOGOUT// - Closing the connection, leaving the controller running
210 +* //PAUSE// - suspend or resume the controller, must supply additional payload
211 +** **state** - boolean value, true if controller should be suspended
212 +* //WRITE// - Acquire write access mutex to the controller
213 +* //CLEANUP// (//write//) - Start the cleanup procedure, sending the trains back to their home tacks
214 +* //DEBUG// (//write//) - enable or disable verbose output, must supply additional payload
215 +** **state** - boolean value, true if verbose output should be activated
216 +* //LIGHT (write//) - activate or deactivate the lights on the railway, must supply additional payload\\
217 +** **state** - boolean value, true if lights should be lit
218 +* //WAIT// (//write//) - Force a train to wait in the next station, must supply additional payload
219 +** **train** - integer train identification
220 +* //START (write//) - Force a waiting train to immediately abort the waiting timer, must supply additional payload
221 +** **train** - integer train identification
222 +* //SCHEDULE// (//write//) - Set the new schedule for a train, needs additional payload
223 +** **train** - integer train identification
224 +** **currentIndex** - current integer position in the schedule array
225 +** **tracks** - a JSON Array of integer values, representing the station tracks in encoding above
226 +* //SPEED (write//) - Change the speed settings of a train, needs additional payload
227 +** **train** - integer train identification
228 +** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
229 +* //TIME// (//write//) - Change the waiting times for a train
230 +** **train** - integer train identification
231 +** **times** -
232 +
233 +{{status colour="Yellow" title="Define a format for this"/}}
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9471479
1 +9471580
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471479/TCP Communication
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471580/TCP Communication

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage