paparazzi · gautierhattenberger · Apr 24, 2012 · Apr 24, 2012
diff --git a/conf/modules/AOA_adc.xml b/conf/modules/AOA_adc.xml
@@ -5,6 +5,10 @@
      -->
 
 <module name="AOA_adc" dir="sensors">
+  <doc>
+    <description>Angle of Attack using internal ADC</description>
+    <configure name="ADC_AOA" value="ADCX" description="select the ADC channel to use"/>
+  </doc>
 
   <header>
     <file name="AOA_adc.h"/>

diff --git a/conf/modules/MPPT.xml b/conf/modules/MPPT.xml
@@ -1,6 +1,12 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
 <module name="MPPT">
+  <doc>
+    <description>
+      Maximum Power Point Tracker
+      Solar Cells control board by Michel
+    </description>
+  </doc>
   <header>
     <file name="MPPT.h"/>
   </header>

diff --git a/conf/modules/adc_generic.xml b/conf/modules/adc_generic.xml
@@ -7,6 +7,11 @@
      -->
 
 <module name="adc_generic" dir="adcs">
+  <doc>
+    <description>Generic ADC</description>
+    <configure name="ADC_CHANNEL_GENERIC1" value="ADCX" description="choose which ADC is used for input 1"/>
+    <configure name="ADC_CHANNEL_GENERIC2" value="ADCX" description="choose which ADC is used for input 2"/>
+  </doc>
   <header>
     <file name="adc_generic.h"/>
   </header>

diff --git a/conf/modules/airborne_ant_track.xml b/conf/modules/airborne_ant_track.xml
@@ -1,6 +1,9 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
 <module name="airborne_ant_track" dir="airborne_ant_track">
+  <doc>
+    <description>Airborne Antenna tracker</description>
+  </doc>
   <header>
     <file name="airborne_ant_track.h"/>
   </header>

diff --git a/conf/modules/airspeed_adc.xml b/conf/modules/airspeed_adc.xml
@@ -8,6 +8,13 @@
      -->
 
 <module name="airspeed_adc" dir="sensors">
+  <doc>
+    <description>Airspeed sensor using internal ADC</description>
+    <configure name="ADC_AIRSPEED" value="ADCX" description="ADC on which sensor is connected"/>
+    <define name="AIRSPEED_SCALE" value="scale factor" description="linear scale factor (used if AIRSPEED_QUADRATIC_SCALE is not defined"/>
+    <define name="AIRSPEED_QUADRATIC_SCALE" value="quadratic scale factor" description="it is recommended to use quadratic scale"/>
+    <define name="AIRSPEED_BIAS" value="sensor bias"/>
+  </doc>
 
   <header>
     <file name="airspeed_adc.h"/>

diff --git a/conf/modules/airspeed_ads1114.xml b/conf/modules/airspeed_ads1114.xml
@@ -2,6 +2,9 @@
 <!-- Module to extend the baro_board module with an airspeed sensor using ads1114 adc -->
 
 <module name="airspeed_ads1114" dir="sensors">
+  <doc>
+    <description>Module to extend the baro_board module with an airspeed sensor using ads1114 adc</description>
+  </doc>
   <depend require="baro_board.xml"/>
   <header>
     <file name="airspeed_ads1114.h"/>

diff --git a/conf/modules/airspeed_amsys.xml b/conf/modules/airspeed_amsys.xml
@@ -10,6 +10,14 @@ Airspeed AMSYS module (I2C)
 -->
 
 <module name="airspeed_amsys" dir="sensors">
+  <doc>
+    <description>Airspeed AMSYS module (I2C)</description>
+    <define name="AIRSPEED_AMSYS_I2C_DEV" value="i2cX" description="change default i2c peripheral"/>
+    <define name="AIRSPEED_AMSYS_OFFSET" value="sensor offset"/>
+    <define name="AIRSPEED_AMSYS_SCALE" value="sensor scale factor"/>
+    <define name="USE_AIRSPEED" description="flag to use the data for airspeed control"/>
+    <define name="SENSOR_SYNC_SEND" description="flag to transmit the data as it is acquired"/>
+  </doc>
 
   <header>
     <file name="airspeed_amsys.h"/>

diff --git a/conf/modules/airspeed_ets.xml b/conf/modules/airspeed_ets.xml
@@ -10,6 +10,14 @@
      -->
 
 <module name="airspeed_ets" dir="sensors">
+  <doc>
+    <description>Airspeed ETS module (I2C)</description>
+    <define name="AIRSPEED_ETS_I2C_DEV" value="i2cX" description="change default i2c peripheral"/>
+    <define name="AIRSPEED_ETS_OFFSET" value="sensor offset"/>
+    <define name="AIRSPEED_ETS_SCALE" value="sensor scale factor"/>
+    <define name="USE_AIRSPEED" description="flag to use the data for airspeed control"/>
+    <define name="SENSOR_SYNC_SEND" description="flag to transmit the data as it is acquired"/>
+  </doc>
 
   <header>
     <file name="airspeed_ets.h"/>

diff --git a/conf/modules/alt_filter.xml b/conf/modules/alt_filter.xml
@@ -1,6 +1,9 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
 <module name="alt_filter" dir="ins">
+  <doc>
+    <description>Altitude filter (not used for A/C estimation and control, only debug)</description>
+  </doc>
   <header>
     <file name="alt_filter.h"/>
   </header>

diff --git a/conf/modules/alt_srf08.xml b/conf/modules/alt_srf08.xml
@@ -1,6 +1,9 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
 <module name="alt_srf08" dir="sensors">
+  <doc>
+    <description>Range meter based on srf08 ultrasonic sensor</description>
+  </doc>
   <header>
     <file name="alt_srf08.h"/>
   </header>

diff --git a/conf/modules/baro_MS5534A.xml b/conf/modules/baro_MS5534A.xml
@@ -1,6 +1,9 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
 <module name="baro_MS5534A" dir="sensors">
+  <doc>
+    <description>MS5611 barometer (SPI)</description>
+  </doc>
   <header>
     <file name="baro_MS5534A.h"/>
   </header>

diff --git a/conf/modules/baro_amsys.xml b/conf/modules/baro_amsys.xml
@@ -6,6 +6,10 @@
      -->
 
 <module name="baro_amsys" dir="sensors">
+  <doc>
+    <description>Baro ETS module (I2C)</description>
+    <define name="BARO_ETS_I2C_DEV" value="i2cX" description="select which i2c peripheral to use (default i2c0)"/>
+  </doc>
 
   <header>
     <file name="baro_amsys.h"/>

diff --git a/conf/modules/baro_bmp.xml b/conf/modules/baro_bmp.xml
@@ -7,6 +7,11 @@
      -->
 
 <module name="baro_bmp" dir="sensors">
+  <doc>
+    <description>Bosch BMP085 pressure sensor</description>
+    <define name="BMP_I2C_DEV" value="i2cX" description="select which i2c peripheral to use (default i2c0)"/>
+    <define name="SENSOR_SYNC_SEND" description="flag to transmit the data as it is acquired"/>
+  </doc>
   <header>
     <file name="baro_bmp.h"/>
   </header>

diff --git a/conf/modules/baro_board.xml b/conf/modules/baro_board.xml
@@ -1,6 +1,9 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
 <module name="baro_board" dir="sensors">
+  <doc>
+    <description>Temporary hack to use baro interface on fixedwing</description>
+  </doc>
   <header>
     <file name="baro_board_module.h"/>
   </header>

diff --git a/conf/modules/baro_ets.xml b/conf/modules/baro_ets.xml
@@ -6,6 +6,10 @@
      -->
 
 <module name="baro_ets" dir="sensors">
+  <doc>
+    <description>Baro ETS module (I2C)</description>
+    <define name="BARO_ETS_I2C_DEV" value="i2cX" description="select i2c peripheral to use (default i2c0)"/>
+  </doc>
 
   <header>
     <file name="baro_ets.h"/>

diff --git a/conf/modules/baro_ms5611_i2c.xml b/conf/modules/baro_ms5611_i2c.xml
@@ -6,6 +6,10 @@
      -->
 
 <module name="baro_ms5611_i2c" dir="sensors">
+  <doc>
+    <description>Measurement Specialties MS5611-01BA pressure sensor (I2C)</description>
+    <define name="MS5611_I2C_DEV" value="i2cX" description="select i2c peripheral to use (default i2c0)"/>
+  </doc>
   <header>
     <file name="baro_ms5611_i2c.h"/>
   </header>

diff --git a/conf/modules/baro_scp.xml b/conf/modules/baro_scp.xml
@@ -6,6 +6,10 @@
      -->
 
 <module name="baro_scp" dir="sensors">
+  <doc>
+    <description>VTI SCP1000 pressure sensor (SPI)</description>
+    <define name="SENSOR_SYNC_SEND" description="flag to transmit the data as it is acquired"/>
+  </doc>
   <header>
     <file name="baro_scp.h"/>
   </header>

diff --git a/conf/modules/baro_scp_i2c.xml b/conf/modules/baro_scp_i2c.xml
@@ -7,6 +7,11 @@
      -->
 
 <module name="baro_scp_i2c" dir="sensors">
+  <doc>
+    <description>VTI SCP1000 pressure sensor (I2C)</description>
+    <define name="SCP_I2C_DEV" value="i2cX" description="select i2c peripheral to use (default i2c0)"/>
+    <define name="SENSOR_SYNC_SEND" description="flag to transmit the data as it is acquired"/>
+  </doc>
   <header>
     <file name="baro_scp_i2c.h"/>
   </header>

diff --git a/conf/modules/bat_checker.xml b/conf/modules/bat_checker.xml
@@ -8,6 +8,11 @@
      @define BAT_CHECKER_LED   The LED to use for the warning signal.
      -->
 <module name="bat_checker">
+  <doc>
+    <description>Battery checker module</description>
+    <define name="BAT_CHECKER_DELAY" value="delay" description="number of seconds the battery voltage has to below LOW_BAT_LEVEL before warning signal is activated"/>
+    <define name="BAT_CHECKER_LED" value="X" description="led number to use for the warning signal"/>
+  </doc>
   <header>
     <file name="bat_checker.h"/>
   </header>

diff --git a/conf/modules/booz_cam.xml b/conf/modules/booz_cam.xml
@@ -1,6 +1,9 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
 <module name="booz_cam" dir="cam_control">
+  <doc>
+    <description>Camera control for BOOZ board</description>
+  </doc>
   <!-- depend require="booz_pwm|led" -->
   <header>
     <file name="booz_cam.h"/>

diff --git a/conf/modules/booz_drop.xml b/conf/modules/booz_drop.xml
@@ -5,6 +5,11 @@
      -->
 
 <module name="drop">
+  <doc>
+    <description>Drop control for BOOZ board</description>
+    <define name="DROP_SERVO_OPEN" value="pwm" description="PWM value when servo is in open position in us (optional)"/>
+    <define name="DROP_SERVO_CLOSED" value="pwm" description="PWM value when servo is in closed position in us (optional)"/>
+  </doc>
   <!-- depend require="booz_pwm" -->
   <header>
     <file name="booz_drop.h"/>

diff --git a/conf/modules/booz_extra_dl.xml b/conf/modules/booz_extra_dl.xml
@@ -1,6 +1,9 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
 <module name="core">
+  <doc>
+    <description>Extra datalink channel (PPRZ transport)</description>
+  </doc>
   <header>
     <file name="extra_pprz_dl.h"/>
   </header>

diff --git a/conf/modules/booz_pwm.xml b/conf/modules/booz_pwm.xml
@@ -7,6 +7,10 @@
    -->
 
 <module name="booz_pwm" dir="core">
+  <doc>
+    <description>Allow to use PWM output on booz boards, PWM0 is activated by default (PWM5 on lpc21 output)</description>
+    <define name="USE_PWM1" description="flag to activate with USE_PWM1 flag (PWM2 on lpc21 output)"/>
+  </doc>
   <header>
     <file name="booz_pwm_arch.h"/>
   </header>

diff --git a/conf/modules/cam_point.xml b/conf/modules/cam_point.xml
@@ -1,6 +1,9 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
 <module name="cam_point" dir="cam_control">
+  <doc>
+    <description>Camera control for fixedwing</description>
+  </doc>
   <header>
     <file name="cam.h"/>
     <file name="point.h"/>

diff --git a/conf/modules/cam_roll.xml b/conf/modules/cam_roll.xml
@@ -1,6 +1,9 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
 <module name="cam_roll" dir="cam_control">
+  <doc>
+    <description>Camera control on roll axis only</description>
+  </doc>
   <header>
     <file name="cam.h"/>
   </header>

diff --git a/conf/modules/cam_segment.xml b/conf/modules/cam_segment.xml
@@ -1,6 +1,9 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
 <module name="cam_segment" dir="cam_control">
+  <doc>
+    <description>Camera control to point a segment</description>
+  </doc>
   <!--depend require="cam_point.xml"/-->
   <header>
     <file name="cam_segment.h"/>

diff --git a/conf/modules/cartography.xml b/conf/modules/cartography.xml
@@ -1,6 +1,9 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
 <module name="cartography">
+  <doc>
+    <description>Cartography sweeping pattern for navigation</description>
+  </doc>
   <header>
     <file name="cartography.h"/>
   </header>

diff --git a/conf/modules/charge_sens.xml b/conf/modules/charge_sens.xml
@@ -1,6 +1,9 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
 <module name="charge_sens" dir="meteo">
+  <doc>
+    <description></description>
+  </doc>
   <header>
     <file name="charge_sens.h"/>
   </header>

diff --git a/conf/modules/demo_module.xml b/conf/modules/demo_module.xml
@@ -1,6 +1,9 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
 <module name="demo_module">
+  <doc>
+    <description>Demo module</description>
+  </doc>
   <header>
     <file name="demo_module.h"/>
   </header>

diff --git a/conf/modules/deploy_sonar_buoy.xml b/conf/modules/deploy_sonar_buoy.xml
@@ -1,6 +1,9 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
 <module name="deploy_sonar_buoy">
+  <doc>
+    <description></description>
+  </doc>
   <header>
     <file name="deploy_sonar_buoy.h"/>
   </header>

diff --git a/conf/modules/digital_cam.xml b/conf/modules/digital_cam.xml
@@ -20,6 +20,10 @@
 -->
 
 <module name="digital_cam">
+  <doc>
+    <description>Digital camera control (trigger using led)</description>
+  </doc>
+
   <header>
     <file name="led_cam_ctrl.h"/>
   </header>

diff --git a/conf/modules/digital_cam_i2c.xml b/conf/modules/digital_cam_i2c.xml
@@ -1,6 +1,10 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
 <module name="atmega_i2c_cam_ctrl" dir="digital_cam">
+  <doc>
+    <description></description>
+  </doc>
+
   <header>
     <file name="atmega_i2c_cam_ctrl.h"/>
   </header>

diff --git a/conf/modules/digital_cam_servo.xml b/conf/modules/digital_cam_servo.xml
@@ -20,6 +20,9 @@
 -->
 
 <module name="digital_cam_servo" dir="digital_cam">
+  <doc>
+    <description>Digital camera control (trigger using servo)</description>
+  </doc>
 
   <header>
     <file name="servo_cam_ctrl.h"/>

diff --git a/conf/modules/dust_gp2y.xml b/conf/modules/dust_gp2y.xml
@@ -1,6 +1,9 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
 <module name="dust_gp2y" dir="meteo">
+  <doc>
+    <description></description>
+  </doc>
   <header>
     <file name="dust_gp2y.h"/>
   </header>

diff --git a/conf/modules/enose.xml b/conf/modules/enose.xml
@@ -1,6 +1,9 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
 <module name="enose" dir="enose">
+  <doc>
+    <description>Chemical Enose sensor</description>
+  </doc>
   <header>
     <file name="enose.h"/>
     <file name="chemo_detect.h"/>

diff --git a/conf/modules/extra_dl.xml b/conf/modules/extra_dl.xml
@@ -1,6 +1,9 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
 <module name="extra_dl" dir="datalink">
+  <doc>
+    <description>Extra datalink (PPRZ transport)</description>
+  </doc>
   <header>
     <file name="extra_pprz_dl.h"/>
   </header>