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

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_nunchuk-1.1.12.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_nunchuk-1.1.12.tar.gz
Algorithm Hash digest
SHA256 f3da8b6c0141d4dc834e84de842ebb4c6d5d421ae8c98ae5e8c450853e82e259
MD5 533daeb4eb40b559668ca114aab20dcb
BLAKE2b-256 b8bd65c4d9d89b87110683181e807fd02492a865797c9996cd00abfceb974b83

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_nunchuk-1.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 eaca91a9a5321678b8b2bf0cea95a3972540d674e3e526a20883bf357e0447a9
MD5 0a0dc9a8fb8f591ad88d2bf878be99d8
BLAKE2b-256 c6b4f51c3775f2068c13ea334c888b1be097d84f68e83835ee6159a35a8c9e75

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