Page History

Table of Contents
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/.

...

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 otherwisewrite - 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 StatuscolourRedtitleRemovedstate - 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) StatuscolourYellowtitlechanged
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

Number	Track	Number	Track	Number	Track	Number	Track
09	KH_ST_1	817	KH_ST_1 (reverse)	1625	IC_ST_1	2433	OC_ST_1
110	KH_ST_2	918	KH_ST_2 (reverse)	1726	IC_ST_2	2534	OC_ST_2
211	KH_ST_3	1019	KH_ST_3 (reverse)	1827	IC_ST_3	2635	OC_ST_3
312	KH_ST_4	1120	KH_ST_4 (reverse)
413	KH_ST_5	1221	KH_ST_5 (reverse)

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 Block

language	js
title	Sample status
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]}}

    {"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":[ {"trainNumstate":03, "waiting":false, "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":21, "schedule":[1, 1, 11, 14, 6]}, {"trainNum":1, "waiting":true, 9,13,17,21,25,27,33,35],"currentDestination":9},{"state":1,"waitTime":99999999992500, "spdSlow":5141, "spdCaution":7161, "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":02, "schedule":[2, 1, 11, 14, 6]}, {"trainNum":2, "waiting":false, 9,13,17,21,25,27,33,35],"currentDestination":13},{"state":0,"waitTime":0, "spdSlow":5242, "spdCaution":7262, "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":13, "schedule":[3, 1, 11, 14, 6]}, {"trainNum":3, "waiting":false, 9,13,17,21,25,27,33,35],"currentDestination":13},{"state":0,"waitTime":0, "spdSlow":5343, "spdCaution":7363, "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":14, "schedule":[4, 1, 11, 14, 6]}, {"trainNum":4, "waiting":false, 9,13,17,21,25,27,33,35],"currentDestination":13},{"state":0,"waitTime":0, "spdSlow":5444, "spdCaution":7464, "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":25, "schedule":[5, 1, 11, 14, 6]}, {"trainNum":5, "waiting":false, 9,13,17,21,25,27,33,35],"currentDestination":27},{"state":1,"waitTime":010000, "spdSlow":5545, "spdCaution":7565, "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":36, "schedule":[6, 1, 11, 14, 6]}, {"trainNum":6, "waiting":false, 9,13,17,21,25,27,33,35],"currentDestination":9},{"state":2,"waitTime":0, "spdSlow":5646, "spdCaution":7666, "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":17, "schedule":[7, 1, 11, 14, 6]}, {"trainNum":7, "waiting":false, 9,13,17,21,25,27,33,35],"currentDestination":10},{"state":0,"waitTime":0, "spdSlow":5747, "spdCaution":7767, "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":04, "schedule":[8, 1, 11, 14, 6]9,13,17,21,25,27,33,35],"currentDestination":21}], "locks":[-1, -1, -1, 5, -1, -1, 2, 3, 0,-1,-1, 2,-1, -1, -1, 61, -1, -1, -1, -1, -1, -1, 4, -1, -1, -1, -1, 0, -1, -1, 4,-1, -1, -1, -1, -1,5, -1, -1, -1, ,3,3,7,7,-1, -1, -1, -1, -1, -1, 76, -1, -1, -1, -1, -1, -1],"tickTime":[50,60,70],"overallTime":[70,80,90]}}

Messages received by controller

Every message must contain the key commandkeys command and data.
Valid values for command are the following uppercase commands.
Depending on the command, additional keys might be requiredthe 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

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
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 (write)
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
- train - integer train identification
START (write) - 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
- 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
- train - integer train identification
- speeds - JSON Array with three integer values spdSlow, spdCaution, spdNormal
TIME (write) - Change the waiting times for a train
- train - integer train identification
  times - StatuscolourYellowtitleDefine a format for thisa 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.

Page tree

Versions Compared

Old Version 14

New Version Current

Key

Messages received by controller

Valid commands