[doc] some module description cleanups

This commit is contained in:
Felix Ruess
2012-12-29 23:12:24 +01:00
parent d0659d1df7
commit e04623c872
49 changed files with 133 additions and 172 deletions
-4
View File
@@ -1,9 +1,5 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!--
Angle of Attack ADC module
-->
<module name="AOA_adc" dir="sensors">
<doc>
<description>Angle of Attack using internal ADC</description>
-6
View File
@@ -1,11 +1,5 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!--
Generic ADC module
@configure ADC_CHANNEL_GENERIC1 on which ADC input 1 is measured
@configure ADC_CHANNEL_GENERIC2 on which ADC input 2 is measured
-->
<module name="adc_generic" dir="adcs">
<doc>
<description>Generic ADC</description>
+2 -9
View File
@@ -1,19 +1,12 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!--
Airspeed ADC module
@configure ADC_AIRSPEED on which ADC the sensor is connected
@define AIRSPEED_SCALE/AIRSPEED_QUADRATIC_SCALE scale factor, quadratic is used if defined
@define AIRSPEED_BIAS offset on ADC
-->
<module name="airspeed_adc" dir="sensors">
<doc>
<description>Airspeed sensor using internal ADC</description>
<description>Airspeed sensor (ADC). Using the 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"/>
<define name="AIRSPEED_BIAS" value="sensor bias" description="offset on ADC"/>
</doc>
<header>
+4 -2
View File
@@ -1,9 +1,11 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!-- 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>
<description>
ADS1114 airspeed sensor.
Module to extend the baro_board module with an airspeed sensor using ads1114 adc
</description>
</doc>
<depend require="baro_board.xml"/>
<header>
+8 -13
View File
@@ -1,20 +1,15 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!--
Airspeed AMSYS module (I2C)
@param AIRSPEED_AMSYS_SCALE scale factor (default 1.8)
@param AIRSPEED_AMSYS_OFFSET offset (default 0)
@param AIRSPEED_AMSYS_I2C_DEV i2c device (default i2c0)
@flag USE_AIRSPEED to use the data for airspeed control loop
@flag SENSOR_SYNC_SEND to transmit the data as it is acquired
-->
<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"/>
<description>
Airspeed AMSYS (I2C)
Driver for a Amsys Differential Presure Sensor I2C
(AMS 5812-0003-D)
</description>
<define name="AIRSPEED_AMSYS_I2C_DEV" value="i2c0" description="change default i2c peripheral"/>
<define name="AIRSPEED_AMSYS_OFFSET" value="0" description="sensor offset (default: 0)"/>
<define name="AIRSPEED_AMSYS_SCALE" value="1.0" description="sensor scale factor (default: 1.0)"/>
<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>
+18 -13
View File
@@ -1,20 +1,25 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!--
Airspeed ETS module (I2C)
@define AIRSPEED_ETS_SCALE scale factor (default 1.8)
@define AIRSPEED_ETS_OFFSET offset (default 0)
@define AIRSPEED_ETS_I2C_DEV i2c device (default i2c0)
@define USE_AIRSPEED to use the data for airspeed control loop
@define SENSOR_SYNC_SEND to transmit the data as it is acquired
-->
<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"/>
<description>
Airspeed ETS (I2C).
Driver for the EagleTree Systems Airspeed Sensor.
Has only been tested with V3 of the sensor hardware.
Notes:
Connect directly to TWOG/Tiny I2C port. Multiple sensors can be chained together.
Sensor should be in the proprietary mode (default) and not in 3rd party mode.
Sensor module wire assignments:
- Red wire: 5V
- White wire: Ground
- Yellow wire: SDA
- Brown wire: SCL
</description>
<define name="AIRSPEED_ETS_I2C_DEV" value="i2c0" description="change default i2c peripheral"/>
<define name="AIRSPEED_ETS_OFFSET" value="0" description="sensor offset (default: 0)"/>
<define name="AIRSPEED_ETS_SCALE" value="1.8" description="sensor scale factor (default: 1.8)"/>
<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>
+4 -1
View File
@@ -2,7 +2,10 @@
<module name="alt_filter" dir="ins">
<doc>
<description>Altitude filter (not used for A/C estimation and control, only debug)</description>
<description>
Altitude filter
(not used for A/C estimation and control, only debug)
</description>
</doc>
<header>
<file name="alt_filter.h"/>
+1 -1
View File
@@ -2,7 +2,7 @@
<module name="alt_srf08" dir="sensors">
<doc>
<description>Range meter based on srf08 ultrasonic sensor</description>
<description>SRF08 ultrasonic range meter</description>
</doc>
<header>
<file name="alt_srf08.h"/>
+1 -6
View File
@@ -1,13 +1,8 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!--
Baro ETS module (I2C)
@param BARO_ETS_I2C_DEV i2c device (default i2c0)
-->
<module name="baro_amsys" dir="sensors">
<doc>
<description>Baro ETS module (I2C)</description>
<description>Baro ETS (I2C)</description>
<define name="BARO_ETS_I2C_DEV" value="i2cX" description="select which i2c peripheral to use (default i2c0)"/>
</doc>
-6
View File
@@ -1,11 +1,5 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!--
Bosch BMP085 pressure sensor
@define BMP_I2C_DEV i2c device (default i2c0)
@define SENSOR_SYNC_SEND to transmit the data as it is acquired
-->
<module name="baro_bmp" dir="sensors">
<doc>
<description>Bosch BMP085 pressure sensor</description>
+4 -1
View File
@@ -2,7 +2,10 @@
<module name="baro_board" dir="sensors">
<doc>
<description>Allow to use baro interface on fixedwing with external barometers</description>
<description>
Baro board wrapper.
Allows to use baro interface on fixedwing with external barometers.
</description>
</doc>
<header>
<file name="baro_board_module.h"/>
+1 -6
View File
@@ -1,13 +1,8 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!--
Baro ETS module (I2C)
@define BARO_ETS_I2C_DEV i2c device (default i2c0)
-->
<module name="baro_ets" dir="sensors">
<doc>
<description>Baro ETS module (I2C)</description>
<description>Baro ETS (I2C)</description>
<define name="BARO_ETS_I2C_DEV" value="i2cX" description="select i2c peripheral to use (default i2c0)"/>
<define name="BARO_ETS_SCALE" value="sensor scale factor"/>
<define name="BARO_ETS_TELEMETRY" description="flag to transmit the data as it is acquired"/>
+1 -1
View File
@@ -2,7 +2,7 @@
<module name="baro_hca" dir="sensors">
<doc>
<description>Baro sensortechnics HCA module (I2C)</description>
<description>Baro sensortechnics HCA (I2C)</description>
<define name="BARO_HCA_I2C_DEV" value="i2cX" description="select which i2c peripheral to use (default i2c0)"/>
</doc>
+1 -1
View File
@@ -2,7 +2,7 @@
<module name="baro_mpl3115" dir="sensors">
<doc>
<description>Baro MPL3115A2 module (I2C)</description>
<description>Baro MPL3115A2 (I2C)</description>
<define name="MPL3115_I2C_DEV" value="i2cX" description="select which i2c peripheral to use (default i2c0)"/>
</doc>
+4 -6
View File
@@ -1,13 +1,11 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!--
Measurement Specialties MS5611-01BA pressure sensor (I2C)
@param MS5611_I2C_DEV i2c device (default i2c0)
-->
<module name="baro_ms5611_i2c" dir="sensors">
<doc>
<description>Measurement Specialties MS5611-01BA pressure sensor (I2C)</description>
<description>
Baro MS5611 (I2C)
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>
-5
View File
@@ -1,10 +1,5 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!--
VTI SCP1000 pressure sensor (SPI)
@define SENSOR_SYNC_SEND to transmit the data as it is acquired
-->
<module name="baro_scp" dir="sensors">
<doc>
<description>VTI SCP1000 pressure sensor (SPI)</description>
-6
View File
@@ -1,11 +1,5 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!--
VTI SCP1000 pressure sensor (I2C)
@define SCP_I2C_DEV i2c device (default i2c0)
@define SENSOR_SYNC_SEND to transmit the data as it is acquired
-->
<module name="baro_scp_i2c" dir="sensors">
<doc>
<description>VTI SCP1000 pressure sensor (I2C)</description>
-7
View File
@@ -1,12 +1,5 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!--
Battery checker module
@define BAT_CHECKER_DELAY Number of seconds the battery voltage has to be
below LOW_BAT_LEVEL before the warning signal is
activated.
@define BAT_CHECKER_LED The LED to use for the warning signal.
-->
<module name="bat_checker">
<doc>
<description>Battery checker module</description>
+4 -1
View File
@@ -2,7 +2,10 @@
<module name="charge_sens" dir="meteo">
<doc>
<description></description>
<description>
Charge sensor.
I2C interface for University of Reading charge sensor
</description>
</doc>
<header>
<file name="charge_sens.h"/>
+4 -1
View File
@@ -2,7 +2,10 @@
<module name="deploy_sonar_buoy">
<doc>
<description></description>
<description>
Toggle two gpio pins (Lisa).
The application in this was written for drops two sonar buoys.
</description>
</doc>
<header>
<file name="deploy_sonar_buoy.h"/>
+4 -1
View File
@@ -2,7 +2,10 @@
<module name="atmega_i2c_cam_ctrl" dir="digital_cam">
<doc>
<description>Trigger Digital Camera Using I2C connected remote microcontroller</description>
<description>
Trigger Digital Camera (I2C).
Using I2C connected remote microcontroller
</description>
<define name="DC_SHOOT_ON_BUTTON_RELEASE" />
<define name="SENSOR_SYNC_SEND" value="1" />
</doc>
+5 -1
View File
@@ -2,7 +2,11 @@
<module name="dust_gp2y" dir="meteo">
<doc>
<description></description>
<description>
Sharp GP2Y1010AU dust sensor.
This reads the values for dust density from the Sharp GP2Y1010AU0F sensor
through I2C (needs I2C ADC at the sensor).
</description>
</doc>
<header>
<file name="dust_gp2y.h"/>
-4
View File
@@ -1,9 +1,5 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!--
EzOSD current sensor module (I2C)
-->
<module name="ezcurrent" dir="sensors">
<doc>
<description>EzOSD Current sensor (I2C).</description>
+4 -1
View File
@@ -2,7 +2,10 @@
<module name="gain_scheduling">
<doc>
<description> Module that interpolates between different gain sets </description>
<description>
Gain set interpolation.
Interpolate between different gain sets for rotorcrafts.
</description>
</doc>
<header>
<file name="gain_scheduling.h"/>
+1 -1
View File
@@ -2,7 +2,7 @@
<module name="geiger_counter" dir="meteo">
<doc>
<description>Geifer counter sensor</description>
<description>Geiger counter sensor</description>
</doc>
<header>
<file name="geiger_counter.h"/>
+4 -6
View File
@@ -1,13 +1,11 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!-- Generic Com Module -->
<!-- Can be redefined :
GENERIC_COM_I2C_DEV (default: i2c0)
GENERIC_COM_SLAVE_ADDR (default: ??)
-->
<module name="generic_com" dir="com">
<doc>
<description>Generic com (can be used for Satcom/GSM)</description>
<description>
Generic com.
Can be used for Satcom/GSM
</description>
<define name="GENERIC_COM_I2C_DEV" value="i2cX" description="select i2c peripheral to use (default i2c0)"/>
<define name="GENERIC_COM_SLAVE_ADDR" value="i2c address"/>
</doc>
+5 -7
View File
@@ -1,13 +1,11 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!-- to be configured with
ap.CFLAGS += -DUSE_GPS -DUBX -DGPS_LINK=gps_i2c -DGPS_LED=2
ap.CFLAGS += -DGPS_CONFIGURE -DGPS_PORT_ID=GPS_PORT_DDC
-->
<module name="gps_i2c">
<doc>
<description>U-blox gps using i2c (broken)</description>
<description>
U-blox GPS (I2C)
(apparently currently broken)
</description>
</doc>
<header>
<file name="gps_i2c.h"/>
@@ -18,7 +16,7 @@ ap.CFLAGS += -DGPS_CONFIGURE -DGPS_PORT_ID=GPS_PORT_DDC
<makefile target="ap">
<file name="gps_i2c.c"/>
<define name="GPS_CONFIGURE" />
<define name="GPS_PORT_ID" value="GPS_PORT_DDC" />
<define name="GPS_PORT_ID" value="GPS_PORT_DDC"/>
</makefile>
</module>
+2
View File
@@ -3,6 +3,8 @@
<module name="gps_ubx" dir="gps">
<doc>
<description>
Ublox GPS autoconfiguration.
Automatically configure any Ublox GPS for paparazzi.
-configures all the messages, and the rates
+4 -1
View File
@@ -2,7 +2,10 @@
<module name="humid_dpicco" dir="meteo">
<doc>
<description></description>
<description>
DigiPicco humidity sensor.
This reads the values for humidity and temperature from the IST DigiPicco sensor through I2C.
</description>
</doc>
<header>
<file name="humid_dpicco.h"/>
+4 -1
View File
@@ -2,7 +2,10 @@
<module name="humid_hih" dir="meteo">
<doc>
<description></description>
<description>
HIH-4030 humidity sensor.
This reads the values for humidity from the Honeywell HIH-4030 sensor via ADC.
</description>
</doc>
<header>
<file name="humid_hih.h"/>
-5
View File
@@ -1,10 +1,5 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!--
TronSens HTM-B71 humidity sensor (I2C)
@param HTM_I2C_DEV i2c device (default i2c0)
-->
<module name="humid_htm_b71" dir="meteo">
<doc>
<description>TronSens HTM-B71 humidity sensor (I2C)</description>
+5 -1
View File
@@ -2,7 +2,11 @@
<module name="humdid_pcap01" dir="meteo">
<doc>
<description></description>
<description>
ACAM Picocap capacitance sensor.
ACAM Picocap Single-chip Solution for Capacitance Measurement
This reads the values for temperature and humidity from the ACAM capacitance and resistance measurement unit through I2C.
</description>
</doc>
<header>
<file name="humid_pcap01.h"/>
+4 -1
View File
@@ -2,7 +2,10 @@
<module name="humid_sht" dir="meteo">
<doc>
<description></description>
<description>
SHTxx humidity sensor.
This reads the values for humidity and temperature from the SHTxx sensor through bit banging.
</description>
</doc>
<header>
<file name="humid_sht.h"/>
-5
View File
@@ -1,10 +1,5 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!--
Sensirion SHT25 humidity sensor (I2C)
@define SCP_I2C_DEV i2c device (default i2c0)
-->
<module name="humid_sht_i2c" dir="meteo">
<doc>
<description>Sensirion SHT25 humidity sensor (I2C)</description>
+1 -4
View File
@@ -1,8 +1,5 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!-- optional flags:
- USE_HIGH_ACCEL_FLAG: will disable accelerometers on high acceleration detection (low speed, high thrust)
- ARDUIMU_SYNC_SEND: downlink imu gyro and accels
-->
<module name="ins_ArduIMU" dir="ins">
<doc>
<description>ArduIMU v2</description>
+1 -3
View File
@@ -1,10 +1,8 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!-- Driver for the EA DOG-M163 LCD (SPI) -->
<module name="lcd_dogm" dir="display">
<doc>
<description>Driver for the EA DOG-M163 LCD (SPI)</description>
<description>EA DOG-M163 LCD (SPI)</description>
</doc>
<header>
<file name="lcd_dogm.h"/>
+4 -1
View File
@@ -2,7 +2,10 @@
<module name="led_safety_status">
<doc>
<description> LED module that blinks in different patterns in different safety situations </description>
<description>
LED safety indicator.
LED module that blinks in different patterns in different safety situations.
</description>
</doc>
<header>
<file name="led_safety_status.h"/>
+1 -1
View File
@@ -2,7 +2,7 @@
<module name="sensors">
<doc>
<description>standalone hmc5843 magnetometer</description>
<description>hmc5843 magnetometer</description>
</doc>
<!-- <depend conflict="ins" -->
<header>
+4 -1
View File
@@ -2,7 +2,10 @@
<module name="mag_micromag_fw" dir="sensors">
<doc>
<description>Micromag magnetometer for fixedwing</description>
<description>
Micromag magnetometer.
for fixedwing
</description>
</doc>
<header>
<file name="mag_micromag_fw_hw.h"/>
+1 -1
View File
@@ -4,7 +4,7 @@
<module name="max3100">
<doc>
<description>Driver for the MAXIM SPI/Uart MAX3100 converter</description>
<description>MAX3100 SPI/Uart converter</description>
</doc>
<header>
<file name="max3100_hw.h"/>
+2 -14
View File
@@ -1,23 +1,11 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!--
Pressure Board Navarro (2010)
by Matthieu Navarro
combine differential and absolute pressure sensor (ETS raw sensors)
controlled by a dspic
return scaled values over I2C
-->
<module name="pbn" dir="sensors">
<doc>
<description>
Pressure Board Navarro (2010)
Pressure Board Navarro.
by Matthieu Navarro
by Matthieu Navarro (2010)
combine differential and absolute pressure sensor (ETS raw sensors)
controlled by a dspic
+3 -1
View File
@@ -2,7 +2,9 @@
<module name="potential" dir="multi">
<doc>
<description>Collision avoidance using potential fields</description>
<description>
Potential fields collision avoidance.
</description>
</doc>
<header>
<file name="potential.h"/>
+8 -9
View File
@@ -1,17 +1,16 @@
<!DOCTYPE module SYSTEM "module.dtd">
<!-- Currently only available on LPC21xx arch
pwm input measurement mcu periph access and init wrapper for other modules
For LPC21xx on the TWOG:
1 - INPUT CAPTURE CAP0.3 on P0.29 (TWOG ADC5, 5V->3.3V voltage divider)
2 - INPUT CAPTURE CAP0.0 on P0.30 (TWOG ADC4, no voltage divider)
-->
<module name="pwm_meas" dir="core">
<doc>
<description>
pwm input measurement mcu periph access and init wrapper for other modules
PWM measurement.
PWM input measurement mcu periph access and init wrapper for other modules.
For LPC21xx on the TWOG:
1 - INPUT CAPTURE CAP0.3 on P0.29 (TWOG ADC5, 5V to 3.3V voltage divider)
2 - INPUT CAPTURE CAP0.0 on P0.30 (TWOG ADC4, no voltage divider)
- INPUT CAPTURE CAP0.3 on P0.29 (TWOG ADC5, 5V to 3.3V voltage divider)
- INPUT CAPTURE CAP0.0 on P0.30 (TWOG ADC4, no voltage divider)
Currently only available on LPC21xx arch
</description>
</doc>
+1 -1
View File
@@ -3,7 +3,7 @@
<module name="sonar">
<doc>
<description>
Maxbotix Sonar driver
Maxbotix Sonar.
On Booz board, ADC_0 should be use by default (payload connector)
</description>
<configure name="ADC_SONAR" value="ADC_X" description="select ADC to use with the sonar"/>
+1 -1
View File
@@ -2,7 +2,7 @@
<module name="tcas" dir="multi">
<doc>
<description>Collision avoidance system based on TCAS logic</description>
<description>TCAS collision avoidance</description>
</doc>
<header>
<file name="tcas.h"/>
+1 -1
View File
@@ -2,7 +2,7 @@
<module name="temp_lm75" dir="meteo">
<doc>
<description></description>
<description>LM75 temparature sensor</description>
</doc>
<header>
<file name="temp_lm75.h"/>
+4 -1
View File
@@ -2,7 +2,10 @@
<module name="trigger_ext" dir="sensors">
<doc>
<description>External trigger (lpc only)</description>
<description>
External trigger
(lpc only)
</description>
</doc>
<header>
<file name="trig_ext_hw.h"/>
+1 -1
View File
@@ -22,7 +22,7 @@
*/
/**
* @file airspeed_ets.c
* @file modules/sensors/airspeed_ets.c
*
* Driver for the EagleTree Systems Airspeed Sensor.
* Has only been tested with V3 of the sensor hardware.
+1 -1
View File
@@ -22,7 +22,7 @@
*/
/**
* @file airspeed_ets.h
* @file modules/sensors/airspeed_ets.h
*
* Driver for the EagleTree Systems Airspeed Sensor.
* Has only been tested with V3 of the sensor hardware.