FAQ

General

1. What is the difference between the Communicator Plugin and the API?
2. What is it good for?

1. What is the Garmin API license?
2. What code is open source?

1. I'm getting a JavaScript error: "ReferenceError: Garmin is not defined"
2. I'm getting a JavaScript error: "TypeError: Garmin.DeviceControl is not a constructor"
3. I'm getting: "This plugin is site-locked"

General

What is the difference between the Communicator Plugin and the API?

The plugin is the actual software program that must be installed on a client computer that enables a browser to communicate with a GPS device.

The API is a javascript library that allows website developers to control the plugin

---

What is it good for?

Allowing users to exchange their GPS data with a web sites using just a USB cable.

License

What is the Garmin API license?

Developers wishing to control the Garmin Communicator Plugin must agree to the API License Agreement.

---

What code is open source?

All javascript code is open source. Javascript is easily copied so rather than trying to protect it we thought we'd encourage others to help the cause.

The javascript uses the Apache 2.0 license.

Trouble Shooting

I'm getting a JavaScript error: "ReferenceError: Garmin is not defined"

This usualy means prototype.js is not present. Check your path and script elements.

---

I'm getting a JavaScript error: "TypeError: Garmin.DeviceControl is not a constructor"

This usualy means prototype.js is not present. Check your path and script elements.

---

I'm getting: "This plugin is site-locked"

The Garmin plugin requires a domain-specific key to unlock it that matches the URL of the web page it is hosted on. Developers using the plugin can obtain a key here.