python-tsl2591 0.1.8

Community-coded Python module for TSL2591 sensor converted from Adafruit's TSL2591 library. Use at your own risk.

TSL2591 Python Library

This is a simple python library for the Adafruit TSL2591 breakout board based on the Arduino library from Adafruit. It was developed to work on a Raspberry PI.

Installation

This module can be installed using pip (and can find a copy of this module on PyPi).

pip install python-tsl2591

Step 1: Enable I2C

You can enable I2C on the Raspberry Pi by following the instructions on Adafruit.

The quick version is:

1. Run sudo raspi-config
2. Select Advanced Options
3. Enable I2C
4. Reboot (sudo reboot)

When testing I2C (sudo i2cdetect -y 1), you should see at least one connected device, your TSL2591 at 0x29. For more information, see the FAQ.

Step 2: Install System dependencies

Prior to using this library, you will need the following packages installed on your Raspberry Pi.

sudo apt-get install python3-dev python3-smbus libffi-dev libssl-dev

Step 3: Install Python dependencies

To install the Python module, download this repository and run:

python setup.py install

Quickstart

from python_tsl2591 import tsl2591

tsl = tsl2591()  # initialize
full, ir = tsl.get_full_luminosity()  # read raw values (full spectrum and ir spectrum)
lux = tsl.calculate_lux(full, ir)  # convert raw values to lux
print lux, full, ir

FAQ

Fatal error

If you do not have those Raspbian packages installed prior to installing this library, you will run into errors that look similar to this.

fatal error: ffi.h: No such file or directory
     #include <ffi.h>
                     ^
compilation terminated.
error: command 'arm-linux-gnueabihf-gcc' failed with exit status 1

I2C Check for Static Address

Because the TSL2591 connects via I2C, it's always good to run the I2C detection to verify the address is being read. Unlike the TSL2561 with programmable addresses, the TSL2591's address is hard coded and cannot be changed - thus it will always show 0x29.

In the example output below, you can see there are two I2C devices detected, one being the TSL2591.

pi@raspberrypi:~ $ sudo i2cdetect -y 1
     0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f
00:          -- -- -- -- -- -- -- -- -- -- -- -- --
10: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
20: -- -- -- -- -- -- -- -- -- 29 -- -- -- -- -- --
30: -- -- -- -- -- -- -- -- -- -- -- -- 3c -- -- --
40: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
50: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
60: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
70: -- -- -- -- -- -- -- --

License

Python files in this repository are released under the MIT license.