Garmin Communicator Plugin API

Overview

The Garmin Communicator Plugin is an exciting new software program that transfers data between websites and Garmin GPS Devices. The Garmin Communicator Plugin API allows developers to integrate the Communicator Plugin into any website.

The API is a Javascript library that provides user interface components that will transfer GPS data between a website and a Garmin device. The result is a toolkit that can connect any website’s visitors to Garmin devices with very little development effort.

API Features

• Auto-detection of devices connected to a computer
• Access to device product information like product name and software version
• Read tracks, routes and waypoints from supported recreational, fitness and navigation devices
• Write tracks, routes and waypoints to supported recreational, fitness and navigation devices
• Read fitness data from supported fitness devices
• Geo-code address and save to a device as a waypoint or favorite
• Read and write using standard XML files (GPX,TCX)
• Support for most Garmin devices (USB, USB mass-storage, most serial devices)
• Support for Internet Explorer and Firefox on Microsoft Windows.
• Support for Safari and Firefox on Mac OS X.

Architecture

The Garmin Communicator API is a JavaScript framework that hides the details of working directly with the underlying browser plugin. It consists of three tiers, each more user-friendly than the one it builds on.
The easiest to use is the DeviceDisplay which can be added to a web site with just a few lines of configuration code. The next tier down is the DeviceControl which is for JavaScript programmers who need more control over the event model. Lastly the DevicePlugin is a low-level plugin wrapper for developers who need bare-metal access.

Getting Started

Anyone is free to write software to do cool stuff using Garmin GPS data via the API. Here’s how to get started:

1. Download and Install Garmin Browser Plugin
2. Try the cut-and-paste examples from the DeviceDisplay
3. More advanced users can work at the DeviceControl level.
4. Sign up for an API account key

Developer Resources

• Maven generated developer site (most up-to-date information)
• Control API Demo page
• Understand the license
• Browse the source code documentation
• Browse the source code
• Run the unit tests

Distribution

The Javascript source files are all you need to integrate most features into your website. The source files may be accessed in three ways:

• Hosted - Reference the javascript files hosted at http://developer.garmin.com
• Distribution - Download the distribution file and deploy the necessary scripts into your own site and access resources locally
• Source - Check out the source files and build using maven

Note: Source code is distributed under the Apache 2.0 open source license. Find out more about the licenses and how you can contribute to the project.

Releases

Changes between releases are found in the Release Notes. The latest stable release may always be found at http://developer.garmin.com/web/communicator-api/. However, if you don’t want to risk breaking your page with each new release, point at the specific version that you developed against (recommended)