Skip to content

Commit 7273e63

Browse files
gigapodgigapod
authored
Merge pull request #1 from sparkfun/feature/move-to-toolkit
Feature/move to toolkit
2 parents d144f3e + b1dc4e2 commit 7273e63

File tree

109 files changed

+2453
-8867
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

109 files changed

+2453
-8867
lines changed

‎.github/workflows/add_issue_to_project.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Add new issue to our main project
2+
3+
on:
4+
issues:
5+
types:
6+
- opened
7+
8+
jobs:
9+
add-to-project:
10+
name: Add issue to project
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/add-to-project@main
14+
with:
15+
# You can target a project in a different organization
16+
# to the issue
17+
project-url: https://github.com/orgs/sparkfun/projects/19
18+
github-token: ${{ secrets.DEFECT_ADD_TO_PROJECT }}

‎.github/workflows/build-deploy-ghpages.yml

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Build Documentation and Deploy
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
id-token: write
12+
pages: write
13+
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: true
17+
18+
jobs:
19+
# Build job
20+
build:
21+
runs-on: ubuntu-latest
22+
steps:
23+
# Checkout the repository
24+
- name: Checkout repository
25+
uses: actions/checkout@v2
26+
with:
27+
fetch-depth: 0
28+
submodules: "true"
29+
30+
- name: Set Version
31+
run: echo "PROJECT_NUMBER = `git describe --tags`" >> ./docs/doxygen/doxygen-config
32+
33+
- name: Build Documentation
34+
uses: mattnotmitt/doxygen-action@v1.9.5
35+
with:
36+
doxyfile-path: "./docs/doxygen/doxygen-config"
37+
38+
# Upload the documentation as an artifact
39+
- name: Upload documentation
40+
uses: actions/upload-pages-artifact@v3.0.1
41+
with:
42+
path: ./docs/html
43+
44+
# Deploy job
45+
deploy:
46+
# Add a dependency to the build job
47+
needs: build
48+
49+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
50+
permissions:
51+
pages: write # to deploy to Pages
52+
id-token: write # to verify the deployment originates from an appropriate source
53+
54+
# Deploy to the github-pages environment
55+
environment:
56+
name: github-pages
57+
url: ${{ steps.deployment.outputs.page_url }}
58+
59+
# Specify runner + deployment step
60+
runs-on: ubuntu-latest
61+
steps:
62+
- name: Deploy to GitHub Pages
63+
id: deployment
64+
uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action

‎.github/workflows/compile-sketch.yml

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
name: Cross-compilation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
jobs:
10+
compile-sketch:
11+
runs-on: ubuntu-latest
12+
13+
strategy:
14+
fail-fast: false
15+
16+
matrix:
17+
board:
18+
# Uno
19+
# https://github.com/arduino/ArduinoCore-avr/blob/master/boards.txt
20+
- fqbn: arduino:avr:mega
21+
# platforms: |
22+
name: arduino:avr
23+
source-url: https://downloads.arduino.cc/packages/package_index.json
24+
25+
# ESP32
26+
# https://github.com/espressif/arduino-esp32/blob/master/boards.txt
27+
- fqbn: esp32:esp32:esp32
28+
# platforms: |
29+
name: esp32:esp32
30+
source-url: https://github.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
31+
32+
# ESP32-S2
33+
# https://github.com/espressif/arduino-esp32/blob/master/boards.txt
34+
- fqbn: esp32:esp32:esp32s2
35+
# platforms: |
36+
name: esp32:esp32
37+
source-url: https://github.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
38+
39+
# ESP32-C3
40+
# https://github.com/espressif/arduino-esp32/blob/master/boards.txt
41+
- fqbn: esp32:esp32:esp32c3
42+
# platforms: |
43+
name: esp32:esp32
44+
source-url: https://github.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
45+
46+
# Artemis / Apollo3
47+
# https://github.com/sparkfun/Arduino_Apollo3/blob/main/boards.txt
48+
- fqbn: SparkFun:apollo3:sfe_artemis_atp
49+
# platforms: |
50+
name: SparkFun:apollo3
51+
source-url: https://github.com/sparkfun/Arduino_Apollo3/master/package_sparkfun_apollo3_index.json
52+
53+
# ESP8266
54+
# https://github.com/esp8266/Arduino/blob/master/boards.txt
55+
- fqbn: esp8266:esp8266:thingdev
56+
# platforms: |
57+
name: esp8266:esp8266
58+
source-url: https://arduino.esp8266.com/stable/package_esp8266com_index.json
59+
60+
# SAMD21
61+
# https://github.com/arduino/ArduinoCore-samd/blob/master/boards.txt
62+
- fqbn: arduino:samd:mkr1000
63+
# platforms: |
64+
name: arduino:samd
65+
source-url: https://downloads.arduino.cc/packages/package_index.json
66+
67+
# Nano BLE 33 / nRF52840
68+
# https://github.com/arduino/ArduinoCore-mbed/blob/master/boards.txt
69+
- fqbn: arduino:mbed:nano33ble
70+
# platforms: |
71+
name: arduino:mbed
72+
source-url: https://downloads.arduino.cc/packages/package_index.json
73+
74+
# RP2040
75+
# https://github.com/arduino/ArduinoCore-mbed/blob/master/boards.txt
76+
- fqbn: rp2040:rp2040:sparkfun_promicrorp2040
77+
# platforms: |
78+
name: rp2040:rp2040
79+
source-url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json
80+
81+
# RP2350
82+
# https://github.com/arduino/ArduinoCore-mbed/blob/master/boards.txt
83+
- fqbn: rp2040:rp2040:sparkfun_promicrorp2350
84+
# platforms: |
85+
name: rp2040:rp2040
86+
source-url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json
87+
88+
# STM32
89+
# https://github.com/arduino/ArduinoCore-mbed/blob/master/boards.txt
90+
- fqbn: STMicroelectronics:stm32:GenF4
91+
# platforms: |
92+
name: STMicroelectronics:stm32
93+
source-url: https://github.com/stm32duino/BoardManagerFiles/raw/main/package_stmicroelectronics_index.json
94+
95+
steps:
96+
- name: Checkout
97+
uses: actions/checkout@v3
98+
99+
- name: Branch name
100+
run:
101+
echo running on branch ${GITHUB_REF##*/}
102+
103+
# Setup Arduino command line - install esp32 and all the libs flux needs
104+
- name: Arduino - Install and setup the Arduino CLI
105+
uses: arduino/setup-arduino-cli@v2
106+
107+
- name: Arduino - Start config file
108+
run: arduino-cli config init --additional-urls ${{ matrix.board.source-url}}
109+
110+
- name: Arduino - Update index
111+
run: arduino-cli core update-index
112+
113+
- name: Arduino - Install platform
114+
run: arduino-cli core install ${{ matrix.board.name}}
115+
116+
- name: Arduino - Install libraries
117+
run: |
118+
arduino-cli config set library.enable_unsafe_install true
119+
arduino-cli version
120+
arduino-cli lib install 'SparkFun Toolkit'
121+
122+
- name: Compile Sketch
123+
run: arduino-cli compile --fqbn ${{ matrix.board.fqbn }} examples/Example1_getLux --library .
124+
125+
# outputs:
126+
# report-artifact-name: ${{ steps.report-artifact-name.outputs.report-artifact-name }}

‎.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "docs/doxygen/doxygen-awesome-css"]
2+
path = docs/doxygen/doxygen-awesome-css
3+
url = https://github.com/jothepro/doxygen-awesome-css.git

‎LICENSE.md

Lines changed: 3 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,6 @@
1-
SparkFun License Information
2-
============================
1+
MIT License
32

4-
SparkFun uses two different licenses for our files — one for hardware and one for code.
5-
6-
Hardware
7-
---------
8-
9-
**SparkFun hardware is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).**
10-
11-
Note: This is a human-readable summary of (and not a substitute for) the [license](http://creativecommons.org/licenses/by-sa/4.0/legalcode).
12-
13-
You are free to:
14-
15-
Share — copy and redistribute the material in any medium or format
16-
Adapt — remix, transform, and build upon the material
17-
for any purpose, even commercially.
18-
The licensor cannot revoke these freedoms as long as you follow the license terms.
19-
Under the following terms:
20-
21-
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.
22-
ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
23-
No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
24-
Notices:
25-
26-
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.
27-
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.
28-
29-
30-
Code
31-
--------
32-
33-
**SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).**
34-
35-
The MIT License (MIT)
36-
37-
Copyright (c) 2021 SparkFun Electronics
3+
Copyright (c) 2025 SparkFun Electronics
384

395
Permission is hereby granted, free of charge, to any person obtaining a copy
406
of this software and associated documentation files (the "Software"), to deal
@@ -52,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
5218
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
5319
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
5420
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
55-
SOFTWARE.
21+
SOFTWARE.

‎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)