It's easy to use the LTR-329 and the LTR-303 with Python or CircuitPython, and the Adafruit_CircuitPython_LTR329_LTR303 module. This module allows you to easily write Python code that reads the values from the LTR-329 and LTR-303 light sensors. You can use this sensor with any CircuitPython microcontroller board or with a computer that has GPIO and Python thanks to Adafruit_Blinka, our CircuitPython-for-Python compatibility library.
This page focuses heavily on the LTR-329, but using the LTR-303 is basically the same. At the end of the page you'll find an LTR-303-specific example utilizing the int pin.
Wire up an LTR-329 to your board exactly as shown below. Here's an example of wiring a Feather RP2040 to the sensor with I2C using one of the handy STEMMA QT connectors:
- Board 3V to sensor VIN (red wire)
- Board GND to sensor GND (black wire)
- Board SCL to sensor SCL (yellow wire)
- Board SDA to sensor SDA (blue wire)
You can also connect the LTR-329 using standard 0.1" pitch headers to wire it up on a breadboard:
- Board 3V to sensor VIN (red wire)
- Board GND to sensor GND (black wire)
- Board SCL to sensor SCL (yellow wire)
- Board SDA to sensor SDA (blue wire)
Python Computer Wiring
Since there's dozens of Linux computers/boards you can use, below shows wiring for Raspberry Pi. For other platforms, please visit the guide for CircuitPython on Linux to see whether your platform is supported.
Here's the Raspberry Pi wired to the LTR-329 using I2C and a STEMMA QT connector:
- Pi 3V to sensor VIN (red wire)
- Pi GND to sensor GND (black wire)
- Pi SCL to sensor SCL (yellow wire)
- Pi SDA to sensor SDA (blue wire)
Here is the Raspberry Pi wired to the LTR-329 using a solderless breadboard:
- Pi 3V to sensor VIN (red wire)
- Pi GND to sensor GND (black wire)
- Pi SCL to sensor SCL (yellow wire)
- Pi SDA to sensor SDA (blue wire)
Python Installation of LTR329_LTR303 Library
You'll need to install the Adafruit_Blinka library that provides the CircuitPython support in Python. This may also require enabling I2C on your platform and verifying you are running Python 3. Since each platform is a little different, and Linux changes often, please visit the CircuitPython on Linux guide to get your computer ready!
Once that's done, from your command line run the following command:
pip3 install adafruit-circuitpython-ltr329-ltr303
If your default Python is version 3, you may need to run pip
instead. Make sure you aren't trying to use CircuitPython on Python 2.x, it isn't supported!
CircuitPython Usage
To use with CircuitPython, you need to first install the LTR329_LTR303 library, and its dependencies, into the lib folder on your CIRCUITPY drive. Then you need to update code.py with the example script.
Thankfully, we can do this in one go. In the example below, click the Download Project Bundle button below to download the necessary libraries and the code.py file in a zip file. Extract the contents of the zip file, and copy the entire lib folder and the code.py file to your CIRCUITPY drive.
Your CIRCUITPY/lib folder should contain the following folders and file:
- adafruit_bus_device/
- adafruit_register/
- adafruit_ltr329_ltr303.mpy
Python Usage
Once you have the library pip3
installed on your computer, copy or download the following example to your computer, and run the following, replacing code.py with whatever you named the file:
python3 code.py
# SPDX-FileCopyrightText: Copyright (c) 2022 ladyada for Adafruit Industries # # SPDX-License-Identifier: Unlicense import time import board from adafruit_ltr329_ltr303 import LTR329 i2c = board.I2C() # uses board.SCL and board.SDA # i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller time.sleep(0.1) # sensor takes 100ms to 'boot' on power up ltr329 = LTR329(i2c) while True: print("Visible + IR:", ltr329.visible_plus_ir_light) print("Infrared :", ltr329.ir_light) print() time.sleep(0.5) # sleep for half a second
If running CircuitPython: Once everything is saved to the CIRCUITPY drive, connect to the serial console to see the data printed out!
If running Python: The console output will appear wherever you are running Python.
Try covering the sensor with your finger to see the values decrease. Shine a flashlight on the sensor to see them increase.
That's all there is to using the LTR-329 with CircuitPython!
LTR-303 Example
This example is specific to the LTR-303. It enables the interrupt functionality. To see it working, you'll wire up an LED to the pin.
- Board 3V to power rail on breadboard (red wire)
- Sensor VIN to power rail on breadboard (red wire)
- LED + (anode) to power rail on breadboard (red wire)
- Board GND to ground rail on breadboard (black wire)
- Sensor GND to ground rail on breadboard (black wire)
- Board SCL to sensor SCL (yellow wire)
- Board SDA to sensor SDA (blue wire)
- LED - (cathode) to 470Ω resistor
- Sensor INT to 470Ω resistor
Example Code for LTR-303
As explained above, click the Download Project Bundle button below to download the necessary libraries and the code.py file in a zip file. Extract the contents of the zip file, and copy the entire lib folder and the code.py file to your CIRCUITPY drive.
# SPDX-FileCopyrightText: Copyright (c) 2022 ladyada for Adafruit Industries # # SPDX-License-Identifier: Unlicense import time import board import adafruit_ltr329_ltr303 as adafruit_ltr303 i2c = board.I2C() # uses board.SCL and board.SDA # i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller time.sleep(0.1) # sensor takes 100ms to 'boot' on power up ltr303 = adafruit_ltr303.LTR303(i2c) # Can set the ALS light gain, can be: 1, 2, 4, 8, 48 or 96 times # to range from 1~64 kLux to 0.01~600 Lux ltr303.als_gain = 96 print("LTR-303 ALS gain:", ltr303.als_gain) # Can set the ALS measurement integration time, how long the sensor # 'looks' for light data. Default is 100ms. # Set to: 50, 100, 150, 200, 250, 300, 350, or 400 millisec # ltr303.integration_time = 50 print("LTR-303 integration time (ms):", ltr303.integration_time) # Can set the ALS measurement rate, how often the data register updates # Default is 500ms. Must be equal or greater than the integration time # Set to: 50, 100, 200, 500, 1000, 2000 millisec # ltr303.measurement_rate = 500 print("LTR-303 measurement rate (ms):", ltr303.measurement_rate) # Can put into stand-by mode at any time, for low power usage # self.active_mode = False # The LTR-303, unlike the LTR-329, can also generate an IRQ output # The interrupt output can be enabled ltr303.enable_int = True # We can also change whether the polarity is active LOW (False) or HIGH (True) # Default is LOW (False) ltr303.int_polarity = False # Then set the low and high thresholds that would trigger an IRQ! ltr303.threshold_low = 2000 # interrupt goes off if BELOW this number ltr303.threshold_high = 40000 # or ABOVE this number! print("Interrupt thresholds:", ltr303.threshold_low, ltr303.threshold_high) # Finally, we can set how many measurements must be above/below before # we trigger an IRQ - basically avoid spurious readings. A setting of 1 # means every value triggers an int, 2 means two consecutive readings to # trigger... up to 16! ltr303.int_persistence = 4 while True: # The sensor will let us know when the measurement time has # created a new data reading! if ltr303.new_als_data_available: # The sensor can get 'overwhelmed' by bright light if the # gain isn't set right, in which case the data is invalid. # We can check the data invalid first and toss out the reading... if ltr303.als_data_invalid: ltr303.throw_out_reading() # perform & toss out the reading continue # try again next time! # OR we can 'try' to do the read and get an exception if the # data is invalid try: # If we're using `new_als_data_available` we should # read both channels ONCE only! To do that use... visible_plus_ir, ir = ltr303.light_channels # this will get both channels at once! (It's also faster) # Now we can do various math... print("Visible + IR:", visible_plus_ir) print("Infrared :", ir) print("ALS gain: :", ltr303.als_data_gain) print() except ValueError: # we can also check `ltr303.als_data_invalid` if we # want, to verify that print("Light sensor data invalid, trying again!") time.sleep(0.1)
If running CircuitPython: Once everything is saved to the CIRCUITPY drive, connect to the serial console to see the data printed out!
If running Python: The console output will appear wherever you are running Python.
Try covering the sensor with your finger to drop it below the lower threshold. The LED should blink regularly indicating the interrupt has been triggered.
Try shining a flashlight on the sensor to bring it above the upper threshold. You should get the same result from the LED.
That's all there is to using the LTR-303 interrupt functionality!
Text editor powered by tinymce.