strat db
[aversive.git] / config / Configure.help
1 #
2 # Format of this file: description<nl>variable<nl>  helptext<nl>...<nl><nl>.
3 # If the question being documented is of type "choice", we list
4 # only the first occurring config variable. The help texts
5 # must not contain empty lines. No variable should occur twice; if it
6 # does, only the first occurrence will be used by Configure. The lines
7 # in a help text should be indented two positions. Lines starting with
8 # `#' are ignored. To be nice to menuconfig, limit your lines to 70
9 # characters. Use emacs' kfill.el to edit this file or you lose.
10 #
11
12 CONFIG_MCU_ATMEGA128
13   Choose your target device.
14
15 CONFIG_QUARTZ
16   Choose the speed of your target device. This frequency is specified in
17   Hertz.
18
19 CONFIG_OPTM_0
20   Choose this option to customize code optimization (see
21   the gcc manual for details). The -Os option is recommanded
22   for most purposes.
23
24 CONFIG_MATH_LIB
25   Include math lib in the linker flags.
26
27 CONFIG_MINIMAL_PRINTF
28   Choose printf style. The minimal printf cannot handle floats. The advanced 
29   printf can, but it requires the math lib. Disable it if you don't use
30   printf, you'll win some prog space.
31
32 CONFIG_FORMAT_IHEX
33   Set the default format of generated executable. The Intel HEX
34   format is the default choice, as it is a simple format, supported 
35   by avrdude. You can also choose raw binary or S-records (see 
36   avr-objcopy manual for details).
37
38
39
40 CONFIG_MODULE_CIRBUF
41   This module provides a circular buffer implementation (fifo or lifo).
42
43 CONFIG_MODULE_FIXED_POINT
44   This module provides functions for using fixed point variables. Using
45   this type can be faster and/or more accurate than using float in some 
46   cases (for example if you mainly do sums). It requires the math lib.
47
48
49 CONFIG_MODULE_VECT2
50   This module provides functions for converting 2D vectors from 
51   polar to cartesian and vice versa.
52
53 CONFIG_MODULE_HOSTSIM
54   AVR simulator. This code is used on host (PC for instance) to
55   generate a signal that will call other aversive modules like
56   scheduler or uart. The goal is to simulate the behaviour of
57   hardware interrupts in a unix application. This has no effect
58   when compiling for AVR.
59
60
61 CONFIG_MODULE_SCHEDULER
62   The 'scheduler' module is NOT a scheduler in the same way than in
63   a multitask kernel. This module allow to schedule functions in the
64   future (only a call, or periodical call). If CONFIG_MODULE_SCHEDULER_USE_TIMERS
65   option is not enabled, the functions are called from TIMER0 interrupt, 
66   else you can choose which timer to use. This module is able to handle 
67   priority between events.
68
69 CONFIG_MODULE_SCHEDULER_CREATE_CONFIG
70   Create a scheduler_config.h file if it does not exist, with a default
71   configuration.
72
73 CONFIG_MODULE_SCHEDULER_TIMER0
74   Use either the hardware/timer module, the timer0 or a manual call 
75   for the to call the scheduler. The generic timer module support 
76   many archs and timers. If you don't enable it, you must use TIMER0 
77   overflow interrupt, and only some AVR are supported, or you should
78   can call the scheduler manually. In this case, the SCHEDULER_UNIT 
79   macro has to be defined in configuration file.
80
81
82 CONFIG_TIME
83   This module can be used to get a human readable time. It uses the
84   scheduler module. Its goal is not to be very precise, but just
85   simple to use.  provides two timers: one in s and us, and one in
86   us which doesn't overflow on seconds (better to substract two
87   times)
88
89 CONFIG_MODULE_TIME_CREATE_CONFIG
90   Create a time_config.h file if it does not exist, with a default
91   configuration.
92
93
94 CONFIG_TIME_EXT
95   This module can be used to have a very precise, yet human-readable,
96   time. It uses TIMER2 in asynchronous mode, you MUST have a 32.768kHz
97   quartz connected to TOSC1 and TOSC2 pins.
98   Provides a global time value (instant 0 is the initialization of the
99   module). Warning: this module uses some hardcoded values for
100   timer 2 configuration, it may not work on all AVR.
101
102 CONFIG_MODULE_TIME_EXT_CREATE_CONFIG
103   Create a time_ext_config.h file if it does not exist, with a default
104   configuration.
105
106 CONFIG_MODULE_UART
107   This module provide functions to use the embedded UART or USART in
108   the AVR. With this module, it is more easy to configure it, and
109   data can be emited on interruption. The uart module also contains
110   a fifo for emission and reception (configurable in uart_config.h).
111
112 CONFIG_MODULE_UART_CREATE_CONFIG
113   Create a uart_config.h file if it does not exist, with a default
114   configuration.
115
116 CONFIG_MODULE_SPI
117   This module provide functions to use the embedded SPI in
118   the AVR.
119
120 CONFIG_MODULE_SPI_CREATE_CONFIG
121   Create a spi_config.h file if it does not exist, with a default
122   configuration.
123
124 CONFIG_MODULE_I2C
125   This module provide functions to use the embedded I2C (TWI
126   interface) in the AVR.
127
128 CONFIG_MODULE_I2C_CREATE_CONFIG
129   Create a i2c_config.h file if it does not exist, with a default
130   configuration.
131
132 CONFIG_MODULE_MF2_CLIENT
133   This module provide functions to interface with a device that uses
134   the mf2 protocol. With the client, you can interface with a PS/2 keyboard.
135
136 CONFIG_MODULE_MF2_CLIENT_USE_SCHEDULER
137   Enabling this option avoid active loops and enable mf2 watchdog. 
138   The watchdog avoid desynchronisation if there is transmission
139   problems or if keyboard is unplugged during operation.
140
141 CONFIG_MODULE_MF2_CLIENT_CREATE_CONFIG
142   Create a mf2_client_config.h file if it does not exist, with a default
143   configuration.
144
145 CONFIG_MODULE_MF2_SERVER
146   This module provide functions to interface with a device that uses
147   the mf2 protocol. With the server, you can emulate a PS/2 keyboard.
148
149 CONFIG_MODULE_MF2_SERVER_CREATE_CONFIG
150   Create a mf2_server_config.h file if it does not exist, with a default
151   configuration.
152
153
154 CONFIG_MODULE_TIMER
155   This module provide some simple functions to use some timers 
156   functionnalities of AVR.
157
158 CONFIG_MODULE_TIMER_CREATE_CONFIG
159   Create a timer_config.h file if it does not exist, with a default
160   configuration.
161
162 CONFIG_MODULE_PWM
163   This module provide a driver to use the PWM (Pulse Width Modulation) 
164   hardware of the AVR : the configuration can be statically or dynamically
165   defined. This module can be replaced by PWM_NG.
166
167 CONFIG_MODULE_PWM_CREATE_CONFIG
168   Create a pwm_config.h file if it does not exist, with a default
169   configuration.
170
171 CONFIG_MODULE_PWM_NG
172   This module provide a driver to use the PWM (Pulse Width Modulation) 
173   hardware of the AVR : the configuration is set dynamically.
174
175
176
177 CONFIG_MODULE_BRUSHLESS_3PHASE_DIGITAL_HALL
178   This module drives a 3-phase synchronous motor (called brushless)
179   This is done with 3 hall sensors who give the position of the rotor.
180   The controller polls these sensors, and updates 3 PWM outputs to drive
181   the 3 phases.
182
183 CONFIG_MODULE_BRUSHLESS_3PHASE_DIGITAL_HALL_DOUBLE
184   This is a double implementation of the MODULE_BRUSHLESS_3PHASE_DIGITAL_HALL
185   This module drives two 3-phase synchronous motor (called brushless)
186   This is done with 3 hall sensors who give the position of the rotor.
187   The controller polls these sensors, and updates 3 PWM outputs to drive
188   the 3 phases of each motor
189
190 CONFIG_MODULE_CC2420
191   This modules implements the protocol to use a CC2420 radio chip.
192   This radio chip is IEEE 802.15.4 compliant and is widely used
193   in wireless sensors.
194   This modules requires SPI to be activated.
195
196 CONFIG_MODULE_MENU
197   The menu module provides some helpers to create a human-machine
198   interface that uses a tree-organized static menu.
199
200 CONFIG_MODULE_VT100
201   This module provides functions to parse vt100 commands.
202
203 CONFIG_MODULE_RDLINE
204   The rdline module provides an interface for editing a buffer on a
205   vt100 terminal, for instance through a UART.
206
207 CONFIG_MODULE_RDLINE_CREATE_CONFIG
208   Create a rdline_config.h file if it does not exist, with a default
209   configuration.
210
211 CONFIG_MODULE_RDLINE_KILL_BUF
212   Enable cut/paste (with CTRL-k and CTRL-y)
213
214 CONFIG_MODULE_RDLINE_HISTORY
215   Enable history buffer, to save last commands (up and down arrows)
216
217 CONFIG_MODULE_PARSE
218   The parse module is able to parse a buffer containing strings, 
219   numbers, (...) into a C structure.
220
221
222 CONFIG_MODULE_LCD
223   This module provide an interface to control an external standard
224   LCD screen (text mode).
225
226 CONFIG_MODULE_LCD_CREATE_CONFIG
227   Create a lcd_config.h file if it does not exist, with a default
228   configuration.
229
230
231 CONFIG_MODULE_MULTISERVO
232   This module provide an interface to command many servo (like in model
233   toys). It uses one timer (a 8 bits or a 16 bits, depending on accuracy
234   you want). As it does not uses the PWM mode of timer, it can consum
235   some CPU time in interrupt, but you can command up to 10 servos
236   and the output ports can be on a non-specialized port.
237
238 CONFIG_MODULE_MULTISERVO_CREATE_CONFIG
239   Create a servo_config.h file if it does not exist, with a default
240   configuration.
241
242
243 CONFIG_MODULE_ENCODERS_MICROB
244   Provide an interface for reading values from encoders. The electric
245   scheme is provided in the file encoders_microb.h
246
247 CONFIG_MODULE_ENCODERS_SPI
248   Provide an interface for reading values from encoders. This module
249   uses the SPI interface to update values.
250
251 CONFIG_MODULE_ENCODERS_EIRBOT
252   Provide an interface for reading values from encoders. The electric
253   scheme should be provided in the file encoders_eirbot.h
254
255 CONFIG_MODULE_ROBOT_SYSTEM
256   The Robot System module role is to provide a virtual system that
257   represents a robot by its angle/distance instead of left/right 
258   wheels. It provides a virtual angle/distance PWM and a virtual
259   angle/distance encoder.
260
261 CONFIG_MODULE_ROBOT_SYSTEM_MOT_AND_EXT
262   If the robot has external and motor encoder, you can use both 
263   by defining this option.
264
265 CONFIG_MODULE_POSITION_MANAGER
266   This module processes the position of the robot, depending of the 
267   value returned by the associated robot system, and some physical
268   parameters of the robot.
269
270 CONFIG_MODULE_TRAJECTORY_MANAGER
271   Manage the control systems of the robot, depending on the position,
272   the physical parameters of the robot, and the user consign. Command
273   can be something like trajectory_goto_xya(...)
274
275 CONFIG_MODULE_BLOCKING_DETECTION_MANAGER
276   Detect when the robot is blocked on an obstacle.
277
278 CONFIG_MODULE_OBSTACLE_AVOIDANCE
279   Determine a optimized path from a point to antoher, avioding
280   obstacles.
281
282
283 CONTROL_SYSTEM_MANAGER
284   A module that manages a servo control system. It uses filters, like
285   the PID filter to work. This module also needs a the in/out functions
286   of the controled system, for instance encoders and PWM, but it can
287   any other func that has the same interface.
288
289 CONFIG_MODULE_PID
290   This filter provides a PID (proportionnal, integral, derivate).
291
292 CONFIG_MODULE_PID_CREATE_CONFIG
293   Create a pid_config.h file if it does not exist, with a default
294   configuration.
295
296 CONFIG_MODULE_RAMP
297   This module limits the variation of the input of the filter. It can
298   be used in a speed control system as a consign filter to set a 
299   maximum acceleration.
300
301 CONFIG_MODULE_QUADRAMP
302   This module limits the variation of the input, and the variation 
303   of the derivate of the input. It can be used in a position control 
304   system as a consign filter to specify a maximum acceleration and a 
305   maximum speed.
306
307 CONFIG_MODULE_QUADRAMP_DERIVATE
308   This module generates the same kind of ramp than the quadramp.
309   however here we generate the derivate of this ramp, which is a speed
310   consign which can be fed to a speed PID.
311   The advantages are less computation (no square root), and a better
312   robustness against blocking.
313
314 CONFIG_MODULE_BIQUAD
315   This module is a general digital filter. It is very useful for all
316   filtering purposes, not only for control loops. You can implement
317   every digital filter with this module ! Sometimes you will have to
318   put a few in series.
319
320 CONFIG_MODULE_AES
321   Enable AES crypto functions in Aversive
322
323 CONFIG_MODULE_AES_CTR
324   Enable AES counter mode
325
326 CONFIG_MODULE_MD5
327   Enable MD5 alg functions in Aversive
328
329 CONFIG_MODULE_MD5_HMAC
330   Enable md5 HMAC functions in Aversive
331
332 CONFIG_MODULE_RC4
333   Enable RC4 alg functions in Aversive
334
335
336 CONFIG_MODULE_BASE64
337   Enable base64 encoding module, compatible with PEM.
338
339 CONFIG_MODULE_HAMMING
340   Enable Hamming encoding module, which is an error detection
341   coding system.
342
343
344 CONFIG_MODULE_DIAGNOSTIC
345   this module contains tools to view the stack space or the processor
346   charge (interrupts)
347
348 CONFIG_MODULE_ERROR
349   this module helps storing and handling errors, warnings and so on...
350
351 CONFIG_AVRDUDE_PROG_FUTURELEC
352   Choose the hardware programmer type. Please see the avrdude manual
353   for details.
354
355 CONFIG_AVRDUDE_PORT
356   Choose the avrdude device. Under linux, it can be '/dev/parport0' or 
357   '/dev/ttyS0', depending on the programmer type. Under win32, it can
358   look like 'com1' for instance.
359
360 CONFIG_AVRDUDE_BAUDRATE
361   Choose the baudrate. This can be very useful if you are using a stk500
362   bootloader, and you want to speed it up.
363
364 CONFIG_AVRDUDE_CHECK_SIGNATURE
365   Avrdude normally checks the device signature, but some bootloaders doesn't
366   implement this, or your device may not communicate with Avrdude. This option
367   allows you to bypass this check.
368
369 CONFIG_AVRDUDE_FUSE
370   If you enable this option, a script will be launched just after this
371   saving the configuration. This script uses avrdude to program the
372   fuse value of your target device. NOT IMPLEMENTED YET.