1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
# client code
this is the subdirectory for all client code (runs on pc/laptop)
this page is WIP
## features
|feature|due|status|author|description|
|-|-|-|-|-|
|view warnings / errors|may 31|unimplemented||see a log of parsed warnings/errors
|direct control|may 31|unimplemented||directly control the robot with tank-style controls
|configure map|june 04|unimplemented||set map width/height and define entry/exitpoints
|input orders|june 04|unimplemented||type orders with lists of coordinates to visit
|enable/disable emergency mode|may 31|unimplemented||self-explanatory
|enable/disable sensor calibration mode|may 31|unimplemented||self-explanatory
|enable/disable wet floor mode|may 31|unimplemented||self-explanatory
|read sensor values|june 04|unimplemented||dashboard that displays all i/o as bar graphs
|set display contents|optional|unimplemented||send text to display on lcd
|play music|optional|unimplemented||play tunes
|control leds|optional|unimplemented||turn on/off underside leds
## interface
the client is a user-facing application that allows control and monitoring of
the robot in various ways. it primarily works in a bios-like way, with the user
having access to multiple tabs containing options or custom interface elements.
to start the interface, the user should run `./main <com-port>`. the interface
could look something like this (with colored text for element seperation, [see
on figma](https://www.figma.com/file/vZ6rQp2G1HBAmbdrkxIZJ3/terminal-app)):
```
verbonden, 2ms ping (0.0.2-11-g92c394b) batterij 100%
[huidige logica-modus] 0 waarschuwingen, 0 foutmeldingen
[info] logs direct aansturen kaart orders modus instellen sensor...
--------------------------------------------------------------------------------
welkom in de wall-e2 console applicatie! deze client is versie
0.0.2-11-g92c394b
deze applicatie functioneert op een soortgelijke manier als een BIOS. hier is
een lijst met besturingscommando's:
<links>/<rechts>, <h>/<l> tabblad wisselen
<omlaag>/<omhoog>, <j>/<k> optie selecteren
<enter>, <i> optie aanpassen
<home>, <g> terug naar boven scrollen
<end>, <G> naar einde van pagina scrollen
<escape> terug
<q> console applicatie sluiten
sneltoetsen:
<N> info <o> orders
<S> logs <M> modus instellen
<d> direct aansturen <m> kaart
```
the top status bar is always supposed to be visible, and is sort of inspired by
[ncmpcpp](https://github.com/ncmpcpp/ncmpcpp). because the client software
should use no libraries if possible, a custom renderer needs to be implemented,
though it doesn't matter if it's very primitive.
going from top-left in reading order the status bar contains: connection
status, ping time, robot version number, robot battery info, current logic
mode, warnings and critical exceptions, and lastly a tab bar. the version
number is aligned to the terminal center, and the battery and warning counters
are aligned right. when a connection hasn't been established between the robot
and client, the fields containing robot info should dissapear. the tab bar
scrolls horizontally, and tab names should in addition to a single space
seperator, keep spaces before and after to fit square brackets indicating tab
selection status.
## code structure
because multithreading is hard, another cyclic system is used. the following
modules are executed after each other:
- serial read
- stdin read (user input)
- status bar paint
- current tab paint
## notes on ascii escape codes
- color codes
- terminal echo codes
- how to read terminal (re)size
- cursor movement(?)
|