Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/adafruit/adafruit_circuitpython_pycamera

Library for the Adafruit PyCamera
https://github.com/adafruit/adafruit_circuitpython_pycamera

adafruit circuitpython esp32s3 ov5640 python

Last synced: 10 days ago
JSON representation

Library for the Adafruit PyCamera

Awesome Lists containing this project

README

        

Introduction
============

.. image:: https://readthedocs.org/projects/circuitpython-pycamera/badge/?version=latest
:target: https://docs.circuitpython.org/projects/pycamera/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_PyCamera/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_PyCamera/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

Library for the Adafruit PyCamera

Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython `_
* `Bus Device `_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle `_
or individual libraries can be installed using
`circup `_.

.. ::
`Purchase one from the Adafruit shop `_

Installing from PyPI
=====================

This package is available on PyPI so that it can be installed by Thonny. It is
not useful to install this package from PyPI on a Windows, Mac, or Linux
computer.

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_pycamera

Or the following command to update an existing version:

.. code-block:: shell

circup update

Usage Example
=============

.. code-block: python

from adafruit_pycamera import PyCamera

pycam = PyCamera()

while True:
new_frame = pycam.continuous_capture()
# .. do something with new_frame

Documentation
=============
API documentation for this library can be found on `Read the Docs `_.

For information on building library documentation, please check out
`this guide `_.

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
`_
before contributing to help this project stay welcoming.