README.rst

Introduction

Library for the LTR559 Proximity/Presence/Light Sensor

Dependencies

This driver depends on:

• Adafruit CircuitPython
• Bus Device
• Register

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

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!

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install pimoroni-circuitpython-ltr559

To install system-wide (this may be required in some cases):

sudo pip3 install pimoroni-circuitpython-ltr559

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install pimoroni-circuitpython-ltr559

Usage Example

import time
from board import SCL, SDA
from busio import I2C
from pimoroni_circuitpython_ltr559 import Pimoroni_LTR559

I2C_BUS = I2C(SCL, SDA)
LTR559 = Pimoroni_LTR559(I2C_BUS)

while True:
    print(LTR559.lux)  # Get Lux value from light sensor
    print(LTR559.prox)  # Get Proximity value from proximity sensor
    time.sleep(1.0)

Contributing

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

Documentation

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