Wiki source code of Android
Last modified by csp on 2025/01/30 12:05
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | == Android Studio Project == | ||
| 2 | |||
| 3 | Find the project files and README at [[/14ss-railway/code/gui/android>>url:https://git.rtsys.informatik.uni-kiel.de/projects/PRAK/repos/14ss-railway/browse/code/gui/android||shape="rect"]]. | ||
| 4 | |||
| 5 | == Android App == | ||
| 6 | |||
| 7 | Download the app from [[app-release.apk (Stash)>>url:https://git.rtsys.informatik.uni-kiel.de/projects/PRAK/repos/14ss-railway/browse/code/gui/android/release/app-release.apk||shape="rect"]] or [[railway.apk (direkt link)>>attach:railway.apk]]. | ||
| 8 | |||
| 9 | == App Features == | ||
| 10 | |||
| 11 | Global controls are connect/disconnect to/from the server specified in the settings, sending messages, shutting down the controller and opening the app's settings screen. | ||
| 12 | |||
| 13 | The first screen shown by the app on initial start is the settings screen. | ||
| 14 | |||
| 15 | === Settings screen === | ||
| 16 | |||
| 17 | |((( | ||
| 18 | [[image:attach:SS14Railway.GUIs.WebHome@settings.png]] | ||
| 19 | )))|((( | ||
| 20 | Edit the app's settings: | ||
| 21 | |||
| 22 | * Host and port of the PC running the railway controller. | ||
| 23 | * (De-) activate automatic polling of status information. | ||
| 24 | * Period of automatic polling. | ||
| 25 | |||
| 26 | |||
| 27 | |||
| 28 | |||
| 29 | |||
| 30 | Exit the settings by clicking the app icon in the upper left or by pressing 'back' on your device. | ||
| 31 | ))) | ||
| 32 | |||
| 33 | |||
| 34 | |||
| 35 | === Status Screen === | ||
| 36 | |||
| 37 | |((( | ||
| 38 | [[image:attach:SS14Railway.GUIs.WebHome@main.png]] | ||
| 39 | )))|((( | ||
| 40 | Displays general status information and controls and the list of trains. | ||
| 41 | |||
| 42 | General controls are setting pause, debug or lights on/off and activating the cleanup function. | ||
| 43 | |||
| 44 | |||
| 45 | |||
| 46 | Short click a train to edit it's parameters. | ||
| 47 | |||
| 48 | Long click a train to force start or stop it. | ||
| 49 | |||
| 50 | Swipe left to get to the log/error screen | ||
| 51 | ))) | ||
| 52 | |||
| 53 | === Edit train === | ||
| 54 | |||
| 55 | Editing trains is divided into three parts. | ||
| 56 | |||
| 57 | To apply the changes of the current screen, click the save icon in the upper right to send the command to the controller. | ||
| 58 | |||
| 59 | ==== Schedule ==== | ||
| 60 | |||
| 61 | |((( | ||
| 62 | [[image:attach:SS14Railway.GUIs.WebHome@schedule.png]] | ||
| 63 | )))|((( | ||
| 64 | Edit the train's schedule by adding, removing or changing entries. Each entry can be picked from a popup list. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | Swipe left to get to the speeds section. | ||
| 75 | ))) | ||
| 76 | |||
| 77 | ==== Speeds ==== | ||
| 78 | |||
| 79 | |((( | ||
| 80 | [[image:attach:SS14Railway.GUIs.WebHome@speeds.png]] | ||
| 81 | )))|((( | ||
| 82 | Edit the train's speeds for SLOW, CAUTION and NORMAL by selecting or entering the desired value. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | Swipe left to get to the waiting times section. | ||
| 93 | ))) | ||
| 94 | |||
| 95 | ==== Waiting times ==== | ||
| 96 | |||
| 97 | |((( | ||
| 98 | [[image:attach:SS14Railway.GUIs.WebHome@times.png]] | ||
| 99 | )))|((( | ||
| 100 | Edit the train's minimum waiting times and the maximum random offset for each station and platform. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | Leave the train edit screen by clicking the app icon in the upper left or by pressing 'back' on your device. | ||
| 111 | ))) | ||
| 112 | |||
| 113 | === Start/stop a train === | ||
| 114 | |||
| 115 | |((( | ||
| 116 | [[image:attach:SS14Railway.GUIs.WebHome@forceWaitStart.png]] | ||
| 117 | )))|((( | ||
| 118 | When a train is travelling, forcing it to stop causes the train to wait in the next station until 'Force start' is clicked. | ||
| 119 | |||
| 120 | When a train is already waiting in a station but it's waiting time is counting down, force stop causes it to stay in this station until it's force started. | ||
| 121 | |||
| 122 | When a train is forced waiting in a station, force start causes it to leave the station as soon as possible (other trains may block it from leaving). | ||
| 123 | ))) | ||
| 124 | |||
| 125 | === Log/error screen === | ||
| 126 | |||
| 127 | |((( | ||
| 128 | [[image:attach:SS14Railway.GUIs.WebHome@log.png]] | ||
| 129 | )))|((( | ||
| 130 | Shows log and error messages received from the controller. | ||
| 131 | |||
| 132 | If this view isn't visible, the amount of unread errors is displayed in the tab title and a notification is shown on new errors. | ||
| 133 | ))) | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 |