Changes for page TCP Communication

Last modified by csp on 2025/01/30 12:05
<
From version < 7.1 >
edited by csp
on 2014/07/07 12:07
To version < 40.1 >
edited by csp
on 2014/08/19 13:20
>
Change comment: train has currentDestination attribute

Summary

Details

Page properties
Content
... ... @@ -2,10 +2,6 @@
2 2  
3 3  {{toc/}}
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"]].
... ... @@ -31,44 +31,199 @@
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 -** **spdSlow** - the integer PWM value of this train while driving slow
37 -** **spdCaution** - the integer PWM value of this train while driving caution
38 -** **spdNormal** - the integer PWM value of this train while driving normally
39 -** **currentIndex** -an integer describing the current position in the schedule
40 -** **schedule** - a JSON Array of integer values, representing the station tracks in the normal encoding (Hoermann API)
41 -* **{{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)
30 +* (((
31 +**trains** - a JSON Array with the data of all trains, each entry is a JSON Object with these values* **state** - integer value for current train state (0 = travelling, 1 = waiting, 2 = travelling until next station, 3 = forced wait, 4 = no schedule)
32 +* **waitTime** - (integer) remaining milliseconds until departure (0 if not waiting)
33 +* **spdSlow** - the integer PWM value of this train while driving slow
34 +* **spdCaution** - the integer PWM value of this train while driving caution
35 +* **spdNormal** - the integer PWM value of this train while driving normally
36 +* **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.
37 +* **currentIndex** - an integer describing the current position in the schedule
38 +* (((
39 +**schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
40 +)))
41 +* (((
42 +**currentDestination** - the current destination track, encoded in the following fashion 
42 42  
44 +{{status colour="Green" title="NEW"/}}
45 +
46 +|=(((
47 +Number
48 +)))|=(((
49 +Track
50 +)))|=(% colspan="1" %)(% colspan="1" %)
51 +(((
52 +Number
53 +)))|=(% colspan="1" %)(% colspan="1" %)
54 +(((
55 +Track
56 +)))|=(((
57 +Number
58 +)))|=(((
59 +Track
60 +)))|=(% colspan="1" %)(% colspan="1" %)
61 +(((
62 +Number
63 +)))|=(% colspan="1" %)(% colspan="1" %)
64 +(((
65 +Track
66 +)))
67 +|(((
68 +9
69 +)))|(((
70 +KH_ST_1
71 +)))|(% colspan="1" %)(% colspan="1" %)
72 +(((
73 +17
74 +)))|(% colspan="1" %)(% colspan="1" %)
75 +(((
76 +KH_ST_1 (reverse)
77 +)))|(((
78 +25
79 +)))|(((
80 +IC_ST_1
81 +)))|(% colspan="1" %)(% colspan="1" %)
82 +(((
83 +33
84 +)))|(% colspan="1" %)(% colspan="1" %)
85 +(((
86 +OC_ST_1
87 +)))
88 +|(((
89 +10
90 +)))|(((
91 +KH_ST_2
92 +)))|(% colspan="1" %)(% colspan="1" %)
93 +(((
94 +18
95 +)))|(% colspan="1" %)(% colspan="1" %)
96 +(((
97 +KH_ST_2 (reverse)
98 +)))|(((
99 +26
100 +)))|(((
101 +IC_ST_2
102 +)))|(% colspan="1" %)(% colspan="1" %)
103 +(((
104 +34
105 +)))|(% colspan="1" %)(% colspan="1" %)
106 +(((
107 +OC_ST_2
108 +)))
109 +|(((
110 +11
111 +)))|(((
112 +KH_ST_3
113 +)))|(% colspan="1" %)(% colspan="1" %)
114 +(((
115 +19
116 +)))|(% colspan="1" %)(% colspan="1" %)
117 +(((
118 +KH_ST_3 (reverse)
119 +)))|(((
120 +27
121 +)))|(((
122 +IC_ST_3
123 +)))|(% colspan="1" %)(% colspan="1" %)
124 +(((
125 +35
126 +)))|(% colspan="1" %)(% colspan="1" %)
127 +(((
128 +OC_ST_3
129 +)))
130 +|(((
131 +12
132 +)))|(((
133 +KH_ST_4
134 +)))|(% colspan="1" %)(% colspan="1" %)
135 +(((
136 +20
137 +)))|(% colspan="1" %)(% colspan="1" %)
138 +(((
139 +KH_ST_4 (reverse)
140 +)))|(((
141 +
142 +)))|(((
143 +
144 +)))|(% colspan="1" %)(% colspan="1" %)
145 +(((
146 +
147 +)))|(% colspan="1" %)(% colspan="1" %)
148 +(((
149 +
150 +)))
151 +|(((
152 +13
153 +)))|(((
154 +KH_ST_5
155 +)))|(% colspan="1" %)(% colspan="1" %)
156 +(((
157 +21
158 +)))|(% colspan="1" %)(% colspan="1" %)
159 +(((
160 +KH_ST_5 (reverse)
161 +)))|(((
162 +
163 +)))|(((
164 +
165 +)))|(% colspan="1" %)(% colspan="1" %)
166 +(((
167 +
168 +)))|(% colspan="1" %)(% colspan="1" %)
169 +(((
170 +
171 +)))
172 +)))
173 +)))
174 +* **locks** - a JSON Array containing the current value of the track permissions, ordered by the default encoding (Hoermann API)
175 +* **tickTime** - Time consumption of tick function in milliseconds. 3 element double-array [min,avg,max].
176 +* **overallTime** -  Time consumption of overall controller loop in milliseconds. 3 element double-array [min,avg,max].
177 +
178 +
179 +
43 43  {{code title="Sample status" language="js" collapse="true"}}
44 44  {"msgType":"status",
45 - "data":{
46 - "debug":false,
47 - "cleanup":false,
48 - "pause":false,
49 - "trainCount":8,
50 - "trains":[
51 - {"trainNum":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":2, "schedule":[8, 10, 25, 29, 41, 43]},
52 - {"trainNum":1, "spdSlow":50, "spdCaution":70, "spdNormal":100, "currentIndex":0, "schedule":[8]},
53 - ... ],
54 - "locks":[-1, -1, -1, 5, -1, -1, 2, 10, -1, -1, ..., -1]}}
182 +"data":{
183 + "debug":false,
184 + "cleanup":false,
185 + "pause":false,
186 + "trainCount":8,
187 + "trains":[
188 + {"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],"currentDestination":9},
189 + {"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],"currentDestination":13},
190 + {"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],"currentDestination":13},
191 + {"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],"currentDestination":13},
192 + {"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],"currentDestination":27},
193 + {"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],"currentDestination":9},
194 + {"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],"currentDestination":10},
195 + {"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],"currentDestination":21}
196 + ],
197 + "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],
198 + "tickTime":[50,60,70],
199 + "overallTime":[70,80,90]}}
200 +[One line to test via netcat]
201 +{"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],"currentDestination":9},{"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],"currentDestination":13},{"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],"currentDestination":13},{"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],"currentDestination":13},{"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],"currentDestination":27},{"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],"currentDestination":9},{"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],"currentDestination":10},{"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],"currentDestination":21}],"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]}}
55 55  {{/code}}
56 56  
57 57  == Messages received by controller ==
58 58  
59 -* Every message must contain the key **command**.
60 -* Depending on the command, additional keys might be required.
206 +* Every message must contain the keys **command **and **data**.
207 +* Valid values for **command **are the following uppercase commands.
208 +* Depending on the command, the **data**-object contains the described infos.
209 +** If a command doesn't require any additional information, the data-object may be omitted or empty.
61 61  
62 62  === Valid commands ===
63 63  
213 +* //STATUS// - Poll for the current status, should trigger a status reply message
64 64  * //SHUTDOWN// - Causing the controller to end the program and close all sockets
65 65  * //LOGOUT// - Closing the connection, leaving the controller running
66 -* //STATUS// - Poll for the current status, should trigger a status reply message
216 +* //PAUSE// - suspend or resume the controller, must supply additional payload
217 +** **state** - boolean value, true if controller should be suspended
67 67  * //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks
68 68  * //DEBUG// - enable or disable verbose output, must supply additional payload
69 69  ** **state** - boolean value, true if verbose output should be activated
70 -* //PAUSE// - suspend or resume the controller, must supply additional payload
71 -** **state** - boolean value, true if controller should be suspended
221 +* //ECHO// - Prints message as log message on the server (will be broadcasted to all clients)\\
222 +** **message** - string, message text
72 72  * //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
73 73  ** **state** - boolean value, true if lights should be lit
74 74  * //WAIT// - Force a train to wait in the next station, must supply additional payload
... ... @@ -78,12 +78,10 @@
78 78  * //SCHEDULE// - Set the new schedule for a train, needs additional payload
79 79  ** **train** - integer train identification
80 80  ** **currentIndex** - current integer position in the schedule array
81 -** **tracks** - a JSON Array of integer values, representing the station tracks in the normal encoding (Hoermann API)
82 -* //{{status colour="Yellow" title="Need to change this to enable KH-Reverse tracks"/}}SPEED// - Change the speed settings of a train, needs additional payload
232 +** **tracks** - a JSON Array of integer values, representing the station tracks in encoding above
233 +* //SPEED //- Change the speed settings of a train, needs additional payload
83 83  ** **train** - integer train identification
84 84  ** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
85 85  * //TIME// - Change the waiting times for a train
86 86  ** **train** - integer train identification
87 -** **times** -
88 -
89 -{{status colour="Yellow" title="Define a format for this"/}}
238 +**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 -9471511
1 +9471739
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471511/TCP Communication
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471739/TCP Communication

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage