Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ch9328/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ch9328/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_CH9328/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_CH9328/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
CircuitPython driver for the CH9328 UART to HID keyboard breakout
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>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5973>`_
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-ch9328/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-ch9328
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-ch9328
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-ch9328
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_ch9328
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import board
import busio
import time
from adafruit_ch9328.ch9328 import Adafruit_CH9328
from adafruit_ch9328.ch9328_keymap import Keymap
# Initialize UART for the CH9328
uart = busio.UART(board.TX, board.RX, baudrate=9600)
ch9328 = Adafruit_CH9328(uart)
ch9328.send_string("Hello World!")
# Send the backspace key 12 times to erase the string
keys = [Keymap.BACKSPACE, 0, 0, 0, 0, 0] # Keycode for backspace in US mapping
no_keys_pressed = [0, 0, 0, 0, 0, 0]
for _ in range(12):
ch9328.send_key_press(keys, 0) # Press
ch9328.send_key_press(no_keys_pressed, 0) # Release the key
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ch9328/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_CH9328/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-ch9328",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, ch9328, UART",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/26/29/5cc525694c9e2688c407ab4502fc01ff4e895d7cba9203ddb2bfd1b5f406/adafruit_circuitpython_ch9328-1.0.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ch9328/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ch9328/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_CH9328/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_CH9328/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\nCircuitPython driver for the CH9328 UART to HID keyboard breakout\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>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5973>`_\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-ch9328/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-ch9328\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-ch9328\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-ch9328\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_ch9328\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 busio\n import time\n from adafruit_ch9328.ch9328 import Adafruit_CH9328\n from adafruit_ch9328.ch9328_keymap import Keymap\n\n # Initialize UART for the CH9328\n uart = busio.UART(board.TX, board.RX, baudrate=9600)\n ch9328 = Adafruit_CH9328(uart)\n\n ch9328.send_string(\"Hello World!\")\n\n # Send the backspace key 12 times to erase the string\n keys = [Keymap.BACKSPACE, 0, 0, 0, 0, 0] # Keycode for backspace in US mapping\n no_keys_pressed = [0, 0, 0, 0, 0, 0]\n for _ in range(12):\n ch9328.send_key_press(keys, 0) # Press\n ch9328.send_key_press(no_keys_pressed, 0) # Release the key\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ch9328/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_CH9328/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython driver for the CH9328 UART to HID keyboard breakout",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_CH9328"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" ch9328",
" uart"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eadf7f6d24006c208e31ce64443663a686bde67cde6ca333feda41e9c4d60b70",
"md5": "6159626b6a31a34e7d19febb4653d478",
"sha256": "35fee20d95ae0e15824deb2b6b03426a06251f4cc4628a2d285c160f57fe1bf4"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ch9328-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6159626b6a31a34e7d19febb4653d478",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6888,
"upload_time": "2024-10-07T21:38:29",
"upload_time_iso_8601": "2024-10-07T21:38:29.944488Z",
"url": "https://files.pythonhosted.org/packages/ea/df/7f6d24006c208e31ce64443663a686bde67cde6ca333feda41e9c4d60b70/adafruit_circuitpython_ch9328-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "26295cc525694c9e2688c407ab4502fc01ff4e895d7cba9203ddb2bfd1b5f406",
"md5": "6604aca6d2bec8cb68a5c81414b90f3e",
"sha256": "699b7b867c6d7d55cb27a1974a6c5d633eb31ea1c2ac116b5ba310563f7be872"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ch9328-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "6604aca6d2bec8cb68a5c81414b90f3e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28347,
"upload_time": "2024-10-07T21:38:30",
"upload_time_iso_8601": "2024-10-07T21:38:30.776825Z",
"url": "https://files.pythonhosted.org/packages/26/29/5cc525694c9e2688c407ab4502fc01ff4e895d7cba9203ddb2bfd1b5f406/adafruit_circuitpython_ch9328-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 21:38:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_CH9328",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-ch9328"
}
JSON
