Compass

Functions
void	calibrate_compass ()
void	set_compass_params (float meanX, float meanY, float meanZ, float W1, float W2, float div_E1, float div_E2)
float	get_compass_angle (void)

Detailed Description

The functions defined here make a compass.

Function Documentation

calibrate_compass()

void calibrate_compass

(

)

Begin calibrating the compass.

Will display the calibration parameter results which can be used in the future with set_compass_params

Provided by Dr. Andrew H. Fagg and Twister Robotics

get_compass_angle()

float get_compass_angle

(

void

)

Get the current compass heading.

Provided by Dr. Andrew H. Fagg and Twister Robotics

Returns

the compass angle in radians

set_compass_params()

void set_compass_params	(	float	meanX,
		float	meanY,
		float	meanZ,
		float	W1,
		float	W2,
		float	div_E1,
		float	div_E2
	)

Set the compass parameters based on a previous calibration.

Provided by Dr. Andrew H. Fagg and Twister Robotics

Parameters

[in]	meanX	a value provided by calibrate_compass
[in]	meanY	a value provided by calibrate_compass
[in]	meanZ	a value provided by calibrate_compass
[in]	W1	a value provided by calibrate_compass
[in]	W2	a value provided by calibrate_compass
[in]	div_E1	a value provided by calibrate_compass
[in]	div_E2	a value provided by calibrate_compass