NUNCHUCK Class Reference

C++ API for the Wii Nunchuck. More...

Detailed Description

• ID: nunchuck
• Name: Wii Nunchuck
• Category: accelerometer
• Manufacturer: generic
• Link: http://wiibrew.org/wiki/Wiimote/Extension_Controllers
• Connection: i2c

UPM module for the Wii Nunchuck. This module was tested with the Wii Nunchuck connected to I2C via a Grove Wii Nunchuck adapter.

See http://wiibrew.org/wiki/Wiimote/Extension_Controllers and http://wiibrew.org/wiki/Wiimote/Extension_Controllers/Nunchuck for more detailed information on the controller and it's protocol.

A warning for the Grove nunchuck adapter: It has 2 traces on one side, and 3 traces on the other. Do not match these up with the nunchuck connector's traces. The nunchuck connector 'groove' should be on the same side as the grove interface socket on the adapter.

  // Instantiate a nunchuck controller bus 0
  upm::NUNCHUCK *nunchuck = new upm::NUNCHUCK(0);
  
  // always do this first
  cout << "Initializing... " << endl;
  if (!nunchuck->init())
    {
      cerr << "nunchuck->init() failed." << endl;
      return 0;
    }
  
  while (shouldRun)
    {
      nunchuck->update();

      cout << "stickX: " << nunchuck->stickX 
           << ", stickY: " << nunchuck->stickY << endl;
      cout << "accelX: " << nunchuck->accelX 
           << ", accelY: " << nunchuck->accelY 
           << ", accelZ: " << nunchuck->accelZ << endl;
      
      cout << "button C: " 
           << ((nunchuck->buttonC) ? "pressed" : "not pressed") << endl;
      cout << "button Z: " 
           << ((nunchuck->buttonZ) ? "pressed" : "not pressed") << endl;
      cout << endl;

      usleep(100000);
    }

Public Member Functions
	NUNCHUCK (int bus, uint8_t addr=NUNCHUCK_I2C_ADDR)
	~NUNCHUCK ()
bool	writeByte (uint8_t reg, uint8_t byte)
uint8_t	readBytes (uint8_t reg, uint8_t *buffer, unsigned int len)
bool	init ()
void	update ()

Data Fields
int	stickX
int	stickY
int	accelX
int	accelY
int	accelZ
bool	buttonC
bool	buttonZ

Constructor & Destructor Documentation

NUNCHUCK	(	int	bus,
		uint8_t	addr = NUNCHUCK_I2C_ADDR
	)

NUNCHUCK constructor

Parameters

bus	i2c bus to use
addr	i2c address to use

~NUNCHUCK

(

)

NUNCHUCK destructor

Member Function Documentation

bool writeByte	(	uint8_t	reg,
		uint8_t	byte
	)

Write value(s) into registers

Parameters

reg	register location to start writing into
byte	byte to write

Returns

true if successful

uint8_t readBytes	(	uint8_t	reg,
		uint8_t *	buffer,
		unsigned int	len
	)

Read value(s) from registers

Parameters

reg	register location to start reading from
buffer	buffer for data storage
len	number of bytes to read

Returns

number of bytes read

bool init

(

)

Initialize the controller. Here, we disable encryption after delaying for a time to ensure the controller is ready.

Returns

true if initialized successfully

void update

(

void

)

Read and update the current state of the controller.

Field Documentation

int stickX

Current analog stick X position

int stickY

Current analog stick Y position

int accelX

Current accelerometer X value

int accelY

Current accelerometer Y value

int accelZ

Current accelerometer Z value

bool buttonC

Button C pressed?

bool buttonZ

Button Z pressed?

---

The documentation for this class was generated from the following files:

• /var/lib/jenkins/workspace/upm-doc-stable/src/nunchuck/nunchuck.h
• /var/lib/jenkins/workspace/upm-doc-stable/src/nunchuck/nunchuck.cxx