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.0.tar.gz (28.0 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: adafruit-circuitpython-nunchuk-1.1.0.tar.gz
  • Upload date:
  • Size: 28.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.2

File hashes

Hashes for adafruit-circuitpython-nunchuk-1.1.0.tar.gz
Algorithm Hash digest
SHA256 695dbb732f0a51535370a82a396e87f125cf45ff23f1f32650ef786b5fb16376
MD5 fd2e71d3c97e03111331a4eb16edfa19
BLAKE2b-256 b2afc41a11b76a82759edf0aec775e51211f72614818076a804bc389e3f8d307

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