Skip to content

Commit

Permalink
Add links for exmaple readme
Browse files Browse the repository at this point in the history
  • Loading branch information
malcolm-sparkfun committed Feb 19, 2025
1 parent f54364f commit c1a1da9
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@ Below is a brief summary of each of the example programs included in this reposi
NOTE: Any numbering of examples is to retain consistency with the Arduino library from which this was ported.

## Qwiic Gps Ex1
Simple Example for SparkFun GPS Breakout - XA1110
In this example NMEA data is requested from the GPS module and the recieved Latitude,
Longitude, and Time data is printed to the screen.
In this example NMEA data is requested from the GPS module and the recieved Latitude, Longitude, and Time data is printed to the screen.

## Qwiic Gps Ex2
Simple Example for SparkFun GPS Breakout - XA1110
In this example, much like the first, NMEA data is requested from the SparkFun
GPS Breakout Board. All data that is retrieved is the printed to the screen.
The key methods/properties showcased by this example are:
- [get_nmea_data()](https://docs.sparkfun.com/qwiic_titan_gps_py/classqwiic__titan__gps_1_1_qwiic_titan_gps.html#a4b88d6bbd3acf09b379fce2c6ce3ca52)
- [gnss_messages](https://docs.sparkfun.com/qwiic_titan_gps_py/classqwiic__titan__gps_1_1_qwiic_titan_gps.html#af002fb88446a4547f6b9564b264e9f39)

## Qwiic Gps Ex2
In this example, much like the first, NMEA data is requested from the SparkFun
GPS Breakout Board. All data that is retrieved is the printed to the screen.

The key methods/properties showcased by this example are:
- [get_nmea_data()](https://docs.sparkfun.com/qwiic_titan_gps_py/classqwiic__titan__gps_1_1_qwiic_titan_gps.html#a4b88d6bbd3acf09b379fce2c6ce3ca52)
- [gnss_messages](https://docs.sparkfun.com/qwiic_titan_gps_py/classqwiic__titan__gps_1_1_qwiic_titan_gps.html#af002fb88446a4547f6b9564b264e9f39)

0 comments on commit c1a1da9

Please sign in to comment.