Symbian3/PDK/Source/GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1.dita
author Dominic Pinkman <dominic.pinkman@nokia.com>
Fri, 16 Jul 2010 17:23:46 +0100
changeset 12 80ef3a206772
permissions -rw-r--r--
Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
12
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
     1
<?xml version="1.0" encoding="utf-8"?>
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
     2
<!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
     3
<!-- This component and the accompanying materials are made available under the terms of the License 
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
     4
"Eclipse Public License v1.0" which accompanies this distribution, 
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
     5
and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
     6
<!-- Initial Contributors:
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
     7
    Nokia Corporation - initial contribution.
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
     8
Contributors: 
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
     9
-->
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    10
<!DOCTYPE concept
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    11
  PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    12
<concept xml:lang="en" id="GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1"><title>Positioning Plug-in Information API</title><prolog><metadata><keywords/></metadata></prolog><conbody><p>The Positioning Plug-in Information API defines Publish and Subscribe (P&amp;S) keys for publishing and receiving PSY settings. The API is intended for device creators who write their own PSYs. </p> <section><title>Contents</title> <ul><li id="GUID-F154C09E-9148-57F7-BC4E-5F69D7A2C1B0-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-2-2-1"><p><xref href="GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1.dita#GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1/GUID-54FAA4F6-F3D5-5876-A914-A598E6FF7EF7-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-3">Purpose</xref> </p> </li> <li id="GUID-E81C5D5C-2162-589C-8677-459CC1DE9BA4-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-2-2-2"><p><xref href="GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1.dita#GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1/GUID-D0101461-C24E-5477-83FC-A25AE8A62503-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-4">API description</xref>  </p> </li> <li id="GUID-EEBE4B98-3F9B-54D9-825C-E2C3ECC84091-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-2-2-3"><p><xref href="GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1.dita#GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1/GUID-3C0DF56B-A650-5FC6-99A4-7A2878280ED2-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-5">Using the Positioning Plug-in Information API</xref>  </p> <ul><li id="GUID-904EE33A-1C37-59D6-B0A7-828DCA3915B7-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-2-2-3-2-1"><p><xref href="GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1.dita#GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1/GUID-D73BEF29-7A57-5E11-A373-2437A03CFA78-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-5-4">Positioning Plug-in Information API published keys</xref>  </p> </li> <li id="GUID-CF4A5928-09C8-55F9-BAAA-384F00475899-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-2-2-3-2-2"><p><xref href="GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1.dita#GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1/GUID-4703C9C7-7909-5284-99C0-1D88070DA2F5-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-5-11">Extensions to the API</xref>  </p> </li> </ul> </li> <li id="GUID-408D16C8-A9F7-5C03-8A16-4D07187DA40B-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-2-2-4"><p><xref href="GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1.dita#GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1/GUID-5FEBB0E6-3E75-53B5-A416-7F9F687E0071-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-6">Glossary</xref> </p> <ul><li id="GUID-D44C1874-8F06-51BA-96F9-7446B402C9F2-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-2-2-4-2-1"><p><xref href="GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1.dita#GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1/GUID-DA92D821-DE5E-5324-8EE9-F31223ADB81F-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-6-2">Abbreviations</xref> </p> </li> <li id="GUID-4D514325-C143-5E2A-8E6A-8EA122E953DE-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-2-2-4-2-2"><p><xref href="GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1.dita#GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1/GUID-1D083A2D-FB50-5D24-A641-941B1657E64D-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-6-4">Definitions</xref> </p> </li> <li id="GUID-38A40B81-6066-53E4-973F-EE303CFC43C1-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-2-2-4-2-3"><p><xref href="GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1.dita#GUID-DA2DC704-CE65-54FB-9049-4E1C73092EDF-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1/GUID-31329496-57D1-5C17-B4F4-50125B8393A8-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-6-6">References</xref> </p> </li> </ul> </li> </ul> </section> <section id="GUID-54FAA4F6-F3D5-5876-A914-A598E6FF7EF7-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-3"><title>Purpose</title> <p>The Positioning Plug-in Information API defines Central Repository keys for publishing Positioning Plug-in (PSY) static capabilities and basic setup information related to the PSY. These keys published by the PSYs are used by Location Framework. This API is intended for developers who write their own positioning plug-ins. </p> <p>The licensee also needs to implement the <xref href="GUID-893737B2-4863-5BB9-8AA1-6AB5045FADC9.dita">Positioning Plug-in API</xref> to create a PSY. </p> </section> <section id="GUID-D0101461-C24E-5477-83FC-A25AE8A62503-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-4"><title>API Description</title> <p>The Positioning Plug-in Information API is a Central Repository interface for defining keys. It specifies the parameters associated with a positioning module. It does not define any classes but defines the keys that each Positioning Plug-in needs to declare. </p> <p>To use the Positioning Plug-in Information API, a developer must create a Central Repository file with the same UID as the PSY’s UID. This file must contain all the defined keys for the positioning plug-in. If the values for the keys are incorrect the Location Framework will ignore the plug-in and it will not be usable. If this file is to be backed up during a backup operation, the owner of this file should be set to <codeph>0x101f97b2</codeph>, which is the Location Server’s UID. </p> </section> <section id="GUID-3C0DF56B-A650-5FC6-99A4-7A2878280ED2-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-5"><title>Using the Positioning Plug-in Information API</title> <p>To implement a PSY, the developer must do the following: </p> <ol id="GUID-3BA28F3C-714C-573D-81E5-D87EDCE646CC-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-5-3"><li id="GUID-DA6F0E1A-A492-571B-AF52-5484526967D0-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-5-3-1"><p>Create a PSY by implementing the <xref href="GUID-893737B2-4863-5BB9-8AA1-6AB5045FADC9.dita">Positioning Plug-in API</xref>. </p> </li> <li id="GUID-8B9D5ED4-5C91-59FA-A931-A33D1A0FD88B-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-5-3-2"><p>Create a Central Repository file to publish PSY information according to the Positioning Plug-in Information API. </p> </li> <li id="GUID-A9605241-CFA4-56DA-90FF-968EFD785546-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-5-3-3"><p>Test the positioning module implementation using the <xref href="GUID-20D774EC-4993-55F5-979C-AF80A264F777.dita">PSY tester application</xref>. The PSY tester application tests whether a particular PSY implementation conforms to the Positioning Plug-in API and the Positioning Plug-in Information API specifications. </p> </li> </ol> <p id="GUID-D73BEF29-7A57-5E11-A373-2437A03CFA78-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-5-4"><b>Positioning Plug-in Information API published keys</b> </p> <p>Every Positioning Plug-in has its own repository identified with the implementation UID of the plug-in. This repository contains the predefined keys published by the Positioning Plug-in Information API. These keys include the properties of the positioning plug-in. The keys are defined in the <filepath>PositioningPluginFWInternalCRKeys.h</filepath> header file. </p> <table id="GUID-6749D3D1-3968-5792-B7D6-25C2A69ED891-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-5-6"><tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/><thead><row><entry>Central Repository key </entry> <entry>Description</entry> </row> </thead> <tbody><row><entry><p> <xref href="GUID-4C4DCA0A-E524-3383-8151-A68FF8DBF72F.dita"><apiname>KPSYInterfaceVersion</apiname></xref>  </p> </entry> <entry><p>The version of the Positioning Plug-in Information API interface. </p> </entry> </row> <row><entry><p> <xref href="GUID-9E477072-14CC-3247-B39C-909802A49EA9.dita"><apiname>KPSYPriority</apiname></xref>  </p> </entry> <entry><p>The Positioning plug-in priority set for the PSY on installation. </p> </entry> </row> <row><entry><p> <xref href="GUID-C64C26DB-52A1-36B0-B890-6E2879AE4938.dita"><apiname>KPSYStatus</apiname></xref>  </p> </entry> <entry><p>The Positioning plug-in status set for the PSY when installed to the system. </p> </entry> </row> <row><entry><p> <xref href="GUID-F0018CF3-8D7E-3E5C-8345-779EA09C514D.dita"><apiname>KPSYTimeToFirstFix</apiname></xref>  </p> </entry> <entry><p>The estimated time to the first fix from the positioning plug-in after a connection is established. It is defined as a double and should not be a negative number. The definition for time to the first fix can be found in the Location Acquisition API. </p> </entry> </row> <row><entry><p> <xref href="GUID-FA1D8202-F243-3271-BC24-0092BC803D3A.dita"><apiname>KPSYTimeToNextFix</apiname></xref>  </p> </entry> <entry><p>This should be a conservative estimate of the time between consecutive fixes once the plug-in has been loaded and started. It is defined as a double and should not be a negative number. The definition of the time to the next fix can be found in the Location Acquisition API. </p> </entry> </row> <row><entry><p> <xref href="GUID-7C18FF42-1D28-3C35-B950-80AFDEBCAEE8.dita"><apiname>KPSYHorizontalAccuracy</apiname></xref>  </p> </entry> <entry><p>This should be a conservative estimate of the expected horizontal accuracy and should be given in metres. The definition of horizontal accuracy can be found in the Location Acquisition API. </p> </entry> </row> <row><entry><p> <xref href="GUID-8F18F9EA-A90F-31BE-968C-C925D4428CBF.dita"><apiname>KPSYVerticalAccuracy</apiname></xref>  </p> </entry> <entry><p>This should be a conservative estimate of the expected vertical accuracy and should be given in metres. The definition of vertical accuracy can be found in the Location Acquisition API. </p> </entry> </row> <row><entry><p> <xref href="GUID-0D9A6DA8-0705-3511-8381-E46AAC50E5AB.dita"><apiname>KPSYCostIndicator</apiname></xref>  </p> </entry> <entry><p>The cost of using the positioning technology. The cost indicator takes one of the discrete values unknown, zero, possible or charge. There is no mapping to any fixed sum of money. The cost indicator is only a default value. The actual value can be changed by the user. The definition for possible cost indicator values can be found in the Location Acquisition API. </p> </entry> </row> <row><entry><p> <xref href="GUID-CC3515E5-4A2D-3371-A4BF-3197AABE7B6F.dita"><apiname>KPSYPowerConsumption</apiname></xref>  </p> </entry> <entry><p>The power consumption of the plug-in. Power consumption takes one of the discrete values unknown, zero, low, medium or high. There is no mapping to any fixed power. The definition for possible power consumption values can be found in the Location Acquisition API. </p> </entry> </row> <row><entry><p> <xref href="GUID-715DB9BF-8C60-39AA-A653-3C4FFC38B94D.dita"><apiname>KPSYTechnologyType</apiname></xref>  </p> </entry> <entry><p>The type of technology used to get the location. Specifies whether the positioning technology is terminal-based or network-based, or if it is using assistance data from the network. The definition for all available values for technology can be found in the Location Acquisition API. </p> </entry> </row> <row><entry><p> <xref href="GUID-85153FA6-F39E-3654-B69E-D5ED0466F194.dita"><apiname>KPSYDeviceLocation</apiname></xref>  </p> </entry> <entry><p>The positioning hardware deployment. Specifies whether the actual positioning hardware is internal or external to the phone. The definition for all available values for this device location can be found in the Location Acquisition API. </p> </entry> </row> <row><entry><p> <xref href="GUID-C3FD0558-0C69-3587-ABFD-61AFBC328A7B.dita"><apiname>KPSYCapabilities</apiname></xref>  </p> </entry> <entry><p>The positioning capabilities of the positioning plug-in. This is a bitmap specifying the PSY’s capabilities, for example whether the PSY is capable of handling vertical measurements, NMEA reading, addresses, compass information, building information. The definition for all available values for capabilities can be found in the Location Acquisition API. </p> </entry> </row> <row><entry><p> <xref href="GUID-8B42A620-635D-34A6-B8D4-FA0BC33CDE4B.dita"><apiname>KPSYClassesSupported</apiname></xref>  </p> </entry> <entry><p>The supported Location Framework position data classes. This is a bitmap specifying which <codeph>TPositionInfoBase</codeph> classes can be handled by the PSY. A PSY must always support at least <codeph>TPositionInfo</codeph>. The definition for all available values for supported classes can be found in the Location Acquisition API. </p> </entry> </row> <row><entry><p> <xref href="GUID-9449A2EB-85B5-3221-9D12-A543BFD8CE3A.dita"><apiname>KPSYVisibility</apiname></xref>  </p> </entry> <entry><p>This key specifies whether the plug-in is visible to Location Framework. </p> </entry> </row> <row><entry><p> <xref href="GUID-A6348C78-825B-3CD5-A0B3-12885F9CCCB8.dita"><apiname>KPSYNameResource</apiname></xref>  </p> </entry> <entry><p>This key specifies the name for the resource file that contains the localised text for the PSY name. If the key does not exist or the resource file does not exist, the name mentioned in the ECOM implementation resource file is used as the PSY name. </p> </entry> </row> </tbody> </tgroup> </table> <p><b>Example</b> </p> <p>The Positioning Plug-in keys are specified as part of a Central Repository file. The example below is a typical Central Repository file created for a PSY. </p> <codeblock id="GUID-B570C267-A981-571D-9FE7-6D21D4148AAE-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-5-9" xml:space="preserve">/* The Header of the central repository text file */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    13
cenrep
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    14
/* Version of central repository */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    15
version 1
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    16
[owner]
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    17
/* The owner for this central repository file, which is Location Server */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    18
0x101f97b2
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    19
[defaultmeta]
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    20
/* Central Repository related headers */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    21
 0
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    22
[platsec]
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    23
/* Capability required to access(read / write) these central repository keys */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    24
cap_rd=ReadDeviceData cap_wr=WriteDeviceData
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    25
[Main]
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    26
/* 
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    27
 * The keys defined by the Positioning Plug-in Information API interface.
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    28
 * These key values are read by Location Server using Central Repository.
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    29
 */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    30
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    31
/* version 1 of the Positioning plug-in Information API. */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    32
0x1 int 1 16777216 cap_rd=ReadDeviceData cap_wr=alwaysfail
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    33
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    34
/* 
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    35
 * PSY Priority 0 which means that Location Server will decide the priority
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    36
 * of the PSY. 
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    37
 */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    38
0x2 int 0 16777216 cap_rd=ReadDeviceData cap_wr=alwaysfail
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    39
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    40
/* 
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    41
 * The PSY is available when it is installed in the system.
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    42
 * The availability can be changed later through the Location UI.
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    43
 */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    44
0x3 int 1 16777216 cap_rd=ReadDeviceData cap_wr=alwaysfail
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    45
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    46
/* 
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    47
 * The estimated time to obtain the initial location fix 80000000 microseconds
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    48
 * i.e. 80 seconds.
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    49
 */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    50
0x4 int 80000000 16777216 cap_rd=ReadDeviceData cap_wr=alwaysfail
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    51
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    52
/* 
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    53
 * The estimated time to obtain a fix knowing the current position is 1000000 microseconds
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    54
 * i.e. 1 second.  
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    55
 */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    56
0x5 int 1000000 16777216 cap_rd=ReadDeviceData cap_wr=alwaysfail
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    57
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    58
/* 
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    59
 * The estimated error for the latitude and longitude 
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    60
 * components of a position determined by this PSY is 10 metres.
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    61
 */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    62
0x6 real 10 16777216 cap_rd=ReadDeviceData cap_wr=alwaysfail
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    63
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    64
/* 
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    65
 * The estimated error for the altitude components of
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    66
 * a position determined by this PSY is 30 metres.  
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    67
 */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    68
0x7 real 30 16777216 cap_rd=ReadDeviceData cap_wr=alwaysfail
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    69
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    70
/*
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    71
 * The user will not incur any charge when using this PSY 
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    72
 * to make a position determination.
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    73
 */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    74
0x8 int 1 16777216 cap_rd=ReadDeviceData cap_wr=alwaysfail
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    75
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    76
/*
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    77
 * This PSY will consume a resonable amount of battery power when
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    78
 * used for position determination.
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    79
 */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    80
0x9 int 3 16777216 cap_rd=ReadDeviceData cap_wr=alwaysfail
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    81
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    82
/*
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    83
 * The PSY uses a positioning techonology that works stand-alone
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    84
 * on the terminal.
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    85
 */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    86
0xa int 1 16777216 cap_rd=ReadDeviceData cap_wr=alwaysfail
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    87
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    88
/*
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    89
 * The PSY uses a technology external to the terminal.
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    90
 */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    91
0xb int 2 16777216 cap_rd=ReadDeviceData cap_wr=alwaysfail
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    92
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    93
/*
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    94
 * The PSY is capable of returning information about
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    95
 * latitude, longitude, speed, address and satellite.
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    96
 */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    97
0xc int 95 16777216 cap_rd=ReadDeviceData cap_wr=alwaysfail
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    98
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
    99
/*
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
   100
 * This PSY is capable of returning location information
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
   101
 * through all position information data classes namely
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
   102
 * TPositionInfo, TPositionCourseInfo, TPositionSatelliteInfo 
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
   103
 * and HGenericPositionInfo.
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
   104
 */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
   105
0xd int 15 16777216 cap_rd=ReadDeviceData cap_wr=alwaysfail
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
   106
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
   107
/*
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
   108
 * This PSY is visible to the user through the Location UI.
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
   109
 */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
   110
0xe int 1 16777216 cap_rd=ReadDeviceData cap_wr=alwaysfail
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
   111
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
   112
/*
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
   113
 * The localised PSY name is specified in psylocalised_name.rsc
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
   114
 * resource file.
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
   115
 */
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents:
diff changeset
   116
0xf string "\\resource\\psylocalised_name.rsc" 16777216 cap_rd=ReadDeviceData cap_wr=alwaysfail</codeblock> <p> </p> <p id="GUID-4703C9C7-7909-5284-99C0-1D88070DA2F5-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-5-11"><b> Extensions to the API</b> </p> <p><b>PSY-specific settings</b> </p> <p>Any PSY-specific settings can be implemented as part of the same Central Repository file as the PSY common settings. In this case, the PSY must publish a header for the PSY-specific settings. The header must contain the Central Repository UID value and the key values for the PSY-specific settings. </p> <p>The PSY-specific settings key are bound by the following constraints: </p> <ul><li id="GUID-E4DAE7D2-6876-5118-8934-D5A5CD53898A-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-5-15-1"><p>IDs should start from the value 0x10000000. The values from 0x0000000F to 0x0FFFFFFF are reserved for expansion of the Positioning Plug-in Information API. </p> </li> <li id="GUID-77C92F57-11A5-5034-B9EF-34867652E239-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-5-15-2"><p>The required capabilities for the keys should be: </p> <ul><li id="GUID-3B274CAE-FFC2-5F56-AC40-02DA90947273-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-5-15-2-2-1"><p> <codeph>ReadDeviceData</codeph> for reading the key values </p> </li> <li id="GUID-42C90200-E32C-5523-AD7C-EF0AF5900FE1-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-5-15-2-2-2"><p> <codeph>WriteDeviceData</codeph> for writing the key values </p> </li> </ul> </li> </ul> <p>Alternatively the PSY can implement these settings through any other mechanism such as database or file stores. </p> <p>An example of PSY-specific settings are those of the <xref href="GUID-5454AFE9-ADC2-5980-85FC-3FF457B638D0.dita">Bluetooth PSY Settings</xref>. </p> <p><b>PSY-specific Configuration UI</b> </p> <p>The PSY can implement a configuration UI for reading and setting the PSY-specific settings keys. Creating a configuration UI for a PSY is a licensee-specific task as it uses platform-dependent UI framework. </p> </section> <section id="GUID-5FEBB0E6-3E75-53B5-A416-7F9F687E0071-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-6"><title>Glossary</title> <p id="GUID-DA92D821-DE5E-5324-8EE9-F31223ADB81F-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-6-2"><b>Abbreviations</b> </p> <table id="GUID-DE49F7C2-022A-5AF0-9AB5-95DE75A5DDD7-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-6-3"><tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/><thead><row><entry>Abbreviation</entry> <entry>Description</entry> </row> </thead> <tbody><row><entry><p>API </p> </entry> <entry><p>Application Programming Interface </p> </entry> </row> <row><entry><p>LBS </p> </entry> <entry><p>Location Based Services </p> </entry> </row> <row><entry><p>PSY </p> </entry> <entry><p>Positioning Technology Plug-in </p> </entry> </row> <row><entry><p>SDK </p> </entry> <entry><p>Software Development Kit </p> </entry> </row> <row><entry><p>UML </p> </entry> <entry><p>Unified Modeling Language </p> </entry> </row> </tbody> </tgroup> </table> <p id="GUID-1D083A2D-FB50-5D24-A641-941B1657E64D-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-6-4"><b>Definitions</b> </p> <table id="GUID-714F83DA-5D51-51E9-B49D-64152B46C1E4-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-6-5"><tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/><thead><row><entry>Term</entry> <entry>Description</entry> </row> </thead> <tbody><row><entry><p>ECom </p> </entry> <entry><p>A system support that allows the loading of interface implementations. </p> </entry> </row> <row><entry><p>Location Framework </p> </entry> <entry><p>A framework for enabling location based services in Symbian. </p> </entry> </row> <row><entry><p>UID </p> </entry> <entry><p>Unique Identifier number in Symbian. </p> </entry> </row> </tbody> </tgroup> </table> <p id="GUID-31329496-57D1-5C17-B4F4-50125B8393A8-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-6-6"><b>References</b> </p> <ul><li id="GUID-52C60F11-55B4-5637-8E3C-AAF7A9A1566F-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-6-7-1"><p><xref href="GUID-D0318BB6-0B9F-5A1C-AB0B-61BA22D28661.dita"> Location Acquisition API</xref>  </p> </li> <li id="GUID-3A1C16EA-0D2A-5C19-9F98-DFEF3E3C4D33-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-6-7-2"><p><xref href="GUID-893737B2-4863-5BB9-8AA1-6AB5045FADC9.dita">Positioning Plug-in API</xref>  </p> </li> <li id="GUID-A2F35F6B-A97E-5011-B76B-899F46F09552-GENID-1-12-1-19-1-1-10-1-5-1-5-1-8-1-2-6-7-3"><p><xref href="GUID-20D774EC-4993-55F5-979C-AF80A264F777.dita">PSY Tester User’s Guide</xref>  </p> </li> </ul> </section> </conbody></concept>