Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-crickit/badge/?version=latest
:target: https://docs.circuitpython.org/projects/crickit/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Crickit/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_Crickit/actions/
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
This convenience library makes coding for the Crickit robotics boards simpler and shorter.
Dependencies
=============
This driver depends on:
* `Adafruit seesaw library <https://github.com/adafruit/Adafruit_Circuitpython_seesaw>`_
* `Adafruit Motor library <https://github.com/adafruit/Adafruit_Circuitpython_Motor>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-crickit/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-crickit
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-crickit
To install in a virtual environment in your current project:
.. code-block:: shell
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.
.. code-block:: python
# 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 <https://docs.circuitpython.org/projects/crickit/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_Crickit/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-crickit",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, crickit, robotics, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/f3/0c/f99fe6ad31043a782f7766c1dfaa94052b7910694608effa978b6bd9bdab/adafruit_circuitpython_crickit-2.3.18.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-crickit/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/crickit/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Crickit/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Crickit/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nThis convenience library makes coding for the Crickit robotics boards simpler and shorter.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit seesaw library <https://github.com/adafruit/Adafruit_Circuitpython_seesaw>`_\n* `Adafruit Motor library <https://github.com/adafruit/Adafruit_Circuitpython_Motor>`_\n\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-crickit/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-crickit\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-crickit\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-crickit\n\nUsage Example\n=============\n\nThis examples shows how to control all the devices supported by the library.\nIn most cases you just need a couple of imports.\n\n.. code-block:: python\n\n # This is a mock example showing typical usage of the library for each kind of device.\n\n from adafruit_crickit import crickit\n\n # Add this import if using stepper motors.\n # It will expose constants saying how to step: stepper.FORWARD, stepper.BACKWARD, etc.\n from adafruit_motor import stepper\n\n # Set servo 1 to 90 degrees\n crickit.servo_1.angle = 90\n\n # Change servo settings.\n crickit.servo_1.actuation_range = 135\n crickit.servo_1.set_pulse_width_range(min_pulse=850, max_pulse=2100)\n\n # You can assign a device to a variable to get a shorter name.\n servo_2 = crickit.servo_2\n servo_2.throttle = 0\n\n # Run a continous servo on Servo 2 backwards at half speed.\n crickit.continuous_servo_2.throttle = -0.5\n\n # Run the motor on Motor 1 terminals at half speed.\n crickit.dc_motor_1.throttle = 0.5\n\n # Set Drive 1 terminal to 3/4 strength.\n crickit.drive_1.fraction = 0.75\n\n if crickit.touch_1.value:\n print(\"Touched terminal Touch 1\")\n\n # A single stepper motor uses up all the motor terminals.\n crickit.stepper_motor.onestep(direction=stepper.FORWARD)\n\n # You can also use the Drive terminals for a stepper motor\n crickit.drive_stepper_motor.onestep(direction=stepper.BACKWARD)\n\n # Note: On CPX Crickit, NeoPixel pin is normally connected to A1, not to seesaw,\n # so this part of the demo cannot control the NeoPixel terminal.\n # Strip or ring of 8 NeoPixels\n crickit.init_neopixel(8)\n crickit.neopixel.fill((100, 100, 100))\n\n # Set the Crickit's on-board NeoPixel to a dim purple.\n crickit.onboard_pixel.brightness = 0.01\n crickit.onboard_pixel[0] = (255, 24, 255)\n # or\n crickit.onboard_pixel.fill((255, 24, 255))\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/crickit/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_Crickit/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for controlling a Crickit robotics board.",
"version": "2.3.18",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Crickit"
},
"split_keywords": [
"adafruit",
" crickit",
" robotics",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c5e67fbf179b744c96443b8f36d45c8fb98ce46d61e13c4208128c4cfb87c969",
"md5": "17428a40083fb0a296307238f4e15cf0",
"sha256": "df72da78d182fe3680aa6675b66c25af8167b08487ff311cc26fb1f4080e3b86"
},
"downloads": -1,
"filename": "adafruit_circuitpython_crickit-2.3.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "17428a40083fb0a296307238f4e15cf0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7454,
"upload_time": "2024-10-07T21:42:32",
"upload_time_iso_8601": "2024-10-07T21:42:32.904471Z",
"url": "https://files.pythonhosted.org/packages/c5/e6/7fbf179b744c96443b8f36d45c8fb98ce46d61e13c4208128c4cfb87c969/adafruit_circuitpython_crickit-2.3.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f30cf99fe6ad31043a782f7766c1dfaa94052b7910694608effa978b6bd9bdab",
"md5": "5cb4455a1f16079dc0420d1fecdb856d",
"sha256": "e27f7a6a3d2b7e5da488e8412e2c2588018bbfb1b994c3638f298567470b039a"
},
"downloads": -1,
"filename": "adafruit_circuitpython_crickit-2.3.18.tar.gz",
"has_sig": false,
"md5_digest": "5cb4455a1f16079dc0420d1fecdb856d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29816,
"upload_time": "2024-10-07T21:42:35",
"upload_time_iso_8601": "2024-10-07T21:42:35.313034Z",
"url": "https://files.pythonhosted.org/packages/f3/0c/f99fe6ad31043a782f7766c1dfaa94052b7910694608effa978b6bd9bdab/adafruit_circuitpython_crickit-2.3.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 21:42:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Crickit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-seesaw",
"specs": []
},
{
"name": "adafruit-circuitpython-motor",
"specs": []
}
],
"lcname": "adafruit-circuitpython-crickit"
}
JSON
