Skip to main content

Introduction

Documentation Status Discord Build Status Code Style: Black

This convenience library makes coding for the Crickit robotics boards simpler and shorter.

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.

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-crickit

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-crickit

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-crickit

Usage Example

This examples shows how to control all the devices supported by the library. In most cases you just need a couple of imports.

# This is a mock example showing typical usage of the library for each kind of device.

from adafruit_crickit import crickit

# Add this import if using stepper motors.
# It will expose constants saying how to step: stepper.FORWARD, stepper.BACKWARD, etc.
from adafruit_motor import stepper

# Set servo 1 to 90 degrees
crickit.servo_1.angle = 90

# Change servo settings.
crickit.servo_1.actuation_range = 135
crickit.servo_1.set_pulse_width_range(min_pulse=850, max_pulse=2100)

# You can assign a device to a variable to get a shorter name.
servo_2 = crickit.servo_2
servo_2.throttle = 0

# Run a continous servo on Servo 2 backwards at half speed.
crickit.continuous_servo_2.throttle = -0.5

# Run the motor on Motor 1 terminals at half speed.
crickit.dc_motor_1.throttle = 0.5

# Set Drive 1 terminal to 3/4 strength.
crickit.drive_1.fraction = 0.75

if crickit.touch_1.value:
    print("Touched terminal Touch 1")

# A single stepper motor uses up all the motor terminals.
crickit.stepper_motor.onestep(direction=stepper.FORWARD)

# You can also use the Drive terminals for a stepper motor
crickit.drive_stepper_motor.onestep(direction=stepper.BACKWARD)

# Note: On CPX Crickit, NeoPixel pin is normally connected to A1, not to seesaw,
# so this part of the demo cannot control the NeoPixel terminal.
# Strip or ring of 8 NeoPixels
crickit.init_neopixel(8)
crickit.neopixel.fill((100, 100, 100))

# Set the Crickit's on-board NeoPixel to a dim purple.
crickit.onboard_pixel.brightness = 0.01
crickit.onboard_pixel[0] = (255, 24, 255)
# or
crickit.onboard_pixel.fill((255, 24, 255))

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.

Metadata

Release files for adafruit-circuitpython-crickit 2.3.17

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adafruit-circuitpython-crickit 2.3.17
File Size Uploaded
adafruit-circuitpython-crickit-2.3.17.tar.gz 29.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for adafruit-circuitpython-crickit 2.3.17
File Interpreter ABI Platform
adafruit_circuitpython_crickit-2.3.17-py3-none-any.whl Python 3 none any Details

Total release size: 37.3 kB

Release files / adafruit-circuitpython-crickit-2.3.17.tar.gz

Download URL adafruit-circuitpython-crickit-2.3.17.tar.gz
Size 29.8 kB
Tags Source
SHA-256 checksum
How to use checksums
ba7d3cc477402d908469683e7318f14966583185f5174c5e6a40283050c45e37
BLAKE2b-256 checksum
How to use checksums
1650a5e7116e2bd8de84835bdca3c72b7fcea02c7d6b08b47c456f9fc60bbcbe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.7

Release files / adafruit_circuitpython_crickit-2.3.17-py3-none-any.whl

Download URL adafruit_circuitpython_crickit-2.3.17-py3-none-any.whl
Size 7.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
900e02cca7b230a1a77971c900d995e2a5fa5c048e9f7e040c43a1cc94c37d93
BLAKE2b-256 checksum
How to use checksums
487a02b694b91235ede886114d2563e5a99f6c547a85879341ae94ef8d7a3279
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.7

Release history Release notifications | RSS feed

2.3.24

2 release files

2.3.23

2 release files

2.3.22

2 release files

2.3.21

2 release files

2.3.20

2 release files

2.3.19

2 release files

This release

2.3.17 This release

2 release files

2.3.16

2 release files

2.3.14

2 release files

2.3.13

2 release files

2.3.12

2 release files

2.3.11

2 release files

2.3.9

1 release file

2.3.8

1 release file

2.3.7

1 release file

2.3.6

1 release file

2.3.5

1 release file

2.3.4

1 release file

2.3.3

1 release file

2.3.2

1 release file

2.3.1

1 release file

2.3.0

1 release file

2.2.1

1 release file

2.2.0

1 release file

2.1.6

1 release file

2.1.5

1 release file

2.1.4

1 release file

2.1.3

1 release file

2.1.2

1 release file

2.1.1

1 release file

2.1.0

1 release file

2.0.2

1 release file

2.0.1

1 release file

1.0.2

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page