Changes for page TCP Communication
Last modified by csp on 2025/01/30 12:05
Summary
-
Page properties (3 modified, 0 added, 0 removed)
-
Objects (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Parent
-
... ... @@ -1,0 +1,1 @@ 1 +SS14Railway.Railway Project (summer term 2014).Documentation.C Controller.WebHome - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. nbw1 +XWiki.csp - 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"]]. ... ... @@ -30,21 +30,21 @@ 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 34 34 * **trainCount** - an integer with the number of active trains on the railway 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 40 -** **spdCaution** - the integer PWM value of this train while driving caution 41 -** **spdNormal** - the integer PWM value of this train while driving normally 42 -** **currentIndex** -an integer describing the current position in the schedule 43 -** ((( 44 -**schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion 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 45 45 46 -{{status colour="Yellow" title="CHANGED"/}} 47 - 48 48 |=((( 49 49 Number 50 50 )))|=((( ... ... @@ -172,41 +172,43 @@ 172 172 173 173 ))) 174 174 ))) 171 +))) 175 175 * **locks** - a JSON Array containing the current value of the track permissions, ordered by the default encoding (Hoermann API) 176 -* **tickTime** - Time consumption of tick function. 3 element array [min,avg,max]. 177 -* **overallTime** - Time consumption of overall controller loop. 3 element array [min,avg,max]. 173 +* **tickTime** - Time consumption of tick function in milliseconds. 3 element double-array [min,avg,max]. 174 +* **overallTime** - Time consumption of overall controller loop in milliseconds. 3 element double-array [min,avg,max]. 178 178 179 179 180 180 181 181 {{code title="Sample status" language="js" collapse="true"}} 182 182 {"msgType":"status", 183 - "data":{ 184 - "debug":false, 185 - "cleanup":false, 186 - "pause":false, 187 - "trainCount":8, 188 - "trains":[ 189 - {"trainNum":0, "waitTime":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":1, "schedule":[9,13,17,21,25,27,33,35]}, 190 - {"trainNum":1, "waitTime":2500, "spdSlow":41, "spdCaution":61, "spdNormal":101, "currentIndex":2, "schedule":[9,13,17,21,25,27,33,35]}, 191 - {"trainNum":2, "waitTime":0, "spdSlow":42, "spdCaution":62, "spdNormal":102, "currentIndex":3, "schedule":[9,13,17,21,25,27,33,35]}, 192 - {"trainNum":3, "waitTime":0, "spdSlow":43, "spdCaution":63, "spdNormal":103, "currentIndex":4, "schedule":[9,13,17,21,25,27,33,35]}, 193 - {"trainNum":4, "waitTime":0, "spdSlow":44, "spdCaution":64, "spdNormal":104, "currentIndex":5, "schedule":[9,13,17,21,25,27,33,35]}, 194 - {"trainNum":5, "waitTime":10000, "spdSlow":45, "spdCaution":65, "spdNormal":105, "currentIndex":6, "schedule":[9,13,17,21,25,27,33,35]}, 195 - {"trainNum":6, "waitTime":0, "spdSlow":46, "spdCaution":66, "spdNormal":106, "currentIndex":7, "schedule":[9,13,17,21,25,27,33,35]}, 196 - {"trainNum":7, "waitTime":0, "spdSlow":47, "spdCaution":67, "spdNormal":107, "currentIndex":8, "schedule":[9,13,17,21,25,27,33,35]}, 197 - ], 198 - "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]}, 199 - "tickTime":[50, 60, 70], 200 - "overallTime":[70, 80, 90]} 201 - 180 +"data":{ 181 + "debug":false, 182 + "cleanup":false, 183 + "pause":false, 184 + "trainCount":8, 185 + "trains":[ 186 + {"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}, 187 + {"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}, 188 + {"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}, 189 + {"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}, 190 + {"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}, 191 + {"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}, 192 + {"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}, 193 + {"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} 194 + ], 195 + "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], 196 + "tickTime":[50,60,70], 197 + "overallTime":[70,80,90]}} 202 202 [One line to test via netcat] 203 -{"msgType":"status","data":{"debug":false,"cleanup":false,"pause":false,"trainCount":8,"trains":[{"t rainNum":0,},{"trainNum":1,},{"trainNum":2,},{"trainNum":3,},{"trainNum":4,},{"trainNum":5,},{"trainNum":6,},{"trainNum":7,8,},],"locks":[-1,},199 +{"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]}} 204 204 {{/code}} 205 205 206 206 == Messages received by controller == 207 207 208 -* Every message must contain the key **command**. 209 -* Depending on the command, additional keys might be required. 204 +* Every message must contain the keys **command **and **data**. 205 +* Valid values for **command **are the following uppercase commands. 206 +* Depending on the command, the **data**-object contains the described infos. 207 +** If a command doesn't require any additional information, the data-object may be omitted or empty. 210 210 211 211 === Valid commands === 212 212 ... ... @@ -215,25 +215,24 @@ 215 215 * //LOGOUT// - Closing the connection, leaving the controller running 216 216 * //PAUSE// - suspend or resume the controller, must supply additional payload 217 217 ** **state** - boolean value, true if controller should be suspended 218 -* //WRITE// - Acquire write access mutex to the controller 219 -* //CLEANUP// (//write//) - Start the cleanup procedure, sending the trains back to their home tacks 220 -* //DEBUG// (//write//) - enable or disable verbose output, must supply additional payload 216 +* //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks 217 +* //DEBUG// - enable or disable verbose output, must supply additional payload 221 221 ** **state** - boolean value, true if verbose output should be activated 222 -* //LIGHT (write//) - activate or deactivate the lights on the railway, must supply additional payload\\ 219 +* //ECHO// - Prints message as log message on the server (will be broadcasted to all clients)\\ 220 +** **message** - string, message text 221 +* //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\ 223 223 ** **state** - boolean value, true if lights should be lit 224 -* //WAIT// (//write//)- Force a train to wait in the next station, must supply additional payload223 +* //WAIT// - Force a train to wait in the next station, must supply additional payload 225 225 ** **train** - integer train identification 226 -* //START (write//)- Force a waiting train to immediately abort the waiting timer, must supply additional payload225 +* //START// - Force a waiting train to immediately abort the waiting timer, must supply additional payload 227 227 ** **train** - integer train identification 228 -* //SCHEDULE// (//write//)- Set the new schedule for a train, needs additional payload227 +* //SCHEDULE// - Set the new schedule for a train, needs additional payload 229 229 ** **train** - integer train identification 230 230 ** **currentIndex** - current integer position in the schedule array 231 231 ** **tracks** - a JSON Array of integer values, representing the station tracks in encoding above 232 -* //SPEED (write//)- Change the speed settings of a train, needs additional payload231 +* //SPEED //- Change the speed settings of a train, needs additional payload 233 233 ** **train** - integer train identification 234 234 ** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal 235 -* //TIME// (//write//)- Change the waiting times for a train234 +* //TIME// - Change the waiting times for a train 236 236 ** **train** - integer train identification 237 -** **times** - 238 - 239 -{{status colour="Yellow" title="Define a format for this"/}} 236 +**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 -9471 5971 +9471477 - URL
-
... ... @@ -1,1 +1,1 @@ 1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471 597/TCP Communication1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471477/TCP Communication