├── .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 ├── ReadSensors │ └── ReadSensors.ino ├── ReadSensorsImperial │ └── ReadSensorsImperial.ino └── TemperatureAlert │ └── TemperatureAlert.ino ├── keywords.txt ├── library.properties └── src ├── Arduino_HTS221.h ├── HTS.cpp └── HTS.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 = , 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 | - "library.properties" 9 | - "examples/**" 10 | - "src/**" 11 | pull_request: 12 | paths: 13 | - ".github/workflows/compile-examples.yml" 14 | - "library.properties" 15 | - "examples/**" 16 | - "src/**" 17 | schedule: 18 | # Run every Tuesday at 8 AM UTC to catch breakage caused by changes to external resources (libraries, platforms). 19 | - cron: "0 8 * * TUE" 20 | workflow_dispatch: 21 | repository_dispatch: 22 | 23 | jobs: 24 | build: 25 | name: ${{ matrix.board.fqbn }} 26 | runs-on: ubuntu-latest 27 | 28 | env: 29 | SKETCHES_REPORTS_PATH: sketches-reports 30 | 31 | strategy: 32 | fail-fast: false 33 | 34 | matrix: 35 | board: 36 | - fqbn: arduino:mbed_nano:nano33ble 37 | platforms: | 38 | - name: arduino:mbed_nano 39 | artifact-name-suffix: arduino-mbed_nano-nano33ble 40 | 41 | steps: 42 | - name: Checkout repository 43 | uses: actions/checkout@v4 44 | 45 | - name: Compile examples 46 | uses: arduino/compile-sketches@v1 47 | with: 48 | github-token: ${{ secrets.GITHUB_TOKEN }} 49 | fqbn: ${{ matrix.board.fqbn }} 50 | platforms: ${{ matrix.board.platforms }} 51 | libraries: | 52 | # Install the library from the local path. 53 | - source-path: ./ 54 | # Additional library dependencies can be listed here. 55 | # See: https://github.com/arduino/compile-sketches#libraries 56 | sketch-paths: | 57 | - examples 58 | enable-deltas-report: true 59 | sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }} 60 | 61 | - name: Save sketches report as workflow artifact 62 | uses: actions/upload-artifact@v4 63 | with: 64 | if-no-files-found: error 65 | path: ${{ env.SKETCHES_REPORTS_PATH }} 66 | name: sketches-report-${{ matrix.board.artifact-name-suffix }} 67 | -------------------------------------------------------------------------------- /.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_HTS221 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 | Allows you to read the temperature and humidity from the ST Microelectronics HTS221 programmable chip. 11 | 12 | 13 | == License == 14 | 15 | Copyright (c) 2019 Arduino SA. All rights reserved. 16 | 17 | This library is free software; you can redistribute it and/or 18 | modify it under the terms of the GNU Lesser General Public 19 | License as published by the Free Software Foundation; either 20 | version 2.1 of the License, or (at your option) any later version. 21 | 22 | This library is distributed in the hope that it will be useful, 23 | but WITHOUT ANY WARRANTY; without even the implied warranty of 24 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 25 | Lesser General Public License for more details. 26 | 27 | You should have received a copy of the GNU Lesser General Public 28 | License along with this library; if not, write to the Free Software 29 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 30 | -------------------------------------------------------------------------------- /docs/api.md: -------------------------------------------------------------------------------- 1 | # ArduinoHTS221 library 2 | 3 | ## Methods 4 | 5 | ### `begin()` 6 | 7 | Initialize the humidity and temperature sensor. 8 | 9 | #### Syntax 10 | 11 | ``` 12 | HTS.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 (!HTS.begin()) { 27 | Serial.println("Failed to initialize humidity temperature sensor!"); 28 | while (1); 29 | } 30 | ``` 31 | 32 | #### See also 33 | 34 | * [end()](#end) 35 | * [readTemperature()](#readtemperature) 36 | * [readHumidity()](#readhumidity) 37 | 38 | ### `end()` 39 | 40 | De-initialize the humidity and temperature sensor. 41 | 42 | #### Syntax 43 | 44 | ``` 45 | HTS.end() 46 | ``` 47 | 48 | #### Parameters 49 | 50 | None. 51 | 52 | #### Returns 53 | 54 | None. 55 | 56 | #### Example 57 | 58 | ``` 59 | if (!HTS.begin()) { 60 | Serial.println("Failed to initialize humidity temperature sensor!"); 61 | while (1); 62 | } 63 | 64 | // ... 65 | 66 | HTS.end(); 67 | ``` 68 | 69 | #### See also 70 | 71 | * [begin()](#begin) 72 | * [readTemperature()](#readtemperature) 73 | * [readHumidity()](#readhumidity) 74 | 75 | ### `readTemperature()` 76 | 77 | Read the sensor’s measured temperature value. 78 | 79 | #### Syntax 80 | 81 | ``` 82 | HTS.readTemperature() 83 | HTS.readTemperature(units) 84 | ``` 85 | 86 | #### Parameters 87 | 88 | * _units_: FAHRENHEIT to read the temperature in Fahrenheit and CELSIUS to read the temperature in Celsius. If unit parameter is not provided, default is CELSIUS. 89 | 90 | #### Returns 91 | 92 | The temperature in degrees Fahrenheit or Celsius, depending on the units requested. 93 | 94 | #### Example 95 | 96 | ``` 97 | float temperature = HTS.readTemperature(); 98 | 99 | Serial.print("Temperature = "); 100 | Serial.print(temperature); 101 | Serial.println(" °C"); 102 | ``` 103 | 104 | #### See also 105 | 106 | * [begin()](#begin) 107 | * [end()](#end) 108 | * [readHumidity()](#readhumidity) 109 | 110 | ### `readHumidity()` 111 | 112 | Read the sensor’s measured relative humidity value. 113 | 114 | #### Syntax 115 | 116 | ``` 117 | HTS.readHumidity() 118 | ``` 119 | 120 | #### Parameters 121 | 122 | None. 123 | 124 | #### Returns 125 | 126 | The humidity value from the sensor as a percentage. 127 | 128 | #### Example 129 | 130 | ``` 131 | float humidity = HTS.readHumidity(); 132 | 133 | Serial.print("Humidity = "); 134 | Serial.print(humidity); 135 | Serial.println(" %"); 136 | ``` 137 | 138 | #### See also 139 | 140 | * [begin()](#begin) 141 | * [end()](#end) 142 | * [readTemperature()](#readtemperature) -------------------------------------------------------------------------------- /docs/readme.md: -------------------------------------------------------------------------------- 1 | # ArduinoHTS221 library 2 | 3 | 4 | The ArduinoHTS221 library allows you to use the [HTS221](https://www.st.com/resource/en/datasheet/HTS221.pdf) sensor available on the Arduino® Nano 33 BLE Sense board to read the temperature and the relative humidity of the environment. 5 | 6 | To use this library: 7 | 8 | ``` 9 | #include 10 | ``` 11 | 12 | Main features of the HTS221 sensor: 13 | 14 | - Humidity accuracy: ± 3.5% rH, 20 to +80% rH. 15 | - Humidity range: 0 to 100%. 16 | - Temperature accuracy: ± 0.5 °C, 15 to +40 °C. 17 | - Temperature range: -40 to 120° C, 18 | -------------------------------------------------------------------------------- /examples/ReadSensors/ReadSensors.ino: -------------------------------------------------------------------------------- 1 | /* 2 | HTS221 - Read Sensors 3 | 4 | This example reads data from the on-board HTS221 sensor of the 5 | Nano 33 BLE Sense and prints the temperature and humidity sensor 6 | values 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 (!HTS.begin()) { 21 | Serial.println("Failed to initialize humidity temperature sensor!"); 22 | while (1); 23 | } 24 | } 25 | 26 | void loop() { 27 | // read all the sensor values 28 | float temperature = HTS.readTemperature(); 29 | float humidity = HTS.readHumidity(); 30 | 31 | // print each of the sensor values 32 | Serial.print("Temperature = "); 33 | Serial.print(temperature); 34 | Serial.println(" °C"); 35 | 36 | Serial.print("Humidity = "); 37 | Serial.print(humidity); 38 | Serial.println(" %"); 39 | 40 | // print an empty line 41 | Serial.println(); 42 | 43 | // wait 1 second to print again 44 | delay(1000); 45 | } 46 | -------------------------------------------------------------------------------- /examples/ReadSensorsImperial/ReadSensorsImperial.ino: -------------------------------------------------------------------------------- 1 | /* 2 | HTS221 - Read Sensors Imperial 3 | 4 | This example reads data from the on-board HTS221 sensor of the 5 | Nano 33 BLE Sense then, prints the temperature and humidity sensor 6 | values in imperial units 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 (!HTS.begin()) { 21 | Serial.println("Failed to initialize humidity temperature sensor!"); 22 | while (1); 23 | } 24 | } 25 | 26 | void loop() { 27 | // Passing in FAHRENHEIT as the unit parameter to HTS.readTemperature(...), 28 | // allows you to read the sensor values in imperial units 29 | float temperature = HTS.readTemperature(FAHRENHEIT); 30 | float humidity = HTS.readHumidity(); 31 | 32 | // print each of the sensor values 33 | Serial.print("Temperature = "); 34 | Serial.print(temperature); 35 | Serial.println(" °F"); 36 | 37 | Serial.print("Humidity = "); 38 | Serial.print(humidity); 39 | Serial.println(" %"); 40 | 41 | // print an empty line 42 | Serial.println(); 43 | 44 | // wait 1 second to print again 45 | delay(1000); 46 | } 47 | -------------------------------------------------------------------------------- /examples/TemperatureAlert/TemperatureAlert.ino: -------------------------------------------------------------------------------- 1 | /* 2 | HTS221 - Temperature Alert 3 | This example reads data from the on-board HTS221 sensor of the 4 | Nano 33 BLE Sense. If the temperature increases above a certain limit, it turns the buzzer on. 5 | The circuit: 6 | - Arduino Nano 33 BLE Sense 7 | - Active buzzer module connected to pin 9 and GND 8 | 9 | written by K.Abhijeet 10 | This example code is in the public domain 11 | */ 12 | 13 | #include 14 | 15 | float tempLimit = 37; // set your temperature limit in °C 16 | 17 | void setup() { 18 | Serial.begin(9600); 19 | while (!Serial); 20 | 21 | pinMode(9, OUTPUT); 22 | 23 | if (!HTS.begin()) { 24 | Serial.println("Failed to initialize humidity temperature sensor!"); 25 | while (1); 26 | } 27 | } 28 | 29 | void loop() { 30 | 31 | float temperature = HTS.readTemperature(); // read the sensor value 32 | 33 | Serial.print("Temperature = "); // print the sensor value 34 | Serial.print(temperature); 35 | Serial.println(" °C"); 36 | 37 | if (temperature > tempLimit) 38 | { 39 | digitalWrite(9, HIGH); 40 | delay(500); 41 | digitalWrite(9, LOW); 42 | delay(500); 43 | } 44 | else 45 | { 46 | delay(2000); // wait a while before displaying the next reading If the temperature is below the limit 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /keywords.txt: -------------------------------------------------------------------------------- 1 | ######################################### 2 | # Syntax Coloring Map For Arduino_HTS221 3 | ######################################### 4 | # Class 5 | ######################################### 6 | 7 | Arduino_HTS221 KEYWORD1 8 | HTS221 KEYWORD1 9 | HTS KEYWORD1 10 | 11 | ######################################### 12 | # Methods and Functions 13 | ######################################### 14 | 15 | begin KEYWORD2 16 | end KEYWORD2 17 | 18 | readTemperature KEYWORD2 19 | readHumidity KEYWORD2 20 | 21 | ######################################### 22 | # Constants 23 | ######################################### 24 | 25 | FAHRENHEIT LITERAL1 26 | CELSIUS LITERAL1 27 | -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=Arduino_HTS221 2 | version=1.0.0 3 | author=Arduino 4 | maintainer=Arduino 5 | sentence=Allows you to read the temperature and humidity sensors of your Nano 33 BLE Sense. 6 | paragraph= 7 | category=Sensors 8 | url=http://github.com/arduino-libraries/Arduino_HTS221 9 | architectures=* 10 | includes=Arduino_HTS221.h 11 | -------------------------------------------------------------------------------- /src/Arduino_HTS221.h: -------------------------------------------------------------------------------- 1 | /* 2 | This file is part of the Arduino_HTS221 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 _ARUDINO_HTS221_H_ 21 | #define _ARUDINO_HTS221_H_ 22 | 23 | #include "HTS.h" 24 | 25 | #endif 26 | -------------------------------------------------------------------------------- /src/HTS.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | This file is part of the Arduino_HTS221 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 | #include "HTS.h" 23 | 24 | #define HTS221_ADDRESS 0x5F 25 | 26 | #define HTS221_WHO_AM_I_REG 0x0f 27 | #define HTS221_CTRL1_REG 0x20 28 | #define HTS221_CTRL2_REG 0x21 29 | #define HTS221_STATUS_REG 0x27 30 | #define HTS221_HUMIDITY_OUT_L_REG 0x28 31 | #define HTS221_TEMP_OUT_L_REG 0x2a 32 | #define HTS221_H0_rH_x2_REG 0x30 33 | #define HTS221_H1_rH_x2_REG 0x31 34 | #define HTS221_T0_degC_x8_REG 0x32 35 | #define HTS221_T1_degC_x8_REG 0x33 36 | #define HTS221_T1_T0_MSB_REG 0x35 37 | #define HTS221_H0_T0_OUT_REG 0x36 38 | #define HTS221_H1_T0_OUT_REG 0x3a 39 | #define HTS221_T0_OUT_REG 0x3c 40 | #define HTS221_T1_OUT_REG 0x3e 41 | 42 | HTS221Class::HTS221Class(TwoWire& wire) : 43 | _wire(&wire) 44 | { 45 | } 46 | 47 | int HTS221Class::begin() 48 | { 49 | _wire->begin(); 50 | 51 | if (i2cRead(HTS221_WHO_AM_I_REG) != 0xbc) { 52 | end(); 53 | 54 | return 0; 55 | } 56 | 57 | readHTS221Calibration(); 58 | 59 | // turn on the HTS221 and enable Block Data Update 60 | i2cWrite(HTS221_CTRL1_REG, 0x84); 61 | 62 | return 1; 63 | } 64 | 65 | void HTS221Class::end() 66 | { 67 | // disable HTS221 68 | i2cWrite(HTS221_CTRL1_REG, 0x00); 69 | 70 | _wire->end(); 71 | } 72 | 73 | float HTS221Class::readTemperature(int units) 74 | { 75 | // Wait for ONE_SHOT bit to be cleared by the hardware 76 | while (i2cRead(HTS221_CTRL2_REG) & 0x01); 77 | 78 | // trigger one shot 79 | i2cWrite(HTS221_CTRL2_REG, 0x01); 80 | 81 | // wait for completion 82 | while ((i2cRead(HTS221_STATUS_REG) & 0x01) == 0) { 83 | yield(); 84 | } 85 | 86 | // read value and convert 87 | int16_t tout = i2cRead16(HTS221_TEMP_OUT_L_REG); 88 | float reading = (tout * _hts221TemperatureSlope + _hts221TemperatureZero); 89 | if (units == FAHRENHEIT) { // Fahrenheit = (Celsius * 9 / 5) + 32 90 | return (reading * 9.0 / 5.0) + 32.0; 91 | } else { 92 | return reading; 93 | } 94 | } 95 | 96 | float HTS221Class::readHumidity() 97 | { 98 | // Wait for ONE_SHOT bit to be cleared by the hardware 99 | while (i2cRead(HTS221_CTRL2_REG) & 0x01); 100 | 101 | // trigger one shot 102 | i2cWrite(HTS221_CTRL2_REG, 0x01); 103 | 104 | // wait for completion 105 | while ((i2cRead(HTS221_STATUS_REG) & 0x02) == 0) { 106 | yield(); 107 | } 108 | 109 | // read value and convert 110 | int16_t hout = i2cRead16(HTS221_HUMIDITY_OUT_L_REG); 111 | 112 | return (hout * _hts221HumiditySlope + _hts221HumidityZero); 113 | } 114 | 115 | int HTS221Class::i2cRead(uint8_t reg) 116 | { 117 | _wire->beginTransmission(HTS221_ADDRESS); 118 | _wire->write(reg); 119 | if (_wire->endTransmission(false) != 0) { 120 | return -1; 121 | } 122 | 123 | if (_wire->requestFrom(HTS221_ADDRESS, 1) != 1) { 124 | return -1; 125 | } 126 | 127 | return _wire->read(); 128 | } 129 | 130 | int HTS221Class::i2cWrite(uint8_t reg, uint8_t val) 131 | { 132 | _wire->beginTransmission(HTS221_ADDRESS); 133 | _wire->write(reg); 134 | _wire->write(val); 135 | if (_wire->endTransmission() != 0) { 136 | return 0; 137 | } 138 | 139 | return 1; 140 | } 141 | 142 | void HTS221Class::readHTS221Calibration() 143 | { 144 | uint8_t h0rH = i2cRead(HTS221_H0_rH_x2_REG); 145 | uint8_t h1rH = i2cRead(HTS221_H1_rH_x2_REG); 146 | 147 | uint16_t t0degC = i2cRead(HTS221_T0_degC_x8_REG) | ((i2cRead(HTS221_T1_T0_MSB_REG) & 0x03) << 8); 148 | uint16_t t1degC = i2cRead(HTS221_T1_degC_x8_REG) | ((i2cRead(HTS221_T1_T0_MSB_REG) & 0x0c) << 6); 149 | 150 | int16_t h0t0Out = i2cRead16(HTS221_H0_T0_OUT_REG); 151 | int16_t h1t0Out = i2cRead16(HTS221_H1_T0_OUT_REG); 152 | 153 | int16_t t0Out = i2cRead16(HTS221_T0_OUT_REG); 154 | int16_t t1Out = i2cRead16(HTS221_T1_OUT_REG); 155 | 156 | // calculate slopes and 0 offset from calibration values, 157 | // for future calculations: value = a * X + b 158 | 159 | _hts221HumiditySlope = (h1rH - h0rH) / (2.0 * (h1t0Out - h0t0Out)); 160 | _hts221HumidityZero = (h0rH / 2.0) - _hts221HumiditySlope * h0t0Out; 161 | 162 | _hts221TemperatureSlope = (t1degC - t0degC) / (8.0 * (t1Out - t0Out)); 163 | _hts221TemperatureZero = (t0degC / 8.0) - _hts221TemperatureSlope * t0Out; 164 | } 165 | 166 | #ifdef ARDUINO_ARDUINO_NANO33BLE 167 | HTS221Class HTS(Wire1); 168 | #else 169 | HTS221Class HTS(Wire); 170 | #endif 171 | -------------------------------------------------------------------------------- /src/HTS.h: -------------------------------------------------------------------------------- 1 | /* 2 | This file is part of the Arduino_HTS221 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 _HTS_H_ 21 | #define _HTS_H_ 22 | 23 | #include 24 | #include 25 | 26 | enum { 27 | FAHRENHEIT, 28 | CELSIUS 29 | }; 30 | 31 | class HTS221Class { 32 | public: 33 | HTS221Class(TwoWire& wire); 34 | 35 | int begin(); 36 | void end(); 37 | 38 | float readTemperature(int units = CELSIUS); 39 | float readHumidity(); 40 | 41 | private: 42 | int i2cRead(uint8_t reg); 43 | int i2cRead16(uint8_t reg) { 44 | return (i2cRead(reg) | (i2cRead(reg + 1) << 8)); 45 | } 46 | int i2cWrite(uint8_t reg, uint8_t val); 47 | 48 | void readHTS221Calibration(); 49 | 50 | private: 51 | TwoWire* _wire; 52 | 53 | float _hts221HumiditySlope; 54 | float _hts221HumidityZero; 55 | float _hts221TemperatureSlope; 56 | float _hts221TemperatureZero; 57 | }; 58 | 59 | extern HTS221Class HTS; 60 | 61 | #endif 62 | --------------------------------------------------------------------------------