Classes
struct	read_req_t
	Data read request structure. More...

struct	ang3s_t
	Roll/Pitch/Yaw short angles. More...

struct	ang3f_t
	Roll/Pitch/Yaw float angles. More...

struct	vec2b_t
	Unsigned x,y byte vector. More...

struct	vec3b_t
	Unsigned x,y,z byte vector. More...

struct	vec3f_t
	Signed x,y,z float struct. More...

struct	orient_t
	Orientation struct. More...

struct	gforce_t
	Gravity force struct. More...

struct	accel_t
	Accelerometer struct. More...

struct	ir_dot_t
	A single IR source. More...

struct	ir_t
	IR struct. More...

struct	joystick_t
	Joystick calibration structure. More...

struct	nunchuk_t
	Nunchuk expansion device. More...

struct	classic_ctrl_t
	Classic controller expansion device. More...

struct	guitar_hero_3_t
	Guitar Hero 3 expansion device. More...

struct	motion_plus_t
	Motion Plus expansion device. More...

struct	tatacon_t
	Tatacon expansion device. More...

struct	wii_board_t
	Wii Balance Board "expansion" device. More...

struct	expansion_t
	Generic expansion device plugged into wiimote. More...

struct	wiimote_state_t
	Significant data from the previous event. More...

struct	wiimote_t
	Main Wiimote device structure. More...

struct	wiimote_callback_data_t
	Data passed to a callback during wiiuse_update() More...

struct	data_req_t
	Data write request structure. More...

Macros
#define	WIIUSE_SYNC_HANDSHAKE

#define	WIIUSE_EXPORT_DECL

#define	WIIUSE_IMPORT_DECL

#define	WIIUSE_EXPORT WIIUSE_IMPORT_DECL

#define	WIIUSE_HAS_OUTPUT_REDIRECTION
	Define indicating the presence of the feature allowing you to redirect output for one or more logging levels within the library.

Typedefs
typedef enum ir_position_t	ir_position_t
	IR correction types.

typedef unsigned char	byte

typedef char	sbyte

typedef void(*	wiiuse_read_cb) (struct wiimote_t wm, byte data, uint16_t len)
	Callback that handles a read event. More...

typedef struct ang3s_t	ang3s_t

typedef struct ang3f_t	ang3f_t

typedef struct vec2b_t	vec2b_t
	Unsigned x,y byte vector.

typedef struct vec3b_t	vec3b_t
	Unsigned x,y,z byte vector.

typedef struct vec3f_t	vec3f_t
	Signed x,y,z float struct.

typedef struct orient_t	orient_t
	Orientation struct. More...

typedef struct gforce_t	gforce_t
	Gravity force struct.

typedef struct accel_t	accel_t
	Accelerometer struct. More...

typedef struct ir_dot_t	ir_dot_t
	A single IR source.

typedef enum aspect_t	aspect_t
	Screen aspect ratio.

typedef struct ir_t	ir_t
	IR struct. More...

typedef struct joystick_t	joystick_t
	Joystick calibration structure. More...

typedef struct nunchuk_t	nunchuk_t
	Nunchuk expansion device.

typedef struct classic_ctrl_t	classic_ctrl_t
	Classic controller expansion device.

typedef struct guitar_hero_3_t	guitar_hero_3_t
	Guitar Hero 3 expansion device.

typedef struct motion_plus_t	motion_plus_t
	Motion Plus expansion device.

typedef struct tatacon_t	tatacon_t
	Tatacon expansion device.

typedef struct wii_board_t	wii_board_t
	Wii Balance Board "expansion" device. More...

typedef struct expansion_t	expansion_t
	Generic expansion device plugged into wiimote.

typedef enum win_bt_stack_t	win_bt_stack_t
	Available bluetooth stacks for Windows.

typedef struct wiimote_state_t	wiimote_state_t
	Significant data from the previous event.

typedef enum WIIUSE_EVENT_TYPE	WIIUSE_EVENT_TYPE
	Events that wiiuse can generate from a poll.

typedef enum WIIUSE_WIIMOTE_TYPE	WIIUSE_WIIMOTE_TYPE
	Type of wiimote peripheral.

typedef struct wiimote_t	wiimote
	Main Wiimote device structure. More...

typedef struct wiimote_callback_data_t	wiimote_callback_data_t
	Data passed to a callback during wiiuse_update()

typedef void(*	wiiuse_update_cb) (struct wiimote_callback_data_t *wm)
	Callback type.

typedef void(*	wiiuse_write_cb) (struct wiimote_t wm, unsigned char data, unsigned short len)
	Callback that handles a write event. More...

typedef enum data_req_s	data_req_s

typedef enum wiiuse_loglevel	wiiuse_loglevel
	Loglevels supported by wiiuse.

Enumerations
enum	ir_position_t { WIIUSE_IR_ABOVE, WIIUSE_IR_BELOW }
	IR correction types.

enum	aspect_t { WIIUSE_ASPECT_4_3, WIIUSE_ASPECT_16_9 }
	Screen aspect ratio.

enum	win_bt_stack_t { WIIUSE_STACK_UNKNOWN, WIIUSE_STACK_MS, WIIUSE_STACK_BLUESOLEIL }
	Available bluetooth stacks for Windows.

enum	WIIUSE_EVENT_TYPE { WIIUSE_NONE = 0, WIIUSE_EVENT, WIIUSE_STATUS, WIIUSE_CONNECT, WIIUSE_DISCONNECT, WIIUSE_UNEXPECTED_DISCONNECT, WIIUSE_READ_DATA, WIIUSE_WRITE_DATA, WIIUSE_NUNCHUK_INSERTED, WIIUSE_NUNCHUK_REMOVED, WIIUSE_CLASSIC_CTRL_INSERTED, WIIUSE_CLASSIC_CTRL_REMOVED, WIIUSE_GUITAR_HERO_3_CTRL_INSERTED, WIIUSE_GUITAR_HERO_3_CTRL_REMOVED, WIIUSE_WII_BOARD_CTRL_INSERTED, WIIUSE_WII_BOARD_CTRL_REMOVED, WIIUSE_MOTION_PLUS_ACTIVATED, WIIUSE_MOTION_PLUS_REMOVED, WIIUSE_TATACON_CTRL_INSERTED, WIIUSE_TATACON_CTRL_REMOVED }
	Events that wiiuse can generate from a poll.

enum	WIIUSE_WIIMOTE_TYPE { WIIUSE_WIIMOTE_REGULAR = 0, WIIUSE_WIIMOTE_MOTION_PLUS_INSIDE }
	Type of wiimote peripheral.

enum	data_req_s { REQ_READY = 0, REQ_SENT, REQ_DONE }

enum	wiiuse_loglevel { LOGLEVEL_ERROR = 0, LOGLEVEL_WARNING = 1, LOGLEVEL_INFO = 2, LOGLEVEL_DEBUG = 3 }
	Loglevels supported by wiiuse.

Functions
WIIUSE_EXPORT const char *	wiiuse_version ()
	Returns the version of the library.

WIIUSE_EXPORT void	wiiuse_set_output (enum wiiuse_loglevel loglevel, FILE *logtarget)
	Specify an alternate FILE stream for a log level. More...

WIIUSE_EXPORT struct wiimote_t **	wiiuse_init (int wiimotes)
	Initialize an array of wiimote structures. More...

WIIUSE_EXPORT void	wiiuse_disconnected (struct wiimote_t *wm)
	The wiimote disconnected. More...

WIIUSE_EXPORT void	wiiuse_cleanup (struct wiimote_t **wm, int wiimotes)
	Clean up wiimote_t array created by wiiuse_init()

WIIUSE_EXPORT void	wiiuse_rumble (struct wiimote_t *wm, int status)
	Enable or disable the rumble. More...

WIIUSE_EXPORT void	wiiuse_toggle_rumble (struct wiimote_t *wm)
	Toggle the state of the rumble. More...

WIIUSE_EXPORT void	wiiuse_set_leds (struct wiimote_t *wm, int leds)
	Set the enabled LEDs. More...

WIIUSE_EXPORT void	wiiuse_motion_sensing (struct wiimote_t *wm, int status)
	Set if the wiimote should report motion sensing. More...

WIIUSE_EXPORT int	wiiuse_read_data (struct wiimote_t wm, byte buffer, unsigned int offset, uint16_t len)
	Read data from the wiimote (event version). More...

WIIUSE_EXPORT int	wiiuse_write_data (struct wiimote_t wm, unsigned int addr, const byte data, byte len)
	Write data to the wiimote. More...

WIIUSE_EXPORT void	wiiuse_status (struct wiimote_t *wm)
	Request the wiimote controller status. More...

WIIUSE_EXPORT struct wiimote_t *	wiiuse_get_by_id (struct wiimote_t **wm, int wiimotes, int unid)
	Find a wiimote_t structure by its unique identifier. More...

WIIUSE_EXPORT int	wiiuse_set_flags (struct wiimote_t *wm, int enable, int disable)
	Set flags for the specified wiimote. More...

WIIUSE_EXPORT float	wiiuse_set_smooth_alpha (struct wiimote_t *wm, float alpha)
	Set the wiimote smoothing alpha value. More...

WIIUSE_EXPORT void	wiiuse_set_bluetooth_stack (struct wiimote_t **wm, int wiimotes, enum win_bt_stack_t type)
	Set the bluetooth stack type to use. More...

WIIUSE_EXPORT void	wiiuse_set_orient_threshold (struct wiimote_t *wm, float threshold)
	Set the orientation event threshold. More...

WIIUSE_EXPORT void	wiiuse_resync (struct wiimote_t *wm)
	Try to resync with the wiimote by starting a new handshake. More...

WIIUSE_EXPORT void	wiiuse_set_timeout (struct wiimote_t **wm, int wiimotes, byte normal_timeout, byte exp_timeout)
	Set the normal and expansion handshake timeouts. More...

WIIUSE_EXPORT void	wiiuse_set_accel_threshold (struct wiimote_t *wm, int threshold)
	Set the accelerometer event threshold. More...

WIIUSE_EXPORT void	wiiuse_wiiboard_use_alternate_report (struct wiimote_t *wm, int enabled)
	Switch the Balance Board to use report 0x34 instead of 0x32. More...

WIIUSE_EXPORT int	wiiuse_find (struct wiimote_t **wm, int max_wiimotes, int timeout)
	Find a wiimote or wiimotes. More...

WIIUSE_EXPORT int	wiiuse_connect (struct wiimote_t **wm, int wiimotes)
	Connect to a wiimote or wiimotes once an address is known. More...

WIIUSE_EXPORT void	wiiuse_disconnect (struct wiimote_t *wm)
	Disconnect a wiimote. More...

WIIUSE_EXPORT int	wiiuse_poll (struct wiimote_t **wm, int wiimotes)
	Poll the wiimotes for any events. More...

WIIUSE_EXPORT int	wiiuse_update (struct wiimote_t **wm, int wiimotes, wiiuse_update_cb callback)
	Poll Wiimotes, and call the provided callback with information on each Wiimote that had an event. More...

WIIUSE_EXPORT void	wiiuse_set_ir (struct wiimote_t *wm, int status)
	Set if the wiimote should track IR targets. More...

WIIUSE_EXPORT void	wiiuse_set_ir_vres (struct wiimote_t *wm, unsigned int x, unsigned int y)
	Set the virtual screen resolution for IR tracking. More...

WIIUSE_EXPORT void	wiiuse_set_ir_position (struct wiimote_t *wm, enum ir_position_t pos)
	Set the XY position for the IR cursor. More...

WIIUSE_EXPORT void	wiiuse_set_aspect_ratio (struct wiimote_t *wm, enum aspect_t aspect)
	Set the aspect ratio of the TV/monitor. More...

WIIUSE_EXPORT void	wiiuse_set_ir_sensitivity (struct wiimote_t *wm, int level)
	Set the IR sensitivity. More...

WIIUSE_EXPORT void	wiiuse_set_nunchuk_orient_threshold (struct wiimote_t *wm, float threshold)
	Set the orientation event threshold for the nunchuk. More...

WIIUSE_EXPORT void	wiiuse_set_nunchuk_accel_threshold (struct wiimote_t *wm, int threshold)
	Set the accelerometer event threshold for the nunchuk. More...

WIIUSE_EXPORT void	wiiuse_set_wii_board_calib (struct wiimote_t *wm)
	Calib wii board. More...

WIIUSE_EXPORT void	wiiuse_set_motion_plus (struct wiimote_t *wm, int status)
	Enable/disable Motion+ expansion. More...

Wiimote state flags and macros
#define	WIIMOTE_STATE_DEV_FOUND 0x0001

#define	WIIMOTE_STATE_HANDSHAKE 0x0002 /* actual connection exists but no handshake yet */

#define	WIIMOTE_STATE_HANDSHAKE_COMPLETE 0x0004 /* actual connection exists but no handshake yet */

#define	WIIMOTE_STATE_CONNECTED 0x0008

#define	WIIMOTE_STATE_RUMBLE 0x0010

#define	WIIMOTE_STATE_ACC 0x0020

#define	WIIMOTE_STATE_EXP 0x0040

#define	WIIMOTE_STATE_IR 0x0080

#define	WIIMOTE_STATE_SPEAKER 0x0100

#define	WIIMOTE_STATE_IR_SENS_LVL1 0x0200

#define	WIIMOTE_STATE_IR_SENS_LVL2 0x0400

#define	WIIMOTE_STATE_IR_SENS_LVL3 0x0800

#define	WIIMOTE_STATE_IR_SENS_LVL4 0x1000

#define	WIIMOTE_STATE_IR_SENS_LVL5 0x2000

#define	WIIMOTE_STATE_EXP_HANDSHAKE 0x10000 /* actual M+ connection exists but no handshake yet */

#define	WIIMOTE_STATE_EXP_EXTERN 0x20000 /* actual M+ connection exists but handshake failed */

#define	WIIMOTE_STATE_EXP_FAILED 0x40000 /* actual M+ connection exists but handshake failed */

#define	WIIMOTE_STATE_MPLUS_PRESENT 0x80000 /* Motion+ is connected */

#define	WIIMOTE_ID(wm) (wm->unid)

#define	WIIMOTE_IS_SET(wm, s) ((wm->state & (s)) == (s))

#define	WIIMOTE_IS_CONNECTED(wm) (WIIMOTE_IS_SET(wm, WIIMOTE_STATE_CONNECTED))

LED bit masks
#define	WIIMOTE_LED_NONE 0x00

#define	WIIMOTE_LED_1 0x10

#define	WIIMOTE_LED_2 0x20

#define	WIIMOTE_LED_3 0x40

#define	WIIMOTE_LED_4 0x80

Button codes
#define	WIIMOTE_BUTTON_TWO 0x0001

#define	WIIMOTE_BUTTON_ONE 0x0002

#define	WIIMOTE_BUTTON_B 0x0004

#define	WIIMOTE_BUTTON_A 0x0008

#define	WIIMOTE_BUTTON_MINUS 0x0010

#define	WIIMOTE_BUTTON_ZACCEL_BIT6 0x0020

#define	WIIMOTE_BUTTON_ZACCEL_BIT7 0x0040

#define	WIIMOTE_BUTTON_HOME 0x0080

#define	WIIMOTE_BUTTON_LEFT 0x0100

#define	WIIMOTE_BUTTON_RIGHT 0x0200

#define	WIIMOTE_BUTTON_DOWN 0x0400

#define	WIIMOTE_BUTTON_UP 0x0800

#define	WIIMOTE_BUTTON_PLUS 0x1000

#define	WIIMOTE_BUTTON_ZACCEL_BIT4 0x2000

#define	WIIMOTE_BUTTON_ZACCEL_BIT5 0x4000

#define	WIIMOTE_BUTTON_UNKNOWN 0x8000

#define	WIIMOTE_BUTTON_ALL 0x1F9F

Nunchuk button codes
#define	NUNCHUK_BUTTON_Z 0x01

#define	NUNCHUK_BUTTON_C 0x02

#define	NUNCHUK_BUTTON_ALL 0x03

Classic controller button codes
#define	CLASSIC_CTRL_BUTTON_UP 0x0001

#define	CLASSIC_CTRL_BUTTON_LEFT 0x0002

#define	CLASSIC_CTRL_BUTTON_ZR 0x0004

#define	CLASSIC_CTRL_BUTTON_X 0x0008

#define	CLASSIC_CTRL_BUTTON_A 0x0010

#define	CLASSIC_CTRL_BUTTON_Y 0x0020

#define	CLASSIC_CTRL_BUTTON_B 0x0040

#define	CLASSIC_CTRL_BUTTON_ZL 0x0080

#define	CLASSIC_CTRL_BUTTON_FULL_R 0x0200

#define	CLASSIC_CTRL_BUTTON_PLUS 0x0400

#define	CLASSIC_CTRL_BUTTON_HOME 0x0800

#define	CLASSIC_CTRL_BUTTON_MINUS 0x1000

#define	CLASSIC_CTRL_BUTTON_FULL_L 0x2000

#define	CLASSIC_CTRL_BUTTON_DOWN 0x4000

#define	CLASSIC_CTRL_BUTTON_RIGHT 0x8000

#define	CLASSIC_CTRL_BUTTON_ALL 0xFEFF

Guitar Hero 3 button codes
#define	GUITAR_HERO_3_BUTTON_STRUM_UP 0x0001

#define	GUITAR_HERO_3_BUTTON_YELLOW 0x0008

#define	GUITAR_HERO_3_BUTTON_GREEN 0x0010

#define	GUITAR_HERO_3_BUTTON_BLUE 0x0020

#define	GUITAR_HERO_3_BUTTON_RED 0x0040

#define	GUITAR_HERO_3_BUTTON_ORANGE 0x0080

#define	GUITAR_HERO_3_BUTTON_PLUS 0x0400

#define	GUITAR_HERO_3_BUTTON_MINUS 0x1000

#define	GUITAR_HERO_3_BUTTON_STRUM_DOWN 0x4000

#define	GUITAR_HERO_3_BUTTON_ALL 0xFEFF

Tatacon button codes
#define	TATACON_BUTTON_CENTER_LEFT 0x40

#define	TATACON_BUTTON_CENTER_RIGHT 0x10

#define	TATACON_BUTTON_RIM_LEFT 0x20

#define	TATACON_BUTTON_RIM_RIGHT 0x08

#define	TATACON_BUTTON_ALL 0x78

Wiimote option flags
#define	WIIUSE_SMOOTHING 0x01

#define	WIIUSE_CONTINUOUS 0x02

#define	WIIUSE_ORIENT_THRESH 0x04

#define	WIIUSE_INIT_FLAGS (WIIUSE_SMOOTHING \| WIIUSE_ORIENT_THRESH)

#define	WIIUSE_ORIENT_PRECISION 100.0f

Expansion codes
#define	EXP_NONE 0

#define	EXP_NUNCHUK 1

#define	EXP_CLASSIC 2

#define	EXP_GUITAR_HERO_3 3

#define	EXP_WII_BOARD 4

#define	EXP_MOTION_PLUS 5

#define	EXP_MOTION_PLUS_NUNCHUK 6 /* Motion+ in nunchuk pass-through mode */

#define	EXP_MOTION_PLUS_CLASSIC 7 /* Motion+ in classic ctr. pass-through mode */

#define	EXP_TATACON 8

Device Inquiry Macros
#define	IS_PRESSED(dev, button) ((dev->btns & button) == button)
	Check if a button is pressed. More...

#define	IS_HELD(dev, button) ((dev->btns_held & button) == button)
	Check if a button is being held. More...

#define	IS_RELEASED(dev, button) ((dev->btns_released & button) == button)
	Check if a button is released on this event. More...

#define	IS_JUST_PRESSED(dev, button) (IS_PRESSED(dev, button) && !IS_HELD(dev, button))
	Check if a button has just been pressed this event. More...

#define	WIIUSE_GET_IR_SENSITIVITY(wm, lvl)
	Return the IR sensitivity level. More...

#define	WIIUSE_USING_ACC(wm) ((wm->state & 0x020) == 0x020)

#define	WIIUSE_USING_EXP(wm) ((wm->state & 0x040) == 0x040)

#define	WIIUSE_USING_IR(wm) ((wm->state & 0x080) == 0x080)

#define	WIIUSE_USING_SPEAKER(wm) ((wm->state & 0x100) == 0x100)

#define	WIIUSE_IS_LED_SET(wm, num) ((wm->leds & WIIMOTE_LED_##num) == WIIMOTE_LED_##num)

Detailed Description

Macro Definition Documentation

◆ IS_HELD

#define IS_HELD	(	dev,
		button
	)	((dev->btns_held & button) == button)

Check if a button is being held.

Parameters

dev	Pointer to a wiimote_t or expansion structure.
button	The button you are interested in.

Returns: 1 if the button is held, 0 if not.

◆ IS_JUST_PRESSED

#define IS_JUST_PRESSED	(	dev,
		button
	)	(IS_PRESSED(dev, button) && !IS_HELD(dev, button))

Check if a button has just been pressed this event.

Parameters

dev	Pointer to a wiimote_t or expansion structure.
button	The button you are interested in.

Returns: 1 if the button is pressed, 0 if not.

◆ IS_PRESSED

#define IS_PRESSED	(	dev,
		button
	)	((dev->btns & button) == button)

Check if a button is pressed.

Parameters

dev	Pointer to a wiimote_t or expansion structure.
button	The button you are interested in.

Returns: 1 if the button is pressed, 0 if not.

◆ IS_RELEASED

#define IS_RELEASED	(	dev,
		button
	)	((dev->btns_released & button) == button)

Check if a button is released on this event.

This does not mean the button is not pressed, it means
this button was just now released.

Parameters

dev	Pointer to a wiimote_t or expansion structure.
button	The button you are interested in.

Returns: 1 if the button is released, 0 if not.

◆ WIIUSE_GET_IR_SENSITIVITY

#define WIIUSE_GET_IR_SENSITIVITY	(	wm,
		lvl
	)

Value:

do                                           \
    {                                            \
        if ((wm->state & 0x0200) == 0x0200)      \
            *lvl = 1;                            \
        else if ((wm->state & 0x0400) == 0x0400) \
            *lvl = 2;                            \
        else if ((wm->state & 0x0800) == 0x0800) \
            *lvl = 3;                            \
        else if ((wm->state & 0x1000) == 0x1000) \
            *lvl = 4;                            \
        else if ((wm->state & 0x2000) == 0x2000) \
            *lvl = 5;                            \
        else                                     \
            *lvl = 0;                            \
    } while (0)

Return the IR sensitivity level.

Parameters

wm	Pointer to a wiimote_t structure.
lvl	[out] Pointer to an int that will hold the level setting. If no level is set 'lvl' will be set to 0.

Typedef Documentation

◆ accel_t

typedef struct accel_t accel_t

Accelerometer struct.

For any device with an accelerometer.

◆ ir_t

typedef struct ir_t ir_t

IR struct.

Hold all data related to the IR tracking.

◆ joystick_t

typedef struct joystick_t joystick_t

Joystick calibration structure.

The angle ang is relative to the positive y-axis into quadrant I and ranges from 0 to 360 degrees. So if the joystick is held straight upwards then angle is 0 degrees. If it is held to the right it is 90, down is 180, and left is 270.

The magnitude mag is the distance from the center to where the joystick is being held. The magnitude ranges from 0 to 1. If the joystick is only slightly tilted from the center the magnitude will be low, but if it is closer to the outter edge the value will be higher.

◆ orient_t

typedef struct orient_t orient_t

Orientation struct.

Yaw, pitch, and roll range from -180 to 180 degrees.

◆ wii_board_t

typedef struct wii_board_t wii_board_t

Wii Balance Board "expansion" device.

A Balance Board presents itself as a Wiimote with a permanently-attached Balance Board expansion device.

◆ wiimote

typedef struct wiimote_t wiimote

Main Wiimote device structure.

You need one of these to do pretty much anything with this library.

◆ wiiuse_read_cb

typedef void(* wiiuse_read_cb) (struct wiimote_t *wm, byte *data, uint16_t len)

Callback that handles a read event.

Parameters

wm	Pointer to a wiimote_t structure.
data	Pointer to the filled data block.
len	Length in bytes of the data block.

See also: wiiuse_init()

A registered function of this type is called automatically by the wiiuse library when the wiimote has returned the full data requested by a previous call to wiiuse_read_data().

◆ wiiuse_write_cb

typedef void(* wiiuse_write_cb) (struct wiimote_t *wm, unsigned char *data, unsigned short len)

Callback that handles a write event.

Parameters

wm	Pointer to a wiimote_t structure.
data	Pointer to the sent data block.
len	Length in bytes of the data block.

See also: wiiuse_init()

A registered function of this type is called automatically by the wiiuse library when the wiimote has returned the full data requested by a previous call to wiiuse_write_data().

Function Documentation

◆ wiiuse_connect()

WIIUSE_EXPORT int wiiuse_connect	(	struct wiimote_t **	wm,
		int	wiimotes
	)

Connect to a wiimote or wiimotes once an address is known.

Parameters

wm	An array of wiimote_t structures.
wiimotes	The number of wiimote structures in wm.

Returns: The number of wiimotes that successfully connected.

See also: wiiuse_find(); wiiuse_disconnect(); wiiuse_os_connect()

Connect to a number of wiimotes when the address is already set in the wiimote_t structures. These addresses are normally set by the wiiuse_find() function, but can also be set manually.

This function only delegates to the platform-specific implementation wiiuse_os_connect.

This function is declared in wiiuse.h

◆ wiiuse_disconnect()

WIIUSE_EXPORT void wiiuse_disconnect ( struct wiimote_t * wm )

Disconnect a wiimote.

Parameters

wm	Pointer to a wiimote_t structure.

See also: wiiuse_connect(); wiiuse_os_disconnect()

Note that this will not free the wiimote structure.

This function only delegates to the platform-specific implementation wiiuse_os_disconnect.

This function is declared in wiiuse.h

◆ wiiuse_disconnected()

WIIUSE_EXPORT void wiiuse_disconnected ( struct wiimote_t * wm )

The wiimote disconnected.

Parameters

wm	Pointer to a wiimote_t structure.

◆ wiiuse_find()

WIIUSE_EXPORT int wiiuse_find	(	struct wiimote_t **	wm,
		int	max_wiimotes,
		int	timeout
	)

Find a wiimote or wiimotes.

Parameters

wm	An array of wiimote_t structures.
max_wiimotes	The number of wiimote structures in wm.
timeout	The number of seconds before the search times out.

Returns: The number of wiimotes found.

See also: wiiuse_connect(); wiiuse_os_find()

This function will only look for wiimote devices.
When a device is found the address in the structures will be set.
You can then call wiiuse_connect() to connect to the found
devices.

This function only delegates to the platform-specific implementation wiiuse_os_find.

This function is declared in wiiuse.h

◆ wiiuse_get_by_id()

WIIUSE_EXPORT struct wiimote_t* wiiuse_get_by_id	(	struct wiimote_t **	wm,
		int	wiimotes,
		int	unid
	)

Find a wiimote_t structure by its unique identifier.

Parameters

wm	Pointer to a wiimote_t structure.
wiimotes	The number of wiimote_t structures in wm.
unid	The unique identifier to search for.

Returns: Pointer to a wiimote_t structure, or NULL if not found.

◆ wiiuse_init()

WIIUSE_EXPORT struct wiimote_t** wiiuse_init ( int wiimotes )

Initialize an array of wiimote structures.

Parameters

wiimotes Number of wiimote_t structures to create.

Returns: An array of initialized wiimote_t structures.

See also: wiiuse_connect()

The array returned by this function can be passed to various functions, including wiiuse_connect().

◆ wiiuse_motion_sensing()

WIIUSE_EXPORT void wiiuse_motion_sensing	(	struct wiimote_t *	wm,
		int	status
	)

Set if the wiimote should report motion sensing.

Parameters

wm	Pointer to a wiimote_t structure.
status	1 to enable, 0 to disable.

Since reporting motion sensing sends a lot of data, the wiimote saves power by not transmitting it by default.

◆ wiiuse_poll()

WIIUSE_EXPORT int wiiuse_poll	(	struct wiimote_t **	wm,
		int	wiimotes
	)

Poll the wiimotes for any events.

Parameters

wm	An array of pointers to wiimote_t structures.
wiimotes	The number of wiimote_t structures in the wm array.

Returns: Returns number of wiimotes that an event has occurred on.

It is necessary to poll the wiimote devices for events that occur. If an event occurs on a particular wiimote, the event variable will be set.

◆ wiiuse_read_data()

WIIUSE_EXPORT int wiiuse_read_data	(	struct wiimote_t *	wm,
		byte *	buffer,
		unsigned int	addr,
		uint16_t	len
	)

Read data from the wiimote (event version).

Parameters

wm	Pointer to a wiimote_t structure.
buffer	An allocated buffer to store the data as it arrives from the wiimote. Must be persistent in memory and large enough to hold the data.
addr	The address of wiimote memory to read from.
len	The length of the block to be read.

The library can only handle one data read request at a time because it must keep track of the buffer and other events that are specific to that request. So if a request has already been made, subsequent requests will be added to a pending list and be sent out when the previous finishes.

◆ wiiuse_resync()

WIIUSE_EXPORT void wiiuse_resync ( struct wiimote_t * wm )

Try to resync with the wiimote by starting a new handshake.

Parameters

wm	Pointer to a wiimote_t structure.

◆ wiiuse_rumble()

WIIUSE_EXPORT void wiiuse_rumble	(	struct wiimote_t *	wm,
		int	status
	)

Enable or disable the rumble.

Parameters

wm	Pointer to a wiimote_t structure.
status	1 to enable, 0 to disable.

◆ wiiuse_set_accel_threshold()

WIIUSE_EXPORT void wiiuse_set_accel_threshold	(	struct wiimote_t *	wm,
		int	threshold
	)

Set the accelerometer event threshold.

Parameters

wm	Pointer to a wiimote_t structure.
threshold	The decimal place that should be considered a significant change.

◆ wiiuse_set_aspect_ratio()

WIIUSE_EXPORT void wiiuse_set_aspect_ratio	(	struct wiimote_t *	wm,
		enum aspect_t	aspect
	)

Set the aspect ratio of the TV/monitor.

Parameters

wm	Pointer to a wiimote_t structure.
aspect	Either WIIUSE_ASPECT_16_9 or WIIUSE_ASPECT_4_3

◆ wiiuse_set_bluetooth_stack()

WIIUSE_EXPORT void wiiuse_set_bluetooth_stack	(	struct wiimote_t **	wm,
		int	wiimotes,
		enum win_bt_stack_t	type
	)

Set the bluetooth stack type to use.

Parameters

wm	Array of wiimote_t structures.
wiimotes	Number of objects in the wm array.
type	The type of bluetooth stack to use.

◆ wiiuse_set_flags()

WIIUSE_EXPORT int wiiuse_set_flags	(	struct wiimote_t *	wm,
		int	enable,
		int	disable
	)

Set flags for the specified wiimote.

Parameters

wm	Pointer to a wiimote_t structure.
enable	Flags to enable.
disable	Flags to disable.

Returns: The flags set after 'enable' and 'disable' have been applied.

The values 'enable' and 'disable' may be any flags OR'ed together. Flags are defined in wiiuse.h.

◆ wiiuse_set_ir()

WIIUSE_EXPORT void wiiuse_set_ir	(	struct wiimote_t *	wm,
		int	status
	)

Set if the wiimote should track IR targets.

Parameters

wm	Pointer to a wiimote_t structure.
status	1 to enable, 0 to disable.

◆ wiiuse_set_ir_position()

WIIUSE_EXPORT void wiiuse_set_ir_position	(	struct wiimote_t *	wm,
		enum ir_position_t	pos
	)

Set the XY position for the IR cursor.

Parameters

wm	Pointer to a wiimote_t structure.

◆ wiiuse_set_ir_sensitivity()

WIIUSE_EXPORT void wiiuse_set_ir_sensitivity	(	struct wiimote_t *	wm,
		int	level
	)

Set the IR sensitivity.

Parameters

wm	Pointer to a wiimote_t structure.
level	1-5, same as Wii system sensitivity setting.

If the level is < 1, then level will be set to 1. If the level is > 5, then level will be set to 5.

◆ wiiuse_set_ir_vres()

WIIUSE_EXPORT void wiiuse_set_ir_vres	(	struct wiimote_t *	wm,
		unsigned int	x,
		unsigned int	y
	)

Set the virtual screen resolution for IR tracking.

Parameters

wm	Pointer to a wiimote_t structure.
status	1 to enable, 0 to disable.

◆ wiiuse_set_leds()

WIIUSE_EXPORT void wiiuse_set_leds	(	struct wiimote_t *	wm,
		int	leds
	)

Set the enabled LEDs.

Parameters

wm	Pointer to a wiimote_t structure.
leds	What LEDs to enable.

leds is a bitwise or of WIIMOTE_LED_1, WIIMOTE_LED_2, WIIMOTE_LED_3, or WIIMOTE_LED_4.

◆ wiiuse_set_motion_plus()

WIIUSE_EXPORT void wiiuse_set_motion_plus	(	struct wiimote_t *	wm,
		int	status
	)

Enable/disable Motion+ expansion.

Parameters

wm	Pointer to the wiimote with Motion+
status	0 - off, 1 - on, standalone, 2 - nunchuk pass-through

◆ wiiuse_set_nunchuk_accel_threshold()

WIIUSE_EXPORT void wiiuse_set_nunchuk_accel_threshold	(	struct wiimote_t *	wm,
		int	threshold
	)

Set the accelerometer event threshold for the nunchuk.

Parameters

wm	Pointer to a wiimote_t structure with a nunchuk attached.
threshold	The decimal place that should be considered a significant change.

See wiiuse_set_orient_threshold() for details.

◆ wiiuse_set_nunchuk_orient_threshold()

WIIUSE_EXPORT void wiiuse_set_nunchuk_orient_threshold	(	struct wiimote_t *	wm,
		float	threshold
	)

Set the orientation event threshold for the nunchuk.

Parameters

wm	Pointer to a wiimote_t structure with a nunchuk attached.
threshold	The decimal place that should be considered a significant change.

See wiiuse_set_orient_threshold() for details.

◆ wiiuse_set_orient_threshold()

WIIUSE_EXPORT void wiiuse_set_orient_threshold	(	struct wiimote_t *	wm,
		float	threshold
	)

Set the orientation event threshold.

Parameters

wm	Pointer to a wiimote_t structure.
threshold	The decimal place that should be considered a significant change.

If threshold is 0.01, and any angle changes by 0.01 then a significant change has occurred and the event callback will be invoked. If threshold is 1 then the angle has to change by a full degree to generate an event.

◆ wiiuse_set_output()

WIIUSE_EXPORT void wiiuse_set_output	(	enum wiiuse_loglevel	loglevel,
		FILE *	logfile
	)

Specify an alternate FILE stream for a log level.

Parameters

loglevel	The loglevel, for which the output should be set.
logfile	A valid, writeable `FILE*`, or 0, if output should be disabled.

The default FILE* for all loglevels is stderr

◆ wiiuse_set_smooth_alpha()

WIIUSE_EXPORT float wiiuse_set_smooth_alpha	(	struct wiimote_t *	wm,
		float	alpha
	)

Set the wiimote smoothing alpha value.

Parameters

wm	Pointer to a wiimote_t structure.
alpha	The alpha value to set. Between 0 and 1.

Returns: Returns the old alpha value.

The alpha value is between 0 and 1 and is used in an exponential smoothing algorithm.

Smoothing is only performed if the WIIMOTE_USE_SMOOTHING is set.

◆ wiiuse_set_timeout()

WIIUSE_EXPORT void wiiuse_set_timeout	(	struct wiimote_t **	wm,
		int	wiimotes,
		byte	normal_timeout,
		byte	exp_timeout
	)

Set the normal and expansion handshake timeouts.

Parameters

wm	Array of wiimote_t structures.
wiimotes	Number of objects in the wm array.
normal_timeout	The timeout in milliseconds for a normal read.
exp_timeout	The timeout in millisecondsd to wait for an expansion handshake.

◆ wiiuse_set_wii_board_calib()

WIIUSE_EXPORT void wiiuse_set_wii_board_calib ( struct wiimote_t * wm )

Calib wii board.

Parameters

wm	Pointer to a wiimote_t struct the calib values are used.

◆ wiiuse_status()

WIIUSE_EXPORT void wiiuse_status ( struct wiimote_t * wm )

Request the wiimote controller status.

Parameters

wm	Pointer to a wiimote_t structure.

Controller status includes: battery level, LED status, expansions

◆ wiiuse_toggle_rumble()

WIIUSE_EXPORT void wiiuse_toggle_rumble ( struct wiimote_t * wm )

Toggle the state of the rumble.

Parameters

wm	Pointer to a wiimote_t structure.

◆ wiiuse_update()

WIIUSE_EXPORT int wiiuse_update	(	struct wiimote_t **	wm,
		int	wiimotes,
		wiiuse_update_cb	callback
	)

Poll Wiimotes, and call the provided callback with information on each Wiimote that had an event.

Alternative to calling wiiuse_poll yourself, and provides the same information struct on all platforms.

Returns: Number of wiimotes that had an event.

◆ wiiuse_wiiboard_use_alternate_report()

WIIUSE_EXPORT void wiiuse_wiiboard_use_alternate_report	(	struct wiimote_t *	wm,
		int	enabled
	)

Switch the Balance Board to use report 0x34 instead of 0x32.

Parameters

wm	Pointer to a wiimote_t structure.
enabled	enabled != 0 -> use report 0x32

◆ wiiuse_write_data()

WIIUSE_EXPORT int wiiuse_write_data	(	struct wiimote_t *	wm,
		unsigned int	addr,
		const byte *	data,
		byte	len
	)

Write data to the wiimote.

Parameters

wm	Pointer to a wiimote_t structure.
addr	The address to write to.
data	The data to be written to the memory location.
len	The length of the block to be written.

Classes

Macros

Typedefs

Enumerations

Functions

Wiimote state flags and macros

LED bit masks

Button codes

Nunchuk button codes

Classic controller button codes

Guitar Hero 3 button codes

Tatacon button codes

Wiimote option flags

Expansion codes

Device Inquiry Macros

Detailed Description

Macro Definition Documentation

◆ IS_HELD

◆ IS_JUST_PRESSED

◆ IS_PRESSED

◆ IS_RELEASED

◆ WIIUSE_GET_IR_SENSITIVITY

Typedef Documentation

◆ accel_t

◆ ir_t

◆ joystick_t

◆ orient_t

◆ wii_board_t

◆ wiimote

◆ wiiuse_read_cb

◆ wiiuse_write_cb

Function Documentation

◆ wiiuse_connect()

◆ wiiuse_disconnect()

◆ wiiuse_disconnected()

◆ wiiuse_find()

◆ wiiuse_get_by_id()

◆ wiiuse_init()

◆ wiiuse_motion_sensing()

◆ wiiuse_poll()

◆ wiiuse_read_data()

◆ wiiuse_resync()

◆ wiiuse_rumble()

◆ wiiuse_set_accel_threshold()

◆ wiiuse_set_aspect_ratio()

◆ wiiuse_set_bluetooth_stack()

◆ wiiuse_set_flags()

◆ wiiuse_set_ir()

◆ wiiuse_set_ir_position()

◆ wiiuse_set_ir_sensitivity()

◆ wiiuse_set_ir_vres()

◆ wiiuse_set_leds()

◆ wiiuse_set_motion_plus()

◆ wiiuse_set_nunchuk_accel_threshold()

◆ wiiuse_set_nunchuk_orient_threshold()

◆ wiiuse_set_orient_threshold()

◆ wiiuse_set_output()

◆ wiiuse_set_smooth_alpha()

◆ wiiuse_set_timeout()

◆ wiiuse_set_wii_board_calib()

◆ wiiuse_status()

◆ wiiuse_toggle_rumble()

◆ wiiuse_update()

◆ wiiuse_wiiboard_use_alternate_report()

◆ wiiuse_write_data()