1.3.8

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/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
    :target: https://github.com/astral-sh/ruff
    :alt: Code Style: Ruff

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=4000,
        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.