Changes for page TCP Communication

Last modified by csp on 2025/01/30 12:05
<
From version < 6.1 >
edited by nbw
on 2014/07/05 12:40
To version < 13.1 >
edited by csp
on 2014/07/15 13:01
>
Change comment: tcp protocoll change

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.nbw
1 +XWiki.csp
Content
... ... @@ -4,7 +4,7 @@
4 4  
5 5  
6 6  
7 -{{status colour="Red" title="Work in progress - Might by subject to change"/}}
7 +{{status colour="Red" title="Work in progress - Might bE subject to change"/}}
8 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).
... ... @@ -30,16 +30,148 @@
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 -** **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)
43 +** (((
44 +**schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
42 42  
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 +1
69 +)))|(((
70 +KH_ST_1
71 +)))|(% colspan="1" %)(% colspan="1" %)
72 +(((
73 +6
74 +)))|(% colspan="1" %)(% colspan="1" %)
75 +(((
76 +KH_ST_1 (reverse)
77 +)))|(((
78 +11
79 +)))|(((
80 +IC_ST_3
81 +)))|(% colspan="1" %)(% colspan="1" %)
82 +(((
83 +14
84 +)))|(% colspan="1" %)(% colspan="1" %)
85 +(((
86 +OC_ST_3
87 +)))
88 +|(((
89 +2
90 +)))|(((
91 +KH_ST_2
92 +)))|(% colspan="1" %)(% colspan="1" %)
93 +(((
94 +7
95 +)))|(% colspan="1" %)(% colspan="1" %)
96 +(((
97 +KH_ST_2 (reverse)
98 +)))|(((
99 +12
100 +)))|(((
101 +IC_ST_2
102 +)))|(% colspan="1" %)(% colspan="1" %)
103 +(((
104 +15
105 +)))|(% colspan="1" %)(% colspan="1" %)
106 +(((
107 +OC_ST_2
108 +)))
109 +|(((
110 +3
111 +)))|(((
112 +KH_ST_3
113 +)))|(% colspan="1" %)(% colspan="1" %)
114 +(((
115 +8
116 +)))|(% colspan="1" %)(% colspan="1" %)
117 +(((
118 +KH_ST_3 (reverse)
119 +)))|(((
120 +13
121 +)))|(((
122 +IC_ST_1
123 +)))|(% colspan="1" %)(% colspan="1" %)
124 +(((
125 +16
126 +)))|(% colspan="1" %)(% colspan="1" %)
127 +(((
128 +OC_ST_1
129 +)))
130 +|(((
131 +4
132 +)))|(((
133 +KH_ST_4
134 +)))|(% colspan="1" %)(% colspan="1" %)
135 +(((
136 +9
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 +5
153 +)))|(((
154 +KH_ST_5
155 +)))|(% colspan="1" %)(% colspan="1" %)
156 +(((
157 +10
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 +* **locks** - a JSON Array containing the current value of the track permissions, ordered by the default encoding (Hoermann API)
174 +
43 43  {{code title="Sample status" language="js" collapse="true"}}
44 44  {"msgType":"status",
45 45   "data":{
... ... @@ -48,10 +48,13 @@
48 48   "pause":false,
49 49   "trainCount":8,
50 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]},
183 + {"trainNum":0, "waiting":false, "waitTime":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":2, "schedule":[8, 10, 25, 29, 41, 43]},
184 + {"trainNum":1, "waiting":true, "waitTime":1234545667, "spdSlow":50, "spdCaution":70, "spdNormal":100, "currentIndex":0, "schedule":[8]},
53 53   ... ],
54 54   "locks":[-1, -1, -1, 5, -1, -1, 2, 10, -1, -1, ..., -1]}}
187 +
188 +[One line to test via netcat]
189 +{"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]}}
55 55  {{/code}}
56 56  
57 57  == Messages received by controller ==
... ... @@ -61,28 +61,29 @@
61 61  
62 62  === Valid commands ===
63 63  
199 +* //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
67 -* //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks
68 -* //DEBUG// - enable or disable verbose output, must supply additional payload
69 -** **state** - boolean value, true if verbose output should be activated
70 70  * //PAUSE// - suspend or resume the controller, must supply additional payload
71 71  ** **state** - boolean value, true if controller should be suspended
72 -* //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
204 +* //WRITE// - Acquire write access mutex to the controller
205 +* //CLEANUP// (//write//) - Start the cleanup procedure, sending the trains back to their home tacks
206 +* //DEBUG// (//write//) - enable or disable verbose output, must supply additional payload
207 +** **state** - boolean value, true if verbose output should be activated
208 +* //LIGHT (write//) - activate or deactivate the lights on the railway, must supply additional payload\\
73 73  ** **state** - boolean value, true if lights should be lit
74 -* //WAIT// - Force a train to wait in the next station, must supply additional payload
210 +* //WAIT// (//write//) - Force a train to wait in the next station, must supply additional payload
75 75  ** **train** - integer train identification
76 -* //START// - Force a waiting train to immediately abort the waiting timer, must supply additional payload
212 +* //START (write//) - Force a waiting train to immediately abort the waiting timer, must supply additional payload
77 77  ** **train** - integer train identification
78 -* //SCHEDULE// - Set the new schedule for a train, needs additional payload
214 +* //SCHEDULE// (//write//) - 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
217 +** **tracks** - a JSON Array of integer values, representing the station tracks in encoding above
218 +* //SPEED (write//) - 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 -* //TIME// - Change the waiting times for a train
221 +* //TIME// (//write//) - Change the waiting times for a train
86 86  ** **train** - integer train identification
87 87  ** **times** -
88 88  
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9471509
1 +9471567
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471509/TCP Communication
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471567/TCP Communication

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage