Wiki source code of TCP Communication

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

version	line-number	content
1.1	1
	2
6.1	3	{{toc/}}
	4
1.1	5	Both the controller and the client GUI send their data as JSON Objects.
	6	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).
	7	For more information or a complete grammar see [[http:~~/~~/www.json.org/>>url:http://www.json.org/\|\|shape="rect"]].
	8
	9	== Messages sent by Controller ==
	10
	11	* Every message must provide the keys msgType and data.
	12	* Valid values for msgType are// log//, //error// or// status//.
	13
	14	=== Log messages ===
	15
	16	For //log// messages the data segment consists of a JSON Array, containing zero or more strings.
	17
	18	=== Error messages ===
	19
	20	For //error// messages the data segment consists of one single string, describing the error.
	21
	22	=== Status messages ===
	23
	24	In //status// messages the data segment is a JSON Object which must contain the following key/value pairs.
	25
	26	* debug - true if the controller is set to verbose debug output, false otherwise
	27	* cleanup - true after cleanup mode has been engaged, false before that point
	28	* pause - true while the controller is paused, false otherwise
	29	* trainCount - an integer with the number of active trains on the railway
40.1	30	* (((
	31	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)
	32	* waitTime - (integer) remaining milliseconds until departure (0 if not waiting)
	33	* spdSlow - the integer PWM value of this train while driving slow
	34	* spdCaution - the integer PWM value of this train while driving caution
	35	* spdNormal - the integer PWM value of this train while driving normally
	36	* 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.
	37	* currentIndex - an integer describing the current position in the schedule
	38	* (((
	39	schedule - a JSON Array of integer values, representing the station tracks, encoded in the following fashion
	40	)))
	41	* (((
40.2	42	currentDestination - the current destination track, encoded in the following fashion
4.1	43
8.1	44	\|=(((
	45	Number
	46	)))\|=(((
	47	Track
	48	)))\|=(% colspan="1" %)(% colspan="1" %)
	49	(((
	50	Number
	51	)))\|=(% colspan="1" %)(% colspan="1" %)
	52	(((
	53	Track
	54	)))\|=(((
	55	Number
	56	)))\|=(((
	57	Track
	58	)))\|=(% colspan="1" %)(% colspan="1" %)
	59	(((
	60	Number
	61	)))\|=(% colspan="1" %)(% colspan="1" %)
	62	(((
	63	Track
	64	)))
	65	\|(((
17.1	66	9
8.1	67	)))\|(((
	68	KH_ST_1
	69	)))\|(% colspan="1" %)(% colspan="1" %)
	70	(((
17.1	71	17
8.1	72	)))\|(% colspan="1" %)(% colspan="1" %)
	73	(((
	74	KH_ST_1 (reverse)
	75	)))\|(((
17.1	76	25
8.1	77	)))\|(((
15.1	78	IC_ST_1
8.1	79	)))\|(% colspan="1" %)(% colspan="1" %)
	80	(((
17.1	81	33
8.1	82	)))\|(% colspan="1" %)(% colspan="1" %)
	83	(((
15.1	84	OC_ST_1
8.1	85	)))
	86	\|(((
17.1	87	10
8.1	88	)))\|(((
	89	KH_ST_2
	90	)))\|(% colspan="1" %)(% colspan="1" %)
	91	(((
17.1	92	18
8.1	93	)))\|(% colspan="1" %)(% colspan="1" %)
	94	(((
	95	KH_ST_2 (reverse)
	96	)))\|(((
17.1	97	26
8.1	98	)))\|(((
	99	IC_ST_2
	100	)))\|(% colspan="1" %)(% colspan="1" %)
	101	(((
17.1	102	34
8.1	103	)))\|(% colspan="1" %)(% colspan="1" %)
	104	(((
	105	OC_ST_2
	106	)))
	107	\|(((
17.1	108	11
8.1	109	)))\|(((
	110	KH_ST_3
	111	)))\|(% colspan="1" %)(% colspan="1" %)
	112	(((
17.1	113	19
8.1	114	)))\|(% colspan="1" %)(% colspan="1" %)
	115	(((
	116	KH_ST_3 (reverse)
	117	)))\|(((
17.1	118	27
8.1	119	)))\|(((
15.1	120	IC_ST_3
8.1	121	)))\|(% colspan="1" %)(% colspan="1" %)
	122	(((
17.1	123	35
8.1	124	)))\|(% colspan="1" %)(% colspan="1" %)
	125	(((
15.1	126	OC_ST_3
8.1	127	)))
	128	\|(((
17.1	129	12
8.1	130	)))\|(((
	131	KH_ST_4
	132	)))\|(% colspan="1" %)(% colspan="1" %)
	133	(((
17.1	134	20
8.1	135	)))\|(% colspan="1" %)(% colspan="1" %)
	136	(((
	137	KH_ST_4 (reverse)
	138	)))\|(((
	139
	140	)))\|(((
	141
	142	)))\|(% colspan="1" %)(% colspan="1" %)
	143	(((
	144
	145	)))\|(% colspan="1" %)(% colspan="1" %)
	146	(((
	147
	148	)))
	149	\|(((
17.1	150	13
8.1	151	)))\|(((
	152	KH_ST_5
	153	)))\|(% colspan="1" %)(% colspan="1" %)
	154	(((
17.1	155	21
8.1	156	)))\|(% colspan="1" %)(% colspan="1" %)
	157	(((
	158	KH_ST_5 (reverse)
	159	)))\|(((
	160
	161	)))\|(((
	162
	163	)))\|(% colspan="1" %)(% colspan="1" %)
	164	(((
	165
	166	)))\|(% colspan="1" %)(% colspan="1" %)
	167	(((
	168
	169	)))
	170	)))
40.1	171	)))
8.1	172	* locks - a JSON Array containing the current value of the track permissions, ordered by the default encoding (Hoermann API)
39.1	173	* tickTime - Time consumption of tick function in milliseconds. 3 element double-array [min,avg,max].
	174	* overallTime - Time consumption of overall controller loop in milliseconds. 3 element double-array [min,avg,max].
8.1	175
16.1	176
	177
4.1	178	{{code title="Sample status" language="js" collapse="true"}}
	179	{"msgType":"status",
28.1	180	"data":{
	181	"debug":false,
	182	"cleanup":false,
	183	"pause":false,
	184	"trainCount":8,
	185	"trains":[
40.1	186	{"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},
	187	{"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},
	188	{"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},
	189	{"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},
	190	{"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},
	191	{"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},
	192	{"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},
	193	{"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}
28.1	194	],
	195	"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],
	196	"tickTime":[50,60,70],
	197	"overallTime":[70,80,90]}}
9.1	198	[One line to test via netcat]
40.1	199	{"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]}}
4.1	200	{{/code}}
5.1	201
38.1	202	== Messages received by controller ==
5.1	203
33.1	204	* Every message must contain the keys command and data.
	205	* Valid values for command are the following uppercase commands.
	206	* Depending on the command, the data-object contains the described infos.
	207	** If a command doesn't require any additional information, the data-object may be omitted or empty.
	208
5.1	209	=== Valid commands ===
	210
13.1	211	* //STATUS// - Poll for the current status, should trigger a status reply message
5.1	212	* //SHUTDOWN// - Causing the controller to end the program and close all sockets
	213	* //LOGOUT// - Closing the connection, leaving the controller running
	214	* //PAUSE// - suspend or resume the controller, must supply additional payload
6.1	215	state** - boolean value, true if controller should be suspended
21.1	216	* //CLEANUP// - Start the cleanup procedure, sending the trains back to their home tacks
	217	* //DEBUG// - enable or disable verbose output, must supply additional payload
12.1	218	state** - boolean value, true if verbose output should be activated
38.1	219	* //ECHO// - Prints message as log message on the server (will be broadcasted to all clients)\\
35.1	220	message** - string, message text
21.1	221	* //LIGHT// - activate or deactivate the lights on the railway, must supply additional payload\\
5.1	222	state** - boolean value, true if lights should be lit
21.1	223	* //WAIT// - Force a train to wait in the next station, must supply additional payload
5.1	224	train** - integer train identification
21.1	225	* //START// - Force a waiting train to immediately abort the waiting timer, must supply additional payload
5.1	226	train** - integer train identification
21.1	227	* //SCHEDULE// - Set the new schedule for a train, needs additional payload
5.1	228	train** - integer train identification
	229	currentIndex** - current integer position in the schedule array
8.1	230	tracks** - a JSON Array of integer values, representing the station tracks in encoding above
21.1	231	* //SPEED //- Change the speed settings of a train, needs additional payload
5.1	232	train** - integer train identification
	233	speeds** - JSON Array with three integer values (% class="confluence-link" %)spdSlow, spdCaution, spdNormal
21.1	234	* //TIME// - Change the waiting times for a train
5.1	235	train** - integer train identification
22.1	236	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.

Wiki source code of TCP Communication

Navigation

Quick Links