Wiki source code of TCP Communication

Version 40.1 by csp on 2014/08/19 13:20

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