3 This repo contains git submodules with all source code of this coffee
4 terminal. Fetch it with:
6 git submodule update --init
8 The [`coffee-flask`](coffee-flask.git) directory contains the server
9 application, which runs on [rtime](https://rtime.felk.cvut.cz/coffee)
12 `terminal` directory contains the code running on the terminal. It is
13 based on a standard [buildroot](https://buildroot.org/) distribution.
14 The most important piece of code here is the `mtaio` application from
15 [`terminal/src/mt-apps`](./mt-apps.git), which contains the web server
16 powering the GUI of the terminal – a web browser. Among other things,
17 it informs the browser about physical events captured by the terminal
18 from the card reader and coffee machine buttons.
20 A more detailed documentation is available in [Jiří Matěják's Master
21 thesis](https://dspace.cvut.cz/handle/10467/76276).
25 Data collected by the terminal are stored in an sqlite database on the
26 rtime server. Users with SSH access to that server have read-only
27 access to the database. For example, the whole database can be dumped
30 sqlite3 /home/coffee/coffee-flask/coffee.db .dump
32 ## Hacking on the code
34 To improve the terminal, you can run all the relevant code on your
37 First install all prerequisites:
39 apt install python3-flask libev-dev cmake
40 pip3 install flask_cors
42 Then compile and run all the software components:
44 1. Compile _mtaio_ simulator: `make -C terminal/src/mt-apps SIM=1`
45 2. Run mtaio: `cd terminal/src/mt-apps && ./build/mtaio`
46 3. Run the server application: `cd coffee-flask && FLASK_APP=app.py FLASK_DEBUG=1 flask run`
47 4. Point your web browser to http://localhost:8080/
48 5. Pressing keys in _mtaio_ window simulates various activities.
49 Numbers are cards of different users, letters A through F are
50 different coffee machine buttons.
52 The size of the terminal window is 960×560 px.
54 ### Submitting patches
56 Send patches by email (preferably with [git send-email][]) to
57 `coffee@rtime.felk.cvut.cz` [mailing list][]. You can subscribe the
58 [mailing list][] to discuss the patches sent by others.
60 It is recommended to run the [`setup_git`][sg] script in your local
61 repository to configure git optimally for patch submission.
63 [git send-email]: https://rtime.felk.cvut.cz/wiki/index.php/Configuring_git_send-email
64 [mailing list]: https://rtime.felk.cvut.cz/mailman/listinfo/coffee
65 [sg]: main.git/blob/HEAD:/setup_git