summaryrefslogtreecommitdiff
path: root/enhanced-position-service/api/genivi-positioning-configuration.xml
blob: 0de89476a70f4fe0cf7f6afdb1cce199471b9f8b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<?xml-stylesheet type="text/xsl" href="introspect.xsl"?>

<!-- SPDX-License-Identifier: MPL-2.0
     Component Name: EnhancedPositionService
     Compliance Level: Abstract Component
     Copyright (C) 2012, BMW Car IT GmbH, Continental Automotive GmbH, PCA Peugeot Citroën, XS Embedded GmbH
     License:
     This Source Code Form is subject to the terms of the
     Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with
     this file, You can obtain one at http://mozilla.org/MPL/2.0/.
-->

<node name="/org/genivi/positioning/Configuration" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="introspect.xsd">

  <interface name="org.genivi.positioning.Configuration">
    <version>3.0.0 (10-Dec-2014)</version>
    <doc>
      <line>Configuration = This interface allows a client application to set and retrieve configuration options</line>
    </doc>
   
    <method name="GetVersion">
      <doc>
        <line>GetVersion = This method returns the API version implemented by the server application.</line>
      </doc>
      <arg name="version" type="(qqqs)" direction="out">
        <doc>
          <line>version = struct(major,minor,micro,date)</line>
          <line>major = when the major changes, then backward compatibility with previous releases is not granted</line>
          <line>minor = when the minor changes, then backward compatibility with previous releases is granted, but something changed in the implementation of the API (e.g. new methods may have been added)</line> 
          <line>micro = when the micro changes, then backward compatibility with previous releases is granted (bug fixes or documentation modifications)</line> 
          <line>date = release date (e.g. 21-06-2011)</line>
        </doc>
      </arg>
    </method>

    <method name="GetProperties">
      <doc>
        <line>GetProperties = This method returns all global system properties.</line>
      </doc>
      <arg name="properties" type="a{sv}" direction="out" />
    </method>

    <method name="SetProperty">
      <doc>
        <line>SetProperty = This method changes the value of the specified property</line>
        <line>Only properties that are listed as read-write are changeable</line>
        <line>On success a PropertyChanged signal will be emitted</line>
      </doc>
      <arg name="name" type="s" direction="in">
        <doc>
          <line>name = property name</line>
        </doc>
      </arg>
      <arg name="value" type="v" direction="in">
        <doc>
          <line>value = property value</line>
        </doc>
      </arg>
      <error name="org.genivi.positioning.Configuration.Error.InvalidProperty" />
    </method>

    <signal name="PropertyChanged">
      <doc>
        <line>PropertyChanged = This signal is emitted when a property changes</line>
      </doc>
      <arg name="name" type="s">
        <doc>
          <line>name = property name</line>
        </doc>
      </arg>
      <arg name="value" type="v">
        <doc>
          <line>value = property value</line>
        </doc>
      </arg>
    </signal>

    <property name="SatelliteSystem" type="q" access="readwrite">
      <doc>
        <line>SatelliteSystem = enum(INVALID,GPS,GLONASS,GALILEO,COMPASS, ... )</line>
      </doc>
    </property>

    <property name="UpdateInterval" type="i" access="readwrite">
      <doc>
        <line>UpdateInterval = update interval in ms</line>
      </doc>
    </property>

    <method name="GetSupportedProperties">
      <doc>
        <line>GetSupportedProperties = This method returns all suppported global system properties</line>
      </doc>
      <arg name="properties" type="a{sv}" direction="out">
        <doc>
          <line>properties = array[property]</line>
          <line>property = dictionary[key,value]</line>
          <line>key = enum(SatelliteSystem,UpdateInterval, ... )</line>
          <line>key = SatelliteSystem, value = value of type 'aq'; 'q' is an enum(INVALID,GPS,GLONASS,GALILEO,COMPASS, ...)</line>
          <line>key = UpdateInterval, value = value of type 'ai'; 'i' is the update interval in ms</line>
        </doc>
      </arg>
    </method>

  </interface>

</node>