https://github.com/robotastic/circuitpython_usefulsensors_persondetector
https://github.com/robotastic/circuitpython_usefulsensors_persondetector
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/robotastic/circuitpython_usefulsensors_persondetector
- Owner: robotastic
- License: mit
- Created: 2022-10-01T14:00:44.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-06T02:11:28.000Z (over 3 years ago)
- Last Synced: 2025-10-03T06:56:51.611Z (9 months ago)
- Language: Python
- Size: 24.4 KB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Introduction
============
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/robotastic/CircuitPython_UsefulSensors_PersonDetector/workflows/Build%20CI/badge.svg
:target: https://github.com/robotastic/CircuitPython_UsefulSensors_PersonDetector/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
.. todo:: Describe what the library does.
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 `_.Installing from PyPI
=====================
.. note:: This library is not available on PyPI yet. Install documentation is included
as a standard element. Stay tuned for PyPI availability!
.. todo:: Remove the above note if PyPI version is/will be available at time of release.
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI `_.
To install for current user:
.. code-block:: shell
pip3 install circuitpython-usefulsensors-persondetector
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-usefulsensors-persondetector
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 circuitpython-usefulsensors-persondetector
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 usefulsensors_persondetector
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. todo:: Add a quick, simple example. It and other examples should live in the
examples folder and be included in docs/examples.rst.
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.