Skip to content

Latest commit

 

History

History
119 lines (73 loc) · 7.67 KB

GETTING-STARTED.md

File metadata and controls

119 lines (73 loc) · 7.67 KB

SnapperGPS: Getting started

You just obtained your first SnapperGPS receiver or built one yourself? Here is how to get started with a quick test. If you face any problems on the way, check our troubleshooting section on https://snappergps.info/, ask a question on GitHub, or create a new troubleshooting issue.

What is in the box?

SnapperGPS receivers come as assembled PCBs, but without any further protection or peripherals.

A bare-bone SnapperGPS receiver
Figure 1: A bare-bone SnapperGPS receiver.

What you need in addition.

To make your SnapperGPS receiver fully functional, you need the following items:

A SnapperGPS receiver, an Echo 27 antenna (right), and a 400 mAh lithium-polymer battery (left)
Figure 2: A SnapperGPS receiver, an Echo 27 antenna (right), and a lithium-ion polymer battery with a JST-PH connector with the correct polarity (left).
JST-PH connectors with the incorrect polarity.)
Figure 3: JST-PH connectors with the incorrect polarity. The red and the black cable are swapped in contrast to the connector in Figure 1. Do not use a battery with this polarity with SnapperGPS.

How to assemble your tag.

Connect your active GPS-L1 antenna to the circular U.FL connector. Make sure that the connection is tight.

Next, connect your battery to the plastic JST connector of your SnapperGPS receiver. Make sure that the black cable is connected to the part of the connector that is labelled with “-” and the red cable to the one labelled with “+”. If the polarity is inverted, you may damage your SnapperGPS receiver.

Finally, connect a USB-C cable to the USB-C port of your SnapperGPS receiver.

A SnapperGPS receiver with peripherals
Figure 4: A SnapperGPS receiver with peripherals.

Connect to your SnapperGPS receiver.

Connect your SnapperGPS receiver via USB to your laptop, desktop computer, tablet, or phone. (Note: iOS and iPadOS are not supported.)

Go to https://snappergps.info/ in a browser like Microsoft Edge or Google Chrome. (Note: Mozilla Firefox and Apple Safari are not supported, for example.)

Click on “Configure” and then on “Pair Receiver”. If your SnapperGPS receiver is connected via USB, you should see it in a pop-up and should be able to select it.

Home page of https://snappergps.info/
Figure 5: Home page of https://snappergps.info/.
Configure page before pairing a SnapperGPS receiver
Figure 6: Configure page before pairing a SnapperGPS receiver.

Check the battery voltage.

If you successfully connected your SnapperGPS receiver to the web app, then you should see information about your SnapperGPS receiver on the top of the website. Check that the battery is charged, i.e., the battery voltage is around 4.1 V. If the battery is not charged, do so first before you continue.

Configure page showing battery voltage
Figure 7: Configure page showing battery voltage.

Configure your SnapperGPS receiver.

Follow the steps on the same page of the web app to configure your SnapperGPS receiver for a test deployment. As start and end time, just select a short time period in the near future.

Check that the text below the “Configure” button reads “Your receiver is configured.”

Unplug your SnapperGPS receiver from USB. Immediately, the green LED should flash several times. If it does not flash or the red LED flashes, then your SnapperGPS receiver is not configured.

Configure page after configuring a SnapperGPS receiver
Figure 8: Configure page after configuring a SnapperGPS receiver.

Record some data.

Move your SnapperGPS receivers outside. Place it in a way that the antenna points upwards towards the sky. Ensure that the the board is not placed on a conductive surface and no conducting materials are directly placed on the board without isolation. (This includes antenna and battery.)

When your SnapperGPS receiver has not started to record data, then both LEDs will jointly flash in a regular interval. Once it has started to record data, the green LED will flash whenever it captures data. After all data has been recorded, the red LED will flash several times. However, you do not need to wait until this happens.

SnapperGPS receivers recording data
Figure 9: SnapperGPS receivers recording data.

Upload your data.

Connect you SnapperGPS receiver again via USB and go to the Upload page of https://snappergps.info/. Follow the instructions there to upload your raw data to our server.

Once your data has been processed, you should be able to see the final computed track on the download page.

Home page of https://snappergps.info/
Figure 10: Home page of https://snappergps.info/.
A SnapperGPS receiver with its recorded track
Figure 11: A SnapperGPS receiver with its recorded track.

Further resources.

If you want to post-process your data, for example, smooth it to get better accuracy or plot it on an interactive map, and you have a little bit familiarity with the Python programming language, then you can find some scripts in this repository.

If you want to build a housing for your SnapperGPS receiver, then you can find some inspiration in this repository. Potential housings include vacuum sealing, heat shrinking, milled plastic, or 3D printing. Make sure that the chosen method is suitable for your deployment environment.

Your SnapperGPS receiver exposes three general-purpose input-output (GPIO) pins that you can use to connect an external sensor or a trigger. Check out the PCB design and the firmware to learn more about this possibility.

This documentation is licensed under a Creative Commons Attribution 4.0 International License.

CC BY 4.0