Changes for page TCP Communication

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

From version < 3.1 >

edited by nbw
on 2014/07/05 12:02

To version < 24.1 >

edited by nbw
on 2014/07/30 14:14

Change comment: removed trainNum from train entries in state

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

@@ -1,7 +1,11 @@
--{{status colour="Red" title="Work in progress - Might by subject to change"/}}
++{{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"]].
@@ -28,10 +28,201 @@
  * **pause** - true while the controller is paused, 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
++** **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
--** **schedule** - a JSON Array of integer values, representing the station tracks in the normal encoding (Hoermann API)
--* **{{status colour="Yellow" title="Need to change this to enable KH-Reverse tracks"/}}locks** - a JSON Array containing the current value of the track permissions, ordered by the default encoding (Hoermann API)
++** **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
++
++|=(((
++Number
++)))|=(((
++Track
++)))|=(% colspan="1" %)(% colspan="1" %)
++(((
++Number
++)))|=(% colspan="1" %)(% colspan="1" %)
++(((
++Track
++)))|=(((
++Number
++)))|=(((
++Track
++)))|=(% colspan="1" %)(% colspan="1" %)
++(((
++Number
++)))|=(% colspan="1" %)(% colspan="1" %)
++(((
++Track
++)))
++|(((
++9
++)))|(((
++KH_ST_1
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++17
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++KH_ST_1 (reverse)
++)))|(((
++25
++)))|(((
++IC_ST_1
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++33
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++OC_ST_1
++)))
++|(((
++10
++)))|(((
++KH_ST_2
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++18
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++KH_ST_2 (reverse)
++)))|(((
++26
++)))|(((
++IC_ST_2
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++34
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++OC_ST_2
++)))
++|(((
++11
++)))|(((
++KH_ST_3
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++19
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++KH_ST_3 (reverse)
++)))|(((
++27
++)))|(((
++IC_ST_3
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++35
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++OC_ST_3
++)))
++|(((
++12
++)))|(((
++KH_ST_4
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++20
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++KH_ST_4 (reverse)
++)))|(((
++
++)))|(((
++
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++
++)))
++|(((
++13
++)))|(((
++KH_ST_5
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++21
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++KH_ST_5 (reverse)
++)))|(((
++
++)))|(((
++
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++
++)))
++)))
++* **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":[
++            {"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]},
++            {"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]},
++            {"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]},
++            {"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]},
++            {"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]},
++            {"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]},
++            {"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]},
++            {"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":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 ==
++
++* Every message must contain the key **command**.
++* Depending on the command, additional keys might be required.
++
++=== 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
++* //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
++* //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
++** **train** - integer train identification
++* //START// - 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
++** **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
++** **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** - 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 @@
--9471481
++9471612

URL

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

Changes for page TCP Communication

Summary

Details

Navigation

Quick Links