Changes for page TCP Communication
Last modified by csp on 2025/01/30 12:05
<
>
edited by Alexander Schulz-Rosengarten
on 2014/08/18 11:57
on 2014/08/18 11:57
edited by Alexander Schulz-Rosengarten
on 2014/07/16 14:31
on 2014/07/16 14:31
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Objects (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -2,6 +2,10 @@ 2 2 3 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"]]. ... ... @@ -26,17 +26,18 @@ 26 26 * **debug** - true if the controller is set to verbose debug output, false otherwise 27 27 * **cleanup** - true after cleanup mode has been engaged, false before that point 28 28 * **pause** - true while the controller is paused, false otherwise 33 +* **write** - true if receiving client has write access, false otherwise 29 29 * **trainCount** - an integer with the number of active trains on the railway 30 -* **trains** - a JSON Array with the data of all trains, each entry is a JSON Object with these values 31 -** **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 35 +* **trains** - a JSON Array with the data of all trains, each entry is a JSON Object with these values\\ 36 +** **trainNum** - the individual controller number of the train 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 34 34 ** **spdCaution** - the integer PWM value of this train while driving caution 35 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 42 +** **currentIndex** -an integer describing the current position in the schedule 38 38 ** ((( 39 -**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 40 40 41 41 |=((( 42 42 Number ... ... @@ -60,75 +60,75 @@ 60 60 Track 61 61 ))) 62 62 |((( 63 - 968 +0 64 64 )))|((( 65 65 KH_ST_1 66 66 )))|(% colspan="1" %)(% colspan="1" %) 67 67 ((( 68 - 1773 +8 69 69 )))|(% colspan="1" %)(% colspan="1" %) 70 70 ((( 71 71 KH_ST_1 (reverse) 72 72 )))|((( 73 - 2578 +16 74 74 )))|((( 75 75 IC_ST_1 76 76 )))|(% colspan="1" %)(% colspan="1" %) 77 77 ((( 78 - 3383 +24 79 79 )))|(% colspan="1" %)(% colspan="1" %) 80 80 ((( 81 81 OC_ST_1 82 82 ))) 83 83 |((( 84 -1 089 +1 85 85 )))|((( 86 86 KH_ST_2 87 87 )))|(% colspan="1" %)(% colspan="1" %) 88 88 ((( 89 - 1894 +9 90 90 )))|(% colspan="1" %)(% colspan="1" %) 91 91 ((( 92 92 KH_ST_2 (reverse) 93 93 )))|((( 94 - 2699 +17 95 95 )))|((( 96 96 IC_ST_2 97 97 )))|(% colspan="1" %)(% colspan="1" %) 98 98 ((( 99 - 34104 +25 100 100 )))|(% colspan="1" %)(% colspan="1" %) 101 101 ((( 102 102 OC_ST_2 103 103 ))) 104 104 |((( 105 - 11110 +2 106 106 )))|((( 107 107 KH_ST_3 108 108 )))|(% colspan="1" %)(% colspan="1" %) 109 109 ((( 110 -1 9115 +10 111 111 )))|(% colspan="1" %)(% colspan="1" %) 112 112 ((( 113 113 KH_ST_3 (reverse) 114 114 )))|((( 115 - 27120 +18 116 116 )))|((( 117 117 IC_ST_3 118 118 )))|(% colspan="1" %)(% colspan="1" %) 119 119 ((( 120 - 35125 +26 121 121 )))|(% colspan="1" %)(% colspan="1" %) 122 122 ((( 123 123 OC_ST_3 124 124 ))) 125 125 |((( 126 - 12131 +3 127 127 )))|((( 128 128 KH_ST_4 129 129 )))|(% colspan="1" %)(% colspan="1" %) 130 130 ((( 131 - 20136 +11 132 132 )))|(% colspan="1" %)(% colspan="1" %) 133 133 ((( 134 134 KH_ST_4 (reverse) ... ... @@ -144,12 +144,12 @@ 144 144 145 145 ))) 146 146 |((( 147 - 13152 +4 148 148 )))|((( 149 149 KH_ST_5 150 150 )))|(% colspan="1" %)(% colspan="1" %) 151 151 ((( 152 - 21157 +12 153 153 )))|(% colspan="1" %)(% colspan="1" %) 154 154 ((( 155 155 KH_ST_5 (reverse) ... ... @@ -166,42 +166,28 @@ 166 166 ))) 167 167 ))) 168 168 * **locks** - a JSON Array containing the current value of the track permissions, ordered by the default encoding (Hoermann API) 169 -* **tickTime** - Time consumption of tick function in milliseconds. 3 element double-array [min,avg,max]. 170 -* **overallTime** - Time consumption of overall controller loop in milliseconds. 3 element double-array [min,avg,max]. 171 171 172 - 173 - 174 174 {{code title="Sample status" language="js" collapse="true"}} 175 175 {"msgType":"status", 176 -"data":{ 177 - "debug":false, 178 - "cleanup":false, 179 - "pause":false, 180 - "trainCount":8, 181 - "trains":[ 182 - {"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]}, 183 - {"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]}, 184 - {"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]}, 185 - {"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]}, 186 - {"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]}, 187 - {"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]}, 188 - {"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]}, 189 - {"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]} 190 - ], 191 - "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], 192 - "tickTime":[50,60,70], 193 - "overallTime":[70,80,90]}} 177 + "data":{ 178 + "debug":false, 179 + "cleanup":false, 180 + "pause":false, 181 + "trainCount":8, 182 + "trains":[ 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]}, 185 + ... ], 186 + "locks":[-1, -1, -1, 5, -1, -1, 2, 10, -1, -1, ..., -1]}} 194 194 195 195 [One line to test via netcat] 196 -{"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]},{"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]},{"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]},{"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]},{"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]},{"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]},{"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]},{"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]}],"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]}}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]}} 197 197 {{/code}} 198 198 199 199 == Messages received by controller == 200 200 201 -* Every message must contain the keys **command **and **data**. 202 -* Valid values for **command **are the following uppercase commands. 203 -* Depending on the command, the **data**-object contains the described infos. 204 -** If a command doesn't require any additional information, the data-object may be omitted or empty. 194 +* Every message must contain the key **command**. 195 +* Depending on the command, additional keys might be required. 205 205 206 206 === Valid commands === 207 207 ... ... @@ -210,24 +210,25 @@ 210 210 * //LOGOUT// - Closing the connection, leaving the controller running 211 211 * //PAUSE// - suspend or resume the controller, must supply additional payload 212 212 ** **state** - boolean value, true if controller should be suspended 213 -* //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks 214 -* //DEBUG// - enable or disable verbose output, 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 215 215 ** **state** - boolean value, true if verbose output should be activated 216 -* //ECHO// - Prints message as log message on the server (will be broadcasted to all clients)\\ 217 -** **message** - string, message text 218 -* //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\ 208 +* //LIGHT (write//) - activate or deactivate the lights on the railway, must supply additional payload\\ 219 219 ** **state** - boolean value, true if lights should be lit 220 -* //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 221 221 ** **train** - integer train identification 222 -* //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 223 223 ** **train** - integer train identification 224 -* //SCHEDULE// - Set the new schedule for a train, needs additional payload 214 +* //SCHEDULE// (//write//) - Set the new schedule for a train, needs additional payload 225 225 ** **train** - integer train identification 226 226 ** **currentIndex** - current integer position in the schedule array 227 227 ** **tracks** - a JSON Array of integer values, representing the station tracks in encoding above 228 -* //SPEED //- Change the speed settings of a train, needs additional payload 218 +* //SPEED (write//) - Change the speed settings of a train, needs additional payload 229 229 ** **train** - integer train identification 230 230 ** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal 231 -* //TIME// - Change the waiting times for a train 221 +* //TIME// (//write//) - Change the waiting times for a train 232 232 ** **train** - integer train identification 233 -**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. 223 +** **times** - 224 + 225 +{{status colour="Yellow" title="Define a format for this"/}}
- Confluence.Code.ConfluencePageClass[0]
-
- Id
-
... ... @@ -1,1 +1,1 @@ 1 -9471 6901 +9471570 - URL
-
... ... @@ -1,1 +1,1 @@ 1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471 690/TCP Communication1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471570/TCP Communication