Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-fruitjam/badge/?version=latest
:target: https://docs.circuitpython.org/projects/fruitjam/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_FruitJam/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_FruitJam/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
Helper library for the FruitJam board
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
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>`_.
`Fruit Jam will be available from the Adafruit shop <http://www.adafruit.com/products/>`_
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-fruitjam/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-fruitjam
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-fruitjam
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-fruitjam
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_fruitjam
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import supervisor
from adafruit_fruitjam.peripherals import request_display_config
print(f"Display is None ? {supervisor.runtime.display is None}")
print(f"size: {supervisor.runtime.display.width}, {supervisor.runtime.display.height}")
request_display_config(360, 200)
print(f"size: {supervisor.runtime.display.width}, {supervisor.runtime.display.height}")
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/fruitjam/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_FruitJam/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-fruitjam",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, fruitjam, hardware, peripherals",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/c6/f5/efc3033cab5436d7ea8c3e1d3c628ef961e70cc2276b052f253295354ae0/adafruit_circuitpython_fruitjam-0.4.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-fruitjam/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/fruitjam/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_FruitJam/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_FruitJam/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nHelper library for the FruitJam board\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\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`Fruit Jam will be available from the Adafruit shop <http://www.adafruit.com/products/>`_\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-fruitjam/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-fruitjam\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-fruitjam\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-fruitjam\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_fruitjam\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 supervisor\n\n from adafruit_fruitjam.peripherals import request_display_config\n\n print(f\"Display is None ? {supervisor.runtime.display is None}\")\n print(f\"size: {supervisor.runtime.display.width}, {supervisor.runtime.display.height}\")\n request_display_config(360, 200)\n print(f\"size: {supervisor.runtime.display.width}, {supervisor.runtime.display.height}\")\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/fruitjam/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_FruitJam/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Helper library for the FruitJam board",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_FruitJam"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" fruitjam",
" hardware",
" peripherals"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "32dc3413d84bb8143d5aec9749cd775849b5c4d9d1a9e56d079fd527b0f5b283",
"md5": "671fe160721fd499186244a5b2f78da8",
"sha256": "151ac704d38ec25a6e1e4929d1aee0dee06ce3784637cbdc21fd0181215f2724"
},
"downloads": -1,
"filename": "adafruit_circuitpython_fruitjam-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "671fe160721fd499186244a5b2f78da8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 13731,
"upload_time": "2025-07-22T13:24:42",
"upload_time_iso_8601": "2025-07-22T13:24:42.245536Z",
"url": "https://files.pythonhosted.org/packages/32/dc/3413d84bb8143d5aec9749cd775849b5c4d9d1a9e56d079fd527b0f5b283/adafruit_circuitpython_fruitjam-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c6f5efc3033cab5436d7ea8c3e1d3c628ef961e70cc2276b052f253295354ae0",
"md5": "07f7b3b717e155af9d274b63a3a05276",
"sha256": "0cabf8f931667607aa74164b732ba3743cce6b9b087cd86dd33c10d900e96679"
},
"downloads": -1,
"filename": "adafruit_circuitpython_fruitjam-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "07f7b3b717e155af9d274b63a3a05276",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29902,
"upload_time": "2025-07-22T13:24:43",
"upload_time_iso_8601": "2025-07-22T13:24:43.563442Z",
"url": "https://files.pythonhosted.org/packages/c6/f5/efc3033cab5436d7ea8c3e1d3c628ef961e70cc2276b052f253295354ae0/adafruit_circuitpython_fruitjam-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-22 13:24:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_FruitJam",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
},
{
"name": "adafruit-circuitpython-tlv320",
"specs": []
},
{
"name": "adafruit-circuitpython-neopixel",
"specs": []
},
{
"name": "adafruit-circuitpython-portalbase",
"specs": []
},
{
"name": "adafruit-circuitpython-esp32spi",
"specs": []
},
{
"name": "adafruit-circuitpython-requests",
"specs": []
},
{
"name": "adafruit-circuitpython-bitmap-font",
"specs": []
},
{
"name": "adafruit-circuitpython-display-text",
"specs": []
}
],
"lcname": "adafruit-circuitpython-fruitjam"
}
JSON
