Changes for page TCP Communication

Last modified by csp on 2025/01/30 12:05
<
From version < 18.1 >
edited by nbw
on 2014/07/18 12:47
To version < 5.1 >
edited by nbw
on 2014/07/05 12:39
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,11 +1,7 @@
1 1  
2 2  
3 -{{toc/}}
3 +{{status colour="Red" title="Work in progress - Might by subject to change"/}}
4 4  
5 -
6 -
7 -{{status colour="Red" title="Work in progress - Might bE subject to change"/}}
8 -
9 9  Both the controller and the client GUI send their data as JSON Objects.
10 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 11  For more information or a complete grammar see [[http:~~/~~/www.json.org/>>url:http://www.json.org/||shape="rect"]].
... ... @@ -30,177 +30,28 @@
30 30  * **debug** - true if the controller is set to verbose debug output, false otherwise
31 31  * **cleanup** - true after cleanup mode has been engaged, false before that point
32 32  * **pause** - true while the controller is paused, false otherwise
33 -* **write** - true if receiving client has write access, false otherwise
34 34  * **trainCount** - an integer with the number of active trains on the railway
35 35  * **trains** - a JSON Array with the data of all trains, each entry is a JSON Object with these values\\
36 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
32 +** **spdSlow** - the integer PWM value of this train while driving slow
40 40  ** **spdCaution** - the integer PWM value of this train while driving caution
41 41  ** **spdNormal** - the integer PWM value of this train while driving normally
42 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
36 +** **schedule** - a JSON Array of integer values, representing the station tracks in the normal encoding (Hoermann API)
37 +* **{{status colour="Yellow" title="Need to change this to enable KH-Reverse tracks"/}}locks** - a JSON Array containing the current value of the track permissions, ordered by the default encoding (Hoermann API)
45 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 181  {{code title="Sample status" language="js" collapse="true"}}
182 182  {"msgType":"status",
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]}
201 -
202 -[One line to test via netcat]
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]}
41 + "data":{
42 + "debug":false,
43 + "cleanup":false,
44 + "pause":false,
45 + "trainCount":8,
46 + "trains":[
47 + {"trainNum":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":2, "schedule":[8, 10, 25, 29, 41, 43]},
48 + {"trainNum":1, "spdSlow":50, "spdCaution":70, "spdNormal":100, "currentIndex":0, "schedule":[8]},
49 + ... ],
50 + "locks":[-1, -1, -1, 5, -1, -1, 2, 10, -1, -1, ..., -1]}}
204 204  {{/code}}
205 205  
206 206  == Messages received by controller ==
... ... @@ -210,29 +210,28 @@
210 210  
211 211  === Valid commands ===
212 212  
213 -* //STATUS// - Poll for the current status, should trigger a status reply message
214 214  * //SHUTDOWN// - Causing the controller to end the program and close all sockets
215 215  * //LOGOUT// - Closing the connection, leaving the controller running
216 -* //PAUSE// - suspend or resume the controller, must supply additional payload
217 -** **state** - boolean value, true if controller should be suspended
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
62 +* //STATUS// - Poll for the current status, should trigger a status reply message
63 +* //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks
64 +* //DEBUG// - enable or disable verbose output, must supply additional payload
221 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\\
66 +* //PAUSE// - suspend or resume the controller, must supply additional payload
67 +** **state** - boolean value, true if controller should be suspended\\
68 +* //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
223 223  ** **state** - boolean value, true if lights should be lit
224 -* //WAIT// (//write//) - Force a train to wait in the next station, must supply additional payload
70 +* //WAIT// - Force a train to wait in the next station, must supply additional payload
225 225  ** **train** - integer train identification
226 -* //START (write//) - Force a waiting train to immediately abort the waiting timer, must supply additional payload
72 +* //START// - Force a waiting train to immediately abort the waiting timer, must supply additional payload
227 227  ** **train** - integer train identification
228 -* //SCHEDULE// (//write//) - Set the new schedule for a train, needs additional payload
74 +* //SCHEDULE// - Set the new schedule for a train, needs additional payload
229 229  ** **train** - integer train identification
230 230  ** **currentIndex** - current integer position in the schedule array
231 -** **tracks** - a JSON Array of integer values, representing the station tracks in encoding above
232 -* //SPEED (write//) - Change the speed settings of a train, needs additional payload
77 +** **tracks** - a JSON Array of integer values, representing the station tracks in the normal encoding (Hoermann API)
78 +* //{{status colour="Yellow" title="Need to change this to enable KH-Reverse tracks"/}}SPEED// - Change the speed settings of a train, needs additional payload
233 233  ** **train** - integer train identification
234 234  ** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
235 -* //TIME// (//write//) - Change the waiting times for a train
81 +* //TIME// - Change the waiting times for a train
236 236  ** **train** - integer train identification
237 237  ** **times** -
238 238  
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9471597
1 +9471484
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471597/TCP Communication
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471484/TCP Communication

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage