Skip to main content

CircuitPython library for Nintendo Wii Classic controllers.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

CircuitPython library for Nintendo Wii Classic controllers.

Dependencies

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")
        time.sleep(0.5)

Documentation

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

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

Contributing

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file adafruit-circuitpython-wii-classic-1.0.1.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-wii-classic-1.0.1.tar.gz
Algorithm Hash digest
SHA256 325740bd0c1e1c9e0a435b64aa24259ef372d51313ccbd08d9a44661cf124364
MD5 7477f4f6835fb0e14abb53b69799aea2
BLAKE2b-256 5462c73ef2b812a9b5f3e15cdbef4a4174da3adabf02ff6632b3730c7a2d0381

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_wii_classic-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_wii_classic-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ab340319a7c3a34604b80c5ed7a8af8ae8b3663b4efbe09b758545c555afdf64
MD5 3fd3826ee92bf91ba141b61d6a28d7ed
BLAKE2b-256 41effbdc25b7097d5bcc448c89290aca3b176e9c249581e0b0b0bbdbeeb8c453

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page