Skip to content

Commit 3db2d39

Browse files
committed
updated readme for the v2.0 of the library
1 parent f9ab6cb commit 3db2d39

File tree

1 file changed

+40
-23
lines changed

1 file changed

+40
-23
lines changed

README.md

Lines changed: 40 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,55 @@
1-
SparkFun VEML7700 Arduino Library
2-
==============================
1+
![SparkFun Ambient Light Sensor - VEML7700 Arduino Library](docs/images/gh-banner-2025-arduino-veml7700.png "SparkFun Ambient Light Sensor - VEML7700 Arduino Library]")
32

4-
[![SparkX Ambient Light Sensor - VEML7700 (Qwiic) (SPX-18981)](https://cdn.sparkfun.com//assets/parts/1/8/5/5/5/18981-Ambient_Light_Sensor_-_VEML7700__Qwiic_-01.jpg)](https://www.sparkfun.com/products/18981)
3+
# SparkFun Ambient Light Sensor - VEML7700 Arduino Library
54

6-
[*SparkX Ambient Light Sensor - VEML7700 (Qwiic) (SPX-18981)*](https://www.sparkfun.com/products/18981)
5+
SparkFun Ambient Light Sensor - VEML7700 - AS7343 (QWIIC)
76

8-
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.
9-
10-
This library handles the initialization and configuration of the sensor, and monitoring of the ambient light level.
7+
![License](https://img.shields.io/github/license/sparkfun/SparkFun_VEML7700_Arduino_Library)
8+
![Release](https://img.shields.io/github/v/release/sparkfun/SparkFun_VEML7700_Arduino_Library)
9+
![Release Date](https://img.shields.io/github/release-date/sparkfun/SparkFun_VEML7700_Arduino_Library)
10+
![Documentation - build](https://img.shields.io/github/actions/workflow/status/sparkfun/SparkFun_VEML7700_Arduino_Library/build-deploy-ghpages.yml?label=doc%20build)
11+
![Compile - Test](https://img.shields.io/github/actions/workflow/status/sparkfun/SparkFun_VEML7700_Arduino_Library/compile-sketch.yml?label=compile%20test)
12+
![GitHub issues](https://img.shields.io/github/issues/sparkfun/SparkFun_VEML7700_Arduino_Library)
1113

12-
## Repository Contents
1314

14-
* **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE.
15-
* **/src** - Source files for the library (.cpp, .h).
16-
* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE.
17-
* **library.properties** - General library properties for the Arduino package manager.
18-
* **LICENSE.md** - Contains the license information.
15+
This library provides full access to the functions of the VEML7700 Ambient Light Sensor through an I2C connection using the SparkFun Qwiic connectors and cables.
16+
17+
### Supported Products
18+
This library is intended for use with the following SparkFun Product - available at [www.sparkfun.com](https://www.sparkfun.com).
19+
20+
| Product | Description|
21+
|--|--|
22+
|[SparkFun Ambient Light Sensor - VEML7700 (Qwiic)](https://www.sparkfun.com/sparkfun-ambient-light-sensor-veml7700-qwiic.html) | The SparkFun Qwiic VEML7700 Ambient Light Sensor provides accurate, 16-bit ambient light readings from 0 to 167,000 lux via the I2C interface. This miniature sensor (6.8mm x 3.0mm x 2.5mm) features a high-sensitivity photodiode, a low-noise amplifier, and a 16-bit analog-to-digital (A/D) converter. Its unshifted 7-bit I2C address is 0x10.|
1923

2024
## Documentation
2125

22-
- **/docs** - HTML documentation generated with [Doxygen](https://www.doxygen.nl/index.html). Open [**GitHub Pages**](https://sparkfun.github.io/SparkFun_VEML7700_Arduino_Library/) to view the documentation.
23-
- **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.
26+
|Reference | Description |
27+
|---|---|
28+
|[Library Documentation](https://docs.sparkfun.com/SparkFun_VEML7700_Arduino_Library/)| The full documentation and API for this Arduino library|
29+
|[SparkFun Ambient Light Sensor - VEML7700 (Qwiic)](https://github.com/sparkfun/SparkFun_Ambient_Light_Sensor-VEML7700)| Hardware GitHub Repository|
30+
|[Hook Up Guide - SparkFun Ambient Light Sensor - VEML7700 (Qwiic)](https://docs.sparkfun.com/SparkFun_Ambient_Light_Sensor-VEML7700/introduction/) | Hardware Overview and Quick Start for the Ambient Light Sensor - VEML7700|
31+
|[SparkFun Ambient Light Sensor - VEML7700 (Qwiic)](https://github.com/sparkfun/SparkFun_VEML7700_Arduino_Library)| Arduino Library - GitHub Repository|
32+
|[VEML7700 Datasheet](https://cdn.sparkfun.com/assets/a/2/b/a/4/VEML7700_Datasheet.pdf) | Datasheet for the VEML7700 IC|
33+
|[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)| Basic information on how to install an Arduino library|
2434

25-
## Products That Use This Library
35+
## Examples
2636

27-
* [SPX-18976](https://www.sparkfun.com/products/18976) - smôl Environmental Peripheral Board
28-
* [SPX-18981](https://www.sparkfun.com/products/18981) - Ambient Light Sensor - VEML7700 (Qwiic)
37+
The following examples are provided with the library
38+
39+
| Example | Description |
40+
|---|---|
41+
|[Read LUX Value](examples/Example1_getLux/Example1_getLux.ino)| Take basic readings from the sensor - read the currently detect LUX value.|
42+
|[Change Settings](examples/Example2_changeSettings/Example2_changeSettings.ino)| Change the operational settings of the sensor|
43+
|[Threshold Settings](examples/Example3_threshold/Example3_threshold.ino)| Set threshold values and check for threshold triggered interrupts.|
44+
|[Power Settomgs](examples/Example4_shutDown/Example4_shutDown.ino)| Shows how to shutdown and power up the sensor.|
45+
|[Production Test](examples/Example5_ProductionTest/Example5_ProductionTest.ino)| Test used during board production |
2946

30-
## License Information
3147

32-
This product is _**open source**_!
3348

34-
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.
3549

36-
Distributed as-is; no warranty is given.
50+
## License Information
51+
52+
This product is ***open source***!
53+
54+
This product is licensed using the [MIT Open Source License](https://opensource.org/license/mit).
3755

38-
- Your friends at SparkFun.

0 commit comments

Comments
 (0)