Initial commit with examples

Author: nseidle

Diff for: README.md

@@ -1,17 +1,13 @@
-SparkFun BNO080 IMU Library
+SparkFun Ublox Arduino Library
 ===========================================================
 
-![SparkFun Inertial Measurement Unit - BNO080](https://cdn.sparkfun.com//assets/parts/1/2/7/3/3/14586-VR_IMU__Qwiic__-_BNO080-01.jpg)
+![SparkFun GPS-RTK - NEO-M8P-2](https://cdn.sparkfun.com/r/500-500/assets/parts/1/3/2/8/2/14980-Ublox_GPS-RTK__Qwiic__-_NEO-M8P-2-01.jpg)
 
-[*SparkX IMU BNO080 (SPX-14586)*](https://www.sparkfun.com/products/14586)
+[*SparkFun GPS-RTK - NEO-M8P-2 (SPX-14980)*](https://www.sparkfun.com/products/14980)
 
-The BNO080/BNO085 IMU has a combination triple axis accelerometer/gyro/magnetometer packaged with an ARM Cortex M0+ running powerful algorithms. This enables the BNO080 Inertial Measurement Unit (IMU) to produce accurate rotation vector headings with an error of 5 degrees or less. It's what we've been waiting for: all the sensor data is combined into meaningful, accurate IMU information.
+The NEO-M8P-2 module is the top-of-the-line module for high accuracy GNSS and GPS location solutions including RTK. The NEO-M8P-2 is unique in that it is capable of both rover and base station operations. The ‘-2’ designation means this module has survey-in mode allowing the module to become a base station and produce RTCM 3.x correction data. 
 
-This IC was designed to be implemented in Android based cellular phones to handle all the computations necessary for virtual reality goggles using only your phone. The sensor is quite powerful but with power comes a complex interface. We've written an I<sup>2</sup>C based library that provides the rotation vector (the reading most folks want from an IMU) as well as raw acceleration, gyro, and magnetometer readings. The sensor is capable of communicating over SPI and UART as well!
-
-In addition the BNO080 IMU provides a built-in step counter, tap detector, activity classifier (are you running, walking, or sitting still?), and a shake detector. We are duly impressed.
-
-Library written by Nathan Seidle ([SparkFun](http://www.sparkfun.com)).
+This library allows the reading of NMEA data over I2C as well as sending binary UBX configuration commands over I2C. This is helpful for configuring advanced modules like the NEO-M8P-2.
 
 Repository Contents
 -------------------
@@ -25,14 +21,14 @@ Documentation
 --------------
 
 * **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.
-* **[Product Repository](https://github.com/sparkfunX/Qwiic_IMU_BNO080)** - Main repository (including hardware files)
+* **[Product Repository](https://github.com/sparkfunX/Qwiic_GPS-RTK)** - Main repository (including hardware files)
 
 License Information
 -------------------
 
 This product is _**open source**_! 
 
-Various bits of the code have different licenses applied. Anything SparkFun wrote 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! Anything Maxim wrote has its own license. Anything that was co-writing with Peter Jansen is BSD.
+Various bits of the code have different licenses applied. Anything SparkFun wrote 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!
 
 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.
 

Diff for: examples/Example1_BasicNMEARead/Example1_BasicNMEARead.ino

@@ -0,0 +1,49 @@
+/*
+  Read NMEA sentences over I2C using Ublox module SAM-M8Q, NEO-M8P, etc
+  By: Nathan Seidle
+  SparkFun Electronics
+  Date: August 22nd, 2018
+  License: MIT. See license file for more information but you can
+  basically do whatever you want with this code.
+
+  This example reads the NMEA setences from the Ublox module over I2c and outputs
+  them to the serial port
+  
+  Feel like supporting open source hardware?
+  Buy a board from SparkFun! https://www.sparkfun.com/products/14980
+
+  Hardware Connections:
+  Plug a Qwiic cable into the GPS and a BlackBoard
+  If you don't have a platform with a Qwiic connection use the SparkFun Qwiic Breadboard Jumper (https://www.sparkfun.com/products/14425)
+  Open the serial monitor at 115200 baud to see the output
+*/
+
+#include <Wire.h> //Needed for I2C to GPS
+
+#include "SparkFun_Ublox_Arduino_Library.h" //Click here to get the library: http://librarymanager/All#SparkFun_Ublox_GPS
+SFE_UBLOX_GPS myGPS;
+
+void setup()
+{
+  Serial.begin(115200);
+  Serial.println("Ublox GPS I2C Test");
+
+  myGPS.begin(Wire);
+  if (myGPS.isConnected() == false)
+  {
+    Serial.println(F("Ublox GPS not detected at default I2C address. Please check wiring. Freezing."));
+    while (1);
+  }
+
+  Wire.setClock(400000); //Increase I2C clock speed to 400kHz
+
+  //This will pipe all NMEA sentences to the serial port so we can see them
+  myGPS.setNMEAOutputPort(Serial);
+}
+
+void loop()
+{
+  myGPS.checkUblox(); //See if new data is available. Process bytes as they come in.
+
+  delay(250); //Don't pound too hard on the I2C bus
+}

Diff for: examples/Example1_BasicReadings/Example1_BasicReadings.ino

@@ -0,0 +1,81 @@
+/*
+  Read NMEA sentences over I2C using Ublox module SAM-M8Q, NEO-M8P, etc
+  By: Nathan Seidle
+  SparkFun Electronics
+  Date: August 22nd, 2018
+  License: MIT. See license file for more information but you can
+  basically do whatever you want with this code.
+
+  This example reads the NMEA characters over I2C and pipes them to MicroNMEA
+  This example will output your current long/lat and satellites in view
+ 
+  Feel like supporting open source hardware?
+  Buy a board from SparkFun! https://www.sparkfun.com/products/14980
+
+  For more MicroNMEA info see https://github.com/stevemarple/MicroNMEA
+
+  Hardware Connections:
+  Plug a Qwiic cable into the GPS and a BlackBoard
+  If you don't have a platform with a Qwiic connection use the SparkFun Qwiic Breadboard Jumper (https://www.sparkfun.com/products/14425)
+  Open the serial monitor at 115200 baud to see the output
+  Go outside! Wait ~25 seconds and you should see your lat/long
+*/
+
+#include <Wire.h> //Needed for I2C to GPS
+
+#include "SparkFun_Ublox_Arduino_Library.h" //http://librarymanager/All#SparkFun_Ublox_GPS
+SFE_UBLOX_GPS myGPS;
+
+#include <MicroNMEA.h> //http://librarymanager/All#MicroNMEA
+char nmeaBuffer[100];
+MicroNMEA nmea(nmeaBuffer, sizeof(nmeaBuffer));
+
+void setup()
+{
+  Serial.begin(115200);
+  Serial.println("Ublox GPS I2C Test");
+
+  myGPS.begin(Wire);
+  if (myGPS.isConnected() == false)
+  {
+    Serial.println(F("Ublox GPS not detected at default I2C address. Please check wiring. Freezing."));
+    while (1);
+  }
+
+  Wire.setClock(400000); //Increase I2C clock speed to 400kHz
+}
+
+void loop()
+{
+  myGPS.checkUblox(); //See if new data is available. Process bytes as they come in.
+
+  if(nmea.isValid() == true)
+  {
+    long latitude_mdeg = nmea.getLatitude();
+    long longitude_mdeg = nmea.getLongitude();
+
+    Serial.print("Latitude (deg): ");
+    Serial.println(latitude_mdeg / 1000000., 6);
+    Serial.print("Longitude (deg): ");
+    Serial.println(longitude_mdeg / 1000000., 6);
+  }
+  else
+  {
+    Serial.print("No Fix - ");
+    Serial.print("Num. satellites: ");
+    Serial.println(nmea.getNumSatellites());
+  }
+
+  delay(250); //Don't pound too hard on the I2C bus
+}
+
+//This function gets called from the SparkFun Ublox Arduino Library
+//As each NMEA character comes in you can specify what to do with it
+//Useful for passing to other libraries like tinyGPS, MicroNMEA, or even
+//a buffer, radio, etc.
+void SFE_UBLOX_GPS::processNMEA(char incoming)
+{
+  //Take the incoming char from the Ublox I2C port and pass it on to the MicroNMEA lib
+  //for sentence cracking
+  nmea.process(incoming);
+}

Diff for: examples/Example2_NMEAParsing/Example2_NMEAParsing.ino

@@ -0,0 +1,72 @@
+/*
+  Send UBX binary commands to enable RTCM sentences on Ublox NEO-M8P module
+  By: Nathan Seidle
+  SparkFun Electronics
+  Date: September 7th, 2018
+  License: MIT. See license file for more information but you can
+  basically do whatever you want with this code.
+
+  This example sends the command to enable the four RTCM messages needed for RTK. This 
+  is the first part of a larger tutorial and example to setup an RTK base station.
+  These commands are only accepted by the NEO-M8P module.
+ 
+  Feel like supporting open source hardware?
+  Buy a board from SparkFun! https://www.sparkfun.com/products/14980
+
+  Hardware Connections:
+  Plug a Qwiic cable into the GPS and a BlackBoard
+  If you don't have a platform with a Qwiic connection use the SparkFun Qwiic Breadboard Jumper (https://www.sparkfun.com/products/14425)
+  Open the serial monitor at 115200 baud to see the output
+*/
+
+#include <Wire.h> //Needed for I2C to GPS
+
+#include "SparkFun_Ublox_Arduino_Library.h" //http://librarymanager/All#SparkFun_Ublox_GPS
+SFE_UBLOX_GPS myGPS;
+
+void setup()
+{
+  Serial.begin(115200);
+  while(!Serial); //Wait for user to open terminal
+  Serial.println("Ublox RTCM Enable Example");
+
+  myGPS.begin(Wire); //Connect to the Ublox module using Wire port
+  if (myGPS.isConnected() == false)
+  {
+    Serial.println(F("Ublox GPS not detected at default I2C address. Please check wiring. Freezing."));
+    while (1);
+  }
+
+  Wire.setClock(400000); //Increase I2C clock speed to 400kHz
+
+  while(Serial.available()) Serial.read(); //Clear any latent chars in serial buffer
+  Serial.println("Press any key to send commands to enable RTCM 3.x");
+  while(Serial.available() == 0) ; //Wait for user to press a key
+
+  boolean response = true;
+  response &= myGPS.enableRTCMmessage(UBX_RTCM_1005, UBX_RTCM_I2C_PORT, 1); //Enable message 1005 to output through I2C port, message every second
+  response &= myGPS.enableRTCMmessage(UBX_RTCM_1077, UBX_RTCM_I2C_PORT, 1);
+  response &= myGPS.enableRTCMmessage(UBX_RTCM_1087, UBX_RTCM_I2C_PORT, 1);
+  response &= myGPS.enableRTCMmessage(UBX_RTCM_1230, UBX_RTCM_I2C_PORT, 10); //Enable message every 10 seconds
+
+  if (response == true)
+  {
+    Serial.println("RTCM messages enabled");
+  }
+  else
+  {
+    Serial.println("RTCM failed to enable. Are you sure you have an NEO-M8P?");
+    while(1); //Freeze
+  }
+
+  //This will pipe the RTCM sentences out the serial port so we can see them
+  myGPS.setRTCMOutputPort(Serial);
+}
+
+void loop()
+{
+  myGPS.checkUblox(); //See if new data is available. Process bytes as they come in.
+
+  delay(250); //Don't pound too hard on the I2C bus
+}
+