summaryrefslogtreecommitdiff
path: root/src/components/interfaces
diff options
context:
space:
mode:
authorAlexander Kutsan <AKutsan@luxoft.com>2016-03-24 10:45:41 +0200
committerAlexander <AKutsan@luxoft.com>2016-04-11 11:52:02 +0300
commit4439a2a9b1b5c78c08c712452fbca7ac5873ff76 (patch)
tree60339edd42c1459343ddf3286c01dd56ebc8ef16 /src/components/interfaces
parent9712f7b229481b3533d0a4d81f39cb3da71f5862 (diff)
downloadsdl_core-4439a2a9b1b5c78c08c712452fbca7ac5873ff76.tar.gz
Extend Send location RPC
Mobile and HMI interface changes Mobile API changes : New parameters "timeStamp" and "address" at SendLocation_request The "longtitudeDegrees" and "latitudeDegrees" made mandatory=false New struct "DateTime" New struct "OASISAddress" HMI_API changes: New resultCode "SAVED" New parameters "timeStamp" and "address" at SendLocation_request The "longtitudeDegrees" and "latitudeDegrees" made mandatory=false New struct "DateTime" New struct "OASISAddress" HMI_API changes: Relased Issue : [APPLINK-21338](https://adc.luxoft.com/jira/browse/APPLINK-21338) Implements CRQ: APPLINK-21336 SendLocation: SDL must support new "address" and "timeStamp" parameters API changed to double Add processing address and latitude in SendLocationRequest Add checking compabilities of address and latitude fields in SendLocationRequest Relased Issue : [APPLINK-APPLINK-23324](https://adc.luxoft.com/jira/browse/APPLINK-23324) Implements CRQ: APPLINK-23322 [GENIVI] SendLocation: SDL must support new "address" and "timeStamp" parameters APPLINK-23255 Cut Adress if it is empty APPLINK-23218 Add validation for all fields in address
Diffstat (limited to 'src/components/interfaces')
-rw-r--r--src/components/interfaces/HMI_API.xml78
-rw-r--r--src/components/interfaces/MOBILE_API.xml70
2 files changed, 141 insertions, 7 deletions
diff --git a/src/components/interfaces/HMI_API.xml b/src/components/interfaces/HMI_API.xml
index f16dc972dc..f20d0b0538 100644
--- a/src/components/interfaces/HMI_API.xml
+++ b/src/components/interfaces/HMI_API.xml
@@ -34,7 +34,7 @@
<interfaces name="SmartDeviceLink HMI API">
-<interface name="Common" version="1.1" date="2013-10-02">
+<interface name="Common" version="1.3" date="2016-03-20">
<enum name="Result">
<element name="SUCCESS" value="0"/>
@@ -62,6 +62,7 @@
<element name="GENERIC_ERROR" value="22"/>
<element name="USER_DISALLOWED" value="23"/>
<element name="TRUNCATED_DATA" value="24"/>
+ <element name="SAVED" value="25"/>
</enum>
<enum name="TransportType">
@@ -1656,9 +1657,9 @@
<!--IVI part-->
<struct name="GPSData">
<description>Struct with the GPS data.</description>
- <param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180" mandatory="false">
+ <param name="longitudeDegrees" type="Double" minvalue="-180" maxvalue="180" mandatory="false">
</param>
- <param name="latitudeDegrees" type="Float" minvalue="-90" maxvalue="90" mandatory="false">
+ <param name="latitudeDegrees" type="Double" minvalue="-90" maxvalue="90" mandatory="false">
</param>
<param name="utcYear" type="Integer" minvalue="2010" maxvalue="2100" mandatory="false">
<description>The current UTC year.</description>
@@ -1956,6 +1957,63 @@
</struct>
<!--end of IVI part-->
+<struct name="DateTime">
+ <param name="second" type="Integer" minvalue="0" maxvalue="60" mandatory="true">
+ <description>Seconds part of time</description>
+ </param>
+ <param name="minute" type="Integer" minvalue="0" maxvalue="59" mandatory="true">
+ <description>Minutes part of time</description>
+ </param>
+ <param name="hour" type="Integer" minvalue="0" maxvalue="23" mandatory="true">
+ <description>Hours part of time. Note that this structure accepts time only in 24 Hr format</description>
+ </param>
+ <param name="day" type="Integer" minvalue="1" maxvalue="31" mandatory="true">
+ <description>Day of the month</description>
+ </param>
+ <param name="month" type="Integer" minvalue="1" maxvalue="12" mandatory="true">
+ <description>Month of the year</description>
+ </param>
+ <param name="year" type="Integer" maxvalue="4095" mandatory="true">
+ <description>The year in YYYY format</description>
+ </param>
+ <param name="tz_hour" type="Integer" minvalue="-12" maxvalue="14" defvalue="0" mandatory="true">
+ <description>Time zone offset in Hours wrt UTC.</description>
+ </param>
+ <param name="tz_minute" type="Integer" minvalue="0" maxvalue="59" defvalue="0" mandatory="true">
+ <description>Time zone offset in Min wrt UTC.</description>
+ </param>
+ </struct>
+
+<struct name="OASISAddress">
+ <param name="countryName" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Name of the country (localized)</description>
+ </param>
+ <param name="countryCode" minlength="0" maxlength="50" type="String" mandatory="false">
+ <description>Name of country (ISO 3166-2)</description>
+ </param>
+ <param name="postalCode" minlength="0" maxlength="16" type="String" mandatory="false">
+ <description>(PLZ, ZIP, PIN, CAP etc.)</description>
+ </param>
+ <param name="administrativeArea" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Portion of country (e.g. state)</description>
+ </param>
+ <param name="subAdministrativeArea" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Portion of e.g. state (e.g. county)</description>
+ </param>
+ <param name="locality" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Hypernym for e.g. city/village</description>
+ </param>
+ <param name="subLocality" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Hypernym for e.g. district</description>
+ </param>
+ <param name="thoroughfare" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Hypernym for street, road etc.</description>
+ </param>
+ <param name="subThoroughfare" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Portion of thoroughfare e.g. house number</description>
+ </param>
+</struct>
+
</interface>
<interface name="Buttons" version="1.0" date="2013-04-12">
@@ -3152,9 +3210,9 @@
<param name="appID" type="Integer" mandatory="true">
<description>ID of application related to this RPC.</description>
</param>
- <param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180" mandatory="true">
+ <param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180" mandatory="false">
</param>
- <param name="latitudeDegrees" type="Float" minvalue="-90" maxvalue="90" mandatory="true">
+ <param name="latitudeDegrees" type="Float" minvalue="-90" maxvalue="90" mandatory="false">
</param>
<param name="locationName" type="String" maxlength="500" mandatory="false">
<description> Name / title of intended location </description>
@@ -3171,6 +3229,16 @@
<param name="locationImage" type="Common.Image" mandatory="false">
<description> Image / icon of intended location (if applicable and supported) </description>
</param>
+ <param name="timeStamp" type="Common.DateTime" mandatory="false">
+ <description>
+ timestamp in ISO 8601 format
+ </description>
+ </param>
+
+ <param name="address" type="Common.OASISAddress" mandatory="false">
+ <description>Address to be used for setting destination</description>
+ </param>
+
</function>
<function name="SendLocation" messagetype="response" >
</function>
diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml
index 1892df6da1..0700aff333 100644
--- a/src/components/interfaces/MOBILE_API.xml
+++ b/src/components/interfaces/MOBILE_API.xml
@@ -2245,6 +2245,62 @@
<element name="notification" value="2" />
</enum>
+ <struct name="DateTime">
+ <param name="second" type="Integer" minvalue="0" maxvalue="60" mandatory="true">
+ <description>Seconds part of time</description>
+ </param>
+ <param name="minute" type="Integer" minvalue="0" maxvalue="59" mandatory="true">
+ <description>Minutes part of time</description>
+ </param>
+ <param name="hour" type="Integer" minvalue="0" maxvalue="23" mandatory="true">
+ <description>Hours part of time. Note that this structure accepts time only in 24 Hr format</description>
+ </param>
+ <param name="day" type="Integer" minvalue="1" maxvalue="31" mandatory="true">
+ <description>Day of the month</description>
+ </param>
+ <param name="month" type="Integer" minvalue="1" maxvalue="12" mandatory="true">
+ <description>Month of the year</description>
+ </param>
+ <param name="year" type="Integer" maxvalue="4095" mandatory="true">
+ <description>The year in YYYY format</description>
+ </param>
+ <param name="tz_hour" type="Integer" minvalue="-12" maxvalue="14" defvalue="0" mandatory="true">
+ <description>Time zone offset in Hours wrt UTC.</description>
+ </param>
+ <param name="tz_minute" type="Integer" minvalue="0" maxvalue="59" defvalue="0" mandatory="true">
+ <description>Time zone offset in Min wrt UTC.</description>
+ </param>
+ </struct>
+
+<struct name="OASISAddress">
+ <param name="countryName" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Name of the country (localized)</description>
+ </param>
+ <param name="countryCode" minlength="0" maxlength="50" type="String" mandatory="false">
+ <description>Name of country (ISO 3166-2)</description>
+ </param>
+ <param name="postalCode" minlength="0" maxlength="16" type="String" mandatory="false">
+ <description>(PLZ, ZIP, PIN, CAP etc.)</description>
+ </param>
+ <param name="administrativeArea" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Portion of country (e.g. state)</description>
+ </param>
+ <param name="subAdministrativeArea" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Portion of e.g. state (e.g. county)</description>
+ </param>
+ <param name="locality" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Hypernym for e.g. city/village</description>
+ </param>
+ <param name="subLocality" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Hypernym for e.g. district</description>
+ </param>
+ <param name="thoroughfare" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Hypernym for street, road etc.</description>
+ </param>
+ <param name="subThoroughfare" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Portion of thoroughfare e.g. house number</description>
+ </param>
+</struct>
<!-- Requests/Responses -->
<function name="RegisterAppInterface" functionID="RegisterAppInterfaceID" messagetype="request">
@@ -4679,9 +4735,9 @@
</function>
<function name="SendLocation" functionID="SendLocationID" messagetype="request">
- <param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180" mandatory="true">
+ <param name="longitudeDegrees" type="Double" minvalue="-180" maxvalue="180" mandatory="false">
</param>
- <param name="latitudeDegrees" type="Float" minvalue="-90" maxvalue="90" mandatory="true">
+ <param name="latitudeDegrees" type="Double" minvalue="-90" maxvalue="90" mandatory="false">
</param>
<param name="locationName" type="String" maxlength="500" mandatory="false">
<description>
@@ -4707,6 +4763,16 @@
<description>
Image / icon of intended location (if applicable and supported)
</description>
+ </param>
+
+ <param name="timeStamp" type="DateTime" mandatory="false">
+ <description>
+ timestamp in ISO 8601 format
+ </description>
+ </param>
+
+ <param name="address" type="OASISAddress" mandatory="false">
+ <description>Address to be used for setting destination</description>
</param>
</function>