adafruit-circuitpython-pioasm


Nameadafruit-circuitpython-pioasm JSON
Version 1.2.1 PyPI version JSON
download
home_pageNone
SummarySimple assembler to convert pioasm to bytes
upload_time2024-10-07 22:32:13
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython pioasm rp2040
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pioasm/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/pioasm/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_PIOASM/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_PIOASM/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

Simple assembler to convert pioasm to bytes


Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.

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-pioasm/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-pioasm

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-pioasm

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

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

.. code-block:: python

    import time
    import rp2pio
    import board
    import adafruit_pioasm

    squarewave = """
    .program squarewave
        set pins 1 [1]  ; Drive pin high and then delay for one cycle
        set pins 0      ; Drive pin low
    """

    assembled = adafruit_pioasm.assemble(squarewave)

    sm = rp2pio.StateMachine(
        assembled,
        frequency=2000,
        init=adafruit_pioasm.assemble("set pindirs 1"),
        first_set_pin=board.LED,
    )
    print("real frequency", sm.frequency)

    time.sleep(120)

Documentation
=============

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pioasm/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_PIOASM/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-pioasm",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, blinka, circuitpython, micropython, pioasm, rp2040",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/23/7c/04b82b23e94b5dfb071e24c0293287c2dcbd92a2f57105a581bd2eabe4d6/adafruit_circuitpython_pioasm-1.2.1.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pioasm/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/pioasm/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_PIOASM/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_PIOASM/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\nSimple assembler to convert pioasm to bytes\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\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://circuitpython.org/libraries>`_.\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-pioasm/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-pioasm\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-pioasm\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-pioasm\n\nUsage Example\n=============\n\n.. code-block:: python\n\n    import time\n    import rp2pio\n    import board\n    import adafruit_pioasm\n\n    squarewave = \"\"\"\n    .program squarewave\n        set pins 1 [1]  ; Drive pin high and then delay for one cycle\n        set pins 0      ; Drive pin low\n    \"\"\"\n\n    assembled = adafruit_pioasm.assemble(squarewave)\n\n    sm = rp2pio.StateMachine(\n        assembled,\n        frequency=2000,\n        init=adafruit_pioasm.assemble(\"set pindirs 1\"),\n        first_set_pin=board.LED,\n    )\n    print(\"real frequency\", sm.frequency)\n\n    time.sleep(120)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pioasm/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_PIOASM/blob/master/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Simple assembler to convert pioasm to bytes",
    "version": "1.2.1",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_PIOASM"
    },
    "split_keywords": [
        "adafruit",
        " blinka",
        " circuitpython",
        " micropython",
        " pioasm",
        " rp2040"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "002fdcd8367d23ea20d4d827a627044d0b5500a1f58a94ded962b97ac0808b8f",
                "md5": "408d734c9085ca4320c066aafcaf7d26",
                "sha256": "9de8fb9a0a79da73a2c7b9d6442c69dfc09c873b3516e1bf56206427ea65cbb5"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_pioasm-1.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "408d734c9085ca4320c066aafcaf7d26",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 8733,
            "upload_time": "2024-10-07T22:32:12",
            "upload_time_iso_8601": "2024-10-07T22:32:12.322526Z",
            "url": "https://files.pythonhosted.org/packages/00/2f/dcd8367d23ea20d4d827a627044d0b5500a1f58a94ded962b97ac0808b8f/adafruit_circuitpython_pioasm-1.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "237c04b82b23e94b5dfb071e24c0293287c2dcbd92a2f57105a581bd2eabe4d6",
                "md5": "0d1b96a839a092de8d5b138bb8c71762",
                "sha256": "1234e0a997886325aeee776f88a6add3906664ab8ac31024649b03f3e964f68b"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_pioasm-1.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "0d1b96a839a092de8d5b138bb8c71762",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 58449,
            "upload_time": "2024-10-07T22:32:13",
            "upload_time_iso_8601": "2024-10-07T22:32:13.825248Z",
            "url": "https://files.pythonhosted.org/packages/23/7c/04b82b23e94b5dfb071e24c0293287c2dcbd92a2f57105a581bd2eabe4d6/adafruit_circuitpython_pioasm-1.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-07 22:32:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_PIOASM",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-pioasm"
}
        
Elapsed time: 0.34832s