Initial commit

PaulZC · PaulZC · commit f6b3c063c591 · 2021-11-04T19:07:43.000Z
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,55 @@
+SparkFun License Information
+============================
+
+SparkFun uses two different licenses for our files — one for hardware and one for code.
+
+Hardware
+---------
+
+**SparkFun hardware is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).**
+
+Note: This is a human-readable summary of (and not a substitute for) the [license](http://creativecommons.org/licenses/by-sa/4.0/legalcode).
+
+You are free to:
+
+Share — copy and redistribute the material in any medium or format
+Adapt — remix, transform, and build upon the material
+for any purpose, even commercially.
+The licensor cannot revoke these freedoms as long as you follow the license terms.
+Under the following terms:
+
+Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
+ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
+No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
+Notices:
+
+You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
+No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.
+
+
+Code
+--------
+
+**SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).**
+
+The MIT License (MIT)
+
+Copyright (c) 2021 SparkFun Electronics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,36 @@
+SparkFun VEML7700 Arduino Library
+==============================
+
+[![SparkX smôl Environmental Peripheral Board (SPX-18976)]()](https://www.sparkfun.com/products/18976)
+
+[*SparkX smôl Environmental Peripheral Board (SPX-18976)*](https://www.sparkfun.com/products/18976)
+
+The Vishay Semiconductors VEML7700 is a high accuracy ambient light sensor with 16-bit resolution in a miniature transparent package. It includes a high sensitive photo diode, a low noise amplifier, a 16-bit A/D converter and supports the I<sup>2</sup>C bus communication interface.
+  
+This library handles the initialization and configuration of the sensor, and monitoring of the ambient light level.
+
+## Repository Contents
+
+* **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE. 
+* **/src** - Source files for the library (.cpp, .h).
+* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE. 
+* **library.properties** - General library properties for the Arduino package manager. 
+* **LICENSE.md** - Contains the license information.
+
+## Documentation
+
+* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.
+
+## Products That Use This Library
+
+* [SPX-18976](https://www.sparkfun.com/products/18976)- smôl Environmental Peripheral Board
+
+## License Information
+
+This product is _**open source**_!
+
+Please use, reuse, and modify these files as you see fit. Please maintain attribution to SparkFun Electronics and release anything derivative under the same license.
+
+Distributed as-is; no warranty is given.
+
+- Your friends at SparkFun.
diff --git a/examples/Example1_getLux/Example1_getLux.ino b/examples/Example1_getLux/Example1_getLux.ino
@@ -0,0 +1,47 @@
+/*!
+ * @file Example1_getLux.ino
+ *
+ * This example was written by:
+ * Paul Clark
+ * SparkFun Electronics
+ * November 4th 2021
+ * 
+ * This example demonstrates how to initialize the VEML7700 and then get the ambient light lux.
+ * 
+ * Want to support open source hardware? Buy a board from SparkFun!
+ * <br>SparkX smôl Environmental Peripheral Board (SPX-18976): https://www.sparkfun.com/products/18976
+ * 
+ * Please see LICENSE.md for the license information
+ * 
+ */
+
+#include <SparkFun_VEML7700_Arduino_Library.h> // Click here to get the library: http://librarymanager/All#SparkFun_VEML7700
+
+VEML7700 mySensor; // Create a VEML7700 object
+
+void setup()
+{
+  Serial.begin(115200);
+  Serial.println(F("SparkFun VEML7700 Example"));
+
+  Wire.begin();
+
+  //mySensor.enableDebugging(); // Uncomment this line to enable helpful debug messages on Serial
+
+  // Begin the VEML7700 using the Wire I2C port
+  // .begin will return true on success, or false on failure to communicate
+  if (mySensor.begin() == false)
+  {
+    Serial.println("Unable to communicate with the VEML7700. Please check the wiring. Freezing...");
+    while (1)
+      ;
+  }
+
+  Serial.println(F("Lux:"));
+}
+
+void loop()
+{
+  Serial.println(mySensor.getLux(), 4); // Read the lux from the sensor and print it
+  delay(250);
+}
diff --git a/keywords.txt b/keywords.txt
@@ -0,0 +1,82 @@
+#######################################
+# Syntax Coloring Map 
+#######################################
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+SparkFun_VEML7700_Arduino_Library	KEYWORD1
+VEML7700	KEYWORD1
+VEML7700_t	KEYWORD1
+VEML7700_error_t	KEYWORD1
+VEML7700_sensitivity_mode_t	KEYWORD1
+VEML7700_integration_time_t	KEYWORD1
+VEML7700_persistence_protect_t	KEYWORD1
+VEML7700_interrupt_enable_t	KEYWORD1
+VEML7700_shutdown_t	KEYWORD1
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+
+begin	KEYWORD2
+enableDebugging	KEYWORD2
+disableDebugging	KEYWORD2
+isConnected	KEYWORD2
+setShutdown	KEYWORD2
+powerOn	KEYWORD2
+shutdown	KEYWORD2
+getShutdown	KEYWORD2
+setInterruptEnable	KEYWORD2
+getInterruptEnable	KEYWORD2
+setPersistenceProtect	KEYWORD2
+getPersistenceProtect	KEYWORD2
+setIntegrationTime	KEYWORD2
+getIntegrationTime	KEYWORD2
+setSensitivityMode	KEYWORD2
+getSensitivityMode	KEYWORD2
+setHighThreshold	KEYWORD2
+getHighThreshold	KEYWORD2
+setLowThreshold	KEYWORD2
+getLowThreshold	KEYWORD2
+getAmbientLight	KEYWORD2
+getWhiteLevel	KEYWORD2
+getLux	KEYWORD2
+getHighInterruptStatus	KEYWORD2
+getLowInterruptStatus	KEYWORD2
+clearInterruptStatus	KEYWORD2
+
+#######################################
+# Constants (LITERAL1)
+#######################################
+
+VEML7700_ERROR_READ	LITERAL1
+VEML7700_ERROR_WRITE	LITERAL1
+VEML7700_ERROR_INVALID_ADDRESS	LITERAL1
+VEML7700_ERROR_UNDEFINED	LITERAL1
+VEML7700_ERROR_SUCCESS	LITERAL1
+VEML7700_SUCCESS|	LITERAL1
+VEML7700_SENSITIVITY_x1	LITERAL1
+VEML7700_SENSITIVITY_x2	LITERAL1
+VEML7700_SENSITIVITY_x1_8	LITERAL1
+VEML7700_SENSITIVITY_x1_4	LITERAL1
+VEML7700_SENSITIVITY_INVALID	LITERAL1
+VEML7700_INTEGRATION_25ms	LITERAL1
+VEML7700_INTEGRATION_50ms	LITERAL1
+VEML7700_INTEGRATION_100ms	LITERAL1
+VEML7700_INTEGRATION_200ms	LITERAL1
+VEML7700_INTEGRATION_400ms	LITERAL1
+VEML7700_INTEGRATION_800ms	LITERAL1
+VEML7700_INTEGRATION_INVALID	LITERAL1
+VEML7700_PERSISTENCE_1	LITERAL1
+VEML7700_PERSISTENCE_2	LITERAL1
+VEML7700_PERSISTENCE_4	LITERAL1
+VEML7700_PERSISTENCE_8	LITERAL1
+VEML7700_PERSISTENCE_INVALID	LITERAL1
+VEML7700_INT_DISABLE	LITERAL1
+VEML7700_INT_ENABLE	LITERAL1
+VEML7700_INT_INVALID	LITERAL1
+VEML7700_POWER_ON	LITERAL1
+VEML7700_SHUT_DOWN	LITERAL1
+VEML7700_SHUTDOWN_INVALID	LITERAL1
diff --git a/library.properties b/library.properties
@@ -0,0 +1,9 @@
+name=SparkFun VEML7700 Arduino Library
+version=1.0.0
+author=SparkFun Electronics <techsupport@sparkfun.com>
+maintainer=SparkFun Electronics <sparkfun.com>
+sentence=Library for the VEML7700 Ambient Light Sensor
+paragraph=An Arduino Library for the VEML7700 ambient light sensor. This library configures the sensor and reads the ambient light level.
+category=Sensors
+url=https://github.com/sparkfun/SparkFun_VEML7700_Arduino_Library
+architectures=*
diff --git a/src/SparkFun_VEML7700_Arduino_Library.cpp b/src/SparkFun_VEML7700_Arduino_Library.cpp
diff --git a/src/SparkFun_VEML7700_Arduino_Library.h b/src/SparkFun_VEML7700_Arduino_Library.h
