Changes for page TCP Communication

Last modified by csp on 2025/01/30 12:05
<
From version < 9.1 >
edited by nbw
on 2014/07/08 14:59
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
... ... @@ -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,8 +168,14 @@
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"}}
182 +<<OUTDATED>>
183 +
173 173  {"msgType":"status",
174 174   "data":{
175 175   "debug":false,
... ... @@ -177,13 +177,13 @@
177 177   "pause":false,
178 178   "trainCount":8,
179 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]},
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]},
182 182   ... ],
183 183   "locks":[-1, -1, -1, 5, -1, -1, 2, 10, -1, -1, ..., -1]}}
184 184  
185 185  [One line to test via netcat]
186 -{"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]}}
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]}}
187 187  {{/code}}
188 188  
189 189  == Messages received by controller ==
... ... @@ -193,28 +193,29 @@
193 193  
194 194  === Valid commands ===
195 195  
207 +* //STATUS// - Poll for the current status, should trigger a status reply message
196 196  * //SHUTDOWN// - Causing the controller to end the program and close all sockets
197 197  * //LOGOUT// - Closing the connection, leaving the controller running
198 -* //STATUS// - Poll for the current status, should trigger a status reply message
199 -* //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks
200 -* //DEBUG// - enable or disable verbose output, must supply additional payload
201 -** **state** - boolean value, true if verbose output should be activated
202 202  * //PAUSE// - suspend or resume the controller, must supply additional payload
203 203  ** **state** - boolean value, true if controller should be suspended
204 -* //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
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\\
205 205  ** **state** - boolean value, true if lights should be lit
206 -* //WAIT// - Force a train to wait in the next station, must supply additional payload
218 +* //WAIT// (//write//) - Force a train to wait in the next station, must supply additional payload
207 207  ** **train** - integer train identification
208 -* //START// - Force a waiting train to immediately abort the waiting timer, must supply additional payload
220 +* //START (write//) - Force a waiting train to immediately abort the waiting timer, must supply additional payload
209 209  ** **train** - integer train identification
210 -* //SCHEDULE// - Set the new schedule for a train, needs additional payload
222 +* //SCHEDULE// (//write//) - Set the new schedule for a train, needs additional payload
211 211  ** **train** - integer train identification
212 212  ** **currentIndex** - current integer position in the schedule array
213 213  ** **tracks** - a JSON Array of integer values, representing the station tracks in encoding above
214 -* //SPEED// - Change the speed settings of a train, needs additional payload
226 +* //SPEED (write//) - Change the speed settings of a train, needs additional payload
215 215  ** **train** - integer train identification
216 216  ** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
217 -* //TIME// - Change the waiting times for a train
229 +* //TIME// (//write//) - Change the waiting times for a train
218 218  ** **train** - integer train identification
219 219  ** **times** -
220 220  
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9471522
1 +9471580
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471522/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