...
- 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 otherwise
- write - 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
Status colour Green title NEW - waitTime - (integer) timestamp, when the train is allowed to depart, should only be interpreted if waiting is true
Status colour Green title NEW - 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, encoded in the following fashion
Number Track Number Track Number Track Number Track 1 KH_ST_1 6 KH_ST_1 (reverse) 11 IC_ST_3 14 OC_ST_3 2 KH_ST_2 7 KH_ST_2 (reverse) 12 IC_ST_2 15 OC_ST_2 3 KH_ST_3 8 KH_ST_3 (reverse) 13 IC_ST_1 16 OC_ST_1 4 KH_ST_4 9 KH_ST_4 (reverse) 5 KH_ST_5 10 KH_ST_5 (reverse)
- locks - a JSON Array containing the current value of the track permissions, ordered by the default encoding (Hoermann API)
...
- 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
- STATUS - Poll for the current status, should trigger a status reply message
- CLEANUP 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
- PAUSE - suspend or resume the controller, must supply additional payload
- state - boolean value, true if controller should be suspended
- LIGHT
- LIGHT (write) - 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 -
Status colour Yellow title Define a format for this