-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathct-Bot.h
388 lines (310 loc) · 11.7 KB
/
ct-Bot.h
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
/*
* c't-Bot
*
* This program is free software; you can redistribute it
* and/or modify it under the terms of the GNU General
* Public License as published by the Free Software
* Foundation; either version 2 of the License, or (at your
* option) any later version.
* This program is distributed in the hope that it will be
* useful, but WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU General Public License for more details.
* You should have received a copy of the GNU General Public
* License along with this program; if not, write to the Free
* Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307, USA.
*
*/
/**
* \file ct-Bot.h
* \brief globale Schalter fuer die einzelnen Bot-Funktionalitaeten
* \author Benjamin Benz ([email protected])
* \date 26.12.2005
*/
#ifndef CT_BOT_H_
#define CT_BOT_H_
/*** Konfigurierbare Optionen
* Die Optionen lassen sich jeweils per #define ein- oder ausschalten. Das Ausschalten erfolgt durch die Kommentarzeichen am Anfang der Zeile.
* Ausgeschaltete Optionen belegen keinen Platz im Flash-Speicher des Controllers. ***/
/* Logging-Funktionen */
//Achtung: Bis auf #define USE_MINILOG, das zusaetzlich aktiviert sein kann, kann immer nur eine Logging-Ausgabe aktiviert sein
//#define LOG_CTSIM_AVAILABLE /**< Logging zum ct-Sim (PC und MCU) */
//#define LOG_DISPLAY_AVAILABLE /**< Logging-Ausgabe ueber das LCD-Display (PC und MCU) */
//#define LOG_UART_AVAILABLE /**< Logging ueber UART (nur fuer MCU) */
//#define LOG_RPI_AVAILABLE /**< Logging-Ausgabe vom ATmega zum ARM-Linux Board z.B. RPi (nur MCU) */
#define LOG_STDOUT_AVAILABLE /**< Logging-Ausgabe auf die Konsole, von der der Bot gestartet wurde (nur fuer PC) */
//#define LOG_MMC_AVAILABLE /**< Logging in eine txt-Datei auf MMC */
#define USE_MINILOG /**< schaltet auf schlankes Logging um */
//#define CREATE_TRACEFILE_AVAILABLE /**< Aktiviert das Schreiben einer Trace-Datei (nur PC) */
/* Kommunikation */
#define BOT_2_SIM_AVAILABLE /**< Soll der Bot mit dem Sim kommunizieren? */
//#define BOT_2_BOT_AVAILABLE /**< Sollen Bots untereinander kommunizieren? */
#define BOT_2_BOT_PAYLOAD_AVAILABLE /**< Aktiviert Payload-Versand per Bot-2-Bot Kommunikation */
/* Display-Funktionen */
#define DISPLAY_AVAILABLE /**< Display-Funktionen aktiv */
#define KEYPAD_AVAILABLE /**< Keypad-Eingabe vorhanden? */
#define DISPLAY_MCU_AVAILABLE /**< lokales Display (an ATmega) vorhanden */
#define DISPLAY_REMOTE_AVAILABLE /**< Sende LCD Anzeigedaten an den Simulator */
//#define WELCOME_AVAILABLE /**< kleiner Willkommensgruss */
/* Sensorauswertung */
//#define MOUSE_AVAILABLE /**< Maus Sensor */
#define MEASURE_MOUSE_AVAILABLE /**< Geschwindigkeiten werden aus den Maussensordaten berechnet */
//#define MEASURE_COUPLED_AVAILABLE /**< Geschwindigkeiten werden aus Maus- und Encoderwerten ermittelt und gekoppelt */
//#define MEASURE_POSITION_ERRORS_AVAILABLE /**< Fehlerberechnungen bei der Positionsbestimmung */
//#define BPS_AVAILABLE /**< Bot Positioning System */
//#define SRF10_AVAILABLE /**< Ultraschallsensor SRF10 vorhanden */
//#define CMPS03_AVAILABLE /**< Kompass CMPS03 vorhanden */
/* Motoransteuerung */
#define SPEED_CONTROL_AVAILABLE /**< Aktiviert die Motorregelung */
//#define ADJUST_PID_PARAMS /**< macht PID-Paramter zur Laufzeit per FB einstellbar */
//#define SPEED_LOG_AVAILABLE /**< Zeichnet Debug-Infos der Motorregelung auf MMC auf */
/* Umgebungskarte */
#define MAP_AVAILABLE /**< Aktiviert die Kartographie; wenn aktiviert, funktioniert ui/available-screens.h/DISPLAY_MMC_INFO nicht */
#define MAP_2_SIM_AVAILABLE /**< Sendet die Map zur Anzeige an den Sim */
/* MMC-/SD-Karte als Speichererweiterung (opt. Erweiterungsmodul) */
//#define MMC_AVAILABLE /**< Aktiviert Unterstuetzung von MMC/SD-Karten im Erweiterungsmodul */
#define SDFAT_AVAILABLE /**< Unterstuetzung fuer FAT-Dateisystem (FAT16 und FAT32) auf MMC/SD-Karte */
/* Hardware-Treiber */
#define ADC_AVAILABLE /**< A/D-Konverter */
#define SHIFT_AVAILABLE /**< Shift Register */
#define ENA_AVAILABLE /**< Enable-Leitungen */
#define LED_AVAILABLE /**< LEDs aktiv */
#define IR_AVAILABLE /**< Infrarot Fernbedienung aktiv */
#define RC5_AVAILABLE /**< Key-Mapping fuer IR-RC aktiv */
//#define SP03_AVAILABLE /**< Sprachmodul SP03 vorhanden */
/* Sonstiges */
#define BEHAVIOUR_AVAILABLE /**< Nur wenn dieser Parameter gesetzt ist, exisitiert das Verhaltenssystem */
#define POS_STORE_AVAILABLE /**< Positionsspeicher vorhanden */
#define OS_AVAILABLE /**< Aktiviert BotOS fuer Threads und Scheduling */
//#define BOOTLOADER_AVAILABLE /**< Aktiviert den Bootloadercode - das ist nur noetig fuer die einmalige "Installation" des Bootloaders */
#define ARM_LINUX_BOARD /**< Code fuer ARM-Linux Board aktivieren, wenn ein ARM-Linux-* Target ausgewaehlt wurde. Fuehrt den high-level Code und die Verhalten aus */
//#define BOT_2_RPI_AVAILABLE /**< Kommunikation von ATmega mit einem Linux-Board (z.B. Raspberry Pi) aktivieren. Fuehrt auf dem ATmega den low-level Code aus */
/*** Abhaengigkeiten ***/
#include "global.h" // ct-Bot Datentypen
#include "bot-local.h" // Hardwarekonfigurationen, die bei den Bots verschieden sein koennen
#ifdef IN_TEST_RUN
#ifndef TEST_CONFIG
#error "Test-Modus, aber keine Test-Config eingebunden. Falsche Compiler-include-Pfade gesetzt?"
#endif
#endif
#if ! (defined PC && defined ARM_LINUX_BOARD && defined __arm__ && defined __gnu_linux__)
#undef ARM_LINUX_BOARD
#endif
#ifndef IR_AVAILABLE
#undef RC5_AVAILABLE
#endif
#ifndef RC5_AVAILABLE
#undef KEYPAD_AVAILABLE
#endif
#include "rc5-codes.h"
#if ! defined RC5_CODE_DOT || ! defined RC5_CODE_STOP || ! defined RC5_CODE_PLAY
#undef KEYPAD_AVAILABLE
#endif
#ifdef EXPANSION_BOARD_AVAILABLE
#undef ENABLE_RX0_PULLUP // Erweiterungsboard verwendet pull-down fuer RX0, also Kurzschluss verhindern
#endif
#ifdef AUTO_DISPLAYLIGHT
#undef EXPANSION_BOARD_AVAILABLE // Erweiterungsboard verwendet ENA_MOUSE_SENSOR fuer den Betrieb des Maussensors
#endif
#ifndef MOUSE_AVAILABLE
#undef MEASURE_MOUSE_AVAILABLE
#undef MEASURE_COUPLED_AVAILABLE
#endif
#ifdef BOT_2_BOT_AVAILABLE
#define BOT_2_SIM_AVAILABLE
#endif
#ifdef PC
#ifndef DOXYGEN
/* Folgende Optionen deaktivieren, es gibt sie nicht fuer PC */
#undef UART_AVAILABLE
#undef SHIFT_AVAILABLE
#undef SRF10_AVAILABLE
#undef TWI_AVAILABLE
#undef SPEED_CONTROL_AVAILABLE
#undef SPEED_LOG_AVAILABLE
#undef MMC_AVAILABLE
#undef I2C_AVAILABLE
#undef CMPS03_AVAILABLE
#undef SP03_AVAILABLE
#undef BOT_2_RPI_AVAILABLE
#undef BOOTLOADER_AVAILABLE
#endif // ! DOXYGEN
#if !defined BOT_2_SIM_AVAILABLE && ! defined ARM_LINUX_BOARD
#define BOT_2_SIM_AVAILABLE // simulierte Bots brauchen immer Kommunikation zum Sim
#endif
#define COMMAND_AVAILABLE /**< High-Level Kommunikation */
#endif // PC
#ifdef MCU
#ifdef LOG_CTSIM_AVAILABLE
#define BOT_2_SIM_AVAILABLE
#endif
#if defined MCU && defined BOT_2_RPI_AVAILABLE
#define UART_AVAILABLE
#define COMMAND_AVAILABLE
#undef BOT_2_BOT_AVAILABLE
#undef BOT_2_SIM_AVAILABLE
#undef LOG_UART_AVAILABLE
#undef BEHAVIOUR_AVAILABLE
#undef POS_STORE_AVAILABLE
#undef MAP_AVAILABLE
#ifdef DISPLAY_MCU_AVAILABLE
#undef DISPLAY_REMOTE_AVAILABLE
#endif
#endif // MCU && BOT_2_RPI_AVAILABLE
#ifdef BOT_2_SIM_AVAILABLE
#define UART_AVAILABLE /**< Serielle Kommunikation */
#define COMMAND_AVAILABLE /**< High-Level Kommunikation */
#else // ! BOT_2_SIM_AVAILABLE
#ifndef BOT_2_RPI_AVAILABLE
#undef DISPLAY_REMOTE_AVAILABLE
#endif
#undef MAP_2_SIM_AVAILABLE
#endif // BOT_2_SIM_AVAILABLE
#if ! (defined DISPLAY_MCU_AVAILABLE || defined DISPLAY_REMOTE_AVAILABLE || defined ARM_LINUX_DISPLAY)
#undef DISPLAY_AVAILABLE
#endif
#ifndef DISPLAY_AVAILABLE
#undef WELCOME_AVAILABLE
#undef DISPLAY_MCU_AVAILABLE
#undef DISPLAY_REMOTE_AVAILABLE
#endif
#undef CREATE_TRACEFILE_AVAILABLE
#if ! defined __AVR_ATmega1284P__ && ! defined __AVR_ATmega644__ && ! defined __AVR_ATmega644P__
#undef MMC_AVAILABLE
#undef SDFAT_AVAILABLE
#endif // ATmega1284P / ATmega644X
#endif // MCU
#ifndef SPEED_CONTROL_AVAILABLE
#undef ADJUST_PID_PARAMS
#endif
#ifndef MMC_AVAILABLE
#ifdef MCU
#undef MAP_AVAILABLE // Map geht auf dem MCU nur mit MMC
#undef SDFAT_AVAILABLE
#endif // MCU
#endif // ! MMC_AVAILABLE
#if ! defined BEHAVIOUR_AVAILABLE && defined POS_STORE_AVAILABLE
#undef POS_STORE_AVAILABLE
#warning "POS_STORE_AVAILABLE benoetigt BEHAVIOUR_AVAILABLE"
#endif
#if ! defined OS_AVAILABLE && defined SDFAT_AVAILABLE
#undef SDFAT_AVAILABLE
#warning "SDFAT_AVAILABLE benoetigt OS_AVAILABLE"
#endif
#ifdef PC
#undef LOG_UART_AVAILABLE // Auf dem PC gibts kein Logging ueber UART
#endif // PC
#ifdef MCU
/* Mit Bot zu Sim Kommunikation auf dem MCU gibts kein Logging ueber UART.
* Ohne gibts keine Kommunikation ueber ct-Sim. */
#undef LOG_STDOUT_AVAILABLE // MCU hat kein LOG_STDOUT
#ifdef BOT_2_SIM_AVAILABLE
#undef LOG_UART_AVAILABLE
#else // ! BOT_2_SIM_AVAILABLE
#ifndef BOT_2_RPI_AVAILABLE
#undef LOG_CTSIM_AVAILABLE
#endif // ! BOT_2_RPI_AVAILABLE
#endif // BOT_2_SIM_AVAILABLE
#else // ! MCU
#undef LOG_RPI_AVAILABLE
#endif // MCU
/* Ohne Display gibts auch keine Ausgaben auf diesem. */
#ifndef DISPLAY_AVAILABLE
#undef LOG_DISPLAY_AVAILABLE
#endif
#if ! defined SDFAT_AVAILABLE && defined USE_MINILOG
#undef LOG_MMC_AVAILABLE
#endif // SDFAT_AVAILABLE && USE_MINILOG
#ifndef SDFAT_AVAILABLE
#undef SPEED_LOG_AVAILABLE
#undef MAP_AVAILABLE
#endif
#ifndef BOT_2_RPI_AVAILABLE
#undef LOG_RPI_AVAILABLE
#endif
#ifdef LOG_UART_AVAILABLE
#define LOG_AVAILABLE
#endif
#ifdef LOG_CTSIM_AVAILABLE
#define LOG_AVAILABLE
#endif
#ifdef LOG_DISPLAY_AVAILABLE
#undef USE_MINILOG
#define LOG_AVAILABLE
#endif
#if defined LOG_STDOUT_AVAILABLE && defined PC
#undef USE_MINILOG
#define LOG_AVAILABLE
#endif
#ifdef LOG_RPI_AVAILABLE
#define LOG_AVAILABLE
#endif
#ifdef LOG_MMC_AVAILABLE
#define LOG_AVAILABLE
#endif
#ifndef BEHAVIOUR_AVAILABLE
#undef MAP_AVAILABLE
#endif
#ifdef MAP_AVAILABLE
#define OS_AVAILABLE // Map braucht BotOS
#else // ! MAP_AVAILABLE
#undef MAP_2_SIM_AVAILABLE
#endif // MAP_AVAILABLE
#ifndef BOT_2_BOT_AVAILABLE
#undef BOT_2_BOT_PAYLOAD_AVAILABLE
#endif
#ifdef LOG_AVAILABLE
/* Es kann immer nur ueber eine Schnittstelle geloggt werden. */
#ifdef LOG_UART_AVAILABLE
#define UART_AVAILABLE /**< Serielle Kommunikation */
#undef LOG_CTSIM_AVAILABLE
#undef LOG_DISPLAY_AVAILABLE
#undef LOG_STDOUT_AVAILABLE
#undef LOG_MMC_AVAILABLE
#undef LOG_RPI_AVAILABLE
#endif
#ifdef LOG_CTSIM_AVAILABLE
#undef LOG_DISPLAY_AVAILABLE
#undef LOG_STDOUT_AVAILABLE
#undef LOG_MMC_AVAILABLE
#undef LOG_RPI_AVAILABLE
#endif
#ifdef LOG_DISPLAY_AVAILABLE
#undef LOG_STDOUT_AVAILABLE
#undef LOG_MMC_AVAILABLE
#undef LOG_RPI_AVAILABLE
#endif
#ifdef LOG_STDOUT_AVAILABLE
#undef LOG_RPI_AVAILABLE
#undef LOG_MMC_AVAILABLE
#endif
#ifdef LOG_RPI_AVAILABLE
#undef LOG_MMC_AVAILABLE
#endif
#ifndef SDFAT_AVAILABLE
#undef LOG_MMC_AVAILABLE
#undef SPEED_LOG_AVAILABLE
#endif
#if ! defined LOG_CTSIM_AVAILABLE && ! defined LOG_DISPLAY_AVAILABLE && ! defined LOG_UART_AVAILABLE && \
! defined LOG_STDOUT_AVAILABLE && ! defined LOG_MMC_AVAILABLE && ! defined LOG_RPI_AVAILABLE
// Wenn keine sinnvolle Log-Option mehr uebrig, loggen wir auch nicht
#undef LOG_AVAILABLE
#endif
#endif // LOG_AVAILABLE
#ifdef SRF10_AVAILABLE
#define TWI_AVAILABLE /**< TWI-Schnittstelle (I2C) */
#endif
#ifdef CMPS03_AVAILABLE
#define I2C_AVAILABLE /**< I2C-Treiber */
#endif
#ifdef SP03_AVAILABLE
#define I2C_AVAILABLE /**< I2C-Treiber */
#endif
#ifdef TWI_AVAILABLE
#define I2C_AVAILABLE /**< I2C-Treiber statt TWI-Implementierung benutzen */
#endif
#if defined CREATE_TRACEFILE_AVAILABLE && ! defined OS_AVAILABLE
#define OS_AVAILABLE
#endif
#endif // CT_BOT_H_