net.studioblueplanet.usb

Class UsbInterface

java.lang.Object

net.studioblueplanet.usb.WatchInterface

net.studioblueplanet.usb.UsbInterface

public class UsbInterface
extends WatchInterface

This class represents the communication interface to the TomTom Watch. It offers user level functionality. It depends on UsbConnection for the actual communication to the watch. It contains the main functions concern the handling of files on the watch.

Author:

Jorgen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UsbInterface.FileMode

Nested classes/interfaces inherited from class net.studioblueplanet.usb.WatchInterface

WatchInterface.FileType

Field Summary

Fields inherited from class net.studioblueplanet.usb.WatchInterface

FILEID_BLE_FIRMWARE, FILEID_BLE_UPDATE_LOG, FILEID_GPS_FIRMWARE, FILEID_GPSQUICKFIX_DATA, FILEID_INVALID, FILEID_LOG, FILEID_MANIFEST1, FILEID_MANIFEST2, FILEID_PLAYLIST, FILEID_PREFERENCES_XML, FILEID_SYSTEM_FIRMWARE, FILEID_UPDATE_LOG, fileList, listener, preferenceFile, PRODUCTID_UNKNOWN, TTWATCH_FILE_TYPE_MASK

Constructor Summary

Constructors

Constructor and Description
UsbInterface(UsbConnection usbConnection) Constructor.

Method Summary

Modifier and Type	Method and Description
void	closeConnection() Closes the USB connection
boolean	deleteFile(UsbFile file) Deletes the file on the watch indicated by the ID in the file passed.
boolean	fileExists(int fileId) This method checks if a file exists
boolean	formatDevice() This method formats the device
String	getDeviceSerialNumber() Returns the serial number of the device.
ArrayList<UsbFile>	getFileList(WatchInterface.FileType fileType) This method requests the list of file of given type
int	getProductId() This method returns the firmware version
hirondelle.date4j.DateTime	getWatchTime() This method retrieves the time from the watch.
boolean	openConnection() Opens the USB connection
String	readBleVersion() This method returns the BLE version
boolean	readFile(UsbFile file) This method reads the file with file ID defined in the file instance passed from the watch
String	readFirmwareVersion() This method returns the firmware version
boolean	resetDevice() Execute device reset
boolean	resetGpsProcessor() Resets the GPS processor
boolean	sendMessageGroup1() Another message sequence reported by ttwatch
boolean	sendStartupSequence() According to ttwatch (Ryan Binns) this is the sequence that should be called after opening the watch connection
boolean	writeFile(UsbFile file) Write file to the watch.

Methods inherited from class net.studioblueplanet.usb.WatchInterface

getPreference, isFileType, readPreferences, setPreference, setProgressListener, writeGpxQuickFixFile, writePreferences, writeVerifyFile

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UsbInterface

public UsbInterface(UsbConnection usbConnection)

Constructor.

Parameters:

usbConnection - The USB connection to use

Method Detail

openConnection

public boolean openConnection()

Opens the USB connection

Overrides:

openConnection in class WatchInterface

Returns:

True if not successful, false if successful

closeConnection

public void closeConnection()

Closes the USB connection

Overrides:

closeConnection in class WatchInterface

sendStartupSequence

public boolean sendStartupSequence()

According to ttwatch (Ryan Binns) this is the sequence that should be called after opening the watch connection

Overrides:

sendStartupSequence in class WatchInterface

Returns:

True if an error occurred, false if successful

sendMessageGroup1

public boolean sendMessageGroup1()

Another message sequence reported by ttwatch

Overrides:

sendMessageGroup1 in class WatchInterface

Returns:

True if an error occurred, false if successful

fileExists

public boolean fileExists(int fileId)

Description copied from class: WatchInterface

This method checks if a file exists

Specified by:

fileExists in class WatchInterface

Parameters:

fileId - Id of the file to check

Returns:

True if the file exists or false if not or something

readFile

public boolean readFile(UsbFile file)

This method reads the file with file ID defined in the file instance passed from the watch

Specified by:

readFile in class WatchInterface

Parameters:

file - File defining the file ID. The file data is read into this file instance

Returns:

The file or null if an error occurred

writeFile

public boolean writeFile(UsbFile file)

Write file to the watch. The file (ID and data) is defined in the UsbFile passed

Specified by:

writeFile in class WatchInterface

Parameters:

file - The file to write

Returns:

True if succeeded, false if not

deleteFile

public boolean deleteFile(UsbFile file)

Deletes the file on the watch indicated by the ID in the file passed. En passant the file data in the file is also deleted

Specified by:

deleteFile in class WatchInterface

Parameters:

file - File defining the file ID to delete

Returns:

True if an error cccurred, false if not

getFileList

public ArrayList<UsbFile> getFileList(WatchInterface.FileType fileType)

This method requests the list of file of given type

Specified by:

getFileList in class WatchInterface

Parameters:

fileType - The type of files to request

Returns:

The file list or null if something went wrong

getWatchTime

public hirondelle.date4j.DateTime getWatchTime()

This method retrieves the time from the watch.

Specified by:

getWatchTime in class WatchInterface

Returns:

The DateTime that represents the watch time in UTC. Or null if an error occurred.

readBleVersion

public String readBleVersion()

This method returns the BLE version

Specified by:

readBleVersion in class WatchInterface

Returns:

The version as string

readFirmwareVersion

public String readFirmwareVersion()

This method returns the firmware version

Specified by:

readFirmwareVersion in class WatchInterface

Returns:

The version as string, or null if an error occurred

getProductId

public int getProductId()

This method returns the firmware version

Specified by:

getProductId in class WatchInterface

Returns:

The version as string, or null if an error occurred

getDeviceSerialNumber

public String getDeviceSerialNumber()

Returns the serial number of the device. BECAUSE OF AN ERROR IN USB4JAVA THIS METHOD DOES NOT WORK

Specified by:

getDeviceSerialNumber in class WatchInterface

Returns:

String containing the serial number

resetDevice

public boolean resetDevice()

Execute device reset

Overrides:

resetDevice in class WatchInterface

Returns:

False if all went OK, true if an error occurred.

resetGpsProcessor

public boolean resetGpsProcessor()

Resets the GPS processor

Overrides:

resetGpsProcessor in class WatchInterface

Returns:

False if all went OK, true if an error occurred.

formatDevice

public boolean formatDevice()

This method formats the device

Overrides:

formatDevice in class WatchInterface

Returns:

False if all went OK, true if an error occurred.