adafruit-mirror/Adafruit_CircuitPython_OPT4048
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

initial files

Browse source
This commit is contained in:
foamyguy 2025-05-22 16:37:56 -05:00
parent 77b1e8856b
commit 20233d4c4b
31 changed files with 1989 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
.gitattributes vendored Normal file
View file

@ -0,0 +1,11 @@
# SPDX-FileCopyrightText: 2024 Justin Myers
#
# SPDX-License-Identifier: Unlicense
.py text eol=lf
.rst text eol=lf
.txt text eol=lf
.yaml text eol=lf
.toml text eol=lf
.license text eol=lf
.md text eol=lf

13
.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md vendored Normal file
View file

@ -0,0 +1,13 @@
# SPDX-FileCopyrightText: 2021 Adafruit Industries
#
# SPDX-License-Identifier: MIT
Thank you for contributing! Before you submit a pull request, please read the following.
Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://docs.circuitpython.org/en/latest/docs/design_guide.html
If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs
Before submitting the pull request, make sure you've run Pylint and Black locally on your code. You can do this manually or using pre-commit. Instructions are available here: https://adafru.it/check-your-code
Please remove all of this text before submitting. Include an explanation or list of changes included in your PR, as well as, if applicable, a link to any related issues.

14
.github/workflows/build.yml vendored Normal file
View file

@ -0,0 +1,14 @@
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
#
# SPDX-License-Identifier: MIT
name: Build CI
on: [pull_request, push]
jobs:
test:
runs-on: ubuntu-latest
steps:
- name: Run Build CI workflow
uses: adafruit/workflows-circuitpython-libs/build@main

19
.github/workflows/failure-help-text.yml vendored Normal file
View file

@ -0,0 +1,19 @@
# SPDX-FileCopyrightText: 2021 Scott Shawcroft for Adafruit Industries
#
# SPDX-License-Identifier: MIT
name: Failure help text
on:
workflow_run:
workflows: ["Build CI"]
types:
- completed
jobs:
post-help:
runs-on: ubuntu-latest
if: ${{ github.event.workflow_run.conclusion == 'failure' && github.event.workflow_run.event == 'pull_request' }}
steps:
- name: Post comment to help
uses: adafruit/circuitpython-action-library-ci-failed@v1

19
.github/workflows/release_gh.yml vendored Normal file
View file

@ -0,0 +1,19 @@
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
#
# SPDX-License-Identifier: MIT
name: GitHub Release Actions
on:
release:
types: [published]
jobs:
upload-release-assets:
runs-on: ubuntu-latest
steps:
- name: Run GitHub Release CI workflow
uses: adafruit/workflows-circuitpython-libs/release-gh@main
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
upload-url: ${{ github.event.release.upload_url }}

19
.github/workflows/release_pypi.yml vendored Normal file
View file

@ -0,0 +1,19 @@
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
#
# SPDX-License-Identifier: MIT
name: PyPI Release Actions
on:
release:
types: [published]
jobs:
upload-release-assets:
runs-on: ubuntu-latest
steps:
- name: Run PyPI Release CI workflow
uses: adafruit/workflows-circuitpython-libs/release-pypi@main
with:
pypi-username: ${{ secrets.pypi_username }}
pypi-password: ${{ secrets.pypi_password }}

21
.pre-commit-config.yaml Normal file
View file

@ -0,0 +1,21 @@
# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
#
# SPDX-License-Identifier: Unlicense
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0
hooks:
- id: check-yaml
- id: end-of-file-fixer
- id: trailing-whitespace
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.3.4
hooks:
- id: ruff-format
- id: ruff
args: ["--fix"]
- repo: https://github.com/fsfe/reuse-tool
rev: v3.0.1
hooks:
- id: reuse

22
.readthedocs.yaml Normal file
View file

@ -0,0 +1,22 @@
# SPDX-FileCopyrightText: 2021 Melissa LeBlanc-Williams for Adafruit Industries
#
# SPDX-License-Identifier: Unlicense
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
sphinx:
configuration: docs/conf.py
build:
os: ubuntu-lts-latest
tools:
python: "3"
python:
install:
- requirements: docs/requirements.txt
- requirements: requirements.txt

158
CODE_OF_CONDUCT.md Normal file
View file

@ -0,0 +1,158 @@
<!--
SPDX-FileCopyrightText: 2014 Coraline Ada Ehmke
SPDX-FileCopyrightText: 2019-2021 Kattni Rembor for Adafruit Industries
SPDX-License-Identifier: CC-BY-4.0
-->
# Adafruit Community Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and leaders pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level or type of
experience, education, socio-economic status, nationality, personal appearance,
race, religion, or sexual identity and orientation.
## Our Standards
We are committed to providing a friendly, safe and welcoming environment for
all.
Examples of behavior that contributes to creating and maintaining a positive environment
include:
* Be kind and courteous to others
* Using welcoming and inclusive language
* Respecting the identity of every community member, including asking for their
pronouns if uncertain
* Being respectful of differing viewpoints and experiences
* Collaborating with other community members
* Providing desired assistance and knowledge to other community members
* Being open to new information and ideas
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by community members include:
* The use of sexualized language or imagery and sexual attention or advances
* The use of inappropriate images, including in a community member's avatar
* The use of inappropriate language or profanity, including in a community member's nickname
* Any spamming, flaming, baiting or other attention-stealing behavior
* Excessive or unwelcome helping; answering outside the scope of the question
asked
* Discussion or promotion of activities or projects that intend or pose a risk of
significant harm
* Trolling, insulting/derogatory comments, and attacks of any nature (including,
but not limited to, personal or political attacks)
* Promoting or spreading disinformation, lies, or conspiracy theories against
a person, group, organisation, project, or community
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Engaging in behavior that creates an unwelcoming or uninclusive environment
* Other conduct which could reasonably be considered inappropriate
The Adafruit Community welcomes everyone and strives to create a safe space for all. It is built
around sharing and contributing to technology. We encourage discussing your thoughts, experiences,
and feelings within the scope of the community. However, there are topics that can sometimes stray
from that scope, and can lead to hurting others and create an unwelcoming, uninclusive environment.
Examples of discussion topics that have been known to stray outside the scope of the Adafruit
Community include, but are not limited to:
* Discussions regarding religion and related topics
* Discussions regarding politics and related topics
The goal of the standards and moderation guidelines outlined here is to build
and maintain a respectful community. We ask that you don’t just aim to be
"technically unimpeachable", but rather try to be your best self.
We value many things beyond technical expertise, including collaboration and
supporting others within our community. Providing a positive experience for
other community members can have a much more significant impact than simply
providing the correct answer.
## Our Responsibilities
Project leaders are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project leaders have the right and responsibility to remove, edit, or
reject messages, comments, commits, code, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any community member for other behaviors that they deem
inappropriate, threatening, offensive, or harmful.
## Moderation
Instances of behaviors that violate the Adafruit Community Code of Conduct
may be reported by any member of the community. Community members are
encouraged to report these situations, including situations they witness
involving other community members.
You may report in the following ways:
In any situation, you may email <support@adafruit.com>.
On the Adafruit Discord, you may send an open message from any channel
to all Community Moderators by tagging @community moderators. You may
also send an open message from the #help-with-community channel, or a
direct message to any Community Moderator.
The source of email and direct message reports will be kept confidential.
In situations on Discord where the issue is particularly offensive, possibly
illegal, requires immediate action, or violates the Discord terms of service,
you should also report the message directly to [Discord](https://discord.com/safety).
These are the steps for upholding our community’s standards of conduct.
1. Any member of the community may report any situation that violates the
Adafruit Community Code of Conduct. All reports will be reviewed and
investigated.
2. If the behavior is a severe violation, the community member who
committed the violation may be banned immediately, without warning.
3. Otherwise, moderators will first respond to such behavior with a warning.
4. Moderators follow a soft "three strikes" policy - the community member may
be given another chance, if they are receptive to the warning and change their
behavior.
5. If the community member is unreceptive or unreasonable when warned by a
moderator, or the warning goes unheeded, they may be banned for a first or
second offense. Repeated offenses will result in the community member being
banned.
6. Disciplinary actions (warnings, bans, etc) for Code of Conduct violations apply
to the platform where the violation occurred. However, depending on the severity
of the violation, the disciplinary action may be applied across Adafruit's other
community platforms. For example, a severe violation on the Adafruit Discord
server may result in a ban on not only the Adafruit Discord server, but also on
the Adafruit GitHub organisation, Adafruit Forums, Adafruit Twitter, etc.
## Scope
This Code of Conduct and the enforcement policies listed above apply to all
Adafruit Community venues. This includes but is not limited to any community
spaces (both public and private), the entire Adafruit Discord server, and
Adafruit GitHub repositories. Examples of Adafruit Community spaces include
but are not limited to meet-ups, audio chats on the Adafruit Discord, or
interaction at a conference.
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. As a community
member, you are representing our community, and are expected to behave
accordingly.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/),
version 1.4, available on [contributor-covenant.org](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html),
and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html).
For other projects adopting the Adafruit Community Code of
Conduct, please contact the maintainers of those projects for enforcement.
If you wish to use this code of conduct for your own project, consider
explicitly mentioning your moderation policy or making a copy with your
own moderation policy so as to avoid confusion.

21
LICENSE Normal file
View file

@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2025 Tim C for Adafruit Industries
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

324
LICENSES/CC-BY-4.0.txt Normal file
View file

@ -0,0 +1,324 @@
Creative Commons Attribution 4.0 International Creative Commons Corporation
("Creative Commons") is not a law firm and does not provide legal services
or legal advice. Distribution of Creative Commons public licenses does not
create a lawyer-client or other relationship. Creative Commons makes its licenses
and related information available on an "as-is" basis. Creative Commons gives
no warranties regarding its licenses, any material licensed under their terms
and conditions, or any related information. Creative Commons disclaims all
liability for damages resulting from their use to the fullest extent possible.
Using Creative Commons Public Licenses
Creative Commons public licenses provide a standard set of terms and conditions
that creators and other rights holders may use to share original works of
authorship and other material subject to copyright and certain other rights
specified in the public license below. The following considerations are for
informational purposes only, are not exhaustive, and do not form part of our
licenses.
Considerations for licensors: Our public licenses are intended for use by
those authorized to give the public permission to use material in ways otherwise
restricted by copyright and certain other rights. Our licenses are irrevocable.
Licensors should read and understand the terms and conditions of the license
they choose before applying it. Licensors should also secure all rights necessary
before applying our licenses so that the public can reuse the material as
expected. Licensors should clearly mark any material not subject to the license.
This includes other CC-licensed material, or material used under an exception
or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors
Considerations for the public: By using one of our public licenses, a licensor
grants the public permission to use the licensed material under specified
terms and conditions. If the licensor's permission is not necessary for any
reason–for example, because of any applicable exception or limitation to copyright–then
that use is not regulated by the license. Our licenses grant only permissions
under copyright and certain other rights that a licensor has authority to
grant. Use of the licensed material may still be restricted for other reasons,
including because others have copyright or other rights in the material. A
licensor may make special requests, such as asking that all changes be marked
or described. Although not required by our licenses, you are encouraged to
respect those requests where reasonable. More considerations for the public
: wiki.creativecommons.org/Considerations_for_licensees Creative Commons Attribution
4.0 International Public License
By exercising the Licensed Rights (defined below), You accept and agree to
be bound by the terms and conditions of this Creative Commons Attribution
4.0 International Public License ("Public License"). To the extent this Public
License may be interpreted as a contract, You are granted the Licensed Rights
in consideration of Your acceptance of these terms and conditions, and the
Licensor grants You such rights in consideration of benefits the Licensor
receives from making the Licensed Material available under these terms and
conditions.
Section 1 – Definitions.
a. Adapted Material means material subject to Copyright and Similar Rights
that is derived from or based upon the Licensed Material and in which the
Licensed Material is translated, altered, arranged, transformed, or otherwise
modified in a manner requiring permission under the Copyright and Similar
Rights held by the Licensor. For purposes of this Public License, where the
Licensed Material is a musical work, performance, or sound recording, Adapted
Material is always produced where the Licensed Material is synched in timed
relation with a moving image.
b. Adapter's License means the license You apply to Your Copyright and Similar
Rights in Your contributions to Adapted Material in accordance with the terms
and conditions of this Public License.
c. Copyright and Similar Rights means copyright and/or similar rights closely
related to copyright including, without limitation, performance, broadcast,
sound recording, and Sui Generis Database Rights, without regard to how the
rights are labeled or categorized. For purposes of this Public License, the
rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
d. Effective Technological Measures means those measures that, in the absence
of proper authority, may not be circumvented under laws fulfilling obligations
under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996,
and/or similar international agreements.
e. Exceptions and Limitations means fair use, fair dealing, and/or any other
exception or limitation to Copyright and Similar Rights that applies to Your
use of the Licensed Material.
f. Licensed Material means the artistic or literary work, database, or other
material to which the Licensor applied this Public License.
g. Licensed Rights means the rights granted to You subject to the terms and
conditions of this Public License, which are limited to all Copyright and
Similar Rights that apply to Your use of the Licensed Material and that the
Licensor has authority to license.
h. Licensor means the individual(s) or entity(ies) granting rights under this
Public License.
i. Share means to provide material to the public by any means or process that
requires permission under the Licensed Rights, such as reproduction, public
display, public performance, distribution, dissemination, communication, or
importation, and to make material available to the public including in ways
that members of the public may access the material from a place and at a time
individually chosen by them.
j. Sui Generis Database Rights means rights other than copyright resulting
from Directive 96/9/EC of the European Parliament and of the Council of 11
March 1996 on the legal protection of databases, as amended and/or succeeded,
as well as other essentially equivalent rights anywhere in the world.
k. You means the individual or entity exercising the Licensed Rights under
this Public License. Your has a corresponding meaning.
Section 2 – Scope.
a. License grant.
1. Subject to the terms and conditions of this Public License, the Licensor
hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive,
irrevocable license to exercise the Licensed Rights in the Licensed Material
to:
A. reproduce and Share the Licensed Material, in whole or in part; and
B. produce, reproduce, and Share Adapted Material.
2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions
and Limitations apply to Your use, this Public License does not apply, and
You do not need to comply with its terms and conditions.
3. Term. The term of this Public License is specified in Section 6(a).
4. Media and formats; technical modifications allowed. The Licensor authorizes
You to exercise the Licensed Rights in all media and formats whether now known
or hereafter created, and to make technical modifications necessary to do
so. The Licensor waives and/or agrees not to assert any right or authority
to forbid You from making technical modifications necessary to exercise the
Licensed Rights, including technical modifications necessary to circumvent
Effective Technological Measures. For purposes of this Public License, simply
making modifications authorized by this Section 2(a)(4) never produces Adapted
Material.
5. Downstream recipients.
A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed
Material automatically receives an offer from the Licensor to exercise the
Licensed Rights under the terms and conditions of this Public License.
B. No downstream restrictions. You may not offer or impose any additional
or different terms or conditions on, or apply any Effective Technological
Measures to, the Licensed Material if doing so restricts exercise of the Licensed
Rights by any recipient of the Licensed Material.
6. No endorsement. Nothing in this Public License constitutes or may be construed
as permission to assert or imply that You are, or that Your use of the Licensed
Material is, connected with, or sponsored, endorsed, or granted official status
by, the Licensor or others designated to receive attribution as provided in
Section 3(a)(1)(A)(i).
b. Other rights.
1. Moral rights, such as the right of integrity, are not licensed under this
Public License, nor are publicity, privacy, and/or other similar personality
rights; however, to the extent possible, the Licensor waives and/or agrees
not to assert any such rights held by the Licensor to the limited extent necessary
to allow You to exercise the Licensed Rights, but not otherwise.
2. Patent and trademark rights are not licensed under this Public License.
3. To the extent possible, the Licensor waives any right to collect royalties
from You for the exercise of the Licensed Rights, whether directly or through
a collecting society under any voluntary or waivable statutory or compulsory
licensing scheme. In all other cases the Licensor expressly reserves any right
to collect such royalties.
Section 3 – License Conditions.
Your exercise of the Licensed Rights is expressly made subject to the following
conditions.
a. Attribution.
1. If You Share the Licensed Material (including in modified form), You must:
A. retain the following if it is supplied by the Licensor with the Licensed
Material:
i. identification of the creator(s) of the Licensed Material and any others
designated to receive attribution, in any reasonable manner requested by the
Licensor (including by pseudonym if designated);
ii. a copyright notice;
iii. a notice that refers to this Public License;
iv. a notice that refers to the disclaimer of warranties;
v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
B. indicate if You modified the Licensed Material and retain an indication
of any previous modifications; and
C. indicate the Licensed Material is licensed under this Public License, and
include the text of, or the URI or hyperlink to, this Public License.
2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner
based on the medium, means, and context in which You Share the Licensed Material.
For example, it may be reasonable to satisfy the conditions by providing a
URI or hyperlink to a resource that includes the required information.
3. If requested by the Licensor, You must remove any of the information required
by Section 3(a)(1)(A) to the extent reasonably practicable.
4. If You Share Adapted Material You produce, the Adapter's License You apply
must not prevent recipients of the Adapted Material from complying with this
Public License.
Section 4 – Sui Generis Database Rights.
Where the Licensed Rights include Sui Generis Database Rights that apply to
Your use of the Licensed Material:
a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract,
reuse, reproduce, and Share all or a substantial portion of the contents of
the database;
b. if You include all or a substantial portion of the database contents in
a database in which You have Sui Generis Database Rights, then the database
in which You have Sui Generis Database Rights (but not its individual contents)
is Adapted Material; and
c. You must comply with the conditions in Section 3(a) if You Share all or
a substantial portion of the contents of the database.
For the avoidance of doubt, this Section 4 supplements and does not replace
Your obligations under this Public License where the Licensed Rights include
other Copyright and Similar Rights.
Section 5 – Disclaimer of Warranties and Limitation of Liability.
a. Unless otherwise separately undertaken by the Licensor, to the extent possible,
the Licensor offers the Licensed Material as-is and as-available, and makes
no representations or warranties of any kind concerning the Licensed Material,
whether express, implied, statutory, or other. This includes, without limitation,
warranties of title, merchantability, fitness for a particular purpose, non-infringement,
absence of latent or other defects, accuracy, or the presence or absence of
errors, whether or not known or discoverable. Where disclaimers of warranties
are not allowed in full or in part, this disclaimer may not apply to You.
b. To the extent possible, in no event will the Licensor be liable to You
on any legal theory (including, without limitation, negligence) or otherwise
for any direct, special, indirect, incidental, consequential, punitive, exemplary,
or other losses, costs, expenses, or damages arising out of this Public License
or use of the Licensed Material, even if the Licensor has been advised of
the possibility of such losses, costs, expenses, or damages. Where a limitation
of liability is not allowed in full or in part, this limitation may not apply
to You.
c. The disclaimer of warranties and limitation of liability provided above
shall be interpreted in a manner that, to the extent possible, most closely
approximates an absolute disclaimer and waiver of all liability.
Section 6 – Term and Termination.
a. This Public License applies for the term of the Copyright and Similar Rights
licensed here. However, if You fail to comply with this Public License, then
Your rights under this Public License terminate automatically.
b. Where Your right to use the Licensed Material has terminated under Section
6(a), it reinstates:
1. automatically as of the date the violation is cured, provided it is cured
within 30 days of Your discovery of the violation; or
2. upon express reinstatement by the Licensor.
c. For the avoidance of doubt, this Section 6(b) does not affect any right
the Licensor may have to seek remedies for Your violations of this Public
License.
d. For the avoidance of doubt, the Licensor may also offer the Licensed Material
under separate terms or conditions or stop distributing the Licensed Material
at any time; however, doing so will not terminate this Public License.
e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
Section 7 – Other Terms and Conditions.
a. The Licensor shall not be bound by any additional or different terms or
conditions communicated by You unless expressly agreed.
b. Any arrangements, understandings, or agreements regarding the Licensed
Material not stated herein are separate from and independent of the terms
and conditions of this Public License.
Section 8 – Interpretation.
a. For the avoidance of doubt, this Public License does not, and shall not
be interpreted to, reduce, limit, restrict, or impose conditions on any use
of the Licensed Material that could lawfully be made without permission under
this Public License.
b. To the extent possible, if any provision of this Public License is deemed
unenforceable, it shall be automatically reformed to the minimum extent necessary
to make it enforceable. If the provision cannot be reformed, it shall be severed
from this Public License without affecting the enforceability of the remaining
terms and conditions.
c. No term or condition of this Public License will be waived and no failure
to comply consented to unless expressly agreed to by the Licensor.
d. Nothing in this Public License constitutes or may be interpreted as a limitation
upon, or waiver of, any privileges and immunities that apply to the Licensor
or You, including from the legal processes of any jurisdiction or authority.
Creative Commons is not a party to its public licenses. Notwithstanding, Creative
Commons may elect to apply one of its public licenses to material it publishes
and in those instances will be considered the "Licensor." The text of the
Creative Commons public licenses is dedicated to the public domain under the
CC0 Public Domain Dedication. Except for the limited purpose of indicating
that material is shared under a Creative Commons public license or as otherwise
permitted by the Creative Commons policies published at creativecommons.org/policies,
Creative Commons does not authorize the use of the trademark "Creative Commons"
or any other trademark or logo of Creative Commons without its prior written
consent including, without limitation, in connection with any unauthorized
modifications to any of its public licenses or any other arrangements, understandings,
or agreements concerning use of licensed material. For the avoidance of doubt,
this paragraph does not form part of the public licenses.
Creative Commons may be contacted at creativecommons.org.

19
LICENSES/MIT.txt Normal file
View file

@ -0,0 +1,19 @@
MIT License Copyright (c) <year> <copyright holders>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next
paragraph) shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

20
LICENSES/Unlicense.txt Normal file
View file

@ -0,0 +1,20 @@
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute
this software, either in source code form or as a compiled binary, for any
purpose, commercial or non-commercial, and by any means.
In jurisdictions that recognize copyright laws, the author or authors of this
software dedicate any and all copyright interest in the software to the public
domain. We make this dedication for the benefit of the public at large and
to the detriment of our heirs and successors. We intend this dedication to
be an overt act of relinquishment in perpetuity of all present and future
rights to this software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH
THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information,
please refer to <https://unlicense.org/>

119
README.rst Normal file
View file

@ -0,0 +1,119 @@
Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-opt4048/badge/?version=latest
:target: https://docs.circuitpython.org/projects/opt4048/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_OPT4048/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_OPT4048/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 library for the Adafruit OPT4048 breakout board, a high-speed, high-precision tristimulus XYZ color sensor.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
.. todo:: Describe the Adafruit product this library works with. For PCBs, you can also add the
image from the assets folder in the PCB's GitHub repo.
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/6335>`_
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!
.. todo:: Remove the above note if PyPI version is/will be available at time of release.
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-opt4048/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-opt4048
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-opt4048
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-opt4048
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_opt4048
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. todo:: Add a quick, simple example. It and other examples should live in the
examples folder and be included in docs/examples.rst.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/opt4048/en/latest/>`_.
For information on building library documentation, please check out
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_OPT4048/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

3
README.rst.license Normal file
View file

@ -0,0 +1,3 @@
SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
SPDX-FileCopyrightText: Copyright (c) 2025 Tim C for Adafruit Industries
SPDX-License-Identifier: MIT

720
adafruit_opt4048.py Normal file
View file

@ -0,0 +1,720 @@
# SPDX-FileCopyrightText: Copyright (c) 2025 Tim C for Adafruit Industries
#
# SPDX-License-Identifier: MIT
"""
`adafruit_opt4048`
================================================================================
CircuitPython driver library for the Adafruit OPT4048 breakout board, a high-speed,
high-precision tristimulus XYZ color sensor.
* Author(s): Tim C
Implementation Notes
--------------------
**Hardware:**
* `Adafruit OPT4048 Breakout <https://www.adafruit.com/products/6335>`_
**Software and Dependencies:**
* Adafruit CircuitPython firmware for the supported boards:
https://circuitpython.org/downloads
# * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
# * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
"""
# imports
__version__ = "0.0.0+auto.0"
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_OPT4048.git"
from time import sleep
from adafruit_bus_device import i2c_device
from adafruit_register.i2c_bit import RWBit
from adafruit_register.i2c_bits import ROBits, RWBits
from adafruit_register.i2c_struct import UnaryStruct
from micropython import const
try:
from typing import ClassVar, Optional, Tuple
import busio
except ImportError:
pass
__version__ = "0.0.0+auto.0"
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_OPT4048.git"
# Correct content of DEVICE_ID register
_OPT4048_CHIP_ID = const(0x0821) # OPT4048 default device id
class CV:
"""Constant value class helper for enums."""
# @classmethod
# def add_values(cls, value_tuples: Tuple[str, int, str, Optional[float]]) -> None:
# """Add CV values to the class"""
# cls.string = {}
# cls.lsb = {}
#
# for value_tuple in value_tuples:
# name, value, string, lsb = value_tuple
# setattr(cls, name, value)
# cls.string[value] = string
# cls.lsb[value] = lsb
@classmethod
def is_valid(cls, value: int) -> bool:
"""Validate that a given value is a member"""
IGNORE_LIST = [cls.__module__, cls.__name__]
print(IGNORE_LIST)
print(cls.__dict__.values())
if value in cls.__dict__.values() and value not in IGNORE_LIST:
return True
return False
class Range(CV):
"""Available range settings for the OPT4048 sensor.
Full-scale light level ranges as described in datasheet page 29.
+------------------------------+-------------------------+
| Setting | Range Value |
+==============================+=========================+
| :py:const:`Range.RANGE_2K` | 2.2 klux |
+------------------------------+-------------------------+
| :py:const:`Range.RANGE_4K` | 4.5 klux |
+------------------------------+-------------------------+
| :py:const:`Range.RANGE_9K` | 9 klux |
+------------------------------+-------------------------+
| :py:const:`Range.RANGE_18K` | 18 klux |
+------------------------------+-------------------------+
| :py:const:`Range.RANGE_36K` | 36 klux |
+------------------------------+-------------------------+
| :py:const:`Range.RANGE_72K` | 72 klux |
+------------------------------+-------------------------+
| :py:const:`Range.RANGE_144K` | 144 klux |
+------------------------------+-------------------------+
| :py:const:`Range.AUTO` | Auto-range |
+------------------------------+-------------------------+
"""
RANGE_2K = 0 # 2.2 klux
RANGE_4K = 1 # 4.5 klux
RANGE_9K = 2 # 9 klux
RANGE_18K = 3 # 18 klux
RANGE_36K = 4 # 36 klux
RANGE_72K = 5 # 72 klux
RANGE_144K = 6 # 144 klux
AUTO = 12 # Auto-range
class ConversionTime(CV):
"""Available conversion time settings for the OPT4048 sensor.
These control the device conversion time per channel as described in datasheet page 29.
+------------------------------------------+-------------------------+
| Setting | Time |
+==========================================+=========================+
| :py:const:`ConversionTime.TIME_600US` | 600 microseconds |
+------------------------------------------+-------------------------+
| :py:const:`ConversionTime.TIME_1MS` | 1 millisecond |
+------------------------------------------+-------------------------+
| :py:const:`ConversionTime.TIME_1_8MS` | 1.8 milliseconds |
+------------------------------------------+-------------------------+
| :py:const:`ConversionTime.TIME_3_4MS` | 3.4 milliseconds |
+------------------------------------------+-------------------------+
| :py:const:`ConversionTime.TIME_6_5MS` | 6.5 milliseconds |
+------------------------------------------+-------------------------+
| :py:const:`ConversionTime.TIME_12_7MS` | 12.7 milliseconds |
+------------------------------------------+-------------------------+
| :py:const:`ConversionTime.TIME_25MS` | 25 milliseconds |
+------------------------------------------+-------------------------+
| :py:const:`ConversionTime.TIME_50MS` | 50 milliseconds |
+------------------------------------------+-------------------------+
| :py:const:`ConversionTime.TIME_100MS` | 100 milliseconds |
+------------------------------------------+-------------------------+
| :py:const:`ConversionTime.TIME_200MS` | 200 milliseconds |
+------------------------------------------+-------------------------+
| :py:const:`ConversionTime.TIME_400MS` | 400 milliseconds |
+------------------------------------------+-------------------------+
| :py:const:`ConversionTime.TIME_800MS` | 800 milliseconds |
+------------------------------------------+-------------------------+
"""
TIME_600US = 0 # 600 microseconds
TIME_1MS = 1 # 1 millisecond
TIME_1_8MS = 2 # 1.8 milliseconds
TIME_3_4MS = 3 # 3.4 milliseconds
TIME_6_5MS = 4 # 6.5 milliseconds
TIME_12_7MS = 5 # 12.7 milliseconds
TIME_25MS = 6 # 25 milliseconds
TIME_50MS = 7 # 50 milliseconds
TIME_100MS = 8 # 100 milliseconds
TIME_200MS = 9 # 200 milliseconds
TIME_400MS = 10 # 400 milliseconds
TIME_800MS = 11 # 800 milliseconds
class Mode(CV):
"""Available operating mode settings for the OPT4048 sensor.
Controls the device mode of operation as described in datasheet page 29.
+--------------------------------------+-------------------------+
| Setting | Mode |
+======================================+=========================+
| :py:const:`Mode.POWERDOWN` | Power-down mode |
+--------------------------------------+-------------------------+
| :py:const:`Mode.AUTO_ONESHOT` | Auto-range one-shot |
+--------------------------------------+-------------------------+
| :py:const:`Mode.ONESHOT` | One-shot mode |
+--------------------------------------+-------------------------+
| :py:const:`Mode.CONTINUOUS` | Continuous mode |
+--------------------------------------+-------------------------+
"""
POWERDOWN = 0 # Power-down mode
AUTO_ONESHOT = 1 # Forced auto-range one-shot mode
ONESHOT = 2 # One-shot mode
CONTINUOUS = 3 # Continuous mode
class FaultCount(CV):
"""Available fault count settings for the OPT4048 sensor.
Controls how many consecutive fault events are needed to trigger an interrupt.
+------------------------------------+-------------------------+
| Setting | Count |
+====================================+=========================+
| :py:const:`FaultCount.COUNT_1` | 1 fault count (default) |
+------------------------------------+-------------------------+
| :py:const:`FaultCount.COUNT_2` | 2 consecutive faults |
+------------------------------------+-------------------------+
| :py:const:`FaultCount.COUNT_4` | 4 consecutive faults |
+------------------------------------+-------------------------+
| :py:const:`FaultCount.COUNT_8` | 8 consecutive faults |
+------------------------------------+-------------------------+
"""
COUNT_1 = 0 # 1 fault count (default)
COUNT_2 = 1 # 2 consecutive fault counts
COUNT_4 = 2 # 4 consecutive fault counts
COUNT_8 = 3 # 8 consecutive fault counts
class IntConfig(CV):
"""Interrupt configuration settings for the OPT4048 sensor.
Controls the interrupt mechanism after end of conversion.
+----------------------------------------+----------------------------------+
| Setting | Configuration |
+========================================+==================================+
| :py:const:`IntConfig.SMBUS_ALERT` | SMBUS Alert |
+----------------------------------------+----------------------------------+
| :py:const:`IntConfig.DATA_READY_NEXT` | INT Pin data ready for next chan |
+----------------------------------------+----------------------------------+
| :py:const:`IntConfig.DATA_READY_ALL` | INT Pin data ready for all chans |
+----------------------------------------+----------------------------------+
"""
SMBUS_ALERT = 0 # SMBUS Alert
DATA_READY_NEXT = 1 # INT Pin data ready for next channel
DATA_READY_ALL = 3 # INT Pin data ready for all channels
# Default I2C address (ADDR pin connected to GND)
_OPT4048_DEFAULT_ADDR = const(0x44)
# Register addresses
_OPT4048_REG_CH0_MSB = const(0x00) # X channel MSB register
_OPT4048_REG_CH0_LSB = const(0x01) # X channel LSB register
_OPT4048_REG_CH1_MSB = const(0x02) # Y channel MSB register
_OPT4048_REG_CH1_LSB = const(0x03) # Y channel LSB register
_OPT4048_REG_CH2_MSB = const(0x04) # Z channel MSB register
_OPT4048_REG_CH2_LSB = const(0x05) # Z channel LSB register
_OPT4048_REG_CH3_MSB = const(0x06) # W channel MSB register
_OPT4048_REG_CH3_LSB = const(0x07) # W channel LSB register
_OPT4048_REG_THRESHOLD_LOW = const(0x08) # Low threshold register
_OPT4048_REG_THRESHOLD_HIGH = const(0x09) # High threshold register
_OPT4048_REG_CONFIG = const(0x0A) # Configuration register
_OPT4048_REG_THRESHOLD_CFG = const(0x0B) # Threshold configuration register
_OPT4048_REG_STATUS = const(0x0C) # Status register
_OPT4048_REG_DEVICE_ID = const(0x11) # Device ID register
# Status register (0x0C) bit flags
_OPT4048_FLAG_L = const(0x01) # Flag low - measurement smaller than threshold
_OPT4048_FLAG_H = const(0x02) # Flag high - measurement larger than threshold
_OPT4048_FLAG_CONVERSION_READY = const(0x04) # Conversion ready
_OPT4048_FLAG_OVERLOAD = const(0x08) # Overflow condition
class OPT4048:
"""Library for the OPT4048 Tristimulus XYZ Color Sensor
:param ~busio.I2C i2c_bus: The I2C bus the device is connected to
:param int address: The I2C device address. Defaults to :const:`0x44`
**Quickstart: Importing and using the device**
Here is an example of using the :class:`OPT4048`.
First you will need to import the libraries to use the sensor
.. code-block:: python
import board
from adafruit_opt4048 import OPT4048
Once this is done you can define your `board.I2C` object and define your sensor object
.. code-block:: python
i2c = board.I2C() # uses board.SCL and board.SDA
sensor = OPT4048(i2c)
Now you have access to the color data
.. code-block:: python
x, y, z, w = sensor.color_data
"""
# _device_id = ROBits(16, _OPT4048_REG_DEVICE_ID, 0, register_width=2, lsb_first=False)
_device_id = UnaryStruct(_OPT4048_REG_DEVICE_ID, ">H")
_interrupt_direction = RWBit(_OPT4048_REG_THRESHOLD_CFG, 4, register_width=2, lsb_first=False)
_interrupt_config = RWBits(2, _OPT4048_REG_THRESHOLD_CFG, 2, register_width=2, lsb_first=False)
_interrupt_latch = RWBit(_OPT4048_REG_CONFIG, 3, register_width=2, lsb_first=False)
_interrupt_polarity = RWBit(_OPT4048_REG_CONFIG, 2, register_width=2, lsb_first=False)
_range = RWBits(4, _OPT4048_REG_CONFIG, 10, register_width=2, lsb_first=False)
_conversion_time = RWBits(4, _OPT4048_REG_CONFIG, 6, register_width=2, lsb_first=False)
_mode = RWBits(2, _OPT4048_REG_CONFIG, 4, register_width=2, lsb_first=False)
# Threshold Low register bits (register 0x08)
_threshold_low_exponent = RWBits(
4, _OPT4048_REG_THRESHOLD_LOW, 12, register_width=2, lsb_first=False
)
_threshold_low_mantissa = RWBits(
12, _OPT4048_REG_THRESHOLD_LOW, 0, register_width=2, lsb_first=False
)
_all_channels_raw = RWBits(
16 * 8, _OPT4048_REG_CH0_MSB, 0, register_width=2 * 8, lsb_first=False
)
def __init__(self, i2c_bus, address=_OPT4048_DEFAULT_ADDR):
self.i2c_device = i2c_device.I2CDevice(i2c_bus, address)
self.init()
def init(self):
"""Initialize the sensor and verify the device ID"""
# Check device ID
print(f"id: {hex(self._device_id)}")
if self._device_id != _OPT4048_CHIP_ID:
raise RuntimeError("Failed to find an OPT4048 sensor - check your wiring!")
# Initialize the sensor with default settings
self.interrupt_direction = True
self.interrupt_config = IntConfig.DATA_READY_ALL
self.interrupt_latch = True
self.interrupt_polarity = True # Use active-high interrupts by default
self.interrupt_config = IntConfig.DATA_READY_ALL
@property
def interrupt_direction(self):
"""Get the current interrupt direction setting.
Returns True if interrupts are generated when measurement > high threshold,
False if interrupts are generated when measurement < low threshold.
"""
return self._interrupt_direction
@interrupt_direction.setter
def interrupt_direction(self, value):
"""Set the direction of interrupt generation.
:param bool value: True for interrupt when measurement > high threshold,
False for interrupt when measurement < low threshold
"""
self._interrupt_direction = value
@property
def interrupt_config(self):
"""Get the current interrupt configuration.
Returns the current interrupt configuration mode.
See IntConfig class for valid values.
"""
return self._interrupt_config
@interrupt_config.setter
def interrupt_config(self, value):
"""Set the interrupt configuration.
:param int value: The interrupt configuration value.
Must be a valid IntConfig value.
"""
if not IntConfig.is_valid(value):
raise ValueError("Interrupt configuration must be a valid IntConfig value")
self._interrupt_config = value
@property
def interrupt_latch(self):
"""Get the current interrupt latch setting.
Returns True if interrupts are latched (interrupt flag remains active until
register is read), False if interrupts are transparent (interrupt flag
is updated with each measurement).
"""
return self._interrupt_latch
@interrupt_latch.setter
def interrupt_latch(self, value):
"""Set the interrupt latch mode.
:param bool value: True for latched interrupts (interrupt flag remains active
until register is read), False for transparent interrupts
(interrupt flag is updated with each measurement)
"""
self._interrupt_latch = value
@property
def interrupt_polarity(self):
"""Get the current interrupt pin polarity setting.
Returns True if interrupts are active-high (1 = interrupt active),
False if interrupts are active-low (0 = interrupt active).
"""
return self._interrupt_polarity
@interrupt_polarity.setter
def interrupt_polarity(self, value):
"""Set the interrupt pin polarity.
:param bool value: True for active-high interrupts (1 = interrupt active),
False for active-low interrupts (0 = interrupt active)
"""
self._interrupt_polarity = value
@property
def range(self):
"""Get the current range setting for light measurements.
Returns the current range setting from the Range enum.
This controls the full-scale light level range of the device.
See the Range class for valid values:
- Range.RANGE_2K: 2.2 klux
- Range.RANGE_4K: 4.5 klux
- Range.RANGE_9K: 9 klux
- Range.RANGE_18K: 18 klux
- Range.RANGE_36K: 36 klux
- Range.RANGE_72K: 72 klux
- Range.RANGE_144K: 144 klux
- Range.AUTO: Auto-range
"""
return self._range
@range.setter
def range(self, value):
"""Set the range for light measurements.
:param int value: The range setting to use from Range enum.
Controls the full-scale light level range.
Must be a valid Range value.
"""
if not Range.is_valid(value):
raise ValueError("Range setting must be a valid Range value")
self._range = value
@property
def conversion_time(self):
"""Get the current conversion time setting for the OPT4048 sensor.
Returns the current conversion time setting from the ConversionTime enum.
This controls the device conversion time per channel.
See the ConversionTime class for valid values:
- ConversionTime.TIME_600US: 600 microseconds
- ConversionTime.TIME_1MS: 1 millisecond
- ConversionTime.TIME_1_8MS: 1.8 milliseconds
- ConversionTime.TIME_3_4MS: 3.4 milliseconds
- ConversionTime.TIME_6_5MS: 6.5 milliseconds
- ConversionTime.TIME_12_7MS: 12.7 milliseconds
- ConversionTime.TIME_25MS: 25 milliseconds
- ConversionTime.TIME_50MS: 50 milliseconds
- ConversionTime.TIME_100MS: 100 milliseconds
- ConversionTime.TIME_200MS: 200 milliseconds
- ConversionTime.TIME_400MS: 400 milliseconds
- ConversionTime.TIME_800MS: 800 milliseconds
"""
return self._conversion_time
@conversion_time.setter
def conversion_time(self, value):
"""Set the conversion time for light measurements.
:param int value: The conversion time setting to use from ConversionTime enum.
Controls the device conversion time per channel.
Must be a valid ConversionTime value.
"""
if not ConversionTime.is_valid(value):
raise ValueError("Conversion time setting must be a valid ConversionTime value")
self._conversion_time = value
@property
def mode(self):
"""Get the current operating mode setting for the OPT4048 sensor.
Returns the current operating mode setting from the Mode enum.
This controls the device operating mode.
See the Mode class for valid values:
- Mode.POWERDOWN: Power-down mode
- Mode.AUTO_ONESHOT: Auto-range one-shot mode
- Mode.ONESHOT: One-shot mode
- Mode.CONTINUOUS: Continuous mode
"""
return self._mode
@mode.setter
def mode(self, value):
"""Set the operating mode of the sensor.
:param int value: The operating mode setting to use from Mode enum.
Controls the device's operating mode.
Must be a valid Mode value.
"""
if not Mode.is_valid(value):
raise ValueError("Mode setting must be a valid Mode value")
self._mode = value
def get_channels_raw(self):
"""Read all four channels, verify CRC, and return raw ADC code values.
Reads registers for channels 0-3 in one burst, checks the CRC bits for each,
and computes the raw ADC code values.
:return: Tuple of 4 raw channel values (X, Y, Z, W) if successful
:rtype: Tuple[int, int, int, int]
:raises RuntimeError: If CRC check fails for any channel
"""
# Read all channels in one operation using the ROBits accessor
all_channels_data = self._all_channels_raw
# Process each channel's data
channels = []
for ch in range(4):
# Extract channel data from the appropriate position in the buffer
# Each channel has 4 bytes (32 bits) of data
channel_offset = ch * 32
# Extract exponent (4 bits), MSB (12 bits), LSB (8 bits), and counter/CRC (8 bits)
exp = (all_channels_data >> (channel_offset + 28)) & 0xF
msb = (all_channels_data >> (channel_offset + 16)) & 0xFFF
lsb = (all_channels_data >> (channel_offset + 8)) & 0xFF
counter = (all_channels_data >> (channel_offset + 4)) & 0xF
crc = all_channels_data >> channel_offset & 0xF
# Combine MSB and LSB to form the 20-bit mantissa
mant = (msb << 8) | lsb
# print(f"ch: {ch} exp: {exp} msb: {msb} lsb: {lsb} counter: {counter} crc: {crc} mant: {mant}") # noqa: E501
# Calculate CRC
# Initialize CRC variables
x0 = 0 # CRC bit 0
x1 = 0 # CRC bit 1
x2 = 0 # CRC bit 2
x3 = 0 # CRC bit 3
# Calculate bit 0 (x0): XOR of all bits
# XOR all exponent bits
for i in range(4):
x0 ^= (exp >> i) & 1
# XOR all mantissa bits
for i in range(20):
x0 ^= (mant >> i) & 1
# XOR all counter bits
for i in range(4):
x0 ^= (counter >> i) & 1
# Calculate bit 1 (x1)
# Include counter bits 1 and 3
x1 ^= (counter >> 1) & 1 # COUNTER_CHx[1]
x1 ^= (counter >> 3) & 1 # COUNTER_CHx[3]
# Include odd-indexed mantissa bits
for i in range(1, 20, 2):
x1 ^= (mant >> i) & 1
# Include exponent bits 1 and 3
x1 ^= (exp >> 1) & 1 # E[1]
x1 ^= (exp >> 3) & 1 # E[3]
# Calculate bit 2 (x2)
# Include counter bit 3
x2 ^= (counter >> 3) & 1 # COUNTER_CHx[3]
# Include mantissa bits at positions 3,7,11,15,19
for i in range(3, 20, 4):
x2 ^= (mant >> i) & 1
# Include exponent bit 3
x2 ^= (exp >> 3) & 1 # E[3]
# Calculate bit 3 (x3)
# XOR mantissa bits at positions 3, 11, 19
x3 ^= (mant >> 3) & 1 # R[3]
x3 ^= (mant >> 11) & 1 # R[11]
x3 ^= (mant >> 19) & 1 # R[19]
# Combine bits to form the CRC
calculated_crc = (x3 << 3) | (x2 << 2) | (x1 << 1) | x0
# Verify CRC
if crc != calculated_crc:
raise RuntimeError(f"CRC check failed for channel {ch}")
# Convert to raw ADC value format (mantissa << exponent)
output = mant << exp
# Add to channels list
# channels.append(output)
channels.insert(0, output)
# Return all four channels (X, Y, Z, W)
return tuple(channels)
@property
def threshold_low(self):
"""Get the current low threshold value.
Returns the current low threshold value as a 32-bit integer.
This value determines when a low threshold interrupt is generated
when interrupt_direction is False.
"""
# Read the exponent and mantissa from the threshold low register
exponent = self._threshold_low_exponent
mantissa = self._threshold_low_mantissa
print(f"exponent: {exponent} mantissa: {mantissa}")
# Calculate ADC code value by applying the exponent as a bit shift
# ADD 8 to the exponent as per datasheet equations 12-13
return mantissa << (8 + exponent)
@threshold_low.setter
def threshold_low(self, value):
"""Set the low threshold value for interrupt generation.
:param int value: The low threshold value as a 32-bit integer
"""
# Find the appropriate exponent and mantissa values that represent the threshold
exponent = 0
mantissa = value
# The mantissa needs to fit in 12 bits, so we start by shifting right
# to determine how many shifts we need (which gives us the exponent)
# Note that the threshold registers already have 8 added to exponent
# internally so we first subtract 8 from our target exponent
if mantissa > 0xFFF: # If value won't fit in 12 bits
while mantissa > 0xFFF and exponent < 15:
mantissa >>= 1
exponent += 1
if mantissa > 0xFFF: # If still won't fit with max exponent, clamp
mantissa = 0xFFF
exponent = 15 - 8 # Max exponent (15) minus the 8 that's added internally
# Write the exponent and mantissa to the register
self._threshold_low_exponent = exponent
self._threshold_low_mantissa = mantissa
def get_cie(self):
"""Calculate CIE chromaticity coordinates and lux from raw sensor values.
Reads all four channels and calculates CIE x and y chromaticity coordinates
and illuminance (lux) using a matrix transformation.
:return: Tuple of CIE x, CIE y, and lux values
:rtype: Tuple[float, float, float]
"""
# Read all four channels using get_channels_raw
ch0, ch1, ch2, ch3 = self.get_channels_raw()
# Matrix multiplication coefficients (from datasheet)
m0x = 2.34892992e-04
m0y = -1.89652390e-05
m0z = 1.20811684e-05
m0l = 0
m1x = 4.07467441e-05
m1y = 1.98958202e-04
m1z = -1.58848115e-05
m1l = 2.15e-3
m2x = 9.28619404e-05
m2y = -1.69739553e-05
m2z = 6.74021520e-04
m2l = 0
m3x = 0
m3y = 0
m3z = 0
m3l = 0
# Matrix multiplication to calculate X, Y, Z, L values
# [ch0 ch1 ch2 ch3] * [m0x m0y m0z m0l] = [X Y Z Lux]
# [m1x m1y m1z m1l]
# [m2x m2y m2z m2l]
# [m3x m3y m3z m3l]
x = ch0 * m0x + ch1 * m1x + ch2 * m2x + ch3 * m3x
y = ch0 * m0y + ch1 * m1y + ch2 * m2y + ch3 * m3y
z = ch0 * m0z + ch1 * m1z + ch2 * m2z + ch3 * m3z
lux = ch0 * m0l + ch1 * m1l + ch2 * m2l + ch3 * m3l
# Calculate CIE x, y chromaticity coordinates
sum_xyz = x + y + z
if sum_xyz <= 0:
# Avoid division by zero
return 0.0, 0.0, 0.0
cie_x = x / sum_xyz
cie_y = y / sum_xyz
return cie_x, cie_y, lux
def calculate_color_temperature(self, cie_x, cie_y):
"""Calculate the correlated color temperature (CCT) in Kelvin.
Uses McCamy's approximation formula to calculate CCT from CIE 1931 x,y
coordinates. This is accurate for color temperatures between 2000K and
30000K.
Formula:
n = (x - 0.3320) / (0.1858 - y)
CCT = 437 * n^3 + 3601 * n^2 + 6861 * n + 5517
:param float cie_x: CIE x chromaticity coordinate
:param float cie_y: CIE y chromaticity coordinate
:return: The calculated color temperature in Kelvin
:rtype: float
"""
# Check for invalid coordinates
if cie_x == 0 and cie_y == 0:
return 0.0
# Calculate using McCamy's formula
# n = (x - 0.3320) / (0.1858 - y)
n = (cie_x - 0.3320) / (0.1858 - cie_y)
# CCT = 437 * n^3 + 3601 * n^2 + 6861 * n + 5517
cct = (437.0 * n * n * n) + (3601.0 * n * n) + (6861.0 * n) + 5517.0
return cct

BIN
docs/_static/favicon.ico vendored Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 4.3 KiB

3
docs/_static/favicon.ico.license vendored Normal file
View file

@ -0,0 +1,3 @@
SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries
SPDX-License-Identifier: CC-BY-4.0

11
docs/api.rst Normal file
View file

@ -0,0 +1,11 @@
.. If you created a package, create one automodule per module in the package.
.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
.. use this format as the module name: "adafruit_foo.foo"
API Reference
#############
.. automodule:: adafruit_opt4048
:members:

4
docs/api.rst.license Normal file
View file

@ -0,0 +1,4 @@
SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
SPDX-FileCopyrightText: Copyright (c) 2025 Tim C for Adafruit Industries
SPDX-License-Identifier: MIT

185
docs/conf.py Normal file
View file

@ -0,0 +1,185 @@
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
#
# SPDX-License-Identifier: MIT
import datetime
import os
import sys
sys.path.insert(0, os.path.abspath(".."))
# -- General configuration ------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx.ext.autodoc",
"sphinxcontrib.jquery",
"sphinx.ext.intersphinx",
"sphinx.ext.napoleon",
"sphinx.ext.todo",
]
# TODO: Please Read!
# Uncomment the below if you use native CircuitPython modules such as
# digitalio, micropython and busio. List the modules you use. Without it, the
# autodoc module docs will fail to generate with a warning.
# autodoc_mock_imports = ["digitalio", "busio"]
autodoc_preserve_defaults = True
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"BusDevice": ("https://docs.circuitpython.org/projects/busdevice/en/latest/", None),
"Register": ("https://docs.circuitpython.org/projects/register/en/latest/", None),
"CircuitPython": ("https://docs.circuitpython.org/en/latest/", None),
}
# Show the docstring from both the class and its __init__() method.
autoclass_content = "both"
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
source_suffix = ".rst"
# The master toctree document.
master_doc = "index"
# General information about the project.
project = "Adafruit CircuitPython OPT4048 Library"
creation_year = "2025"
current_year = str(datetime.datetime.now().year)
year_duration = (
current_year if current_year == creation_year else creation_year + " - " + current_year
)
copyright = year_duration + " Tim C"
author = "Tim C"
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = "1.0"
# The full version, including alpha/beta/rc tags.
release = "1.0"
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = "en"
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = [
"_build",
"Thumbs.db",
".DS_Store",
".env",
"CODE_OF_CONDUCT.md",
]
# The reST default role (used for this markup: `text`) to use for all
# documents.
#
default_role = "any"
# If true, '()' will be appended to :func: etc. cross-reference text.
#
add_function_parentheses = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# If this is True, todo emits a warning for each TODO entries. The default is False.
todo_emit_warnings = True
napoleon_numpy_docstring = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#
html_favicon = "_static/favicon.ico"
# Output file base name for HTML help builder.
htmlhelp_basename = "Adafruit_CircuitPython_Opt4048_Librarydoc"
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
# 'preamble': '',
# Latex figure (float) alignment
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(
master_doc,
"Adafruit_CircuitPython_OPT4048_Library.tex",
"Adafruit CircuitPython OPT4048 Library Documentation",
author,
"manual",
),
]
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(
master_doc,
"Adafruit_CircuitPython_OPT4048_Library",
"Adafruit CircuitPython OPT4048 Library Documentation",
[author],
1,
),
]
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(
master_doc,
"Adafruit_CircuitPython_OPT4048_Library",
"Adafruit CircuitPython OPT4048 Library Documentation",
author,
"Adafruit_CircuitPython_OPT4048_Library",
"One line description of project.",
"Miscellaneous",
),
]

8
docs/examples.rst Normal file
View file

@ -0,0 +1,8 @@
Simple test
------------
Ensure your device works with this simple test.
.. literalinclude:: ../examples/opt4048_simpletest.py
:caption: examples/opt4048_simpletest.py
:linenos:

4
docs/examples.rst.license Normal file
View file

@ -0,0 +1,4 @@
SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
SPDX-FileCopyrightText: Copyright (c) 2025 Tim C for Adafruit Industries
SPDX-License-Identifier: MIT

53
docs/index.rst Normal file
View file

@ -0,0 +1,53 @@
.. include:: ../README.rst
Table of Contents
=================
.. toctree::
:maxdepth: 4
:hidden:
self
.. toctree::
:caption: Examples
examples
.. toctree::
:caption: API Reference
:maxdepth: 3
api
.. toctree::
:caption: Tutorials
.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
the toctree above for use later.
.. toctree::
:caption: Related Products
.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
the toctree above for use later.
.. toctree::
:caption: Other Links
Download from GitHub <https://github.com/adafruit/Adafruit_CircuitPython_OPT4048/releases/latest>
Download Library Bundle <https://circuitpython.org/libraries>
CircuitPython Reference Documentation <https://docs.circuitpython.org>
CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>
Discord Chat <https://adafru.it/discord>
Adafruit Learning System <https://learn.adafruit.com>
Adafruit Blog <https://blog.adafruit.com>
Adafruit Store <https://www.adafruit.com>
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

4
docs/index.rst.license Normal file
View file

@ -0,0 +1,4 @@
SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
SPDX-FileCopyrightText: Copyright (c) 2025 Tim C for Adafruit Industries
SPDX-License-Identifier: MIT

7
docs/requirements.txt Normal file
View file

@ -0,0 +1,7 @@
# SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries
#
# SPDX-License-Identifier: Unlicense
sphinx
sphinxcontrib-jquery
sphinx-rtd-theme

21
examples/opt4048_simpletest.py Normal file
View file

@ -0,0 +1,21 @@
# SPDX-FileCopyrightText: Copyright (c) 2025 Tim C for Adafruit Industries
# SPDX-License-Identifier: MIT
import time
from time import sleep
import board
from adafruit_opt4048 import OPT4048, ConversionTime, Mode, Range
i2c = board.I2C() # uses board.SCL and board.SDA
# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller
sensor = OPT4048(i2c)
sensor.range = Range.AUTO
sensor.conversion_time = ConversionTime.TIME_100MS
sensor.mode = Mode.CONTINUOUS
while True:
x, y, lux = sensor.get_cie()
print(f"CIE x:{x}, y:{y}, lux: {lux}", end=" ")
print(f"K: {sensor.calculate_color_temperature(x,y)}")
time.sleep(1)

3
optional_requirements.txt Normal file
View file

@ -0,0 +1,3 @@
# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries
#
# SPDX-License-Identifier: Unlicense

55
pyproject.toml Normal file
View file

@ -0,0 +1,55 @@
# SPDX-FileCopyrightText: 2022 Alec Delaney, written for Adafruit Industries
# SPDX-FileCopyrightText: Copyright (c) 2025 Tim C for Adafruit Industries
#
# SPDX-License-Identifier: MIT
[build-system]
requires = [
"setuptools",
"wheel",
"setuptools-scm",
]
[project]
name = "adafruit-circuitpython-opt4048"
description = "CircuitPython driver library for the Adafruit OPT4048 breakout board, a high-speed, high-precision tristimulus XYZ color sensor."
version = "0.0.0+auto.0"
readme = "README.rst"
authors = [
{name = "Adafruit Industries", email = "circuitpython@adafruit.com"}
]
urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_OPT4048"}
keywords = [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"opt4048",
"color",
"colorsensor",
"sensor",
"colors",
"light",
"lux",
"xyz",
"tristimulus",
]
license = {text = "MIT"}
classifiers = [
"Intended Audience :: Developers",
"Topic :: Software Development :: Libraries",
"Topic :: Software Development :: Embedded Systems",
"Topic :: System :: Hardware",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python :: 3",
]
dynamic = ["dependencies", "optional-dependencies"]
[tool.setuptools]
# TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER,
# CHANGE `py_modules = ['...']` TO `packages = ['...']`
py-modules = ["adafruit_opt4048"]
[tool.setuptools.dynamic]
dependencies = {file = ["requirements.txt"]}
optional-dependencies = {optional = {file = ["optional_requirements.txt"]}}

8
requirements.txt Normal file
View file

@ -0,0 +1,8 @@
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
# SPDX-FileCopyrightText: Copyright (c) 2025 Tim C for Adafruit Industries
#
# SPDX-License-Identifier: MIT
Adafruit-Blinka
adafruit-circuitpython-busdevice
adafruit-circuitpython-register

101
ruff.toml Normal file
View file

@ -0,0 +1,101 @@
# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries
#
# SPDX-License-Identifier: MIT
target-version = "py38"
line-length = 100
[lint]
preview = true
select = ["I", "PL", "UP"]
extend-select = [
"D419", # empty-docstring
"E501", # line-too-long
"W291", # trailing-whitespace
"PLC0414", # useless-import-alias
"PLC2401", # non-ascii-name
"PLC2801", # unnecessary-dunder-call
"PLC3002", # unnecessary-direct-lambda-call
"E999", # syntax-error
"PLE0101", # return-in-init
"F706", # return-outside-function
"F704", # yield-outside-function
"PLE0116", # continue-in-finally
"PLE0117", # nonlocal-without-binding
"PLE0241", # duplicate-bases
"PLE0302", # unexpected-special-method-signature
"PLE0604", # invalid-all-object
"PLE0605", # invalid-all-format
"PLE0643", # potential-index-error
"PLE0704", # misplaced-bare-raise
"PLE1141", # dict-iter-missing-items
"PLE1142", # await-outside-async
"PLE1205", # logging-too-many-args
"PLE1206", # logging-too-few-args
"PLE1307", # bad-string-format-type
"PLE1310", # bad-str-strip-call
"PLE1507", # invalid-envvar-value
"PLE2502", # bidirectional-unicode
"PLE2510", # invalid-character-backspace
"PLE2512", # invalid-character-sub
"PLE2513", # invalid-character-esc
"PLE2514", # invalid-character-nul
"PLE2515", # invalid-character-zero-width-space
"PLR0124", # comparison-with-itself
"PLR0202", # no-classmethod-decorator
"PLR0203", # no-staticmethod-decorator
"UP004", # useless-object-inheritance
"PLR0206", # property-with-parameters
"PLR0904", # too-many-public-methods
"PLR0911", # too-many-return-statements
"PLR0912", # too-many-branches
"PLR0913", # too-many-arguments
"PLR0914", # too-many-locals
"PLR0915", # too-many-statements
"PLR0916", # too-many-boolean-expressions
"PLR1702", # too-many-nested-blocks
"PLR1704", # redefined-argument-from-local
"PLR1711", # useless-return
"C416", # unnecessary-comprehension
"PLR1733", # unnecessary-dict-index-lookup
"PLR1736", # unnecessary-list-index-lookup
# ruff reports this rule is unstable
#"PLR6301", # no-self-use
"PLW0108", # unnecessary-lambda
"PLW0120", # useless-else-on-loop
"PLW0127", # self-assigning-variable
"PLW0129", # assert-on-string-literal
"B033", # duplicate-value
"PLW0131", # named-expr-without-context
"PLW0245", # super-without-brackets
"PLW0406", # import-self
"PLW0602", # global-variable-not-assigned
"PLW0603", # global-statement
"PLW0604", # global-at-module-level
# fails on the try: import typing used by libraries
#"F401", # unused-import
"F841", # unused-variable
"E722", # bare-except
"PLW0711", # binary-op-exception
"PLW1501", # bad-open-mode
"PLW1508", # invalid-envvar-default
"PLW1509", # subprocess-popen-preexec-fn
"PLW2101", # useless-with-lock
"PLW3301", # nested-min-max
]
ignore = [
"PLR2004", # magic-value-comparison
"UP030", # format literals
"PLW1514", # unspecified-encoding
"PLR0914", # too many local vars
"PLR6301", # method could be function
]
[format]
line-ending = "lf"