Class Garmin.DeviceControl

Object
   |
   +--Garmin.DeviceControl

class Garmin.DeviceControl

Garmin.DeviceControl The controller must be unlocked before anything can be done with it. Then you'll have to find a device before you can start to read data from and write data to the device.

We use the observer pattern (http://en.wikipedia.org/wiki/Observer_pattern) to handle the asynchronous nature of device communication. You must register your class as a listener to this Object and then implement methods that will get called on certain events.

Events:

onStartFindDevices called when starting to search for devices. the object returned is {controller: this}

onCancelFindDevices is called when the controller is told to cancel finding devices {controller: this}

onFinishFindDevices called when the devices are found. the object returned is {controller: this}

onException is called when an exception occurs in a method object passed back is {msg: exception}

onInteractionWithNoDevice is called when the device is lazy loaded, but finds no devices, yet still attempts a read/write action {controller: this}

onStartReadFromDevice is called when the controller is about to start reading from the device {controller: this}

onFinishReadFromDevice is called when the controller is done reading the device. the read is either a success or failure, which is communicated via json. object passed back contains {success:this.garminPlugin.GpsTransferSucceeded, controller: this}

onWaitingReadFromDevice is called when the controller is waiting for input from the user about the device. object passed back contains: {message: this.garminPlugin.MessageBoxXml, controller: this}

onProgressReadFromDevice is called when the controller is still reading information from the device. in this case the message is a percent complete/ {progress: this.getDeviceStatus(), controller: this}

onCancelReadFromDevice is called when the controller is told to cancel reading from the device {controller: this}

onFinishWriteToDevice is called when the controller is done writing to the device. the write is either a success or failure, which is communicated via json. object passed back contains {success:this.garminPlugin.GpsTransferSucceeded, controller: this}

onWaitingWriteToDevice is called when the controller is waiting for input from the user about the device. object passed back contains: {message: this.garminPlugin.MessageBoxXml, controller: this}

onProgressWriteToDevice is called when the controller is still writing information to the device. in this case the message is a percent complete/ {progress: this.getDeviceStatus(), controller: this}

onCancelWriteToDevice is called when the controller is told to cancel writing to the device {controller: this}


Defined in GarminDeviceControl.js

Requires:

- Prototype
- BrowserDetect
- Garmin.DevicePlugin
- Garmin.Broadcaster
- Garmin.XmlConverter

Field Detail

FILE_TYPES

<static> Object FILE_TYPES

Constants defining possible file types associated with read and write methods.

FINISH_STATES

<static> Object FINISH_STATES

Constants defining possible states when you poll the finishActions

MESSAGES

<static> Object MESSAGES

Constants defining possible errors messages for various errors on the page

REQUIRED_VERSION

<static> Object REQUIRED_VERSION

Current Version of the Garmin Communicator Plugin, and a complementary toString function to print it out with

TRANSFER_DIRECTIONS

<static> Object TRANSFER_DIRECTIONS

Constants defining the strings used by the Device.xml to indicate transfer direction of each file type

Garmin.DeviceControl

Garmin.DeviceControl()

A controller object that can retrieve and send data to a Garmin device.

Requires:
- Prototype
- BrowserDetect
- Garmin.DevicePlugin
- Garmin.Broadcaster
- Garmin.XmlConverter

_isAMember

Object _isAMember(element, array)

_majorVersionToNumber

Object _majorVersionToNumber(versionArray)

_messageWaiting

Object _messageWaiting()

Called when device generates a message. This occurs when completionState == Garmin.DeviceControl.FINISH_STATES.messageWaiting.

_versionToNumber

Object _versionToNumber(versionArray)

cancelFindDevices

void cancelFindDevices()

Cancels the current find devices interaction

cancelReadFromDevice

void cancelReadFromDevice()

User canceled the read.

cancelWriteToDevice

void cancelWriteToDevice()

Cancels the current write transfer to the device

downlaodToDevice

void downlaodToDevice(<String> xmlDownloadDescription, filename)

Writes GPI info to the currently selected device.

Parameters:
xmlDownloadDescription - to be written to the device.
fileName - to write it to.

findDevices

void findDevices()

Finds any connected Garmin Devices. When it's done finding the devices, onFinishFindDevices is dispatched this.numDevices = the number of devices found this.deviceNumber is the device that we'll use to communicate with Use this.getDevices() to get an array of the found devices and this.setDeviceNumber({Number}) to change the device

getDevices

Array getDevices()

Get a list of the devices found

getDeviceStatus

Garmin.TransferProgress getDeviceStatus()

Get the status/progress of the current state or transfer

getPluginVersion

Array getPluginVersion()

Gets the version number for the plugin the user has currently installed

Returns:
An array of the Garmin.DeviceControl.prototype.format = [versionMajor, versionMinor, buildMajor, buildMinor];.

getPluginVersionString

String getPluginVersionString()

Gets a string of the version number for the plugin the user has currently installed

Returns:
A string of the format "versionMajor.versionMinor.buildMajor.buildMinor", Garmin.DeviceControl.prototype.ex = "2.0.0.4";

initialize

void initialize()

Instantiates a Garmin.DeviceControl object, but does not unlock/activate plugin.

isActivated

Boolean isActivated()

DEPRICATED - This funciton will be removed in the next release!! True if plugin has been successfully created and unlocked.

Deprecated use isUnlocked instead

isPluginInitialized

Boolean isPluginInitialized()

Determines if the plugin is initialized

isPluginInstalled

Boolean isPluginInstalled()

Determines if the plugin is installed on the user's machine

isPluginOutOfDate

Boolean isPluginOutOfDate()

Determines if the Garmin plugin is the required version or a newer version for this JavaScript library.

isUnlocked

Boolean isUnlocked()

True if plugin has been successfully created and unlocked.

readDataFromDevice

void readDataFromDevice(<String> fileType)

Generic read method.

Parameters:
fileType - is either 'gpx' or 'hst'

readFromDevice

void readFromDevice()

Asynchronously reads GPX data from the connected device. Only handles reading from the device in this.deviceNumber When the data has been gathered, the onFinishedReadFromDevice is fired, and the data is stored in this.gpsDataString and this.gpsData

readFromDeviceFitness

void readFromDeviceFitness()

Asynchronously reads fotmess data (HST) from the connected device. Only handles reading from the device in this.deviceNumber When the data has been gathered, the onFinishedReadFromDevice is fired, and the data is stored in this.gpsDataString

register

void register(listener)

Register to be an event listener. An object that is registered will be dispatched a method if they have a function with the same dispatch name. So if you register a listener with an onFinishFindDevices, and the onFinishFindDevices message is called, you'll get that message. See class comments for event types

Parameters:
Object - that will listen for events coming from this object

See:
- {Garmin.Broadcaster}

respondToMessageBox

void respondToMessageBox(<Number> response)

Responds to a message box on the device. TODO this method only works with writes - should it work with reads?

Parameters:
response - should be an int which corresponds to a button value from this.garminPlugin.MessageBoxXml

setDeviceNumber

void setDeviceNumber(deviceNumber)

Sets the deviceNumber variable which determines which connected device to talk to.

Parameters:
The - device number

unlock

Boolean unlock(<Array> pathKeyPairsArray)

Unlocks the GpsControl object to be used at the given web adress.

Parameters:
pathKeyPairsArray - baseURL and key pairs.

Returns:
True if the plug-in was unlocked successfully

writeAddressToDevice

void writeAddressToDevice(<String> address)

Writes an address to the currently selected device.

Parameters:
address - to be written to the device. This doesn't check validity

writeToDevice

void writeToDevice(<String> gpxString, <String> fileName)

Writes the given GPX XML string to the device selected in this.deviceNumber

Parameters:
gpxString - XML to be written to the device. This doesn't check validity.
fileName - to write it to. Validity is not checked here.