https://github.com/dyadica/circuitpython_paa5100ej

A Circuit-Python library for the PAA5100EJ
https://github.com/dyadica/circuitpython_paa5100ej

circuit-python circuitpython micropython optical-flow paa5100ej pmw3901 python rp2040 sensor

Last synced: 2 months ago
JSON representation

A Circuit-Python library for the PAA5100EJ

• Host: GitHub
• URL: https://github.com/dyadica/circuitpython_paa5100ej
• Owner: dyadica
• License: mit
• Created: 2022-01-26T13:03:00.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-02-16T15:22:11.000Z (almost 3 years ago)
• Last Synced: 2024-10-09T22:42:00.251Z (2 months ago)
• Topics: circuit-python, circuitpython, micropython, optical-flow, paa5100ej, pmw3901, python, rp2040, sensor
• Language: Python
• Homepage: https://dyadica.github.io/blog/a-circuit-python-library-for-the-PAA5100JE/
• Size: 11.7 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PAA5100JE 2-Dimensional Optical Flow Sensor

![The PAA5100EJ](https://dyadica.github.io/wp-content/uploads/2022/02/16/PA5100EJ_Breadboard_1.jpg)

This repo contains a quick and dirty Circuit-python port of the [Pimoroni](https://github.com/pimoroni/pmw3901-python) PMW3901/PAA5100EJ sensor library. Its the very first thing Ive done in either Python/Circuit-python so ain’t too pretty :) In addition to the aforementioned Pimoroni library; this library was also greatly inspired/aided by the Arduino port by [Bitcraze](https://github.com/bitcraze/Bitcraze_PMW3901)

## About the library

A full breakdown of the library, its code and how to use it can be found via an accompanying post [here](https://dyadica.github.io/blog/a-circuit-python-library-for-the-PAA5100JE/).

## Prerequisites

Assuming you already have an already complete Circuit-python installation; in order to use this library you will need to install the [Adafruit_Circuit_BusDevice library](https://github.com/adafruit/Adafruit_CircuitPython_BusDevice). This library can be locatated via the previous link or installed via the following pip command:

```

pip3 install adafruit-circuitpython-busdevice

```

## Installing

One you have installed the required prerequisites all you need to do is place the file paa5100ej.py in your designated library location and the file code.py in its corresponding location on your Circuit-python drive (usually the root). 

### Notes

1. This code has only been tested via Adafruit CircuitPython 7.1.1 on an Adafruit Feather RP2040 with rp2040 via Thonny

2. The code has been targeted for the PAA5100JE only; modification to the init/secret registers may be needed to make it work with the pmw3901. I have updated the code to include these too!

3. The product page for the used PAA5100JE can be found [here](https://shop.pimoroni.com/products/paa5100je-optical-tracking-spi-breakout).

4. An accompanying post for the library can be found [here](https://dyadica.github.io/blog/a-circuit-python-library-for-the-PAA5100JE/).

5. Enjoy ;)

NB: Since completing the library I discovered an official Pico one for Micropython by Pimoroni so that may be a better option for you? This can be found [here](https://github.com/pimoroni/pimoroni-pico) At a glance it looks like there may be a few more hoops to go in order to get things up and going; however, I have not tried and/or look into using it yet. Please see their readme for more details!