Changes for page TCP Communication

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

Summary

Details

Page properties
Content
... ... @@ -1,7 +1,11 @@
1 1  
2 2  
3 -{{status colour="Red" title="Work in progress - Might by subject to change"/}}
3 +{{toc/}}
4 4  
5 +
6 +
7 +{{status colour="Red" title="Work in progress - Might bE subject to change"/}}
8 +
5 5  Both the controller and the client GUI send their data as JSON Objects.
6 6  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).
7 7  For more information or a complete grammar see [[http:~~/~~/www.json.org/>>url:http://www.json.org/||shape="rect"]].
... ... @@ -33,9 +33,138 @@
33 33  ** **spdCaution** - the integer PWM value of this train while driving caution
34 34  ** **spdNormal** - the integer PWM value of this train while driving normally
35 35  ** **currentIndex** -an integer describing the current position in the schedule
36 -** **schedule** - a JSON Array of integer values, representing the station tracks in the normal encoding (Hoermann API)
37 -* **{{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)
40 +** (((
41 +**schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
38 38  
43 +|=(((
44 +Number
45 +)))|=(((
46 +Track
47 +)))|=(% colspan="1" %)(% colspan="1" %)
48 +(((
49 +Number
50 +)))|=(% colspan="1" %)(% colspan="1" %)
51 +(((
52 +Track
53 +)))|=(((
54 +Number
55 +)))|=(((
56 +Track
57 +)))|=(% colspan="1" %)(% colspan="1" %)
58 +(((
59 +Number
60 +)))|=(% colspan="1" %)(% colspan="1" %)
61 +(((
62 +Track
63 +)))
64 +|(((
65 +1
66 +)))|(((
67 +KH_ST_1
68 +)))|(% colspan="1" %)(% colspan="1" %)
69 +(((
70 +6
71 +)))|(% colspan="1" %)(% colspan="1" %)
72 +(((
73 +KH_ST_1 (reverse)
74 +)))|(((
75 +11
76 +)))|(((
77 +IC_ST_3
78 +)))|(% colspan="1" %)(% colspan="1" %)
79 +(((
80 +14
81 +)))|(% colspan="1" %)(% colspan="1" %)
82 +(((
83 +OC_ST_3
84 +)))
85 +|(((
86 +2
87 +)))|(((
88 +KH_ST_2
89 +)))|(% colspan="1" %)(% colspan="1" %)
90 +(((
91 +7
92 +)))|(% colspan="1" %)(% colspan="1" %)
93 +(((
94 +KH_ST_2 (reverse)
95 +)))|(((
96 +12
97 +)))|(((
98 +IC_ST_2
99 +)))|(% colspan="1" %)(% colspan="1" %)
100 +(((
101 +15
102 +)))|(% colspan="1" %)(% colspan="1" %)
103 +(((
104 +OC_ST_2
105 +)))
106 +|(((
107 +3
108 +)))|(((
109 +KH_ST_3
110 +)))|(% colspan="1" %)(% colspan="1" %)
111 +(((
112 +8
113 +)))|(% colspan="1" %)(% colspan="1" %)
114 +(((
115 +KH_ST_3 (reverse)
116 +)))|(((
117 +13
118 +)))|(((
119 +IC_ST_1
120 +)))|(% colspan="1" %)(% colspan="1" %)
121 +(((
122 +16
123 +)))|(% colspan="1" %)(% colspan="1" %)
124 +(((
125 +OC_ST_1
126 +)))
127 +|(((
128 +4
129 +)))|(((
130 +KH_ST_4
131 +)))|(% colspan="1" %)(% colspan="1" %)
132 +(((
133 +9
134 +)))|(% colspan="1" %)(% colspan="1" %)
135 +(((
136 +KH_ST_4 (reverse)
137 +)))|(((
138 +
139 +)))|(((
140 +
141 +)))|(% colspan="1" %)(% colspan="1" %)
142 +(((
143 +
144 +)))|(% colspan="1" %)(% colspan="1" %)
145 +(((
146 +
147 +)))
148 +|(((
149 +5
150 +)))|(((
151 +KH_ST_5
152 +)))|(% colspan="1" %)(% colspan="1" %)
153 +(((
154 +10
155 +)))|(% colspan="1" %)(% colspan="1" %)
156 +(((
157 +KH_ST_5 (reverse)
158 +)))|(((
159 +
160 +)))|(((
161 +
162 +)))|(% colspan="1" %)(% colspan="1" %)
163 +(((
164 +
165 +)))|(% colspan="1" %)(% colspan="1" %)
166 +(((
167 +
168 +)))
169 +)))
170 +* **locks** - a JSON Array containing the current value of the track permissions, ordered by the default encoding (Hoermann API)
171 +
39 39  {{code title="Sample status" language="js" collapse="true"}}
40 40  {"msgType":"status",
41 41   "data":{
... ... @@ -49,3 +49,37 @@
49 49   ... ],
50 50   "locks":[-1, -1, -1, 5, -1, -1, 2, 10, -1, -1, ..., -1]}}
51 51  {{/code}}
185 +
186 +== Messages received by controller ==
187 +
188 +* Every message must contain the key **command**.
189 +* Depending on the command, additional keys might be required.
190 +
191 +=== Valid commands ===
192 +
193 +* //SHUTDOWN// - Causing the controller to end the program and close all sockets
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 +* //PAUSE// - suspend or resume the controller, must supply additional payload
200 +** **state** - boolean value, true if controller should be suspended
201 +* //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
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
204 +** **train** - integer train identification
205 +* //START// - Force a waiting train to immediately abort the waiting timer, must supply additional payload
206 +** **train** - integer train identification
207 +* //SCHEDULE// - Set the new schedule for a train, needs additional payload
208 +** **train** - integer train identification
209 +** **currentIndex** - current integer position in the schedule array
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
212 +** **train** - integer train identification
213 +** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
214 +* //TIME// - Change the waiting times for a train
215 +** **train** - integer train identification
216 +** **times** -
217 +
218 +{{status colour="Yellow" title="Define a format for this"/}}
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9471483
1 +9471513
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471483/TCP Communication
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471513/TCP Communication

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage