Changes for page TCP Communication

Last modified by csp on 2025/01/30 12:05
<
From version < 10.1 >
edited by nbw
on 2014/07/09 13:56
To version < 28.1 >
edited by nbw
on 2014/07/31 12:34
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -31,16 +31,16 @@
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 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 -** **trainNum** - the individual controller number of the train
36 -** **waiting** - boolean value, true if the train is waiting in a station, false otherwise 
37 -** **{{status colour="Green" title="NEW"/}}waitTime** - (integer) timestamp, when the train is allowed to depart, should only be interpreted if **waiting** is true 
38 -** **{{status colour="Green" title="NEW"/}}spdSlow** - the integer PWM value of this train while driving slow
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 = forced travel, 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
39 39  ** **spdCaution** - the integer PWM value of this train while driving caution
40 40  ** **spdNormal** - the integer PWM value of this train while driving normally
41 -** **currentIndex** -an integer describing the current position in the schedule
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 42  ** (((
43 -**schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
43 +**schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
44 44  
45 45  |=(((
46 46  Number
... ... @@ -64,75 +64,75 @@
64 64  Track
65 65  )))
66 66  |(((
67 -1
67 +9
68 68  )))|(((
69 69  KH_ST_1
70 70  )))|(% colspan="1" %)(% colspan="1" %)
71 71  (((
72 -6
72 +17
73 73  )))|(% colspan="1" %)(% colspan="1" %)
74 74  (((
75 75  KH_ST_1 (reverse)
76 76  )))|(((
77 -11
77 +25
78 78  )))|(((
79 -IC_ST_3
79 +IC_ST_1
80 80  )))|(% colspan="1" %)(% colspan="1" %)
81 81  (((
82 -14
82 +33
83 83  )))|(% colspan="1" %)(% colspan="1" %)
84 84  (((
85 -OC_ST_3
85 +OC_ST_1
86 86  )))
87 87  |(((
88 -2
88 +10
89 89  )))|(((
90 90  KH_ST_2
91 91  )))|(% colspan="1" %)(% colspan="1" %)
92 92  (((
93 -7
93 +18
94 94  )))|(% colspan="1" %)(% colspan="1" %)
95 95  (((
96 96  KH_ST_2 (reverse)
97 97  )))|(((
98 -12
98 +26
99 99  )))|(((
100 100  IC_ST_2
101 101  )))|(% colspan="1" %)(% colspan="1" %)
102 102  (((
103 -15
103 +34
104 104  )))|(% colspan="1" %)(% colspan="1" %)
105 105  (((
106 106  OC_ST_2
107 107  )))
108 108  |(((
109 -3
109 +11
110 110  )))|(((
111 111  KH_ST_3
112 112  )))|(% colspan="1" %)(% colspan="1" %)
113 113  (((
114 -8
114 +19
115 115  )))|(% colspan="1" %)(% colspan="1" %)
116 116  (((
117 117  KH_ST_3 (reverse)
118 118  )))|(((
119 -13
119 +27
120 120  )))|(((
121 -IC_ST_1
121 +IC_ST_3
122 122  )))|(% colspan="1" %)(% colspan="1" %)
123 123  (((
124 -16
124 +35
125 125  )))|(% colspan="1" %)(% colspan="1" %)
126 126  (((
127 -OC_ST_1
127 +OC_ST_3
128 128  )))
129 129  |(((
130 -4
130 +12
131 131  )))|(((
132 132  KH_ST_4
133 133  )))|(% colspan="1" %)(% colspan="1" %)
134 134  (((
135 -9
135 +20
136 136  )))|(% colspan="1" %)(% colspan="1" %)
137 137  (((
138 138  KH_ST_4 (reverse)
... ... @@ -148,12 +148,12 @@
148 148  
149 149  )))
150 150  |(((
151 -5
151 +13
152 152  )))|(((
153 153  KH_ST_5
154 154  )))|(% colspan="1" %)(% colspan="1" %)
155 155  (((
156 -10
156 +21
157 157  )))|(% colspan="1" %)(% colspan="1" %)
158 158  (((
159 159  KH_ST_5 (reverse)
... ... @@ -170,22 +170,34 @@
170 170  )))
171 171  )))
172 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].
173 173  
176 +
177 +
174 174  {{code title="Sample status" language="js" collapse="true"}}
175 175  {"msgType":"status",
176 - "data":{
177 - "debug":false,
178 - "cleanup":false,
179 - "pause":false,
180 - "trainCount":8,
181 - "trains":[
182 - {"trainNum":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":2, "schedule":[8, 10, 25, 29, 41, 43]},
183 - {"trainNum":1, "spdSlow":50, "spdCaution":70, "spdNormal":100, "currentIndex":0, "schedule":[8]},
184 - ... ],
185 - "locks":[-1, -1, -1, 5, -1, -1, 2, 10, -1, -1, ..., -1]}}
180 +"data":{
181 + "debug":false,
182 + "cleanup":false,
183 + "pause":false,
184 + "trainCount":8,
185 + "trains":[
186 + {"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]},
187 + {"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]},
188 + {"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]},
189 + {"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]},
190 + {"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]},
191 + {"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]},
192 + {"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]},
193 + {"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]},
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]}}
186 186  
187 187  [One line to test via netcat]
188 -{"msgType":"status", "data":{"debug":false, "cleanup":false, "pause":false, "trainCount":8, "trains":[ {"trainNum":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":2, "schedule":[1, 1, 11, 14, 6]}, {"trainNum":1, "spdSlow":51, "spdCaution":71, "spdNormal":101, "currentIndex":0, "schedule":[2, 1, 11, 14, 6]}, {"trainNum":2, "spdSlow":52, "spdCaution":72, "spdNormal":102, "currentIndex":1, "schedule":[3, 1, 11, 14, 6]}, {"trainNum":3, "spdSlow":53, "spdCaution":73, "spdNormal":103, "currentIndex":1, "schedule":[4, 1, 11, 14, 6]}, {"trainNum":4, "spdSlow":54, "spdCaution":74, "spdNormal":104, "currentIndex":2, "schedule":[5, 1, 11, 14, 6]}, {"trainNum":5, "spdSlow":55, "spdCaution":75, "spdNormal":105, "currentIndex":3, "schedule":[6, 1, 11, 14, 6]}, {"trainNum":6, "spdSlow":56, "spdCaution":76, "spdNormal":106, "currentIndex":1, "schedule":[7, 1, 11, 14, 6]}, {"trainNum":7, "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]}}
200 +{"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]}}
189 189  {{/code}}
190 190  
191 191  == Messages received by controller ==
... ... @@ -195,14 +195,14 @@
195 195  
196 196  === Valid commands ===
197 197  
210 +* //STATUS// - Poll for the current status, should trigger a status reply message
198 198  * //SHUTDOWN// - Causing the controller to end the program and close all sockets
199 199  * //LOGOUT// - Closing the connection, leaving the controller running
200 -* //STATUS// - Poll for the current status, should trigger a status reply message
213 +* //PAUSE// - suspend or resume the controller, must supply additional payload
214 +** **state** - boolean value, true if controller should be suspended
201 201  * //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks
202 202  * //DEBUG// - enable or disable verbose output, must supply additional payload
203 203  ** **state** - boolean value, true if verbose output should be activated
204 -* //PAUSE// - suspend or resume the controller, must supply additional payload
205 -** **state** - boolean value, true if controller should be suspended
206 206  * //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
207 207  ** **state** - boolean value, true if lights should be lit
208 208  * //WAIT// - Force a train to wait in the next station, must supply additional payload
... ... @@ -213,11 +213,9 @@
213 213  ** **train** - integer train identification
214 214  ** **currentIndex** - current integer position in the schedule array
215 215  ** **tracks** - a JSON Array of integer values, representing the station tracks in encoding above
216 -* //SPEED// - Change the speed settings of a train, needs additional payload
228 +* //SPEED //- Change the speed settings of a train, needs additional payload
217 217  ** **train** - integer train identification
218 218  ** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
219 219  * //TIME// - Change the waiting times for a train
220 220  ** **train** - integer train identification
221 -** **times** -
222 -
223 -{{status colour="Yellow" title="Define a format for this"/}}
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.
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9471528
1 +9471628
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471528/TCP Communication
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471628/TCP Communication

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage