Skip to content

Commit 2392564

Browse files
jacobkeelerjacobkeeler
authored
Merge pull request #1339 from smartdevicelink/hotfix/GetWayPoints_implementation
Fix WayPoints API implementation
2 parents ed8a807 + 3bd9b63 commit 2392564

File tree

4 files changed

+118
-93
lines changed

4 files changed

+118
-93
lines changed

‎src/appMain/sdl_preloaded_pt.json‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -907,6 +907,25 @@
907907
}
908908
}
909909
},
910+
"WayPoints": {
911+
"rpcs": {
912+
"GetWayPoints": {
913+
"hmi_levels": ["BACKGROUND",
914+
"FULL",
915+
"LIMITED"]
916+
},
917+
"SubscribeWayPoints": {
918+
"hmi_levels": ["BACKGROUND",
919+
"FULL",
920+
"LIMITED"]
921+
},
922+
"UnsubscribeWayPoints": {
923+
"hmi_levels": ["BACKGROUND",
924+
"FULL",
925+
"LIMITED"]
926+
}
927+
}
928+
},
910929
"BackgroundAPT": {
911930
"rpcs": {
912931
"EndAudioPassThru": {

‎src/components/application_manager/test/message_helper/message_helper_test.cc‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -540,7 +540,10 @@ class MessageHelperTest : public ::testing::Test {
540540
"DiagnosticMessage",
541541
"SystemRequest",
542542
"SendLocation",
543-
"DialNumber"}
543+
"DialNumber",
544+
"GetWayPoints",
545+
"SubscribeWayPoints",
546+
"UnsubscribeWayPoints"}
544547
, events_id_strings{"OnHMIStatus",
545548
"OnAppInterfaceUnregistered",
546549
"OnButtonEvent",

‎src/components/interfaces/HMI_API.xml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434

3535
<interfaces name="SmartDeviceLink HMI API">
3636

37-
<interface name="Common" version="1.4" date="2016-05-11">
37+
<interface name="Common" version="1.5" date="2017-03-29">
3838

3939
<enum name="Result">
4040
<element name="SUCCESS" value="0"/>
@@ -3248,7 +3248,7 @@
32483248
</function>
32493249
</interface>
32503250

3251-
<interface name="Navigation" version="1.2" date="2016-06-09">
3251+
<interface name="Navigation" version="1.3" date="2017-03-29">
32523252

32533253
<function name="IsReady" messagetype="request">
32543254
<description>Method is invoked at system startup. Response must provide the information about presence of UI Navigation module and its readiness to cooperate with SDL.</description>
@@ -3415,7 +3415,7 @@
34153415
</function>
34163416
<function name="GetWayPoints" functionID="GetWayPointsID" messagetype="request">
34173417
<description>Request for getting waypoint/destination data.</description>
3418-
<param name="wayPointType" type="Common.WayPointType" defvalue="ALL" mandatory="false">
3418+
<param name="wayPointType" type="Common.WayPointType" mandatory="true">
34193419
<description>To request for either the destination only or for all waypoints including destination</description>
34203420
</param>
34213421
<param name="appID" type="Integer" mandatory="true">

‎src/components/interfaces/MOBILE_API.xml‎

Lines changed: 92 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0" standalone="no"?>
22
<?xml-stylesheet type="text/xml" href="protocol2html.xsl"?>
33

4-
<interface name="Ford Sync RAPI" version="4.2" date="2016-11-16">
4+
<interface name="Ford Sync RAPI" version="4.3" date="2016-11-16">
55

66
<enum name="Result" internal_scope="base">
77
<element name="SUCCESS">
@@ -2223,9 +2223,9 @@
22232223
<element name="SystemRequestID" value="38" hexvalue="26" />
22242224
<element name="SendLocationID" value="39" hexvalue="27" />
22252225
<element name="DialNumberID" value="40" hexvalue="28" />
2226-
<element name="GetWayPointsID" value="41" hexvalue="29" />
2227-
<element name="SubscribeWayPointsID" value="42" hexvalue="2A"/>
2228-
<element name="UnsubscribeWayPointsID" value="43" hexvalue="2B"/>
2226+
<element name="GetWayPointsID" value="45" hexvalue="2D" />
2227+
<element name="SubscribeWayPointsID" value="46" hexvalue="2E"/>
2228+
<element name="UnsubscribeWayPointsID" value="47" hexvalue="2F"/>
22292229

22302230
<!--
22312231
Base Notifications
@@ -2247,7 +2247,7 @@
22472247
<element name="OnTouchEventID" value="32780" hexvalue="800C" />
22482248
<element name="OnSystemRequestID" value="32781" hexvalue="800D" />
22492249
<element name="OnHashChangeID" value="32782" hexvalue="800E" />
2250-
<element name="OnWayPointChangeID" value="32783" hexvalue="800F" />
2250+
<element name="OnWayPointChangeID" value="32784" hexvalue="8010" />
22512251

22522252
<!--
22532253
Ford Specific Request / Response RPCs
@@ -4918,6 +4918,86 @@
49184918
</param>
49194919
</function>
49204920

4921+
<function name="SubscribeWayPoints" functionID="SubscribeWayPointsID" messagetype="request">
4922+
<description>To subscribe in getting changes for Waypoints/destinations</description>
4923+
</function>
4924+
4925+
<function name="SubscribeWayPoints" functionID="SubscribeWayPointsID" messagetype="response">
4926+
<param name="success" type="Boolean" platform="documentation">
4927+
<description> true, if successful; false, if failed </description>
4928+
</param>
4929+
<param name="resultCode" type="Result" platform="documentation">
4930+
<description>See Result</description>
4931+
<element name="SUCCESS"/>
4932+
<element name="INVALID_DATA"/>
4933+
<element name="GENERIC_ERROR"/>
4934+
<element name="REJECTED"/>
4935+
<element name="UNSUPPORTED_RESOURCE"/>
4936+
<element name="IGNORED"/>
4937+
<element name="DISALLOWED"/>
4938+
</param>
4939+
<param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
4940+
<description>Provides additional human readable info regarding the result.</description>
4941+
</param>
4942+
</function>
4943+
4944+
<function name="GetWayPoints" functionID="GetWayPointsID" messagetype="request">
4945+
<description>Request for getting waypoint/destination data.</description>
4946+
<param name="wayPointType" type="WayPointType" mandatory="true">
4947+
<description>To request for either the destination only or for all waypoints including destination</description>
4948+
</param>
4949+
</function>
4950+
4951+
<function name="GetWayPoints" functionID="GetWayPointsID" messagetype="response">
4952+
<param name="success" type="Boolean" platform="documentation">
4953+
<description> true, if successful; false, if failed </description>
4954+
</param>
4955+
<param name="resultCode" type="Result" platform="documentation">
4956+
<description>See Result</description>
4957+
<element name="SUCCESS"/>
4958+
<element name="INVALID_DATA"/>
4959+
<element name="TIMED_OUT"/>
4960+
<element name="GENERIC_ERROR"/>
4961+
<element name="REJECTED"/>
4962+
<element name="UNSUPPORTED_RESOURCE"/>
4963+
<element name="IGNORED"/>
4964+
<element name="IN_USE"/>
4965+
<element name="DISALLOWED"/>
4966+
</param>
4967+
<param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
4968+
<description>Provides additional human readable info regarding the result.</description>
4969+
</param>
4970+
<param name="wayPoints" type="LocationDetails" mandatory="false" array="true" minsize="1" maxsize="10">
4971+
<description>See LocationDetails</description>
4972+
</param>
4973+
</function>
4974+
4975+
<function name="UnsubscribeWayPoints" functionID="UnsubscribeWayPointsID" messagetype="request">
4976+
<description>Request to unsubscribe from WayPoints and Destination</description>
4977+
</function>
4978+
4979+
<function name="UnsubscribeWayPoints" functionID="UnsubscribeWayPointsID" messagetype="response">
4980+
<param name="success" type="Boolean" platform="documentation">
4981+
<description> true, if successful; false, if failed </description>
4982+
</param>
4983+
<param name="resultCode" type="Result" platform="documentation">
4984+
<description>See Result</description>
4985+
<element name="SUCCESS"/>
4986+
<element name="INVALID_DATA"/>
4987+
<element name="GENERIC_ERROR"/>
4988+
<element name="REJECTED"/>
4989+
<element name="UNSUPPORTED_RESOURCE"/>
4990+
<element name="IGNORED"/>
4991+
<element name="DISALLOWED"/>
4992+
</param>
4993+
<param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
4994+
<description>Provides additional human readable info regarding the result.</description>
4995+
</param>
4996+
<param name="wayPoints" type="LocationDetails" mandatory="false" array="true" minsize="1" maxsize="10">
4997+
<description>See LocationDetails</description>
4998+
</param>
4999+
</function>
5000+
49215001
<!-- Notifications -->
49225002

49235003
<function name="OnHMIStatus" functionID="OnHMIStatusID" messagetype="notification">
@@ -5159,6 +5239,13 @@
51595239
</param>
51605240
</function>
51615241

5242+
<function name="OnWayPointChange" functionID="OnWayPointChangeID" messagetype="notification">
5243+
<description>Notification which provides the entire LocationDetails when there is a change to any waypoints or destination.</description>
5244+
<param name="wayPoints" type="LocationDetails" mandatory="true" array="true" minsize="1" maxsize="10">
5245+
<description>See LocationDetails</description>
5246+
</param>
5247+
</function>
5248+
51625249
<!-- ~~~~~~~~~~~~~~~~~~ -->
51635250
<!-- Ford Specific APIs -->
51645251
<!-- ~~~~~~~~~~~~~~~~~~ -->
@@ -5250,90 +5337,6 @@
52505337
</param>
52515338
</function>
52525339

5253-
<function name="SubscribeWayPoints" functionID="SubscribeWayPointsID" messagetype="request">
5254-
<description>To subscribe in getting changes for Waypoints/destinations</description>
5255-
</function>
5256-
5257-
<function name="SubscribeWayPoints" functionID="SubscribeWayPointsID" messagetype="response">
5258-
<param name="success" type="Boolean" platform="documentation">
5259-
<description> true, if successful; false, if failed </description>
5260-
</param>
5261-
<param name="resultCode" type="Result" platform="documentation">
5262-
<description>See Result</description>
5263-
<element name="SUCCESS"/>
5264-
<element name="INVALID_DATA"/>
5265-
<element name="GENERIC_ERROR"/>
5266-
<element name="REJECTED"/>
5267-
<element name="UNSUPPORTED_RESOURCE"/>
5268-
<element name="IGNORED"/>
5269-
<element name="DISALLOWED"/>
5270-
</param>
5271-
<param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
5272-
<description>Provides additional human readable info regarding the result.</description>
5273-
</param>
5274-
</function>
5275-
5276-
<function name="GetWayPoints" functionID="GetWayPointsID" messagetype="request">
5277-
<description>Request for getting waypoint/destination data.</description>
5278-
<param name="wayPointType" type="WayPointType" defvalue="ALL" mandatory="false">
5279-
<description>To request for either the destination only or for all waypoints including destination</description>
5280-
</param>
5281-
</function>
5282-
5283-
<function name="GetWayPoints" functionID="GetWayPointsID" messagetype="response">
5284-
<param name="success" type="Boolean" platform="documentation">
5285-
<description> true, if successful; false, if failed </description>
5286-
</param>
5287-
<param name="resultCode" type="Result" platform="documentation">
5288-
<description>See Result</description>
5289-
<element name="SUCCESS"/>
5290-
<element name="INVALID_DATA"/>
5291-
<element name="TIMED_OUT"/>
5292-
<element name="GENERIC_ERROR"/>
5293-
<element name="REJECTED"/>
5294-
<element name="UNSUPPORTED_RESOURCE"/>
5295-
<element name="IGNORED"/>
5296-
<element name="IN_USE"/>
5297-
<element name="DISALLOWED"/>
5298-
</param>
5299-
<param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
5300-
<description>Provides additional human readable info regarding the result.</description>
5301-
</param>
5302-
</function>
5303-
5304-
<function name="UnsubscribeWayPoints" functionID="UnsubscribeWayPointsID" messagetype="request">
5305-
<description>Request to unsubscribe from WayPoints and Destination</description>
5306-
</function>
5307-
5308-
<function name="UnsubscribeWayPoints" functionID="UnsubscribeWayPointsID" messagetype="response">
5309-
<param name="success" type="Boolean" platform="documentation">
5310-
<description> true, if successful; false, if failed </description>
5311-
</param>
5312-
<param name="resultCode" type="Result" platform="documentation">
5313-
<description>See Result</description>
5314-
<element name="SUCCESS"/>
5315-
<element name="INVALID_DATA"/>
5316-
<element name="GENERIC_ERROR"/>
5317-
<element name="REJECTED"/>
5318-
<element name="UNSUPPORTED_RESOURCE"/>
5319-
<element name="IGNORED"/>
5320-
<element name="DISALLOWED"/>
5321-
</param>
5322-
<param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
5323-
<description>Provides additional human readable info regarding the result.</description>
5324-
</param>
5325-
<param name="wayPoints" type="LocationDetails" mandatory="false" array="true" minsize="1" maxsize="10">
5326-
<description>See LocationDetails</description>
5327-
</param>
5328-
</function>
5329-
5330-
<function name="OnWayPointChange" functionID="OnWayPointChangeID" messagetype="notification">
5331-
<description>Notification which provides the entire LocationDetails when there is a change to any waypoints or destination.</description>
5332-
<param name="wayPoints" type="LocationDetails" mandatory="true" array="true" minsize="1" maxsize="10">
5333-
<description>See LocationDetails</description>
5334-
</param>
5335-
</function>
5336-
53375340

53385341
<!-- Deprecating - covered by OnSystemRequest
53395342
<function name="OnSyncPData" functionID="OnSyncPDataID" messagetype="notification" >

0 commit comments

Comments
 (0)