<
From version < 10.1 >
edited by nbw
on 2014/07/09 13:56
To version < 5.1 >
edited by nbw
on 2014/07/05 12:39
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,11 +1,7 @@
1 1  
2 2  
3 -{{toc/}}
3 +{{status colour="Red" title="Work in progress - Might by subject to change"/}}
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"]].
... ... @@ -33,144 +33,13 @@
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 -** **waiting** - boolean value, true if the train is waiting in a station, false otherwise 
37 -** **{{status colour="Green" title="NEW"/}}waitTime** - (integer) timestamp, when the train is allowed to depart, should only be interpreted if **waiting** is true 
38 -** **{{status colour="Green" title="NEW"/}}spdSlow** - the integer PWM value of this train while driving slow
32 +** **spdSlow** - the integer PWM value of this train while driving slow
39 39  ** **spdCaution** - the integer PWM value of this train while driving caution
40 40  ** **spdNormal** - the integer PWM value of this train while driving normally
41 41  ** **currentIndex** -an integer describing the current position in the schedule
42 -** (((
43 -**schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
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)
44 44  
45 -|=(((
46 -Number
47 -)))|=(((
48 -Track
49 -)))|=(% colspan="1" %)(% colspan="1" %)
50 -(((
51 -Number
52 -)))|=(% colspan="1" %)(% colspan="1" %)
53 -(((
54 -Track
55 -)))|=(((
56 -Number
57 -)))|=(((
58 -Track
59 -)))|=(% colspan="1" %)(% colspan="1" %)
60 -(((
61 -Number
62 -)))|=(% colspan="1" %)(% colspan="1" %)
63 -(((
64 -Track
65 -)))
66 -|(((
67 -1
68 -)))|(((
69 -KH_ST_1
70 -)))|(% colspan="1" %)(% colspan="1" %)
71 -(((
72 -6
73 -)))|(% colspan="1" %)(% colspan="1" %)
74 -(((
75 -KH_ST_1 (reverse)
76 -)))|(((
77 -11
78 -)))|(((
79 -IC_ST_3
80 -)))|(% colspan="1" %)(% colspan="1" %)
81 -(((
82 -14
83 -)))|(% colspan="1" %)(% colspan="1" %)
84 -(((
85 -OC_ST_3
86 -)))
87 -|(((
88 -2
89 -)))|(((
90 -KH_ST_2
91 -)))|(% colspan="1" %)(% colspan="1" %)
92 -(((
93 -7
94 -)))|(% colspan="1" %)(% colspan="1" %)
95 -(((
96 -KH_ST_2 (reverse)
97 -)))|(((
98 -12
99 -)))|(((
100 -IC_ST_2
101 -)))|(% colspan="1" %)(% colspan="1" %)
102 -(((
103 -15
104 -)))|(% colspan="1" %)(% colspan="1" %)
105 -(((
106 -OC_ST_2
107 -)))
108 -|(((
109 -3
110 -)))|(((
111 -KH_ST_3
112 -)))|(% colspan="1" %)(% colspan="1" %)
113 -(((
114 -8
115 -)))|(% colspan="1" %)(% colspan="1" %)
116 -(((
117 -KH_ST_3 (reverse)
118 -)))|(((
119 -13
120 -)))|(((
121 -IC_ST_1
122 -)))|(% colspan="1" %)(% colspan="1" %)
123 -(((
124 -16
125 -)))|(% colspan="1" %)(% colspan="1" %)
126 -(((
127 -OC_ST_1
128 -)))
129 -|(((
130 -4
131 -)))|(((
132 -KH_ST_4
133 -)))|(% colspan="1" %)(% colspan="1" %)
134 -(((
135 -9
136 -)))|(% colspan="1" %)(% colspan="1" %)
137 -(((
138 -KH_ST_4 (reverse)
139 -)))|(((
140 -
141 -)))|(((
142 -
143 -)))|(% colspan="1" %)(% colspan="1" %)
144 -(((
145 -
146 -)))|(% colspan="1" %)(% colspan="1" %)
147 -(((
148 -
149 -)))
150 -|(((
151 -5
152 -)))|(((
153 -KH_ST_5
154 -)))|(% colspan="1" %)(% colspan="1" %)
155 -(((
156 -10
157 -)))|(% colspan="1" %)(% colspan="1" %)
158 -(((
159 -KH_ST_5 (reverse)
160 -)))|(((
161 -
162 -)))|(((
163 -
164 -)))|(% colspan="1" %)(% colspan="1" %)
165 -(((
166 -
167 -)))|(% colspan="1" %)(% colspan="1" %)
168 -(((
169 -
170 -)))
171 -)))
172 -* **locks** - a JSON Array containing the current value of the track permissions, ordered by the default encoding (Hoermann API)
173 -
174 174  {{code title="Sample status" language="js" collapse="true"}}
175 175  {"msgType":"status",
176 176   "data":{
... ... @@ -183,9 +183,6 @@
183 183   {"trainNum":1, "spdSlow":50, "spdCaution":70, "spdNormal":100, "currentIndex":0, "schedule":[8]},
184 184   ... ],
185 185   "locks":[-1, -1, -1, 5, -1, -1, 2, 10, -1, -1, ..., -1]}}
186 -
187 -[One line to test via netcat]
188 -{"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]}}
189 189  {{/code}}
190 190  
191 191  == Messages received by controller ==
... ... @@ -202,7 +202,7 @@
202 202  * //DEBUG// - enable or disable verbose output, must supply additional payload
203 203  ** **state** - boolean value, true if verbose output should be activated
204 204  * //PAUSE// - suspend or resume the controller, must supply additional payload
205 -** **state** - boolean value, true if controller should be suspended
67 +** **state** - boolean value, true if controller should be suspended\\
206 206  * //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
207 207  ** **state** - boolean value, true if lights should be lit
208 208  * //WAIT// - Force a train to wait in the next station, must supply additional payload
... ... @@ -212,8 +212,8 @@
212 212  * //SCHEDULE// - Set the new schedule for a train, needs additional payload
213 213  ** **train** - integer train identification
214 214  ** **currentIndex** - current integer position in the schedule array
215 -** **tracks** - a JSON Array of integer values, representing the station tracks in encoding above
216 -* //SPEED// - Change the speed settings of a train, needs additional payload
77 +** **tracks** - a JSON Array of integer values, representing the station tracks in the normal encoding (Hoermann API)
78 +* //{{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 217  ** **train** - integer train identification
218 218  ** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
219 219  * //TIME// - Change the waiting times for a train
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9471528
1 +9471484
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471528/TCP Communication
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471484/TCP Communication