WatchInterface (TomTomWatch 1.15 API)

java.lang.Object
- net.studioblueplanet.usb.WatchInterface

Direct Known Subclasses:

UsbInterface, UsbTestInterface
```
public abstract class WatchInterface
extends Object
```
This abstract class defines the interface to the watch. It defines the file handling methods as well as the file definitions. A number of generic methods have been filled in, a number of specific methods need to be overridden in child classes

Author:

Jorgen

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class WatchInterface.FileType
This enum defines the file type.

Nested Classes
Modifier and Type	Class and Description
`static class`	`WatchInterface.FileType` This enum defines the file type.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FILEID_BLE_FIRMWARE`
`static int`	`FILEID_BLE_UPDATE_LOG`
`static int`	`FILEID_GPS_FIRMWARE`
`static int`	`FILEID_GPSQUICKFIX_DATA`
`static int`	`FILEID_INVALID`
`static int`	`FILEID_LOG`
`static int`	`FILEID_MANIFEST1`
`static int`	`FILEID_MANIFEST2`
`static int`	`FILEID_PLAYLIST`
`static int`	`FILEID_PREFERENCES_XML`
`static int`	`FILEID_SYSTEM_FIRMWARE`
`static int`	`FILEID_UPDATE_LOG`
`protected ArrayList<UsbFile>`	`fileList`
`protected ProgressListener`	`listener`
`protected UsbFile`	`preferenceFile` The preference file of the watch
`static int`	`PRODUCTID_UNKNOWN`
`protected static int`	`TTWATCH_FILE_TYPE_MASK`

Constructor Summary

Constructors
Modifier Constructor and Description

protected WatchInterface()
Constructor

Constructors
Modifier	Constructor and Description
`protected`	`WatchInterface()` Constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`closeConnection()` Closes the USB connection
`abstract boolean`	`deleteFile(UsbFile file)` Deletes the file on the watch indicated by the ID in the file passed.
`abstract boolean`	`fileExists(int fileId)` This method checks if a file exists
`boolean`	`formatDevice()` This method formats the device
`abstract String`	`getDeviceSerialNumber()` Returns the serial number of the device.
`abstract ArrayList<UsbFile>`	`getFileList(WatchInterface.FileType fileType)` This method requests the list of file of given type
`String`	`getPreference(String tag)` This method returns the preference from the watch XML preference file indicated by the tag.
`abstract int`	`getProductId()` This method returns the firmware version
`abstract hirondelle.date4j.DateTime`	`getWatchTime()` This method retrieves the time from the watch.
`boolean`	`isFileType(UsbFile file, WatchInterface.FileType type)` THis method evaluates the file and indicates whether it is a file of indicated file type
`boolean`	`openConnection()` Opens the USB connection
`abstract String`	`readBleVersion()` This method returns the BLE (Bluetooth Low Energy) version
`abstract boolean`	`readFile(UsbFile file)` This method reads the file with file ID defined in the file instance passed from the watch
`abstract String`	`readFirmwareVersion()` This method returns the firmware version
`UsbFile`	`readPreferences()` This method reads and returns the preferences from the watch.
`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`	`setPreference(String tag, String value)` Write a preference in the preference file to the watch
`void`	`setProgressListener(ProgressListener listener)` This method sets the progress listener for file reading and writing.
`abstract boolean`	`writeFile(UsbFile file)` Write file to the watch.
`boolean`	`writeGpxQuickFixFile(byte[] quickFixFile)` Write the GPS Quickfix file
`boolean`	`writePreferences()` Write the preference file to the watch.
`boolean`	`writeVerifyFile(UsbFile file)` This method writes the file, reads it back and verifies it

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FILEID_BLE_FIRMWARE
```
public static final int FILEID_BLE_FIRMWARE
```
    See Also:
    
    Constant Field Values
  - FILEID_SYSTEM_FIRMWARE
```
public static final int FILEID_SYSTEM_FIRMWARE
```
    See Also:
    
    Constant Field Values
  - FILEID_GPSQUICKFIX_DATA
```
public static final int FILEID_GPSQUICKFIX_DATA
```
    See Also:
    
    Constant Field Values
  - FILEID_GPS_FIRMWARE
```
public static final int FILEID_GPS_FIRMWARE
```
    See Also:
    
    Constant Field Values
  - FILEID_BLE_UPDATE_LOG
```
public static final int FILEID_BLE_UPDATE_LOG
```
    See Also:
    
    Constant Field Values
  - FILEID_UPDATE_LOG
```
public static final int FILEID_UPDATE_LOG
```
    See Also:
    
    Constant Field Values
  - FILEID_LOG
```
public static final int FILEID_LOG
```
    See Also:
    
    Constant Field Values
  - FILEID_MANIFEST1
```
public static final int FILEID_MANIFEST1
```
    See Also:
    
    Constant Field Values
  - FILEID_MANIFEST2
```
public static final int FILEID_MANIFEST2
```
    See Also:
    
    Constant Field Values
  - FILEID_PLAYLIST
```
public static final int FILEID_PLAYLIST
```
    See Also:
    
    Constant Field Values
  - FILEID_PREFERENCES_XML
```
public static final int FILEID_PREFERENCES_XML
```
    See Also:
    
    Constant Field Values
  - FILEID_INVALID
```
public static final int FILEID_INVALID
```
    See Also:
    
    Constant Field Values
  - PRODUCTID_UNKNOWN
```
public static final int PRODUCTID_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - TTWATCH_FILE_TYPE_MASK
```
protected static final int TTWATCH_FILE_TYPE_MASK
```
    See Also:
    
    Constant Field Values
  - fileList
```
protected final ArrayList<UsbFile> fileList
```
  - listener
```
protected ProgressListener listener
```
  - preferenceFile
```
protected UsbFile preferenceFile
```
    The preference file of the watch
- Constructor Detail
  - WatchInterface
```
protected WatchInterface()
```
    Constructor
- Method Detail
  - openConnection
```
public boolean openConnection()
```
    Opens the USB connection
    
    Returns:
    
    True if an error occurred, false if the connection successfully opened
  - closeConnection
```
public void closeConnection()
```
    Closes the USB connection
  - sendStartupSequence
```
public boolean sendStartupSequence()
```
    According to ttwatch (Ryan Binns) this is the sequence that should be called after opening the watch connection
    
    Returns:
    
    True if an error occurred, false if successful
  - sendMessageGroup1
```
public boolean sendMessageGroup1()
```
    Another message sequence reported by ttwatch
    
    Returns:
    
    True if an error occurred, false if successful
  - setProgressListener
```
public void setProgressListener(ProgressListener listener)
```
    This method sets the progress listener for file reading and writing. Set to null if not used. Progress is reported to the listerner.
    
    Parameters:
    
    listener - The listener
  - fileExists
```
public abstract boolean fileExists(int fileId)
```
    This method checks if a file exists
    
    Parameters:
    
    fileId - Id of the file to check
    
    Returns:
    
    True if the file exists or false if not or something
  - readFile
```
public abstract boolean readFile(UsbFile file)
```
    This method reads the file with file ID defined in the file instance passed from the watch
    
    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 abstract boolean writeFile(UsbFile file)
```
    Write file to the watch. The file (ID and data) is defined in the UsbFile passed
    
    Parameters:
    
    file - The file to write
    
    Returns:
    
    True if succeeded, false if not
  - writeVerifyFile
```
public boolean writeVerifyFile(UsbFile file)
```
    This method writes the file, reads it back and verifies it
    
    Parameters:
    
    file - The file to write
    
    Returns:
    
    False if the file was correctly written, false if an error occurred or the verification failed.
  - writeGpxQuickFixFile
```
public boolean writeGpxQuickFixFile(byte[] quickFixFile)
```
    Write the GPS Quickfix file
    
    Parameters:
    
    quickFixFile - The quick fix file data
    
    Returns:
    
    True if an error occurred, false if succeeded.
  - deleteFile
```
public abstract 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
    
    Parameters:
    
    file - File defining the file ID to delete
    
    Returns:
    
    True if an error cccurred, false if not
  - getFileList
```
public abstract ArrayList<UsbFile> getFileList(WatchInterface.FileType fileType)
```
    This method requests the list of file of given type
    
    Parameters:
    
    fileType - The type of files to request
    
    Returns:
    
    The file list or null if something went wrong
  - getWatchTime
```
public abstract hirondelle.date4j.DateTime getWatchTime()
```
    This method retrieves the time from the watch.
    
    Returns:
    
    The DateTime that represents the watch time in UTC. Or null if an error occurred.
  - readPreferences
```
public UsbFile readPreferences()
```
    This method reads and returns the preferences from the watch. The XML data is encoded in the UsbFile.fileData;
    
    Returns:
    
    The preference file or null if an error occurred
  - writePreferences
```
public boolean writePreferences()
```
    Write the preference file to the watch.
    
    Returns:
    
    True if an error occurred, false if ok
  - getPreference
```
public String getPreference(String tag)
```
    This method returns the preference from the watch XML preference file indicated by the tag. Quick and dirty XML parsing :-)
    
    Parameters:
    
    tag - Tag in the XML file, without the braces
    
    Returns:
    
    The preference value as string or null if not found
  - setPreference
```
public boolean setPreference(String tag,
                             String value)
```
    Write a preference in the preference file to the watch
    
    Parameters:
    
    tag - Tag of the preference
    
    value - Value of the preference
    
    Returns:
    
    False if all went ok, true if an error occurred.
  - readBleVersion
```
public abstract String readBleVersion()
```
    This method returns the BLE (Bluetooth Low Energy) version
    
    Returns:
    
    The version as string
  - readFirmwareVersion
```
public abstract String readFirmwareVersion()
```
    This method returns the firmware version
    
    Returns:
    
    The version as string, or null if an error occurred
  - getProductId
```
public abstract int getProductId()
```
    This method returns the firmware version
    
    Returns:
    
    The version as string, or null if an error occurred
  - getDeviceSerialNumber
```
public abstract String getDeviceSerialNumber()
```
    Returns the serial number of the device. BECAUSE OF AN ERROR IN USB4JAVA THIS METHOD DOES NOT WORK
    
    Returns:
    
    String containing the serial number
  - isFileType
```
public boolean isFileType(UsbFile file,
                          WatchInterface.FileType type)
```
    THis method evaluates the file and indicates whether it is a file of indicated file type
    
    Parameters:
    
    file - File to evaluate
    
    type - Type to check against
    
    Returns:
    
    True if the file is of indicated type
  - resetDevice
```
public boolean resetDevice()
```
    Execute device reset
    
    Returns:
    
    False if all went OK, true if an error occurred.
  - resetGpsProcessor
```
public boolean resetGpsProcessor()
```
    Resets the GPS processor
    
    Returns:
    
    False if all went OK, true if an error occurred.
  - formatDevice
```
public boolean formatDevice()
```
    This method formats the device
    
    Returns:
    
    False if all went OK, true if an error occurred.

Class WatchInterface

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FILEID_BLE_FIRMWARE

FILEID_SYSTEM_FIRMWARE

FILEID_GPSQUICKFIX_DATA

FILEID_GPS_FIRMWARE

FILEID_BLE_UPDATE_LOG

FILEID_UPDATE_LOG

FILEID_LOG

FILEID_MANIFEST1

FILEID_MANIFEST2

FILEID_PLAYLIST

FILEID_PREFERENCES_XML

FILEID_INVALID

PRODUCTID_UNKNOWN

TTWATCH_FILE_TYPE_MASK

fileList

listener

preferenceFile

Constructor Detail

WatchInterface

Method Detail

openConnection

closeConnection

sendStartupSequence

sendMessageGroup1

setProgressListener

fileExists

readFile

writeFile

writeVerifyFile

writeGpxQuickFixFile

deleteFile

getFileList

getWatchTime

readPreferences

writePreferences

getPreference

setPreference

readBleVersion

readFirmwareVersion

getProductId

getDeviceSerialNumber

isFileType

resetDevice

resetGpsProcessor

formatDevice