Datasheet

You can also download the adafruit_gps.mpy file from the Adafruit CircuitPython GPS releases page.

Before continuing make sure your board's lib folder or root filesystem has the adafruit_gps.mpy, files and

folders copied over.

Usage

To demonstrate the usage of the GPS module in CircuitPython let's look at a complete program example. the simple.py

file from the module's examples. Save this file as main.py on your board, then open the REPL connection to the board

to see its output:

# Simple GPS module demonstration.

# Will wait for a fix and print a message every second with the current location

# and other details.

import time

import board

import busio

import adafruit_gps

# Define RX and TX pins for the board's serial port connected to the GPS.

# These are the defaults you should use for the GPS FeatherWing.

# For other boards set RX = GPS module TX, and TX = GPS module RX pins.

RX = board.RX

TX = board.TX

# Create a serial connection for the GPS connection using default speed and

# a slightly higher timeout (GPS modules typically update once a second).

uart = busio.UART(TX, RX, baudrate=9600, timeout=3000)

# Create a GPS module instance.

gps = adafruit_gps.GPS(uart)

# Initialize the GPS module by changing what data it sends and at what rate.

# These are NMEA extensions for PMTK_314_SET_NMEA_OUTPUT and

# PMTK_220_SET_NMEA_UPDATERATE but you can send anything from here to adjust

# the GPS module behavior:

# https://cdn-shop.adafruit.com/datasheets/PMTK_A11.pdf

# Turn on the basic GGA and RMC info (what you typically want)

gps.send_command('PMTK314,0,1,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0')

# Turn on just minimum info (RMC only, location):

#gps.send_command('PMTK314,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0')

# Turn off everything:

#gps.send_command('PMTK314,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0')

# Tuen on everything (not all of it is parsed!)

#gps.send_command('PMTK314,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0')

# Set update rate to once a second (1hz) which is what you typically want.

gps.send_command('PMTK220,1000')

# Or decrease to once every two seconds by doubling the millisecond value.

# Be sure to also increase your UART timeout above!

#gps.send_command('PMTK220,2000')

# You can also speed up the rate, but don't go too fast or else you can lose

# data during parsing. This would be twice a second (2hz, 500ms delay):

#gps.send_command('PMTK220,500')