├── .codespellrc ├── .github ├── dependabot.yml └── workflows │ ├── check-arduino.yml │ ├── compile-examples.yml │ ├── report-size-deltas.yml │ ├── spell-check.yml │ └── sync-labels.yml ├── LICENSE.txt ├── README.adoc ├── docs ├── api.md └── readme.md ├── examples ├── ColorSensor │ └── ColorSensor.ino ├── FullExample │ └── FullExample.ino ├── GestureSensor │ └── GestureSensor.ino └── ProximitySensor │ └── ProximitySensor.ino ├── keywords.txt ├── library.properties └── src ├── Arduino_APDS9960.cpp └── Arduino_APDS9960.h /.codespellrc: -------------------------------------------------------------------------------- 1 | # See: https://github.com/codespell-project/codespell#using-a-config-file 2 | [codespell] 3 | # In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here: 4 | ignore-words-list = totaly 5 | check-filenames = 6 | check-hidden = 7 | skip = ./.git 8 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # See: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#about-the-dependabotyml-file 2 | version: 2 3 | 4 | updates: 5 | # Configure check for outdated GitHub Actions actions in workflows. 6 | # See: https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot 7 | - package-ecosystem: github-actions 8 | directory: / # Check the repository's workflows under /.github/workflows/ 9 | schedule: 10 | interval: daily 11 | labels: 12 | - "topic: infrastructure" 13 | -------------------------------------------------------------------------------- /.github/workflows/check-arduino.yml: -------------------------------------------------------------------------------- 1 | name: Check Arduino 2 | 3 | # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows 4 | on: 5 | push: 6 | pull_request: 7 | schedule: 8 | # Run every Tuesday at 8 AM UTC to catch breakage caused by new rules added to Arduino Lint. 9 | - cron: "0 8 * * TUE" 10 | workflow_dispatch: 11 | repository_dispatch: 12 | 13 | jobs: 14 | lint: 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - name: Checkout repository 19 | uses: actions/checkout@v4 20 | 21 | - name: Arduino Lint 22 | uses: arduino/arduino-lint-action@v2 23 | with: 24 | compliance: strict 25 | library-manager: update 26 | # Always use this setting for official repositories. Remove for 3rd party projects. 27 | official: true 28 | project-type: library 29 | -------------------------------------------------------------------------------- /.github/workflows/compile-examples.yml: -------------------------------------------------------------------------------- 1 | name: Compile Examples 2 | 3 | # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows 4 | on: 5 | push: 6 | paths: 7 | - ".github/workflows/compile-examples.yml" 8 | - "examples/**" 9 | - "src/**" 10 | pull_request: 11 | paths: 12 | - ".github/workflows/compile-examples.yml" 13 | - "examples/**" 14 | - "src/**" 15 | schedule: 16 | # Run every Tuesday at 8 AM UTC to catch breakage caused by changes to external resources (libraries, platforms). 17 | - cron: "0 8 * * TUE" 18 | workflow_dispatch: 19 | repository_dispatch: 20 | 21 | jobs: 22 | build: 23 | name: ${{ matrix.board.fqbn }} 24 | runs-on: ubuntu-latest 25 | 26 | env: 27 | SKETCHES_REPORTS_PATH: sketches-reports 28 | 29 | strategy: 30 | fail-fast: false 31 | 32 | matrix: 33 | board: 34 | - fqbn: arduino:avr:nano 35 | platforms: | 36 | - name: arduino:avr 37 | artifact-name-suffix: arduino-avr-nano 38 | - fqbn: arduino:avr:mega 39 | platforms: | 40 | - name: arduino:avr 41 | artifact-name-suffix: arduino-avr-mega 42 | - fqbn: arduino:avr:leonardo 43 | platforms: | 44 | - name: arduino:avr 45 | artifact-name-suffix: arduino-avr-leonardo 46 | - fqbn: arduino:megaavr:nona4809 47 | platforms: | 48 | - name: arduino:megaavr 49 | artifact-name-suffix: arduino-megaavr-nona4809 50 | - fqbn: arduino:sam:arduino_due_x_dbg 51 | platforms: | 52 | - name: arduino:sam 53 | artifact-name-suffix: arduino-sam-arduino_due_x_dbg 54 | - fqbn: arduino:samd:mkrzero 55 | platforms: | 56 | - name: arduino:samd 57 | artifact-name-suffix: arduino-samd-mkrzero 58 | - fqbn: arduino:mbed_portenta:envie_m7:target_core=cm4 59 | platforms: | 60 | - name: arduino:mbed_portenta 61 | artifact-name-suffix: arduino-mbed_portenta-envie_m7-target_core-cm4 62 | - fqbn: arduino:mbed_portenta:envie_m7 63 | platforms: | 64 | - name: arduino:mbed_portenta 65 | artifact-name-suffix: arduino-mbed_portenta-envie_m7 66 | - fqbn: arduino:mbed_nano:nano33ble 67 | platforms: | 68 | - name: arduino:mbed_nano 69 | artifact-name-suffix: arduino-mbed_nano-nano33ble 70 | - fqbn: arduino:mbed_nano:nanorp2040connect 71 | platforms: | 72 | - name: arduino:mbed_nano 73 | artifact-name-suffix: arduino-mbed_nano-nanorp2040connect 74 | 75 | steps: 76 | - name: Checkout repository 77 | uses: actions/checkout@v4 78 | 79 | - name: Compile examples 80 | uses: arduino/compile-sketches@v1 81 | with: 82 | github-token: ${{ secrets.GITHUB_TOKEN }} 83 | fqbn: ${{ matrix.board.fqbn }} 84 | platforms: ${{ matrix.board.platforms }} 85 | libraries: | 86 | # Install the library from the local path. 87 | - source-path: ./ 88 | # Additional library dependencies can be listed here. 89 | # See: https://github.com/arduino/compile-sketches#libraries 90 | sketch-paths: | 91 | - examples 92 | enable-deltas-report: true 93 | sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }} 94 | 95 | - name: Save sketches report as workflow artifact 96 | uses: actions/upload-artifact@v4 97 | with: 98 | if-no-files-found: error 99 | path: ${{ env.SKETCHES_REPORTS_PATH }} 100 | name: sketches-report-${{ matrix.board.artifact-name-suffix }} 101 | -------------------------------------------------------------------------------- /.github/workflows/report-size-deltas.yml: -------------------------------------------------------------------------------- 1 | name: Report Size Deltas 2 | 3 | # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows 4 | on: 5 | push: 6 | paths: 7 | - ".github/workflows/report-size-deltas.yml" 8 | schedule: 9 | # Run at the minimum interval allowed by GitHub Actions. 10 | # Note: GitHub Actions periodically has outages which result in workflow failures. 11 | # In this event, the workflows will start passing again once the service recovers. 12 | - cron: "*/5 * * * *" 13 | workflow_dispatch: 14 | repository_dispatch: 15 | 16 | jobs: 17 | report: 18 | runs-on: ubuntu-latest 19 | steps: 20 | - name: Comment size deltas reports to PRs 21 | uses: arduino/report-size-deltas@v1 22 | with: 23 | # Regex matching the names of the workflow artifacts created by the "Compile Examples" workflow 24 | sketches-reports-source: ^sketches-report-.+ 25 | -------------------------------------------------------------------------------- /.github/workflows/spell-check.yml: -------------------------------------------------------------------------------- 1 | name: Spell Check 2 | 3 | # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows 4 | on: 5 | push: 6 | pull_request: 7 | schedule: 8 | # Run every Tuesday at 8 AM UTC to catch new misspelling detections resulting from dictionary updates. 9 | - cron: "0 8 * * TUE" 10 | workflow_dispatch: 11 | repository_dispatch: 12 | 13 | jobs: 14 | spellcheck: 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - name: Checkout repository 19 | uses: actions/checkout@v4 20 | 21 | - name: Spell check 22 | uses: codespell-project/actions-codespell@master 23 | -------------------------------------------------------------------------------- /.github/workflows/sync-labels.yml: -------------------------------------------------------------------------------- 1 | # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/sync-labels.md 2 | name: Sync Labels 3 | 4 | # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows 5 | on: 6 | push: 7 | paths: 8 | - ".github/workflows/sync-labels.ya?ml" 9 | - ".github/label-configuration-files/*.ya?ml" 10 | pull_request: 11 | paths: 12 | - ".github/workflows/sync-labels.ya?ml" 13 | - ".github/label-configuration-files/*.ya?ml" 14 | schedule: 15 | # Run daily at 8 AM UTC to sync with changes to shared label configurations. 16 | - cron: "0 8 * * *" 17 | workflow_dispatch: 18 | repository_dispatch: 19 | 20 | env: 21 | CONFIGURATIONS_FOLDER: .github/label-configuration-files 22 | CONFIGURATIONS_ARTIFACT: label-configuration-files 23 | 24 | jobs: 25 | check: 26 | runs-on: ubuntu-latest 27 | 28 | steps: 29 | - name: Checkout repository 30 | uses: actions/checkout@v4 31 | 32 | - name: Download JSON schema for labels configuration file 33 | id: download-schema 34 | uses: carlosperate/download-file-action@v2 35 | with: 36 | file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/arduino-tooling-gh-label-configuration-schema.json 37 | location: ${{ runner.temp }}/label-configuration-schema 38 | 39 | - name: Install JSON schema validator 40 | run: | 41 | sudo npm install \ 42 | --global \ 43 | ajv-cli \ 44 | ajv-formats 45 | 46 | - name: Validate local labels configuration 47 | run: | 48 | # See: https://github.com/ajv-validator/ajv-cli#readme 49 | ajv validate \ 50 | --all-errors \ 51 | -c ajv-formats \ 52 | -s "${{ steps.download-schema.outputs.file-path }}" \ 53 | -d "${{ env.CONFIGURATIONS_FOLDER }}/*.{yml,yaml}" 54 | 55 | download: 56 | needs: check 57 | runs-on: ubuntu-latest 58 | 59 | strategy: 60 | matrix: 61 | filename: 62 | # Filenames of the shared configurations to apply to the repository in addition to the local configuration. 63 | # https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/sync-labels 64 | - universal.yml 65 | 66 | steps: 67 | - name: Download 68 | uses: carlosperate/download-file-action@v2 69 | with: 70 | file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/${{ matrix.filename }} 71 | 72 | - name: Pass configuration files to next job via workflow artifact 73 | uses: actions/upload-artifact@v4 74 | with: 75 | path: | 76 | *.yaml 77 | *.yml 78 | if-no-files-found: error 79 | name: ${{ env.CONFIGURATIONS_ARTIFACT }} 80 | 81 | sync: 82 | needs: download 83 | runs-on: ubuntu-latest 84 | 85 | steps: 86 | - name: Set environment variables 87 | run: | 88 | # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable 89 | echo "MERGED_CONFIGURATION_PATH=${{ runner.temp }}/labels.yml" >> "$GITHUB_ENV" 90 | 91 | - name: Determine whether to dry run 92 | id: dry-run 93 | if: > 94 | github.event_name == 'pull_request' || 95 | ( 96 | ( 97 | github.event_name == 'push' || 98 | github.event_name == 'workflow_dispatch' 99 | ) && 100 | github.ref != format('refs/heads/{0}', github.event.repository.default_branch) 101 | ) 102 | run: | 103 | # Use of this flag in the github-label-sync command will cause it to only check the validity of the 104 | # configuration. 105 | echo "::set-output name=flag::--dry-run" 106 | 107 | - name: Checkout repository 108 | uses: actions/checkout@v4 109 | 110 | - name: Download configuration files artifact 111 | uses: actions/download-artifact@v4 112 | with: 113 | name: ${{ env.CONFIGURATIONS_ARTIFACT }} 114 | path: ${{ env.CONFIGURATIONS_FOLDER }} 115 | 116 | - name: Remove unneeded artifact 117 | uses: geekyeggo/delete-artifact@v5 118 | with: 119 | name: ${{ env.CONFIGURATIONS_ARTIFACT }} 120 | 121 | - name: Merge label configuration files 122 | run: | 123 | # Merge all configuration files 124 | shopt -s extglob 125 | cat "${{ env.CONFIGURATIONS_FOLDER }}"/*.@(yml|yaml) > "${{ env.MERGED_CONFIGURATION_PATH }}" 126 | 127 | - name: Install github-label-sync 128 | run: sudo npm install --global github-label-sync 129 | 130 | - name: Sync labels 131 | env: 132 | GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }} 133 | run: | 134 | # See: https://github.com/Financial-Times/github-label-sync 135 | github-label-sync \ 136 | --labels "${{ env.MERGED_CONFIGURATION_PATH }}" \ 137 | ${{ steps.dry-run.outputs.flag }} \ 138 | ${{ github.repository }} 139 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | [This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.] 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | 474 | Copyright (C) 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 489 | USA 490 | 491 | Also add information on how to contact you by electronic and paper mail. 492 | 493 | You should also get your employer (if you work as a programmer) or your 494 | school, if any, to sign a "copyright disclaimer" for the library, if 495 | necessary. Here is a sample; alter the names: 496 | 497 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 498 | library `Frob' (a library for tweaking knobs) written by James Random 499 | Hacker. 500 | 501 | , 1 April 1990 502 | Ty Coon, President of Vice 503 | 504 | That's all there is to it! 505 | -------------------------------------------------------------------------------- /README.adoc: -------------------------------------------------------------------------------- 1 | :repository-owner: arduino-libraries 2 | :repository-name: Arduino_APDS9960 3 | 4 | = {repository-name} Library for Arduino = 5 | 6 | image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-arduino.yml/badge.svg["Check Arduino status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-arduino.yml"] 7 | image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml/badge.svg["Compile Examples status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml"] 8 | image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml/badge.svg["Spell Check status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml"] 9 | 10 | A library for the APDS-9960 sensor, allows you to read gestures, color, and proximity on your Arduino Nano 33 BLE Sense board and other boards with sensor attached via I2C. 11 | 12 | For more information about this library please visit us at https://www.arduino.cc/reference/en/libraries/arduino_apds9960/ 13 | -------------------------------------------------------------------------------- /docs/api.md: -------------------------------------------------------------------------------- 1 | # ArduinoAPDS9960 library 2 | 3 | ## Methods 4 | 5 | ### `begin()` 6 | 7 | Initialize the APDS gesture sensor. 8 | 9 | #### Syntax 10 | 11 | ``` 12 | APDS.begin() 13 | ``` 14 | 15 | #### Parameters 16 | 17 | None. 18 | 19 | #### Returns 20 | 21 | 1 on success, 0 on failure. 22 | 23 | #### Example 24 | 25 | ``` 26 | if (!APDS.begin()) { 27 | Serial.println("Error initializing APDS9960 sensor!"); 28 | } 29 | ``` 30 | 31 | #### See also 32 | 33 | * [end()](#end) 34 | * [gestureAvailable()](#gestureavailable) 35 | * [readGesture()](#readgesture) 36 | * [colorAvailable()](#coloravailable) 37 | * [readColor()](#readcolor) 38 | * [proximityAvailable()](#proximityavailable) 39 | * [readProximity()](#readproximity) 40 | * [setGestureSensitivity()](#setgesturesensitivity) 41 | * [setInterruptPin()](#setinterruptpin) 42 | * [setLEDBoost()](#setledboost) 43 | 44 | ### `end()` 45 | 46 | Deactivate the APDS gesture sensor. 47 | 48 | #### Syntax 49 | 50 | ``` 51 | APDS.end() 52 | ``` 53 | 54 | #### Parameters 55 | 56 | None. 57 | 58 | #### Returns 59 | 60 | None. 61 | 62 | #### Example 63 | 64 | ``` 65 | APDS.end(); 66 | ``` 67 | 68 | #### See also 69 | 70 | * [begin()](#begin) 71 | * [gestureAvailable()](#gestureavailable) 72 | * [readGesture()](#readgesture) 73 | * [colorAvailable()](#coloravailable) 74 | * [readColor()](#readcolor) 75 | * [proximityAvailable()](#proximityavailable) 76 | * [readProximity()](#readproximity) 77 | * [setGestureSensitivity()](#setgesturesensitivity) 78 | * [setInterruptPin()](#setinterruptpin) 79 | * [setLEDBoost()](#setledboost) 80 | 81 | ### `gestureAvailable()` 82 | 83 | Checks if the sensor has detected gestures. The detected gesture can be read using the `APDS.readGesture()` function. This function also enables the gesture sensor when called for the first time. 84 | 85 | #### Syntax 86 | 87 | ``` 88 | APDS.gestureAvailable() 89 | ``` 90 | 91 | #### Parameters 92 | 93 | None. 94 | 95 | #### Returns 96 | 97 | 1 if a gesture has been detected, otherwise 0. 98 | 99 | #### Example 100 | 101 | ``` 102 | if (APDS.gestureAvailable()) { 103 | // a gesture was detected 104 | int gesture = APDS.readGesture(); 105 | } 106 | ``` 107 | 108 | #### See also 109 | 110 | * [begin()](#begin) 111 | * [end()](#end) 112 | * [readGesture()](#readgesture) 113 | * [colorAvailable()](#coloravailable) 114 | * [readColor()](#readcolor) 115 | * [proximityAvailable()](#proximityavailable) 116 | * [readProximity()](#readproximity) 117 | * [setGestureSensitivity()](#setgesturesensitivity) 118 | * [setInterruptPin()](#setinterruptpin) 119 | * [setLEDBoost()](#setledboost) 120 | 121 | ### `readGesture()` 122 | 123 | Read the gesture detected from the sensor. You can check if a gesture has been detected using the `APDS.gestureAvailable()` function. 124 | 125 | #### Syntax 126 | 127 | ``` 128 | APDS.readGesture() 129 | ``` 130 | 131 | #### Parameters 132 | 133 | None. 134 | 135 | #### Returns 136 | 137 | The detected gesture. Can be one of the following values: 138 | 139 | * GESTURE_UP: “up” gesture. 140 | * GESTURE_DOWN: “down” gesture. 141 | * GESTURE_LEFT: “left” gesture. 142 | * GESTURE_RIGHT: “right” gesture. 143 | * GESTURE_NONE: the gesture doesn’t match any of the above. 144 | 145 | #### Example 146 | 147 | ``` 148 | /* 149 | APDS-9960 - Gesture Sensor 150 | 151 | This example reads gesture data from the on-board APDS-9960 sensor of the 152 | Nano 33 BLE Sense board and prints any detected gestures to the Serial Monitor. 153 | 154 | Gesture directions are as follows: 155 | - UP: from USB connector towards antenna. 156 | - DOWN: from antenna towards USB connector. 157 | - LEFT: from analog pins side towards digital pins side. 158 | - RIGHT: from digital pins side towards analog pins side. 159 | 160 | The circuit: 161 | - Arduino Nano 33 BLE Sense. 162 | 163 | This example code is in the public domain. 164 | */ 165 | 166 | #include 167 | 168 | void setup() { 169 | Serial.begin(9600); 170 | while (!Serial); 171 | 172 | if (!APDS.begin()) { 173 | Serial.println("Error initializing APDS-9960 sensor."); 174 | } 175 | 176 | // For setGestureSensitivity(...), a value between 1 and 100 is required. 177 | // Higher values make the gesture recognition more sensitive but less accurate 178 | // (a wrong gesture may be detected by the sensor). Lower values makes the gesture recognition 179 | // more accurate but less sensitive (some gestures may be missed by the sensor). 180 | // Default value is 80. 181 | 182 | //APDS.setGestureSensitivity(80); 183 | 184 | Serial.println("Detecting gestures ..."); 185 | } 186 | 187 | void loop() { 188 | if (APDS.gestureAvailable()) { 189 | // A gesture was detected, read and print to Serial Monitor. 190 | int gesture = APDS.readGesture(); 191 | 192 | switch (gesture) { 193 | case GESTURE_UP: 194 | Serial.println("Detected UP gesture"); 195 | break; 196 | 197 | case GESTURE_DOWN: 198 | Serial.println("Detected DOWN gesture"); 199 | break; 200 | 201 | case GESTURE_LEFT: 202 | Serial.println("Detected LEFT gesture"); 203 | break; 204 | 205 | case GESTURE_RIGHT: 206 | Serial.println("Detected RIGHT gesture"); 207 | break; 208 | 209 | default: 210 | // Ignore. 211 | break; 212 | } 213 | } 214 | } 215 | ``` 216 | 217 | #### See also 218 | 219 | * [begin()](#begin) 220 | * [end()](#end) 221 | * [gestureAvailable()](#readgesture) 222 | * [colorAvailable()](#coloravailable) 223 | * [readColor()](#readcolor) 224 | * [proximityAvailable()](#proximityavailable) 225 | * [readProximity()](#readproximity) 226 | * [setGestureSensitivity()](#setgesturesensitivity) 227 | * [setInterruptPin()](#setinterruptpin) 228 | * [setLEDBoost()](#setledboost) 229 | 230 | ### `colorAvailable()` 231 | 232 | Check if a color reading is available from the sensor. The color reading can be retrieved using the `APDS.readColor(...)` function. 233 | 234 | #### Syntax 235 | 236 | ``` 237 | APDS.colorAvailable() 238 | ``` 239 | 240 | #### Parameters 241 | 242 | None. 243 | 244 | #### Returns 245 | 246 | 1 if a color has been read, otherwise 0. 247 | 248 | #### Example 249 | 250 | ``` 251 | // Check if a color reading is available: 252 | if (APDS.colorAvailable()) { 253 | int r, g, b; 254 | 255 | // Read the color: 256 | APDS.readColor(r, g, b); 257 | } 258 | ``` 259 | 260 | #### See also 261 | 262 | * [begin()](#begin) 263 | * [end()](#end) 264 | * [gestureAvailable()](#readgesture) 265 | * [readGesture()](#coloravailable) 266 | * [readColor()](#readcolor) 267 | * [proximityAvailable()](#proximityavailable) 268 | * [readProximity()](#readproximity) 269 | * [setGestureSensitivity()](#setgesturesensitivity) 270 | * [setInterruptPin()](#setinterruptpin) 271 | * [setLEDBoost()](#setledboost) 272 | 273 | ### `readColor()` 274 | 275 | Retrieve the color read from the sensor. You can check if a color has been read by the sensor and may be retrieved using the `APDS.colorAvailable()` function. 276 | 277 | #### Syntax 278 | 279 | ``` 280 | Int r, g, b; 281 | APDS.readColor(r, g, b); 282 | Int a; 283 | APDS.readColor(r, g, b, a); 284 | ``` 285 | 286 | #### Parameters 287 | 288 | This function requires 3 or 4 integer variables as arguments where the read color will be stored: 289 | 290 | * _r_: the red component of the read color. 291 | * _g_: the green component of the read color. 292 | * _b_: the blue component of the read color. 293 | * _a_. the ambient light intensity. 294 | 295 | #### Returns 296 | 297 | None. 298 | 299 | #### Example 300 | 301 | ``` 302 | /* 303 | APDS-9960 - Color Sensor 304 | 305 | This example reads color data from the on-board APDS-9960 sensor of the 306 | Nano 33 BLE Sense and prints the color RGB (red, green, blue) values 307 | to the Serial Monitor once a second. 308 | 309 | The circuit: 310 | - Arduino Nano 33 BLE Sense. 311 | 312 | This example code is in the public domain. 313 | */ 314 | 315 | #include 316 | 317 | void setup() { 318 | Serial.begin(9600); 319 | while (!Serial); 320 | 321 | if (!APDS.begin()) { 322 | Serial.println("Error initializing APDS-9960 sensor."); 323 | } 324 | } 325 | 326 | void loop() { 327 | // Check if a color reading is available. 328 | while (!APDS.colorAvailable()) { 329 | delay(5); 330 | } 331 | 332 | int r, g, b; 333 | 334 | // Read the color. 335 | APDS.readColor(r, g, b); 336 | 337 | // Print the values: 338 | Serial.print("r = "); 339 | Serial.println(r); 340 | Serial.print("g = "); 341 | Serial.println(g); 342 | Serial.print("b = "); 343 | Serial.println(b); 344 | Serial.println(); 345 | 346 | // Wait a bit before reading again. 347 | delay(1000); 348 | } 349 | ``` 350 | 351 | #### See also 352 | 353 | * [begin()](#begin) 354 | * [end()](#end) 355 | * [gestureAvailable()](#readgesture) 356 | * [readGesture()](#coloravailable) 357 | * [colorAvailable()](#readcolor) 358 | * [proximityAvailable()](#proximityavailable) 359 | * [readProximity()](#readproximity) 360 | * [setGestureSensitivity()](#setgesturesensitivity) 361 | * [setInterruptPin()](#setinterruptpin) 362 | * [setLEDBoost()](#setledboost) 363 | 364 | ### `colorAvailable()` 365 | 366 | Check if a color reading is available from the senor. The color reading can be retrieved using the `APDS.readColor(...)` function. This function also enables the color sensor when called for the first time. 367 | 368 | #### Syntax 369 | 370 | ``` 371 | APDS.colorAvailable() 372 | ``` 373 | 374 | #### Parameters 375 | 376 | None. 377 | 378 | #### Returns 379 | 380 | 1 if a color has been read, otherwise 0. 381 | 382 | #### Example 383 | 384 | ``` 385 | // Check if a color reading is available. 386 | if (APDS.colorAvailable()) { 387 | int r, g, b; 388 | 389 | // Read the color. 390 | APDS.readColor(r, g, b); 391 | } 392 | ``` 393 | 394 | #### See also 395 | 396 | * [begin()](#begin) 397 | * [end()](#end) 398 | * [gestureAvailable()](#readgesture) 399 | * [readGesture()](#coloravailable) 400 | * [readColor()](#readcolor) 401 | * [proximityAvailable()](#proximityavailable) 402 | * [readProximity()](#readproximity) 403 | * [setGestureSensitivity()](#setgesturesensitivity) 404 | * [setInterruptPin()](#setinterruptpin) 405 | * [setLEDBoost()](#setledboost) 406 | 407 | ### `proximityAvailable()` 408 | 409 | Check if a proximity reading is available from the senor. The proximity reading can be retrieved using the `APDS.readProximity()` function. This function also enables the proximity sensor when called for the first time. 410 | 411 | #### Syntax 412 | 413 | ``` 414 | APDS.proximityAvailable() 415 | ``` 416 | 417 | #### Parameters 418 | 419 | None. 420 | 421 | #### Returns 422 | 423 | 1 if a proximity has been read, otherwise 0 424 | 425 | #### Example 426 | 427 | ``` 428 | // Check if a proximity reading is available. 429 | if (APDS.proximityAvailable()) { 430 | int proximity = APDS.readProximity(); 431 | Serial.println(proximity); 432 | } 433 | ``` 434 | 435 | #### See also 436 | 437 | * [begin()](#begin) 438 | * [end()](#end) 439 | * [gestureAvailable()](#readgesture) 440 | * [readGesture()](#coloravailable) 441 | * [readColor()](#readcolor) 442 | * [colorAvailable()](#proximityavailable) 443 | * [readProximity()](#readproximity) 444 | * [setGestureSensitivity()](#setgesturesensitivity) 445 | * [setInterruptPin()](#setinterruptpin) 446 | * [setLEDBoost()](#setledboost) 447 | 448 | ### `readProximity()` 449 | 450 | Retrieve the proximity read from the sensor. You can check if a proximity has been read by the sensor and may be retrieved using the `APDS.proximityAvailable()` function. 451 | 452 | #### Syntax 453 | 454 | ``` 455 | APDS.readProximity() 456 | ``` 457 | 458 | #### Parameters 459 | 460 | None. 461 | 462 | #### Returns 463 | 464 | The detected proximity that may range from 0 to 255 where 0 is the closest and 255 is the farthest. The function returns -1 in case of error. 465 | 466 | #### Example 467 | 468 | ``` 469 | /* 470 | APDS-9960 - Proximity Sensor 471 | 472 | This example reads proximity data from the on-board APDS-9960 sensor of the 473 | Nano 33 BLE Sense and prints the proximity value to the Serial Monitor 474 | every 100 ms. 475 | 476 | The circuit: 477 | - Arduino Nano 33 BLE Sense. 478 | 479 | This example code is in the public domain. 480 | */ 481 | 482 | #include 483 | 484 | void setup() { 485 | Serial.begin(9600); 486 | while (!Serial); 487 | 488 | if (!APDS.begin()) { 489 | Serial.println("Error initializing APDS-9960 sensor."); 490 | } 491 | } 492 | 493 | void loop() { 494 | // Check if a proximity reading is available. 495 | if (APDS.proximityAvailable()) { 496 | // Read the proximity where: 497 | // - 0 => close 498 | // - 255 => far 499 | // - -1 => error 500 | int proximity = APDS.readProximity(); 501 | 502 | // Print value to the Serial Monitor. 503 | Serial.println(proximity); 504 | } 505 | 506 | // Wait a bit before reading again. 507 | delay(100); 508 | } 509 | ``` 510 | 511 | #### See also 512 | 513 | * [begin()](#begin) 514 | * [end()](#end) 515 | * [gestureAvailable()](#readgesture) 516 | * [readGesture()](#coloravailable) 517 | * [readColor()](#readcolor) 518 | * [colorAvailable()](#proximityavailable) 519 | * [proximityAvailable](#readproximity) 520 | * [setGestureSensitivity()](#setgesturesensitivity) 521 | * [setInterruptPin()](#setinterruptpin) 522 | * [setLEDBoost()](#setledboost) 523 | 524 | ### `setGestureSensitivity()` 525 | 526 | Sets APDS gesture sensor sensitivity. 527 | 528 | #### Syntax 529 | 530 | ``` 531 | APDS.setGestureSensitivity(sensitivity) 532 | ``` 533 | 534 | #### Parameters 535 | 536 | * _sensitivity_: The desired gesture sensitivity a value between 1 and 100 is required. Higher values makes the gesture recognition more sensible but less accurate (a wrong gesture may be detected), lower values makes the gesture recognition more accurate but less sensible (some gestures may be missed). The default sensitivity value is 80. 537 | 538 | #### Returns 539 | 540 | None. 541 | 542 | #### Example 543 | 544 | ``` 545 | APDS.setGestureSensitivity(90); 546 | ``` 547 | 548 | #### See also 549 | 550 | * [begin()](#begin) 551 | * [end()](#end) 552 | * [gestureAvailable()](#readgesture) 553 | * [readGesture()](#coloravailable) 554 | * [readColor()](#readcolor) 555 | * [colorAvailable()](#proximityavailable) 556 | * [proximityAvailable](#readproximity) 557 | * [readProximity()](#setgesturesensitivity) 558 | * [setInterruptPin()](#setinterruptpin) 559 | * [setLEDBoost()](#setledboost) 560 | 561 | ### `setInterruptPin()` 562 | 563 | Sets APDS chip interrupt pin. The library tries to set the correct interrupt pin automatically based on the available board data. This function may be used in case the default pin is not correct or not available. The sensor is read even if the interrupt pin is not set or automatically found; setting the interrupt pin manually, if not automatically found, will increase performance. 564 | 565 | #### Syntax 566 | 567 | ``` 568 | APDS.setInterruptPin(pin) 569 | ``` 570 | 571 | #### Parameters 572 | 573 | * _pin_: the board pin where the sensor interrupt pin is connected, or -1 if not connected. 574 | 575 | #### Returns 576 | 577 | None. 578 | 579 | #### Example 580 | 581 | ``` 582 | APDS.setInterruptPin(x); 583 | ``` 584 | 585 | #### See also 586 | 587 | * [begin()](#begin) 588 | * [end()](#end) 589 | * [gestureAvailable()](#readgesture) 590 | * [readGesture()](#coloravailable) 591 | * [readColor()](#readcolor) 592 | * [colorAvailable()](#proximityavailable) 593 | * [proximityAvailable](#readproximity) 594 | * [readProximity()](#setgesturesensitivity) 595 | * [setGestureSensitivity()](#setinterruptpin) 596 | * [setLEDBoost()](#setledboost) 597 | 598 | ### `setLEDBoost()` 599 | 600 | Sets APDS LED boost to increase the power of the infra-red LED emitters embedded into the sensor. Up to 3 times of the nominal power may be set. 601 | 602 | #### Syntax 603 | 604 | ``` 605 | APDS.setLEDBoost(boost_mode) 606 | ``` 607 | 608 | #### Parameters 609 | 610 | * _boost_mode_: a number, between 0 and 3, that specify the desired power increase. 0 sets boost to 100% (this is the default power value), 1 sets boost to 150%, 2 sets boost to 200% and 3 sets boost to 300%. 611 | 612 | #### Returns 613 | 614 | 1 on success, 0 on failure 615 | 616 | #### Example 617 | 618 | ``` 619 | // Set LED output to maximum power. 620 | APDS.setLEDBoost(3); 621 | ``` 622 | 623 | #### See also 624 | 625 | * [begin()](#begin) 626 | * [end()](#end) 627 | * [gestureAvailable()](#gestureavailable) 628 | * [readGesture()](#readgesture) 629 | * [colorAvailable()](#coloravailable) 630 | * [readColor()](#readcolor) 631 | * [proximityAvailable()](#proximityavailable) 632 | * [readProximity()](#readproximity) 633 | * [setGestureSensitivity()](#setgesturesensitivity) 634 | * [setInterruptPin()](#setinterruptpin) -------------------------------------------------------------------------------- /docs/readme.md: -------------------------------------------------------------------------------- 1 | # ArduinoAPDS9960 library 2 | 3 | The ArduinoAPDS9960 library allows you to use the [APDS9960](https://docs.broadcom.com/docs/AV02-4191EN) sensor available on the Arduino® Nano 33 BLE Sense to read gestures, color, light intensity and proximity. The gestures readings are based on the detection of the movement of the hand over four photodiodes inside the sensor, while proximity is read by the amount of infrared light reflected by something (anything that reflects IR) back to the sensor. Color is given as a 16-bit value for R, G, B and white components; if the light that hits the sensor is the ambient one and not a reflection on some object, it is possible to calculate the color temperature, otherwise it is possible to detect the color of the object that is reflecting light onto the sensor. 4 | 5 | To use this library: 6 | 7 | ``` 8 | #include 9 | ``` 10 | -------------------------------------------------------------------------------- /examples/ColorSensor/ColorSensor.ino: -------------------------------------------------------------------------------- 1 | /* 2 | APDS-9960 - Color Sensor 3 | 4 | This example reads color data from the on-board APDS-9960 sensor of the 5 | Nano 33 BLE Sense and prints the color RGB (red, green, blue) values 6 | to the Serial Monitor once a second. 7 | 8 | The circuit: 9 | - Arduino Nano 33 BLE Sense 10 | 11 | This example code is in the public domain. 12 | */ 13 | 14 | #include 15 | 16 | void setup() { 17 | Serial.begin(9600); 18 | while (!Serial); 19 | 20 | if (!APDS.begin()) { 21 | Serial.println("Error initializing APDS-9960 sensor."); 22 | } 23 | } 24 | 25 | void loop() { 26 | // check if a color reading is available 27 | while (! APDS.colorAvailable()) { 28 | delay(5); 29 | } 30 | int r, g, b; 31 | 32 | // read the color 33 | APDS.readColor(r, g, b); 34 | 35 | // print the values 36 | Serial.print("r = "); 37 | Serial.println(r); 38 | Serial.print("g = "); 39 | Serial.println(g); 40 | Serial.print("b = "); 41 | Serial.println(b); 42 | Serial.println(); 43 | 44 | // wait a bit before reading again 45 | delay(1000); 46 | } 47 | -------------------------------------------------------------------------------- /examples/FullExample/FullExample.ino: -------------------------------------------------------------------------------- 1 | /* 2 | APDS-9960 - All sensor data from APDS-9960 3 | 4 | This example reads all data from the on-board APDS-9960 sensor of the 5 | Nano 33 BLE Sense: 6 | - color RGB (red, green, blue) 7 | - proximity 8 | - gesture 9 | and prints updates to the Serial Monitor every 100 ms. 10 | 11 | The circuit: 12 | - Arduino Nano 33 BLE Sense 13 | 14 | This example code is in the public domain. 15 | */ 16 | 17 | #include 18 | 19 | void setup() { 20 | Serial.begin(9600); 21 | while (!Serial); // Wait for Serial Monitor to open 22 | 23 | if (!APDS.begin()) { 24 | Serial.println("Error initializing APDS-9960 sensor."); 25 | while (true); // Stop forever 26 | } 27 | } 28 | 29 | int proximity = 0; 30 | int r = 0, g = 0, b = 0; 31 | unsigned long lastUpdate = 0; 32 | 33 | void loop() { 34 | 35 | // Check if a proximity reading is available. 36 | if (APDS.proximityAvailable()) { 37 | proximity = APDS.readProximity(); 38 | } 39 | 40 | // Check if a gesture reading is available 41 | if (APDS.gestureAvailable()) { 42 | int gesture = APDS.readGesture(); 43 | switch (gesture) { 44 | case GESTURE_UP: 45 | Serial.println("Detected UP gesture"); 46 | break; 47 | 48 | case GESTURE_DOWN: 49 | Serial.println("Detected DOWN gesture"); 50 | break; 51 | 52 | case GESTURE_LEFT: 53 | Serial.println("Detected LEFT gesture"); 54 | break; 55 | 56 | case GESTURE_RIGHT: 57 | Serial.println("Detected RIGHT gesture"); 58 | break; 59 | 60 | default: 61 | // Ignore 62 | break; 63 | } 64 | } 65 | 66 | // Check if a color reading is available 67 | if (APDS.colorAvailable()) { 68 | APDS.readColor(r, g, b); 69 | } 70 | 71 | // Print updates every 100 ms 72 | if (millis() - lastUpdate > 100) { 73 | lastUpdate = millis(); 74 | Serial.print("PR="); 75 | Serial.print(proximity); 76 | Serial.print(" RGB="); 77 | Serial.print(r); 78 | Serial.print(","); 79 | Serial.print(g); 80 | Serial.print(","); 81 | Serial.println(b); 82 | } 83 | } 84 | -------------------------------------------------------------------------------- /examples/GestureSensor/GestureSensor.ino: -------------------------------------------------------------------------------- 1 | /* 2 | APDS-9960 - Gesture Sensor 3 | 4 | This example reads gesture data from the on-board APDS-9960 sensor of the 5 | Nano 33 BLE Sense and prints any detected gestures to the Serial Monitor. 6 | 7 | Gesture directions are as follows: 8 | - UP: from USB connector towards antenna 9 | - DOWN: from antenna towards USB connector 10 | - LEFT: from analog pins side towards digital pins side 11 | - RIGHT: from digital pins side towards analog pins side 12 | 13 | The circuit: 14 | - Arduino Nano 33 BLE Sense 15 | 16 | This example code is in the public domain. 17 | */ 18 | 19 | #include 20 | 21 | void setup() { 22 | Serial.begin(9600); 23 | while (!Serial); 24 | 25 | if (!APDS.begin()) { 26 | Serial.println("Error initializing APDS-9960 sensor!"); 27 | } 28 | 29 | // for setGestureSensitivity(..) a value between 1 and 100 is required. 30 | // Higher values make the gesture recognition more sensitive but less accurate 31 | // (a wrong gesture may be detected). Lower values makes the gesture recognition 32 | // more accurate but less sensitive (some gestures may be missed). 33 | // Default is 80 34 | //APDS.setGestureSensitivity(80); 35 | 36 | Serial.println("Detecting gestures ..."); 37 | } 38 | void loop() { 39 | if (APDS.gestureAvailable()) { 40 | // a gesture was detected, read and print to Serial Monitor 41 | int gesture = APDS.readGesture(); 42 | 43 | switch (gesture) { 44 | case GESTURE_UP: 45 | Serial.println("Detected UP gesture"); 46 | break; 47 | 48 | case GESTURE_DOWN: 49 | Serial.println("Detected DOWN gesture"); 50 | break; 51 | 52 | case GESTURE_LEFT: 53 | Serial.println("Detected LEFT gesture"); 54 | break; 55 | 56 | case GESTURE_RIGHT: 57 | Serial.println("Detected RIGHT gesture"); 58 | break; 59 | 60 | default: 61 | // ignore 62 | break; 63 | } 64 | } 65 | } 66 | -------------------------------------------------------------------------------- /examples/ProximitySensor/ProximitySensor.ino: -------------------------------------------------------------------------------- 1 | /* 2 | APDS-9960 - Proximity Sensor 3 | 4 | This example reads proximity data from the on-board APDS-9960 sensor of the 5 | Nano 33 BLE Sense and prints the proximity value to the Serial Monitor 6 | every 100 ms. 7 | 8 | The circuit: 9 | - Arduino Nano 33 BLE Sense 10 | 11 | This example code is in the public domain. 12 | */ 13 | 14 | #include 15 | 16 | void setup() { 17 | Serial.begin(9600); 18 | while (!Serial); 19 | 20 | if (!APDS.begin()) { 21 | Serial.println("Error initializing APDS-9960 sensor!"); 22 | } 23 | } 24 | 25 | void loop() { 26 | // check if a proximity reading is available 27 | if (APDS.proximityAvailable()) { 28 | // read the proximity 29 | // - 0 => close 30 | // - 255 => far 31 | // - -1 => error 32 | int proximity = APDS.readProximity(); 33 | 34 | // print value to the Serial Monitor 35 | Serial.println(proximity); 36 | } 37 | 38 | // wait a bit before reading again 39 | delay(100); 40 | } 41 | -------------------------------------------------------------------------------- /keywords.txt: -------------------------------------------------------------------------------- 1 | ########################################### 2 | # Syntax Coloring Map For Arduino_APDS9960 3 | ########################################### 4 | # Class 5 | ########################################### 6 | 7 | Arduino_APDS9960 KEYWORD1 8 | APDS9960 KEYWORD1 9 | APDS KEYWORD1 10 | 11 | ########################################### 12 | # Methods and Functions 13 | ########################################### 14 | 15 | begin KEYWORD2 16 | end KEYWORD2 17 | 18 | gestureAvailable KEYWORD2 19 | readGesture KEYWORD2 20 | colorAvailable KEYWORD2 21 | readColor KEYWORD2 22 | proximityAvailable KEYWORD2 23 | readProximity KEYWORD2 24 | setGestureSensitivity KEYWORD2 25 | setInterruptPin KEYWORD2 26 | setLEDBoost KEYWORD2 27 | 28 | ########################################### 29 | # Constants 30 | ########################################### 31 | 32 | GESTURE_NONE LITERAL1 33 | GESTURE_UP LITERAL1 34 | GESTURE_DOWN LITERAL1 35 | GESTURE_LEFT LITERAL1 36 | GESTURE_RIGHT LITERAL1 37 | -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=Arduino_APDS9960 2 | version=1.0.4 3 | author=Arduino 4 | maintainer=Arduino 5 | sentence=A library for the APDS-9960 sensor 6 | paragraph=allows reading gestures, color, and proximity on your Arduino Nano 33 BLE Sense board and other boards with a sensor attached via I2C. 7 | category=Sensors 8 | url=https://github.com/arduino-libraries/Arduino_APDS9960 9 | architectures=* 10 | includes=Arduino_APDS9960.h 11 | -------------------------------------------------------------------------------- /src/Arduino_APDS9960.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | This file is part of the Arduino_APDS9960 library. 3 | Copyright (c) 2019 Arduino SA. All rights reserved. 4 | 5 | This library is free software; you can redistribute it and/or 6 | modify it under the terms of the GNU Lesser General Public 7 | License as published by the Free Software Foundation; either 8 | version 2.1 of the License, or (at your option) any later version. 9 | 10 | This library is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 | Lesser General Public License for more details. 14 | 15 | You should have received a copy of the GNU Lesser General Public 16 | License along with this library; if not, write to the Free Software 17 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 18 | */ 19 | 20 | #include 21 | 22 | APDS9960::APDS9960(TwoWire& wire, int intPin) : 23 | _wire(wire), 24 | _intPin(intPin), 25 | _gestureEnabled(false), 26 | _proximityEnabled(false), 27 | _colorEnabled(false), 28 | _gestureIn(false), 29 | _gestureDirectionX(0), 30 | _gestureDirectionY(0), 31 | _gestureDirInX(0), 32 | _gestureDirInY(0), 33 | _gestureSensitivity(20), 34 | _detectedGesture(GESTURE_NONE) 35 | { 36 | } 37 | 38 | APDS9960::~APDS9960() 39 | { 40 | } 41 | 42 | bool APDS9960::begin() { 43 | _wire.begin(); 44 | 45 | // Check ID register 46 | uint8_t id; 47 | if (!getID(&id)) return false; 48 | if (id!=0xAB) return false; 49 | 50 | // Disable everything 51 | if (!setENABLE(0x00)) return false; 52 | if (!setWTIME(0xFF)) return false; 53 | if (!setGPULSE(0x8F)) return false; // 16us, 16 pulses // default is: 0x40 = 8us, 1 pulse 54 | if (!setPPULSE(0x8F)) return false; // 16us, 16 pulses // default is: 0x40 = 8us, 1 pulse 55 | if (!setGestureIntEnable(true)) return false; 56 | if (!setGestureMode(true)) return false; 57 | if (!enablePower()) return false; 58 | if (!enableWait()) return false; 59 | // set ADC integration time to 10 ms 60 | if (!setATIME(256 - (10 / 2.78))) return false; 61 | // set ADC gain 4x (0x00 => 1x, 0x01 => 4x, 0x02 => 16x, 0x03 => 64x) 62 | if (!setCONTROL(0x02)) return false; 63 | delay(10); 64 | // enable power 65 | if (!enablePower()) return false; 66 | 67 | if (_intPin > -1) { 68 | pinMode(_intPin, INPUT); 69 | } 70 | 71 | return true; 72 | } 73 | 74 | void APDS9960::end() { 75 | // Disable everything 76 | setENABLE(0x00); 77 | 78 | _gestureEnabled = false; 79 | 80 | _wire.end(); 81 | } 82 | 83 | // Sets the LED current boost value: 84 | // 0=100%, 1=150%, 2=200%, 3=300% 85 | bool APDS9960::setLEDBoost(uint8_t boost) { 86 | uint8_t r; 87 | if (!getCONFIG2(&r)) return false; 88 | r &= 0b11001111; 89 | r |= (boost << 4) & 0b00110000; 90 | return setCONFIG2(r); 91 | } 92 | 93 | void APDS9960::setGestureSensitivity(uint8_t sensitivity) { 94 | if (sensitivity > 100) sensitivity = 100; 95 | _gestureSensitivity = 100 - sensitivity; 96 | } 97 | 98 | void APDS9960::setInterruptPin(int pin) { 99 | _intPin = pin; 100 | } 101 | 102 | bool APDS9960::setGestureIntEnable(bool en) { 103 | uint8_t r; 104 | if (!getGCONF4(&r)) return false; 105 | if (en) { 106 | r |= 0b00000010; 107 | } else { 108 | r &= 0b11111101; 109 | } 110 | return setGCONF4(r); 111 | } 112 | 113 | bool APDS9960::setGestureMode(bool en) 114 | { 115 | uint8_t r; 116 | if (!getGCONF4(&r)) return false; 117 | if (en) { 118 | r |= 0b00000001; 119 | } else { 120 | r &= 0b11111110; 121 | } 122 | return setGCONF4(r); 123 | } 124 | 125 | bool APDS9960::enablePower() { 126 | uint8_t r; 127 | if (!getENABLE(&r)) return false; 128 | if ((r & 0b00000001) != 0) return true; 129 | r |= 0b00000001; 130 | return setENABLE(r); 131 | } 132 | 133 | bool APDS9960::disablePower() { 134 | uint8_t r; 135 | if (!getENABLE(&r)) return false; 136 | if ((r & 0b00000001) == 0) return true; 137 | r &= 0b11111110; 138 | return setENABLE(r); 139 | } 140 | 141 | bool APDS9960::enableColor() { 142 | uint8_t r; 143 | if (!getENABLE(&r)) return false; 144 | if ((r & 0b00000010) != 0) { 145 | _colorEnabled = true; 146 | return true; 147 | } 148 | r |= 0b00000010; 149 | bool res = setENABLE(r); 150 | _colorEnabled = res; 151 | return res; 152 | } 153 | 154 | bool APDS9960::disableColor() { 155 | uint8_t r; 156 | if (!getENABLE(&r)) return false; 157 | if ((r & 0b00000010) == 0) { 158 | _colorEnabled = false; 159 | return true; 160 | } 161 | r &= 0b11111101; 162 | bool res = setENABLE(r); 163 | _colorEnabled = !res; // (res == true) if successfully disabled 164 | return res; 165 | } 166 | 167 | bool APDS9960::enableProximity() { 168 | uint8_t r; 169 | if (!getENABLE(&r)) return false; 170 | if ((r & 0b00000100) != 0) { 171 | _proximityEnabled = true; 172 | return true; 173 | } 174 | r |= 0b00000100; 175 | bool res = setENABLE(r); 176 | _proximityEnabled = res; 177 | return res; 178 | } 179 | 180 | bool APDS9960::disableProximity() { 181 | uint8_t r; 182 | if (!getENABLE(&r)) return false; 183 | if ((r & 0b00000100) == 0) { 184 | _proximityEnabled = false; 185 | return true; 186 | } 187 | r &= 0b11111011; 188 | bool res = setENABLE(r); 189 | _proximityEnabled = !res; // (res == true) if successfully disabled 190 | return res; 191 | } 192 | 193 | bool APDS9960::enableWait() { 194 | uint8_t r; 195 | if (!getENABLE(&r)) return false; 196 | if ((r & 0b00001000) != 0) return true; 197 | r |= 0b00001000; 198 | return setENABLE(r); 199 | } 200 | 201 | bool APDS9960::disableWait() { 202 | uint8_t r; 203 | if (!getENABLE(&r)) return false; 204 | if ((r & 0b00001000) == 0) return true; 205 | r &= 0b11110111; 206 | return setENABLE(r); 207 | } 208 | 209 | bool APDS9960::enableGesture() { 210 | uint8_t r; 211 | if (!getENABLE(&r)) return false; 212 | if ((r & 0b01000000) != 0) { 213 | _gestureEnabled = true; 214 | return true; 215 | } 216 | r |= 0b01000000; 217 | bool res = setENABLE(r); 218 | _gestureEnabled = res; 219 | return res; 220 | } 221 | 222 | bool APDS9960::disableGesture() { 223 | uint8_t r; 224 | if (!getENABLE(&r)) return false; 225 | if ((r & 0b01000000) == 0) { 226 | _gestureEnabled = false; 227 | return true; 228 | } 229 | r &= 0b10111111; 230 | bool res = setENABLE(r); 231 | _gestureEnabled = !res; // (res == true) if successfully disabled 232 | return res; 233 | } 234 | 235 | #define APDS9960_ADDR 0x39 236 | 237 | bool APDS9960::write(uint8_t val) { 238 | _wire.beginTransmission(APDS9960_ADDR); 239 | _wire.write(val); 240 | return _wire.endTransmission() == 0; 241 | } 242 | 243 | bool APDS9960::write(uint8_t reg, uint8_t val) { 244 | _wire.beginTransmission(APDS9960_ADDR); 245 | _wire.write(reg); 246 | _wire.write(val); 247 | return _wire.endTransmission() == 0; 248 | } 249 | 250 | bool APDS9960::read(uint8_t reg, uint8_t *val) { 251 | if (!write(reg)) return false; 252 | _wire.requestFrom(APDS9960_ADDR, 1); 253 | if (!_wire.available()) return false; 254 | *val = _wire.read(); 255 | return true; 256 | } 257 | 258 | size_t APDS9960::readBlock(uint8_t reg, uint8_t *val, unsigned int len) { 259 | size_t i = 0; 260 | if (!write(reg)) return 0; 261 | _wire.requestFrom((uint8_t)APDS9960_ADDR, len); 262 | while (_wire.available()) { 263 | if (i == len) return 0; 264 | val[i++] = _wire.read(); 265 | } 266 | return i; 267 | } 268 | 269 | int APDS9960::gestureFIFOAvailable() { 270 | uint8_t r; 271 | if (!getGSTATUS(&r)) return -1; 272 | if ((r & 0x01) == 0x00) return -2; 273 | if (!getGFLVL(&r)) return -3; 274 | return r; 275 | } 276 | 277 | int APDS9960::handleGesture() { 278 | const int gestureThreshold = 30; 279 | while (true) { 280 | int available = gestureFIFOAvailable(); 281 | if (available <= 0) return 0; 282 | 283 | uint8_t fifo_data[128]; 284 | uint8_t bytes_read = readGFIFO_U(fifo_data, available * 4); 285 | if (bytes_read == 0) return 0; 286 | 287 | for (int i = 0; i+3 < bytes_read; i+=4) { 288 | uint8_t u,d,l,r; 289 | u = fifo_data[i]; 290 | d = fifo_data[i+1]; 291 | l = fifo_data[i+2]; 292 | r = fifo_data[i+3]; 293 | // Serial.print(u); 294 | // Serial.print(","); 295 | // Serial.print(d); 296 | // Serial.print(","); 297 | // Serial.print(l); 298 | // Serial.print(","); 299 | // Serial.println(r); 300 | 301 | if (u _gestureSensitivity) { _detectedGesture = GESTURE_RIGHT; } 312 | if (totalY < -_gestureSensitivity) { _detectedGesture = GESTURE_DOWN; } 313 | if (totalY > _gestureSensitivity) { _detectedGesture = GESTURE_UP; } 314 | _gestureDirectionX = 0; 315 | _gestureDirectionY = 0; 316 | _gestureDirInX = 0; 317 | _gestureDirInY = 0; 318 | } 319 | continue; 320 | } 321 | 322 | _gestureDirectionX = r - l; 323 | _gestureDirectionY = u - d; 324 | if (_gestureIn) { 325 | _gestureIn = false; 326 | _gestureDirInX = _gestureDirectionX; 327 | _gestureDirInY = _gestureDirectionY; 328 | // Serial.print("IN "); 329 | // Serial.print(_gestureDirInX); 330 | // Serial.print(","); 331 | // Serial.print(_gestureDirInY); 332 | // Serial.print(" "); 333 | } 334 | } 335 | } 336 | } 337 | 338 | int APDS9960::gestureAvailable() { 339 | if (!_gestureEnabled) enableGesture(); 340 | 341 | if (_intPin > -1) { 342 | if (digitalRead(_intPin) != LOW) { 343 | return 0; 344 | } 345 | } else if (gestureFIFOAvailable() <= 0) { 346 | return 0; 347 | } 348 | 349 | handleGesture(); 350 | if (_proximityEnabled) { 351 | setGestureMode(false); 352 | } 353 | return (_detectedGesture == GESTURE_NONE) ? 0 : 1; 354 | } 355 | 356 | int APDS9960::readGesture() { 357 | int gesture = _detectedGesture; 358 | 359 | _detectedGesture = GESTURE_NONE; 360 | 361 | return gesture; 362 | } 363 | 364 | int APDS9960::colorAvailable() { 365 | uint8_t r; 366 | 367 | enableColor(); 368 | 369 | if (!getSTATUS(&r)) { 370 | return 0; 371 | } 372 | 373 | if (r & 0b00000001) { 374 | return 1; 375 | } 376 | 377 | return 0; 378 | } 379 | 380 | bool APDS9960::readColor(int& r, int& g, int& b) { 381 | int c; 382 | 383 | return readColor(r, g, b, c); 384 | } 385 | 386 | bool APDS9960::readColor(int& r, int& g, int& b, int& c) { 387 | uint16_t colors[4]; 388 | 389 | if (!readCDATAL((uint8_t *)colors, sizeof(colors))) { 390 | r = -1; 391 | g = -1; 392 | b = -1; 393 | c = -1; 394 | 395 | return false; 396 | } 397 | 398 | c = colors[0]; 399 | r = colors[1]; 400 | g = colors[2]; 401 | b = colors[3]; 402 | 403 | disableColor(); 404 | 405 | return true; 406 | } 407 | 408 | int APDS9960::proximityAvailable() { 409 | uint8_t r; 410 | 411 | enableProximity(); 412 | 413 | if (!getSTATUS(&r)) { 414 | return 0; 415 | } 416 | 417 | if (r & 0b00000010) { 418 | return 1; 419 | } 420 | 421 | return 0; 422 | } 423 | 424 | int APDS9960::readProximity() { 425 | uint8_t r; 426 | 427 | if (!getPDATA(&r)) { 428 | return -1; 429 | } 430 | 431 | disableProximity(); 432 | 433 | return (255 - r); 434 | } 435 | 436 | #if defined(APDS9960_INT_PIN) 437 | APDS9960 APDS(APDS9960_WIRE_INSTANCE, APDS9960_INT_PIN); 438 | #elif defined(ARDUINO_ARDUINO_NANO33BLE) 439 | APDS9960 APDS(Wire1, PIN_INT_APDS); 440 | #else 441 | APDS9960 APDS(Wire, -1); 442 | #endif 443 | -------------------------------------------------------------------------------- /src/Arduino_APDS9960.h: -------------------------------------------------------------------------------- 1 | /* 2 | This file is part of the Arduino_APDS9960 library. 3 | Copyright (c) 2019 Arduino SA. All rights reserved. 4 | 5 | This library is free software; you can redistribute it and/or 6 | modify it under the terms of the GNU Lesser General Public 7 | License as published by the Free Software Foundation; either 8 | version 2.1 of the License, or (at your option) any later version. 9 | 10 | This library is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 | Lesser General Public License for more details. 14 | 15 | You should have received a copy of the GNU Lesser General Public 16 | License along with this library; if not, write to the Free Software 17 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 18 | */ 19 | 20 | #ifndef ARDUINO_APDS9960 21 | #define ARDUINO_APDS9960 22 | 23 | #include 24 | #include 25 | 26 | enum { 27 | GESTURE_NONE = -1, 28 | GESTURE_UP = 0, 29 | GESTURE_DOWN = 1, 30 | GESTURE_LEFT = 2, 31 | GESTURE_RIGHT = 3 32 | }; 33 | 34 | class APDS9960 { 35 | public: 36 | APDS9960(TwoWire &wire, int intPin); 37 | virtual ~APDS9960(); 38 | 39 | bool begin(); 40 | void end(); 41 | 42 | int gestureAvailable(); 43 | int readGesture(); 44 | 45 | int colorAvailable(); 46 | bool readColor(int& r, int& g, int& b); 47 | bool readColor(int& r, int& g, int& b, int& c); 48 | 49 | int proximityAvailable(); 50 | int readProximity(); 51 | 52 | void setGestureSensitivity(uint8_t sensitivity); 53 | 54 | void setInterruptPin(int pin); 55 | 56 | bool setLEDBoost(uint8_t boost); 57 | 58 | private: 59 | bool setGestureIntEnable(bool en); 60 | bool setGestureMode(bool en); 61 | int gestureFIFOAvailable(); 62 | int handleGesture(); 63 | 64 | bool enablePower(); 65 | bool disablePower(); 66 | bool enableColor(); 67 | bool disableColor(); 68 | bool enableProximity(); 69 | bool disableProximity(); 70 | bool enableWait(); 71 | bool disableWait(); 72 | bool enableGesture(); 73 | bool disableGesture(); 74 | 75 | private: 76 | TwoWire& _wire; 77 | int _intPin; 78 | 79 | bool _gestureEnabled; 80 | bool _proximityEnabled; 81 | bool _colorEnabled; 82 | bool _gestureIn; 83 | int _gestureDirectionX; 84 | int _gestureDirectionY; 85 | int _gestureDirInX; 86 | int _gestureDirInY; 87 | int _gestureSensitivity; 88 | int _detectedGesture; 89 | 90 | bool write(uint8_t val); 91 | bool write(uint8_t reg, uint8_t val); 92 | bool read(uint8_t reg, uint8_t *val); 93 | size_t readBlock(uint8_t reg, uint8_t *val, unsigned int len); 94 | 95 | private: 96 | #define REG(name, addr) \ 97 | bool get##name(uint8_t *val) { return read(addr, val); } \ 98 | bool set##name(uint8_t val) { return write(addr, val); } \ 99 | size_t read##name(uint8_t *val, uint8_t len) { return readBlock(addr, val, len); } 100 | REG(ENABLE, 0x80) 101 | REG(ATIME, 0x81) 102 | REG(WTIME, 0x83) 103 | REG(AILTL, 0x84) 104 | REG(AILTH, 0x85) 105 | REG(AIHTL, 0x86) 106 | REG(AIHTH, 0x87) 107 | REG(PILT, 0x89) 108 | REG(PIHT, 0x8B) 109 | REG(PERS, 0x8C) 110 | REG(CONFIG1, 0x8D) 111 | REG(PPULSE, 0x8E) 112 | REG(CONTROL, 0x8F) 113 | REG(CONFIG2, 0x90) 114 | REG(ID, 0x92) 115 | REG(STATUS, 0x93) 116 | REG(CDATAL, 0x94) 117 | REG(CDATAH, 0x95) 118 | REG(RDATAL, 0x96) 119 | REG(RDATAH, 0x97) 120 | REG(GDATAL, 0x98) 121 | REG(GDATAH, 0x99) 122 | REG(BDATAL, 0x9A) 123 | REG(BDATAH, 0x9B) 124 | REG(PDATA, 0x9C) 125 | REG(POFFSET_UR, 0x9D) 126 | REG(POFFSET_DL, 0x9E) 127 | REG(CONFIG3, 0x9F) 128 | REG(GPENTH, 0xA0) 129 | REG(GEXTH, 0xA1) 130 | REG(GCONF1, 0xA2) 131 | REG(GCONF2, 0xA3) 132 | REG(GOFFSET_U, 0xA4) 133 | REG(GOFFSET_D, 0xA5) 134 | REG(GPULSE, 0xA6) 135 | REG(GOFFSET_L, 0xA7) 136 | REG(GOFFSET_R, 0xA9) 137 | REG(GCONF3, 0xAA) 138 | REG(GCONF4, 0xAB) 139 | REG(GFLVL, 0xAE) 140 | REG(GSTATUS, 0xAF) 141 | REG(IFORCE, 0xE4) 142 | REG(PICLEAR, 0xE5) 143 | REG(CICLEAR, 0xE6) 144 | REG(AICLEAR, 0xE7) 145 | REG(GFIFO_U, 0xFC) 146 | REG(GFIFO_D, 0xFD) 147 | REG(GFIFO_L, 0xFE) 148 | REG(GFIFO_R, 0xFF) 149 | }; 150 | 151 | extern APDS9960 APDS; 152 | 153 | #endif // ARDUINO_APDS9960 154 | --------------------------------------------------------------------------------