Interfacing and Building

== Railway Interface ==

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 an 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"]]

== Interaction ==

=== 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

24

The build process for the controller consists of two main tasks:

25

26

=== Compilation from SCChart to C-Code ===

27

28

The SCCharts for the Controller are compiled by KIELER. This can either be done in the usual GUI Version or with the [[doc:KIELER.KIELER Compiler Console]].

29

30

Before trying to run the code the compiler output should be checked. The compiler generates C-Code even if the Controller isn't fully schedulable, so be careful when trying new controllers.

31

32

The generated C-Files should be stored in the ///code/// part of the local working copy but commited to the repository.

33

34

=== Compilation from C-Code to executable ===

35

36

To generate the final executable a python script is provided. This can be found at [[/code/make.py>>url:https://git.rtsys.informatik.uni-kiel.de/projects/PRAK/repos/14ss-railway/browse/code/make.py||shape="rect"]].

37

38

Calling the script with the first parameter **rail** and the path to the C-Code compiles the controller for the real railway installation.

39

40

41

python make.py rail railway/Tests/TestAll.c

42

43

44

With the parameter **sim** instead of rail the simulation is built.

45