Skip to content

Commit 36492b0

Browse files
marshalltaylorSFEmarshalltaylorSFE
committed
1.0 release
1 parent c3101d5 commit 36492b0

File tree

7 files changed

+49
-35
lines changed

7 files changed

+49
-35
lines changed

‎README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
SparkFun RedBot Line Follower Bar Arduino Library
1+
SparkFun RedBot Line Follower Array Arduino Library
22
========================================
33

4-
![RedBot Line Follower Bar](https://cdn.sparkfun.com/r/140-140/assets/parts/1/0/2/8/8/13166-07a.jpg)
4+
![SparkFun Line Follower Array](https://raw.githubusercontent.com/sparkfun/SparkFun_Line_Follower_Array_Arduino_Library/master/extras/BoardPicture.png?token=AKhi91BrwgQjDyN_JtS7Qd-Hquv4fkMiks5WJn4hwA%3D%3D)
55

6-
[*RedBot Line Follower Bar (SKU-00000)*](http://www.sparkfun.com)
6+
[*SparkFun Line Follower Array (SEN-13582)*](https://www.sparkfun.com/products/13582)
77

8-
This library for the RedBot Line Following Bar allows the following functions:
8+
This library for the Line Following Array allows the following functions:
99

1010
* get raw data
1111
* get position
@@ -26,17 +26,18 @@ Documentation
2626

2727
* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.
2828
* **[Product Repository](GitHub Product URL)** - Main repository (including hardware files) for the <PRODUCT NAME>.
29-
* **[Hookup Guide](Learn.SparkFun URL)** - Basic hookup guide for the <PRODUCT NAME>.
29+
* **[Line Follower Array Hookup Guide](https://learn.sparkfun.com/tutorials/sparkfun-line-follower-array-hookup-guide)** - Basic hookup guide for the *SparkFun Line Follower Array (SEN-13582)*.
3030

3131
Products that use this Library
3232
---------------------------------
3333

34-
* [Part SKU](SparkFun part URL)- Basic part and short description here
34+
* [*SparkFun Line Follower Array (SEN-13582)*](https://www.sparkfun.com/products/13582)
3535

3636
Version History
3737
---------------
3838

39-
* [V_0.4.0](https://github.com/sparkfun/RedBot_Line_Follower_Bar_Arduino_Library/tree/V_0.4.0) - Beta Release. All functions covered
39+
* [V_1.0.0](https://github.com/sparkfun/SparkFun_Line_Follower_Array_Arduino_Library/tree/V_1.0.0) - Public release, names and links formalized.
40+
* [V_0.4.0](https://github.com/sparkfun/SparkFun_Line_Follower_Array_Arduino_Library/tree/V_0.4.0) - Beta release. All functions covered
4041

4142
License Information
4243
-------------------

‎examples/AveragingReadBarOnly/AveragingReadBarOnly.ino

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,20 @@ Marshall Taylor, SparkFun Engineering
77
88
5-27-2015
99
10-
<github repository address>
10+
Library:
11+
https://github.com/sparkfun/SparkFun_Line_Follower_Array_Arduino_Library
12+
Product:
13+
https://github.com/sparkfun/Line_Follower_Array
1114
1215
This sketch shows how to use the circular buffer class to create a history of
1316
sensor bar scans.
14-
The buffer is hard-coded (see CSTACK_MAX_LENGTH in sensorbar.h) to have a size of
15-
200 16bit integers.
17+
The buffer configured with CBUFFER_SIZE to have a length of 100 16bit integers.
1618
1719
Resources:
1820
sensorbar.h
1921
2022
Development environment specifics:
21-
arduino v1.6.4
23+
arduino > v1.6.4
2224
hw v1.0
2325
2426
This code is released under the [MIT License](http://opensource.org/licenses/MIT).

‎examples/MostBasicFollower/MostBasicFollower.ino

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
/******************************************************************************
22
MostBasicFollower.ino
33
4-
A very simple method for following a line with a redbot and sensor bar.
4+
A very simple method for following a line with a redbot and the line follower array.
55
66
Marshall Taylor, SparkFun Engineering
77
88
5-27-2015
99
10-
<github repository address>
10+
Library:
11+
https://github.com/sparkfun/SparkFun_Line_Follower_Array_Arduino_Library
12+
Product:
13+
https://github.com/sparkfun/Line_Follower_Array
1114
1215
This example demonstrates the easiest way to interface the redbot sensor bar.
1316
"SensorBar mySensorBar(SX1509_ADDRESS);" creates the sensor bar object.
@@ -31,7 +34,7 @@ Resources:
3134
sensorbar.h
3235
3336
Development environment specifics:
34-
arduino v1.6.4
37+
arduino > v1.6.4
3538
hw v1.0
3639
3740
This code is released under the [MIT License](http://opensource.org/licenses/MIT).

‎examples/ReadBarOnly/ReadBarOnly.ino

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,22 @@ Marshall Taylor, SparkFun Engineering
77
88
5-27-2015
99
10-
<github repository address>
10+
Library:
11+
https://github.com/sparkfun/SparkFun_Line_Follower_Array_Arduino_Library
12+
Product:
13+
https://github.com/sparkfun/Line_Follower_Array
1114
1215
This sketch simply reads the data from the bar and prints it to the serial buffer.
1316
"SensorBar mySensorBar(SX1509_ADDRESS);" creates the sensor bar object.
14-
"mySensorBar.init();" gets the bar ready.
17+
"mySensorBar.begin();" gets the bar ready.
1518
"mySensorBar.getDensity()" gets the number of points sensed.
1619
"mySensorBar.getPosition()" gets the average center of sensed points.
1720
1821
Resources:
1922
sensorbar.h
2023
2124
Development environment specifics:
22-
arduino v1.6.4
25+
arduino > v1.6.4
2326
hw v1.0
2427
2528
This code is released under the [MIT License](http://opensource.org/licenses/MIT).

‎library.properties

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
name=RedBot Line Follower Bar Arduino Library
2-
version=0.4.0
1+
name=SparkFun Line Follower Array
2+
version=1.0.0
33
author=SparkFun Electronics <[email protected]>
44
maintainer=SparkFun Electronics <sparkfun.com>
5-
sentence=Library to operate the 8 position line sensor bar for robots.
5+
sentence=Library to operate the 8 position line sensor array for robots.
66
paragraph=This library can: get raw data, get position, get number of points detected, and build a circular buffer to record the data as it passes.
77
category=Sensors
8-
url=https://github.com/sparkfun/RedBot_Line_Follower_Bar_Arduino_Library
8+
url=https://github.com/sparkfun/SparkFun_Line_Follower_Array_Arduino_Library
99
architectures=*

‎src/sensorbar.cpp

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
/******************************************************************************
22
sensorbar.cpp
33
4-
RedBot Sensor Bar Library
4+
SparkFun Line Follower Array Arduino Library
55
66
Marshall Taylor, SparkFun Engineering
77
88
5-27-2015
99
10-
https://github.com/sparkfun/RedBot_Line_Follower_Bar
10+
Library:
11+
https://github.com/sparkfun/SparkFun_Line_Follower_Array_Arduino_Library
12+
Product:
13+
https://github.com/sparkfun/Line_Follower_Array
1114
1215
This is a library for reading the sensor bar's data by I2C. It was originally
13-
adapted from the "SparkFun SX1509 IO Expander Breakout Arduino Library" that
14-
was written by Jim Lindblom.
16+
adapted from the "SparkFun SX1509 IO Expander Breakout Arduino Library".
1517
1618
Resources:
1719
Relies on the I2C driver (wire.h). Declaring an object of type SensorBar and
@@ -20,9 +22,9 @@ then calling .begin() causes wire.h to operate
2022
Development environment specifics:
2123
Tested on the RedBot 328 based arduino board.
2224
23-
This code is beerware; if you see me (or any other SparkFun employee) at the
24-
local, and you've found our code helpful, please buy us a round!
25-
25+
This code is released under the [MIT License](http://opensource.org/licenses/MIT).
26+
Please review the LICENSE.md file included with this example. If you have any questions
27+
or concerns with licensing, please contact [email protected].
2628
Distributed as-is; no warranty is given.
2729
******************************************************************************/
2830

‎src/sensorbar.h

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,31 @@
11
/******************************************************************************
22
sensorbar.h
33
4-
RedBot Sensor Bar Library
4+
SparkFun Line Follower Array Arduino Library
55
66
Marshall Taylor, SparkFun Engineering
77
88
5-27-2015
99
10-
https://github.com/sparkfun/RedBot_Line_Follower_Bar
10+
Library:
11+
https://github.com/sparkfun/SparkFun_Line_Follower_Array_Arduino_Library
12+
Product:
13+
https://github.com/sparkfun/Line_Follower_Array
1114
1215
This is a library for reading the sensor bar's data by I2C. It was originally
13-
adapted from the ""SparkFun SX1509 IO Expander Breakout Arduino Library" that
16+
adapted from the "SparkFun SX1509 IO Expander Breakout Arduino Library" that
1417
was written by Jim Lindblom.
1518
1619
Resources:
1720
Relies on the I2C driver (wire.h). Declaring an object of type SensorBar and
18-
then calling .init() causes wire.h to operate
21+
then calling .begin() causes wire.h to operate
1922
2023
Development environment specifics:
2124
Tested on the RedBot 328 based arduino board.
2225
23-
This code is beerware; if you see me (or any other SparkFun employee) at the
24-
local, and you've found our code helpful, please buy us a round!
25-
26+
This code is released under the [MIT License](http://opensource.org/licenses/MIT).
27+
Please review the LICENSE.md file included with this example. If you have any questions
28+
or concerns with licensing, please contact [email protected].
2629
Distributed as-is; no warranty is given.
2730
******************************************************************************/
2831

0 commit comments

Comments
 (0)