Changes for page TCP Communication

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

From version < 28.1 >

edited by nbw
on 2014/07/31 12:34

To version < 15.1 >

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

Change comment: There is no comment for this version

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.nbw
++XWiki.als

Content

@@ -30,17 +30,18 @@
  * **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
--** **state** - integer value for current train state (0 = travelling, 1 = waiting, 2 = forced travel, 3 = forced wait)
--** **waitTime** - (integer) remaining milliseconds until departure (0 if not waiting)
--** **spdSlow** - the integer PWM value of this train while driving slow
++* **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
--** **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
++** **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
++**schedule** - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
  |=(((
  Number
@@ -64,75 +64,75 @@
  Track
  )))
  |(((
--9
++0
  )))|(((
  KH_ST_1
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--17
++8
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  KH_ST_1 (reverse)
  )))|(((
--25
++16
  )))|(((
  IC_ST_1
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--33
++24
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  OC_ST_1
  )))
  |(((
--10
++1
  )))|(((
  KH_ST_2
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--18
++9
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  KH_ST_2 (reverse)
  )))|(((
--26
++17
  )))|(((
  IC_ST_2
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--34
++25
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  OC_ST_2
  )))
  |(((
--11
++2
  )))|(((
  KH_ST_3
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--19
++10
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  KH_ST_3 (reverse)
  )))|(((
--27
++18
  )))|(((
  IC_ST_3
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--35
++26
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  OC_ST_3
  )))
  |(((
--12
++3
  )))|(((
  KH_ST_4
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--20
++11
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  KH_ST_4 (reverse)
@@ -148,12 +148,12 @@
  )))
  |(((
--13
++4
  )))|(((
  KH_ST_5
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--21
++12
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  KH_ST_5 (reverse)
@@ -170,34 +170,22 @@
  )))
  )))
  * **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. 3 element array [min,avg,max].
--* **overallTime** -  Time consumption of overall controller loop. 3 element array [min,avg,max].
--
--
  {{code title="Sample status" language="js" collapse="true"}}
  {"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]}}
++	"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]}}
  [One line to test via netcat]
--{"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]}}
++{"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]}}
  {{/code}}
  == Messages received by controller ==
@@ -212,22 +212,25 @@
  * //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
--* //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks
--* //DEBUG// - enable or disable verbose output, must supply additional payload
++* //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
  ** **state** - boolean value, true if verbose output should be activated
--* //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
++* //LIGHT (write//) - activate or deactivate the lights on the railway, must supply additional payload\\
  ** **state** - boolean value, true if lights should be lit
--* //WAIT// - Force a train to wait in the next station, must supply additional payload
++* //WAIT// (//write//) - Force a train to wait in the next station, must supply additional payload
  ** **train** - integer train identification
--* //START// - Force a waiting train to immediately abort the waiting timer, must supply additional payload
++* //START (write//) - Force a waiting train to immediately abort the waiting timer, must supply additional payload
  ** **train** - integer train identification
--* //SCHEDULE// - Set the new schedule for a train, needs additional payload
++* //SCHEDULE// (//write//) - 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 //- Change the speed settings of a train, needs additional payload
++* //SPEED (write//) - 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// - Change the waiting times for a train
++* //TIME// (//write//) - Change the waiting times for a train
  ** **train** - integer train identification
--**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.
++** **times** -
++
++{{status colour="Yellow" title="Define a format for this"/}}

Confluence.Code.ConfluencePageClass[0]

Id

@@ -1,1 +1,1 @@
--9471628
++9471570

URL

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

Changes for page TCP Communication

Summary

Details

Navigation

Quick Links