Changes for page TCP Communication

Last modified by csp on 2025/01/30 12:05
<
From version < 21.1 >
edited by nbw
on 2014/07/30 13:48
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"]].
... ... @@ -33,171 +33,25 @@
33 33  * **trainCount** - an integer with the number of active trains on the railway
34 34  * **trains** - a JSON Array with the data of all trains, each entry is a JSON Object with these values\\
35 35  ** **trainNum** - the individual controller number of the train
36 -** **waitTime** - (integer) remaining milliseconds until departure (0 if not waiting)
37 37  ** **spdSlow** - the integer PWM value of this train while driving slow
38 38  ** **spdCaution** - the integer PWM value of this train while driving caution
39 39  ** **spdNormal** - the integer PWM value of this train while driving normally
40 -** **currentIndex** - an integer describing the current position in the schedule
41 -** **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.
42 -** (((
43 -**schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
35 +** **currentIndex** -an integer describing the current position in the schedule
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)
44 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. 3 element array [min,avg,max].
174 -* **overallTime** -  Time consumption of overall controller loop. 3 element array [min,avg,max].
175 -
176 -
177 -
178 178  {{code title="Sample status" language="js" collapse="true"}}
179 179  {"msgType":"status",
180 - "data":{
181 - "debug":false,
182 - "cleanup":false,
183 - "pause":false,
184 - "trainCount":8,
185 - "trains":[
186 - {"trainNum":0, "waitTime":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":1, "schedule":[9,13,17,21,25,27,33,35]},
187 - {"trainNum":1, "waitTime":2500, "spdSlow":41, "spdCaution":61, "spdNormal":101, "currentIndex":2, "schedule":[9,13,17,21,25,27,33,35]},
188 - {"trainNum":2, "waitTime":0, "spdSlow":42, "spdCaution":62, "spdNormal":102, "currentIndex":3, "schedule":[9,13,17,21,25,27,33,35]},
189 - {"trainNum":3, "waitTime":0, "spdSlow":43, "spdCaution":63, "spdNormal":103, "currentIndex":4, "schedule":[9,13,17,21,25,27,33,35]},
190 - {"trainNum":4, "waitTime":0, "spdSlow":44, "spdCaution":64, "spdNormal":104, "currentIndex":5, "schedule":[9,13,17,21,25,27,33,35]},
191 - {"trainNum":5, "waitTime":10000, "spdSlow":45, "spdCaution":65, "spdNormal":105, "currentIndex":6, "schedule":[9,13,17,21,25,27,33,35]},
192 - {"trainNum":6, "waitTime":0, "spdSlow":46, "spdCaution":66, "spdNormal":106, "currentIndex":7, "schedule":[9,13,17,21,25,27,33,35]},
193 - {"trainNum":7, "waitTime":0, "spdSlow":47, "spdCaution":67, "spdNormal":107, "currentIndex":8, "schedule":[9,13,17,21,25,27,33,35]},
194 - ],
195 - "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]},
196 - "tickTime":[50, 60, 70],
197 - "overallTime":[70, 80, 90]}
198 -
199 -[One line to test via netcat]
200 -{"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]}}
201 201  {{/code}}
202 202  
203 203  == Messages received by controller ==
... ... @@ -207,14 +207,14 @@
207 207  
208 208  === Valid commands ===
209 209  
210 -* //STATUS// - Poll for the current status, should trigger a status reply message
211 211  * //SHUTDOWN// - Causing the controller to end the program and close all sockets
212 212  * //LOGOUT// - Closing the connection, leaving the controller running
213 -* //PAUSE// - suspend or resume the controller, must supply additional payload
214 -** **state** - boolean value, true if controller should be suspended
62 +* //STATUS// - Poll for the current status, should trigger a status reply message
215 215  * //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks
216 216  * //DEBUG// - enable or disable verbose output, must supply additional payload
217 217  ** **state** - boolean value, true if verbose output should be activated
66 +* //PAUSE// - suspend or resume the controller, must supply additional payload
67 +** **state** - boolean value, true if controller should be suspended\\
218 218  * //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
219 219  ** **state** - boolean value, true if lights should be lit
220 220  * //WAIT// - Force a train to wait in the next station, must supply additional payload
... ... @@ -224,12 +224,12 @@
224 224  * //SCHEDULE// - Set the new schedule for a train, needs additional payload
225 225  ** **train** - integer train identification
226 226  ** **currentIndex** - current integer position in the schedule array
227 -** **tracks** - a JSON Array of integer values, representing the station tracks in encoding above
228 -* //SPEED //- 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
229 229  ** **train** - integer train identification
230 230  ** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
231 231  * //TIME// - Change the waiting times for a train
232 232  ** **train** - integer train identification
233 -** **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.
83 +** **times** -
234 234  
235 -{{status colour="Yellow" title="New definition"/}}
85 +{{status colour="Yellow" title="Define a format for this"/}}
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9471606
1 +9471484
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471606/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