Documentation Status Discord Build Status Code Style: Black

CircuitPython library for Nintendo Wii Classic controllers.


This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Works with the Wii Nunchuck Breakout Adapter and a Wii Classic Controller.

Purchase one from the Adafruit shop.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-wii-classic

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-wii-classic

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install Adafruit-circuitpython-wii-classic

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_wii_classic

Or the following command to update an existing version:

circup update

Usage Example

import time
import board
import adafruit_wii_classic

i2c = board.STEMMA_I2C()
ctrl_pad = adafruit_wii_classic.Wii_Classic(i2c)

while True:
        left_x, left_y = ctrl_pad.joystick_l
        right_x, right_y = ctrl_pad.joystick_r
        left_pressure = ctrl_pad.l_shoulder.LEFT_FORCE
        right_pressure = ctrl_pad.r_shoulder.RIGHT_FORCE
        print("joystick_l = {},{}".format(left_x, left_y))
        print("joystick_r = {},{}".format(right_X, left_y))
        print("left shoulder = {}".format(left_pressure))
        print("right shoulder = {}".format(right_pressure))
        if ctrl_pad.buttons.A:
                print("button A")
        if ctrl_pad.buttons.B:
                print("button B")
        if ctrl_pad.d_pad.UP:
                print("d_pad Up")


API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.


Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Table of Contents


Indices and tables