Skip to content

Commit 38d24c3

Browse files
author
Nathan Seidle
committed
Readme update. Add link to lib in each example.
1 parent 288530c commit 38d24c3

File tree

6 files changed

+14
-19
lines changed

6 files changed

+14
-19
lines changed

README.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
1-
SparkFun LIS2DH12 Arduino Library
1+
SparkFun External EEPROM Arduino Library
22
===========================================================
33

4-
![SparkFun Qwiic LIS2DH12](https://cdn.sparkfun.com//assets/parts/1/3/4/3/3/Qwiic_Twist_Hookup_Guide.jpg)
4+
![SparkFun Qwiic EEPROM](https://cdn.sparkfun.com//assets/parts/1/3/0/0/8/14764-Qwiic_EEPROM_-_512Kbit-01.jpg)
55

6-
[*SparkFun Qwiic LIS2DH12 Accelerometer (DEV-15760)*](https://www.sparkfun.com/products/15760)
6+
[*SparkFun Qwiic EEPROM (SPX-14764)*](https://www.sparkfun.com/products/14764)
77

8-
A simple to use I2C library for the very low power LIS2DH12 from ST.
8+
A simple to use I2C library for talking to any EEPROM. It uses the same template system found in the Arduino EEPROM library so you can use the same get() and put() functions.
99

10-
This library can be installed via the Arduino Library manager. Search for **SparkFun LIS2DH12**. ST offers a great portable C library for the LIS2DH12. This library just wraps that library making it Arduino friendly and easier to use with lots of examples.
10+
Various external EEPROMs have various interface specs (overall size, page size, write times, etc). This library works with all types and allows the various settings to be set at runtime. All read and write restrictions associated with pages are taken care of. You can access the external memory as if it was contiguous.
1111

12-
Want to help? Please do! We are always looking for ways to improve and build out features of this library.
12+
Best used with the Qwiic EEPROM: https://www.sparkfun.com/products/14764
13+
14+
This library can be installed via the Arduino Library manager. Search for **SparkFun External EEPROM**.
1315

14-
* This library currently only supports I2C but could be expanded to use SPI as well.
16+
Want to help? Please do! We are always looking for ways to improve and build out features of this library.
1517

1618
Repository Contents
1719
-------------------
@@ -26,13 +28,6 @@ Documentation
2628

2729
* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.
2830

29-
Products That Use This Library
30-
---------------------------------
31-
32-
* [DEV-15136](https://www.sparkfun.com/products/15170) - SparkFun Edge
33-
* [DEV-15005](https://www.sparkfun.com/products/15420) - SparkFun Edge 2
34-
* [SPX-15210](https://www.sparkfun.com/products/15760) - Qwiic LIS2DH12 Accelerometer Breakout
35-
3631
License Information
3732
-------------------
3833

examples/Example1_BasicReadWrite/Example1_BasicReadWrite.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
#include <Wire.h>
2323

24-
#include "SparkFun_External_EEPROM.h"
24+
#include "SparkFun_External_EEPROM.h" // Click here to get the library: http://librarymanager/All#SparkFun_External_EEPROM
2525
ExternalEEPROM myMem;
2626

2727
void setup()

examples/Example2_Settings/Example2_Settings.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
#include <Wire.h>
2727

28-
#include "SparkFun_External_EEPROM.h"
28+
#include "SparkFun_External_EEPROM.h" // Click here to get the library: http://librarymanager/All#SparkFun_External_EEPROM
2929
ExternalEEPROM myMem;
3030

3131
void setup()

examples/Example3_AdvancedI2C/Example3_AdvancedI2C.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
#include <Wire.h>
2626

27-
#include "SparkFun_External_EEPROM.h"
27+
#include "SparkFun_External_EEPROM.h" // Click here to get the library: http://librarymanager/All#SparkFun_External_EEPROM
2828
ExternalEEPROM myMem;
2929

3030
void setup()

examples/Example4_UserOptions/Example4_UserOptions.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
#include <Wire.h>
2323

24-
#include "SparkFun_External_EEPROM.h"
24+
#include "SparkFun_External_EEPROM.h" // Click here to get the library: http://librarymanager/All#SparkFun_External_EEPROM
2525
ExternalEEPROM myMem;
2626

2727
#define LOCATION_SETTINGS 0 //Position in EEPROM to store the user setting structure

examples/Example5_InterfaceTest/Example5_InterfaceTest.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
#include <Wire.h>
2323

24-
#include "SparkFun_External_EEPROM.h"
24+
#include "SparkFun_External_EEPROM.h" // Click here to get the library: http://librarymanager/All#SparkFun_External_EEPROM
2525
ExternalEEPROM myMem;
2626

2727
void setup()

0 commit comments

Comments
 (0)