Synopsis
CTL_STATUS_t hmc5883l_initialize_transport(CTL_MAGNETOMETER_t *self,
                                           CTL_TRANSPORT_t *transport);
Description

hmc5883l_initialize_transport initializes the magnetometer interface self with methods to communicate with an HMC5883L magnetometer using the transport transport to transfer I2C data. The transport transport must already have been initialized with the I2C address of the target HMC5883L.

Return Value

hmc5883l_initialize_transport returns a standard status code.

Thread Safety

hmc5883l_initialize_transport is thread-safe if the transport transport is thread-safe. Typically, for SPI and I2C transports, you ensure thread safety by associating a mutex with the bus used by the transport.

See Also

<ctl_sensors.h>