Bluetooth GPS PSY Configuration API Overview

Purpose

A developer can use the Bluetooth GPS PSY Configuration API to write an application to manage a list of Bluetooth GPS devices. The list of devices is in order of preference. When GPS position information is required, the Bluetooth GPS PSY reads the list and attempts to connect to the first device address listed. If the connection is unsuccessful, then the Bluetooth GPS PSY tries each device in the list, in the order in which they are specified, until a connection is made. If the end of the list is reached, the Bluetooth GPS PSY requests for another device (not on the list) to be selected via the client application.

The Bluetooth GPS PSY Configuration API stores the list in its own repository.

Library details

The DLL that provides the functionality and the library to which your code must link is identified below.

DLL LIB Short description

lbsbtgpsconfig.dll

lbsbtgpsconfig.lib

The Configuration API for the Bluetooth GPS PSY.

Architecture

The following diagram shows the Bluetooth GPS PSY Configuration API class structure:

Figure 1. Bluetooth GPS PSY Configuration API Class Diagram -

Description

The Bluetooth GPS PSY Configuration API provides the following types of functions:

Querying

The following functions return information about the preferred list:

CLbsBtGpsConfig::GetDeviceListL(RPointerArray<TLbsBtGpsDeviceInfo>&) - returns the list of devices.
CLbsBtGpsConfig::GetDeviceCount(TInt&) - returns the number of devices in the list.

Configuring

The following functions enable the preferred list to be configured:

CLbsBtGpsConfig::AddDevice(const TBTDevAddr&, TInt, +

Description

The Bluetooth GPS PSY Configuration API provides the following types of functions:

Querying

The following functions return information about the preferred list:

CLbsBtGpsConfig::GetDeviceListL(RPointerArray<TLbsBtGpsDeviceInfo>&) - returns the list of devices.
CLbsBtGpsConfig::GetDeviceCount(TInt&) - returns the number of devices in the list.

Configuring

The following functions enable the preferred list to be configured:

CLbsBtGpsConfig::AddDevice(const TBTDevAddr&, TInt, TLbsBtGpsEntryKey&) - adds a new device to the list, at a specified position.
CLbsBtGpsConfig::ReorderDevice(TLbsBtGpsEntryKey, TInt) - moves a device to a new position in the list.
CLbsBtGpsConfig::RemoveDevice(TLbsBtGpsEntryKey) - removes a device from the list.
CLbsBtGpsConfig::EmptyDeviceList() - removes all of the devices from the list.

APIs

The key classes of Bluetooth GPS PSY Configuration API are as follows:

Class Name Description

CLbsBtGpsConfig

Enables client applications to manage the preferred list of Bluetooth GPS devices.

MLbsBtGpsConfigObserver

Observer class that client applications can implement to receive notifications about changes to the list.

Using the Bluetooth GPS PSY Configuration API

The following tutorials describe how to use the Bluetooth GPS PSY Configuration API:

Creating an Instance of the Bluetooth GPS PSY Configuration API
Adding a Device to the Start of the List
Moving a Device to a New Position in the List
Removing a Device from the List
Retrieving the List of Devices