Skip to main content

CircuitPython library for Nintendo Nunchuk controller

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

CircuitPython library for Nintendo Nunchuk controller

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 controller (Nunchuck / Wiichuck).

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-nunchuk

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

sudo pip3 install adafruit-circuitpython-nunchuk

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-nunchuk

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 nunchuk

Or the following command to update an existing version:

circup update

Usage Example

See nunchuk_simpletest.py in examples folder.

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-nunchuk-1.1.3.tar.gz (28.7 kB view details)

Uploaded Source

File details

Details for the file adafruit-circuitpython-nunchuk-1.1.3.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-nunchuk-1.1.3.tar.gz
Algorithm Hash digest
SHA256 ed7e38bb64b52a56d06cf1ca76ec3eb693c6a4d1910251d599aee5365f340358
MD5 05e008670ffe079b56bd17451daae098
BLAKE2b-256 0e376c8238390fea82d5c034543101c20be1d32a0a03fc39981608357f9da155

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