https://github.com/tekktrik/circuitpython_ticstepper

CircuitPython library for the family of Tic Stepper Motor drivers
https://github.com/tekktrik/circuitpython_ticstepper

Last synced: about 15 hours ago
JSON representation

CircuitPython library for the family of Tic Stepper Motor drivers

• Host: GitHub
• URL: https://github.com/tekktrik/circuitpython_ticstepper
• Owner: tekktrik
• License: mit
• Created: 2022-03-23T15:03:09.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-06-03T19:12:12.000Z (over 2 years ago)
• Last Synced: 2024-09-24T01:59:05.095Z (1 day ago)
• Language: Python
• Homepage:
• Size: 72.3 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Introduction

============

.. image:: https://readthedocs.org/projects/circuitpython-ticstepper/badge/?version=latest

    :target: https://circuitpython-ticstepper.readthedocs.io/

    :alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/tekktrik/CircuitPython_TicStepper/workflows/Build%20CI/badge.svg

    :target: https://github.com/tekktrik/CircuitPython_TicStepper/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

Driver for the TIC stepper motor drivers

Dependencies

============

This driver depends on:

* `Adafruit CircuitPython `_

* `Bus Device `_

* `Register `_

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 `_.

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:

.. code-block:: shell

    pip3 install circuitpython-ticstepper

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

.. code-block:: shell

    sudo pip3 install circuitpython-ticstepper

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name

    python3 -m venv .env

    source .env/bin/activate

    pip3 install circuitpython-ticstepper

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:

.. code-block:: shell

    pip3 install circup

With ``circup`` installed and your CircuitPython device connected use the

following command to install:

.. code-block:: shell

    circup install ticstepper

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example

=============

See examples in the `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.