bug fixes

CMakeLists.txt

@@ -1,4 +1,4 @@
-set(depends esp_timer esp_system i2c esp_log esp_event esp_err math)
+set(depends esp_timer esp_system esp_event driver)
 
 idf_component_register(
     SRCS "hdc1080.c"

dist/hdc1080_0.2.0/.gitignore

@@ -0,0 +1,19 @@
+#.gitignore
+.vscode
+build
+sdkconfig
+*.info
+*.ci
+*.old
+**/*.info
+**/*.log
+**/*.log*
+**/logs
+**/*.lock
+**/*.old
+**/.idea
+**/*.suo
+**/*.ntvs*
+**/*.njsproj
+**/*.sln
+**/*.sw?

dist/hdc1080_0.2.0/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## [0.2.0](https://github.com/grstat/esp32-hdc1080)
+
+### Notes
+
+- Transformed inital commits into a managed component library

dist/hdc1080_0.2.0/CMakeLists.txt

@@ -0,0 +1,6 @@
+set(depends esp_timer esp_system i2c esp_log esp_event esp_err math)
+
+idf_component_register(
+    SRCS "hdc1080.c"
+    INCLUDE_DIRS "include"
+    REQUIRES ${depends})

dist/hdc1080_0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

dist/hdc1080_0.2.0/README.md

@@ -0,0 +1,10 @@
+# ESP32 HDC1080 COMPONENT DRIVER LIBRARY
+
+ESP32 HDC1080 component driver library for the esp-idf
+
+The HDC1080 is a temperature and humidity sensor made by 
+Texas Instruments. For more information visit: https://www.ti.com/product/HDC1080
+
+## Examples
+
+Here is an example on how to configure and use the driver [Example](https://github.com/grstat/esp32-hdc1080/tree/main/examples)

dist/hdc1080_0.2.0/examples/hdc1080_example_main/CMakeLists.txt

@@ -0,0 +1,6 @@
+# For more information about build system see
+# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html
+cmake_minimum_required(VERSION 3.16)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(esp32-hdc1080-example)

dist/hdc1080_0.2.0/examples/hdc1080_example_main/README.md

@@ -0,0 +1,51 @@
+# ESP32 HDC1080 COMPONENT DRIVER LIBRARY EXAMPLE
+
+The example code should give a good understanding of how to configure and use the hdc1080 component driver.
+
+It includes how to use the aspects of the driver as well as the available macros for calculating and converting 
+the data into various formats. Including: 
+- Celsius -> Fahrenheit
+- Temperature & humidity -> Dewpoint
+- Temperature -> Air saturation vapor pressure
+- Air saturation vapor pressure & humidity -> Air vapor pressure deficit
+
+## Example workflow
+
+- I2C is initalized, included is an I2C scan event that will display current devices on the bus for troubleshooting
+- If the I2C initalized successfully the following occurs
+- hdc1080_settings_t is filled with the I2C configuration and callback procedure
+- hdc1080_config_t is filled with the defined register values
+- The hdc1080 sensor is configured with the settings and configuration defined
+- If the sensor is configured without error and inital sensor read is started; upon completion the hdc1080_settings_t.callback is called
+- The callback procedure performs various conversions and prints the current sensor data.
+- The current hdc1080 configuration is captured
+
+## Pinout
+
+| ESP32 | HDC1080 |
+|-------|---------|
+| 22    | SCL     |
+| 21    | SDA     |
+| 3.3v  | VCC     |
+| GND   | GND     |
+
+## Requirements
+
+- An ESP32 Dev Kit
+- An HDC1080 i2c Sensor module.
+- esp-idf and tools (Developed and tested on v5.1.1)
+
+### Project configuration
+
+* Open the project configuration menu (`idf.py menuconfig`)
+* Go to the HDC1080 Example config section
+* Set the I2C SCL, SDA, PORT NUMBER & FREQUENCY if they are not the default
+* If you do not wish to perform the I2C device scan you can disable the option 
+
+### Build and Flash
+
+Build the project and flash it to the board, then run monitor tool to view serial output:
+
+```
+idf.py -p PORT flash monitor
+```

dist/hdc1080_0.2.0/examples/hdc1080_example_main/main/CMakeLists.txt

@@ -0,0 +1,2 @@
+idf_component_register(SRCS "hdc1080_example_main.c" 
+                    INCLUDE_DIRS ".")

dist/hdc1080_0.2.0/examples/hdc1080_example_main/main/Kconfig.projbuild

@@ -0,0 +1,42 @@
+menu "HDC1080 Example Config"
+
+    config HDC1080_I2C_SCL
+        int "HDC1080 I2C SCL"
+        default 22
+        help
+            The I2C SCL pin number of the HDC1080
+
+    config HDC1080_I2C_SDA
+        int "HDC1080 I2C SDA"
+        default 21
+        help
+            The I2C SDA pin number of the HDC1080
+
+    config HDC1080_I2C_PORT_NUMBER
+        int "HDC1080 I2C PORT NUMBER"
+        default 0
+        help
+            The I2C port number to use
+
+    config HDC1080_I2C_PORT_FREQUENCY
+        int "HDC1080 I2C PORT FREQUENCY"
+        default 400000
+        help
+            The I2C port frequency. The default is 400kHz
+
+    config HDC1080_I2C_PULLUPS
+        int "Enable or disable pullups on the I2C data lines"
+        default 1
+        help
+            Use 1 to enable pullups, 0 to disable. This value
+            changes both the SDA and SCL pullup values
+
+    config HDC1080_I2C_SCAN_FOR_DEVICES
+        bool "Perform I2C device scan after configuration"
+        default y
+        help
+            Enable to run the device scan during I2C initalization.
+            The device scan allows you to see all device IDs connected
+            to the I2C bus via console print.
+
+endmenu