INF2004-Project/magnetometer_8h_source.html

#ifndef MAGNETOMETER_H // Include guard.

#define MAGNETOMETER_H


// Definitions.

// -----------------------------------------------------------------------------

//


#define MAGNETO_METER_ADDR 0x1E

#define MAGNETO_ACCEL_ADDR 0x19

#define MAGNETO_I2C_SDA_PIN 0

#define MAGNETO_I2C_SCL_PIN 1

#define MAGNETO_I2C_BAUDRATE 1000000


#define MAGNETO_CTRL_REG1_A 0x20


#define MAGNETO_OUT_X_L_A 0x28

#define MAGNETO_OUT_X_H_A 0x29

#define MAGNETO_OUT_Y_L_A 0x2A

#define MAGNETO_OUT_Y_H_A 0x2B

#define MAGNETO_OUT_Z_L_A 0x2C

#define MAGNETO_OUT_Z_H_A 0x2D


#define MAGNETO_CRA_REG_M 0x00

#define MAGNETO_MR_REG_M 0x02

#define MAGNETO_OUT_X_H_M 0x03

#define MAGNETO_OUT_X_L_M 0x04

#define MAGNETO_OUT_Z_H_M 0x05

#define MAGNETO_OUT_Z_L_M 0x06

#define MAGNETO_OUT_Y_H_M 0x07

#define MAGNETO_OUT_Y_L_M 0x08


#define MAGNETO_BEARING_OFFSET 1.0f

#define MAGNETO_GRAVITY_CONSTANT_F 9.80665 / 16384.0

 // End of magnetometer_constants group.


// Public Function prototypes.

//

void  magneto_init(void);

void  magneto_read_data(void);

bool  magneto_is_bearing_invalid(void);

float magneto_get_true_bearing(void);

float magneto_get_curr_bearing(void);


#endif // MAGNETOMETER_H


// End of file driver/magnetometer/magnetometer.h.

magneto_read_data
void magneto_read_data(void)
Reads magnetometer data from the magnetometer sensor and outputs the values into the global variables...
Definition: magnetometer.c:69

magneto_get_curr_bearing
float magneto_get_curr_bearing(void)
Gets the current bearing of the magnetometer sensor.
Definition: magnetometer.c:139

magneto_is_bearing_invalid
bool magneto_is_bearing_invalid(void)
Checks if the current bearing is invalid if it is out of bounds.
Definition: magnetometer.c:116

magneto_get_true_bearing
float magneto_get_true_bearing(void)
Gets the true bearing of the magnetometer sensor.
Definition: magnetometer.c:128

magneto_init
void magneto_init(void)
Initializes the magnetometer by initializing the USB, I2C, and setting the GPIO pins.
Definition: magnetometer.c:149