Standard Controller High-Level Library (KPAD) API Function List

Initialization

KPADInit Initializes the KPAD library.
KPADInitEx Initializes the KPAD library. Configures the ring buffer used for internal processing.
KPADShutdown Stops the KPAD library.
KPADReset Returns to the initial state.

Connection

KPADSetConnectCallback Registers the connection notification callback for the application.

Controller Data

KPADRead Gets data.
KPADReadEx Gets data and error code.
KPADSetSamplingCallback Registers the sampling callback for the application.
KPADGetUnifiedWpadStatus Gets controller data such as WPADStatus, including the data format for each element.

Button

KPADSetBtnRepeat Sets the digital button repeat functionality.
KPADSetButtonProcMode Sets the button processing method used inside KPADRead.
KPADGetButtonProcMode Gets the button processing method used inside KPADRead.

Accelerometer

KPADSetAccParam Adjusts the play radius and sensitivity for the acceleration sensor.
KPADGetAccParam Gets the play radius and sensitivity for the set acceleration sensor.
KPADSetAccPlayMode Sets the play mode for the acceleration sensor.
KPADGetAccPlayMode Gets the play mode for the set acceleration sensor.
KPADReviseAcc Corrects any user-specified vector in the same manner as the correction performed when KPADSetReviseMode is set to ON.

DPD

KPADEnableDPD Issues a request to turn the Wii remote DPD module on.
KPADDisableDPD Issues a request to turn the Wii remote DPD module off.
KPADSetControlDpdCallback Registers the callback to use for notification when making DPD settings for the Wii remote.
KPADCalibrateDPD Performs calibration.
KPADGetProjectionPos Converts the normalized coordinate values into projection coordinates.
KPADEnableAimingMode Sets the mode for getting the nearest coordinate to the spot on the TV screen actually being pointed to by the Wii remote.
KPADDisableAimingMode Sets the mode for getting the coordinate with the center of the Sensor Bar used as the reference (default).
KPADIsEnableAimingMode Determines whether the aiming mode is enabled. (In this mode the nearest coordinates to the spot on the TV screen actually being pointed to by the Wii remote are the obtained coordinates.)
KPADSetPosPlayMode Sets the play mode for the coordinate values.
KPADGetPosPlayMode Gets the play mode for the set coordinate values.
KPADSetPosParam Adjusts the play radius and sensitivity for the coordinate values.
KPADGetPosParam Gets the play radius and sensitivity for the set coordinate values.
KPADSetHoriPlayMode Sets the play mode for the horizontal parameters.
KPADGetHoriPlayMode Gets the play mode for the set horizontal parameters.
KPADSetHoriParam Adjusts the play radius and sensitivity for the horizontal parameters.
KPADGetHoriParam Gets the play radius and sensitivity for the set horizontal parameters.
KPADSetDistPlayMode Sets the play mode for the distance.
KPADGetDistPlayMode Gets the play mode for the set distance.
KPADSetDistParam Adjusts the play radius and sensitivity for the distance.
KPADGetDistParam Gets the play radius and sensitivity for the set distance.
KPADSetSensorHeight Sets the height for the Sensor Bar location.
KPADGetSensorHeight Gets the height for the Sensor Bar location.

Wii MotionPlus

KPADEnableMpls Issues a request to turn on the Wii MotionPlus.
KPADDisableMpls Issues a request to turn off the Wii MotionPlus.
KPADSetControlMplsCallback Registers the callback to use for notifications when configuring the Wii MotionPlus.
KPADGetMplsStatus Gets whether a started Wii MotionPlus is plugged into the Wii remote, and if so, whether it is the only device in operation.
KPADSetMplsWorkarea Configures the work area used to process Wii MotionPlus data. This function must be called once before using any other functions related to processing Wii MotionPlus data.
KPADGetMplsWorkSize Gets the amount of memory required by the library to process Wii MotionPlus data.
KPADStartMplsCalibration Performs at-rest (zero point) calibration for the specified channel's Wii MotionPlus.
KPADWorkMplsCalibration Gets the progress status of the at-rest (zero-point) calibration process for the specified channel's Wii MotionPlus.
KPADStopMplsCalibration Stops execution of at-rest (zero-point) calibration for the specified channel's Wii MotionPlus.
KPADResetMpls Initializes the internal state related to processing data for the specified channel's Wii MotionPlus.
KPADSetMplsAngle Resets angle, in the KPADMPStatus structure obtained by the KPADRead function for the specified channel's Wii MotionPlus, with arbitrary values.
KPADSetMplsDirection Resets dir, in the KPADMPStatus structure obtained by the KPADRead function for the specified channel's Wii MotionPlus, with arbitrary values.
KPADSetMplsDirectionMag Sets the magnitude to be applied to the angular velocity value used to internally calculate the dir member of the KPADMPStatus structure obtained by the KPADRead function for the specified channel's Wii MotionPlus.
KPADEnableMplsAccRevise Enables acceleration correction for the specified channel's Wii MotionPlus.
KPADDisableMplsAccRevise Disables acceleration correction for the specified channel's Wii MotionPlus.
KPADIsEnableMplsAccRevise Checks if acceleration correction is enabled for the specified channel's Wii MotionPlus. Returns the correction level when enabled.
KPADInitMplsAccReviseParam Initializes the level of acceleration correction for the specified channel's Wii MotionPlus.
KPADSetMplsAccReviseParam Configures the level of acceleration correction for the specified channel's Wii MotionPlus.
KPADGetMplsAccReviseParam Gets the level of acceleration correction for the specified channel's Wii MotionPlus.
KPADEnableMplsDirRevise Enables attitude correction for the specified channel's Wii MotionPlus.
KPADDisableMplsDirRevise Disables attitude correction for the specified channel's Wii MotionPlus.
KPADIsEnableMplsDirRevise Checks if attitude correction is enabled for the specified channel's Wii MotionPlus. Returns the correction level when enabled.
KPADInitMplsDirReviseParam Initializes the level of attitude correction for the specified channel's Wii MotionPlus.
KPADSetMplDirReviseParam Configures the level of attitude correction for the specified channel's Wii MotionPlus.
KPADGetMplDirReviseParam Get the level of attitude correction for the specified channel's Wii MotionPlus.
KPADSetMplsDirReviseBase Configures the base attitude to use when using attitude correction with the specified channel's Wii MotionPlus.
KPADEnableMplsDpdRevise Enables DPD correction for the specified channel's Wii MotionPlus.
KPADDisableMplsDpdRevise Disables DPD correction for the specified channel's Wii MotionPlus.
KPADIsEnableMplsDpdRevise Checks if DPD correction is enabled for the specified channel's Wii MotionPlus. Returns the correction level when enabled.
KPADInitMplsDpdReviseParam Initializes the level of DPD correction for the specified channel's Wii MotionPlus.
KPADSetMplsDpdReviseParam Configures the level of DPD correction for the specified channel's Wii MotionPlus.
KPADGetMplsDpdReviseParam Gets the level of DPD correction for the specified channel's Wii MotionPlus.
KPADEnableMplsZeroPlay Enables zero-point tolerance for the specified channel's Wii MotionPlus.
KPADDisableMplsZeroPlay Disables zero-point tolerance for the specified channel's Wii MotionPlus.
KPADIsEnableMplsZeroPlay Checks if zero-point play tolerance is enabled for the specified channel's Wii MotionPlus. Returns the correction level when enabled.
KPADInitMplsZeroPlayParam Initializes the zero-point tolerance for the specified channel's Wii MotionPlus.
KPADSetMplsZeroPlayParam Sets the at-rest (zero point) play tolerance for the specified channel's Wii MotionPlus.
KPADGetMplsZeroPlayParam Gets the zero-point play tolerance for the specified channel's Wii MotionPlus.
KPADIsEnableMplsZeroDrift Gets the level of zero-point drift correction of the specified channel's Wii MotionPlus.
KPADInitMplsZeroDriftMode Initializes the zero-point drift correction mode of the specified channel's Wii MotionPlus.
KPADSetMplsZeroDriftMode Sets the zero-point drift correction mode of the specified channel's Wii MotionPlus.
KPADGetMplsZeroDriftMode Gets the zero-point drift correction mode of the specified channel's Wii MotionPlus.
KPADSetMplsMagnification Sets the scaling to apply to each direction when calculating angular speed for the specified channel's Wii MotionPlus.

Analog Stick

KPADEnableStickCrossClamp Sets the stick's clamping method to cross clamping.
KPADDisableStickCrossClamp Sets the stick's clamping method to circular clamping.

Nunchuk

KPADSetReviseMode Sets whether to apply angular correction in advance to the values returned from the Nunchuk Motion Sensor.
KPADGetReviseAngle Gets the angle of rotation, in degrees, of the angular correction performed by KPADReviseAcc.
KPADSetFSStickClamp Clamps control stick information for the Nunchuk.

Wii Balance Board

KPADResetWbcZeroPoint Resets the zero point for the Wii Balance Board.
KPADResetWbcTgcWeight Recalculates the body weight measured by the Wii Balance Board with temperature and gravity corrections applied.

Struct

KPADStatus This structure stores controller data in the KPAD library.
KPADEXStatus This union stores the data for the extended unit in the KPAD library.
KPADMPStatus This structure stores controller data with Wii MotionPlus data in the KPAD library.
KPADUnifiedWpadStatus This structure stores controller data such as WPADStatus, including the data format for each element.


Revision History

2014/01/23 Terminology fix.
2013/05/08 Automated cleanup pass.


CONFIDENTIAL