Paparazzi UAS  v5.0.5_stable-7-g4b8bbb7
Paparazzi is a free software Unmanned Aircraft System.
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
HMC58xx magnetometer

Module XML file: mag_hmc58xx.xml

Module for standalone operation/logging of a HMC58xx magnetometer.

Module configuration options

Configure Options

  • name: MAG_HMC58XX_I2C_DEV value: i2c1
    Description: I2C device to use (e.g. i2c1)

Define Options

  • name: MODULE_HMC58XX_SYNC_SEND value: TRUE|FALSE
    Description: Send IMU_RAW message with each new measurement (default: FALSE)

Module functions

Init Functions

These initialization functions are called once on startup.

Event Functions

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

Periodic Functions

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

Files

Header Files

The following headers are automatically included in modules.h

Source Files

Raw mag_hmc58xx.xml file:

<!DOCTYPE module SYSTEM "module.dtd">
<module name="sensors">
<doc>
<description>
HMC58xx magnetometer.
Module for standalone operation/logging of a HMC58xx magnetometer.
</description>
<configure name="MAG_HMC58XX_I2C_DEV" value="i2c1" description="I2C device to use (e.g. i2c1)"/>
<define name="MODULE_HMC58XX_SYNC_SEND" value="TRUE|FALSE" description="Send IMU_RAW message with each new measurement (default: FALSE)"/>
</doc>
<header>
<file name="mag_hmc58xx.h"/>
</header>
<init fun="mag_hmc58xx_module_init()"/>
<periodic fun="mag_hmc58xx_module_periodic()" freq="60"/>
<periodic fun="mag_hmc58xx_report()" freq="10" autorun="TRUE"/>
<event fun="mag_hmc58xx_module_event()"/>
<makefile>
<file name="mag_hmc58xx.c"/>
<file name="hmc58xx.c" dir="peripherals"/>
<define name="USE_I2C"/>
</makefile>
</module>