summaryrefslogtreecommitdiff
path: root/src/components/policy/policy_table_interface.xml
blob: 6b671226ae3c8a75ba2a7a9a5078b5eb6a71600c (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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
<?xml version="1.0" standalone="no"?>
<?xml-stylesheet type="text/xml" href="protocol2html.xsl"?>

<interface name="policy table interface base" version="0.0"
    date="2014-01-23">

    <!-- Common parameters start -->
    <enum name="Priority">
        <element name="EMERGENCY" />
        <element name="NAVIGATION" />
        <element name="VOICECOM" />
        <element name="COMMUNICATION" />
        <element name="NORMAL" />
        <element name="NONE" />
    </enum>

    <enum name="HmiLevel">
        <element name="BACKGROUND" />
        <element name="FULL" />
        <element name="LIMITED" />
        <element name="NONE" />
    </enum>

    <enum name="Parameter">
        <element name="gps" />
        <element name="speed" />
        <element name="engineTorque" />
        <element name="externalTemperature" />
        <element name="fuelLevel" />
        <element name="fuelLevel_State" />
        <element name="headLampStatus" />
        <element name="instantFuelConsumption" />
        <element name="odometer" />
        <element name="tirePressure" />
        <element name="wiperStatus" />
        <element name="vin" />
        <element name="accPedalPosition" />
        <element name="beltStatus" />
        <element name="driverBraking" />
        <element name="prndl" />
        <element name="rpm" />
        <element name="steeringWheelAngle" />
        <element name="myKey" />
        <element name="airbagStatus" />
        <element name="bodyInformation" />
        <element name="clusterModeStatus" />
        <element name="deviceStatus" />
        <element name="emergencyEvent" />
        <element name="eCallInfo" />
    </enum>

    <enum name="AppHMIType">
        <element name="DEFAULT" />
        <element name="COMMUNICATION" />
        <element name="MEDIA" />
        <element name="MESSAGING" />
        <element name="NAVIGATION" />
        <element name="INFORMATION" />
        <element name="SOCIAL" />
        <element name="BACKGROUND_PROCESS" />
        <element name="TESTING" />
        <element name="SYSTEM" />
    </enum>
    <!-- Common parameters end -->

    <!-- app_policies section start -->

    <typedef name="Strings" type="String" maxlength="255" array="true"
        maxsize="255" />

    <typedef name="AppHMITypes" type="AppHMIType" array="true"
        maxsize="255" />

    <struct name="ApplicationParams">
        <param name="groups" type="Strings" />
        <param name="nicknames" type="Strings" mandatory="false" />
        <param name="AppHMIType" type="AppHMITypes" mandatory="false" />
        <param name="memory_kb" type="Integer" minvalue="1" maxvalue="65225" mandatory="false"/>
        <param name="watchdog_timer_ms" type="Integer" minvalue="1"
            maxvalue="65225" mandatory="false"/>
        <param name="certificate" type="String" minlength="0" maxlength="255"
            mandatory="false" />
    </struct>

    <typedef name="HmiLevels" type="HmiLevel" array="true"
        maxsize="4" />
    <typedef name="Parameters" type="Parameter" array="true"
        maxsize="24" />

    <struct name="RpcParameters">
        <!-- maxsizes are equal to number of currently known elements of
            given type -->
        <param name="hmi_levels" type="HmiLevels" />
        <param name="parameters" type="Parameters" mandatory="false" />
    </struct>

    <!-- maxsizes are equal to number of currently known elements of given
        type -->
    <typedef name="Rpc" type="RpcParameters" map="true" maxsize="50" />

    <struct name="Rpcs">
        <param name="user_consent_prompt" type="String" minlegth="1"
            maxlength="255" mandatory="false"/>
        <param name="rpcs" type="Rpc" null_values_allowed="true"/>
    </struct>
    <!-- app_policies section end -->

    <!-- module_config section start -->
    <!-- minlenght="10" since minimum expected is "http://a.b" -->
    <typedef name="URL" type="String" minlength="10" maxlength="255"
        array="true" minsize="1" maxsize="255" />

    <typedef name="URLList" type="URL" map="true" minsize="1"
        maxsize="255" />

    <!-- max number of services is limited to 255 according to protocol specification -->
    <typedef name="ServiceEndpoints" type="URLList" map="true"
        minsize="1" maxsize="255" />

    <typedef name="NumberOfNotificationsPerMinute" type="Integer"
        map="true" maxsize="6" minvalue="0" maxvalue="255" />

    <typedef name="SecondsBetweenRetries" type="Integer" array="true"
        maxsize="10" minvalue="1" maxvalue="1000" />

    <struct name="ModuleConfig">
        <param name="device_certificates" type="String" minlength="1" maxlength="100" mandatory="false" map="true" minsize="1" maxsize="255" />
        <param name="preloaded_pt" type="Boolean" mandatory="false" />
        <param name="exchange_after_x_ignition_cycles" type="Integer"
            maxvalue="255" />
        <param name="exchange_after_x_kilometers" type="Integer"
            maxvalue="4294967296" />
        <param name="exchange_after_x_days" type="Integer"
            maxvalue="255" />
        <param name="timeout_after_x_seconds" type="Integer"
            maxvalue="65535" />
        <param name="seconds_between_retries" type="SecondsBetweenRetries" />
        <param name="endpoints" type="ServiceEndpoints" />
        <param name="notifications_per_minute_by_priority" type="NumberOfNotificationsPerMinute" />
        <param name="vehicle_make" type="String" maxlength="100"
            mandatory="false" />
        <param name="vehicle_model" type="String" maxlength="100"
            mandatory="false" />
        <param name="vehicle_year" type="String" minlength="4" maxlength="4"
            mandatory="false" />
    </struct>
    <!-- module_config section end -->

    <!-- consumer_friendly_messages section start -->
    <struct name="MessageString">
        <param name="line1" type="String" maxlength="255"
            mandatory="false" />
        <param name="line2" type="String" maxlength="255"
            mandatory="false" />
        <param name="tts" type="String" maxlength="65535" mandatory="false" />
        <param name="label" type="String" maxlength="255"
            mandatory="false" />
        <param name="textBody" type="String" maxlength="500"
            mandatory="false" />
    </struct>

    <typedef name="Languages" map="true" type="MessageString"
        maxsize="500" mandatory="false" />

    <struct name="MessageLanguages">
        <param name="languages" type="Languages" />
    </struct>

    <typedef name="Messages" map="true" type="MessageLanguages"
        maxsize="255" />

    <struct name="ConsumerFriendlyMessages">
        <param name="version" type="String" maxlength="100" />
        <param name="messages" type="Messages" mandatory="false" />
    </struct>
    <!-- consumer_friendly_messages section end -->

    <!-- module_meta section start -->
    <struct name="ModuleMeta">
    </struct>
    <!-- module_meta section end -->

    <!-- usage_and_error_counts section start -->
    <struct name="AppLevel">
    </struct>

    <typedef name="AppLevels" type="AppLevel" map="true" maxsize="255" />

    <struct name="UsageAndErrorCounts">
        <param name="app_level" type="AppLevels" mandatory="false" />
    </struct>
    <!-- usage_and_error_counts section end -->

    <!-- device_data section start -->
    <struct name="DeviceParams">
    </struct>
    <!-- device_data section end -->

    <!-- policy_table section start -->
    <typedef name="ApplicationPolicies" map="true" type="ApplicationParams" null_values_allowed="true" minsize="1" maxsize="1000" />

    <typedef name="FunctionalGroupings" map="true" type="Rpcs"
        minsize="1" maxsize="255" />

    <typedef name="DeviceData" map="true" type="DeviceParams"
        maxsize="255" />

    <struct name="PolicyTable">
        <!-- maxsize for app_policies can be changed, if necessary -->
        <param name="app_policies" type="ApplicationPolicies" />
        <param name="functional_groupings" type="FunctionalGroupings" />
        <param name="consumer_friendly_messages" type="ConsumerFriendlyMessages" />
        <param name="module_config" type="ModuleConfig" />
        <param name="module_meta" type="ModuleMeta" mandatory="false"/>
        <param name="usage_and_error_counts" type="UsageAndErrorCounts" mandatory="false" />
        <param name="device_data" type="DeviceData" mandatory="false" />
    </struct>
    <!-- policy_table section end -->

    <!-- Root element -->
    <struct name="Table">
        <param name="policy_table" type="PolicyTable" />
    </struct>

</interface>