Changes for page TCP Communication

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

From version < 8.1 >

edited by nbw
on 2014/07/07 21:35

To version < 21.1 >

edited by nbw
on 2014/07/30 13:48

Change comment: Removed write lock, Added station times

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -33,12 +33,14 @@
  * **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
++** **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
--** **currentIndex** -an integer describing the current position in the schedule
++** **currentIndex** - an integer describing the current position in the schedule
++** **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.
  ** (((
--**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
@@ -62,75 +62,75 @@
  Track
  )))
  |(((
--1
++9
  )))|(((
  KH_ST_1
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--6
++17
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  KH_ST_1 (reverse)
  )))|(((
--11
++25
  )))|(((
--IC_ST_3
++IC_ST_1
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--14
++33
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--OC_ST_3
++OC_ST_1
  )))
  |(((
--2
++10
  )))|(((
  KH_ST_2
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--7
++18
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  KH_ST_2 (reverse)
  )))|(((
--12
++26
  )))|(((
  IC_ST_2
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--15
++34
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  OC_ST_2
  )))
  |(((
--3
++11
  )))|(((
  KH_ST_3
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--8
++19
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  KH_ST_3 (reverse)
  )))|(((
--13
++27
  )))|(((
--IC_ST_1
++IC_ST_3
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--16
++35
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--OC_ST_1
++OC_ST_3
  )))
  |(((
--4
++12
  )))|(((
  KH_ST_4
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--9
++20
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  KH_ST_4 (reverse)
@@ -146,12 +146,12 @@
  )))
  |(((
--5
++13
  )))|(((
  KH_ST_5
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--10
++21
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  KH_ST_5 (reverse)
@@ -168,19 +168,34 @@
  )))
  )))
  * **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":[
--			{"trainNum":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":2, "schedule":[8, 10, 25, 29, 41, 43]},
--			{"trainNum":1, "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":[
++            {"trainNum":0, "waitTime":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":1, "schedule":[9,13,17,21,25,27,33,35]},
++            {"trainNum":1, "waitTime":2500, "spdSlow":41, "spdCaution":61, "spdNormal":101, "currentIndex":2, "schedule":[9,13,17,21,25,27,33,35]},
++            {"trainNum":2, "waitTime":0, "spdSlow":42, "spdCaution":62, "spdNormal":102, "currentIndex":3, "schedule":[9,13,17,21,25,27,33,35]},
++            {"trainNum":3, "waitTime":0, "spdSlow":43, "spdCaution":63, "spdNormal":103, "currentIndex":4, "schedule":[9,13,17,21,25,27,33,35]},
++            {"trainNum":4, "waitTime":0, "spdSlow":44, "spdCaution":64, "spdNormal":104, "currentIndex":5, "schedule":[9,13,17,21,25,27,33,35]},
++            {"trainNum":5, "waitTime":10000, "spdSlow":45, "spdCaution":65, "spdNormal":105, "currentIndex":6, "schedule":[9,13,17,21,25,27,33,35]},
++            {"trainNum":6, "waitTime":0, "spdSlow":46, "spdCaution":66, "spdNormal":106, "currentIndex":7, "schedule":[9,13,17,21,25,27,33,35]},
++            {"trainNum":7, "waitTime":0, "spdSlow":47, "spdCaution":67, "spdNormal":107, "currentIndex":8, "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]}
++
++[One line to test via netcat]
++{"msgType":"status","data":{"debug":false,"cleanup":false,"pause":false,"trainCount":8,"trains":[{"trainNum":0, "waitTime":0, "spdSlow":40, "spdCaution":60, "spdNormal":100, "currentIndex":1, "schedule":[9,13,17,21,25,27,33,35]},{"trainNum":1, "waitTime":2500, "spdSlow":41, "spdCaution":61, "spdNormal":101, "currentIndex":2, "schedule":[9,13,17,21,25,27,33,35]},{"trainNum":2, "waitTime":0, "spdSlow":42, "spdCaution":62, "spdNormal":102, "currentIndex":3, "schedule":[9,13,17,21,25,27,33,35]},{"trainNum":3, "waitTime":0, "spdSlow":43, "spdCaution":63, "spdNormal":103, "currentIndex":4, "schedule":[9,13,17,21,25,27,33,35]},{"trainNum":4, "waitTime":0, "spdSlow":44, "spdCaution":64, "spdNormal":104, "currentIndex":5, "schedule":[9,13,17,21,25,27,33,35]},{"trainNum":5, "waitTime":10000, "spdSlow":45, "spdCaution":65, "spdNormal":105, "currentIndex":6, "schedule":[9,13,17,21,25,27,33,35]},{"trainNum":6, "waitTime":0, "spdSlow":46, "spdCaution":66, "spdNormal":106, "currentIndex":7, "schedule":[9,13,17,21,25,27,33,35]},{"trainNum":7, "waitTime":0, "spdSlow":47, "spdCaution":67, "spdNormal":107, "currentIndex":8, "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]}
  {{/code}}
  == Messages received by controller ==
@@ -190,14 +190,14 @@
  === Valid commands ===
++* //STATUS// - Poll for the current status, should trigger a status reply message
  * //SHUTDOWN// - Causing the controller to end the program and close all sockets
  * //LOGOUT// - Closing the connection, leaving the controller running
--* //STATUS// - Poll for the current status, should trigger a status reply message
++* //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
  ** **state** - boolean value, true if verbose output should be activated
--* //PAUSE// - suspend or resume the controller, must supply additional payload
--** **state** - boolean value, true if controller should be suspended
  * //LIGHT// - 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
@@ -208,11 +208,11 @@
  ** **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 //- 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
  ** **train** - integer train identification
--** **times** -
++** **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.
--{{status colour="Yellow" title="Define a format for this"/}}
++{{status colour="Yellow" title="New definition"/}}

Confluence.Code.ConfluencePageClass[0]

Id

@@ -1,1 +1,1 @@
--9471513
++9471606

URL

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

Changes for page TCP Communication

Summary

Details

Navigation

Quick Links