ahrs_float_cmpl_rmat module

AHRS using complementary filter in floating point.

Propagation is done in rotation matrix representation.

Example for airframe file

Add to your firmware section: This example contains all possible configuration options, not all of them are mandatory!

<module name="ahrs_float_cmpl_rmat">
  b'<define name="AHRS_MAG_UPDATE_ALL_AXES" value="FALSE|TRUE" />\n    '
  b'<define name="AHRS_USE_GPS_HEADING" value="FALSE|TRUE" />\n    '
  b'<define name="AHRS_GRAVITY_UPDATE_COORDINATED_TURN" value="FALSE|TRUE" />\n    '
  b'<define name="AHRS_GPS_SPEED_IN_NEGATIVE_Z_DIRECTION" value="FALSE|TRUE" />\n\n    '
  b'<define name="AHRS_PROPAGATE_LOW_PASS_RATES" />\n    '
  b'<define name="AHRS_FC_IMU_ID" value="ABI_BROADCAST" />\n    '
  b'<define name="AHRS_FC_MAG_ID" value="ABI_BROADCAST" />\n    '
  b'<define name="AHRS_FC_GPS_ID" value="GPS_MULTI_ID" />\n  '
  b'<configure name="USE_MAGNETOMETER" value="TRUE" />\n    '
  b'<configure name="AHRS_ALIGNER_LED" value="1" />\n    '
</module>

Module configuration options

Configure Options

• name: USE_MAGNETOMETER value: TRUE
  Description: set to FALSE to disable magnetometer
• name: AHRS_ALIGNER_LED value: 1
  Description: LED number to indicate AHRS alignment, none to disable (default is board dependent)

Define Options

• name: AHRS_MAG_UPDATE_ALL_AXES value: FALSE|TRUE
  Description: Use magnetometer to update all axes and not only yaw
• name: AHRS_USE_GPS_HEADING value: FALSE|TRUE
  Description: Use GPS course to update heading
• name: AHRS_GRAVITY_UPDATE_COORDINATED_TURN value: FALSE|TRUE
  Description: Compensation of centrifugal force via GPS speed (to fly in circles with a fixedwing)
• name: AHRS_GPS_SPEED_IN_NEGATIVE_Z_DIRECTION value: FALSE|TRUE
  Description: AHRS_GRAVITY_UPDATE_COORDINATED_TURN assumes the GPS speed is in the X axis direction. Quadshot, DelftaCopter and other hybrids can have the GPS speed in the negative Z direction
• name: AHRS_PROPAGATE_LOW_PASS_RATES value: None
  Description: apply a low pass filter on rotational velocity
• name: AHRS_FC_IMU_ID value: ABI_BROADCAST
  Description: ABI sender id of IMU to use
• name: AHRS_FC_MAG_ID value: ABI_BROADCAST
  Description: ABI sender id of magnetometer to use
• name: AHRS_FC_GPS_ID value: GPS_MULTI_ID
  Description: ABI sender id of GPS to use

Files

Source Files

• modules/ahrs/ahrs_float_cmpl.c
• modules/ahrs/ahrs_float_cmpl_wrapper.c

Raw ahrs_float_cmpl_rmat.xml file:

<!DOCTYPE module SYSTEM "module.dtd">
 
<module name="ahrs_float_cmpl_rmat" dir="ahrs" task="estimation">
  <doc>
    <description>
      AHRS using complementary filter in floating point.
      Propagation is done in rotation matrix representation.
    </description>
    <configure name="USE_MAGNETOMETER" value="TRUE" description="set to FALSE to disable magnetometer"/>
    <configure name="AHRS_ALIGNER_LED" value="1" description="LED number to indicate AHRS alignment, none to disable (default is board dependent)"/>
    <define name="AHRS_MAG_UPDATE_ALL_AXES" value="FALSE|TRUE" description="Use magnetometer to update all axes and not only yaw"/>
    <define name="AHRS_USE_GPS_HEADING" value="FALSE|TRUE" description="Use GPS course to update heading"/>
    <define name="AHRS_GRAVITY_UPDATE_COORDINATED_TURN" value="FALSE|TRUE" description="Compensation of centrifugal force via GPS speed (to fly in circles with a fixedwing)"/>
    <define name="AHRS_GPS_SPEED_IN_NEGATIVE_Z_DIRECTION" value="FALSE|TRUE" description="AHRS_GRAVITY_UPDATE_COORDINATED_TURN assumes the GPS speed is in the X axis direction. Quadshot, DelftaCopter and other hybrids can have the GPS speed in the negative Z direction"/>
 
    <define name="AHRS_PROPAGATE_LOW_PASS_RATES" description="apply a low pass filter on rotational velocity"/>
    <define name="AHRS_FC_IMU_ID" value="ABI_BROADCAST" description="ABI sender id of IMU to use"/>
    <define name="AHRS_FC_MAG_ID" value="ABI_BROADCAST" description="ABI sender id of magnetometer to use"/>
    <define name="AHRS_FC_GPS_ID" value="GPS_MULTI_ID" description="ABI sender id of GPS to use"/>
  </doc>
 
  <settings>
    <dl_settings>
      <dl_settings NAME="AHRS">
        <dl_setting var="ahrs_fc.gravity_heuristic_factor" min="0" step="1" max="50" module="modules/ahrs/ahrs_float_cmpl" shortname="g_heuristic" param="AHRS_GRAVITY_HEURISTIC_FACTOR" type="uint8" persistent="true"/>
        <dl_setting var="ahrs_fc.accel_omega" min="0.02" step="0.02" max="0.2" module="modules/ahrs/ahrs_float_cmpl" shortname="acc_omega" param="AHRS_ACCEL_OMEGA" unit="rad/s" type="float" persistent="true"/>
        <dl_setting var="ahrs_fc.accel_zeta" min="0.7" step="0.05" max="1.5" module="modules/ahrs/ahrs_float_cmpl" shortname="acc_zeta" param="AHRS_ACCEL_ZETA" type="float" persistent="true"/>
        <dl_setting var="ahrs_fc.mag_omega" min="0.02" step="0.01" max="0.1" module="modules/ahrs/ahrs_float_cmpl" shortname="mag_omega" param="AHRS_MAG_OMEGA" unit="rad/s" type="float" persistent="true"/>
        <dl_setting var="ahrs_fc.mag_zeta" min="0.7" step="0.05" max="1.5" module="modules/ahrs/ahrs_float_cmpl" shortname="mag_zeta" param="AHRS_MAG_ZETA" type="float" persistent="true"/>
      </dl_settings>
    </dl_settings>
  </settings>
 
  <dep>
    <depends>ahrs_common,@imu,@gps|@mag</depends>
    <provides>ahrs</provides>
  </dep>
  <makefile target="!sim|fbw" firmware="fixedwing">
    <configure name="USE_MAGNETOMETER" default="0"/>
    <define name="AHRS_USE_GPS_HEADING" cond="ifneq (,$(findstring $(USE_MAGNETOMETER),0 FALSE))"/>
    <define name="AHRS_GRAVITY_UPDATE_COORDINATED_TURN"/>
  </makefile>
  <makefile target="!sim|fbw">
    <configure name="USE_MAGNETOMETER" default="1"/>
    <define name="USE_MAGNETOMETER" cond="ifeq (,$(findstring $(USE_MAGNETOMETER),0 FALSE))"/>
    <define name="AHRS_PROPAGATE_RMAT"/>
    <file name="ahrs_float_cmpl.c"/>
    <file name="ahrs_float_cmpl_wrapper.c"/>
    <test>
        <define name="PRIMARY_AHRS" value="ahrs_fc"/>
        <define name="AHRS_TYPE_H" value="modules/ahrs/ahrs_float_cmpl_wrapper.h" type="string"/>
        <define name="AHRS_PROPAGATE_RMAT"/>
    </test>
    <raw>
ifdef SECONDARY_AHRS
ifneq (,$(findstring $(SECONDARY_AHRS), fcr float_cmpl_rmat))
# this is the secondary AHRS
$(TARGET).CFLAGS += -DAHRS_SECONDARY_TYPE_H=\"modules/ahrs/ahrs_float_cmpl_wrapper.h\"
$(TARGET).CFLAGS += -DSECONDARY_AHRS=ahrs_fc
else
# this is the primary AHRS
$(TARGET).CFLAGS += -DAHRS_TYPE_H=\"modules/ahrs/ahrs_float_cmpl_wrapper.h\"
$(TARGET).CFLAGS += -DPRIMARY_AHRS=ahrs_fc
endif
else
# plain old single AHRS usage
$(TARGET).CFLAGS += -DAHRS_TYPE_H=\"modules/ahrs/ahrs_float_cmpl_wrapper.h\"
endif
    </raw>
  </makefile>
</module>