Synopsis

CTL_STATUS_t hmc5883l_initialize_i2c(CTL_MAGNETOMETER_t *self,
                                     CTL_I2C_BUS_t *bus,
                                     int addr);

Description

hmc5883l_initialize_i2c initializes the magnetometer interface self with methods to communicate with an HMC5883L magnetometer on the I2C bus bus with 8-bit I2C address addr.

Once the magnetometer interface is initialized, you can use all standard magnetometer methods from the sensor API on the interface.

Return Value

hmc5883l_initialize_i2c returns a standard status code.

Thread Safety

hmc5883l_initialize_i2c is thread-safe if a mutex is associated with the I2C bus bus.

See Also

<ctl_sensors.h>