Changes for page TCP Communication

Last modified by csp on 2025/01/30 12:05

From version < 14.1 >

edited by Alexander Schulz-Rosengarten
on 2014/07/16 14:28

To version < 40.1 >

edited by csp
on 2014/08/19 13:20

Change comment: train has currentDestination attribute

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Author

@@ -1,1 +1,1 @@
--XWiki.als
++XWiki.csp

Content

@@ -2,10 +2,6 @@
  {{toc/}}
--
--
--{{status colour="Red" title="Work in progress - Might bE subject to change"/}}
--
  Both the controller and the client GUI send their data as JSON Objects.
  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).
  For more information or a complete grammar see [[http:~~/~~/www.json.org/>>url:http://www.json.org/||shape="rect"]].
@@ -30,19 +30,23 @@
  * **debug** - true if the controller is set to verbose debug output, false otherwise
  * **cleanup** - true after cleanup mode has been engaged, false before that point
  * **pause** - true while the controller is paused, false otherwise
--* **write** - true if receiving client has write access, false otherwise
  * **trainCount** - an integer with the number of active trains on the railway
--* **trains** - a JSON Array with the data of all trains, each entry is a JSON Object with these values\\
--** **trainNum** - the individual controller number of the train
--** --**waiting** - boolean value, true if the train is waiting in a station, false otherwise --
--** **{{status colour="Red" title="Removed"/}}waitTime** - (integer) remaining milliseconds until departure (0 if not waiting)
--** **{{status colour="Yellow" title="changed"/}}spdSlow** - the integer PWM value of this train while driving slow
--** **spdCaution** - the integer PWM value of this train while driving caution
--** **spdNormal** - the integer PWM value of this train while driving normally
--** **currentIndex** -an integer describing the current position in the schedule
--** (((
--**schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
++* (((
++**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)
++* **waitTime** - (integer) remaining milliseconds until departure (0 if not waiting)
++* **spdSlow** - the integer PWM value of this train while driving slow
++* **spdCaution** - the integer PWM value of this train while driving caution
++* **spdNormal** - the integer PWM value of this train while driving normally
++* **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.
++* **currentIndex** - an integer describing the current position in the schedule
++* (((
++**schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
++)))
++* (((
++**currentDestination** - the current destination track, encoded in the following fashion
++{{status colour="Green" title="NEW"/}}
++
  |=(((
  Number
  )))|=(((
@@ -65,75 +65,75 @@
  Track
  )))
  |(((
--0
++9
  )))|(((
  KH_ST_1
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--8
++17
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  KH_ST_1 (reverse)
  )))|(((
--16
++25
  )))|(((
--IC_ST_3
++IC_ST_1
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--24
++33
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--OC_ST_3
++OC_ST_1
  )))
  |(((
--1
++10
  )))|(((
  KH_ST_2
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--9
++18
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  KH_ST_2 (reverse)
  )))|(((
--17
++26
  )))|(((
  IC_ST_2
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--25
++34
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  OC_ST_2
  )))
  |(((
--2
++11
  )))|(((
  KH_ST_3
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--10
++19
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  KH_ST_3 (reverse)
  )))|(((
--18
++27
  )))|(((
--IC_ST_1
++IC_ST_3
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--26
++35
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--OC_ST_1
++OC_ST_3
  )))
  |(((
--3
++12
  )))|(((
  KH_ST_4
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--11
++20
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  KH_ST_4 (reverse)
@@ -149,12 +149,12 @@
  )))
  |(((
--4
++13
  )))|(((
  KH_ST_5
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--12
++21
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  KH_ST_5 (reverse)
@@ -170,29 +170,43 @@
  )))
  )))
++)))
  * **locks** - a JSON Array containing the current value of the track permissions, ordered by the default encoding (Hoermann API)
++* **tickTime** - Time consumption of tick function in milliseconds. 3 element double-array [min,avg,max].
++* **overallTime** -  Time consumption of overall controller loop in milliseconds. 3 element double-array [min,avg,max].
++
++
  {{code title="Sample status" language="js" collapse="true"}}
  {"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":[8, 10, 25, 29, 41, 43]},
--			{"trainNum":1, "waiting":true, "waitTime":1234545667, "spdSlow":50, "spdCaution":70, "spdNormal":100, "currentIndex":0, "schedule":[8]},
--			... ],
--		"locks":[-1, -1, -1, 5, -1, -1, 2, 10, -1, -1, ..., -1]}}
--
++"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]}}
  [One line to test via netcat]
--{"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]}}
++{"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]}}
  {{/code}}
  == Messages received by controller ==
--* Every message must contain the key **command**.
--* Depending on the command, additional keys might be required.
++* Every message must contain the keys **command **and **data**.
++* Valid values for **command **are the following uppercase commands.
++* Depending on the command, the **data**-object contains the described infos.
++** If a command doesn't require any additional information, the data-object may be omitted or empty.
  === Valid commands ===
@@ -201,25 +201,24 @@
  * //LOGOUT// - Closing the connection, leaving the controller running
  * //PAUSE// - suspend or resume the controller, must supply additional payload
  ** **state** - boolean value, true if controller should be suspended
--* //WRITE// - Acquire write access mutex to the controller
--* //CLEANUP// (//write//) - Start the cleanup procedure, sending the trains back to their home tacks
--* //DEBUG// (//write//) - enable or disable verbose output, must supply additional payload
++* //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks
++* //DEBUG// - enable or disable verbose output, must supply additional payload
  ** **state** - boolean value, true if verbose output should be activated
--* //LIGHT (write//) - activate or deactivate the lights on the railway, must supply additional payload\\
++* //ECHO// - Prints message as log message on the server (will be broadcasted to all clients)\\
++** **message** - string, message text
++* //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
  ** **state** - boolean value, true if lights should be lit
--* //WAIT// (//write//) - Force a train to wait in the next station, must supply additional payload
++* //WAIT// - Force a train to wait in the next station, must supply additional payload
  ** **train** - integer train identification
--* //START (write//) - Force a waiting train to immediately abort the waiting timer, must supply additional payload
++* //START// - Force a waiting train to immediately abort the waiting timer, must supply additional payload
  ** **train** - integer train identification
--* //SCHEDULE// (//write//) - Set the new schedule for a train, needs additional payload
++* //SCHEDULE// - Set the new schedule for a train, needs additional payload
  ** **train** - integer train identification
  ** **currentIndex** - current integer position in the schedule array
  ** **tracks** - a JSON Array of integer values, representing the station tracks in encoding above
--* //SPEED (write//) - Change the speed settings of a train, needs additional payload
++* //SPEED //- Change the speed settings of a train, needs additional payload
  ** **train** - integer train identification
  ** **speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
--* //TIME// (//write//) - Change the waiting times for a train
++* //TIME// - Change the waiting times for a train
  ** **train** - integer train identification
--** **times** -
--
--{{status colour="Yellow" title="Define a format for this"/}}
++**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 @@
--9471568
++9471739

URL

@@ -1,1 +1,1 @@
--https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471568/TCP Communication
++https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471739/TCP Communication

Changes for page TCP Communication

Summary

Details

Navigation

Quick Links