Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-husb238/badge/?version=latest
:target: https://docs.circuitpython.org/projects/husb238/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_HUSB238/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_HUSB238/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 helper library for the HUSB238 Type C Power Delivery Dummy Breakout
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
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>`_.
The HUSB238 USB PD sink chip is neat in that you can either use jumpers (really, resistor selection) to set the desired power delivery voltage and current or you can use I2C for dynamic querying and setting.
We've built a nice Adafruit USB Type C Power Delivery Dummy Breakout board around the HUSB238 to make it very easy to configure and integrate without having to solder any tiny resistors.
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5807>`_
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-husb238/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-husb238
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-husb238
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-husb238
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_husb238
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import time
import board
import adafruit_husb238
i2c = board.I2C()
# Initialize HUSB238
pd = adafruit_husb238.Adafruit_HUSB238(i2c)
voltages = pd.available_voltages()
v = 0
while True:
if pd.is_attached():
print(f"Setting to {voltages[v]}V!")
pd.value = voltages[v]
pd.set_value()
current = pd.read_current()
volts = pd.read_voltage()
response = pd.get_response()
print(f"The PD chip returned a response of: {response}")
print(f"It is set to {volts}V/{current}")
print()
v = (v + 1) % len(voltages)
time.sleep(2)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/husb238/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_HUSB238/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-husb238",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,husb238,usb,pd",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/55/39/0b47e7f9187809456774d59d414b5fd538dc6ed9ad06651ab05373ace3b5/adafruit-circuitpython-husb238-1.0.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-husb238/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/husb238/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_HUSB238/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_HUSB238/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 helper library for the HUSB238 Type C Power Delivery Dummy Breakout\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\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\nThe HUSB238 USB PD sink chip is neat in that you can either use jumpers (really, resistor selection) to set the desired power delivery voltage and current or you can use I2C for dynamic querying and setting.\n\nWe've built a nice Adafruit USB Type C Power Delivery Dummy Breakout board around the HUSB238 to make it very easy to configure and integrate without having to solder any tiny resistors.\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5807>`_\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-husb238/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-husb238\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-husb238\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-husb238\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_husb238\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 time\n import board\n import adafruit_husb238\n\n i2c = board.I2C()\n\n # Initialize HUSB238\n pd = adafruit_husb238.Adafruit_HUSB238(i2c)\n voltages = pd.available_voltages()\n\n v = 0\n\n while True:\n if pd.is_attached():\n print(f\"Setting to {voltages[v]}V!\")\n pd.value = voltages[v]\n pd.set_value()\n current = pd.read_current()\n volts = pd.read_voltage()\n response = pd.get_response()\n print(f\"The PD chip returned a response of: {response}\")\n print(f\"It is set to {volts}V/{current}\")\n print()\n v = (v + 1) % len(voltages)\n time.sleep(2)\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/husb238/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_HUSB238/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython helper library for the HUSB238 Type C Power Delivery Dummy Breakout",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_HUSB238"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"husb238",
"usb",
"pd"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2f0fe70e8dadecf7c388beff3ebe070cddc4859a517e4ca5d47c0cf679018bbb",
"md5": "55bd0f78b2bd2155a6973f1017a40db6",
"sha256": "9c67e7aecf1c6f1e45518f51eacd25da01b187e221a53746d0627c5d80a6d4fd"
},
"downloads": -1,
"filename": "adafruit_circuitpython_husb238-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "55bd0f78b2bd2155a6973f1017a40db6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6145,
"upload_time": "2023-11-27T21:47:09",
"upload_time_iso_8601": "2023-11-27T21:47:09.307122Z",
"url": "https://files.pythonhosted.org/packages/2f/0f/e70e8dadecf7c388beff3ebe070cddc4859a517e4ca5d47c0cf679018bbb/adafruit_circuitpython_husb238-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "55390b47e7f9187809456774d59d414b5fd538dc6ed9ad06651ab05373ace3b5",
"md5": "dbe7462dbf40c8b997b1fd5bdb2c92b7",
"sha256": "5a809f93e53d7914fadce02ea9cecf2703eefd72b76a7dc7d64b3cfd2c3a30b3"
},
"downloads": -1,
"filename": "adafruit-circuitpython-husb238-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "dbe7462dbf40c8b997b1fd5bdb2c92b7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27554,
"upload_time": "2023-11-27T21:47:10",
"upload_time_iso_8601": "2023-11-27T21:47:10.855394Z",
"url": "https://files.pythonhosted.org/packages/55/39/0b47e7f9187809456774d59d414b5fd538dc6ed9ad06651ab05373ace3b5/adafruit-circuitpython-husb238-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-27 21:47:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_HUSB238",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
},
{
"name": "adafruit-circuitpython-register",
"specs": []
}
],
"lcname": "adafruit-circuitpython-husb238"
}
JSON
