https://github.com/adafruit/adafruit_circuitpython_tsl2561
CircuitPython driver for TSL2561 Light Sensor
https://github.com/adafruit/adafruit_circuitpython_tsl2561
circuitpython hacktoberfest
Last synced: 7 months ago
JSON representation
CircuitPython driver for TSL2561 Light Sensor
- Host: GitHub
- URL: https://github.com/adafruit/adafruit_circuitpython_tsl2561
- Owner: adafruit
- License: mit
- Created: 2017-10-23T22:28:06.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2025-06-17T16:28:58.000Z (9 months ago)
- Last Synced: 2025-09-01T21:08:06.867Z (7 months ago)
- Topics: circuitpython, hacktoberfest
- Language: Python
- Size: 129 KB
- Stars: 4
- Watchers: 19
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-tsl2561/badge/?version=latest
:target: https://docs.circuitpython.org/projects/tsl2561/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_TSL2561/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_TSL2561/actions/
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
CircuitPython driver for TSL2561 Light Sensor.
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 `_.
Installing from PyPI
====================
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 adafruit-circuitpython-tsl2561
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-tsl2561
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-tsl2561
Usage Example
=============
.. code-block:: python
>>> import board
>>> import busio
>>> i2c = busio.I2C(board.SCL, board.SDA)
>>> import adafruit_tsl2561
>>> tsl = adafruit_tsl2561.TSL2561(i2c)
>>> tsl.lux
3294.37
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.