https://github.com/adafruit/adafruit_circuitpython_si1145

CircuitPython helper library for the SI1145 Digital UV Index IR Visible Light Sensor
https://github.com/adafruit/adafruit_circuitpython_si1145

circuitpython circuitpython-library hacktoberfest python

Last synced: 3 months ago
JSON representation

CircuitPython helper library for the SI1145 Digital UV Index IR Visible Light Sensor

• Host: GitHub
• URL: https://github.com/adafruit/adafruit_circuitpython_si1145
• Owner: adafruit
• License: mit
• Created: 2022-07-19T19:00:19.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-09T17:33:43.000Z (about 1 year ago)
• Last Synced: 2024-04-25T23:20:52.342Z (8 months ago)
• Topics: circuitpython, circuitpython-library, hacktoberfest, python
• Language: Python
• Homepage:
• Size: 62.5 KB
• Stars: 0
• Watchers: 16
• Forks: 5
• Open Issues: 2
• 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-si1145/badge/?version=latest

    :target: https://docs.circuitpython.org/projects/si1145/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_SI1145/workflows/Build%20CI/badge.svg

    :target: https://github.com/adafruit/Adafruit_CircuitPython_SI1145/actions

    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

    :alt: Code Style: Black

CircuitPython helper library for the SI1145 Digital UV Index IR Visible 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 `_

or individual libraries can be installed using

`circup `_.

`Purchase one from the Adafruit shop `_

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-si1145

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-si1145

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name

    python3 -m venv .env

    source .env/bin/activate

    pip3 install adafruit-circuitpython-si1145

Installing to a Connected CircuitPython Device with Circup

==========================================================

Make sure that you have ``circup`` installed in your Python environment.

Install it with the following command if necessary:

.. code-block:: shell

    pip3 install circup

With ``circup`` installed and your CircuitPython device connected use the

following command to install:

.. code-block:: shell

    circup install adafruit_si1145

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example

=============

See example in library.

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.