Adafruit CircuitPython DotStar
==============================
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-dotstar/badge/?version=latest
:target: https://docs.circuitpython.org/projects/dotstar/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_DotStar/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_DotStar/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
Higher level DotStar driver that presents the strip as a sequence. It is the
same api as the `NeoPixel library <https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel>`_.
Colors are stored as tuples by default. However, you can also use int hex syntax
to set values similar to colors on the web. For example, ``0x100000`` (``#100000``
on the web) is equivalent to ``(0x10, 0, 0)``.
If you send a tuple with 4 values, you can control the brightness value, which appears in DotStar but not NeoPixels.
It should be a float. For example, (0xFF,0,0, 1.0) is the brightest red possible, (1,0,0,0.01) is the dimmest red possible.
.. note:: The int hex API represents the brightness of the white pixel when
present by setting the RGB channels to identical values. For example, full
white is 0xffffff but is actually (0xff, 0xff, 0xff) in the tuple syntax.
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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
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-dotstar/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-dotstar
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-dotstar
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-dotstar
Usage Example
=============
This example demonstrates the library with the single built-in DotStar on the
`Trinket M0 <https://www.adafruit.com/product/3500>`_ and
`Gemma M0 <https://www.adafruit.com/product/3501>`_.
.. code-block:: python
import board
import adafruit_dotstar
pixels = adafruit_dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1)
pixels[0] = (10, 0, 0)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/dotstar/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_NeoPixel/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-dotstar",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,dotstar,leds,rgb,spi,addressable,hardware,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/bb/c4/735247935753015c7b479dd864b3c7593724835d510b3941a5862e977539/adafruit-circuitpython-dotstar-2.2.10.tar.gz",
"platform": null,
"description": "\nAdafruit CircuitPython DotStar\n==============================\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-dotstar/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/dotstar/en/latest/\n :alt: Documentation Status\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.. image:: https://github.com/adafruit/Adafruit_CircuitPython_DotStar/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_DotStar/actions/\n :alt: Build Status\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\nHigher level DotStar driver that presents the strip as a sequence. It is the\nsame api as the `NeoPixel library <https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel>`_.\n\nColors are stored as tuples by default. However, you can also use int hex syntax\nto set values similar to colors on the web. For example, ``0x100000`` (``#100000``\non the web) is equivalent to ``(0x10, 0, 0)``.\n\nIf you send a tuple with 4 values, you can control the brightness value, which appears in DotStar but not NeoPixels.\nIt should be a float. For example, (0xFF,0,0, 1.0) is the brightest red possible, (1,0,0,0.01) is the dimmest red possible.\n\n.. note:: The int hex API represents the brightness of the white pixel when\n present by setting the RGB channels to identical values. For example, full\n white is 0xffffff but is actually (0xff, 0xff, 0xff) in the tuple syntax.\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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\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-dotstar/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-dotstar\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-dotstar\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 .venv/bin/activate\n pip3 install adafruit-circuitpython-dotstar\n\nUsage Example\n=============\n\nThis example demonstrates the library with the single built-in DotStar on the\n`Trinket M0 <https://www.adafruit.com/product/3500>`_ and\n`Gemma M0 <https://www.adafruit.com/product/3501>`_.\n\n.. code-block:: python\n\n import board\n import adafruit_dotstar\n\n pixels = adafruit_dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1)\n pixels[0] = (10, 0, 0)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/dotstar/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for DotStar LEDs.",
"version": "2.2.10",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_DotStar"
},
"split_keywords": [
"adafruit",
"dotstar",
"leds",
"rgb",
"spi",
"addressable",
"hardware",
"micropython",
"circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "11162976450c095e31e65a6f591c06aa2b19ef449f15e302d4d67d25343f883f",
"md5": "363e4c5d24434720f7fe3f7e2982bd1b",
"sha256": "3a94543b6503939714b260e221e43f6f63006e10ce225d953c35bae48f94aad9"
},
"downloads": -1,
"filename": "adafruit_circuitpython_dotstar-2.2.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "363e4c5d24434720f7fe3f7e2982bd1b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6103,
"upload_time": "2023-09-25T15:38:54",
"upload_time_iso_8601": "2023-09-25T15:38:54.341082Z",
"url": "https://files.pythonhosted.org/packages/11/16/2976450c095e31e65a6f591c06aa2b19ef449f15e302d4d67d25343f883f/adafruit_circuitpython_dotstar-2.2.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bbc4735247935753015c7b479dd864b3c7593724835d510b3941a5862e977539",
"md5": "5e5927975041f26500ddabcfed3dba13",
"sha256": "562b906e49d407f34998cf6baa99a3eba063f4bfbf83970d19fe352825632c8a"
},
"downloads": -1,
"filename": "adafruit-circuitpython-dotstar-2.2.10.tar.gz",
"has_sig": false,
"md5_digest": "5e5927975041f26500ddabcfed3dba13",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 35552,
"upload_time": "2023-09-25T15:38:55",
"upload_time_iso_8601": "2023-09-25T15:38:55.832221Z",
"url": "https://files.pythonhosted.org/packages/bb/c4/735247935753015c7b479dd864b3c7593724835d510b3941a5862e977539/adafruit-circuitpython-dotstar-2.2.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-25 15:38:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_DotStar",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-dotstar"
}
JSON
