Skip to content

Commit dd6cce0

Browse files
author
Toni Klopfenstein
committed
Fixing library structure to 1.6.4 requirements
1 parent dbdf80c commit dd6cce0

10 files changed

Lines changed: 288 additions & 15 deletions

File tree

‎.gitattributes‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Auto detect text files and perform LF normalization
2+
* text=auto
3+
4+
# Custom for Visual Studio
5+
*.cs diff=csharp
6+
*.sln merge=union
7+
*.csproj merge=union
8+
*.vbproj merge=union
9+
*.fsproj merge=union
10+
*.dbproj merge=union
11+
12+
# Standard to msysgit
13+
*.doc diff=astextplain
14+
*.DOC diff=astextplain
15+
*.docx diff=astextplain
16+
*.DOCX diff=astextplain
17+
*.dot diff=astextplain
18+
*.DOT diff=astextplain
19+
*.pdf diff=astextplain
20+
*.PDF diff=astextplain
21+
*.rtf diff=astextplain
22+
*.RTF diff=astextplain

‎.gitignore‎

Lines changed: 192 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,192 @@
1+
#################
2+
## SparkFun Useful stuff
3+
#################
4+
5+
## AVR Development
6+
*.eep
7+
*.elf
8+
*.lst
9+
*.lss
10+
*.sym
11+
*.d
12+
*.o
13+
*.srec
14+
*.map
15+
16+
## Notepad++ backup files
17+
*.bak
18+
19+
## BOM files
20+
*bom*
21+
22+
#################
23+
## Eclipse
24+
#################
25+
26+
*.pydevproject
27+
.project
28+
.metadata
29+
bin/
30+
tmp/
31+
*.tmp
32+
*.bak
33+
*.swp
34+
*~.nib
35+
local.properties
36+
.classpath
37+
.settings/
38+
.loadpath
39+
40+
# External tool builders
41+
.externalToolBuilders/
42+
43+
# Locally stored "Eclipse launch configurations"
44+
*.launch
45+
46+
# CDT-specific
47+
.cproject
48+
49+
# PDT-specific
50+
.buildpath
51+
52+
53+
#############
54+
## Eagle
55+
#############
56+
57+
# Ignore the board and schematic backup files
58+
*.b#?
59+
*.s#?
60+
61+
62+
#################
63+
## Visual Studio
64+
#################
65+
66+
## Ignore Visual Studio temporary files, build results, and
67+
## files generated by popular Visual Studio add-ons.
68+
69+
# User-specific files
70+
*.suo
71+
*.user
72+
*.sln.docstates
73+
74+
# Build results
75+
[Dd]ebug/
76+
[Rr]elease/
77+
*_i.c
78+
*_p.c
79+
*.ilk
80+
*.meta
81+
*.obj
82+
*.pch
83+
*.pdb
84+
*.pgc
85+
*.pgd
86+
*.rsp
87+
*.sbr
88+
*.tlb
89+
*.tli
90+
*.tlh
91+
*.tmp
92+
*.vspscc
93+
.builds
94+
*.dotCover
95+
96+
## TODO: If you have NuGet Package Restore enabled, uncomment this
97+
#packages/
98+
99+
# Visual C++ cache files
100+
ipch/
101+
*.aps
102+
*.ncb
103+
*.opensdf
104+
*.sdf
105+
106+
# Visual Studio profiler
107+
*.psess
108+
*.vsp
109+
110+
# ReSharper is a .NET coding add-in
111+
_ReSharper*
112+
113+
# Installshield output folder
114+
[Ee]xpress
115+
116+
# DocProject is a documentation generator add-in
117+
DocProject/buildhelp/
118+
DocProject/Help/*.HxT
119+
DocProject/Help/*.HxC
120+
DocProject/Help/*.hhc
121+
DocProject/Help/*.hhk
122+
DocProject/Help/*.hhp
123+
DocProject/Help/Html2
124+
DocProject/Help/html
125+
126+
# Click-Once directory
127+
publish
128+
129+
# Others
130+
[Bb]in
131+
[Oo]bj
132+
sql
133+
TestResults
134+
*.Cache
135+
ClientBin
136+
stylecop.*
137+
~$*
138+
*.dbmdl
139+
Generated_Code #added for RIA/Silverlight projects
140+
141+
# Backup & report files from converting an old project file to a newer
142+
# Visual Studio version. Backup files are not needed, because we have git ;-)
143+
_UpgradeReport_Files/
144+
Backup*/
145+
UpgradeLog*.XML
146+
147+
148+
############
149+
## Windows
150+
############
151+
152+
# Windows image file caches
153+
Thumbs.db
154+
155+
# Folder config file
156+
Desktop.ini
157+
158+
159+
#############
160+
## Python
161+
#############
162+
163+
*.py[co]
164+
165+
# Packages
166+
*.egg
167+
*.egg-info
168+
dist
169+
build
170+
eggs
171+
parts
172+
bin
173+
var
174+
sdist
175+
develop-eggs
176+
.installed.cfg
177+
178+
# Installer logs
179+
pip-log.txt
180+
181+
# Unit test / coverage reports
182+
.coverage
183+
.tox
184+
185+
#Translations
186+
*.mo
187+
188+
#Mr Developer
189+
.mr.developer.cfg
190+
191+
# Mac crap
192+
.DS_Store

‎LICENSE.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
2+
License Information
3+
-------------------
4+
5+
The hardware is released under [Creative Commons Share-alike 3.0](http://creativecommons.org/licenses/by-sa/3.0/).
6+
7+
All other code is open source so please feel free to do anything you want with it; you buy me a beer if you use this and we meet someday ([Beerware license](http://en.wikipedia.org/wiki/Beerware)).
8+
9+

‎Libraries/README.md.txt‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎README.md‎

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,41 @@
1-
# SparkFun_VL6180_Time_of_Flight_Library
2-
VL6180 Baby Bear time of flight range finder Library for use with SparkFun breakouts
1+
SparkFun ToF Range Finder - VL6180 Arduino Library
2+
========================================
3+
4+
Arduino library with basic functionality of the VL6180 sensor.
5+
6+
Repository Contents
7+
-------------------
8+
9+
* **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE.
10+
* **/src** - Source files for the library (.cpp, .h).
11+
* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE.
12+
* **library.properties** - General library properties for the Arduino package manager.
13+
14+
Documentation
15+
--------------
16+
17+
* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.
18+
* **[Breakout Repository](https://github.com/sparkfun/ToF_Range_Finder_Breakout-VL6180/tree/master)** - Main repository (including hardware files) for the breakout.
19+
* **[Sensor Repository](https://github.com/sparkfun/ToF_Range_Finder_Sensor-VL6180/tree/master)** - Main repository (including hardware files) for the sensor board.
20+
* **[Hookup Guide](https://learn.sparkfun.com/tutorials/vl6180-hookup-guide)** - Basic hookup guide for the VL6180.
21+
22+
Products that use this Library
23+
---------------------------------
24+
25+
* [SEN-12785](https://www.sparkfun.com/products/12785)- Sensor Board
26+
* [SEN-12784](https://www.sparkfun.com/products/12784)- Breakout board
27+
28+
29+
License Information
30+
-------------------
31+
32+
This product is _**open source**_!
33+
34+
The **code** is beerware; if you see me (or any other SparkFun employee) at the local, and you've found our code helpful, please buy us a round!
35+
36+
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.
37+
38+
Distributed as-is; no warranty is given.
39+
40+
- Your friends at SparkFun.
41+

Libraries/SFE_VL6180x/examples/VL6180X_demo/VL6180X_demo.ino renamed to examples/SparkFun_VL6180X_demo/SparkFun_VL6180X_demo.ino

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
/******************************************************************************
2-
* VL6180X_demo.ino
2+
* SparkFun_VL6180X_demo.ino
33
* Example Sketch for VL6180x time of flight range finder.
44
* Casey Kuhns @ SparkFun Electronics
55
* 10/29/2014
6-
* https://github.com/sparkfun/ToF_Range_Finder-VL6180_Library
6+
* https://github.com/sparkfun/SparkFun_ToF_Range_Finder-VL6180_Arduino_Library
77
*
88
* The VL6180x by ST micro is a time of flight range finder that
99
* uses pulsed IR light to determine distances from object at close
@@ -16,7 +16,8 @@
1616
* IDE: Arduino 1.0.5
1717
* Hardware Platform: Arduino Pro 3.3V/8MHz
1818
* VL6180x Breakout Version: 1.0
19-
*
19+
* **Updated for Arduino 1.6.4 5/2015**
20+
2021
*
2122
* This code is beerware. If you see me (or any other SparkFun employee) at the
2223
* local pub, and you've found our code helpful, please buy us a round!
@@ -26,7 +27,7 @@
2627

2728
#include <Wire.h>
2829

29-
#include <SFE_VL6180X.h>
30+
#include <SparkFun_VL6180X.h>
3031

3132
/*const float GAIN_1 = 1.01; // Actual ALS Gain of 1.01
3233
const float GAIN_1_25 = 1.28; // Actual ALS Gain of 1.28

Libraries/SFE_VL6180x/keywords.txt renamed to keywords.txt

File renamed without changes.

‎library.properties‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name=SparkFun VL6180 Sensor
2+
version=1.1.0
3+
author=Casey Kuhns@SparkFun <techsupport@sparkfun.com>
4+
maintainer=SparkFun Electronics <sparkfun.com>
5+
sentence=The VL6180 combines an IR emitter, a range sensor, and an ambient light sensor together for you to easily use and communicate with via an I2C interface.
6+
paragraph=Library allows you to read distance and light outputs from the sensor, outputting the data via a serial connection.
7+
category=Sensors
8+
url=https://github.com/sparkfun/SparkFun_ToF_Range_Finder-VL6180_Arduino_Library
9+
architectures=*

Libraries/SFE_VL6180x/SFE_VL6180X.cpp renamed to src/SparkFun_VL6180X.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
/******************************************************************************
2-
* SFE_VL6180x.cpp
2+
* SparkFun_VL6180x.cpp
33
* Library for VL6180x time of flight range finder.
44
* Casey Kuhns @ SparkFun Electronics
55
* 10/29/2014
6-
* https://github.com/sparkfun/
6+
* https://github.com/sparkfun/SparkFun_ToF_Range_Finder-VL6180_Arduino_Library
77
*
88
* The VL6180x by ST micro is a time of flight range finder that
99
* uses pulsed IR light to determine distances from object at close
@@ -18,7 +18,7 @@
1818
* IDE: Arduino 1.0.5
1919
* Hardware Platform: Arduino Pro 3.3V/8MHz
2020
* VL6180x Breakout Version: 1.0
21-
*
21+
* **Updated for Arduino 1.6.4 5/2015**
2222
*
2323
* This code is beerware. If you see me (or any other SparkFun employee) at the
2424
* local pub, and you've found our code helpful, please buy us a round!
@@ -27,7 +27,7 @@
2727
******************************************************************************/
2828

2929
#include <Wire.h>
30-
#include "SFE_VL6180X.h"
30+
#include "SparkFun_VL6180X.h"
3131

3232
VL6180x::VL6180x(uint8_t address)
3333
// Initialize the Library

Libraries/SFE_VL6180x/SFE_VL6180X.h renamed to src/SparkFun_VL6180X.h

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
/******************************************************************************
2-
* SFE_VL6180X.h
2+
* SparkFun_VL6180X.h
33
* Library for VL6180x time of flight range finder.
44
* Casey Kuhns @ SparkFun Electronics
55
* 10/29/2014
6-
* https://github.com/sparkfun/
6+
* https://github.com/sparkfun/SparkFun_ToF_Range_Finder-VL6180_Arduino_Library
77
*
88
* The VL6180x by ST micro is a time of flight range finder that
99
* uses pulsed IR light to determine distances from object at close
@@ -18,6 +18,8 @@
1818
* IDE: Arduino 1.0.5
1919
* Hardware Platform: Arduino Pro 3.3V/8MHz
2020
* VL6180x Breakout Version: 1.0
21+
22+
**Updated for Arduino 1.6.4 5/2015**
2123
*
2224
* Some settings and initial values come from code written by Kris Winer
2325
* VL6180X_t3 Basic Example Code
@@ -32,8 +34,8 @@
3234
* Distributed as-is; no warranty is given.
3335
******************************************************************************/
3436

35-
#ifndef SFE_VL6180X_h
36-
#define SFE_VL6180X_h
37+
#ifndef SparkFun_VL6180X_h
38+
#define SparkFun_VL6180X_h
3739

3840
#include <Arduino.h>
3941

0 commit comments

Comments
 (0)