Skip to main content

Squadrats2Garmin project is a set of tools that improves the experience of _Squadrats_ collectors who use Garmin bike computers and smartwatches.

Project description

🇵🇱 po polsku

Squadrats2Garmin tools

Squadrats2Garmin project is a set of tools that improves the experience of Squadrats collectors who use Garmin bike computers and smartwatches.

What are Squadrats?

That's right. Explain like I'm your grandpa, please!

What does this project do?

It allows you to see borders of Squadrats and Squadratinhos right on your Garmin device. No more need to reach out for your phone to confirm a score!

Here you can generate or download Squadrat- and Squadratinho-sized grid overlay for maps on your Garmin device.

Supported devices

Basically all Garmin devices that can use custom maps in IMG format. That includes but is not limited to:

Bike computers:

  • Edge 10x0 series
  • Edge 8x0 series
  • Edge 5x0 series (starting from Edge 520)

Handheld devices:

  • GPSMAP 62, 65

Smartwatches

  • Garmin Descent
  • Garmin Enduro
  • Garmin epix
  • Garmin Fenix 8, 7, 6, 5X and 5 Plus
  • Garmin Forerunner 965, 945
  • Garmin MARQ
  • Garmin tactix

Pre-made grids

Please check dist directory for pre-made grids. Use the instructions and go explore!

Contact me if your country/province is missing.

Generating your own grid

You can generate your own grid using this project. This will require knowledge of git, Python bash and access to a Linux or macOS computer.

# install mkgmap tool
$ sudo apt install mkgmap

# clone the repository
$ git clone git@github.com:kbrazulewicz/squadrats2garmin.git
$ cd squadrats2garmin

# install uv package and project manager
curl -LsSf https://astral.sh/uv/install.sh | sh

# setup Python environment
$ uv sync

Garmin-compatible grids are created by running squadrats2garmin script, passing a configuration file as an argument, ie.

# run the script
$ uv run grid -c config/PL-Polska.json

Read more about configuration file format

FAQ

Can I see the collected Squadrats?

No. At the moment you are able to see the Squadrats grid without the information about the collected ones.

How do I use the generated grids?

You can use them on your Garmin device by following the instructions.

How do I generate my own grids?

See generating your own grid section.

How do I display the grid in a different color?

To change the default colors you need to generate a custom grid.

  • see generating your own grid section for details how to generate your own grid
  • see etc/squadrats.typ.txt file for customization options
    • Type=0x11400 - Squadratinhos grid
    • Type=0x11410 - Squadrats grid (zoomed out)
    • Type=0x11411 - Squadrats grid (zoomed in)

How do I contact you?

Create a new issue in this project.

How can I support you?

Buy me a coffee:

Postaw mi kawę na buycoffee.to

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

squadrats2garmin-0.2.3-py3-none-any.whl (25.3 kB view details)

Uploaded Python 3

File details

Details for the file squadrats2garmin-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: squadrats2garmin-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 25.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for squadrats2garmin-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7436992331d8885c7f9936d2fcb077ff11abb1b2ac99e93e735b47832343dd9e
MD5 cb4a6199ee4486424364f659d264db2d
BLAKE2b-256 9f99d534862fa05d2d3796b709fa12bfc08ebd9c46a9f082cc9eb4a80bb69f12

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page