Example for airframe file

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

 <module name="imu_aspirin_common">
   <configure name="ASPIRIN_I2C_DEV" value="i2c2" />
   <configure name="ASPIRIN_SPI_DEV" value="spi2" />
   <configure name="ASPIRIN_SPI_SLAVE_IDX" value="SPI_SLAVE2" />
 </module>

Module configuration options

Configure Options

name: ASPIRIN_I2C_DEV value: i2c2
Description: I2C device to use
name: ASPIRIN_SPI_DEV value: spi2
Description: SPI device to use for accel
name: ASPIRIN_SPI_SLAVE_IDX value: SPI_SLAVE2
Description: slave index of the accel CS pin

Airframe file section

section name: IMU prefix: IMU_
- name MAG_X_NEUTRAL value: 2358
- name MAG_Y_NEUTRAL value: 2362
- name MAG_Z_NEUTRAL value: 2119
- name MAG_X_SENS value: 3.4936416
- name MAG_Y_SENS value: 3.607713
- name MAG_Z_SENS value: 4.90788848

Auto-loaded modules

The following modules are automatically loaded (just as if you had added them in the airframe file)

Module functions

Init Functions

These initialization functions are called once on startup.

imu_aspirin_init()

Event Functions

These event functions are called in each cycle of the module event loop.

imu_aspirin_event()

Periodic Functions

These functions are called periodically at the specified frequency from the module periodic loop.

imu_aspirin_periodic()
- Running at maximum module frequency.
- Autorun: LOCK
  Periodic function automatically starts after init and can't be stopped.

Files

Header Files

The following headers are automatically included in modules.h

imu_aspirin.h

Source Files

Raw imu_aspirin_common.xml file:

<!DOCTYPE module SYSTEM "module.dtd">
<module name="imu_aspirin_common">
  <doc>
    <description>
      Common functionality of Aspirin IMUs.
      - Accelerometer: ADXL345 via SPI
      - Gyroscope: ITG3200 via I2C
      - Magnetometer: HMC58xx via I2C
    </description>
    <configure name="ASPIRIN_I2C_DEV" value="i2c2" description="I2C device to use"/>
    <configure name="ASPIRIN_SPI_DEV" value="spi2" description="SPI device to use for accel"/>
    <configure name="ASPIRIN_SPI_SLAVE_IDX" value="SPI_SLAVE2" description="slave index of the accel CS pin"/>
    <section name="IMU" prefix="IMU_">
      <define name="MAG_X_NEUTRAL" value="2358"/>
      <define name="MAG_Y_NEUTRAL" value="2362"/>
      <define name="MAG_Z_NEUTRAL" value="2119"/>
      <define name="MAG_X_SENS" value="3.4936416" integer="16"/>
      <define name="MAG_Y_SENS" value="3.607713" integer="16"/>
      <define name="MAG_Z_SENS" value="4.90788848" integer="16"/>
    </section>
  </doc>
  <autoload name="imu_common"/>
  <autoload name="imu_nps"/>
  <header>
    <file name="imu_aspirin.h" dir="subsystems/imu"/>
  </header>
  <init fun="imu_aspirin_init()"/>
  <periodic fun="imu_aspirin_periodic()"/>
  <event fun="imu_aspirin_event()"/>
  <makefile target="!sim|nps|fbw">
    <configure name="ASPIRIN_I2C_DEV" default="i2c2" case="lower|upper"/>
    <configure name="ASPIRIN_SPI_DEV" default="spi2" case="lower|upper"/>
    <configure name="ASPIRIN_SPI_SLAVE_IDX" default="SPI_SLAVE2"/>
    <define name="ASPIRIN_I2C_DEV" value="$(ASPIRIN_I2C_DEV_LOWER)"/>
    <define name="USE_$(ASPIRIN_I2C_DEV_UPPER)"/>
    <define name="ASPIRIN_SPI_DEV" value="$(ASPIRIN_SPI_DEV_LOWER)"/>
    <define name="USE_$(ASPIRIN_SPI_DEV_UPPER)"/>
    <define name="ASPIRIN_SPI_SLAVE_IDX" value="$(ASPIRIN_SPI_SLAVE_IDX)"/>
    <define name="USE_$(ASPIRIN_SPI_SLAVE_IDX)"/>
    <define name="IMU_TYPE_H" value="imu/imu_aspirin.h" type="string"/>
    <define name="ASPIRIN_ARCH_INDEP"/>
    <file name="adxl345_spi.c" dir="peripherals"/>
    <file name="itg3200.c" dir="peripherals"/>
    <file name="hmc58xx.c" dir="peripherals"/>
    <file name="imu_aspirin.c" dir="subsystems/imu"/>
    <raw>
      include $(CFG_SHARED)/spi_master.makefile
    </raw>
  </makefile>
</module>