Skip to main content

CircuitPython library for Nintendo Nunchuk controller

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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 adafruit_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.18.tar.gz (23.7 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_nunchuk-1.1.18.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_nunchuk-1.1.18.tar.gz
Algorithm Hash digest
SHA256 90dbf00c02ecf4ab4fc9ae9fc99136b22d29e854ef70dc918cd28a27d5ff5fee
MD5 1a4475d4ac59311077c5034ea0898517
BLAKE2b-256 a171d96468398b1b8c2b04b23713c0741cc4996ab56721ee0b5855b032147d8b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_nunchuk-1.1.18-py3-none-any.whl
Algorithm Hash digest
SHA256 0e13c6ea160005d39c0b3ecd0b149d797de261551228a222c52231f3673fe7ac
MD5 76de7e1557d90bc77cc937db75b4fe56
BLAKE2b-256 ddb5fbbf75df8bcc83e3a06b2cd55f7ede3abb8f88e1a9b0cb1dd3bf272e46df

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