Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-monsterm4sk/badge/?version=latest
:target: https://docs.circuitpython.org/projects/monsterm4sk/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_MonsterM4sk/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_MonsterM4sk/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
Helper library for the Monster M4sk device. Allows usage of screens and other built-in hardware.
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>`_
* `Seesaw <https://github.com/adafruit/Adafruit_CircuitPython_seesaw>`_
* `LIS3DH <https://github.com/adafruit/Adafruit_CircuitPython_LIS3DH>`_
* `ST7789 <https://github.com/adafruit/Adafruit_CircuitPython_ST7789>`_
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>`_.
Installing from PyPI
=====================
.. note:: This library will not be available on PyPI. Install documentation is included
as a standard element.
Usage Example
=============
.. code-block:: python
import board
import displayio
from adafruit_display_shapes.circle import Circle
import adafruit_monsterm4sk
SCREEN_SIZE = 240
i2c_bus = board.I2C()
mask = adafruit_monsterm4sk.MonsterM4sk(i2c=i2c_bus)
left_group = displayio.Group()
mask.left_display.root_group = left_group
right_group = displayio.Group()
mask.right_display.root_group = right_group
right_circle = Circle(SCREEN_SIZE // 2, SCREEN_SIZE // 2, 40, fill=0x0000FF)
right_group.append(right_circle)
left_circle = Circle(SCREEN_SIZE // 2, SCREEN_SIZE // 2, 40, fill=0x00AA66)
left_group.append(left_circle)
while True:
pass
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/monsterm4sk/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_MonsterM4sk/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-monsterm4sk",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,monsterm4sk,microcontroller,display,breakout,hardwaremicropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/1e/9f/9d57cc93c2b49f71f2cb1dfd14e3b52cabd79f840d3bf9d11d0cc011eed7/adafruit-circuitpython-monsterm4sk-1.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-monsterm4sk/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/monsterm4sk/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_MonsterM4sk/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_MonsterM4sk/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\nHelper library for the Monster M4sk device. Allows usage of screens and other built-in hardware.\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* `Seesaw <https://github.com/adafruit/Adafruit_CircuitPython_seesaw>`_\n* `LIS3DH <https://github.com/adafruit/Adafruit_CircuitPython_LIS3DH>`_\n* `ST7789 <https://github.com/adafruit/Adafruit_CircuitPython_ST7789>`_\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>`_.\n\nInstalling from PyPI\n=====================\n.. note:: This library will not be available on PyPI. Install documentation is included\n as a standard element.\n\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import board\n import displayio\n from adafruit_display_shapes.circle import Circle\n import adafruit_monsterm4sk\n\n SCREEN_SIZE = 240\n\n i2c_bus = board.I2C()\n\n mask = adafruit_monsterm4sk.MonsterM4sk(i2c=i2c_bus)\n\n left_group = displayio.Group()\n mask.left_display.root_group = left_group\n\n right_group = displayio.Group()\n mask.right_display.root_group = right_group\n\n right_circle = Circle(SCREEN_SIZE // 2, SCREEN_SIZE // 2, 40, fill=0x0000FF)\n right_group.append(right_circle)\n\n left_circle = Circle(SCREEN_SIZE // 2, SCREEN_SIZE // 2, 40, fill=0x00AA66)\n left_group.append(left_circle)\n while True:\n pass\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/monsterm4sk/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_MonsterM4sk/blob/master/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Helper library for the MONSTER M4SK device. Allows usage of screens and other built-in hardware.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_MONSTERM4SK"
},
"split_keywords": [
"adafruit",
"monsterm4sk",
"microcontroller",
"display",
"breakout",
"hardwaremicropython",
"circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b98346ba4a58ace252f3236819407e481fa40703c7cb5eae6e39225ff0b06470",
"md5": "4735ece1769abfb6f308d383565db36d",
"sha256": "dbb0ee8293e730592b338eb9b35a61a5218d1abaad3ef22325e77e23843ff407"
},
"downloads": -1,
"filename": "adafruit_circuitpython_monsterm4sk-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4735ece1769abfb6f308d383565db36d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5806,
"upload_time": "2023-11-03T13:28:05",
"upload_time_iso_8601": "2023-11-03T13:28:05.177754Z",
"url": "https://files.pythonhosted.org/packages/b9/83/46ba4a58ace252f3236819407e481fa40703c7cb5eae6e39225ff0b06470/adafruit_circuitpython_monsterm4sk-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1e9f9d57cc93c2b49f71f2cb1dfd14e3b52cabd79f840d3bf9d11d0cc011eed7",
"md5": "4e0bf7cb40d3a8a899aaacc51a2805b3",
"sha256": "f3e333d514fb80c60a0f4161970c996b347b753e7314187b25177e8bccb6170c"
},
"downloads": -1,
"filename": "adafruit-circuitpython-monsterm4sk-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "4e0bf7cb40d3a8a899aaacc51a2805b3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 36639,
"upload_time": "2023-11-03T13:28:08",
"upload_time_iso_8601": "2023-11-03T13:28:08.963506Z",
"url": "https://files.pythonhosted.org/packages/1e/9f/9d57cc93c2b49f71f2cb1dfd14e3b52cabd79f840d3bf9d11d0cc011eed7/adafruit-circuitpython-monsterm4sk-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-03 13:28:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_MONSTERM4SK",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-monsterm4sk"
}
JSON
