Skip to content
This repository was archived by the owner on Jan 28, 2021. It is now read-only.

Commit 279af3c

Browse files
committed
Adding note about I2C 400kHz issues.
1 parent 9f3799d commit 279af3c

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

Diff for: README.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
SparkFun Ublox Arduino Library
1+
SparkFun u-blox Arduino Library
22
===========================================================
33

44
<table class="table table-hover table-striped table-bordered">
@@ -18,10 +18,18 @@ SparkFun Ublox Arduino Library
1818
</tr>
1919
</table>
2020

21-
Ublox makes some incredible GPS receivers covering everything from low-cost, highly configurable modules such as the SAM-M8Q all the way up to the surveyor grade ZED-F9P with precision of the diameter of a dime. This library focuses on configuration and control of Ublox devices over I2C (called DDC by Ublox) and Serial. The UBX protocol is supported over both I2C and serial, and is a much easier and lighterweight interface to a GPS module. Stop parsing NMEA data! And simply ask for the datums you need.
21+
U-blox makes some incredible GPS receivers covering everything from low-cost, highly configurable modules such as the SAM-M8Q all the way up to the surveyor grade ZED-F9P with precision of the diameter of a dime. This library focuses on configuration and control of u-blox devices over I2C (called DDC by u-blox) and Serial. The UBX protocol is supported over both I2C and serial, and is a much easier and lighterweight interface to a GPS module. Stop parsing NMEA data! And simply ask for the datums you need.
2222

2323
This library can be installed via the Arduino Library manager. Search for **SparkFun Ublox**.
2424

25+
26+
Max (400kHz) I2C Support
27+
-------------------
28+
29+
To achieve 400kHz I2C speed please be sure to remove all pull-ups on the I2C bus. Most, if not all, u-blox modules include pull ups on the I2C lines (sometimes called DDC in their manuals). Cut all I2C pull up jumpers and/or remove them from peripheral boards. Otherwise, various data glitches can occur. See issues [38](https://github.com/sparkfun/SparkFun_Ublox_Arduino_Library/issues/38) and [40](https://github.com/sparkfun/SparkFun_Ublox_Arduino_Library/issues/40) for more information. If possible, run the I2C bus at 100kHz.
30+
31+
-------------------
32+
2533
Want to help? Please do! We are always looking for ways to improve and build out features of this library.
2634

2735
* We are always interested in adding SPI support with a checkUbloxSPI() function
@@ -38,8 +46,7 @@ Thanks to:
3846
* [grexjmo](https://github.com/grexjmo) for pushing for a better NMEA sentence configuration method
3947
* [averywallis](https://github.com/averywallis) for adding good comments to the various constants.
4048

41-
42-
Need a library for the Ublox and Particle? Checkout the [Particle library](https://github.com/aseelye/SparkFun_Ublox_Particle_Library) fork.
49+
Need a library for the Ublox and Particle? Checkout the [Particle library](https://github.com/aseelye/SparkFun_u-blox_Particle_Library) fork.
4350

4451
Repository Contents
4552
-------------------

0 commit comments

Comments
 (0)