Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pio-uart/badge/?version=latest
:target: https://docs.circuitpython.org/projects/pio_uart/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_PIO_UART/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_PIO_UART/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
PIO implementation of CircuitPython UART API
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Adafruit CircuitPython PIOASM <https://github.com/adafruit/Adafruit_CircuitPython_PIOASM>`_
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>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
Works with the Raspberry Pi RP2040 Pico family.
`Purchase one from the Adafruit shop <https://www.adafruit.com/category/875>`_.
Installing from PyPI
=====================
.. note:: This library is not available on PyPI yet. Install documentation is included
as a standard element. Stay tuned for PyPI availability!
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-pio-uart/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-pio-uart
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-pio-uart
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 adafruit-circuitpython-pio-uart
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 adafruit_pio_uart
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import board
import adafruit_pio_uart
uart = adafruit_pio_uart.UART(board.TX, board.RX)
uart.write(b"\x00")
print(uart.read(1))
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pio_uart/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_PIO_UART/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-pio-uart",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, pio_uart",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/46/a6/a0f45f3e0fee697506903b883b2820c1e729d392d22f140f4a84f0830c6d/adafruit_circuitpython_pio_uart-1.0.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pio-uart/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/pio_uart/en/latest/\n :alt: Documentation Status\n\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\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_PIO_UART/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_PIO_UART/actions\n :alt: Build Status\n\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\nPIO implementation of CircuitPython UART API\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Adafruit CircuitPython PIOASM <https://github.com/adafruit/Adafruit_CircuitPython_PIOASM>`_\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>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nWorks with the Raspberry Pi RP2040 Pico family.\n\n`Purchase one from the Adafruit shop <https://www.adafruit.com/category/875>`_.\n\nInstalling from PyPI\n=====================\n.. note:: This library is not available on PyPI yet. Install documentation is included\n as a standard element. Stay tuned for PyPI availability!\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-pio-uart/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-pio-uart\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-pio-uart\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 adafruit-circuitpython-pio-uart\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install adafruit_pio_uart\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import board\n import adafruit_pio_uart\n\n uart = adafruit_pio_uart.UART(board.TX, board.RX)\n\n uart.write(b\"\\x00\")\n print(uart.read(1))\n\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pio_uart/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`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_PIO_UART/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "PIO implementation of CircuitPython UART API",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_PIO_UART"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" pio_uart"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ae19429972fec8f44516fcdf282ef7552c47fc002cb646fd95b66c16bd744c63",
"md5": "56af219d57272b7cb6e484254e03abf6",
"sha256": "e71799775cf08dcc6fe73e558b155933238aa6b4e797b37c9d091afc43ea08b2"
},
"downloads": -1,
"filename": "adafruit_circuitpython_pio_uart-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "56af219d57272b7cb6e484254e03abf6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6016,
"upload_time": "2024-10-12T01:04:29",
"upload_time_iso_8601": "2024-10-12T01:04:29.082794Z",
"url": "https://files.pythonhosted.org/packages/ae/19/429972fec8f44516fcdf282ef7552c47fc002cb646fd95b66c16bd744c63/adafruit_circuitpython_pio_uart-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "46a6a0f45f3e0fee697506903b883b2820c1e729d392d22f140f4a84f0830c6d",
"md5": "20a3cc32197ba9f6e3d1627a64fe330c",
"sha256": "641ccf3b535c092f6c20098ff341e572f36242da347d572bb7338579c8b33654"
},
"downloads": -1,
"filename": "adafruit_circuitpython_pio_uart-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "20a3cc32197ba9f6e3d1627a64fe330c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27790,
"upload_time": "2024-10-12T01:04:30",
"upload_time_iso_8601": "2024-10-12T01:04:30.220907Z",
"url": "https://files.pythonhosted.org/packages/46/a6/a0f45f3e0fee697506903b883b2820c1e729d392d22f140f4a84f0830c6d/adafruit_circuitpython_pio_uart-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-12 01:04:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_PIO_UART",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-pioasm",
"specs": []
}
],
"lcname": "adafruit-circuitpython-pio-uart"
}
JSON
