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 .venv
source .venv/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.9.tar.gz (27.0 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-nunchuk-1.1.9.tar.gz
Algorithm Hash digest
SHA256 264fa085835177541768621314ad05cf8ec95201d668b86c6e79b7a20aad4fde
MD5 a407d21aa5113a19d1bda4654e505254
BLAKE2b-256 2dfeb69422417eb45ed468f4b6b506437185111752f3d53ae260a1afea2fa28a

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_nunchuk-1.1.9-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_nunchuk-1.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 45ca8d07927756c5113517ecaf08e5c72e6bd4e805692697bf61cad353ba26a4
MD5 ca775fb3d705f1a0597aa2395d40b57c
BLAKE2b-256 ea34f5d910fb72060572cc2fcc4b64f591aec0d07126441c46c00dcd4ce0dd7d

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