Skip to main content

CircuitPython library for Nintendo Wii Classic controllers.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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

adafruit_circuitpython_wii_classic-1.0.12.tar.gz (29.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file adafruit_circuitpython_wii_classic-1.0.12.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_wii_classic-1.0.12.tar.gz
Algorithm Hash digest
SHA256 27e81acf53644f98f5c9c107f6ed0e8bc03b7ec27a2b058455c4d657da65e4ee
MD5 05c0743632735061185e785ab464d76f
BLAKE2b-256 1b3acdbe36496a26fec0bf69c1bdc71887011d0e6710ecfbf9d23af202fbfa35

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_wii_classic-1.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 bc98c41049664a3ba8a2fa850437a0504369fe828ef858d7a72855c5e7c70851
MD5 ea3bfff20411dff8b1e9a30fe763094d
BLAKE2b-256 209e46cfdc991b9d5fd0a217de26284475c28bf95facb63fb8a70ba2cf57aab5

See more details on using hashes here.

Supported by

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