VPADIsStartedGyroMagRevise

Syntax

#include <cafe/vpad.h>

f32 VPADIsStartedGyroMagRevise( s32 chan );

Parameters

chan Controller number. 0 for DRC1 and 1 for DRC2.

Return Values

Returns a negative value when disabled. Returns a value of zero during internal magnetometer calibration process or when the attitude correction is temporarily invalid because of the disturbed magnetic field.

Returns a value of positive value when the attitude correction using magnetometer is running. This value indicates the correction level. The closer this value is to 1, the more correction is applied so that the direction of the DRC is made to approach the direction of magnetometer.

Description

Determines whether attitude correction using magnetometer is enabled for the specified channel's DRC. Returns the correction level when enabled. This correction is initially disabled.

Do Not Call From

Background Do not call this function from the background.
Multiple threads This function is not thread-safe.
Multiple Cores Do not call this function from more than one Core.

See Also

VPADStartGyroMagRevise
VPADStopGyroMagRevise

Revision History

2013/08/20 Initial version.


CONFIDENTIAL