micropython-motor


Namemicropython-motor JSON
Version 0.1.0 PyPI version JSON
download
home_page
SummaryMicroPython Helpers for controlling PWM based motors and servos
upload_time2023-07-09 00:02:47
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords sensor micropython motor micropython pwm motor servo drv8833
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============


.. image:: https://readthedocs.org/projects/micropython-motor/badge/?version=latest
    :target: https://micropython-motor.readthedocs.io/en/latest/
    :alt: Documentation Status


.. image:: https://img.shields.io/badge/micropython-Ok-purple.svg
    :target: https://micropython.org
    :alt: micropython

.. image:: https://img.shields.io/pypi/v/micropython-motor.svg
    :alt: latest version on PyPI
    :target: https://pypi.python.org/pypi/micropython-motor

.. image:: https://static.pepy.tech/personalized-badge/micropython-motor?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Pypi%20Downloads
    :alt: Total PyPI downloads
    :target: https://pepy.tech/project/micropython-motor

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Code Style: Black

MicroPython Helpers for controlling PWM based motors and servos This has been adapted to use in the
Raspberry Pi Pico from the excellent Adafruit_CircuitPython_Motor Library here:
https://github.com/adafruit/Adafruit_CircuitPython_Motor

This library can work with other MCU (Not tested) that used the following PWM methods:

* freq
* duty_u16

Sadly do not have the hardware to test the step motor part of the library so, this will
be an exercise for the reader.:)


Installing with mip
====================
To install using mpremote

.. code-block:: shell

    mpremote mip install github:jposada202020/MicroPython_MOTOR

To install directly using a WIFI capable board

.. code-block:: shell

    mip install github:jposada202020/MicroPython_MOTOR


Installing Library Examples
============================

If you want to install library examples:

.. code-block:: shell

    mpremote mip install github:jposada202020/MicroPython_MOTOR/examples.json

To install directly using a WIFI capable board

.. code-block:: shell

    mip install github:jposada202020/MicroPython_MOTOR/examples.json


Installing from PyPI
=====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/micropython-motor/>`_.
To install for current user:

.. code-block:: shell

    pip3 install micropython-motor

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

.. code-block:: shell

    sudo pip3 install micropython-motor

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .venv
    source .env/bin/activate
    pip3 install micropython-motor


Usage Example
=============

Take a look at the examples directory

Documentation
=============
API documentation for this library can be found on `Read the Docs <https://micropython-motor.readthedocs.io/en/latest/>`_.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "micropython-motor",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "sensor,micropython,motor,micropython,pwm,motor,servo,drv8833",
    "author": "",
    "author_email": "JDM <xxyx@mailmeto.mozmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/8f/e3/7c0ec1de0b003bbfe96c9d9bb4ed1dbeb9fb095720b87b7b0b46f00cb4ee/micropython-motor-0.1.0.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/micropython-motor/badge/?version=latest\n    :target: https://micropython-motor.readthedocs.io/en/latest/\n    :alt: Documentation Status\n\n\n.. image:: https://img.shields.io/badge/micropython-Ok-purple.svg\n    :target: https://micropython.org\n    :alt: micropython\n\n.. image:: https://img.shields.io/pypi/v/micropython-motor.svg\n    :alt: latest version on PyPI\n    :target: https://pypi.python.org/pypi/micropython-motor\n\n.. image:: https://static.pepy.tech/personalized-badge/micropython-motor?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Pypi%20Downloads\n    :alt: Total PyPI downloads\n    :target: https://pepy.tech/project/micropython-motor\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\nMicroPython Helpers for controlling PWM based motors and servos This has been adapted to use in the\nRaspberry Pi Pico from the excellent Adafruit_CircuitPython_Motor Library here:\nhttps://github.com/adafruit/Adafruit_CircuitPython_Motor\n\nThis library can work with other MCU (Not tested) that used the following PWM methods:\n\n* freq\n* duty_u16\n\nSadly do not have the hardware to test the step motor part of the library so, this will\nbe an exercise for the reader.:)\n\n\nInstalling with mip\n====================\nTo install using mpremote\n\n.. code-block:: shell\n\n    mpremote mip install github:jposada202020/MicroPython_MOTOR\n\nTo install directly using a WIFI capable board\n\n.. code-block:: shell\n\n    mip install github:jposada202020/MicroPython_MOTOR\n\n\nInstalling Library Examples\n============================\n\nIf you want to install library examples:\n\n.. code-block:: shell\n\n    mpremote mip install github:jposada202020/MicroPython_MOTOR/examples.json\n\nTo install directly using a WIFI capable board\n\n.. code-block:: shell\n\n    mip install github:jposada202020/MicroPython_MOTOR/examples.json\n\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/micropython-motor/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n    pip3 install micropython-motor\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install micropython-motor\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 .env/bin/activate\n    pip3 install micropython-motor\n\n\nUsage Example\n=============\n\nTake a look at the examples directory\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://micropython-motor.readthedocs.io/en/latest/>`_.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "MicroPython Helpers for controlling PWM based motors and servos",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/jposada202020/MicroPython_MOTOR"
    },
    "split_keywords": [
        "sensor",
        "micropython",
        "motor",
        "micropython",
        "pwm",
        "motor",
        "servo",
        "drv8833"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e773a7076fc24319994e12ad44c05c0d1fd4f99f35c86f693561720545872932",
                "md5": "fb98ad85d4706e39ced7299d0364b510",
                "sha256": "09e744875511cc72fe6cdcb7e02de41db240b899c5cd23399acdb911ed9bef19"
            },
            "downloads": -1,
            "filename": "micropython_motor-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fb98ad85d4706e39ced7299d0364b510",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6646,
            "upload_time": "2023-07-09T00:02:45",
            "upload_time_iso_8601": "2023-07-09T00:02:45.895116Z",
            "url": "https://files.pythonhosted.org/packages/e7/73/a7076fc24319994e12ad44c05c0d1fd4f99f35c86f693561720545872932/micropython_motor-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8fe37c0ec1de0b003bbfe96c9d9bb4ed1dbeb9fb095720b87b7b0b46f00cb4ee",
                "md5": "fbd84bb9271a8ee2f49a942b872beb5e",
                "sha256": "9c7b053728e0e993f938b498e668b72f16f2377fbdaa0b3f076fd24601131471"
            },
            "downloads": -1,
            "filename": "micropython-motor-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "fbd84bb9271a8ee2f49a942b872beb5e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 18478,
            "upload_time": "2023-07-09T00:02:47",
            "upload_time_iso_8601": "2023-07-09T00:02:47.639464Z",
            "url": "https://files.pythonhosted.org/packages/8f/e3/7c0ec1de0b003bbfe96c9d9bb4ed1dbeb9fb095720b87b7b0b46f00cb4ee/micropython-motor-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-09 00:02:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jposada202020",
    "github_project": "MicroPython_MOTOR",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "micropython-motor"
}
        
Elapsed time: 0.27926s