Changes for page Building

Last modified by Alexander Schulz-Rosengarten on 2025/01/30 12:05
<
From version < 4.2 >
edited by Alexander Schulz-Rosengarten
on 2023/07/13 12:23
To version < 4.1 >
edited by krat
on 2014/08/11 17:58
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Building
1 +Interfacing and Building
Parent
... ... @@ -1,1 +1,0 @@
1 -SS14Railway.Railway Project (summer term 2014).Documentation.C Controller.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.als
1 +XWiki.krat
Content
... ... @@ -1,5 +1,26 @@
1 -== Building / Make Script ==
1 +== Railway Interface ==
2 2  
3 +To interface with the railway or the simulator a wrapper interface around the so called Hoerman-API is used. It can be found in the repository at
4 +[[/code/hostcode/controller.c>>url:https://git.rtsys.informatik.uni-kiel.de/projects/PRAK/repos/14ss-railway/browse/code/hostcode/controller.c||shape="rect"]] and [[/code/hostcode/controller.h>>url:https://git.rtsys.informatik.uni-kiel.de/projects/PRAK/repos/14ss-railway/browse/code/hostcode/controller.h||shape="rect"]].
5 +
6 +The interface provides shorter and simpler access to most of the railway components. To prevent conflicts with existing function names all functions in our interface are prefixed with //rail//.
7 +
8 +Additionally, the interface handles the repeated reading of the reed contacts and persists these values for one tick to prevent side effects.
9 +
10 +The interface also provides waiting timers for the stations and generates a random timing for each train and each station. The preferences for this can be found in [[/code/hostcode/train_preferences.h>>url:https://git.rtsys.informatik.uni-kiel.de/projects/PRAK/repos/14ss-railway/browse/code/hostcode/train_preferences.h||shape="rect"]]
11 +
12 +== Interaction ==
13 +
14 +=== Quit, Pause and Cleanup ===
15 +
16 +While running the following user inputs are provided by the controller:
17 +
18 +* **CTRL+C** (SIGINT)** **quits the controller
19 +* **CTRL+\** (SIGQUIT)** **cleans up
20 +* **CTRL+Z **(SIGSTP) pauses and continues
21 +
22 +== Controller building / Make Script ==
23 +
3 3  The build process for the controller consists of two main tasks:
4 4  
5 5  === Compilation from SCChart to C-Code ===
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9471038
1 +9471707
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471038/Building
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/SS14Railway/pages/9471707/Interfacing and Building