Changes for page TCP Communication

Last modified by csp on 2025/01/30 12:05
<
From version < 8.1 >
edited by nbw
on 2014/07/07 21:35
To version < 20.1 >
edited by nbw
on 2014/07/25 09:01
>
Change comment: There is no comment for this version

Summary

Details

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

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage