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.16.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.16.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_nunchuk-1.1.16.tar.gz
Algorithm Hash digest
SHA256 abc697fa2087c3ad12d169ffca4b76c142b00b02f848ba1c2230fe61a638bf10
MD5 ecae292e41a4894b790cdef1d98c307c
BLAKE2b-256 73381752dd84456d25797ee39377f83fef037d5f9f76e330fe9f17700b310104

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_nunchuk-1.1.16-py3-none-any.whl
Algorithm Hash digest
SHA256 712a0cdb9effa8f9bd4a4d645c51cefd0706a2359a5d4c869d96dd216a86b5cc
MD5 adfb67d45b3ac261f5ad1c34570c6852
BLAKE2b-256 ab9ee76979daa87d06f44cea1bd7935e25498e85a4efe07f542c20f364279408

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