diff options
91 files changed, 7133 insertions, 6661 deletions
diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 42cf5d0898..672768add7 100644 --- a/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,22 +2,28 @@ Third party contributions are essential for making SDL great. However, we do have a few guidelines we need contributors to follow. +## Environment +Currently supported: +* Ubuntu Linux 14.04 with GCC 4.9.x +* Ubuntu Linux 16.04 with GCC 5.4.x +* [C++11 standard](https://github.com/smartdevicelink/sdl_evolution/issues/132) + ### Issues -If writing a bug report, please make sure <a href="http://yourbugreportneedsmore.info" target="_blank">it has enough info</a>. Include all relevant information. +If writing a bug report, please make sure [you follow the issue template](https://github.com/smartdevicelink/sdl_core/blob/master/.github/ISSUE_TEMPLATE.md). Include all relevant information. If requesting a feature, understand that we appreciate the input! However, it may not immediately fit our roadmap, and it may take a while for us to get to your request. ### Gitflow -We use <a href="http://nvie.com/posts/a-successful-git-branching-model/">Gitflow</a> as our branch management system. Please follow gitflow's guidelines while contributing to any SDL project. +We use [GitFlow](http://nvie.com/posts/a-successful-git-branching-model/) as our branch management system. Please follow GitFlow's guidelines while contributing to any SDL project. ### Pull Requests -* Please follow the repository's for all code and documentation. +* Please follow the repository's [Style Guide](https://github.com/smartdevicelink/sdl_core/wiki/SDL-Coding-Style-Guide) for all code and documentation. * All pull requests should be sent to `smartdevicelink/sdl_core/`, to `develop` or `master` branch. * All feature branches should be based on `develop` and have the format `feature/branch_name`. * All fix branches should be based on `develop` and have the format `fix/branch_name`. * All new functionality requests should be provided only for `develop` branch. -* In case defect should be fixed in short time (after release), send pull request to `master` and have the format `hotfix/branch_name`. -* In case defect exists in `develop` and `master` branches, send pull request to `develop` only. Do not send the same pull request to the `master` branch. +* In case an issue should be fixed in a short time (after release), open a pull request to `master` with a branch name of `hotfix/branch_name`. +* In case an issue exists in both the `develop` and `master` branches, open a pull request to `develop` only. Do not open the same pull request against the `master` branch. * All pull requests should implement a single feature or fix a single bug. Pull Requests that involve multiple changes (it is our discretion what precisely this means) will be rejected with a reason. * All commits should be separated into logical units, i.e. unrelated changes should be in different commits within a pull request. * Work in progress pull requests should have "[WIP]" in front of the Pull Request title. When you believe the pull request is ready to merge, remove this tag and @mention the appropriate SDL team to schedule a review. @@ -30,6 +36,3 @@ In order to accept Pull Requests from contributors, you must first sign [the Con ## Additional Resources * [General GitHub documentation](https://help.github.com/) * [GitHub pull request documentation](https://help.github.com/send-pull-requests/) -* [Contributor's License Agreement](https://docs.google.com/forms/d/1VNR8EUd5b46cQ7uNbCq1fJmnu0askNpUp5dudLKRGpU/viewform) -* [Committers.md](https://github.com/LuxoftSDL/sdl_core/blob/feature/Add_Committers_file/COMMITTERS.md) - diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000..1b58b20e86 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,23 @@ +[Delete any non-applicable sections, but we may ask for more information.] + +### Bug Report +[Summary] + +##### Reproduction Steps +1. [Step 1] +2. [Step 2] +3. [Step 3] + +##### Expected Behavior +[Some expected behavior] + +##### Observed Behavior +[Some observed behavior] + +##### OS & Version Information +* OS/Version: [The OS/Version you were running when the bug occurred] +* SDL Core Version: [The version of SDL Core you were using when the bug occurred] +* Testing Against: [What you tested with to observe this behavior. Proxy, App, HMI etc.] + +##### Test Case, Sample Code, and / or Example App +[Paste a link to a PR, gist, or other code that exemplifies this behavior]
\ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..83c3261f9b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,33 @@ +[Things to note: Pull Requests **must** fix an issue. Discussion about the feature / bug takes place in the issue, discussion of the implementation takes place in the PR. Please also see the [Contributing Guide](https://github.com/smartdevicelink/sdl_core/blob/master/.github/CONTRIBUTING.md) for information on branch naming and the CLA. + +Delete the above section when you've read it.] + +Fixes #[issue number] + +This PR is **[ready / not ready]** for review. + +### Risk +This PR makes **[no / minor / major]** API changes. + +### Testing Plan +[Describe how you plan to unit test the changes in this PR] + +### Summary +[Summary of PR changes] + +### Changelog +##### Breaking Changes +* [Breaking change info] + +##### Enhancements +* [Enhancement info] + +##### Bug Fixes +* [Bug Fix Info] + +### Tasks Remaining: +- [ ] [Task 1] +- [ ] [Task 2] + +### CLA +- [ ] I have signed [the CLA](https://docs.google.com/forms/d/e/1FAIpQLSdsgJY33VByaX482zHzi-xUm49JNnmuJOyAM6uegPQ2LXYVfA/viewform)
\ No newline at end of file diff --git a/COMMITTERS.md b/COMMITTERS.md deleted file mode 100644 index 210fceb421..0000000000 --- a/COMMITTERS.md +++ /dev/null @@ -1,95 +0,0 @@ -#Committing changes to SDL
-
-We would like to make it easier for community members to contribute to SDL
-using pull requests. This makes the process of contributing a little easier for the contributor since they don't
-need to concern themselves with the question, "What branch do I base my changes
-on?" This is already called out in the CONTRIBUTING.md.
-
-##Terminology
-Many of these terms have more than one meaning. For the purposes of this
-document, the following terms refer to specific things.
-
-**contributor** - A person who makes a change to SDL and submits a change
-set in the form of a pull request.
-
-**reviewer** - A person responsible for reviewing a pull request.
-
-**master branch** - [The base branch](https://github.com/smartdevicelink/sdl_core/tree/master).
-
-**develop branch** - [The branch](https://github.com/LuxoftSDL/sdl_core/tree/develop) where bug fixes against the latest release or release candidate are merged.
-
-## Pre-commit hook installation
-* Go to tools/infrastructure/
-* Run install-hooks.py
-* or : Just run "python tools/infrastructure/install-hooks.py"
-
-##Pull request checklist
-* Add Unit tests.
-* All tests pass (see Run all tests section).
-* Check component design
-* Check amount of required memory, memory leaks.
-* Assertion must be used in the right way.
-* Are there cyclic dependencies?
-* Level of abstraction adequate?
-* Are there any platform gotchas? (Does a change make an assumption about
- platform specific behavior that is incompatible with other platforms? e.g.
- Windows paths vs. POSIX paths).
-* Thread safe code.
-* No deadlocks.
-* Is Doxygen API documentation available?
-* Do you have thread specific comment provided? (if another thread uses added method/classes,
- there must be comment which explains: When method will be called by thread? Which thread calls the method? e.g.)
-* Do you have specific realization code comments?
-* Add log messages.
-* There are no Google code style errors. (You can download Google [cpplint.py](https://raw.githubusercontent.com/google/styleguide/gh-pages/cpplint/cpplint.py))
-* Check branch naming.
-* Check correct commit messages in commits (see Pull request message section).
-* Check correct pull request target (`master` or `develop`)
-* Check correct pull request message
-* Add reviewers
-
-##Run all tests
-* Run in root build directory `make test`
-
-##Branch naming
-Branch name should be:
-* `hotfix/<task name>` or
-* `feature/<task name>` or
-* `fix/<task name>`
-
-##Pull request message
-* Describe the reason why you created pull request and what changes there are.
-* Add related Jira ticket as link.
- ( EXAMPLE:
- `Related: [APPLINK-xxxxx](put direct link here)`)
-* If there was an old pull request, add link. ( EXAMPLE: `Old pull request is [here](put direct link here)`)
-
-##Adding reviewers:
-* Add one domain expert
-* Add your mentor (for junior developers only)
-* Add all junior developers (for junior developers only)
-
-`Note`: Everyone from SDL team developers can review any pull request (“reviewed” comment is not required)
-
-##Review process
-* Reviewers can leave comments to code only in `commits` tab.
-* Contributor must answer each comment (Contributor should specify addressee in comment).
-* In case contributor is disagree with reviewer, contributor writes his opinion
-* In case contributor is agree with reviewer, contributor leaves link to new commit with changes.
-* When reviewer is agree with all changes in pull request, he must leave `Reviewed` comment.
-
-##Successfully passed review:
-* Contributor answered to all comments
-* Contributor fixed all mistakes
-* All reviewers left `Reviewed` comment
-
-##Merging
-* Successfully passed review.
-* Rebase in case of existing conflicts.
-* Contributor can squash commits in case of adding same code in different commits.
-* Contact @AGaliuzov or @anosach-luxoft to merge pull request.
-
-##Additional sources
-* [Google cppint.py](https://raw.githubusercontent.com/google/styleguide/gh-pages/cpplint/cpplint.py)
-* [Git commit best practices](http://chris.beams.io/posts/git-commit/)
-* [GitHub Working with formatting](https://help.github.com/articles/working-with-advanced-formatting/)
@@ -1,8 +1,6 @@ [](http://slack.smartdevicelink.com) -[](https://travis-ci.org/smartdevicelink/sdl_core) - - [](https://codecov.io/github/smartdevicelink/sdl_core?branch=develop) +[](https://codecov.io/github/smartdevicelink/sdl_core?branch=develop) # SmartDeviceLink (SDL) @@ -121,54 +119,6 @@ There are several RPCs that are "required" to be implemented in order for SDL to * OnSystemRequest * Speak -## App Launching - -Below are instructions for testing app launching and query with a full system set up. - -### SDL Server -The app querying specification defines an endpoint within Policies where sdl_core will reach out to receive a list of applications that can be launched. The SDL Server provides the back end functionality for app launching and querying. - -You can find the SDL Server on [GitHub](https://github.com/smartdevicelink/sdl_server). The README contains detailed instructions for installing and launching the server. Launch the server on your local machine, and direct your browser to http://localhost:3000. - -The [App Launching Server Specification](https://github.com/smartdevicelink/sdl_server/blob/master/docs/application_launching_v1.0.md) defines an endpoint `/applications/available/:moduleId.json` which return a list of applications available for launching to the handset for filtering. - -To check if there is a module already available you can go to http://localhost:3000/modules.json. If there is a module available, there will be one or more objects in the response array. Keep this response, you'll need the "_id" field for later. - -If there is not a module already available, go to http://localhost:3000/cars and define a new vehicle, then check http://localhost:3000/modules.json. - -Next, you'll need to define applications that can be launched. Go to http://localhost:3000/apps and define some applications. Make sure that you define a url scheme under the iOS tab of the application. This is required for an application to be launched from SDL. A URL scheme has the format `someScheme://`. Save the URL Scheme you used for later steps. - -You'll also need the local ip address of your machine - -At the end of the SDL Server set up you should have - 1. SDL Server running on your local machine connected to mongo db - 2. Your machine's local IP Address - 3. The module id of your vehicle - 4. The URL Scheme of the app you want to launch - -### Mobile -You need at least one app installed on the test device (presumably an iPhone), which we have built for you, the [V4Tester application](https://app.box.com/s/eeloquc0fhqfmxjjubw7kousf12f3pzg). This application implements SDL 4.0 and will respond to SDL Core's QUERY_APPS system request, as well as filter the response for available applications. If you do not have any other applications on the device, you can only test QUERY_APPS functionality, in which no applications will be sent to sdl core which can be launched. - -In order to support the launching of an application, you'll have to create an additional app which responds to the URL Scheme of the application that you set up on the SDL Server. To do so, go to Xcode, select File>New>Project... and under ios/application create a Single View Application. Open the application's Info.plist file (under the Supporting Files section of the project explorer by default). Highlight the Information Property List item and click the plus button to add a new entry to the Property List. From the drop down menu, select URL Types as the key. In the Item 0 dictionary add a "URL Schemes" Array, and make Item 0 in the array the prefix to the URL you previously defined (So if you defined `someScheme://` then Item 0 should be "someScheme"). Make sure the URL identifier matches your application's identifier. When you're finished you should have something that looks like the following. Install this application on your test device. **Note** - this application will only launch during this process, since it is not SDL Connected it will not register with the head unit. - - - -At the end of the Mobile device set up you should have - 1. The V4 Tester Application installed on your device - 2. An application for launching that matches the application submitted to SDL Server - 3. Your iPhone should be on the same network as the machine running SDL Server - -### SDL Core -Take the following steps to launch applications from sdl core. - - 1. Install the [correct version of SDL Core](https://github.com/smartdevicelink/sdl_core/pull/39) - 2. Add the queryAppsUrl that you saved during sdl server set up in the src/appMain/preloaded_pt.json under the "endpoints" property in the format `http://[local machine ip]:3000/applications/available[moduleId].json`. For example `http://192.168.0.150:3000/applications/available/789b739c47c7490321058200.json`. - 3. Run SDL Core - 4. Launch the V4 Tester application on the iPhone - 5. Connect the application via wifi by entering the IP address of Core into the V4 tester - 6. Both applications should show up on the head unit for launching - 7. Select the other application, and you should see it launched and brought to the foreground on the phone - ## Test Coverage ### Used technologies * GCOV - test coverage program. diff --git a/src/3rd_party-static/message_broker/src/lib_messagebroker/websocket_handler.cpp b/src/3rd_party-static/message_broker/src/lib_messagebroker/websocket_handler.cpp index 17c2dd92ae..9fd364cf17 100644 --- a/src/3rd_party-static/message_broker/src/lib_messagebroker/websocket_handler.cpp +++ b/src/3rd_party-static/message_broker/src/lib_messagebroker/websocket_handler.cpp @@ -160,9 +160,9 @@ namespace NsMessageBroker DBG_MSG(("CWebSocketHandler::parseWebSocketData()length:%d; size:%d;" " position:%d\n", (int)length, size, position)); - for (unsigned long i = 0; (i < size); i++) { - Buffer[parsedBufferPosition + i] = recBuffer[i+position]; - } + memmove(&Buffer[parsedBufferPosition], &recBuffer[position], + size - position); + b_size -= position; parsedBufferPosition += length; recBuffer += length; diff --git a/src/appMain/main.cc b/src/appMain/main.cc index 58ab02b123..81482c4335 100644 --- a/src/appMain/main.cc +++ b/src/appMain/main.cc @@ -148,8 +148,7 @@ int32_t main(int32_t argc, char** argv) { // Check if no error values were read from config file if (profile_instance.ErrorOccured()) { - const std::string& error = profile_instance.ErrorDescription(); - LOG4CXX_FATAL(logger_, error); + LOG4CXX_FATAL(logger_, profile_instance.ErrorDescription()); FLUSH_LOGGER(); DEINIT_LOGGER(); exit(EXIT_FAILURE); diff --git a/src/appMain/sdl_preloaded_pt.json b/src/appMain/sdl_preloaded_pt.json index c4f58c04c2..58abfb6f80 100644 --- a/src/appMain/sdl_preloaded_pt.json +++ b/src/appMain/sdl_preloaded_pt.json @@ -2344,11 +2344,7 @@ "steal_focus": false,
"priority": "NONE",
"default_hmi": "NONE",
- "groups": ["Base-4", "RemoteControl"],
- "moduleType": [
- "RADIO",
- "CLIMATE"
- ]
+ "groups": ["Base-4"]
},
"device": {
"keep_context": false,
diff --git a/src/components/application_manager/include/application_manager/commands/command_request_impl.h b/src/components/application_manager/include/application_manager/commands/command_request_impl.h index aa3c216d4d..614f86a6f1 100644 --- a/src/components/application_manager/include/application_manager/commands/command_request_impl.h +++ b/src/components/application_manager/include/application_manager/commands/command_request_impl.h @@ -49,7 +49,7 @@ struct ResponseInfo { , interface_state(HmiInterfaces::STATE_NOT_RESPONSE) , is_ok(false) , is_unsupported_resource(false) - , is_invalid_enum(false) {} + , is_not_used(false) {} ResponseInfo(hmi_apis::Common_Result::eType result, HmiInterfaces::InterfaceID interface) : result_code(result) @@ -57,13 +57,13 @@ struct ResponseInfo { , interface_state(HmiInterfaces::STATE_NOT_RESPONSE) , is_ok(false) , is_unsupported_resource(false) - , is_invalid_enum(false) {} + , is_not_used(false) {} hmi_apis::Common_Result::eType result_code; HmiInterfaces::InterfaceID interface; HmiInterfaces::InterfaceState interface_state; bool is_ok; bool is_unsupported_resource; - bool is_invalid_enum; + bool is_not_used; }; namespace NsSmart = NsSmartDeviceLink::NsSmartObjects; diff --git a/src/components/application_manager/include/application_manager/commands/mobile/subscribe_vehicle_data_request.h b/src/components/application_manager/include/application_manager/commands/mobile/subscribe_vehicle_data_request.h index eb360b50d8..f556f81764 100644 --- a/src/components/application_manager/include/application_manager/commands/mobile/subscribe_vehicle_data_request.h +++ b/src/components/application_manager/include/application_manager/commands/mobile/subscribe_vehicle_data_request.h @@ -148,6 +148,11 @@ class SubscribeVehicleDataRequest : public CommandRequestImpl { */ VehicleInfoSubscriptions vi_already_subscribed_by_this_app_; + /** + * @brief VI parameters which wait for subscribe after HMI respond + */ + VehicleInfoSubscriptions vi_waiting_for_subscribe_; + DISALLOW_COPY_AND_ASSIGN(SubscribeVehicleDataRequest); }; diff --git a/src/components/application_manager/include/application_manager/hmi_capabilities_impl.h b/src/components/application_manager/include/application_manager/hmi_capabilities_impl.h index cbab1fcc80..9380fb41ac 100644 --- a/src/components/application_manager/include/application_manager/hmi_capabilities_impl.h +++ b/src/components/application_manager/include/application_manager/hmi_capabilities_impl.h @@ -425,6 +425,20 @@ class HMICapabilitiesImpl : public HMICapabilities { bool video_streaming_supported() const OVERRIDE; /* + * @brief Interface to store whether HMI supports remote control + * + * @param supported Indicates whether video streaming is supported by HMI + */ + void set_rc_supported(const bool supported) OVERRIDE; + + /* + * @brief Retrieves whether HMI supports remote control + * + * @return TRUE if it supported, otherwise FALSE + */ + bool rc_supported() const OVERRIDE; + + /* * @brief Interface used to store information regarding * the navigation "System Capability" * @@ -557,6 +571,7 @@ class HMICapabilitiesImpl : public HMICapabilities { bool is_navigation_supported_; bool is_phone_call_supported_; bool is_video_streaming_supported_; + bool is_rc_supported_; std::string ccpu_version_; smart_objects::SmartObject* navigation_capability_; smart_objects::SmartObject* phone_capability_; diff --git a/src/components/application_manager/include/application_manager/smart_object_keys.h b/src/components/application_manager/include/application_manager/smart_object_keys.h index 25fa435364..0d4eeea0c4 100644 --- a/src/components/application_manager/include/application_manager/smart_object_keys.h +++ b/src/components/application_manager/include/application_manager/smart_object_keys.h @@ -270,6 +270,7 @@ extern const char* hmi_capabilities; extern const char* navigation; extern const char* phone_call; extern const char* video_streaming; +extern const char* remote_control; extern const char* sdl_version; extern const char* system_software_version; extern const char* priority; diff --git a/src/components/application_manager/src/app_launch/app_launch_sql_queries.cc b/src/components/application_manager/src/app_launch/app_launch_sql_queries.cc index 950bcd44fa..cc4765e6c9 100644 --- a/src/components/application_manager/src/app_launch/app_launch_sql_queries.cc +++ b/src/components/application_manager/src/app_launch/app_launch_sql_queries.cc @@ -36,7 +36,7 @@ namespace app_launch { const std::string kCreateSchema = "CREATE TABLE IF NOT EXISTS `app_launch`( " " `deviceMac` TEXT, " - " `appID` TEXT," + " `appID` TEXT collate nocase," " `bundleID` TEXT," " `last_session` DATETIME, " " PRIMARY KEY(`deviceMac`, `appID`, `bundleID`)" diff --git a/src/components/application_manager/src/application_manager_impl.cc b/src/components/application_manager/src/application_manager_impl.cc index ab20222fcf..9814b4cff8 100644 --- a/src/components/application_manager/src/application_manager_impl.cc +++ b/src/components/application_manager/src/application_manager_impl.cc @@ -1227,8 +1227,22 @@ bool ApplicationManagerImpl::StartNaviService( if (service_type == ServiceType::kMobileNav) { smart_objects::SmartObject converted_params(smart_objects::SmartType_Map); ConvertVideoParamsToSO(converted_params, params); + std::vector<std::string> rejected_params; + if (converted_params.keyExists(strings::codec) && + converted_params[strings::codec] == + hmi_apis::Common_VideoStreamingCodec::INVALID_ENUM) { + rejected_params.push_back(strings::codec); + } + if (converted_params.keyExists(strings::protocol) && + converted_params[strings::protocol] == + hmi_apis::Common_VideoStreamingProtocol::INVALID_ENUM) { + rejected_params.push_back(strings::protocol); + } - if (!converted_params.empty()) { + if (!rejected_params.empty()) { + OnStreamingConfigured(app_id, service_type, false, rejected_params); + return false; + } else if (!converted_params.empty()) { LOG4CXX_INFO(logger_, "Sending video configuration params"); #ifdef DEBUG MessageHelper::PrintSmartObject(converted_params); @@ -1248,6 +1262,8 @@ bool ApplicationManagerImpl::StartNaviService( } else { LOG4CXX_WARN(logger_, "Refused navi service by HMI level"); } + std::vector<std::string> empty; + OnStreamingConfigured(app_id, service_type, false, empty); return false; } @@ -1390,8 +1406,7 @@ void ApplicationManagerImpl::OnServiceStartedCallback( type, ServiceType::kMobileNav, ServiceType::kAudio)) { if (app->is_navi() || app->mobile_projection_enabled()) { if (!StartNaviService(session_key, type, params)) { - connection_handler().NotifyServiceStartedResult( - session_key, false, empty); + LOG4CXX_WARN(logger_, "Starting Navigation service failed"); } return; } else { @@ -1611,11 +1626,11 @@ void ApplicationManagerImpl::SendMessageToMobile( (*message)[strings::params][strings::function_id].asUInt()); if (function_id == mobile_apis::FunctionID::RegisterAppInterfaceID && (*message)[strings::msg_params][strings::success].asBool()) { - const bool is_for_plugin = plugin_manager_.IsAppForPlugins(app); LOG4CXX_INFO(logger_, - "Registered app " << app->app_id() << " is " - << (is_for_plugin ? "" : "not ") - << "for plugins."); + "Registered app " + << app->app_id() << " is " + << (plugin_manager_.IsAppForPlugins(app) ? "" : "not ") + << "for plugins."); } #endif // SDL_REMOTE_CONTROL } else if (app) { @@ -2268,17 +2283,12 @@ bool ApplicationManagerImpl::ConvertSOtoMessage( } if (message.getElement(jhs::S_PARAMS).keyExists(strings::binary_data)) { - application_manager::BinaryData* binaryData = - new application_manager::BinaryData( - message.getElement(jhs::S_PARAMS) - .getElement(strings::binary_data) - .asBinary()); - - if (NULL == binaryData) { - LOG4CXX_ERROR(logger_, "Null pointer"); - return false; - } - output.set_binary_data(binaryData); + application_manager::BinaryData binaryData( + message.getElement(jhs::S_PARAMS) + .getElement(strings::binary_data) + .asBinary()); + + output.set_binary_data(&binaryData); } LOG4CXX_DEBUG(logger_, "Successfully parsed smart object into message"); @@ -3011,7 +3021,8 @@ void ApplicationManagerImpl::UnregisterApplication( #ifdef SDL_REMOTE_CONTROL plugin_manager_.OnApplicationEvent( - functional_modules::ApplicationEvent::kApplicationUnregistered, app_id); + functional_modules::ApplicationEvent::kApplicationUnregistered, + app_to_remove); #endif MessageHelper::SendOnAppUnregNotificationToHMI( @@ -4024,21 +4035,12 @@ void ApplicationManagerImpl::ConvertVideoParamsToSO( const char* protocol = bson_object_get_string(obj, protocol_handler::strings::video_protocol); if (protocol != NULL) { - hmi_apis::Common_VideoStreamingProtocol::eType protocol_enum = - ConvertVideoProtocol(protocol); - if (protocol_enum != - hmi_apis::Common_VideoStreamingProtocol::INVALID_ENUM) { - output[strings::protocol] = protocol_enum; - } + output[strings::protocol] = ConvertVideoProtocol(protocol); } const char* codec = bson_object_get_string(obj, protocol_handler::strings::video_codec); if (codec != NULL) { - hmi_apis::Common_VideoStreamingCodec::eType codec_enum = - ConvertVideoCodec(codec); - if (codec_enum != hmi_apis::Common_VideoStreamingCodec::INVALID_ENUM) { - output[strings::codec] = codec_enum; - } + output[strings::codec] = ConvertVideoCodec(codec); } BsonElement* element = bson_object_get(obj, protocol_handler::strings::height); diff --git a/src/components/application_manager/src/commands/command_request_impl.cc b/src/components/application_manager/src/commands/command_request_impl.cc index 24ab3b11f1..f461db814d 100644 --- a/src/components/application_manager/src/commands/command_request_impl.cc +++ b/src/components/application_manager/src/commands/command_request_impl.cc @@ -106,18 +106,31 @@ const std::string CreateInfoForUnsupportedResult( } bool CheckResultCode(const ResponseInfo& first, const ResponseInfo& second) { - if (first.is_ok && second.is_unsupported_resource && - second.interface_state == HmiInterfaces::STATE_NOT_AVAILABLE) { - return true; + if (!first.is_ok && !second.is_ok) { + return false; } - return false; + + if (!first.is_ok && second.is_not_used) { + return false; + } + + if (!second.is_ok && first.is_not_used) { + return false; + } + + if (first.is_unsupported_resource && second.is_not_used && + HmiInterfaces::STATE_NOT_AVAILABLE == first.interface_state) { + return false; + } + + return true; } bool IsResultCodeUnsupported(const ResponseInfo& first, const ResponseInfo& second) { - return ((first.is_ok || first.is_invalid_enum) && + return ((first.is_ok || first.is_not_used) && second.is_unsupported_resource) || - ((second.is_ok || second.is_invalid_enum) && + ((second.is_ok || second.is_not_used) && first.is_unsupported_resource) || (first.is_unsupported_resource && second.is_unsupported_resource); } @@ -205,6 +218,7 @@ void CommandRequestImpl::SendResponse( const mobile_apis::Result::eType& result_code, const char* info, const smart_objects::SmartObject* response_params) { + LOG4CXX_AUTO_TRACE(logger_); { sync_primitives::AutoLock auto_lock(state_lock_); if (kTimedOut == current_state_) { @@ -776,6 +790,7 @@ bool CommandRequestImpl::PrepareResultForMobileResponse( bool CommandRequestImpl::PrepareResultForMobileResponse( ResponseInfo& out_first, ResponseInfo& out_second) const { + LOG4CXX_AUTO_TRACE(logger_); using namespace helpers; out_first.is_ok = Compare<hmi_apis::Common_Result::eType, EQ, ONE>( @@ -794,10 +809,10 @@ bool CommandRequestImpl::PrepareResultForMobileResponse( hmi_apis::Common_Result::RETRY, hmi_apis::Common_Result::SAVED); - out_first.is_invalid_enum = + out_first.is_not_used = hmi_apis::Common_Result::INVALID_ENUM == out_first.result_code; - out_second.is_invalid_enum = + out_second.is_not_used = hmi_apis::Common_Result::INVALID_ENUM == out_second.result_code; out_first.is_unsupported_resource = @@ -809,13 +824,15 @@ bool CommandRequestImpl::PrepareResultForMobileResponse( out_first.interface_state = application_manager_.hmi_interfaces().GetInterfaceState( out_first.interface); + out_second.interface_state = application_manager_.hmi_interfaces().GetInterfaceState( out_second.interface); bool result = (out_first.is_ok && out_second.is_ok) || - (out_second.is_invalid_enum && out_first.is_ok) || - (out_first.is_invalid_enum && out_second.is_ok); + (out_second.is_not_used && out_first.is_ok) || + (out_first.is_not_used && out_second.is_ok); + result = result || CheckResultCode(out_first, out_second); result = result || CheckResultCode(out_second, out_first); return result; @@ -834,6 +851,7 @@ void CommandRequestImpl::GetInfo( mobile_apis::Result::eType CommandRequestImpl::PrepareResultCodeForResponse( const ResponseInfo& first, const ResponseInfo& second) { + LOG4CXX_AUTO_TRACE(logger_); mobile_apis::Result::eType result_code = mobile_apis::Result::INVALID_ENUM; if (IsResultCodeUnsupported(first, second)) { result_code = mobile_apis::Result::UNSUPPORTED_RESOURCE; diff --git a/src/components/application_manager/src/commands/hmi/on_exit_application_notification.cc b/src/components/application_manager/src/commands/hmi/on_exit_application_notification.cc index 9f4c6e5b5d..efdfaf8f3e 100644 --- a/src/components/application_manager/src/commands/hmi/on_exit_application_notification.cc +++ b/src/components/application_manager/src/commands/hmi/on_exit_application_notification.cc @@ -67,7 +67,7 @@ void OnExitApplicationNotification::Run() { #ifdef SDL_REMOTE_CONTROL application_manager_.GetPluginManager().OnApplicationEvent( - functional_modules::ApplicationEvent::kApplicationExit, app_id); + functional_modules::ApplicationEvent::kApplicationExit, app_impl); #endif // SDL_REMOTE_CONTROL Common_ApplicationExitReason::eType reason; diff --git a/src/components/application_manager/src/commands/hmi/rc_get_capabilities_response.cc b/src/components/application_manager/src/commands/hmi/rc_get_capabilities_response.cc index 3ff6edd125..82cbd7f128 100644 --- a/src/components/application_manager/src/commands/hmi/rc_get_capabilities_response.cc +++ b/src/components/application_manager/src/commands/hmi/rc_get_capabilities_response.cc @@ -45,9 +45,14 @@ void RCGetCapabilitiesResponse::Run() { LOG4CXX_AUTO_TRACE(logger_); HMICapabilities& hmi_capabilities = application_manager_.hmi_capabilities(); - - hmi_capabilities.set_rc_capability( - (*message_)[strings::msg_params][strings::rc_capability]); + bool capability_exists = + (*message_)[strings::msg_params].keyExists(strings::rc_capability); + + if (capability_exists) { + hmi_capabilities.set_rc_capability( + (*message_)[strings::msg_params][strings::rc_capability]); + } + hmi_capabilities.set_rc_supported(capability_exists); } } // namespace commands diff --git a/src/components/application_manager/src/commands/hmi/rc_is_ready_request.cc b/src/components/application_manager/src/commands/hmi/rc_is_ready_request.cc index 71b803d198..a976ce1044 100644 --- a/src/components/application_manager/src/commands/hmi/rc_is_ready_request.cc +++ b/src/components/application_manager/src/commands/hmi/rc_is_ready_request.cc @@ -62,10 +62,14 @@ void RCIsReadyRequest::on_event(const event_engine::Event& event) { HMICapabilities& hmi_capabilities = application_manager_.hmi_capabilities(); hmi_capabilities.set_is_rc_cooperating(is_available); + if (!is_available) { + hmi_capabilities.set_rc_supported(false); + } + if (!CheckAvailabilityHMIInterfaces(application_manager_, HmiInterfaces::HMI_INTERFACE_RC)) { LOG4CXX_INFO(logger_, - "HmiInterfaces::HMI_INTERFACE_VR isn't available"); + "HmiInterfaces::HMI_INTERFACE_RC isn't available"); return; } SendMessageToHMI(); diff --git a/src/components/application_manager/src/commands/mobile/alert_request.cc b/src/components/application_manager/src/commands/mobile/alert_request.cc index 3288870b92..53515a810a 100644 --- a/src/components/application_manager/src/commands/mobile/alert_request.cc +++ b/src/components/application_manager/src/commands/mobile/alert_request.cc @@ -219,7 +219,7 @@ bool AlertRequest::PrepareResponseParameters( result = false; } result_code = mobile_apis::Result::WARNINGS; - if ((ui_alert_info.is_ok || ui_alert_info.is_invalid_enum) && + if ((ui_alert_info.is_ok || ui_alert_info.is_not_used) && tts_alert_info.is_unsupported_resource && HmiInterfaces::STATE_AVAILABLE == tts_alert_info.interface_state) { tts_response_info_ = "Unsupported phoneme type sent in a prompt"; @@ -230,6 +230,10 @@ bool AlertRequest::PrepareResponseParameters( result_code = PrepareResultCodeForResponse(ui_alert_info, tts_alert_info); info = MergeInfos( ui_alert_info, ui_response_info_, tts_alert_info, tts_response_info_); + // Mobile Alert request is successful when UI_Alert is successful + if (is_ui_alert_sent_ && !ui_alert_info.is_ok) { + return false; + } return result; } diff --git a/src/components/application_manager/src/commands/mobile/get_system_capability_request.cc b/src/components/application_manager/src/commands/mobile/get_system_capability_request.cc index d19e2ecbb0..71cde5158d 100644 --- a/src/components/application_manager/src/commands/mobile/get_system_capability_request.cc +++ b/src/components/application_manager/src/commands/mobile/get_system_capability_request.cc @@ -79,9 +79,6 @@ void GetSystemCapabilityRequest::Run() { return; } break; - case mobile_apis::SystemCapabilityType::AUDIO_STREAMING: - SendResponse(false, mobile_apis::Result::UNSUPPORTED_RESOURCE); - return; default: // Return unsupported resource SendResponse(false, mobile_apis::Result::UNSUPPORTED_RESOURCE); return; diff --git a/src/components/application_manager/src/commands/mobile/perform_interaction_request.cc b/src/components/application_manager/src/commands/mobile/perform_interaction_request.cc index 007440e8e6..b199e652a6 100644 --- a/src/components/application_manager/src/commands/mobile/perform_interaction_request.cc +++ b/src/components/application_manager/src/commands/mobile/perform_interaction_request.cc @@ -143,11 +143,10 @@ void PerformInteractionRequest::Run() { } } - if (choice_set_id_list_length && - (!CheckChoiceIDFromRequest( - app, - choice_set_id_list_length, - msg_params[strings::interaction_choice_set_id_list]))) { + if (!CheckChoiceIDFromRequest( + app, + choice_set_id_list_length, + msg_params[strings::interaction_choice_set_id_list])) { LOG4CXX_ERROR(logger_, "PerformInteraction has choice sets with " "duplicated IDs or application does not have choice sets"); diff --git a/src/components/application_manager/src/commands/mobile/register_app_interface_request.cc b/src/components/application_manager/src/commands/mobile/register_app_interface_request.cc index 74bc0c032e..1a60537874 100644 --- a/src/components/application_manager/src/commands/mobile/register_app_interface_request.cc +++ b/src/components/application_manager/src/commands/mobile/register_app_interface_request.cc @@ -217,9 +217,6 @@ void RegisterAppInterfaceRequest::Run() { return; } - const std::string mobile_app_id = - (*message_)[strings::msg_params][strings::app_id].asString(); - ApplicationSharedPtr application = application_manager_.application(connection_key()); @@ -231,7 +228,13 @@ void RegisterAppInterfaceRequest::Run() { const smart_objects::SmartObject& msg_params = (*message_)[strings::msg_params]; - const std::string& policy_app_id = msg_params[strings::app_id].asString(); + const std::string policy_app_id = msg_params[strings::app_id].asString(); + std::string new_policy_app_id = policy_app_id; + std::transform(policy_app_id.begin(), + policy_app_id.end(), + new_policy_app_id.begin(), + ::tolower); + (*message_)[strings::msg_params][strings::app_id] = new_policy_app_id; if (application_manager_.IsApplicationForbidden(connection_key(), policy_app_id)) { @@ -494,6 +497,8 @@ void FillUIRelatedFields(smart_objects::SmartObject& response_params, hmi_capabilities.phone_call_supported(); response_params[strings::hmi_capabilities][strings::video_streaming] = hmi_capabilities.video_streaming_supported(); + response_params[strings::hmi_capabilities][strings::remote_control] = + hmi_capabilities.rc_supported(); } void RegisterAppInterfaceRequest::SendRegisterAppInterfaceResponseToMobile() { diff --git a/src/components/application_manager/src/commands/mobile/send_haptic_data_request.cc b/src/components/application_manager/src/commands/mobile/send_haptic_data_request.cc index cabfef15f6..569eba6c02 100644 --- a/src/components/application_manager/src/commands/mobile/send_haptic_data_request.cc +++ b/src/components/application_manager/src/commands/mobile/send_haptic_data_request.cc @@ -49,7 +49,22 @@ void SendHapticDataRequest::Run() { LOG4CXX_AUTO_TRACE(logger_); smart_objects::SmartObject& msg_params = (*message_)[strings::msg_params]; - SendHMIRequest(hmi_apis::FunctionID::UI_SendHapticData, &msg_params, true); + + ApplicationSharedPtr app = application_manager_.application(connection_key()); + + if (!app) { + LOG4CXX_ERROR(logger_, "Application is not registered"); + SendResponse(false, mobile_apis::Result::APPLICATION_NOT_REGISTERED); + return; + } + + if (app->is_navi() || app->mobile_projection_enabled()) { + SendHMIRequest(hmi_apis::FunctionID::UI_SendHapticData, &msg_params, true); + } else { + SendResponse(false, + mobile_apis::Result::DISALLOWED, + "Application is not of type Navigation or Mobile Projection"); + } } void SendHapticDataRequest::on_event(const event_engine::Event& event) { diff --git a/src/components/application_manager/src/commands/mobile/subscribe_vehicle_data_request.cc b/src/components/application_manager/src/commands/mobile/subscribe_vehicle_data_request.cc index fc839a43f4..28651cded4 100644 --- a/src/components/application_manager/src/commands/mobile/subscribe_vehicle_data_request.cc +++ b/src/components/application_manager/src/commands/mobile/subscribe_vehicle_data_request.cc @@ -250,6 +250,15 @@ void SubscribeVehicleDataRequest::on_event(const event_engine::Event& event) { result_code = mobile_apis::Result::IGNORED; response_info = "Already subscribed on some provided VehicleData."; } + + if (!vi_waiting_for_subscribe_.empty()) { + LOG4CXX_DEBUG(logger_, "Subscribing to all pending VehicleData"); + VehicleInfoSubscriptions::const_iterator key = + vi_waiting_for_subscribe_.begin(); + for (; key != vi_waiting_for_subscribe_.end(); ++key) { + app->SubscribeToIVI(*key); + } + } } UnsubscribeFailedSubscriptions(app, message[strings::msg_params]); @@ -407,12 +416,13 @@ void SubscribeVehicleDataRequest::CheckVISubscribtions( out_request_params[key_name] = is_key_enabled; - if (app->SubscribeToIVI(static_cast<uint32_t>(key_type))) { + if (is_key_enabled) { + vi_waiting_for_subscribe_.insert(key_type); LOG4CXX_DEBUG( logger_, "App with connection key " << connection_key() - << " have been subscribed for VehicleDataType: " << key_type); + << " will be subscribed for VehicleDataType: " << key_type); ++subscribed_items; } } diff --git a/src/components/application_manager/src/hmi_capabilities_impl.cc b/src/components/application_manager/src/hmi_capabilities_impl.cc index 1c6e439ee8..e39b728155 100644 --- a/src/components/application_manager/src/hmi_capabilities_impl.cc +++ b/src/components/application_manager/src/hmi_capabilities_impl.cc @@ -391,6 +391,7 @@ HMICapabilitiesImpl::HMICapabilitiesImpl(ApplicationManager& app_mngr) , is_navigation_supported_(false) , is_phone_call_supported_(false) , is_video_streaming_supported_(false) + , is_rc_supported_(false) , navigation_capability_(NULL) , phone_capability_(NULL) , video_streaming_capability_(NULL) @@ -650,6 +651,10 @@ void HMICapabilitiesImpl::set_video_streaming_supported(const bool supported) { is_video_streaming_supported_ = supported; } +void HMICapabilitiesImpl::set_rc_supported(const bool supported) { + is_rc_supported_ = supported; +} + void HMICapabilitiesImpl::set_navigation_capability( const smart_objects::SmartObject& navigation_capability) { if (navigation_capability_) { @@ -803,6 +808,10 @@ bool HMICapabilitiesImpl::video_streaming_supported() const { return is_video_streaming_supported_; } +bool HMICapabilitiesImpl::rc_supported() const { + return is_rc_supported_; +} + const smart_objects::SmartObject* HMICapabilitiesImpl::navigation_capability() const { return navigation_capability_; @@ -1076,6 +1085,9 @@ bool HMICapabilitiesImpl::load_capabilities_from_file() { Formatters::CFormatterJsonBase::jsonValueToObj( navigation_capability, navigation_capability_so); set_navigation_capability(navigation_capability_so); + if (!navigation_capability_so.empty()) { + set_navigation_supported(true); + } } if (check_existing_json_member(system_capabilities, "phoneCapability")) { @@ -1085,6 +1097,9 @@ bool HMICapabilitiesImpl::load_capabilities_from_file() { Formatters::CFormatterJsonBase::jsonValueToObj(phone_capability, phone_capability_so); set_phone_capability(phone_capability_so); + if (!phone_capability_so.empty()) { + set_phone_call_supported(true); + } } if (check_existing_json_member(system_capabilities, "videoStreamingCapability")) { @@ -1132,6 +1147,9 @@ bool HMICapabilitiesImpl::load_capabilities_from_file() { vs_capability_so["supportedFormats"] = converted_array; } set_video_streaming_capability(vs_capability_so); + if (!vs_capability_so.empty()) { + set_video_streaming_supported(true); + } } if (check_existing_json_member(system_capabilities, "remoteControlCapability")) { @@ -1141,6 +1159,9 @@ bool HMICapabilitiesImpl::load_capabilities_from_file() { Formatters::CFormatterJsonBase::jsonValueToObj(rc_capability, rc_capability_so); set_rc_capability(rc_capability_so); + if (!rc_capability_so.empty()) { + set_rc_supported(true); + } } } } // UI end diff --git a/src/components/application_manager/src/mobile_message_handler.cc b/src/components/application_manager/src/mobile_message_handler.cc index 0d66161f00..bc3aa32731 100644 --- a/src/components/application_manager/src/mobile_message_handler.cc +++ b/src/components/application_manager/src/mobile_message_handler.cc @@ -196,6 +196,8 @@ MobileMessageHandler::HandleIncomingMessageProtocolV2( outgoing_message->set_payload_size(message->payload_size()); if (!payload.data.empty()) { + BinaryData binary_payload_data(payload.data); + outgoing_message->set_binary_data(&binary_payload_data); outgoing_message->set_binary_data(&payload.data); } return outgoing_message.release(); diff --git a/src/components/application_manager/src/policies/policy_handler.cc b/src/components/application_manager/src/policies/policy_handler.cc index ad21f533a1..e6ebaf3b83 100644 --- a/src/components/application_manager/src/policies/policy_handler.cc +++ b/src/components/application_manager/src/policies/policy_handler.cc @@ -808,17 +808,17 @@ bool PolicyHandler::IsAppSuitableForPolicyUpdate( const Applications::value_type value) const { LOG4CXX_AUTO_TRACE(logger_); - const uint32_t app_id = value->app_id(); - if (!value->IsRegistered()) { LOG4CXX_DEBUG(logger_, - "Application " << app_id << " is not marked as registered."); + "Application " << value->app_id() + << " is not marked as registered."); return false; } LOG4CXX_DEBUG(logger_, - "Application " << app_id << " marked as registered." - "Checking its parameters."); + "Application " << value->app_id() + << " marked as registered." + "Checking its parameters."); DeviceParams device_params = GetDeviceParams( value->device(), diff --git a/src/components/application_manager/src/resumption/resumption_sql_queries.cc b/src/components/application_manager/src/resumption/resumption_sql_queries.cc index 5f318e6955..7a5008542c 100644 --- a/src/components/application_manager/src/resumption/resumption_sql_queries.cc +++ b/src/components/application_manager/src/resumption/resumption_sql_queries.cc @@ -212,7 +212,7 @@ const std::string kCreateSchema = "`vrHelpItemArray`(`idglobalProperties`); " "CREATE TABLE IF NOT EXISTS `application`( " " `idApplication` INTEGER PRIMARY KEY NOT NULL, " - " `appID` TEXT, " + " `appID` TEXT COLLATE NOCASE, " " `connection_key` INTEGER, " " `grammarID` INTEGER, " " `hashID` TEXT, " diff --git a/src/components/application_manager/src/smart_object_keys.cc b/src/components/application_manager/src/smart_object_keys.cc index 45bab026b4..0bf3287e42 100644 --- a/src/components/application_manager/src/smart_object_keys.cc +++ b/src/components/application_manager/src/smart_object_keys.cc @@ -234,6 +234,7 @@ const char* hmi_capabilities = "hmiCapabilities"; const char* navigation = "navigation"; const char* phone_call = "phoneCall"; const char* video_streaming = "videoStreaming"; +const char* remote_control = "remoteControl"; const char* sdl_version = "sdlVersion"; const char* system_software_version = "systemSoftwareVersion"; const char* priority = "priority"; diff --git a/src/components/application_manager/test/CMakeLists.txt b/src/components/application_manager/test/CMakeLists.txt index 089f8fd25e..0580998e84 100644 --- a/src/components/application_manager/test/CMakeLists.txt +++ b/src/components/application_manager/test/CMakeLists.txt @@ -143,6 +143,8 @@ set(ResumptionData_SOURCES ) file(COPY hmi_capabilities.json DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) +file(COPY hmi_capabilities_sc1.json DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) +file(COPY hmi_capabilities_sc2.json DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) file(COPY smartDeviceLink_test.ini DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/resumption) diff --git a/src/components/application_manager/test/commands/hmi/rc_get_capabilities_response_test.cc b/src/components/application_manager/test/commands/hmi/rc_get_capabilities_response_test.cc index f851bd644a..90be018e74 100644 --- a/src/components/application_manager/test/commands/hmi/rc_get_capabilities_response_test.cc +++ b/src/components/application_manager/test/commands/hmi/rc_get_capabilities_response_test.cc @@ -87,6 +87,78 @@ class RCGetCapabilitiesResponseTest TEST_F(RCGetCapabilitiesResponseTest, RUN_SUCCESSS) { MessageSharedPtr command_msg = CreateCommandMsg(); + (*command_msg)[strings::msg_params][strings::system_capabilities] = + smart_objects::SmartObject(smart_objects::SmartType_Map); + + (*command_msg)[strings::msg_params][strings::system_capabilities] + [strings::rc_capability] = + smart_objects::SmartObject(smart_objects::SmartType_Map); + smart_objects::SmartObject& remote_control_capability = + (*command_msg)[strings::msg_params][strings::system_capabilities] + [strings::rc_capability]; + + remote_control_capability["climateControlCapabilities"] = + smart_objects::SmartObject(smart_objects::SmartType_Array); + + remote_control_capability["climateControlCapabilities"][0] = + smart_objects::SmartObject(smart_objects::SmartType_Map); + + smart_objects::SmartObject& climate_control_capability = + remote_control_capability["climateControlCapabilities"][0]; + + climate_control_capability["moduleName"] = "Climate"; + climate_control_capability["fanSpeedAvailable"] = true; + climate_control_capability["desiredTemperatureAvailable"] = true; + climate_control_capability["acEnableAvailable"] = true; + climate_control_capability["acMaxEnableAvailable"] = true; + climate_control_capability["circulateAirEnableAvailable"] = true; + climate_control_capability["autoModeEnableAvailable"] = true; + climate_control_capability["dualModeEnableAvailable"] = true; + + climate_control_capability["defrostZoneAvailable"] = true; + climate_control_capability["defrostZone"] = + smart_objects::SmartObject(smart_objects::SmartType_Array); + climate_control_capability["defrostZone"][0] = "ALL"; + + climate_control_capability["ventilationModeAvailable"] = true; + climate_control_capability["ventilationMode"] = + smart_objects::SmartObject(smart_objects::SmartType_Array); + climate_control_capability["ventilationMode"][0] = "BOTH"; + + remote_control_capability["radioControlCapabilities"] = + smart_objects::SmartObject(smart_objects::SmartType_Array); + + remote_control_capability["radioControlCapabilities"][0] = + smart_objects::SmartObject(smart_objects::SmartType_Map); + + smart_objects::SmartObject& radio_control_capability = + remote_control_capability["radioControlCapabilities"][0]; + + radio_control_capability["moduleName"] = "Radio"; + radio_control_capability["radioEnableAvailable"] = true; + radio_control_capability["radioBandAvailable"] = true; + radio_control_capability["radioFrequencyAvailable"] = true; + radio_control_capability["hdChannelAvailable"] = true; + radio_control_capability["rdsDataAvailable"] = true; + radio_control_capability["availableHDsAvailable"] = true; + radio_control_capability["stateAvailable"] = true; + radio_control_capability["signalStrengthAvailable"] = true; + radio_control_capability["signalChangeThresholdAvailable"] = true; + + remote_control_capability[hmi_response::button_capabilities] = + smart_objects::SmartObject(smart_objects::SmartType_Array); + + remote_control_capability[hmi_response::button_capabilities][0] = + smart_objects::SmartObject(smart_objects::SmartType_Map); + + smart_objects::SmartObject& button_capability = + remote_control_capability[hmi_response::button_capabilities][0]; + + button_capability[strings::button_name] = "OK"; + button_capability["shortPressAvailable"] = true; + button_capability["longPressAvailable"] = true; + button_capability["upDownAvailable"] = true; + RCGetCapabilitiesResponsePtr command( CreateCommand<RCGetCapabilitiesResponse>(command_msg)); @@ -97,6 +169,7 @@ TEST_F(RCGetCapabilitiesResponseTest, RUN_SUCCESSS) { (*command_msg)[strings::msg_params][strings::rc_capability]; EXPECT_CALL(mock_hmi_capabilities_, set_rc_capability(rc_capability_so)); + EXPECT_CALL(mock_hmi_capabilities_, set_rc_supported(true)); command->Run(); } diff --git a/src/components/application_manager/test/commands/hmi/rc_is_ready_request_test.cc b/src/components/application_manager/test/commands/hmi/rc_is_ready_request_test.cc index af54321ca7..27a77ba990 100644 --- a/src/components/application_manager/test/commands/hmi/rc_is_ready_request_test.cc +++ b/src/components/application_manager/test/commands/hmi/rc_is_ready_request_test.cc @@ -79,6 +79,9 @@ class RCIsReadyRequestTest } EXPECT_CALL(mock_hmi_capabilities_, set_is_rc_cooperating(is_rc_cooperating_available)); + if (!is_rc_cooperating_available) { + EXPECT_CALL(mock_hmi_capabilities_, set_rc_supported(false)); + } if (is_message_contain_param) { EXPECT_CALL(app_mngr_, hmi_interfaces()) diff --git a/src/components/application_manager/test/commands/mobile/alert_maneuver_request_test.cc b/src/components/application_manager/test/commands/mobile/alert_maneuver_request_test.cc index ee0662e5c6..9a101e6352 100644 --- a/src/components/application_manager/test/commands/mobile/alert_maneuver_request_test.cc +++ b/src/components/application_manager/test/commands/mobile/alert_maneuver_request_test.cc @@ -59,6 +59,7 @@ namespace alert_maneuver_request { using ::testing::_; using ::testing::Return; using ::testing::ReturnRef; +using ::testing::Mock; namespace am = ::application_manager; using am::commands::AlertManeuverRequest; using am::commands::MessageSharedPtr; @@ -70,6 +71,9 @@ typedef SharedPtr<AlertManeuverRequest> CommandPtr; class AlertManeuverRequestTest : public CommandRequestTest<CommandsTestMocks::kIsNice> { public: + AlertManeuverRequestTest() + : mock_message_helper_(*MockMessageHelper::message_helper_mock()) {} + void CheckExpectations(const hmi_apis::Common_Result::eType hmi_response, const mobile_apis::Result::eType mobile_response, const am::HmiInterfaces::InterfaceState state, @@ -87,10 +91,10 @@ class AlertManeuverRequestTest MockAppPtr mock_app(CreateMockApp()); ON_CALL(app_mngr_, application(_)).WillByDefault(Return(mock_app)); - MockMessageHelper* mock_message_helper = - MockMessageHelper::message_helper_mock(); - EXPECT_CALL(*mock_message_helper, HMIToMobileResult(_)) - .WillOnce(Return(mobile_apis::Result::UNSUPPORTED_RESOURCE)); + if (hmi_apis::Common_Result::UNSUPPORTED_RESOURCE != hmi_response) { + EXPECT_CALL(mock_message_helper_, HMIToMobileResult(hmi_response)) + .WillOnce(Return(mobile_response)); + } EXPECT_CALL(mock_hmi_interfaces_, GetInterfaceState(_)) .WillRepeatedly(Return(state)); @@ -112,7 +116,16 @@ class AlertManeuverRequestTest static_cast<int32_t>(mobile_response)); } + void SetUp() OVERRIDE { + Mock::VerifyAndClearExpectations(&mock_message_helper_); + } + + void TearDown() OVERRIDE { + Mock::VerifyAndClearExpectations(&mock_message_helper_); + } + protected: + MockMessageHelper& mock_message_helper_; NiceMock<policy_test::MockPolicyHandlerInterface> policy_interface_; }; @@ -237,30 +250,30 @@ TEST_F(AlertManeuverRequestTest, OnEvent_ReceivedUnknownEvent_UNSUCCESS) { .asInt())); } -TEST_F(AlertManeuverRequestTest, OnEvent_UNSUPPORTED_RESOURCE_Case1) { +TEST_F(AlertManeuverRequestTest, OnEvent_SUCCESS) { CheckExpectations(hmi_apis::Common_Result::SUCCESS, - mobile_apis::Result::UNSUPPORTED_RESOURCE, + mobile_apis::Result::SUCCESS, am::HmiInterfaces::STATE_AVAILABLE, true); } -TEST_F(AlertManeuverRequestTest, OnEvent_UNSUPPORTED_RESOURCE_Case2) { - CheckExpectations(hmi_apis::Common_Result::SUCCESS, +TEST_F(AlertManeuverRequestTest, OnEvent_UNSUPPORTED_RESOURCE) { + CheckExpectations(hmi_apis::Common_Result::UNSUPPORTED_RESOURCE, mobile_apis::Result::UNSUPPORTED_RESOURCE, - am::HmiInterfaces::STATE_NOT_AVAILABLE, - true); + am::HmiInterfaces::STATE_AVAILABLE, + false); } -TEST_F(AlertManeuverRequestTest, OnEvent_UNSUPPORTED_RESOURCE_Case3) { - CheckExpectations(hmi_apis::Common_Result::SUCCESS, - mobile_apis::Result::UNSUPPORTED_RESOURCE, +TEST_F(AlertManeuverRequestTest, OnEvent_WARNINGS) { + CheckExpectations(hmi_apis::Common_Result::WARNINGS, + mobile_apis::Result::WARNINGS, am::HmiInterfaces::STATE_NOT_RESPONSE, true); } -TEST_F(AlertManeuverRequestTest, OnEvent_UNSUPPORTED_RESOURCE_Case4) { +TEST_F(AlertManeuverRequestTest, OnEvent_GENERIC_ERROR) { CheckExpectations(hmi_apis::Common_Result::GENERIC_ERROR, - mobile_apis::Result::UNSUPPORTED_RESOURCE, + mobile_apis::Result::GENERIC_ERROR, am::HmiInterfaces::STATE_NOT_RESPONSE, false); } diff --git a/src/components/application_manager/test/commands/mobile/change_registration_test.cc b/src/components/application_manager/test/commands/mobile/change_registration_test.cc index 2fd43a6353..cbf8ce1abe 100644 --- a/src/components/application_manager/test/commands/mobile/change_registration_test.cc +++ b/src/components/application_manager/test/commands/mobile/change_registration_test.cc @@ -80,7 +80,6 @@ namespace strings = ::application_manager::strings; namespace hmi_response = ::application_manager::hmi_response; namespace { -const int32_t kCommandId = 1; const uint32_t kAppId = 1u; const uint32_t kCmdId = 1u; const uint32_t kConnectionKey = 2u; @@ -391,7 +390,7 @@ TEST_F(ChangeRegistrationRequestTest, CheckExpectations(hmi_apis::Common_Result::UNSUPPORTED_RESOURCE, mobile_apis::Result::UNSUPPORTED_RESOURCE, am::HmiInterfaces::STATE_NOT_RESPONSE, - false); + true); } TEST_F(ChangeRegistrationRequestTest, @@ -399,7 +398,7 @@ TEST_F(ChangeRegistrationRequestTest, CheckExpectations(hmi_apis::Common_Result::UNSUPPORTED_RESOURCE, mobile_apis::Result::UNSUPPORTED_RESOURCE, am::HmiInterfaces::STATE_AVAILABLE, - false); + true); } TEST_F(ChangeRegistrationRequestTest, @@ -407,7 +406,7 @@ TEST_F(ChangeRegistrationRequestTest, CheckExpectations(hmi_apis::Common_Result::UNSUPPORTED_RESOURCE, mobile_apis::Result::UNSUPPORTED_RESOURCE, am::HmiInterfaces::STATE_AVAILABLE, - false, + true, hmi_apis::Common_Result::SUCCESS, hmi_apis::Common_Result::SUCCESS); } diff --git a/src/components/application_manager/test/commands/mobile/send_haptic_data_test.cc b/src/components/application_manager/test/commands/mobile/send_haptic_data_test.cc index 49483209b6..2a3b5d922a 100644 --- a/src/components/application_manager/test/commands/mobile/send_haptic_data_test.cc +++ b/src/components/application_manager/test/commands/mobile/send_haptic_data_test.cc @@ -95,6 +95,11 @@ class SendHapticDataResponseTest }; TEST_F(SendHapticDataRequestTest, Run_SUCCESS) { + EXPECT_CALL(app_mngr_, application(kConnectionKey)) + .WillOnce(Return(mock_app_)); + + EXPECT_CALL(*mock_app_, is_navi()).WillOnce(Return(true)); + EXPECT_CALL(app_mngr_, ManageHMICommand( HMIResultCodeIs(hmi_apis::FunctionID::UI_SendHapticData))) @@ -106,6 +111,22 @@ TEST_F(SendHapticDataRequestTest, Run_SUCCESS) { command->Run(); } +TEST_F(SendHapticDataRequestTest, Run_DISALLOWED) { + EXPECT_CALL(app_mngr_, application(kConnectionKey)) + .WillOnce(Return(mock_app_)); + + EXPECT_CALL(*mock_app_, is_navi()).WillOnce(Return(false)); + + EXPECT_CALL(*mock_app_, mobile_projection_enabled()).WillOnce(Return(false)); + + EXPECT_CALL(app_mngr_, ManageMobileCommand(_, _)).WillOnce(Return(true)); + + SendHapticDataRequestPtr command(CreateCommand<SendHapticDataRequest>(msg_)); + + command->Init(); + command->Run(); +} + TEST_F(SendHapticDataRequestTest, OnEvent_SUCCESS) { EXPECT_CALL( app_mngr_, diff --git a/src/components/application_manager/test/commands/mobile/set_media_clock_timer_test.cc b/src/components/application_manager/test/commands/mobile/set_media_clock_timer_test.cc index 3056d0e9fc..d91087acae 100644 --- a/src/components/application_manager/test/commands/mobile/set_media_clock_timer_test.cc +++ b/src/components/application_manager/test/commands/mobile/set_media_clock_timer_test.cc @@ -329,10 +329,11 @@ TEST_F(SetMediaClockRequestTest, OnEvent_Success) { MessageSharedPtr msg = CreateMessage(); (*msg)[am::strings::params][am::hmi_response::code] = mobile_apis::Result::SUCCESS; - (*msg)[am::strings::msg_params] = SmartObject(smart_objects::SmartType_Null); + (*msg)[am::strings::msg_params] = SmartObject(smart_objects::SmartType_Map); - SharedPtr<SetMediaClockRequest> command( - CreateCommand<SetMediaClockRequest>(msg)); + EXPECT_CALL(mock_message_helper_, + HMIToMobileResult(hmi_apis::Common_Result::SUCCESS)) + .WillOnce(Return(mobile_apis::Result::SUCCESS)); EXPECT_CALL(app_mngr_, ManageMobileCommand(_, _)); @@ -342,6 +343,8 @@ TEST_F(SetMediaClockRequestTest, OnEvent_Success) { Event event(hmi_apis::FunctionID::UI_SetMediaClockTimer); event.set_smart_object(*msg); + SharedPtr<SetMediaClockRequest> command( + CreateCommand<SetMediaClockRequest>(msg)); command->on_event(event); } diff --git a/src/components/application_manager/test/commands/mobile/show_test.cc b/src/components/application_manager/test/commands/mobile/show_test.cc index 29ab902f5c..d1e3c14181 100644 --- a/src/components/application_manager/test/commands/mobile/show_test.cc +++ b/src/components/application_manager/test/commands/mobile/show_test.cc @@ -720,6 +720,7 @@ TEST_F(ShowRequestTest, Run_MainField4_MetadataTag) { } TEST_F(ShowRequestTest, Run_MainField1_MetadataTagWithNoFieldData) { + Mock::VerifyAndClearExpectations(&mock_message_helper_); MessageSharedPtr msg = CreateMsgParams(); SharedPtr<ShowRequest> command(CreateCommand<ShowRequest>(msg)); @@ -744,6 +745,10 @@ TEST_F(ShowRequestTest, Run_MainField1_MetadataTagWithNoFieldData) { Event event(hmi_apis::FunctionID::UI_Show); event.set_smart_object(*ev_msg); + EXPECT_CALL(mock_message_helper_, + HMIToMobileResult(hmi_apis::Common_Result::SUCCESS)) + .WillOnce(Return(mobile_apis::Result::SUCCESS)); + MessageSharedPtr ui_command_result; EXPECT_CALL( app_mngr_, @@ -759,6 +764,8 @@ TEST_F(ShowRequestTest, Run_MainField1_MetadataTagWithNoFieldData) { (*ui_command_result)[am::strings::msg_params][am::strings::result_code] .asInt(), static_cast<int32_t>(mobile_apis::Result::WARNINGS)); + + Mock::VerifyAndClearExpectations(&mock_message_helper_); } TEST_F(ShowRequestTest, Run_MediaClock_SUCCESS) { diff --git a/src/components/application_manager/test/hmi_capabilities_sc1.json b/src/components/application_manager/test/hmi_capabilities_sc1.json new file mode 100644 index 0000000000..3731f8eb78 --- /dev/null +++ b/src/components/application_manager/test/hmi_capabilities_sc1.json @@ -0,0 +1,9 @@ +{ + "UI": { + "systemCapabilities": { + "phoneCapability": { + "dialNumberEnabled": true + } + } + } +} diff --git a/src/components/application_manager/test/hmi_capabilities_sc2.json b/src/components/application_manager/test/hmi_capabilities_sc2.json new file mode 100644 index 0000000000..a8578f04f5 --- /dev/null +++ b/src/components/application_manager/test/hmi_capabilities_sc2.json @@ -0,0 +1,14 @@ +{ + "UI": { + "systemCapabilities": { + "navigationCapability": { + "sendLocationEnabled": true, + "getWayPointsEnabled": false + }, + "phoneCapability": { + }, + "videoStreamingCapability": { + } + } + } +} diff --git a/src/components/application_manager/test/hmi_capabilities_test.cc b/src/components/application_manager/test/hmi_capabilities_test.cc index 5c3830d5a5..b8369528aa 100644 --- a/src/components/application_manager/test/hmi_capabilities_test.cc +++ b/src/components/application_manager/test/hmi_capabilities_test.cc @@ -375,12 +375,17 @@ TEST_F(HMICapabilitiesTest, LoadCapabilitiesFromFile) { EXPECT_TRUE(navigation_capability_so["sendLocationEnabled"].asBool()); EXPECT_TRUE(navigation_capability_so["getWayPointsEnabled"].asBool()); + // since we have navigation capabilities, the feature should be supported + EXPECT_TRUE(hmi_capabilities_test->navigation_supported()); + const smart_objects::SmartObject phone_capability_so = *(hmi_capabilities_test->phone_capability()); EXPECT_TRUE(phone_capability_so.keyExists("dialNumberEnabled")); EXPECT_TRUE(phone_capability_so["dialNumberEnabled"].asBool()); + EXPECT_TRUE(hmi_capabilities_test->phone_call_supported()); + const smart_objects::SmartObject vs_capability_so = *(hmi_capabilities_test->video_streaming_capability()); @@ -428,6 +433,8 @@ TEST_F(HMICapabilitiesTest, LoadCapabilitiesFromFile) { EXPECT_TRUE( vs_capability_so[strings::haptic_spatial_data_supported].asBool()); + EXPECT_TRUE(hmi_capabilities_test->video_streaming_supported()); + // Check remote control capabilites const smart_objects::SmartObject rc_capability_so = *(hmi_capabilities_test->rc_capability()); @@ -469,6 +476,89 @@ TEST_F(HMICapabilitiesTest, LoadCapabilitiesFromFile) { rc_capability_so["buttonCapabilities"][0]["upDownAvailable"].asBool()); } +TEST_F(HMICapabilitiesTest, + LoadCapabilitiesFromFileAndVerifyUnsupportedSystemCapabilities) { + MockApplicationManager mock_app_mngr; + event_engine_test::MockEventDispatcher mock_dispatcher; + MockApplicationManagerSettings mock_application_manager_settings; + + const std::string hmi_capabilities_file = "hmi_capabilities_sc1.json"; + + EXPECT_CALL(mock_app_mngr, event_dispatcher()) + .WillOnce(ReturnRef(mock_dispatcher)); + EXPECT_CALL(mock_app_mngr, get_settings()) + .WillRepeatedly(ReturnRef(mock_application_manager_settings)); + EXPECT_CALL(mock_application_manager_settings, hmi_capabilities_file_name()) + .WillOnce(ReturnRef(hmi_capabilities_file)); + EXPECT_CALL(mock_dispatcher, add_observer(_, _, _)).Times(1); + EXPECT_CALL(mock_dispatcher, remove_observer(_)).Times(1); + EXPECT_CALL(mock_application_manager_settings, launch_hmi()) + .WillOnce(Return(false)); + + if (file_system::FileExists("./app_info_data")) { + EXPECT_TRUE(::file_system::DeleteFile("./app_info_data")); + } + + utils::SharedPtr<HMICapabilitiesForTesting> hmi_capabilities = + utils::MakeShared<HMICapabilitiesForTesting>(mock_app_mngr); + hmi_capabilities->Init(&last_state_); + + // Check system capabilities; only phone capability is available + EXPECT_FALSE(hmi_capabilities->navigation_supported()); + EXPECT_TRUE(hmi_capabilities->phone_call_supported()); + EXPECT_FALSE(hmi_capabilities->video_streaming_supported()); + EXPECT_FALSE(hmi_capabilities->rc_supported()); + + // verify phone capability + const smart_objects::SmartObject phone_capability_so = + *(hmi_capabilities->phone_capability()); + EXPECT_TRUE(phone_capability_so.keyExists("dialNumberEnabled")); + EXPECT_TRUE(phone_capability_so["dialNumberEnabled"].asBool()); +} + +TEST_F(HMICapabilitiesTest, + LoadCapabilitiesFromFileAndVerifyEmptySystemCapabilities) { + MockApplicationManager mock_app_mngr; + event_engine_test::MockEventDispatcher mock_dispatcher; + MockApplicationManagerSettings mock_application_manager_settings; + + const std::string hmi_capabilities_file = "hmi_capabilities_sc2.json"; + + EXPECT_CALL(mock_app_mngr, event_dispatcher()) + .WillOnce(ReturnRef(mock_dispatcher)); + EXPECT_CALL(mock_app_mngr, get_settings()) + .WillRepeatedly(ReturnRef(mock_application_manager_settings)); + EXPECT_CALL(mock_application_manager_settings, hmi_capabilities_file_name()) + .WillOnce(ReturnRef(hmi_capabilities_file)); + EXPECT_CALL(mock_dispatcher, add_observer(_, _, _)).Times(1); + EXPECT_CALL(mock_dispatcher, remove_observer(_)).Times(1); + EXPECT_CALL(mock_application_manager_settings, launch_hmi()) + .WillOnce(Return(false)); + + if (file_system::FileExists("./app_info_data")) { + EXPECT_TRUE(::file_system::DeleteFile("./app_info_data")); + } + + utils::SharedPtr<HMICapabilitiesForTesting> hmi_capabilities = + utils::MakeShared<HMICapabilitiesForTesting>(mock_app_mngr); + hmi_capabilities->Init(&last_state_); + + // Check system capabilities; only navigation capability is valid, the other + // two are empty + EXPECT_TRUE(hmi_capabilities->navigation_supported()); + EXPECT_FALSE(hmi_capabilities->phone_call_supported()); + EXPECT_FALSE(hmi_capabilities->video_streaming_supported()); + EXPECT_FALSE(hmi_capabilities->rc_supported()); + + // verify navigation capabilities + smart_objects::SmartObject navigation_capability_so = + *(hmi_capabilities->navigation_capability()); + EXPECT_TRUE(navigation_capability_so.keyExists("sendLocationEnabled")); + EXPECT_TRUE(navigation_capability_so.keyExists("getWayPointsEnabled")); + EXPECT_TRUE(navigation_capability_so["sendLocationEnabled"].asBool()); + EXPECT_FALSE(navigation_capability_so["getWayPointsEnabled"].asBool()); +} + TEST_F(HMICapabilitiesTest, VerifyImageType) { const int32_t image_type = 1; smart_objects::SmartObject sm_obj; diff --git a/src/components/application_manager/test/include/application_manager/mock_hmi_capabilities.h b/src/components/application_manager/test/include/application_manager/mock_hmi_capabilities.h index dd7ec5f0d5..468bdbe5eb 100644 --- a/src/components/application_manager/test/include/application_manager/mock_hmi_capabilities.h +++ b/src/components/application_manager/test/include/application_manager/mock_hmi_capabilities.h @@ -160,6 +160,9 @@ class MockHMICapabilities : public ::application_manager::HMICapabilities { MOCK_CONST_METHOD0(video_streaming_supported, bool()); MOCK_METHOD1(set_video_streaming_supported, void(const bool supported)); + MOCK_CONST_METHOD0(rc_supported, bool()); + MOCK_METHOD1(set_rc_supported, void(const bool supported)); + MOCK_CONST_METHOD0(navigation_capability, const smart_objects::SmartObject*()); MOCK_METHOD1(set_navigation_capability, diff --git a/src/components/application_manager/test/message_helper/CMakeLists.txt b/src/components/application_manager/test/message_helper/CMakeLists.txt index e4a77aa00a..ccf05fc1c9 100755 --- a/src/components/application_manager/test/message_helper/CMakeLists.txt +++ b/src/components/application_manager/test/message_helper/CMakeLists.txt @@ -49,8 +49,8 @@ set(LIBRARIES if(REMOTE_CONTROL) SET (LIBRARIES - ${LIBRARIES} FunctionalModule + ${LIBRARIES} ) endif(REMOTE_CONTROL) diff --git a/src/components/connection_handler/src/connection_handler_impl.cc b/src/components/connection_handler/src/connection_handler_impl.cc index 6dd4fe06d7..bd5b3d79bb 100644 --- a/src/components/connection_handler/src/connection_handler_impl.cc +++ b/src/components/connection_handler/src/connection_handler_impl.cc @@ -564,6 +564,7 @@ uint32_t ConnectionHandlerImpl::OnSessionEndedCallback( ConnectionList::iterator it = connection_list_.find(connection_handle); if (connection_list_.end() == it) { LOG4CXX_WARN(logger_, "Unknown connection!"); + connection_list_lock_.Release(); return 0; } std::pair<int32_t, Connection*> connection_item = *it; @@ -1122,6 +1123,7 @@ void ConnectionHandlerImpl::OnConnectionEnded( ConnectionList::iterator itr = connection_list_.find(connection_id); if (connection_list_.end() == itr) { LOG4CXX_ERROR(logger_, "Connection not found!"); + connection_list_lock_.Release(); return; } std::auto_ptr<Connection> connection(itr->second); diff --git a/src/components/functional_module/include/functional_module/generic_module.h b/src/components/functional_module/include/functional_module/generic_module.h index 0c686d3501..15d572be6d 100644 --- a/src/components/functional_module/include/functional_module/generic_module.h +++ b/src/components/functional_module/include/functional_module/generic_module.h @@ -143,10 +143,11 @@ class GenericModule { /** * @brief OnApplicationEvent Processes application related events * @param event Event - * @param application_id Application id + * @param application Pointer to application struct */ - virtual void OnApplicationEvent(ApplicationEvent event, - const uint32_t application_id) = 0; + virtual void OnApplicationEvent( + ApplicationEvent event, + application_manager::ApplicationSharedPtr application) = 0; /** * @brief OnPolicyEvent Processes policy related events diff --git a/src/components/functional_module/include/functional_module/plugin_manager.h b/src/components/functional_module/include/functional_module/plugin_manager.h index 1fb5ac9838..c573d843b2 100644 --- a/src/components/functional_module/include/functional_module/plugin_manager.h +++ b/src/components/functional_module/include/functional_module/plugin_manager.h @@ -130,10 +130,11 @@ class PluginManager : public ModuleObserver { /** * @brief OnApplicationEvent Notifies modules on certain application events * @param event Event - * @param application_id Application id of particular application + * @param application Pointer to application struct */ - void OnApplicationEvent(functional_modules::ApplicationEvent event, - const uint32_t application_id); + void OnApplicationEvent( + functional_modules::ApplicationEvent event, + application_manager::ApplicationSharedPtr application); /** * @brief OnPolicyEvent Notifies modules on certain events from policy diff --git a/src/components/functional_module/src/plugin_manager.cc b/src/components/functional_module/src/plugin_manager.cc index b38048f843..a32fdbf773 100644 --- a/src/components/functional_module/src/plugin_manager.cc +++ b/src/components/functional_module/src/plugin_manager.cc @@ -351,14 +351,14 @@ typedef std::map<ModuleID, ModulePtr>::value_type PluginsValueType; struct HandleApplicationEvent { private: const functional_modules::ApplicationEvent event_; - const uint32_t app_id_; + application_manager::ApplicationSharedPtr application_; public: HandleApplicationEvent(functional_modules::ApplicationEvent e, - const uint32_t app_id) - : event_(e), app_id_(app_id) {} + application_manager::ApplicationSharedPtr application) + : event_(e), application_(application) {} void operator()(PluginsValueType& p) { - p.second->OnApplicationEvent(event_, app_id_); + p.second->OnApplicationEvent(event_, application_); } }; @@ -374,11 +374,14 @@ struct HandlePolicyEvent { }; void PluginManager::OnApplicationEvent( - functional_modules::ApplicationEvent event, const uint32_t application_id) { + functional_modules::ApplicationEvent event, + application_manager::ApplicationSharedPtr application) { LOG4CXX_AUTO_TRACE(logger_); - std::for_each(plugins_.begin(), - plugins_.end(), - HandleApplicationEvent(event, application_id)); + if (application) { + std::for_each(plugins_.begin(), + plugins_.end(), + HandleApplicationEvent(event, application)); + } } void PluginManager::OnPolicyEvent(PolicyEvent event) { diff --git a/src/components/functional_module/test/include/driver_generic_module_test.h b/src/components/functional_module/test/include/driver_generic_module_test.h index 0d5aae1f37..23751f51c2 100644 --- a/src/components/functional_module/test/include/driver_generic_module_test.h +++ b/src/components/functional_module/test/include/driver_generic_module_test.h @@ -68,7 +68,7 @@ class DriverGenericModuleTest : public GenericModule { } void OnApplicationEvent(functional_modules::ApplicationEvent event, - const uint32_t application_id) {} + application_manager::ApplicationSharedPtr app) {} void OnPolicyEvent(functional_modules::PolicyEvent event) {} diff --git a/src/components/functional_module/test/plugins/mock_generic_module.h b/src/components/functional_module/test/plugins/mock_generic_module.h index 0139866d67..faea0f135d 100644 --- a/src/components/functional_module/test/plugins/mock_generic_module.h +++ b/src/components/functional_module/test/plugins/mock_generic_module.h @@ -63,7 +63,7 @@ class MockGenericModule : public GenericModule { MOCK_METHOD1(OnUnregisterApplication, void(const uint32_t app_id)); MOCK_METHOD2(OnApplicationEvent, void(functional_modules::ApplicationEvent event, - const uint32_t application_id)); + application_manager::ApplicationSharedPtr application)); MOCK_METHOD1(OnPolicyEvent, void(functional_modules::PolicyEvent event)); MOCK_METHOD0(RemoveAppExtensions, void()); }; diff --git a/src/components/functional_module/test/src/plugin_manager_test.cc b/src/components/functional_module/test/src/plugin_manager_test.cc index 5c251113a8..f99b8b798e 100644 --- a/src/components/functional_module/test/src/plugin_manager_test.cc +++ b/src/components/functional_module/test/src/plugin_manager_test.cc @@ -10,6 +10,7 @@ using application_manager::Message; using protocol_handler::MajorProtocolVersion; using application_manager::MockService; +using test::components::application_manager_test::MockApplication; using ::testing::NiceMock; using ::testing::Expectation; using ::testing::ReturnRef; @@ -76,11 +77,12 @@ TEST_F(PluginManagerTest, SDL_events_triggers_module) { app_events.push_back(ApplicationEvent::kApplicationExit); app_events.push_back(ApplicationEvent::kApplicationUnregistered); + application_manager::ApplicationSharedPtr dummy_ptr = + utils::MakeShared<MockApplication>(); std::vector<ApplicationEvent>::const_iterator ev = app_events.begin(); - const uint32_t kDummyAppId = 1; for (; app_events.end() != ev; ++ev) { - EXPECT_CALL(*module, OnApplicationEvent(*ev, kDummyAppId)); - manager->OnApplicationEvent(*ev, kDummyAppId); + EXPECT_CALL(*module, OnApplicationEvent(*ev, dummy_ptr)); + manager->OnApplicationEvent(*ev, dummy_ptr); } std::vector<PolicyEvent> policy_events; diff --git a/src/components/include/application_manager/hmi_capabilities.h b/src/components/include/application_manager/hmi_capabilities.h index fb40367b00..1283584ef8 100644 --- a/src/components/include/application_manager/hmi_capabilities.h +++ b/src/components/include/application_manager/hmi_capabilities.h @@ -427,6 +427,20 @@ class HMICapabilities { virtual bool video_streaming_supported() const = 0; /* + * @brief Interface to store whether HMI supports remote control + * + * @param supported Indicates whether remote control is supported by HMI + */ + virtual void set_rc_supported(const bool supported) = 0; + + /* + * @brief Retrieves whether HMI supports remote control + * + * @return TRUE if it supported, otherwise FALSE + */ + virtual bool rc_supported() const = 0; + + /* * @brief Interface used to store information regarding * the navigation "System Capability" * diff --git a/src/components/interfaces/HMI_API.xml b/src/components/interfaces/HMI_API.xml index 32360aa357..ab3933fc0f 100644 --- a/src/components/interfaces/HMI_API.xml +++ b/src/components/interfaces/HMI_API.xml @@ -37,7 +37,7 @@ <interfaces name="SmartDeviceLink HMI API"> -<interface name="Common" version="1.6.0" date="2017-04-27"> +<interface name="Common" version="1.7.0" date="2017-10-20"> <enum name="Result"> <element name="SUCCESS" value="0"/> @@ -2112,6 +2112,9 @@ <param name="phoneCall" type="Boolean" mandatory="false"> <description>Availability of build in phone. True: Available, False: Not Available</description> </param> + <param name="videoStreaming" type="Boolean" mandatory="false"> + <description>Availability of built-in video streaming. True: Available, False: Not Available</description> + </param> </struct> <struct name="AudioPassThruCapabilities"> @@ -2659,7 +2662,7 @@ </interface> -<interface name="Buttons" version="1.2.0" date="2017-04-27"> +<interface name="Buttons" version="1.3.0" date="2017-07-18"> <function name="GetCapabilities" messagetype="request"> <description>Method is invoked at system start-up. SDL requests the information about all supported hardware buttons and their capabilities</description> </function> @@ -2743,7 +2746,7 @@ </function> </interface> -<interface name="BasicCommunication" version="1.2.0" date="2017-04-27"> +<interface name="BasicCommunication" version="1.2.1" date="2017-08-02"> <function name="OnReady" messagetype="notification"> <description>HMI must notify SDL about its readiness to start communication. In fact, this has to be the first message between SDL and HMI.</description> </function> @@ -3349,7 +3352,7 @@ </function> </interface> -<interface name="UI" version="1.1.0" date="2017-04-27"> +<interface name="UI" version="1.2.0" date="2017-09-05"> <function name="Alert" messagetype="request"> <description>Request from SDL to show an alert message on the display.</description> <param name="alertStrings" type="Common.TextFieldStruct" mandatory="true" array="true" minsize="0" maxsize="3"> @@ -3861,7 +3864,7 @@ </function> </interface> -<interface name="Navigation" version="1.4.0" date="2017-04-27"> +<interface name="Navigation" version="1.5.0" date="2017-08-15"> <function name="IsReady" messagetype="request"> <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> @@ -4884,7 +4887,7 @@ </function> </interface> -<interface name="RC" version="1.1" date="2017-07-18"> +<interface name="RC" version="1.1.0" date="2017-07-18"> <function name="IsReady" messagetype="request"> <description>Method is invoked at system startup. Response should provide information about presence of any of remote controllable module and its readiness to cooperate with SDL.</description> </function> diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml index 73fe9f3d0c..a1c64aecda 100644 --- a/src/components/interfaces/MOBILE_API.xml +++ b/src/components/interfaces/MOBILE_API.xml @@ -1,6147 +1,6052 @@ -<?xml version="1.0" standalone="no"?>
-<?xml-stylesheet type="text/xml" href="protocol2html.xsl"?>
-
-<interface name="Ford Sync RAPI" version="4.4.0" date="2017-04-27">
-
- <enum name="Result" internal_scope="base">
- <element name="SUCCESS">
- <description>The request succeeded</description>
- </element>
- <element name="UNSUPPORTED_REQUEST">
- <description>The request is not supported by Sync</description>
- </element>
- <element name="UNSUPPORTED_RESOURCE">
- <description>
- A button that was requested for subscription is not supported under the current system.
- NOTE: could become a more generic UNSUPPORTED_RESOURCE by merging with VEHICLE_DATA_NOT_AVAILABLE.
- </description>
- </element>
- <element name="DISALLOWED">
- <description>RPC is not authorized in local policy table.</description>
- </element>
- <element name="REJECTED">
- <description>
- The requested command was rejected, e.g. because mobile app is in background and cannot perform any HMI commands.
- Or an HMI command (e.g. Speak) is rejected because a higher priority HMI command (e.g. Alert) is playing.
- </description>
- </element>
- <element name="ABORTED">
- <description>
- A command was aborted, for example due to user interaction (e.g. user pressed button).
- Or an HMI command (e.g. Speak) is aborted because a higher priority HMI command (e.g. Alert) was requested.
- </description>
- </element>
- <element name="IGNORED">
- <description>
- A command was ignored, because the intended result is already in effect.
- For example, SetMediaClockTimer was used to pause the media clock although the clock is paused already.
- NOTE: potentially replaces SUBSCRIBED_ALREADY
- </description>
- </element>
- <element name="RETRY">
- <description>The user interrupted the RPC (e.g. PerformAudioPassThru) and indicated to start over. Note, the app must issue the new RPC.</description>
- </element>
- <element name="IN_USE">
- <description>
- The data may not be changed, because it is currently in use.
- For example when trying to delete a command set that is currently involved in an interaction.
- </description>
- </element>
- <element name="VEHICLE_DATA_NOT_AVAILABLE">
- <description>The requested vehicle data is not available on this vehicle or is not published.</description>
- </element>
- <element name="TIMED_OUT">
- <description>Overlay reached the maximum timeout and closed.</description>
- </element>
- <element name="INVALID_DATA">
- <description>
- The data sent is invalid. For example:
- Invalid Json syntax
- Parameters out of bounds (number or enum range)
- Mandatory parameters not provided
- Parameter provided with wrong type
- Invalid characters
- Empty string
- </description>
- </element>
- <element name="CHAR_LIMIT_EXCEEDED"></element>
- <element name="INVALID_ID">
- <description>
- One of the provided IDs is not valid. For example
- This applies to CorrelationID, SubscriptionID, CommandID, MenuID, etc.
- </description>
- </element>
- <element name="DUPLICATE_NAME">
- <description>There was a conflict with an registered name (application or menu item) or vr command</description>
- </element>
- <element name="APPLICATION_NOT_REGISTERED">
- <description>An command can not be executed because no application has been registered with RegisterApplication.</description>
- </element>
- <element name="WRONG_LANGUAGE">
- <description>
- The requested language is currently not supported.
- Might be because of a mismatch of the currently active language on Sync and the requested language
- </description>
- </element>
- <element name="OUT_OF_MEMORY">
- <description>The system could not process the request because the necessary memory couldn't be allocated</description>
- </element>
- <element name="TOO_MANY_PENDING_REQUESTS">
- <description>There are too many requests pending (means, that the response has not been delivered, yet).</description>
- <designdescription>There may be a maximum of 1000 pending requests at a time.</designdescription>
- </element>
- <element name="TOO_MANY_APPLICATIONS">
- <description>There are already too many registered applications</description>
- </element>
- <element name="APPLICATION_REGISTERED_ALREADY">
- <description>RegisterApplication has been called again, after a RegisterApplication was successful before.</description>
- </element>
- <element name="WARNINGS">
- <description>The RPC (e.g. SubscribeVehicleData) executed successfully but one or more items have a warning or failure.</description>
- </element>
- <element name="GENERIC_ERROR">
- <description>Provided data is valid but something went wrong in the lower layers.</description>
- </element>
- <element name="USER_DISALLOWED">
- <description>RPC is included in a functional group explicitly blocked by the user.</description>
- </element>
- <element name="TRUNCATED_DATA">
- <description>The RPC (e.g. ReadDID) executed successfully but the data exceeded the platform maximum threshold and thus, only part of the data is available.</description>
- </element>
- <element name="UNSUPPORTED_VERSION">
- <description>Sync doesn't support the protocol that is requested by the mobile application</description>
- </element>
- <element name="VEHICLE_DATA_NOT_ALLOWED">
- <description>The user has turned off access to vehicle data, and it is globally unavailable to mobile applications.</description>
- </element>
- <element name="FILE_NOT_FOUND">
- <description>A specified file could not be found on Sync.</description>
- </element>
- <element name="CANCEL_ROUTE">
- <description>User selected to Cancel Route.</description>
- </element>
- <element name="SAVED">
- <description>The RPC (e.g. Slider) executed successfully and the user elected to save the current position / value.</description>
- </element>
- <element name="INVALID_CERT">
- <description>The certificate provided during authentication is invalid.</description>
- </element>
- <element name="EXPIRED_CERT">
- <description>The certificate provided during authentication is expired.</description>
- </element>
- <element name="RESUME_FAILED">
- <description>The provided hash ID does not match the hash of the current set of registered data or the core could not resume the previous data.</description>
- </element>
- <element name="DATA_NOT_AVAILABLE">
- <description>The requested data is not available on this vehicle or is not published for the connected app </description>
- </element>
- <element name="READ_ONLY">
- <description>The value being set is read only</description>
- </element>
- </enum>
-
- <enum name="ButtonPressMode">
- <element name="LONG">
- <description>
- A button was released, after it was pressed for a long time
- Actual timing is defined by Sync and may vary
- </description>
- </element>
- <element name="SHORT">
- <description>
- A button was released, after it was pressed for a short time
- Actual timing is defined by Sync and may vary
- </description>
- </element>
- </enum>
-
- <enum name="ButtonEventMode">
- <element name="BUTTONUP">
- <description>A button has been released up</description>
- </element>
- <element name="BUTTONDOWN">
- <description>A button has been pressed down</description>
- </element>
- </enum>
-
- <enum name="Language">
- <element name="EN-US" internal_name="EN_US">
- <description>English - US</description>
- </element>
- <element name="ES-MX" internal_name="ES_MX">
- <description>Spanish - Mexico</description>
- </element>
- <element name="FR-CA" internal_name="FR_CA">
- <description>French - Canada</description>
- </element>
- <element name="DE-DE" internal_name="DE_DE">
- <description>German - Germany</description>
- </element>
- <element name="ES-ES" internal_name="ES_ES">
- <description>Spanish - Spain</description>
- </element>
- <element name="EN-GB" internal_name="EN_GB">
- <description>English - GB</description>
- </element>
- <element name="RU-RU" internal_name="RU_RU">
- <description>Russian - Russia</description>
- </element>
- <element name="TR-TR" internal_name="TR_TR">
- <description>Turkish - Turkey</description>
- </element>
- <element name="PL-PL" internal_name="PL_PL">
- <description>Polish - Poland</description>
- </element>
- <element name="FR-FR" internal_name="FR_FR">
- <description>French - France</description>
- </element>
- <element name="IT-IT" internal_name="IT_IT">
- <description>Italian - Italy</description>
- </element>
- <element name="SV-SE" internal_name="SV_SE">
- <description>Swedish - Sweden</description>
- </element>
- <element name="PT-PT" internal_name="PT_PT">
- <description>Portuguese - Portugal</description>
- </element>
- <element name="NL-NL" internal_name="NL_NL">
- <description>Dutch (Standard) - Netherlands</description>
- </element>
- <element name="EN-AU" internal_name="EN_AU">
- <description>English - Australia</description>
- </element>
- <element name="ZH-CN" internal_name="ZH_CN">
- <description>Mandarin - China</description>
- </element>
- <element name="ZH-TW" internal_name="ZH_TW">
- <description>Mandarin - Taiwan</description>
- </element>
- <element name="JA-JP" internal_name="JA_JP">
- <description>Japanese - Japan</description>
- </element>
- <element name="AR-SA" internal_name="AR_SA">
- <description>Arabic - Saudi Arabia</description>
- </element>
- <element name="KO-KR" internal_name="KO_KR">
- <description>Korean - South Korea</description>
- </element>
- <element name="PT-BR" internal_name="PT_BR">
- <description>Portuguese - Brazil</description>
- </element>
- <element name="CS-CZ" internal_name="CS_CZ">
- <description>Czech - Czech Republic</description>
- </element>
- <element name="DA-DK" internal_name="DA_DK">
- <description>Danish - Denmark</description>
- </element>
- <element name="NO-NO" internal_name="NO_NO">
- <description>Norwegian - Norway</description>
- </element>
- <element name="NL-BE" internal_name="NL_BE">
- <description>Dutch (Flemish) - Belgium</description>
- </element>
- <element name="EL-GR" internal_name="EL_GR">
- <description>Greek - Greece</description>
- </element>
- <element name="HU-HU" internal_name="HU_HU">
- <description>Hungarian - Hungary</description>
- </element>
- <element name="FI-FI" internal_name="FI_FI">
- <description>Finnish - Finland</description>
- </element>
- <element name="SK-SK" internal_name="SK_SK">
- <description>Slovak - Slovakia</description>
- </element>
- <element name="EN-IN" internal_name="EN_IN">
- <description>English - India</description>
- </element>
- <element name="TH-TH" internal_name="TH_TH">
- <description>Thai - Thailand</description>
- </element>
- <element name="EN-SA" internal_name="EN_SA">
- <description>English - Middle East</description>
- </element>
- <element name="HE-IL" internal_name="HE_IL">
- <description>Hebrew - Israel</description>
- </element>
- <element name="RO-RO" internal_name="RO_RO">
- <description>Romanian - Romania</description>
- </element>
- <element name="UK-UA" internal_name="UK_UA">
- <description>Ukrainian - Ukraine</description>
- </element>
- <element name="ID-ID" internal_name="ID_ID">
- <description>Indonesian - Indonesia</description>
- </element>
- <element name="VI-VN" internal_name="VI_VN">
- <description>Vietnamese - Vietnam</description>
- </element>
- <element name="MS-MY" internal_name="MS_MY">
- <description>Malay - Malaysia</description>
- </element>
- <element name="HI-IN" internal_name="HI_IN">
- <description>Hindi - India</description>
- </element>
-</enum>
-
- <enum name="UpdateMode">
- <description>Describes how the media clock timer should behave on the platform</description>
- <element name="COUNTUP" />
- <description>Starts the media clock timer counting upwards, as in time elapsed.</description>
- <element name="COUNTDOWN" />
- <description>Starts the media clock timer counting downwards, as in time remaining.</description>
- <element name="PAUSE" />
- <description>Pauses the media clock timer</description>
- <element name="RESUME" />
- <description>Resume the media clock timer</description>
- <element name="CLEAR" />
- <description>Clears the media clock timer (previously done through Show->mediaClock)</description>
- </enum>
-
- <enum name="TimerMode">
- <element name="UP" />
- <description>Causes the media clock timer to update from 0:00 to a specified time</description>
- <element name="DOWN" />
- <description>Causes the media clock timer to update from a specified time to 0:00</description>
- <element name="NONE" />
- <description>Indicates to not use the media clock timer</description>
- </enum>
-
- <enum name="InteractionMode">
- <description>For application-requested interactions, this mode indicates the method in which the user is notified and uses the interaction.</description>
- <element name="MANUAL_ONLY" />
- <description>
- This mode causes the interaction to only occur on the display, meaning the choices are provided only via the display.
- Selections are made with the OK and Seek Right and Left, Tune Up and Down buttons.
- </description>
- <element name="VR_ONLY" />
- <description>
- This mode causes the interaction to only occur using V4.
- Selections are made by saying the command.
- </description>
- <element name="BOTH" />
- <description>
- This mode causes both a VR and display selection option for an interaction.
- Selections can be made either from the menu display or by speaking the command.
- </description>
- </enum>
-
- <enum name="LayoutMode">
- <description>For touchscreen interactions, the mode of how the choices are presented.</description>
- <element name="ICON_ONLY" />
- <description>
- This mode causes the interaction to display the previous set of choices as icons.
- </description>
- <element name="ICON_WITH_SEARCH" />
- <description>
- This mode causes the interaction to display the previous set of choices as icons along with a search field in the HMI.
- </description>
- <element name="LIST_ONLY" />
- <description>
- This mode causes the interaction to display the previous set of choices as a list.
- </description>
- <element name="LIST_WITH_SEARCH" />
- <description>
- This mode causes the interaction to display the previous set of choices as a list along with a search field in the HMI.
- </description>
- <element name="KEYBOARD" />
- <description>
- This mode causes the interaction to immediately display a keyboard entry through the HMI.
- </description>
- </enum>
-
- <enum name="HMILevel">
- <description>Enumeraction that describes current levels of HMI.</description>
- <element name="FULL" internal_name="HMI_FULL" />
- <element name="LIMITED" internal_name="HMI_LIMITED" />
- <element name="BACKGROUND" internal_name="HMI_BACKGROUND" />
- <element name="NONE" internal_name="HMI_NONE" />
- </enum>
-
- <enum name="AudioStreamingState">
- <description>Enumeraction that describes possible states of audio streaming.</description>
- <element name="AUDIBLE" />
- <element name="ATTENUATED" />
- <element name="NOT_AUDIBLE" />
- </enum>
-
- <enum name="SystemAction">
- <description>Enumeration that describes system actions that can be triggered.</description>
- <element name="DEFAULT_ACTION">
- <description>Default action occurs. Standard behavior (e.g. SoftButton clears overlay).</description>
- </element>
- <element name="STEAL_FOCUS">
- <description>App is brought into HMI_FULL.</description>
- </element>
- <element name="KEEP_CONTEXT">
- <description>Current system context is maintained. An overlay is persisted even though a SoftButton has been pressed and the notification sent.</description>
- </element>
- </enum>
-
- <enum name="SystemContext">
- <description>Enumeration that describes possible contexts an app's HMI might be in.</description>
- <description>Communicated to whichever app is in HMI FULL, except Alert.</description>
- <element name="MAIN" internal_name="SYSCTXT_MAIN">
- <description>The app's persistent display (whether media/non-media/navigation) is fully visible onscreen.</description>
- </element>
- <element name="VRSESSION" internal_name="SYSCTXT_VRSESSION">
- <description>The system is currently in a VR session (with whatever dedicated VR screen being overlaid onscreen).</description>
- </element>
- <element name="MENU" internal_name="SYSCTXT_MENU">
- <description>The system is currently displaying an in-App menu onscreen.</description>
- </element>
- <element name="HMI_OBSCURED" internal_name="SYSCTXT_HMI_OBSCURED">
- <description>The app's display HMI is currently being obscured by either a system or other app's overlay.</description>
- </element>
- <element name="ALERT" internal_name="SYSCTXT_ALERT">
- <description>Broadcast only to whichever app has an alert currently being displayed.</description>
- </element>
- </enum>
-
- <enum name="SoftButtonType">
- <description>Contains information about the SoftButton capabilities.</description>
- <element name="TEXT" internal_name="SBT_TEXT"/>
- <element name="IMAGE" internal_name="SBT_IMAGE"/>
- <element name="BOTH" internal_name="SBT_BOTH"/>
- </enum>
-
- <enum name="AppInterfaceUnregisteredReason">
- <description>Error code, which comes from sync side.</description>
-<!-- Deprecate
- <element name="USER_EXIT" />
--->
- <element name="IGNITION_OFF" />
- <element name="BLUETOOTH_OFF" />
- <element name="USB_DISCONNECTED" />
- <element name="REQUEST_WHILE_IN_NONE_HMI_LEVEL" />
- <element name="TOO_MANY_REQUESTS" />
- <element name="DRIVER_DISTRACTION_VIOLATION" />
- <element name="LANGUAGE_CHANGE" />
- <element name="MASTER_RESET" />
- <element name="FACTORY_DEFAULTS" />
- <element name="APP_UNAUTHORIZED" />
- <element name="PROTOCOL_VIOLATION" />
- <element name="UNSUPPORTED_HMI_RESOURCE" />
- </enum>
-
- <enum name="TriggerSource">
- <description>Indicates the source from where the command was triggered.</description>
- <element name="MENU" internal_name="TS_MENU" />
- <element name="VR" internal_name="TS_VR" />
- <element name="KEYBOARD" internal_name="TS_KEYBOARD" />
- </enum>
-
- <enum name="HmiZoneCapabilities">
- <description>Contains information about the HMI zone capabilities.</description>
- <description>For future use.</description>
- <element name="FRONT" />
- <element name="BACK" />
- </enum>
-
- <enum name="SpeechCapabilities">
- <description>Contains information about the TTS capabilities.</description>
- <element name="TEXT" internal_name="SC_TEXT"/>
- <element name="SAPI_PHONEMES" />
- <element name="LHPLUS_PHONEMES" />
- <element name="PRE_RECORDED" />
- <element name="SILENCE" />
- </enum>
-
- <enum name="VrCapabilities">
- <description>Contains information about the VR capabilities.</description>
- <element name="TEXT" internal_name="VR_TEXT"/>
- </enum>
-
- <enum name="PrerecordedSpeech">
- <description>Contains a list of prerecorded speech items present on the platform.</description>
- <element name="HELP_JINGLE" />
- <element name="INITIAL_JINGLE" />
- <element name="LISTEN_JINGLE" />
- <element name="POSITIVE_JINGLE" />
- <element name="NEGATIVE_JINGLE" />
- </enum>
-
- <enum name="SamplingRate">
- <description>Describes different sampling options for PerformAudioPassThru.</description>
- <element name="8KHZ" internal_name="SamplingRate_8KHZ"/>
- <element name="16KHZ" internal_name="SamplingRate_16KHZ"/>
- <element name="22KHZ" internal_name="SamplingRate_22KHZ"/>
- <element name="44KHZ" internal_name="SamplingRate_44KHZ"/>
- </enum>
-
- <enum name="BitsPerSample">
- <description>Describes different quality options for PerformAudioPassThru.</description>
- <element name="8_BIT" internal_name="BitsPerSample_8_BIT"/>
- <element name="16_BIT" internal_name="BitsPerSample_16_BIT"/>
- </enum>
-
- <enum name="AudioType">
- <description>Describes different audio type options for PerformAudioPassThru.</description>
- <element name="PCM" />
- </enum>
-
- <struct name="AudioPassThruCapabilities">
- <description>
- Describes different audio type configurations for PerformAudioPassThru.
- e.g. {8kHz,8-bit,PCM}
- </description>
- <param name="samplingRate" type="SamplingRate" mandatory="true"/>
- <param name="bitsPerSample" type="BitsPerSample" mandatory="true"/>
- <param name="audioType" type="AudioType" mandatory="true"/>
- </struct>
-
- <enum name="VehicleDataType">
- <description>Defines the data types that can be published and subscribed to.</description>
- <element name="VEHICLEDATA_GPS">
- <description>Notifies GPSData may be subscribed</description>
- </element>
- <element name="VEHICLEDATA_SPEED" />
- <element name="VEHICLEDATA_RPM" />
- <element name="VEHICLEDATA_FUELLEVEL" />
- <element name="VEHICLEDATA_FUELLEVEL_STATE" />
- <element name="VEHICLEDATA_FUELCONSUMPTION" />
- <element name="VEHICLEDATA_EXTERNTEMP" />
- <element name="VEHICLEDATA_VIN" />
- <element name="VEHICLEDATA_PRNDL" />
- <element name="VEHICLEDATA_TIREPRESSURE" />
- <element name="VEHICLEDATA_ODOMETER" />
- <element name="VEHICLEDATA_BELTSTATUS" />
- <element name="VEHICLEDATA_BODYINFO" />
- <element name="VEHICLEDATA_DEVICESTATUS" />
- <element name="VEHICLEDATA_ECALLINFO" />
- <element name="VEHICLEDATA_AIRBAGSTATUS" />
- <element name="VEHICLEDATA_EMERGENCYEVENT" />
- <element name="VEHICLEDATA_CLUSTERMODESTATUS" />
- <element name="VEHICLEDATA_MYKEY" />
- <element name="VEHICLEDATA_BRAKING" />
- <element name="VEHICLEDATA_WIPERSTATUS" />
- <element name="VEHICLEDATA_HEADLAMPSTATUS" />
- <element name="VEHICLEDATA_BATTVOLTAGE" />
- <element name="VEHICLEDATA_ENGINETORQUE" />
- <element name="VEHICLEDATA_ACCPEDAL" />
- <element name="VEHICLEDATA_STEERINGWHEEL" />
- </enum>
-
- <enum name="ButtonName">
- <description>Defines the hard (physical) and soft (touchscreen) buttons available from SYNC</description>
- <element name="OK" />
- <element name="SEEKLEFT" />
- <element name="SEEKRIGHT" />
- <element name="TUNEUP" />
- <element name="TUNEDOWN" />
- <element name="PRESET_0" />
- <element name="PRESET_1" />
- <element name="PRESET_2" />
- <element name="PRESET_3" />
- <element name="PRESET_4" />
- <element name="PRESET_5" />
- <element name="PRESET_6" />
- <element name="PRESET_7" />
- <element name="PRESET_8" />
- <element name="PRESET_9" />
- <element name="CUSTOM_BUTTON" />
- <element name="SEARCH" />
-
- <!-- Climate Buttons -->
- <element name="AC_MAX" />
- <element name="AC" />
- <element name="RECIRCULATE" />
- <element name="FAN_UP" />
- <element name="FAN_DOWN" />
- <element name="TEMP_UP" />
- <element name="TEMP_DOWN" />
- <element name="DEFROST_MAX" />
- <element name="DEFROST" />
- <element name="DEFROST_REAR" />
- <element name="UPPER_VENT" />
- <element name="LOWER_VENT" />
-
- <!-- Radio Buttons -->
- <element name="VOLUME_UP" />
- <element name="VOLUME_DOWN" />
- <element name="EJECT" />
- <element name="SOURCE" />
- <element name="SHUFFLE" />
- <element name="REPEAT" />
- </enum>
-
- <enum name="MediaClockFormat">
- <element name="CLOCK1">
- <description>
- minutesFieldWidth = 2;minutesFieldMax = 19;secondsFieldWidth = 2;secondsFieldMax = 99;maxHours = 19;maxMinutes = 59;maxSeconds = 59;
- used for Type II and CID headunits
- </description>
- </element>
- <element name="CLOCK2">
- <description>
- minutesFieldWidth = 3;minutesFieldMax = 199;secondsFieldWidth = 2;secondsFieldMax = 99;maxHours = 59;maxMinutes = 59;maxSeconds = 59;
- used for Type V headunit
- </description>
- </element>
- <element name="CLOCK3">
- <description>
- minutesFieldWidth = 2;minutesFieldMax = 59;secondsFieldWidth = 2;secondsFieldMax = 59;maxHours = 9;maxMinutes = 59;maxSeconds = 59;
- used for GEN1.1 MFD3/4/5 headunits
- </description>
- </element>
- <element name="CLOCKTEXT1">
- <description>
- 5 characters possible
- Format: 1|sp c :|sp c c
- 1|sp : digit "1" or space
- c : character out of following character set: sp|0-9|[letters, see TypeII column in XLS. See [@TODO: create file ref]]
- :|sp : colon or space
- used for Type II headunit
- </description>
- </element>
- <element name="CLOCKTEXT2">
- <description>
- 5 chars possible
- Format: 1|sp c :|sp c c
- 1|sp : digit "1" or space
- c : character out of following character set: sp|0-9|[letters, see CID column in XLS. See [@TODO: create file ref]]
- :|sp : colon or space
- used for CID headunit
- NOTE: difference between CLOCKTEXT1 and CLOCKTEXT2 is the supported character set
- </description>
- </element>
- <element name="CLOCKTEXT3">
- <description>
- 6 chars possible
- Format: 1|sp c c :|sp c c
- 1|sp : digit "1" or space
- c : character out of following character set: sp|0-9|[letters, see Type 5 column in XLS]. See [@TODO: create file ref]
- :|sp : colon or space
- used for Type V headunit
- </description>
- </element>
- <element name="CLOCKTEXT4">
- <description>
- 6 chars possible
- Format: c :|sp c c : c c
- :|sp : colon or space
- c : character out of following character set: sp|0-9|[letters].
- used for GEN1.1 MFD3/4/5 headunits
- </description>
- </element>
- </enum>
-
- <enum name="DisplayType">
- <description>See DAES for further infos regarding the displays</description>
- <element name="CID"/>
- <element name="TYPE2" />
- <element name="TYPE5" />
- <element name="NGN" />
- <element name="GEN2_8_DMA" />
- <element name="GEN2_6_DMA" />
- <element name="MFD3" />
- <element name="MFD4" />
- <element name="MFD5" />
- <element name="GEN3_8-INCH" internal_name="GEN3_8_INCH" />
- <element name="SDL_GENERIC" />
- </enum>
-
- <enum name="TextFieldName">
- <element name="mainField1">
- <description>The first line of first set of main fields of the persistent display; applies to "Show"</description>
- </element>
-
- <element name="mainField2">
- <description>The second line of first set of main fields of the persistent display; applies to "Show"</description>
- </element>
-
- <element name="mainField3">
- <description>The first line of second set of main fields of persistent display; applies to "Show"</description>
- </element>
-
- <element name="mainField4">
- <description>The second line of second set of main fields of the persistent display; applies to "Show"</description>
- </element>
-
- <element name="statusBar">
- <description>The status bar on NGN; applies to "Show"</description>
- </element>
-
- <element name="mediaClock">
- <description>Text value for MediaClock field; applies to "Show"</description>
- </element>
-
- <element name="mediaTrack">
- <description>The track field of NGN and GEN1.1 MFD displays. This field is only available for media applications; applies to "Show"</description>
- </element>
-
- <element name="alertText1">
- <description>The first line of the alert text field; applies to "Alert"</description>
- </element>
-
- <element name="alertText2">
- <description>The second line of the alert text field; applies to "Alert"</description>
- </element>
-
- <element name="alertText3">
- <description>The third line of the alert text field; applies to "Alert"</description>
- </element>
-
- <element name="scrollableMessageBody">
- <description>Long form body of text that can include newlines and tabs; applies to "ScrollableMessage"</description>
- </element>
-
- <element name="initialInteractionText">
- <description> First line suggestion for a user response (in the case of VR enabled interaction)</description>
- </element>
-
- <element name="navigationText1">
- <description> First line of navigation text</description>
- </element>
-
- <element name="navigationText2">
- <description> Second line of navigation text</description>
- </element>
-
- <element name="ETA">
- <description> Estimated Time of Arrival time for navigation</description>
- </element>
-
- <element name="totalDistance">
- <description> Total distance to destination for navigation</description>
- </element>
-
- <element name="audioPassThruDisplayText1">
- <description> First line of text for audio pass thru</description>
- </element>
-
- <element name="audioPassThruDisplayText2">
- <description> Second line of text for audio pass thru</description>
- </element>
-
- <element name="sliderHeader">
- <description> Header text for slider</description>
- </element>
-
- <element name="sliderFooter">
- <description> Footer text for slider</description>
- </element>
-
- <element name="menuName">
- <description> Primary text for Choice</description>
- </element>
-
- <element name="secondaryText">
- <description> Secondary text for Choice</description>
- </element>
-
- <element name="tertiaryText">
- <description> Tertiary text for Choice</description>
- </element>
-
- <element name="menuTitle">
- <description> Optional text to label an app menu button (for certain touchscreen platforms).</description>
- </element>
-
- <element name="locationName">
- <description> Optional name / title of intended location for SendLocation.</description>
- </element>
-
- <element name="locationDescription">
- <description> Optional description of intended location / establishment (if applicable) for SendLocation.</description>
- </element>
-
- <element name="addressLines">
- <description> Optional location address (if applicable) for SendLocation.</description>
- </element>
-
- <element name="phoneNumber">
- <description> Optional hone number of intended location / establishment (if applicable) for SendLocation.</description>
- </element>
-
- </enum>
-
- <enum name="MetadataType">
- <element name="mediaTitle">
- <description>The data in this field contains the title of the currently playing audio track.</description>
- </element>
- <element name="mediaArtist">
- <description>The data in this field contains the artist or creator of the currently playing audio track.</description>
- </element>
- <element name="mediaAlbum">
- <description>The data in this field contains the album title of the currently playing audio track.</description>
- </element>
- <element name="mediaYear">
- <description>The data in this field contains the creation year of the currently playing audio track.</description>
- </element>
- <element name="mediaGenre">
- <description>The data in this field contains the genre of the currently playing audio track.</description>
- </element>
- <element name="mediaStation">
- <description>The data in this field contains the name of the current source for the media.</description>
- </element>
- <element name="rating">
- <description>The data in this field is a rating.</description>
- </element>
- <element name="currentTemperature">
- <description>The data in this field is the current temperature.</description>
- </element>
- <element name="maximumTemperature">
- <description>The data in this field is the maximum temperature for the day.</description>
- </element>
- <element name="minimumTemperature">
- <description>The data in this field is the minimum temperature for the day.</description>
- </element>
- <element name="weatherTerm">
- <description>The data in this field describes the current weather (ex. cloudy, clear, etc.).</description>
- </element>
- <element name="humidity">
- <description>The data in this field describes the current humidity value.</description>
- </element>
- </enum>
-
- <enum name="ImageFieldName">
- <element name="softButtonImage">
- <description>The image field for SoftButton</description>
- </element>
-
- <element name="choiceImage">
- <description>The first image field for Choice</description>
- </element>
-
- <element name="choiceSecondaryImage">
- <description>The secondary image field for Choice</description>
- </element>
-
- <element name="vrHelpItem">
- <description>The image field for vrHelpItem</description>
- </element>
-
- <element name="turnIcon">
- <description>The image field for Turn</description>
- </element>
-
- <element name="menuIcon">
- <description>The image field for the menu icon in SetGlobalProperties</description>
- </element>
-
- <element name="cmdIcon">
- <description>The image field for AddCommand</description>
- </element>
-
- <element name="appIcon">
- <description>The image field for the app icon (set by setAppIcon)</description>
- </element>
-
- <element name="graphic">
- <description>The image field for Show</description>
- </element>
-
- <element name="showConstantTBTIcon">
- <description>The primary image field for ShowConstantTBT</description>
- </element>
-
- <element name="showConstantTBTNextTurnIcon">
- <description>The secondary image field for ShowConstantTBT</description>
- </element>
-
- <element name="locationImage">
- <description>The optional image of a destination / location</description>
- </element>
-
- </enum>
-
- <enum name="CharacterSet">
- <description>The list of potential character sets</description>
- <element name="TYPE2SET">
- <description>See [@TODO: create file ref]</description>
- </element>
- <element name="TYPE5SET">
- <description>See [@TODO: create file ref]</description>
- </element>
- <element name="CID1SET">
- <description>See [@TODO: create file ref]</description>
- </element>
- <element name="CID2SET">
- <description>See [@TODO: create file ref]</description>
- </element>
- </enum>
-
- <enum name="TextAlignment">
- <description>The list of possible alignments, left, right, or centered</description>
- <element name="LEFT_ALIGNED" />
- <element name="RIGHT_ALIGNED" />
- <element name="CENTERED" />
- </enum>
-
- <enum name="TBTState">
- <description>Enumeration that describes possible states of turn-by-turn client or AppLink app.</description>
- <element name="ROUTE_UPDATE_REQUEST" />
- <element name="ROUTE_ACCEPTED" />
- <element name="ROUTE_REFUSED" />
- <element name="ROUTE_CANCELLED" />
- <element name="ETA_REQUEST" />
- <element name="NEXT_TURN_REQUEST" />
- <element name="ROUTE_STATUS_REQUEST" />
- <element name="ROUTE_SUMMARY_REQUEST" />
- <element name="TRIP_STATUS_REQUEST" />
- <element name="ROUTE_UPDATE_REQUEST_TIMEOUT" />
- </enum>
-
- <enum name="DriverDistractionState">
- <description>Enumeration that describes possible states of driver distraction.</description>
- <element name="DD_ON" />
- <element name="DD_OFF" />
- </enum>
-
- <enum name="ImageType">
- <description>Contains information about the type of image.</description>
- <element name="STATIC" />
- <element name="DYNAMIC" />
- </enum>
-
- <enum name="DeliveryMode">
- <description>The mode in which the SendLocation request is sent</description>
- <element name="PROMPT" />
- <element name="DESTINATION" />
- <element name="QUEUE" />
- </enum>
-
- <enum name="VideoStreamingProtocol">
- <description>Enum for each type of video streaming protocol type.</description>
- <element name="RAW">
- <description>
- Raw stream bytes that contains no timestamp data and is the lowest supported video streaming
- </description>
- </element>
- <element name="RTP">
- <description>
- RTP facilitates the transfer of real-time data. Information provided by this protocol include
- timestamps (for synchronization), sequence numbers (for packet loss and reordering detection)
- and the payload format which indicates the encoded format of the data.
- </description>
- </element>
- <element name="RTSP">
- <description>
- The transmission of streaming data itself is not a task of RTSP. Most RTSP servers use the
- Real-time Transport Protocol (RTP) in conjunction with Real-time Control Protocol (RTCP)
- for media stream delivery. However, some vendors implement proprietary transport protocols.
- </description>
- </element>
- <element name="RTMP">
- <description>
- Real-Time Messaging Protocol (RTMP) was initially a proprietary protocol developed by
- Macromedia for streaming audio, video and data over the Internet, between a Flash player
- and a server. Macromedia is now owned by Adobe, which has released an incomplete version
- of the specification of the protocol for public use.
- </description>
- </element>
- <element name="WEBM">
- <description>
- The WebM container is based on a profile of Matroska. WebM initially supported VP8 video and
- Vorbis audio streams. In 2013 it was updated to accommodate VP9 video and Opus audio.
- </description>
- </element>
- </enum>
-
- <enum name="VideoStreamingCodec">
- <description>Enum for each type of video streaming codec.</description>
- <element name="H264">
- <description>
- A block-oriented motion-compensation-based video compression standard.
- As of 2014 it is one of the most commonly used formats for the recording, compression, and
- distribution of video content.
- </description>
- </element>
- <element name="H265">
- <description>
- High Efficiency Video Coding (HEVC), also known as H.265 and MPEG-H Part 2, is a video
- compression standard, one of several potential successors to the widely used AVC (H.264 or
- MPEG-4 Part 10). In comparison to AVC, HEVC offers about double the data compression ratio
- at the same level of video quality, or substantially improved video quality at the same
- bit rate. It supports resolutions up to 8192x4320, including 8K UHD.
- </description>
- </element>
- <element name="Theora">
- <description>
- Theora is derived from the formerly proprietary VP3 codec, released into the public domain
- by On2 Technologies. It is broadly comparable in design and bitrate efficiency to
- MPEG-4 Part 2, early versions of Windows Media Video, and RealVideo while lacking some of
- the features present in some of these other codecs. It is comparable in open standards
- philosophy to the BBC's Dirac codec.
- </description>
- </element>
- <element name="VP8">
- <description>
- VP8 can be multiplexed into the Matroska-based container format WebM along with Vorbis and
- Opus audio. The image format WebP is based on VP8's intra-frame coding. VP8's direct
- successor, VP9, and the emerging royalty-free internet video format AV1 from the Alliance for
- Open Media (AOMedia) are based on VP8.
- </description>
- </element>
- <element name="VP9">
- <description>
- Similar to VP8, but VP9 is customized for video resolutions beyond high-definition video (UHD)
- and also enables lossless compression.
- </description>
- </element>
- </enum>
-
- <struct name="Image">
- <param name="value" minlength="0" maxlength="65535" type="String" mandatory="true">
- <description>Either the static hex icon value or the binary image file name identifier (sent by PutFile).</description>
- </param>
- <param name="imageType" type="ImageType" mandatory="true">
- <description>Describes, whether it is a static or dynamic image.</description>
- </param>
- </struct>
-
- <struct name="SoftButton">
- <param name="type" type="SoftButtonType" mandatory="true">
- <description>Describes, whether it is text, highlighted text, icon, or dynamic image. See softButtonType</description>
- </param>
- <param name="text" minlength="0" maxlength="500" type="String" mandatory="false">
- <description>Optional text to display (if defined as TEXT or BOTH)</description>
- </param>
- <param name="image" type="Image" mandatory="false">
- <description>Optional image struct for SoftButton (if defined as IMAGE or BOTH)</description>
- </param>
- <param name="isHighlighted" type="Boolean" defvalue="false" mandatory="false">
- <description>
- True, if highlighted
- False, if not highlighted
- </description>
- </param>
- <param name="softButtonID" type="Integer" minvalue="0" maxvalue="65535" mandatory="true">
- <description>Value which is returned via OnButtonPress / OnButtonEvent</description>
- </param>
- <param name="systemAction" type="SystemAction" defvalue="DEFAULT_ACTION" mandatory="false">
- <description>Parameter indicating whether selecting a SoftButton shall call a specific system action. This is intended to allow Notifications to bring the callee into full / focus; or in the case of persistent overlays, the overlay can persist when a SoftButton is pressed.</description>
- </param>
- </struct>
-
- <struct name="MetadataTags">
- <param name="mainField1" type="MetadataType" minsize="0" maxsize="5" array="true" mandatory="false">
- <description>The type of data contained in the "mainField1" text field.</description>
- </param>
- <param name="mainField2" type="MetadataType" minsize="0" maxsize="5" array="true" mandatory="false">
- <description>The type of data contained in the "mainField2" text field.</description>
- </param>
- <param name="mainField3" type="MetadataType" minsize="0" maxsize="5" array="true" mandatory="false">
- <description>The type of data contained in the "mainField3" text field.</description>
- </param>
- <param name="mainField4" type="MetadataType" minsize="0" maxsize="5" array="true" mandatory="false">
- <description>The type of data contained in the "mainField4" text field.</description>
- </param>
- </struct>
-
- <struct name="Choice">
- <description>A choice is an option given to the user, which can be selected either by menu, or through voice recognition system.</description>
- <param name="choiceID" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"/>
- <param name="menuName" type="String" maxlength="500" mandatory="true"/>
- <param name="vrCommands" type="String" minsize="1" maxsize="100" maxlength="99" array="true" mandatory="true"/>
- <param name="image" type="Image" mandatory="false"/>
- <param name="secondaryText" maxlength="500" type="String" mandatory="false">
- <description>Optional secondary text to display; e.g. address of POI in a search result entry</description>
- </param>
- <param name="tertiaryText" maxlength="500" type="String" mandatory="false">
- <description>Optional tertiary text to display; e.g. distance to POI for a search result entry</description>
- </param>
- <param name="secondaryImage" type="Image" mandatory="false">
- <description>Optional secondary image struct for choice</description>
- </param>
- </struct>
-
- <struct name="VrHelpItem">
- <param name="text" maxlength="500" type="String" mandatory="true">
- <description>Text to display for VR Help item</description>
- </param>
- <param name="image" type="Image" mandatory="false">
- <description>Image struct for VR Help item</description>
- </param>
- <param name="position" type="Integer" minvalue="1" maxvalue="100" mandatory="true">
- <description>Position to display item in VR Help list</description>
- </param>
- </struct>
-
- <struct name="SyncMsgVersion">
- <description>Specifies the version number of the SYNC V4 protocol, that is supported by the mobile application</description>
-
- <param name="majorVersion" type="Integer" minvalue="1" maxvalue="10" mandatory="true">
- <description>The major version indicates versions that is not-compatible to previous versions.</description>
- </param>
- <param name="minorVersion" type="Integer" minvalue="0" maxvalue="1000" mandatory="true">
- <description>The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality)</description>
- </param>
- <param name="patchVersion" type="Integer" minvalue="0" maxvalue="1000" mandatory="false">
- <description>The patch version indicates a fix to existing functionality in a previous version that should still be able to be run on an older version </description>
- </param>
- </struct>
-
- <enum name="GlobalProperty">
- <description>The different global properties.</description>
- <element name="HELPPROMPT">
- <description>The property helpPrompt of setGlobalProperties</description>
- </element>
- <element name="TIMEOUTPROMPT">
- <description>The property timeoutPrompt of setGlobalProperties</description>
- </element>
- <element name="VRHELPTITLE">
- <description>The property vrHelpTitle of setGlobalProperties</description>
- </element>
- <element name="VRHELPITEMS">
- <description>The property array of vrHelp of setGlobalProperties</description>
- </element>
- <element name="MENUNAME">
- <description>The property in-app menu name of setGlobalProperties</description>
- </element>
- <element name="MENUICON">
- <description>The property in-app menu icon of setGlobalProperties</description>
- </element>
- <element name="KEYBOARDPROPERTIES">
- <description>The on-screen keyboard configuration of setGlobalProperties</description>
- </element>
- </enum>
-
- <enum name="CompassDirection">
- <description>The list of potential compass directions</description>
- <element name="NORTH">
- </element>
- <element name="NORTHWEST">
- </element>
- <element name="WEST">
- </element>
- <element name="SOUTHWEST">
- </element>
- <element name="SOUTH">
- </element>
- <element name="SOUTHEAST">
- </element>
- <element name="EAST">
- </element>
- <element name="NORTHEAST">
- </element>
- </enum>
-
- <enum name="Dimension">
- <description>The supported dimensions of the GPS</description>
- <element name="NO_FIX" internal_name="Dimension_NO_FIX">
- <description>No GPS at all</description>
- </element>
- <element name="2D" internal_name="Dimension_2D">
- <description>Longitude and lattitude</description>
- </element>
- <element name="3D" internal_name="Dimension_3D">
- <description>Longitude and lattitude and altitude</description>
- </element>
- </enum>
-
- <enum name="PRNDL">
- <description>The selected gear.</description>
- <element name="PARK">
- <description>Parking</description>
- </element>
- <element name="REVERSE">
- <description>Reverse gear</description>
- </element>
- <element name="NEUTRAL">
- <description>No gear</description>
- </element>
- <element name="DRIVE">
- </element>
- <element name="SPORT">
- <description>Drive Sport mode</description>
- </element>
- <element name="LOWGEAR">
- <description>1st gear hold</description>
- </element>
- <element name="FIRST">
- </element>
- <element name="SECOND">
- </element>
- <element name="THIRD">
- </element>
- <element name="FOURTH">
- </element>
- <element name="FIFTH">
- </element>
- <element name="SIXTH">
- </element>
- <element name="SEVENTH">
- </element>
- <element name="EIGHTH">
- </element>
- <element name="UNKNOWN">
- </element>
- <element name="FAULT">
- </element>
- </enum>
-
- <enum name="ComponentVolumeStatus">
- <description>The volume status of a vehicle component.</description>
- <element name="UNKNOWN" internal_name="CVS_UNKNOWN">
- </element>
- <element name="NORMAL" internal_name="CVS_NORMAL">
- </element>
- <element name="LOW" internal_name="CVS_LOW">
- </element>
- <element name="FAULT" internal_name="CVS_FAULT">
- </element>
- <element name="ALERT" internal_name="CVS_ALERT">
- </element>
- <element name="NOT_SUPPORTED" internal_name="CVS_NOT_SUPPORTED">
- </element>
- </enum>
-
- <struct name="SingleTireStatus">
- <param name="status" type="ComponentVolumeStatus" mandatory="true">
- <description>See ComponentVolumeStatus.</description>
- </param>
- </struct>
-
- <enum name="WarningLightStatus">
- <description>Reflects the status of a cluster instrument warning light.</description>
- <element name="OFF" internal_name="WLS_OFF">
- </element>
- <element name="ON" internal_name="WLS_ON">
- </element>
- <element name="FLASH" internal_name="WLS_FLASH">
- </element>
- <element name="NOT_USED" internal_name="WLS_NOT_USED">
- </element>
- </enum>
-
- <enum name="VehicleDataNotificationStatus">
- <description>Reflects the status of a vehicle data notification.</description>
- <element name="NOT_SUPPORTED" internal_name="VDNS_NOT_SUPPORTED">
- </element>
- <element name="NORMAL" internal_name="VDNS_NORMAL">
- </element>
- <element name="ACTIVE" internal_name="VDNS_ACTIVE">
- </element>
- <element name="NOT_USED" internal_name="VDNS_NOT_USED">
- </element>
- </enum>
-
- <enum name="IgnitionStableStatus">
- <description>Reflects the ignition switch stability.</description>
- <element name="IGNITION_SWITCH_NOT_STABLE">
- </element>
- <element name="IGNITION_SWITCH_STABLE">
- </element>
- <element name="MISSING_FROM_TRANSMITTER">
- </element>
- </enum>
-
- <enum name="IgnitionStatus">
- <description>Reflects the status of ignition.</description>
- <element name="UNKNOWN" internal_name="IS_UNKNOWN">
- </element>
- <element name="OFF" internal_name="IS_OFF">
- </element>
- <element name="ACCESSORY" internal_name="IS_ACCESSORY">
- </element>
- <element name="RUN" internal_name="IS_RUN">
- </element>
- <element name="START" internal_name="IS_START">
- </element>
- <element name="INVALID" internal_name="IS_INVALID">
- </element>
- </enum>
-
- <enum name="VehicleDataEventStatus">
- <description>Reflects the status of a vehicle data event; e.g. a seat belt event status.</description>
- <element name="NO_EVENT" internal_name="VDES_NO_EVENT">
- </element>
- <element name="NO" internal_name="VDES_NO">
- </element>
- <element name="YES" internal_name="VDES_YES">
- </element>
- <element name="NOT_SUPPORTED" internal_name="VDES_NOT_SUPPORTED">
- </element>
- <element name="FAULT" internal_name="VDES_FAULT">
- </element>
- </enum>
-
- <enum name="DeviceLevelStatus">
- <description>Reflects the reported battery status of the connected device, if reported.</description>
- <element name="ZERO_LEVEL_BARS">
- </element>
- <element name="ONE_LEVEL_BARS">
- </element>
- <element name="TWO_LEVEL_BARS">
- </element>
- <element name="THREE_LEVEL_BARS">
- </element>
- <element name="FOUR_LEVEL_BARS">
- </element>
- <element name="NOT_PROVIDED">
- </element>
- </enum>
-
- <enum name="PrimaryAudioSource">
- <description>Reflects the current primary audio source (if selected).</description>
- <element name="NO_SOURCE_SELECTED">
- </element>
- <element name="USB">
- </element>
- <element name="USB2">
- </element>
- <element name="BLUETOOTH_STEREO_BTST">
- </element>
- <element name="LINE_IN">
- </element>
- <element name="IPOD">
- </element>
- <element name="MOBILE_APP">
- </element>
- </enum>
-
- <enum name="WiperStatus">
- <description>Reflects the status of the wipers.</description>
- <element name="OFF" />
- <element name="AUTO_OFF" />
- <element name="OFF_MOVING" />
- <element name="MAN_INT_OFF" />
- <element name="MAN_INT_ON" />
- <element name="MAN_LOW" />
- <element name="MAN_HIGH" />
- <element name="MAN_FLICK" />
- <element name="WASH" />
- <element name="AUTO_LOW" />
- <element name="AUTO_HIGH" />
- <element name="COURTESYWIPE" />
- <element name="AUTO_ADJUST" />
- <element name="STALLED" />
- <element name="NO_DATA_EXISTS" />
- </enum>
-
- <enum name="VehicleDataStatus">
- <description>Reflects the status of a binary vehicle data item.</description>
- <element name="NO_DATA_EXISTS" internal_name="VDS_NO_DATA_EXISTS">
- </element>
- <element name="OFF" internal_name="VDS_OFF">
- </element>
- <element name="ON" internal_name="VDS_ON">
- </element>
- </enum>
-
- <enum name="MaintenanceModeStatus">
- <description>Reflects the status of a vehicle maintenance mode.</description>
- <element name="NORMAL" internal_name="MMS_NORMAL">
- </element>
- <element name="NEAR" internal_name="MMS_NEAR">
- </element>
- <element name="ACTIVE" internal_name="MMS_ACTIVE">
- </element>
- <element name="FEATURE_NOT_PRESENT" internal_name="MMS_FEATURE_NOT_PRESENT">
- </element>
- </enum>
-
- <enum name="VehicleDataActiveStatus">
- <description>Reflects the status of given vehicle component.</description>
- <element name="INACTIVE_NOT_CONFIRMED" internal_name="VDAS_INACTIVE_NOT_CONFIRMED">
- </element>
- <element name="INACTIVE_CONFIRMED" internal_name="VDAS_INACTIVE_CONFIRMED">
- </element>
- <element name="ACTIVE_NOT_CONFIRMED" internal_name="VDAS_ACTIVE_NOT_CONFIRMED">
- </element>
- <element name="ACTIVE_CONFIRMED" internal_name="VDAS_ACTIVE_CONFIRMED">
- </element>
- <element name="FAULT" internal_name="VDAS_FAULT">
- </element>
- </enum>
-
- <enum name="AmbientLightStatus">
- <description>Reflects the status of the ambient light sensor.</description>
- <element name="NIGHT" />
- <element name="TWILIGHT_1" />
- <element name="TWILIGHT_2" />
- <element name="TWILIGHT_3" />
- <element name="TWILIGHT_4" />
- <element name="DAY" />
- <element name="UNKNOWN" internal_name="ALS_UNKNOWN" />
- <element name="INVALID" />
- </enum>
-
- <struct name="BeltStatus">
- <param name="driverBeltDeployed" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsDrvBelt_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="passengerBeltDeployed" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsPasBelt_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="passengerBuckleBelted" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsRw1PasBckl_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="driverBuckleBelted" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsRw1DrvBckl_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="leftRow2BuckleBelted" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsRw2lBckl_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="passengerChildDetected" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsRw1PasChld_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="rightRow2BuckleBelted" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsRw2rBckl_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="middleRow2BuckleBelted" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsRw2mBckl_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="middleRow3BuckleBelted" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsRw3mBckl_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="leftRow3BuckleBelted" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsRw3lBckl_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="rightRow3BuckleBelted" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsRw3rBckl_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="leftRearInflatableBelted" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsRw2lRib_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="rightRearInflatableBelted" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsRw2rRib_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="middleRow1BeltDeployed" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsRw1mBelt_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="middleRow1BuckleBelted" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsRw1mBckl_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- </struct>
-
- <struct name="BodyInformation">
- <param name="parkBrakeActive" type="Boolean" mandatory="true">
- <description>References signal "PrkBrkActv_B_Actl".</description>
- </param>
- <param name="ignitionStableStatus" type="IgnitionStableStatus" mandatory="true">
- <description>References signal "Ignition_Switch_Stable". See IgnitionStableStatus.</description>
- </param>
- <param name="ignitionStatus" type="IgnitionStatus" mandatory="true">
- <description>References signal "Ignition_status". See IgnitionStatus.</description>
- </param>
- <param name="driverDoorAjar" type="Boolean" mandatory="false">
- <description>References signal "DrStatDrv_B_Actl".</description>
- </param>
- <param name="passengerDoorAjar" type="Boolean" mandatory="false">
- <description>References signal "DrStatPsngr_B_Actl".</description>
- </param>
- <param name="rearLeftDoorAjar" type="Boolean" mandatory="false">
- <description>References signal "DrStatRl_B_Actl".</description>
- </param>
- <param name="rearRightDoorAjar" type="Boolean" mandatory="false">
- <description>References signal "DrStatRr_B_Actl".</description>
- </param>
- </struct>
-
- <struct name="DeviceStatus">
- <param name="voiceRecOn" type="Boolean" mandatory="true">
- <description>References signal "CPM_VoiceRec_STAT".</description>
- </param>
- <param name="btIconOn" type="Boolean" mandatory="true">
- <description>References signal "BT_ICON".</description>
- </param>
- <param name="callActive" type="Boolean" mandatory="true">
- <description>References signal "CPM_Call_Active_STAT".</description>
- </param>
- <param name="phoneRoaming" type="Boolean" mandatory="true">
- <description>References signal "CPM_Phone_Roaming_STAT".</description>
- </param>
- <param name="textMsgAvailable" type="Boolean" mandatory="true">
- <description>References signal "CPM_TextMsg_AVAL".</description>
- </param>
- <param name="battLevelStatus" type="DeviceLevelStatus" mandatory="true">
- <description>Device battery level status. References signal "CPM_Batt_Level_STAT". See DeviceLevelStatus.</description>
- </param>
- <param name="stereoAudioOutputMuted" type="Boolean" mandatory="true">
- <description>References signal "CPM_Stereo_Audio_Output".</description>
- </param>
- <param name="monoAudioOutputMuted" type="Boolean" mandatory="true">
- <description>References signal "CPM_Mono_Audio_Output".</description>
- </param>
- <param name="signalLevelStatus" type="DeviceLevelStatus" mandatory="true">
- <description>Device signal level status. References signal "CPM_Signal_Strength_STAT". See DeviceLevelStatus.</description>
- </param>
- <param name="primaryAudioSource" type="PrimaryAudioSource" mandatory="true">
- <description>References signal "CPM_Stereo_PAS_Source". See PrimaryAudioSource.</description>
- </param>
- <param name="eCallEventActive" type="Boolean" mandatory="true">
- <description>References signal "eCall_Event".</description>
- </param>
- </struct>
-
- <struct name="HeadLampStatus">
- <param name="lowBeamsOn" type="Boolean" mandatory="true">
- <description>Status of the low beam lamps. References signal "HeadLampLoActv_B_Stat".</description>
- </param>
- <param name="highBeamsOn" type="Boolean" mandatory="true">
- <description>Status of the high beam lamps. References signal "HeadLghtHiOn_B_Stat".</description>
- </param>
- <param name="ambientLightSensorStatus" type="AmbientLightStatus" mandatory="false">
- <description>Status of the ambient light sensor.</description>
- </param>
- </struct>
-
- <struct name="AppInfo">
- <description>Contains detailed information about the registered application.</description>
-
- <param name="appDisplayName" type="String" maxlength="100" mandatory="true">
- <description>The name displayed for the mobile application on the mobile device (can differ from the app name set in the initial RAI request).</description>
- </param>
-
- <param name="appBundleID" type="String" maxlength="256" mandatory="true">
- <description>The AppBundleID of an iOS application or package name of the Android application. This supports App Launch strategies for each platform.</description>
- </param>
-
- <param name="appVersion" type="String" maxlength="256" mandatory="true">
- <description>Represents the build version number of this particular mobile app.</description>
- </param>
-
- <param name="appIcon" type="String" maxlength="500" mandatory="false">
- <description>A file reference to the icon utilized by this app (simplifies the process of setting an app icon during app registration).</description>
- </param>
- </struct>
-
- <enum name="ModuleType">
- <element name="CLIMATE"/>
- <element name="RADIO"/>
- </enum>
-
- <enum name="RadioBand">
- <element name="AM"/>
- <element name="FM"/>
- <element name="XM"/>
- </enum>
-
- <struct name="RdsData">
- <param name="PS" type="String" minlength="0" maxlength="8" mandatory="false" >
- <description>Program Service Name</description>
- </param>
- <param name="RT" type="String" minlength="0" maxlength="64" mandatory="false" >
- <description>Radio Text</description>
- </param>
- <param name="CT" type="String" minlength="24" maxlength="24" mandatory="false">
- <description>The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD</description>
- </param>
- <param name="PI" type="String" minlength="0" maxlength="6" mandatory="false" >
- <description>Program Identification - the call sign for the radio station</description>
- </param>
- <param name="PTY" type="Integer" minvalue="0" maxvalue="31" mandatory="false" >
- <description>The program type - The region should be used to differentiate between EU and North America program types</description>
- </param>
- <param name="TP" type="Boolean" mandatory="false" >
- <description>Traffic Program Identification - Identifies a station that offers traffic</description>
- </param>
- <param name="TA" type="Boolean" mandatory="false" >
- <description>Traffic Announcement Identification - Indicates an ongoing traffic announcement</description>
- </param>
- <param name="REG" type="String" mandatory="false" >
- <description>Region</description>
- </param>
- </struct>
-
- <enum name="RadioState">
- <element name="ACQUIRING"/>
- <element name="ACQUIRED"/>
- <element name="MULTICAST"/>
- <element name="NOT_FOUND"/>
- </enum>
-
- <struct name="RadioControlData">
- <param name="frequencyInteger" type="Integer" minvalue="0" maxvalue="1710" mandatory="false">
- <description>The integer part of the frequency ie for 101.7 this value should be 101</description>
- </param>
- <param name="frequencyFraction" type="Integer" minvalue="0" maxvalue="9" mandatory="false">
- <description>The fractional part of the frequency for 101.7 is 7</description>
- </param>
- <param name="band" type="RadioBand" mandatory="false">
- </param>
- <param name="rdsData" type="RdsData" mandatory="false">
- <description> Read only parameter.</description>
- </param>
- <param name="availableHDs" type="Integer" minvalue="1" maxvalue="3" mandatory="false">
- <description>number of HD sub-channels if available. Read only parameter.</description>
- </param>
- <param name="hdChannel" type="Integer" minvalue="1" maxvalue="3" mandatory="false">
- <description>Current HD sub-channel if available</description>
- </param>
- <param name="signalStrength" type="Integer" minvalue="0" maxvalue="100" mandatory="false">
- <description> Read only parameter.</description>
- </param>
- <param name="signalChangeThreshold" type="Integer" minvalue="0" maxvalue="100" mandatory="false">
- <description>If the signal strength falls below the set value for this parameter,
- the radio will tune to an alternative frequency. Read only parameter.</description>
- </param>
- <param name="radioEnable" type="Boolean" mandatory="false">
- <description> True if the radio is on, false is the radio is off.</description>
- </param>
- <param name="state" type="RadioState" mandatory="false">
- <description> Read only parameter.</description>
- </param>
- </struct>
-
- <struct name="RadioControlCapabilities">
- <description>Contains information about a radio control module's capabilities.</description>
- <param name="moduleName" type="String" maxlength="100" mandatory="true" >
- <description>The short name or a short description of the radio control module.</description>
- </param>
- <param name="radioEnableAvailable" type="Boolean" mandatory="false">
- <description>
- Availability of the control of enable/disable radio.
- True: Available, False: Not Available, Not present: Not Available.
- </description>
- </param>
- <param name="radioBandAvailable" type="Boolean" mandatory="false" >
- <description>
- Availability of the control of radio band.
- True: Available, False: Not Available, Not present: Not Available.
- </description>
- </param>
- <param name="radioFrequencyAvailable" type="Boolean" mandatory="false" >
- <description>
- Availability of the control of radio frequency.
- True: Available, False: Not Available, Not present: Not Available.
- </description>
- </param>
- <param name="hdChannelAvailable" type="Boolean" mandatory="false" >
- <description>
- Availability of the control of HD radio channel.
- True: Available, False: Not Available, Not present: Not Available.
- </description>
- </param>
- <param name="rdsDataAvailable" type="Boolean" mandatory="false" >
- <description>
- Availability of the getting Radio Data System (RDS) data.
- True: Available, False: Not Available, Not present: Not Available.
- </description>
- </param>
- <param name="availableHDsAvailable" type="Boolean" mandatory="false" >
- <description>
- Availability of the getting the number of available HD channels.
- True: Available, False: Not Available, Not present: Not Available.
- </description>
- </param>
- <param name="stateAvailable" type="Boolean" mandatory="false" >
- <description>
- Availability of the getting the Radio state.
- True: Available, False: Not Available, Not present: Not Available.
- </description>
- </param>
- <param name="signalStrengthAvailable" type="Boolean" mandatory="false" >
- <description>
- Availability of the getting the signal strength.
- True: Available, False: Not Available, Not present: Not Available.
- </description>
- </param>
- <param name="signalChangeThresholdAvailable" type="Boolean" mandatory="false" >
- <description>
- Availability of the getting the signal Change Threshold.
- True: Available, False: Not Available, Not present: Not Available.
- </description>
- </param>
- </struct>
-
- <enum name="DefrostZone">
- <element name="FRONT"/>
- <element name="REAR"/>
- <element name="ALL"/>
- <element name="NONE"/>
- </enum>
-
- <enum name="VentilationMode">
- <element name="UPPER"/>
- <element name="LOWER"/>
- <element name="BOTH"/>
- <element name="NONE"/>
- </enum>
-
- <enum name="TemperatureUnit">
- <element name="FAHRENHEIT"/>
- <element name="CELSIUS"/>
- </enum>
-
- <struct name="Temperature">
- <param name="unit" type="TemperatureUnit" mandatory="true" >
- <description>Temperature Unit</description>
- </param>
- <param name="value" type="Float" mandatory="true" >
- <description>Temperature Value in TemperatureUnit specified unit. Range depends on OEM and is not checked by SDL.</description>
- </param>
- </struct>
-
- <struct name="ClimateControlData">
- <param name="fanSpeed" type="Integer" minvalue="0" maxvalue="100" mandatory="false">
- </param>
- <param name="currentTemperature" type="Temperature" mandatory="false">
- <description> Read only parameter.</description>
- </param>
- <param name="desiredTemperature" type="Temperature" mandatory="false">
- </param>
- <param name="acEnable" type="Boolean" mandatory="false">
- </param>
- <param name="circulateAirEnable" type="Boolean" mandatory="false">
- </param>
- <param name="autoModeEnable" type="Boolean" mandatory="false">
- </param>
- <param name="defrostZone" type="DefrostZone" mandatory="false">
- </param>
- <param name="dualModeEnable" type="Boolean" mandatory="false">
- </param>
- <param name="acMaxEnable" type="Boolean" mandatory="false">
- </param>
- <param name="ventilationMode" type="VentilationMode" mandatory="false">
- </param>
- </struct>
-
-<struct name="ClimateControlCapabilities">
- <description>Contains information about a climate control module's capabilities.</description>
- <param name="moduleName" type="String" maxlength="100" mandatory="true" >
- <description>The short name or a short description of the climate control module.</description>
- </param>
- <param name="currentTemperatureAvailable" type="Boolean" mandatory="false">
- <description>
- Availability of the reading of current temperature.
- True: Available, False: Not Available, Not present: Not Available.
- </description>
- </param>
- <param name="fanSpeedAvailable" type="Boolean" mandatory="false">
- <description>
- Availability of the control of fan speed.
- True: Available, False: Not Available, Not present: Not Available.
- </description>
- </param>
- <param name="desiredTemperatureAvailable" type="Boolean" mandatory="false">
- <description>
- Availability of the control of desired temperature.
- True: Available, False: Not Available, Not present: Not Available.
- </description>
- </param>
- <param name="acEnableAvailable" type="Boolean" mandatory="false">
- <description>
- Availability of the control of turn on/off AC.
- True: Available, False: Not Available, Not present: Not Available.
- </description>
- </param>
- <param name="acMaxEnableAvailable" type="Boolean" mandatory="false">
- <description>
- Availability of the control of enable/disable air conditioning is ON on the maximum level.
- True: Available, False: Not Available, Not present: Not Available.
- </description>
- </param>
- <param name="circulateAirEnableAvailable" type="Boolean" mandatory="false">
- <description>
- Availability of the control of enable/disable circulate Air mode.
- True: Available, False: Not Available, Not present: Not Available.
- </description>
- </param>
- <param name="autoModeEnableAvailable" type="Boolean" mandatory="false">
- <description>
- Availability of the control of enable/disable auto mode.
- True: Available, False: Not Available, Not present: Not Available.
- </description>
- </param>
- <param name="dualModeEnableAvailable" type="Boolean" mandatory="false">
- <description>
- Availability of the control of enable/disable dual mode.
- True: Available, False: Not Available, Not present: Not Available.
- </description>
- </param>
- <param name="defrostZoneAvailable" type="Boolean" mandatory="false">
- <description>
- Availability of the control of defrost zones.
- True: Available, False: Not Available, Not present: Not Available.
- </description>
- </param>
- <param name="defrostZone" type="DefrostZone" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>
- A set of all defrost zones that are controllable.
- </description>
- </param>
- <param name="ventilationModeAvailable" type="Boolean" mandatory="false">
- <description>
- Availability of the control of air ventilation mode.
- True: Available, False: Not Available, Not present: Not Available.
- </description>
- </param>
- <param name="ventilationMode" type="VentilationMode" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>
- A set of all ventilation modes that are controllable.
- </description>
- </param>
-</struct>
-
- <struct name="ModuleData">
- <description>The moduleType indicates which type of data should be changed and identifies which data object exists in this struct. For example, if the moduleType is CLIMATE then a "climateControlData" should exist</description>
- <param name="moduleType" type="ModuleType" mandatory="true" >
- </param>
- <param name="radioControlData" type="RadioControlData" mandatory="false">
- </param>
- <param name="climateControlData" type="ClimateControlData" mandatory="false">
- </param>
- </struct>
-
-<!-- ~~~~~~~~~~~~~~~~~~~~~~~~ -->
-<!-- Ford Specific Data Items -->
-<!-- ~~~~~~~~~~~~~~~~~~~~~~~~ -->
- <enum name="FileType">
- <description>Enumeration listing possible file types.</description>
- <element name="GRAPHIC_BMP" />
- <element name="GRAPHIC_JPEG" />
- <element name="GRAPHIC_PNG" />
- <element name="AUDIO_WAVE" />
- <element name="AUDIO_MP3" />
- <element name="AUDIO_AAC" />
- <element name="BINARY" />
- <element name="JSON" />
- </enum>
-
- <enum name="FuelCutoffStatus" >
- <description>Reflects the status of the RCM fuel cutoff.</description>
- <element name="TERMINATE_FUEL" internal_name="FCS_TERMINATE_FUEL">
- </element>
- <element name="NORMAL_OPERATION" internal_name="FCS_NORMAL_OPERATION">
- </element>
- <element name="FAULT" internal_name="FCS_FAULT">
- </element>
- </enum>
-
- <enum name="EmergencyEventType">
- <description>Reflects the emergency event status of the vehicle.</description>
- <element name="NO_EVENT" internal_name="EET_NO_EVENT">
- </element>
- <element name="FRONTAL" internal_name="EET_FRONTAL">
- </element>
- <element name="SIDE" internal_name="EET_SIDE">
- </element>
- <element name="REAR" internal_name="EET_REAR">
- </element>
- <element name="ROLLOVER" internal_name="EET_ROLLOVER">
- </element>
- <element name="NOT_SUPPORTED" internal_name="EET_NOT_SUPPORTED">
- </element>
- <element name="FAULT" internal_name="EET_FAULT">
- </element>
- </enum>
-
- <enum name="ECallConfirmationStatus">
- <description>Reflects the status of the eCall Notification.</description>
- <element name="NORMAL" internal_name="ECCS_NORMAL">
- </element>
- <element name="CALL_IN_PROGRESS" internal_name="ECCS_CALL_IN_PROGRESS">
- </element>
- <element name="CALL_CANCELLED" internal_name="ECCS_CALL_CANCELLED">
- </element>
- <element name="CALL_COMPLETED">
- </element>
- <element name="CALL_UNSUCCESSFUL" internal_name="ECCS_CALL_UNSUCCESSFUL">
- </element>
- <element name="ECALL_CONFIGURED_OFF" internal_name="ECCS_ECALL_CONFIGURED_OFF">
- </element>
- <element name="CALL_COMPLETE_DTMF_TIMEOUT" internal_name="ECCS_CALL_COMPLETE_DTMF_TIMEOUT">
- </element>
- </enum>
-
- <enum name="PowerModeQualificationStatus" >
- <description>Reflects the status of the current power mode qualification.</description>
- <element name="POWER_MODE_UNDEFINED">
- </element>
- <element name="POWER_MODE_EVALUATION_IN_PROGRESS">
- </element>
- <element name="NOT_DEFINED">
- </element>
- <element name="POWER_MODE_OK">
- </element>
- </enum>
-
- <enum name="PowerModeStatus">
- <description>Reflects the status of the current power mode.</description>
- <element name="KEY_OUT">
- </element>
- <element name="KEY_RECENTLY_OUT">
- </element>
- <element name="KEY_APPROVED_0">
- </element>
- <element name="POST_ACCESORY_0">
- </element>
- <element name="ACCESORY_1">
- </element>
- <element name="POST_IGNITION_1">
- </element>
- <element name="IGNITION_ON_2">
- </element>
- <element name="RUNNING_2">
- </element>
- <element name="CRANK_3">
- </element>
- </enum>
-
- <enum name="CarModeStatus">
- <description>Reflects the status of the current car mode.</description>
- <element name="NORMAL" internal_name="CMS_NORMAL">
- </element>
- <element name="FACTORY" internal_name="CMS_FACTORY">
- </element>
- <element name="TRANSPORT" internal_name="CMS_TRANSPORT">
- </element>
- <element name="CRASH" internal_name="CMS_CRASH">
- </element>
- </enum>
-
- <struct name="ECallInfo">
- <param name="eCallNotificationStatus" type="VehicleDataNotificationStatus" mandatory="true">
- <description>References signal "eCallNotification_4A". See VehicleDataNotificationStatus.</description>
- </param>
- <param name="auxECallNotificationStatus" type="VehicleDataNotificationStatus" mandatory="true">
- <description>References signal "eCallNotification". See VehicleDataNotificationStatus.</description>
- </param>
- <param name="eCallConfirmationStatus" type="ECallConfirmationStatus" mandatory="true">
- <description>References signal "eCallConfirmation". See ECallConfirmationStatus.</description>
- </param>
- </struct>
-
- <struct name="AirbagStatus">
- <param name="driverAirbagDeployed" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsDrvBag_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="driverSideAirbagDeployed" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsDrvSideBag_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="driverCurtainAirbagDeployed" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsDrvCrtnBag_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="passengerAirbagDeployed" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsPasBag_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="passengerCurtainAirbagDeployed" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsPasCrtnBag_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="driverKneeAirbagDeployed" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsKneeDrvBag_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="passengerSideAirbagDeployed" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsPasSideBag_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- <param name="passengerKneeAirbagDeployed" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsKneePasBag_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- </struct>
-
- <struct name="EmergencyEvent">
- <param name="emergencyEventType" type="EmergencyEventType" mandatory="true">
- <description>References signal "VedsEvntType_D_Ltchd". See EmergencyEventType.</description>
- </param>
- <param name="fuelCutoffStatus" type="FuelCutoffStatus" mandatory="true">
- <description>References signal "RCM_FuelCutoff". See FuelCutoffStatus.</description>
- </param>
- <param name="rolloverEvent" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsEvntRoll_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
-
- <param name="maximumChangeVelocity" type="Integer" minvalue="0" maxvalue="255" mandatory="true">
- <description>References signal "VedsMaxDeltaV_D_Ltchd". Change in velocity in KPH. Additional reserved values:
- 0x00 No event
- 0xFE Not supported
- 0xFF Fault
- </description>
- </param>
- <param name="multipleEvents" type="VehicleDataEventStatus" mandatory="true">
- <description>References signal "VedsMultiEvnt_D_Ltchd". See VehicleDataEventStatus.</description>
- </param>
- </struct>
-
- <struct name="ClusterModeStatus">
- <param name="powerModeActive" type="Boolean" mandatory="true">
- <description>References signal "PowerMode_UB".</description>
- </param>
- <param name="powerModeQualificationStatus" type="PowerModeQualificationStatus" mandatory="true">
- <description>References signal "PowerModeQF". See PowerModeQualificationStatus.</description>
- </param>
- <param name="carModeStatus" type="CarModeStatus" mandatory="true">
- <description>References signal "CarMode". See CarMode.</description>
- </param>
- <param name="powerModeStatus" type="PowerModeStatus" mandatory="true">
- <description>References signal "PowerMode". See PowerMode.</description>
- </param>
- </struct>
-
- <struct name="MyKey">
- <param name="e911Override" type="VehicleDataStatus" mandatory="true">
- <description>Indicates whether e911 override is on. References signal "MyKey_e911Override_St". See VehicleDataStatus.</description>
- </param>
- </struct>
-
-<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
-<!-- / Ford Specific Data Items -->
-<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
-
- <enum name="VehicleDataResultCode">
- <description>Enumeration that describes possible result codes of a vehicle data entry request.</description>
- <element name="SUCCESS" internal_name="VDRC_SUCCESS">
- <description>Individual vehicle data item / DTC / DID request or subscription successful</description>
- </element>
- <element name="TRUNCATED_DATA" internal_name="VDRC_TRUNCATED_DATA">
- <description>DTC / DID request successful, however, not all active DTCs or full contents of DID location available</description>
- </element>
- <element name="DISALLOWED" internal_name="VDRC_DISALLOWED">
- <description>This vehicle data item is not allowed for this app by Ford.</description>
- </element>
- <element name="USER_DISALLOWED" internal_name="VDRC_USER_DISALLOWED">
- <description>The user has not granted access to this type of vehicle data item at this time.</description>
- </element>
- <element name="INVALID_ID" internal_name="VDRC_INVALID_ID">
- <description>The ECU ID referenced is not a valid ID on the bus / system.</description>
- </element>
- <element name="VEHICLE_DATA_NOT_AVAILABLE" internal_name="VDRC_DATA_NOT_AVAILABLE">
- <description>The requested vehicle data item / DTC / DID is not currently available or responding on the bus / system.</description>
- </element>
- <element name="DATA_ALREADY_SUBSCRIBED" internal_name="VDRC_DATA_ALREADY_SUBSCRIBED">
- <description>The vehicle data item is already subscribed.</description>
- </element>
- <element name="DATA_NOT_SUBSCRIBED" internal_name="VDRC_DATA_NOT_SUBSCRIBED">
- <description>The vehicle data item cannot be unsubscribed because it is not currently subscribed.</description>
- </element>
- <element name="IGNORED" internal_name="VDRC_IGNORED">
- <description>The request for this item is ignored because it is already in progress.</description>
- </element>
- </enum>
-
- <struct name="TireStatus">
- <description>The status and pressure of the tires.</description>
-
- <param name="pressureTelltale" type="WarningLightStatus" mandatory="true">
- <description>Status of the Tire Pressure Telltale. See WarningLightStatus.</description>
- </param>
- <param name="leftFront" type="SingleTireStatus" mandatory="true">
- <description>The status of the left front tire.</description>
- </param>
- <param name="rightFront" type="SingleTireStatus" mandatory="true">
- <description>The status of the right front tire.</description>
- </param>
- <param name="leftRear" type="SingleTireStatus" mandatory="true">
- <description>The status of the left rear tire.</description>
- </param>
- <param name="rightRear" type="SingleTireStatus" mandatory="true">
- <description>The status of the right rear tire.</description>
- </param>
- <param name="innerLeftRear" type="SingleTireStatus" mandatory="true">
- <description>The status of the inner left rear.</description>
- </param>
- <param name="innerRightRear" type="SingleTireStatus" mandatory="true">
- <description>The status of the inner right rear.</description>
- </param>
- </struct>
-
- <struct name="GPSData">
- <description>Struct with the GPS data.</description>
- <param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180" mandatory="true">
- </param>
- <param name="latitudeDegrees" type="Float" minvalue="-90" maxvalue="90" mandatory="true">
- </param>
- <param name="utcYear" type="Integer" minvalue="2010" maxvalue="2100" mandatory="true">
- <description>The current UTC year.</description>
- </param>
- <param name="utcMonth" type="Integer" minvalue="1" maxvalue="12" mandatory="true">
- <description>The current UTC month.</description>
- </param>
- <param name="utcDay" type="Integer" minvalue="1" maxvalue="31" mandatory="true">
- <description>The current UTC day.</description>
- </param>
- <param name="utcHours" type="Integer" minvalue="0" maxvalue="23" mandatory="true">
- <description>The current UTC hour.</description>
- </param>
- <param name="utcMinutes" type="Integer" minvalue="0" maxvalue="59" mandatory="true">
- <description>The current UTC minute.</description>
- </param>
- <param name="utcSeconds" type="Integer" minvalue="0" maxvalue="59" mandatory="true">
- <description>The current UTC second.</description>
- </param>
- <param name="compassDirection" type="CompassDirection" mandatory="true">
- <description>See CompassDirection.</description>
- </param>
- <param name="pdop" type="Float" minvalue="0" maxvalue="10" defvalue="0" mandatory="true">
- <description>PDOP. If undefined or unavailable, then value shall be set to 0.</description>
- </param>
- <param name="hdop" type="Float" minvalue="0" maxvalue="10" defvalue="0" mandatory="true">
- <description>HDOP. If value is unknown, value shall be set to 0.</description>
- </param>
- <param name="vdop" type="Float" minvalue="0" maxvalue="10" defvalue="0" mandatory="true">
- <description>VDOP. If value is unknown, value shall be set to 0.</description>
- </param>
- <param name="actual" type="Boolean" mandatory="true">
- <description>
- True, if actual.
- False, if infered.
- </description>
- </param>
- <param name="satellites" type="Integer" minvalue="0" maxvalue="31" mandatory="true">
- <description>Number of satellites in view</description>
- </param>
- <param name="dimension" type="Dimension" mandatory="true">
- <description>See Dimension</description>
- </param>
- <param name="altitude" type="Float" minvalue="-10000" maxvalue="10000" mandatory="true">
- <description>Altitude in meters</description>
- </param>
- <param name="heading" type="Float" minvalue="0" maxvalue="359.99" mandatory="true">
- <description>The heading. North is 0. Resolution is 0.01</description>
- </param>
- <param name="speed" type="Float" minvalue="0" maxvalue="500" mandatory="true">
- <description>The speed in KPH</description>
- </param>
- </struct>
-
- <struct name="VehicleDataResult">
- <description>Individual published data request result</description>
- <param name="dataType" type="VehicleDataType" mandatory="true">
- <description>Defined published data element type.</description>
- </param>
- <param name="resultCode" type="VehicleDataResultCode" mandatory="true">
- <description>Published data result code.</description>
- </param>
- </struct>
-
- <struct name="DIDResult">
- <description>Individual requested DID result and data</description>
- <param name="resultCode" type="VehicleDataResultCode" mandatory="true">
- <description>Individual DID result code.</description>
- </param>
- <param name="didLocation" type="Integer" minvalue="0" maxvalue="65535" mandatory="true">
- <description>Location of raw data from vehicle data DID</description>
- </param>
- <param name="data" type="String" maxlength="5000" mandatory="false">
- <description>Raw DID-based data returned for requested element.</description>
- </param>
- </struct>
-
- <struct name="StartTime">
- <param name="hours" type="Integer" minvalue="0" maxvalue="59" mandatory="true">
- <description>
- The hour of the media clock.
- Some radios only support a max of 19 hours. If out of range, it will be rejected.
- </description>
- </param>
- <param name="minutes" type="Integer" minvalue="0" maxvalue="59" mandatory="true"/>
- <param name="seconds" type="Integer" minvalue="0" maxvalue="59" mandatory="true"/>
- </struct>
-
- <struct name="TextField">
- <param name="name" type="TextFieldName" mandatory="true">
- <description>The name that identifies the field. See TextFieldName.</description>
- </param>
- <param name="characterSet" type="CharacterSet" mandatory="true">
- <description>The character set that is supported in this field. See CharacterSet.</description>
- </param>
- <param name="width" type="Integer" minvalue="1" maxvalue="500" mandatory="true">
- <description>The number of characters in one row of this field.</description>
- </param>
- <param name="rows" type="Integer" minvalue="1" maxvalue="8" mandatory="true">
- <description>The number of rows of this field.</description>
- </param>
- </struct>
-
- <struct name="ImageResolution">
- <param name="resolutionWidth" type="Integer" minvalue="1" maxvalue="10000" mandatory="true">
- <description>The image resolution width.</description>
- </param>
- <param name="resolutionHeight" type="Integer" minvalue="1" maxvalue="10000" mandatory="true">
- <description>The image resolution height.</description>
- </param>
- </struct>
-
- <struct name="ImageField">
- <param name="name" type="ImageFieldName" mandatory="true">
- <description>The name that identifies the field. See ImageFieldName.</description>
- </param>
- <param name="imageTypeSupported" type="FileType" minsize="1" maxsize="100" array="true" mandatory="true">
- <description>The image types that are supported in this field. See FileType.</description>
- </param>
- <param name="imageResolution" type="ImageResolution" mandatory="false">
- <description>The image resolution of this field.</description>
- </param>
- </struct>
-
- <struct name="TouchCoord">
- <param name="x" type="Integer" mandatory="true" minvalue="0" maxvalue="10000">
- <description>The x coordinate of the touch.</description>
- </param>
- <param name="y" type="Integer" mandatory="true" minvalue="0" maxvalue="10000">
- <description>The y coordinate of the touch.</description>
- </param>
- </struct>
-
- <enum name="TouchType">
- <element name="BEGIN"/>
- <element name="MOVE"/>
- <element name="END"/>
- <element name="CANCEL"/>
- </enum>
-
- <struct name="TouchEvent">
- <param name="id" type="Integer" mandatory="true" minvalue="0" maxvalue="9">
- <description>
- A touch's unique identifier. The application can track the current touch events by id.
- If a touch event has type begin, the id should be added to the set of touches.
- If a touch event has type end, the id should be removed from the set of touches.
- </description>
- </param>
- <param name="ts" type="Integer" mandatory="true" array="true" minvalue="0" maxvalue="2000000000" minsize="1" maxsize="1000">
- <description>
- The time that the touch was recorded. This number can the time since the beginning of the session or something else as long as the units are in milliseconds.
- The timestamp is used to determined the rate of change of position of a touch.
- The application also uses the time to verify whether two touches, with different ids, are part of a single action by the user.
- If there is only a single timestamp in this array, it is the same for every coordinate in the coordinates array.
- </description>
- </param>
- <param name="c" type="TouchCoord" mandatory="true" array="true" minsize="1" maxsize="1000">
- </param>
- </struct>
-
- <struct name="TouchEventCapabilities">
- <param name="pressAvailable" type="Boolean" mandatory="true">
- </param>
- <param name="multiTouchAvailable" type="Boolean" mandatory="true">
- </param>
- <param name="doublePressAvailable" type="Boolean" mandatory="true">
- </param>
- </struct>
-
- <struct name="ScreenParams">
- <param name="resolution" type="ImageResolution" mandatory="true">
- <description>The resolution of the prescribed screen area.</description>
- </param>
- <param name="touchEventAvailable" type="TouchEventCapabilities" mandatory="false">
- <description>Types of screen touch events available in screen area.</description>
- </param>
- </struct>
-
- <enum name="PermissionStatus">
- <description>Enumeration that describes possible permission states of a policy table entry.</description>
- <element name="ALLOWED" internal_name="PS_ALLOWED"/>
- <element name="DISALLOWED" internal_name="PS_DISALLOWED"/>
- <element name="USER_DISALLOWED" internal_name="PS_USER_DISALLOWED"/>
- <element name="USER_CONSENT_PENDING" internal_name="PS_USER_CONSENT_PENDING"/>
- </enum>
-
- <struct name="HMIPermissions">
- <param name="allowed" type="HMILevel" minsize="0" maxsize="100" array="true" mandatory="true">
- <description>A set of all HMI levels that are permitted for this given RPC.</description>
- </param>
- <param name="userDisallowed" type="HMILevel" minsize="0" maxsize="100" array="true" mandatory="true">
- <description>A set of all HMI levels that are prohibited for this given RPC.</description>
- </param>
- </struct>
-
- <struct name="ParameterPermissions">
- <param name="allowed" type="String" minsize="0" maxsize="100" maxlength = "100" array="true" mandatory="true">
- <description>A set of all parameters that are permitted for this given RPC.</description>
- </param>
- <param name="userDisallowed" type="String" minsize="0" maxsize="100" maxlength = "100" array="true" mandatory="true">
- <description>A set of all parameters that are prohibited for this given RPC.</description>
- </param>
- </struct>
-
- <struct name="PermissionItem">
- <param name="rpcName" type="String" maxlength="100" mandatory="true">
- <description>Name of the individual RPC in the policy table.</description>
- </param>
- <param name="hmiPermissions" type="HMIPermissions" mandatory="true"/>
- <param name="parameterPermissions" type="ParameterPermissions" mandatory="true"/>
- </struct>
-
- <struct name="VideoStreamingFormat">
- <description>Video streaming formats and their specifications.</description>
- <param name="protocol" type="VideoStreamingProtocol" mandatory="true">
- <description>Protocol type, see VideoStreamingProtocol</description>
- </param>
- <param name="codec" type="VideoStreamingCodec" mandatory="true">
- <description>Codec type, see VideoStreamingCodec</description>
- </param>
- </struct>
-
- <struct name="DisplayCapabilities">
- <description>Contains information about the display capabilities.</description>
- <param name="displayType" type="DisplayType" mandatory="true">
- <description>The type of the display. See DisplayType</description>
- </param>
- <param name="textFields" type="TextField" minsize="1" maxsize="100" array="true" mandatory="true">
- <description>A set of all fields that support text data. See TextField</description>
- </param>
- <param name="imageFields" type="ImageField" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>A set of all fields that support images. See ImageField</description>
- </param>
- <param name="mediaClockFormats" type="MediaClockFormat" minsize="0" maxsize="100" array="true" mandatory="true">
- <description>A set of all supported formats of the media clock. See MediaClockFormat</description>
- </param>
- <param name="graphicSupported" type="Boolean" mandatory="true">
- <description>The display's persistent screen supports referencing a static or dynamic image.</description>
- </param>
- <param name="templatesAvailable" type="String" minsize="0" maxsize="100" maxlength="100" array="true" mandatory="false">
- <description>A set of all predefined persistent display templates available on headunit. To be referenced in SetDisplayLayout.</description>
- </param>
- <param name="screenParams" type="ScreenParams" mandatory="false">
- <description>A set of all parameters related to a prescribed screen area (e.g. for video / touch input).</description>
- </param>
- <param name="numCustomPresetsAvailable" type="Integer" minvalue="1" maxvalue="100" mandatory="false">
- <description>The number of on-screen custom presets available (if any); otherwise omitted.</description>
- </param>
-
- <!-- TODO: Add pixel density? -->
- </struct>
-
- <struct name="ButtonCapabilities">
- <description>Contains information about a button's capabilities.</description>
- <param name="name" type="ButtonName" mandatory="true">
- <description>The name of the button. See ButtonName.</description>
- </param>
- <param name="shortPressAvailable" type="Boolean" mandatory="true">
- <description>
- The button supports a short press.
- Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked.
- </description>
- </param>
- <param name="longPressAvailable" type="Boolean" mandatory="true">
- <description>
- The button supports a LONG press.
- Whenever the button is pressed long, onButtonPressed( LONG) will be invoked.
- </description>
- </param>
- <param name="upDownAvailable" type="Boolean" mandatory="true">
- <description>
- The button supports "button down" and "button up".
- Whenever the button is pressed, onButtonEvent( DOWN) will be invoked.
- Whenever the button is released, onButtonEvent( UP) will be invoked.
- </description>
- </param>
- </struct>
-
- <struct name="RemoteControlCapabilities">
- <param name="climateControlCapabilities" type="ClimateControlCapabilities" mandatory="false" minsize="1" maxsize="100" array="true">
- <description>
- If included, the platform supports RC climate controls.
- For this baseline version, maxsize=1. i.e. only one climate control module is supported.
- </description >
- </param>
- <param name="radioControlCapabilities" type="RadioControlCapabilities" mandatory="false" minsize="1" maxsize="100" array="true">
- <description>
- If included, the platform supports RC radio controls.
- For this baseline version, maxsize=1. i.e. only one radio control module is supported.
- </description >
- </param>
- <param name="buttonCapabilities" type="ButtonCapabilities" mandatory="false" minsize="1" maxsize="100" array="true" >
- <description>If included, the platform supports RC button controls with the included button names.</description >
- </param>
- </struct>
-
- <struct name="SoftButtonCapabilities">
- <description>Contains information about a SoftButton's capabilities.</description>
- <param name="shortPressAvailable" type="Boolean" mandatory="true">
- <description>
- The button supports a short press.
- Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked.
- </description>
- </param>
- <param name="longPressAvailable" type="Boolean" mandatory="true">
- <description>
- The button supports a LONG press.
- Whenever the button is pressed long, onButtonPressed( LONG) will be invoked.
- </description>
- </param>
- <param name="upDownAvailable" type="Boolean" mandatory="true">
- <description>
- The button supports "button down" and "button up".
- Whenever the button is pressed, onButtonEvent( DOWN) will be invoked.
- Whenever the button is released, onButtonEvent( UP) will be invoked.
- </description>
- </param>
- <param name="imageSupported" type="Boolean" mandatory="true">
- <description>The button supports referencing a static or dynamic image.</description>
- </param>
- </struct>
-
- <struct name="PresetBankCapabilities">
- <description>Contains information about on-screen preset capabilities.</description>
- <param name="onScreenPresetsAvailable" type="Boolean" mandatory="true">
- <description>Onscreen custom presets are available.</description>
- </param>
- </struct>
-
- <struct name="HMICapabilities">
- <param name="navigation" type="Boolean" mandatory="false">
- <description>Availability of build in Nav. True: Available, False: Not Available</description>
- </param>
- <param name="phoneCall" type="Boolean" mandatory="false">
- <description>Availability of build in phone. True: Available, False: Not Available </description>
- </param>
- <param name="videoStreaming" type="Boolean" mandatory="false">
- <description>Availability of video streaming. True: Available, False: Not Available</description>
- </param>
- </struct>
-
- <struct name="MenuParams">
- <param name="parentID" type="Integer" minvalue="0" maxvalue="2000000000" defvalue="0" mandatory="false">
- <description>
- unique ID of the sub menu, the command will be added to.
- If not provided, it will be provided to the top level of the in application menu.
- </description>
- </param>
-
- <param name="position" type="Integer" minvalue="0" maxvalue="1000" mandatory="false">
- <description>
- Position within the items that are are at top level of the in application menu.
- 0 will insert at the front.
- 1 will insert at the second position.
- if position is greater or equal than the number of items on top level, the sub menu will be appended to the end.
- If this param was omitted the entry will be added at the end.
- </description>
- </param>
-
- <param name="menuName" type="String" maxlength="500" mandatory="true">
- <description>Text to show in the menu for this sub menu.</description>
- </param>
- </struct>
-
- <struct name="TTSChunk">
- <description>A TTS chunk, that consists of the text/phonemes to speak and the type (like text or SAPI)</description>
- <param name="text" minlength="0" maxlength="500" type="String" mandatory="true">
- <description>
- The text or phonemes to speak.
- May not be empty.
- </description>
- </param>
- <param name="type" type="SpeechCapabilities" mandatory="true">
- <description>Describes, whether it is text or a specific phoneme set. See SpeechCapabilities</description>
- </param>
- </struct>
-
- <struct name="Turn">
- <param name="navigationText" type="String" maxlength="500" mandatory="false">
- <description>Individual turn text. Must provide at least text or icon for a given turn.</description>
- </param>
- <param name="turnIcon" type="Image" mandatory="false">
- <description>Individual turn icon. Must provide at least text or icon for a given turn.</description>
- </param>
- </struct>
-
- <struct name="VehicleType">
- <param name="make" type="String" maxlength="500" mandatory="false">
- <description>Make of the vehicle, e.g. Ford</description>
- </param>
- <param name="model" type="String" maxlength="500" mandatory="false">
- <description>Model of the vehicle, e.g. Fiesta</description>
- </param>
- <param name="modelYear" type="String" maxlength="500" mandatory="false">
- <description>Model Year of the vehicle, e.g. 2013</description>
- </param>
- <param name="trim" type="String" maxlength="500" mandatory="false">
- <description>Trim of the vehicle, e.g. SE</description>
- </param>
- </struct>
-
- <enum name="KeyboardLayout">
- <description>Enumeration listing possible keyboard layouts.</description>
- <element name="QWERTY" />
- <element name="QWERTZ" />
- <element name="AZERTY" />
- </enum>
-
- <enum name="KeyboardEvent" >
- <description>Enumeration listing possible keyboard events.</description>
- <element name="KEYPRESS" />
- <element name="ENTRY_SUBMITTED" />
- <element name="ENTRY_VOICE" />
- <element name="ENTRY_CANCELLED" />
- <element name="ENTRY_ABORTED" />
- </enum>
-
- <enum name="KeypressMode">
- <description>Enumeration listing possible keyboard events.</description>
- <element name="SINGLE_KEYPRESS">
- <description>Each keypress is individually sent as the user presses the keyboard keys.</description>
- </element>
- <element name="QUEUE_KEYPRESSES">
- <description>The keypresses are queued and a string is eventually sent once the user chooses to submit their entry.</description>
- </element>
- <element name="RESEND_CURRENT_ENTRY">
- <description>The keypresses are queue and a string is sent each time the user presses a keyboard key; the string contains the entire current entry.</description>
- </element>
- </enum>
-
- <struct name="KeyboardProperties">
- <description>Configuration of on-screen keyboard (if available).</description>
-
- <param name="language" type="Language" mandatory="false">
- <description>The keyboard language.</description>
- </param>
-
- <param name="keyboardLayout" type="KeyboardLayout" mandatory="false" >
- <description>Desired keyboard layout.</description>
- </param>
-
- <param name="keypressMode" type="KeypressMode" mandatory="false" >
- <description>
- Desired keypress mode.
- If omitted, this value will be set to RESEND_CURRENT_ENTRY.
- </description>
- </param>
-
- <param name="limitedCharacterList" type="String" maxlength="1" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>Array of keyboard characters to enable.</description>
- <description>All omitted characters will be greyed out (disabled) on the keyboard.</description>
- <description>If omitted, the entire keyboard will be enabled.</description>
- </param>
-
- <param name="autoCompleteText" type="String" maxlength="1000" mandatory="false">
- <description>Allows an app to prepopulate the text field with a suggested or completed entry as the user types</description>
- </param>
-
- </struct>
-
- <struct name="DeviceInfo">
- <description>Various information abount connecting device.</description>
-
- <param name="hardware" type="String" minlength="0" maxlength="500" mandatory="false">
- <description>Device model</description>
- </param>
- <param name="firmwareRev" type="String" minlength="0" maxlength="500" mandatory="false">
- <description>Device firmware revision</description>
- </param>
- <param name="os" type="String" minlength="0" maxlength="500" mandatory="false">
- <description>Device OS</description>
- </param>
- <param name="osVersion" type="String" minlength="0" maxlength="500" mandatory="false">
- <description>Device OS version</description>
- </param>
- <param name="carrier" type="String" minlength="0" maxlength="500" mandatory="false">
- <description>Device mobile carrier (if applicable)</description>
- </param>
- <param name="maxNumberRFCOMMPorts" type="Integer" minvalue="0" maxvalue="100" mandatory="false">
- <description>Omitted if connected not via BT.</description>
- </param>
-
- </struct>
-
- <enum name="RequestType">
- <description>Enumeration listing possible asynchronous requests.</description>
- <element name="HTTP" />
- <element name="FILE_RESUME" />
- <element name="AUTH_REQUEST" />
- <element name="AUTH_CHALLENGE" />
- <element name="AUTH_ACK" />
- <element name="PROPRIETARY" />
- <element name="QUERY_APPS" />
- <element name="LAUNCH_APP" />
- <element name="LOCK_SCREEN_ICON_URL" />
- <element name="TRAFFIC_MESSAGE_CHANNEL" />
- <element name="DRIVER_PROFILE" />
- <element name="VOICE_SEARCH" />
- <element name="NAVIGATION" />
- <element name="PHONE" />
- <element name="CLIMATE" />
- <element name="SETTINGS" />
- <element name="VEHICLE_DIAGNOSTICS" />
- <element name="EMERGENCY" />
- <element name="MEDIA" />
- <element name="FOTA" />
- </enum>
-
- <enum name="AppHMIType">
- <description>Enumeration listing possible app types.</description>
- <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" />
- <element name="PROJECTION" />
- <element name="REMOTE_CONTROL" />
- </enum>
-
- <enum name="PredefinedLayout" platform="documentation">
- <description>Predefined screen layout.</description>
-
- <element name="DEFAULT" rootscreen="true">
- <description>
- Default media / non-media screen.
- Can be set as a root screen.
- </description>
- </element>
- <element name="MEDIA" rootscreen="true">
- <description>
- Default Media screen.
- Can be set as a root screen.
- </description>
- </element>
- <element name="NON-MEDIA" internal_name="NON_MEDIA" rootscreen="true">
- <description>
- Default Non-media screen.
- Can be set as a root screen.
- </description>
- </element>
- <element name="ONSCREEN_PRESETS" rootscreen="true">
- <description>
- Custom root media screen containing app-defined onscreen presets.
- Can be set as a root screen.
- </description>
- </element>
- <element name="NAV_FULLSCREEN_MAP" rootscreen="true" >
- <description>
- Custom root template screen containing full screen map with navigation controls.
- Can be set as a root screen.
- </description>
- </element>
- <element name="NAV_LIST" rootscreen="true" >
- <description>
- Custom root template screen containing video represented list.
- Can be set as a root screen.
- </description>
- </element>
- <element name="NAV_KEYBOARD" rootscreen="true" >
- <description>
- Custom root template screen containing video represented keyboard.
- Can be set as a root screen.
- </description>
- </element>
- <element name="GRAPHIC_WITH_TEXT" rootscreen="true">
- <description>
- Custom root template screen containing half-screen graphic with lines of text.
- Can be set as a root screen.
- </description>
- </element>
- <element name="TEXT_WITH_GRAPHIC" rootscreen="true">
- <description>
- Custom root template screen containing lines of text with half-screen graphic.
- Can be set as a root screen.
- </description>
- </element>
- <element name="TILES_ONLY" rootscreen="true">
- <description>
- Custom root template screen containing only tiled SoftButtons.
- Can be set as a root screen.
- </description>
- </element>
- <element name="TEXTBUTTONS_ONLY" rootscreen="true">
- <description>
- Custom root template screen containing only text SoftButtons.
- Can be set as a root screen.
- </description>
- </element>
- <element name="GRAPHIC_WITH_TILES" rootscreen="true">
- <description>
- Custom root template screen containing half-screen graphic with tiled SoftButtons.
- Can be set as a root screen.
- </description>
- </element>
- <element name="TILES_WITH_GRAPHIC" rootscreen="true">
- <description>
- Custom root template screen containing tiled SoftButtons with half-screen graphic.
- Can be set as a root screen.
- </description>
- </element>
- <element name="GRAPHIC_WITH_TEXT_AND_SOFTBUTTONS" rootscreen="true">
- <description>
- Custom root template screen containing half-screen graphic with text and SoftButtons.
- Can be set as a root screen.
- </description>
- </element>
- <element name="TEXT_AND_SOFTBUTTONS_WITH_GRAPHIC" rootscreen="true">
- <description>
- Custom root template screen containing text and SoftButtons with half-screen graphic.
- Can be set as a root screen.
- </description>
- </element>
- <element name="GRAPHIC_WITH_TEXTBUTTONS" rootscreen="true">
- <description>
- Custom root template screen containing half-screen graphic with text only SoftButtons.
- Can be set as a root screen.
- </description>
- </element>
- <element name="TEXTBUTTONS_WITH_GRAPHIC" rootscreen="true">
- <description>
- Custom root template screen containing text only SoftButtons with half-screen graphic.
- Can be set as a root screen.
- </description>
- </element>
- <element name="LARGE_GRAPHIC_WITH_SOFTBUTTONS" rootscreen="true">
- <description>
- Custom root template screen containing a large graphic and SoftButtons.
- Can be set as a root screen.
- </description>
- </element>
- <element name="DOUBLE_GRAPHIC_WITH_SOFTBUTTONS" rootscreen="true">
- <description>
- Custom root template screen containing two graphics and SoftButtons.
- Can be set as a root screen.
- </description>
- </element>
- <element name="LARGE_GRAPHIC_ONLY" rootscreen="true">
- <description>
- Custom root template screen containing only a large graphic.
- Can be set as a root screen.
- </description>
- </element>
- </enum>
-
- <enum name="FunctionID" internal_scope="base">
- <description>Enumeration linking function names with function IDs in AppLink protocol.</description>
- <description>Assumes enumeration starts at value 0.</description>
- <element name="RESERVED" value="0" />
-<!--
- Base Request / Response RPCs
- Range = 0x 0000 0001 - 0x 0000 7FFF
--->
- <element name="RegisterAppInterfaceID" value="1" hexvalue="1" />
- <element name="UnregisterAppInterfaceID" value="2" hexvalue="2" />
- <element name="SetGlobalPropertiesID" value="3" hexvalue="3" />
- <element name="ResetGlobalPropertiesID" value="4" hexvalue="4" />
- <element name="AddCommandID" value="5" hexvalue="5" />
- <element name="DeleteCommandID" value="6" hexvalue="6" />
- <element name="AddSubMenuID" value="7" hexvalue="7" />
- <element name="DeleteSubMenuID" value="8" hexvalue="8" />
- <element name="CreateInteractionChoiceSetID" value="9" hexvalue="9" />
- <element name="PerformInteractionID" value="10" hexvalue="A" />
- <element name="DeleteInteractionChoiceSetID" value="11" hexvalue="B" />
- <element name="AlertID" value="12" hexvalue="C" />
- <element name="ShowID" value="13" hexvalue="D" />
- <element name="SpeakID" value="14" hexvalue="E" />
- <element name="SetMediaClockTimerID" value="15" hexvalue="F" />
- <element name="PerformAudioPassThruID" value="16" hexvalue="10" />
- <element name="EndAudioPassThruID" value="17" hexvalue="11" />
- <element name="SubscribeButtonID" value="18" hexvalue="12" />
- <element name="UnsubscribeButtonID" value="19" hexvalue="13" />
- <element name="SubscribeVehicleDataID" value="20" hexvalue="14" />
- <element name="UnsubscribeVehicleDataID" value="21" hexvalue="15" />
- <element name="GetVehicleDataID" value="22" hexvalue="16" />
- <element name="ReadDIDID" value="23" hexvalue="17" />
- <element name="GetDTCsID" value="24" hexvalue="18" />
- <element name="ScrollableMessageID" value="25" hexvalue="19" />
- <element name="SliderID" value="26" hexvalue="1A" />
- <element name="ShowConstantTBTID" value="27" hexvalue="1B" />
- <element name="AlertManeuverID" value="28" hexvalue="1C" />
- <element name="UpdateTurnListID" value="29" hexvalue="1D" />
- <element name="ChangeRegistrationID" value="30" hexvalue="1E" />
- <element name="GenericResponseID" value="31" hexvalue="1F" />
- <element name="PutFileID" value="32" hexvalue="20" />
- <element name="DeleteFileID" value="33" hexvalue="21" />
- <element name="ListFilesID" value="34" hexvalue="22" />
- <element name="SetAppIconID" value="35" hexvalue="23" />
- <element name="SetDisplayLayoutID" value="36" hexvalue="24" />
- <element name="DiagnosticMessageID" value="37" hexvalue="25" />
- <element name="SystemRequestID" value="38" hexvalue="26" />
- <element name="SendLocationID" value="39" hexvalue="27" />
- <element name="DialNumberID" value="40" hexvalue="28" />
- <element name="ButtonPressID" value="41" hexvalue="29" />
- <element name="GetInteriorVehicleDataID" value="43" hexvalue="2B" />
- <element name="SetInteriorVehicleDataID" value="44" hexvalue="2C" />
- <element name="GetWayPointsID" value="45" hexvalue="2D" />
- <element name="SubscribeWayPointsID" value="46" hexvalue="2E"/>
- <element name="UnsubscribeWayPointsID" value="47" hexvalue="2F"/>
- <element name="GetSystemCapabilityID" value="48" hexvalue="30"/>
- <element name="SendHapticDataID" value="49" hexvalue="31" />
-
-<!--
- Base Notifications
- Range = 0x 0000 8000 - 0x 0000 FFFF
--->
-
- <element name="OnHMIStatusID" value="32768" hexvalue="8000" />
- <element name="OnAppInterfaceUnregisteredID" value="32769" hexvalue="8001" />
- <element name="OnButtonEventID" value="32770" hexvalue="8002" />
- <element name="OnButtonPressID" value="32771" hexvalue="8003" />
- <element name="OnVehicleDataID" value="32772" hexvalue="8004" />
- <element name="OnCommandID" value="32773" hexvalue="8005" />
- <element name="OnTBTClientStateID" value="32774" hexvalue="8006" />
- <element name="OnDriverDistractionID" value="32775" hexvalue="8007" />
- <element name="OnPermissionsChangeID" value="32776" hexvalue="8008" />
- <element name="OnAudioPassThruID" value="32777" hexvalue="8009" />
- <element name="OnLanguageChangeID" value="32778" hexvalue="800A" />
- <element name="OnKeyboardInputID" value="32779" hexvalue="800B" />
- <element name="OnTouchEventID" value="32780" hexvalue="800C" />
- <element name="OnSystemRequestID" value="32781" hexvalue="800D" />
- <element name="OnHashChangeID" value="32782" hexvalue="800E" />
- <element name="OnInteriorVehicleDataID" value="32783" hexvalue="800F" />
- <element name="OnWayPointChangeID" value="32784" hexvalue="8010" />
-
-<!--
- Ford Specific Request / Response RPCs
- Range = 0x 0001 0000 - 0x 0001 7FFF
--->
-
- <element name="EncodedSyncPDataID" value="65536" hexvalue="10000" />
- <element name="SyncPDataID" value="65537" hexvalue="10001" />
-
-<!--
- Ford Specific Notifications
- Range = 0x 0001 8000 - 0x 0001 FFFF
--->
-
- <element name="OnEncodedSyncPDataID" value="98304" hexvalue="18000" />
- <element name="OnSyncPDataID" value="98305" hexvalue="18001" />
- </enum>
-
- <enum name="messageType">
- <description>
- Enumeration linking message types with function types in WiPro protocol.
- Assumes enumeration starts at value 0.
- </description>
- <element name="request" value="0" />
- <element name="response" value="1" />
- <element name="notification" value="2" />
- </enum>
-
- <struct name="DateTime">
- <param name="millisecond" type="Integer" minvalue="0" maxvalue="999" mandatory="false">
- <description>Milliseconds </description>
- </param>
- <param name="second" type="Integer" minvalue="0" maxvalue="60" mandatory="false">
- <description>Seconds part of time</description>
- </param>
- <param name="minute" type="Integer" minvalue="0" maxvalue="59" mandatory="false">
- <description>Minutes part of time</description>
- </param>
- <param name="hour" type="Integer" minvalue="0" maxvalue="23" mandatory="false">
- <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="false">
- <description>Day of the month</description>
- </param>
- <param name="month" type="Integer" minvalue="1" maxvalue="12" mandatory="false">
- <description>Month of the year</description>
- </param>
- <param name="year" type="Integer" maxvalue="4095" mandatory="false">
- <description>The year in YYYY format</description>
- </param>
- <param name="tz_hour" type="Integer" minvalue="-12" maxvalue="14" defvalue="0" mandatory="false">
- <description>Time zone offset in Hours wrt UTC.</description>
- </param>
- <param name="tz_minute" type="Integer" minvalue="0" maxvalue="59" defvalue="0" mandatory="false">
- <description>Time zone offset in Min wrt UTC.</description>
- </param>
- </struct>
-
- <enum name="WayPointType">
- <description>Describes what kind of waypoint is requested/provided.</description>
- <element name="ALL" />
- <element name="DESTINATION" />
- </enum>
-
- <struct name="Coordinate">
- <param name="latitudeDegrees" minvalue="-90" maxvalue="90" type="Float" mandatory="true">
- <description>Latitude of the location.</description>
- </param>
- <param name="longitudeDegrees" minvalue="-180" maxvalue="180" type="Float" mandatory="true">
- <description>Longitude of the location.</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>
-
- <struct name="LocationDetails">
- <param name="coordinate" type="Coordinate" mandatory="false">
- <description>Latitude/Longitude of the location.</description>
- </param>
- <param name="locationName" type="String" maxlength="500" mandatory="false">
- <description>Name of location.</description>
- </param>
- <param name="addressLines" type="String" maxlength="500" minsize="0" maxsize="4" array="true" mandatory="false">
- <description>Location address for display purposes only</description>
- </param>
- <param name="locationDescription" type="String" maxlength="500" mandatory="false">
- <description>Description intended location / establishment (if applicable)</description>
- </param>
- <param name="phoneNumber" type="String" maxlength="500" mandatory="false">
- <description>Phone number of location / establishment.</description>
- </param>
- <param name="locationImage" type="Image" mandatory="false">
- <description>Image / icon of intended location.</description>
- </param>
- <param name="searchAddress" type="OASISAddress" mandatory="false">
- <description>Address to be used by navigation engines for search</description>
- </param>
- </struct>
-
- <enum name="SystemCapabilityType">
- <element name="NAVIGATION"/>
- <element name="PHONE_CALL"/>
- <element name="VIDEO_STREAMING"/>
- <element name="AUDIO_STREAMING"/>
- <element name="REMOTE_CONTROL"/>
- </enum>
-
- <struct name="NavigationCapability">
- <description>Extended capabilities for an onboard navigation system</description>
- <param name="sendLocationEnabled" type="Boolean" mandatory="false">
- <description>If the module has the ability to add locations to the onboard nav</description>
- </param>
- <param name="getWayPointsEnabled" type="Boolean" mandatory="false">
- <description>If the module has the ability to return way points from onboard nav</description>
- </param>
- </struct>
-
- <struct name="PhoneCapability">
- <description>Extended capabilities of the module's phone feature</description>
- <param name="dialNumberEnabled" type="Boolean" mandatory="false">
- <description>If the module has the abiulity to perform dial number</description>
- </param>
- </struct>
-
- <struct name="VideoStreamingCapability">
- <description>Contains information about this system's video streaming capabilities.</description>
- <param name="preferredResolution" type="ImageResolution" mandatory="false">
- <description>The preferred resolution of a video stream for decoding and rendering on HMI.</description>
- </param>
- <param name="maxBitrate" type="Integer" minvalue="0" maxvalue="2147483647" mandatory="false">
- <description>The maximum bitrate of video stream that is supported, in kbps.</description>
- </param>
- <param name="supportedFormats" type="VideoStreamingFormat" array="true" mandatory="false">
- <description>
- Detailed information on each format supported by this system, in its preferred order
- (i.e. the first element in the array is most preferable to the system).
- Each object will contain a VideoStreamingFormat that describes what can be expected.
- </description>
- </param>
- <param name="hapticSpatialDataSupported" type="Boolean" mandatory="false">
- <description>True if the system can utilize the haptic spatial data from the source being streamed.</description>
- </param>
- </struct>
-
- <struct name="SystemCapability">
- <description>The systemCapabilityType indicates which type of data should be changed and identifies which data object exists in this struct. For example, if the SystemCapability Type is NAVIGATION then a "navigationCapability" should exist</description>
- <param name="systemCapabilityType" type="SystemCapabilityType" mandatory="true">
- </param>
- <param name="navigationCapability" type="NavigationCapability" mandatory="false">
- </param>
- <param name="phoneCapability" type="PhoneCapability" mandatory="false">
- </param>
- <param name="videoStreamingCapability" type="VideoStreamingCapability" mandatory="false">
- </param>
- <param name="remoteControlCapability" type="RemoteControlCapabilities" mandatory="false">
- </param>
- </struct>
-
- <struct name="Rectangle">
- <param name="x" type="Float" mandatory="true">
- <description>The upper left X-coordinate of the rectangle</description>
- </param>
- <param name="y" type="Float" mandatory="true">
- <description>The upper left Y-coordinate of the rectangle</description>
- </param>
- <param name="width" type="Float" mandatory="true">
- <description>The width of the rectangle</description>
- </param>
- <param name="height" type="Float" mandatory="true">
- <description>The height of the rectangle</description>
- </param>
- </struct>
-
- <struct name="HapticRect">
- <description>Defines haptic data for each user control object for video streaming application</description>
- <param name="id" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
- <description>A user control spatial identifier</description>
- </param>
- <param name="rect" type="Rectangle" mandatory="true">
- <description>The position of the haptic rectangle to be highlighted. The center of this rectangle will be "touched" when a press occurs.</description>
- </param>
- </struct>
-
- <!-- Requests/Responses -->
-
- <function name="RegisterAppInterface" functionID="RegisterAppInterfaceID" messagetype="request">
- <description>
- Establishes an interface with a mobile application.
- Before registerAppInterface no other commands will be accepted/executed.
- </description>
-
- <param name="syncMsgVersion" type="SyncMsgVersion" mandatory="true">
- <description>See SyncMsgVersion</description>
- </param>
-
- <param name="appName" type="String" maxlength="100" mandatory="true">
- <description>
- The mobile application name, e.g. "Ford Drive Green".
- Needs to be unique over all applications.
- May not be empty.
- May not start with a new line character.
- May not interfere with any name or synonym of previously registered applications and any predefined blacklist of words (global commands)
- Needs to be unique over all applications. Applications with the same name will be rejected.
- Only characters from char set [@TODO: Create char set (character/hex value) for each ACM and refer to] are supported.
- </description>
- </param>
-
- <param name="ttsName" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" >
- <description>
- TTS string for VR recognition of the mobile application name, e.g. "Ford Drive Green".
- Meant to overcome any failing on speech engine in properly pronouncing / understanding app name.
- Needs to be unique over all applications.
- May not be empty.
- May not start with a new line character.
- Only characters from char set [@TODO: Create char set (character/hex value) for each ACM and refer to] are supported.
- </description>
- </param>
-
- <param name="ngnMediaScreenAppName" type="String" maxlength="100" mandatory="false">
- <description>
- Provides an abbreviated version of the app name (if needed), that will be displayed on the NGN media screen.
- If not provided, the appName is used instead (and will be truncated if too long)
- Only characters from char set [@TODO: Create char set (character/hex value) for each ACM and refer to] are supported.
- </description>
- </param>
-
- <param name="vrSynonyms" type="String" maxlength="40" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>
- Defines an additional voice recognition command.
- May not interfere with any app name of previously registered applications and any predefined blacklist of words (global commands)
- Only characters from char set [@TODO: Create char set (character/hex value) for each ACM and refer to] are supported.
- </description>
- </param>
-
- <param name="isMediaApplication" type="Boolean" mandatory="true">
- <description>
- Indicates if the application is a media or a non-media application.
- Only media applications will be able to stream audio to Sync that is audible outside of the BT media source.
- </description>
- </param>
- <param name="languageDesired" type="Language" mandatory="true">
- <description>
- See Language
- Current app's expected VR+TTS language
- If there is a mismatch with SYNC, the app will be able to change this registration with changeRegistration prior to app being brought into focus.
- </description>
- </param>
- <param name="hmiDisplayLanguageDesired" type="Language" mandatory="true">
- <description>
- See Language
- Current app's expected display language
- If there is a mismatch with SYNC, the app will be able to change this registration with changeRegistration prior to app being brought into focus.
- </description>
- </param>
-
- <param name="appHMIType" type="AppHMIType" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>
- See AppHMIType
- List of all applicable app HMI types stating which HMI classifications to be given to the app.
- </description>
- </param>
-
- <param name="hashID" type="String" maxlength="100" mandatory="false">
- <description>
- ID used to uniquely identify current state of all app data that can persist through connection cycles (e.g. ignition cycles).
- This registered data (commands, submenus, choice sets, etc.) can be reestablished without needing to explicitly reregister each piece.
- If omitted, then the previous state of an app's commands, etc. will not be restored.
- When sending hashID, all RegisterAppInterface parameters should still be provided (e.g. ttsName, etc.).
- </description>
- </param>
- <param name="deviceInfo" type="DeviceInfo" mandatory="false">
- <description>
- See DeviceInfo.
- </description>
- </param>
- <param name="appID" type="String" maxlength="100" mandatory="true">
- <description>ID used to validate app with policy table entries</description>
- </param>
- <param name="appInfo" type="AppInfo" mandatory="false">
- <description>
- See AppInfo.
- </description>
- </param>
- </function>
-
- <function name="RegisterAppInterface" functionID="RegisterAppInterfaceID" messagetype="response">
- <description>The response to registerAppInterface</description>
-
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="GENERIC_ERROR"/>
- <element name="DUPLICATE_NAME"/>
- <element name="TOO_MANY_APPLICATIONS"/>
- <element name="APPLICATION_REGISTERED_ALREADY"/>
- <element name="UNSUPPORTED_VERSION"/>
- <element name="WRONG_LANGUAGE"/>
- <element name="DISALLOWED"/>
- <element name="WARNINGS"/>
- <element name="RESUME_FAILED"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- <param name="syncMsgVersion" type="SyncMsgVersion" mandatory="false">
- <description>See SyncMsgVersion</description>
- </param>
-
- <param name="language" type="Language" mandatory="false">
- <description>The currently active VR+TTS language on Sync. See "Language" for options.</description>
- </param>
-
- <param name="hmiDisplayLanguage" type="Language" mandatory="false">
- <description>The currently active display language on Sync. See "Language" for options.</description>
- </param>
-
- <param name="displayCapabilities" type="DisplayCapabilities" mandatory="false">
- <description>See DisplayCapabilities</description>
- </param>
-
- <param name="buttonCapabilities" type="ButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>See ButtonCapabilities</description >
- </param>
-
- <param name="softButtonCapabilities" type="SoftButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>If returned, the platform supports on-screen SoftButtons; see SoftButtonCapabilities.</description >
- </param>
-
- <param name="presetBankCapabilities" type="PresetBankCapabilities" mandatory="false">
- <description>If returned, the platform supports custom on-screen Presets; see PresetBankCapabilities.</description >
- </param>
-
- <param name="hmiZoneCapabilities" type="HmiZoneCapabilities" minsize="1" maxsize="100" array="true" mandatory="false">
- <issue creator="rs">If not used yet => remove</issue>
- <description>See HmiZoneCapabilities</description>
- </param>
-
- <param name="speechCapabilities" type="SpeechCapabilities" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>See SpeechCapabilities</description>
- </param>
-
- <param name="prerecordedSpeech" type="PrerecordedSpeech" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>See PrerecordedSpeech</description>
- </param>
-
- <param name="vrCapabilities" type="VrCapabilities" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>See VrCapabilities</description>
- </param>
-
- <param name="audioPassThruCapabilities" type="AudioPassThruCapabilities" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>See AudioPassThruCapability</description>
- </param>
-
- <param name="pcmStreamCapabilities" type="AudioPassThruCapabilities" array="false" mandatory="false">
- <description>See AudioPassThruCapability</description>
- </param>
-
- <param name="vehicleType" type="VehicleType" mandatory="false">
- <description>Specifies the vehicle's type. See VehicleType.</description>
- </param>
-
- <param name="supportedDiagModes" type="Integer" minvalue="0" maxvalue="255" array="true" minsize="1" maxsize="100" mandatory="false" >
- <description>
- Specifies the white-list of supported diagnostic modes (0x00-0xFF) capable for DiagnosticMessage requests.
- If a mode outside this list is requested, it will be rejected.
- </description>
- </param>
-
- <param name="hmiCapabilities" type="HMICapabilities" mandatory="false">
- <description>Specifies the HMI’s capabilities. See HMICapabilities.</description>
- </param>
-
- <param name="sdlVersion" type="String" maxlength="100" mandatory="false" platform="documentation">
- <description>The SmartDeviceLink version.</description>
- </param>
-
- <param name="systemSoftwareVersion" type="String" maxlength="100" mandatory="false" platform="documentation">
- <description>The software version of the system that implements the SmartDeviceLink core.</description>
- </param>
-
- </function>
-
- <function name="UnregisterAppInterface" functionID="UnregisterAppInterfaceID" messagetype="request">
- <description>
- Closes an interface from a mobile application.
- After unregisterAppInterface, no commands other than registerAppInterface will be accepted/executed.
- Will fail, if no registerAppInterface was completed successfully before.
- </description>
- </function>
-
- <function name="UnregisterAppInterface" functionID="UnregisterAppInterfaceID" messagetype="response">
-
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- </function>
-
- <function name="SetGlobalProperties" functionID="SetGlobalPropertiesID" messagetype="request">
- <description>Allows setting global properties.</description>
-
- <param name="helpPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" >
- <description>
- The help prompt.
- An array of text chunks of type TTSChunk. See TTSChunk.
- The array must have at least one item.
- </description>
- </param>
-
- <param name="timeoutPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" >
- <description>
- Help text for a wait timeout.
- An array of text chunks of type TTSChunk. See TTSChunk.
- The array must have at least one item.
- </description>
- </param>
-
- <param name="vrHelpTitle" type="String" maxlength="500" mandatory="false">
- <description>
- VR Help Title text.
- If omitted on supported displays, the default SYNC help title shall be used.
- If omitted and one or more vrHelp items are provided, the request will be rejected.
- </description>
- </param>
-
- <param name="vrHelp" type="VrHelpItem" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>
- VR Help Items.
- If omitted on supported displays, the default AppLink VR help / What Can I Say? screen shall be used.
- If the list of VR Help Items contains nonsequential positions (e.g. [1,2,4]), the RPC shall be rejected.
- If omitted and a vrHelpTitle is provided, the request will be rejected.
- </description>
- </param>
- <param name="menuTitle" maxlength="500" type="String" mandatory="false">
- <description>Optional text to label an app menu button (for certain touchscreen platforms).</description>
- </param>
-
- <param name="menuIcon" type="Image" mandatory="false">
- <description>>Optional icon to draw on an app menu button (for certain touchscreen platforms).</description>
- </param>
-
- <param name="keyboardProperties" type="KeyboardProperties" mandatory="false">
- <description>On-screen keybaord configuration (if available).</description>
- </param>
- </function>
-
- <function name="SetGlobalProperties" functionID="SetGlobalPropertiesID" messagetype="response">
-
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="UNSUPPORTED_RESOURCE"/>
- <element name="WARNINGS"/>
- <element name="DISALLOWED"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- </function>
-
- <function name="ResetGlobalProperties" functionID="ResetGlobalPropertiesID" messagetype="request">
- <description>Allows resetting global properties.</description>
-
- <param name="properties" type="GlobalProperty" minsize="1" maxsize="100" array="true" mandatory="true">
- <description>Contains the names of all global properties (like timeoutPrompt) that should be unset. Resetting means, that they have the same value as at start up (default)</description>
- </param>
- </function>
-
- <function name="ResetGlobalProperties" functionID="ResetGlobalPropertiesID" messagetype="response">
-
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="DISALLOWED"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="AddCommand" functionID="AddCommandID" messagetype="request">
- <description>
- Adds a command to the in application menu.
- Either menuParams or vrCommands must be provided.
- </description>
-
- <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
- <description>unique ID of the command to add.</description>
- </param>
-
- <param name="menuParams" type="MenuParams" mandatory="false">
- <description>Optional sub value containing menu parameters</description>
- </param>
-
- <param name="vrCommands" type="String" minsize="1" maxsize="100" maxlength="99" array="true" mandatory="false">
- <description>
- An array of strings to be used as VR synonyms for this command.
- If this array is provided, it may not be empty.
- </description>
- </param>
-
- <param name="cmdIcon" type="Image" mandatory="false">
- <description>
- Image struct determining whether static or dynamic icon.
- If omitted on supported displays, no (or the default if applicable) icon shall be displayed.
- </description>
- </param>
-
- </function>
-
- <function name="AddCommand" functionID="AddCommandID" messagetype="response">
-
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="INVALID_ID"/>
- <element name="DUPLICATE_NAME"/>
- <element name="UNSUPPORTED_RESOURCE"/>
- <element name="DISALLOWED"/>
- <element name="WARNINGS"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- </function>
-
- <function name="DeleteCommand" functionID="DeleteCommandID" messagetype="request">
- <description>Deletes all commands from the in-application menu with the specified command id.</description>
-
- <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
- <description>ID of the command(s) to delete.</description>
- </param>
-
- </function>
-
- <function name="DeleteCommand" functionID="DeleteCommandID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="INVALID_ID"/>
- <element name="IN_USE"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- </function>
-
- <function name="AddSubMenu" functionID="AddSubMenuID" messagetype="request">
- <description>Adds a sub menu to the in-application menu.</description>
-
- <param name="menuID" type="Integer" minvalue="1" maxvalue="2000000000" mandatory="true">
- <description>unique ID of the sub menu to add.</description>
- </param>
-
- <param name="position" type="Integer" minvalue="0" maxvalue="1000" defvalue="1000" mandatory="false">
- <description>
- Position within the items that are are at top level of the in application menu.
- 0 will insert at the front.
- 1 will insert at the second position.
- If position is greater or equal than the number of items on top level, the sub menu will be appended to the end.
- Position of any submenu will always be located before the return and exit options
- If this param was omitted the entry will be added at the end.
- </description>
- </param>
-
- <param name="menuName" maxlength="500" type="String" mandatory="true">
- <description>Text to show in the menu for this sub menu.</description>
- </param>
- </function>
-
- <function name="AddSubMenu" functionID="AddSubMenuID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="INVALID_ID"/>
- <element name="DUPLICATE_NAME"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="DeleteSubMenu" functionID="DeleteSubMenuID" messagetype="request">
- <description>Deletes a submenu from the in-application menu.</description>
-
- <param name="menuID" type="Integer" minvalue="1" maxvalue="2000000000" mandatory="true">
- <description>The "menuID" of the submenu to delete. (See addSubMenu.menuID)</description>
- </param>
-
- </function>
-
- <function name="DeleteSubMenu" functionID="DeleteSubMenuID" messagetype="response">
-
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="INVALID_ID"/>
- <element name="IN_USE"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- </function>
-
- <function name="CreateInteractionChoiceSet" functionID="CreateInteractionChoiceSetID" messagetype="request">
- <description>creates interaction choice set to be used later by performInteraction</description>
-
- <param name="interactionChoiceSetID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
- <description>Unique ID used for this interaction choice set.</description>
- </param>
-
- <param name="choiceSet" type="Choice" minsize="1" maxsize="100" array="true" mandatory="true"/>
- </function>
-
- <function name="CreateInteractionChoiceSet" functionID="CreateInteractionChoiceSetID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="INVALID_ID"/>
- <element name="DUPLICATE_NAME"/>
- <element name="UNSUPPORTED_RESOURCE"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="PerformInteraction" functionID="PerformInteractionID" messagetype="request">
- <description>Triggers an interaction (e.g. "Permit GPS?" - Yes, no, Always Allow).</description>
-
- <param name="initialText" type="String" maxlength="500" mandatory="true">
- <description>
- Text to be displayed first.
- </description>
- </param>
-
- <param name="initialPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>
- This is the intial prompt spoken to the user at the start of an interaction.
- An array of text chunks of type TTSChunk. See TTSChunk.
- The array must have at least one item.
- </description>
- </param>
-
- <param name="interactionMode" type="InteractionMode" mandatory="true">
- <description>See InteractionMode.</description>
- </param>
-
- <param name="interactionChoiceSetIDList" type="Integer" minsize="0" maxsize="100" minvalue="0" maxvalue="2000000000" array="true" mandatory="true">
- <description>List of interaction choice set IDs to use with an interaction.</description>
- </param>
-
- <param name="helpPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>
- Help text. This is the spoken string when a user speaks "help" when the interaction is occuring.
- An array of text chunks of type TTSChunk. See TTSChunk.
- The array must have at least one item.
- </description>
- </param>
-
- <param name="timeoutPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>
- Timeout text. This text is spoken when a VR interaction times out.
- An array of text chunks of type TTSChunk. See TTSChunk.
- The array must have at least one item.
- </description>
- </param>
-
- <param name="timeout" type="Integer" minvalue="5000" maxvalue="100000" defvalue="10000" mandatory="false">
- <description>
- Timeout in milliseconds.
- If omitted a standard value of 10000 milliseconds is used.
- Applies only to the menu portion of the interaction. The VR timeout will be handled by the platform.
- </description>
- </param>
-
- <param name="vrHelp" type="VrHelpItem" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>
- Ability to send suggested VR Help Items to display on-screen during Perform Interaction.
- If omitted on supported displays, the default SYNC generated list of suggested choices shall be displayed.
- </description>
- </param>
-
- <param name="interactionLayout" type="LayoutMode" mandatory="false">
- <description>See LayoutMode.</description>
- </param>
-
- </function>
-
- <function name="PerformInteraction" functionID="PerformInteractionID" messagetype="response">
-
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="INVALID_ID"/>
- <element name="DUPLICATE_NAME"/>
- <element name="TIMED_OUT"/>
- <element name="ABORTED"/>
- <element name="UNSUPPORTED_RESOURCE"/>
- <element name="WARNINGS"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- <param name="choiceID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
- <description>
- ID of the choice that was selected in response to PerformInteraction.
- Only is valid if general result is "success:true".
- </description>
- </param>
-
- <param name="manualTextEntry" type="String" maxlength="500" mandatory="false">
- <description>
- Manually entered text selection, e.g. through keyboard
- Can be returned in lieu of choiceID, depending on trigger source
- </description>
- </param>
-
- <param name="triggerSource" type="TriggerSource" mandatory="false">
- <description>
- See TriggerSource
- Only is valid if resultCode is SUCCESS.
- </description>
- </param>
-
- </function>
-
- <function name="DeleteInteractionChoiceSet" functionID="DeleteInteractionChoiceSetID" messagetype="request">
- <description>Deletes interaction choice set that has been created with "CreateInteractionChoiceSet".</description>
- <description>The interaction may only be deleted when not currently in use by a "performInteraction".</description>
-
- <param name="interactionChoiceSetID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
- <description>ID of the interaction choice set to delete.</description>
- </param>
- </function>
-
- <function name="DeleteInteractionChoiceSet" functionID="DeleteInteractionChoiceSetID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="INVALID_ID"/>
- <element name="IN_USE"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="Alert" functionID="AlertID" messagetype="request">
- <description>Shows an alert which typically consists of text-to-speech message and text on the display. At least either alertText1, alertText2 or TTSChunks need to be provided.</description>
-
- <param name="alertText1" type="String" maxlength="500" mandatory="false">
- <description>The first line of the alert text field</description>
- </param>
-
- <param name="alertText2" type="String" maxlength="500" mandatory="false">
- <description>The second line of the alert text field</description>
- </param>
-
- <param name="alertText3" type="String" maxlength="500" mandatory="false">
- <description>The optional third line of the alert text field</description>
- </param>
-
- <param name="ttsChunks" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>
- An array of text chunks of type TTSChunk. See TTSChunk.
- The array must have at least one item.
- </description>
- </param>
-
- <param name="duration" type="Integer" minvalue="3000" maxvalue="10000" defvalue="5000" mandatory="false">
- <description>
- Timeout in milliseconds.
- Typical timeouts are 3-5 seconds.
- If omitted, timeout is set to 5s.
- </description>
- </param>
-
- <param name="playTone" type="Boolean" mandatory="false">
- <description>
- Defines if tone should be played. Tone is played before TTS.
- If omitted, no tone is played.
- </description>
- </param>
-
- <param name="progressIndicator" type="Boolean" mandatory="false">
- <description>
- If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc.
- </description>
- </param>
-
- <param name="softButtons" type="SoftButton" minsize="0" maxsize="4" array="true" mandatory="false">
- <description>
- App defined SoftButtons.
- If omitted on supported displays, the displayed alert shall not have any SoftButtons.
- </description>
- </param>
-
- </function>
-
- <function name="Alert" functionID="AlertID" messagetype="response">
-
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="ABORTED"/>
- <element name="DISALLOWED"/>
- <element name="USER_DISALLOWED"/>
- <element name="UNSUPPORTED_RESOURCE"/>
- <element name="WARNINGS"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- <param name="tryAgainTime" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
- <description>
- Amount of time (in seconds) that an app must wait before resending an alert.
- If provided, another system event or overlay currently has a higher priority than this alert.
- An app must not send an alert without waiting at least the amount of time dictated.
- </description>
- </param>
-
- </function>
-
- <function name="Show" functionID="ShowID" messagetype="request">
- <description>Updates the persistent display. Supported fields depend on display capabilities.</description>
-
- <param name="mainField1" type="String" minlength="0" maxlength="500" mandatory="false">
- <description>
- The text that should be displayed in a single or upper display line.
- If this text is not set, the text of mainField1 stays unchanged.
- If this text is empty "", the field will be cleared.
- </description>
- </param>
-
- <param name="mainField2" type="String" minlength="0" maxlength="500" mandatory="false">
- <description>
- The text that should be displayed on the second display line.
- If this text is not set, the text of mainField2 stays unchanged.
- If this text is empty "", the field will be cleared.
- </description>
- </param>
-
- <param name="mainField3" type="String" minlength="0" maxlength="500" mandatory="false">
- <description>
- The text that should be displayed on the second "page" first display line.
- If this text is not set, the text of mainField3 stays unchanged.
- If this text is empty "", the field will be cleared.
- </description>
- </param>
-
- <param name="mainField4" type="String" minlength="0" maxlength="500" mandatory="false">
- <description>
- The text that should be displayed on the second "page" second display line.
- If this text is not set, the text of mainField4 stays unchanged.
- If this text is empty "", the field will be cleared.
- </description>
- </param>
-
- <param name="alignment" type="TextAlignment" mandatory="false">
- <description>
- Specifies how mainField1 and mainField2 texts should be aligned on display.
- If omitted, texts will be centered.
- </description>
- </param>
-
- <param name="statusBar" type="String" minlength="0" maxlength="500" mandatory="false">
- <description>Requires investigation regarding the nav display capabilities. Potentially lower lowerStatusBar, upperStatusBar, titleBar, etc.</description>
- </param>
-
- <param name="mediaClock" type="String" minlength="0" maxlength="500" mandatory="false">
- <description>
- Text value for MediaClock field. Has to be properly formatted by Mobile App according to Sync capabilities.
- If this text is set, any automatic media clock updates previously set with SetMediaClockTimer will be stopped.
- </description>
- </param>
-
- <param name="mediaTrack" type="String" minlength="0" maxlength="500" mandatory="false">
- <description>
- The text that should be displayed in the track field.
- If this text is not set, the text of mediaTrack stays unchanged.
- If this text is empty "", the field will be cleared.
- </description>
- </param>
-
- <param name="graphic" type="Image" mandatory="false">
- <description>
- Image struct determining whether static or dynamic image to display in app.
- If omitted on supported displays, the displayed graphic shall not change.
- </description>
- </param>
-
- <param name="secondaryGraphic" type="Image" mandatory="false">
- <description>
- Image struct determining whether static or dynamic secondary image to display in app.
- If omitted on supported displays, the displayed secondary graphic shall not change.
- </description>
- </param>
-
-
- <param name="softButtons" type="SoftButton" minsize="0" maxsize="8" array="true" mandatory="false">
- <description>
- App defined SoftButtons.
- If omitted on supported displays, the currently displayed SoftButton values will not change.
- </description>
- </param>
-
- <param name="customPresets" type="String" maxlength="500" minsize="0" maxsize="10" array="true" mandatory="false">
- <description>
- App labeled on-screen presets (i.e. on-screen media presets or dynamic search suggestions).
- If omitted on supported displays, the presets will be shown as not defined.
- </description>
- </param>
-
- <param name="metadataTags" type="MetadataTags" mandatory="false">
- <description>
- App defined metadata information. See MetadataTags. Uses mainField1, mainField2, mainField3, mainField4.
- If omitted on supported displays, the currently set metadata tags will not change.
- If any text field contains no tags, the metadata tag for that textfield should be removed.
- </description>
- </param>
-
- </function>
-
- <function name="Show" functionID="ShowID" messagetype="response">
-
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="DISALLOWED"/>
- <element name="UNSUPPORTED_RESOURCE"/>
- <element name="WARNINGS"/>
- <element name="ABORTED"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="Speak" functionID="SpeakID" messagetype="request">
- <description>Speaks a text.</description>
-
- <param name="ttsChunks" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="true">
- <description>
- An array of text chunks of type TTSChunk. See TTSChunk.
- The array must have at least one item.
- </description>
- </param>
-
- </function>
-
- <function name="Speak" functionID="SpeakID" messagetype="response">
-
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="DISALLOWED"/>
- <element name="ABORTED"/>
- <element name="WARNINGS"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- </function>
-
- <function name="SetMediaClockTimer" functionID="SetMediaClockTimerID" messagetype="request">
- <description>Sets the initial media clock value and automatic update method.</description>
-
- <param name="startTime" type="StartTime" mandatory="false">
- <description>
- See StartTime.
- startTime must be provided for "COUNTUP" and "COUNTDOWN".
- startTime will be ignored for "RESUME", and "CLEAR"
- startTime can be sent for "PAUSE", in which case it will update the paused startTime
- </description>
- </param>
-
- <param name="endTime" type="StartTime" mandatory="false">
- <description>
- See StartTime.
- endTime can be provided for "COUNTUP" and "COUNTDOWN"; to be used to calculate any visual progress bar (if not provided, this feature is ignored)
- If endTime is greater then startTime for COUNTDOWN or less than startTime for COUNTUP, then the request will return an INVALID_DATA.
- endTime will be ignored for "RESUME", and "CLEAR"
- endTime can be sent for "PAUSE", in which case it will update the paused endTime
- </description>
- </param>
-
- <param name="updateMode" type="UpdateMode" mandatory="true">
- <description>
- Enumeration to control the media clock.
- In case of pause, resume, or clear, the start time value is ignored and shall be left out. For resume, the time continues with the same value as it was when paused.
- </description>
- </param>
- </function>
-
- <function name="SetMediaClockTimer" functionID="SetMediaClockTimerID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="IGNORED"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="PerformAudioPassThru" functionID="PerformAudioPassThruID" messagetype="request">
- <description>Starts audio pass thru session </description>
- <param name="initialPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>
- SYNC will speak this prompt before opening the audio pass thru session.
- An array of text chunks of type TTSChunk. See TTSChunk.
- The array must have at least one item.
- If omitted, then no initial prompt is spoken.
- </description>
- </param>
- <param name="audioPassThruDisplayText1" type="String" mandatory="false" maxlength="500">
- <description>First line of text displayed during audio capture.</description>
- </param>
- <param name="audioPassThruDisplayText2" type="String" mandatory="false" maxlength="500">
- <description>Second line of text displayed during audio capture.</description>
- </param>
- <param name="samplingRate" type="SamplingRate" mandatory="true">
- <description> This value shall be allowed at 8 khz or 16 or 22 or 44 khz.</description>
- </param>
- <param name="maxDuration" type="Integer" minvalue="1" maxvalue="1000000" mandatory="true">
- <description>The maximum duration of audio recording in milliseconds. </description>
- </param>
- <param name="bitsPerSample" type="BitsPerSample" mandatory="true">
- <description>Specifies the quality the audio is recorded. Currently 8 bit or 16 bit.</description>
- </param>
- <param name="audioType" type="AudioType" mandatory="true">
- <description>Specifies the type of audio data being requested.</description>
- </param>
- <param name="muteAudio" type="Boolean" mandatory="false">
- <description>
- Defines if the current audio source should be muted during the APT session. If not, the audio source will play without interruption.
- If omitted, the value is set to true.
- </description>
- </param>
- </function>
-
- <function name="PerformAudioPassThru" functionID="PerformAudioPassThruID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="DISALLOWED"/>
- <element name="REJECTED"/>
- <element name="ABORTED"/>
- <element name="RETRY"/>
- <element name="WARNINGS"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="EndAudioPassThru" functionID="EndAudioPassThruID" messagetype="request">
- <description>When this request is invoked, the audio capture stops.</description>
- </function>
-
- <function name="EndAudioPassThru" functionID="EndAudioPassThruID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="DISALLOWED"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="SubscribeButton" functionID="SubscribeButtonID" messagetype="request">
- <description>
- Subscribes to built-in HMI buttons.
- The application will be notified by the OnButtonEvent and OnButtonPress.
- To unsubscribe the notifications, use unsubscribeButton.
- </description>
-
- <param name="buttonName" type="ButtonName" mandatory="true">
- <description>Name of the button to subscribe.</description>
- </param>
- </function>
-
- <function name="SubscribeButton" functionID="SubscribeButtonID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="UNSUPPORTED_RESOURCE" />
- <element name="IGNORED" />
- <element name="REJECTED"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="UnsubscribeButton" functionID="UnsubscribeButtonID" messagetype="request">
- <description>Unsubscribes from built-in HMI buttons.</description>
-
- <param name="buttonName" type="ButtonName" mandatory="true">
- <description>Name of the button to unsubscribe.</description>
- </param>
- </function>
-
- <function name="UnsubscribeButton" functionID="UnsubscribeButtonID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="UNSUPPORTED_RESOURCE" />
- <element name="IGNORED" />
- <element name="REJECTED"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="SubscribeVehicleData" functionID="SubscribeVehicleDataID" messagetype="request">
- <description>
- Subscribes for specific published data items.
- The data will be only sent if it has changed.
- The application will be notified by the onVehicleData notification whenever new data is available.
- To unsubscribe the notifications, use unsubscribe with the same subscriptionType.
- </description>
-
- <param name="gps" type="Boolean" mandatory="false">
- <description>See GPSData</description>
- </param>
- <param name="speed" type="Boolean" mandatory="false">
- <description>The vehicle speed in kilometers per hour</description>
- </param>
- <param name="rpm" type="Boolean" mandatory="false">
- <description>The number of revolutions per minute of the engine</description>
- </param>
- <param name="fuelLevel" type="Boolean" mandatory="false">
- <description>The fuel level in the tank (percentage)</description>
- </param>
- <param name="fuelLevel_State" type="Boolean" mandatory="false">
- <description>The fuel level state</description>
- </param>
- <param name="instantFuelConsumption" type="Boolean" mandatory="false">
- <description>The instantaneous fuel consumption in microlitres</description>
- </param>
- <param name="externalTemperature" type="Boolean" mandatory="false">
- <description>The external temperature in degrees celsius</description>
- </param>
- <param name="prndl" type="Boolean" mandatory="false">
- <description>See PRNDL</description>
- </param>
- <param name="tirePressure" type="Boolean" mandatory="false">
- <description>See TireStatus</description>
- </param>
- <param name="odometer" type="Boolean" mandatory="false">
- <description>Odometer in km</description>
- </param>
- <param name="beltStatus" type="Boolean" mandatory="false">
- <description>The status of the seat belts</description>
- </param>
- <param name="bodyInformation" type="Boolean" mandatory="false">
- <description>The body information including power modes</description>
- </param>
- <param name="deviceStatus" type="Boolean" mandatory="false">
- <description>The device status including signal and battery strength</description>
- </param>
- <param name="driverBraking" type="Boolean" mandatory="false">
- <description>The status of the brake pedal</description>
- </param>
- <param name="wiperStatus" type="Boolean" mandatory="false">
- <description>The status of the wipers</description>
- </param>
- <param name="headLampStatus" type="Boolean" mandatory="false">
- <description>Status of the head lamps</description>
- </param>
- <param name="engineTorque" type="Boolean" mandatory="false">
- <description>Torque value for engine (in Nm) on non-diesel variants</description>
- </param>
- <param name="accPedalPosition" type="Boolean" mandatory="false">
- <description>Accelerator pedal position (percentage depressed)</description>
- </param>
- <param name="steeringWheelAngle" type="Boolean" mandatory="false">
- <description>Current angle of the steering wheel (in deg)</description>
- </param>
-
- <!-- Ford Specific Data Items -->
- <param name="eCallInfo" type="Boolean" mandatory="false">
- <description>Emergency Call notification and confirmation data</description>
- </param>
- <param name="airbagStatus" type="Boolean" mandatory="false">
- <description>The status of the air bags</description>
- </param>
- <param name="emergencyEvent" type="Boolean" mandatory="false">
- <description>Information related to an emergency event (and if it occurred)</description>
- </param>
- <param name="clusterModeStatus" type="Boolean" mandatory="false">
- <description>The status modes of the cluster</description>
- </param>
- <param name="myKey" type="Boolean" mandatory="false">
- <description>Information related to the MyKey feature</description>
- </param>
-
- <!-- / Ford Specific Data Items -->
-
- </function>
-
- <function name="SubscribeVehicleData" functionID="SubscribeVehicleDataID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="WARNINGS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED" />
- <element name="IGNORED" />
- <element name="DISALLOWED"/>
- <element name="USER_DISALLOWED"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- <param name="gps" type="VehicleDataResult" mandatory="false">
- <description>See GPSData</description>
- </param>
- <param name="speed" type="VehicleDataResult" mandatory="false">
- <description>The vehicle speed in kilometers per hour</description>
- </param>
- <param name="rpm" type="VehicleDataResult" mandatory="false">
- <description>The number of revolutions per minute of the engine</description>
- </param>
- <param name="fuelLevel" type="VehicleDataResult" mandatory="false">
- <description>The fuel level in the tank (percentage)</description>
- </param>
- <param name="fuelLevel_State" type="VehicleDataResult" mandatory="false">
- <description>The fuel level state</description>
- </param>
- <param name="instantFuelConsumption" type="VehicleDataResult" mandatory="false">
- <description>The instantaneous fuel consumption in microlitres</description>
- </param>
- <param name="externalTemperature" type="VehicleDataResult" mandatory="false">
- <description>The external temperature in degrees celsius.</description>
- </param>
- <param name="prndl" type="VehicleDataResult" mandatory="false">
- <description>See PRNDL</description>
- </param>
- <param name="tirePressure" type="VehicleDataResult" mandatory="false">
- <description>See TireStatus</description>
- </param>
- <param name="odometer" type="VehicleDataResult" mandatory="false">
- <description>Odometer in km</description>
- </param>
- <param name="beltStatus" type="VehicleDataResult" mandatory="false">
- <description>The status of the seat belts</description>
- </param>
- <param name="bodyInformation" type="VehicleDataResult" mandatory="false">
- <description>The body information including power modes</description>
- </param>
- <param name="deviceStatus" type="VehicleDataResult" mandatory="false">
- <description>The device status including signal and battery strength</description>
- </param>
- <param name="driverBraking" type="VehicleDataResult" mandatory="false">
- <description>The status of the brake pedal</description>
- </param>
- <param name="wiperStatus" type="VehicleDataResult" mandatory="false">
- <description>The status of the wipers</description>
- </param>
- <param name="headLampStatus" type="VehicleDataResult" mandatory="false">
- <description>Status of the head lamps</description>
- </param>
- <param name="engineTorque" type="VehicleDataResult" mandatory="false">
- <description>Torque value for engine (in Nm) on non-diesel variants</description>
- </param>
- <param name="accPedalPosition" type="VehicleDataResult" mandatory="false">
- <description>Accelerator pedal position (percentage depressed)</description>
- </param>
- <param name="steeringWheelAngle" type="VehicleDataResult" mandatory="false">
- <description>Current angle of the steering wheel (in deg)</description>
- </param>
-
- <!-- Ford Specific Data Items -->
- <param name="eCallInfo" type="VehicleDataResult" mandatory="false">
- <description>Emergency Call notification and confirmation data</description>
- </param>
- <param name="airbagStatus" type="VehicleDataResult" mandatory="false">
- <description>The status of the air bags</description>
- </param>
- <param name="emergencyEvent" type="VehicleDataResult" mandatory="false">
- <description>Information related to an emergency event (and if it occurred)</description>
- </param>
- <param name="clusterModes" type="VehicleDataResult" mandatory="false">
- <description>The status modes of the cluster</description>
- </param>
- <param name="myKey" type="VehicleDataResult" mandatory="false">
- <description>Information related to the MyKey feature</description>
- </param>
- <!-- / Ford Specific Data Items -->
-
- </function>
-
- <function name="UnsubscribeVehicleData" functionID="UnsubscribeVehicleDataID" messagetype="request">
- <description>This function is used to unsubscribe the notifications from the subscribeVehicleData function.</description>
-
- <param name="gps" type="Boolean" mandatory="false">
- <description>See GPSData</description>
- </param>
- <param name="speed" type="Boolean" mandatory="false">
- <description>The vehicle speed in kilometers per hour</description>
- </param>
- <param name="rpm" type="Boolean" mandatory="false">
- <description>The number of revolutions per minute of the engine</description>
- </param>
- <param name="fuelLevel" type="Boolean" mandatory="false">
- <description>The fuel level in the tank (percentage)</description>
- </param>
- <param name="fuelLevel_State" type="Boolean" mandatory="false">
- <description>The fuel level state</description>
- </param>
- <param name="instantFuelConsumption" type="Boolean" mandatory="false">
- <description>The instantaneous fuel consumption in microlitres</description>
- </param>
- <param name="externalTemperature" type="Boolean" mandatory="false">
- <description>The external temperature in degrees celsius.</description>
- </param>
- <param name="prndl" type="Boolean" mandatory="false">
- <description>See PRNDL</description>
- </param>
- <param name="tirePressure" type="Boolean" mandatory="false">
- <description>See TireStatus</description>
- </param>
- <param name="odometer" type="Boolean" mandatory="false">
- <description>Odometer in km</description>
- </param>
- <param name="beltStatus" type="Boolean" mandatory="false">
- <description>The status of the seat belts</description>
- </param>
- <param name="bodyInformation" type="Boolean" mandatory="false">
- <description>The body information including power modes</description>
- </param>
- <param name="deviceStatus" type="Boolean" mandatory="false">
- <description>The device status including signal and battery strength</description>
- </param>
- <param name="driverBraking" type="Boolean" mandatory="false">
- <description>The status of the brake pedal</description>
- </param>
- <param name="wiperStatus" type="Boolean" mandatory="false">
- <description>The status of the wipers</description>
- </param>
- <param name="headLampStatus" type="Boolean" mandatory="false">
- <description>Status of the head lamps</description>
- </param>
- <param name="engineTorque" type="Boolean" mandatory="false">
- <description>Torque value for engine (in Nm) on non-diesel variants</description>
- </param>
- <param name="accPedalPosition" type="Boolean" mandatory="false">
- <description>Accelerator pedal position (percentage depressed)</description>
- </param>
- <param name="steeringWheelAngle" type="Boolean" mandatory="false">
- <description>Current angle of the steering wheel (in deg)</description>
- </param>
-
- <!-- Ford Specific Data Items -->
- <param name="eCallInfo" type="Boolean" mandatory="false">
- <description>Emergency Call notification and confirmation data</description>
- </param>
- <param name="airbagStatus" type="Boolean" mandatory="false">
- <description>The status of the air bags</description>
- </param>
- <param name="emergencyEvent" type="Boolean" mandatory="false">
- <description>Information related to an emergency event (and if it occurred)</description>
- </param>
- <param name="clusterModeStatus" type="Boolean" mandatory="false">
- <description>The status modes of the cluster</description>
- </param>
- <param name="myKey" type="Boolean" mandatory="false">
- <description>Information related to the MyKey feature</description>
- </param>
- <!-- / Ford Specific Data Items -->
-
- </function>
-
- <function name="UnsubscribeVehicleData" functionID="UnsubscribeVehicleDataID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="WARNINGS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED" />
- <element name="IGNORED" />
- <element name="DISALLOWED"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- <param name="gps" type="VehicleDataResult" mandatory="false">
- <description>See GPSData</description>
- </param>
- <param name="speed" type="VehicleDataResult" mandatory="false">
- <description>The vehicle speed in kilometers per hour</description>
- </param>
- <param name="rpm" type="VehicleDataResult" mandatory="false">
- <description>The number of revolutions per minute of the engine</description>
- </param>
- <param name="fuelLevel" type="VehicleDataResult" mandatory="false">
- <description>The fuel level in the tank (percentage)</description>
- </param>
- <param name="fuelLevel_State" type="VehicleDataResult" mandatory="false">
- <description>The fuel level state</description>
- </param>
- <param name="instantFuelConsumption" type="VehicleDataResult" mandatory="false">
- <description>The instantaneous fuel consumption in microlitres</description>
- </param>
- <param name="externalTemperature" type="VehicleDataResult" mandatory="false">
- <description>The external temperature in degrees celsius</description>
- </param>
- <param name="prndl" type="VehicleDataResult" mandatory="false">
- <description>See PRNDL</description>
- </param>
- <param name="tirePressure" type="VehicleDataResult" mandatory="false">
- <description>See TireStatus</description>
- </param>
- <param name="odometer" type="VehicleDataResult" mandatory="false">
- <description>Odometer in km</description>
- </param>
- <param name="beltStatus" type="VehicleDataResult" mandatory="false">
- <description>The status of the seat belts</description>
- </param>
- <param name="bodyInformation" type="VehicleDataResult" mandatory="false">
- <description>The body information including power modes</description>
- </param>
- <param name="deviceStatus" type="VehicleDataResult" mandatory="false">
- <description>The device status including signal and battery strength</description>
- </param>
- <param name="driverBraking" type="VehicleDataResult" mandatory="false">
- <description>The status of the brake pedal</description>
- </param>
- <param name="wiperStatus" type="VehicleDataResult" mandatory="false">
- <description>The status of the wipers</description>
- </param>
- <param name="headLampStatus" type="VehicleDataResult" mandatory="false">
- <description>Status of the head lamps</description>
- </param>
- <param name="engineTorque" type="VehicleDataResult" mandatory="false">
- <description>Torque value for engine (in Nm) on non-diesel variants</description>
- </param>
- <param name="accPedalPosition" type="VehicleDataResult" mandatory="false">
- <description>Accelerator pedal position (percentage depressed)</description>
- </param>
- <param name="steeringWheelAngle" type="VehicleDataResult" mandatory="false">
- <description>Current angle of the steering wheel (in deg)</description>
- </param>
-
- <!-- Ford Specific Data Items -->
- <param name="eCallInfo" type="VehicleDataResult" mandatory="false">
- <description>Emergency Call notification and confirmation data</description>
- </param>
- <param name="airbagStatus" type="VehicleDataResult" mandatory="false" >
- <description>The status of the air bags</description>
- </param>
- <param name="emergencyEvent" type="VehicleDataResult" mandatory="false">
- <description>Information related to an emergency event (and if it occurred)</description>
- </param>
- <param name="clusterModes" type="VehicleDataResult" mandatory="false">
- <description>The status modes of the cluster</description>
- </param>
- <param name="myKey" type="VehicleDataResult" mandatory="false">
- <description>Information related to the MyKey feature</description>
- </param>
- <!-- / Ford Specific Data Items -->
-
- </function>
-
- <function name="GetVehicleData" functionID="GetVehicleDataID" messagetype="request">
- <description>Non periodic vehicle data read request.</description>
-
- <param name="gps" type="Boolean" mandatory="false">
- <description>See GPSData</description>
- </param>
- <param name="speed" type="Boolean" mandatory="false">
- <description>The vehicle speed in kilometers per hour</description>
- </param>
- <param name="rpm" type="Boolean" mandatory="false">
- <description>The number of revolutions per minute of the engine</description>
- </param>
- <param name="fuelLevel" type="Boolean" mandatory="false">
- <description>The fuel level in the tank (percentage)</description>
- </param>
- <param name="fuelLevel_State" type="Boolean" mandatory="false">
- <description>The fuel level state</description>
- </param>
- <param name="instantFuelConsumption" type="Boolean" mandatory="false">
- <description>The instantaneous fuel consumption in microlitres</description>
- </param>
- <param name="externalTemperature" type="Boolean" mandatory="false">
- <description>The external temperature in degrees celsius</description>
- </param>
- <param name="vin" type="Boolean" mandatory="false">
- <description>Vehicle identification number</description>
- </param>
- <param name="prndl" type="Boolean" mandatory="false">
- <description>See PRNDL</description>
- </param>
- <param name="tirePressure" type="Boolean" mandatory="false">
- <description>See TireStatus</description>
- </param>
- <param name="odometer" type="Boolean" mandatory="false">
- <description>Odometer in km</description>
- </param>
- <param name="beltStatus" type="Boolean" mandatory="false">
- <description>The status of the seat belts</description>
- </param>
- <param name="bodyInformation" type="Boolean" mandatory="false">
- <description>The body information including ignition status and internal temp</description>
- </param>
- <param name="deviceStatus" type="Boolean" mandatory="false">
- <description>The device status including signal and battery strength</description>
- </param>
- <param name="driverBraking" type="Boolean" mandatory="false">
- <description>The status of the brake pedal</description>
- </param>
- <param name="wiperStatus" type="Boolean" mandatory="false">
- <description>The status of the wipers</description>
- </param>
- <param name="headLampStatus" type="Boolean" mandatory="false">
- <description>Status of the head lamps</description>
- </param>
- <param name="engineTorque" type="Boolean" mandatory="false">
- <description>Torque value for engine (in Nm) on non-diesel variants</description>
- </param>
- <param name="accPedalPosition" type="Boolean" mandatory="false">
- <description>Accelerator pedal position (percentage depressed)</description>
- </param>
- <param name="steeringWheelAngle" type="Boolean" mandatory="false">
- <description>Current angle of the steering wheel (in deg)</description>
- </param>
-
- <!-- Ford Specific Data Items -->
- <param name="eCallInfo" type="Boolean" mandatory="false">
- <description>Emergency Call notification and confirmation data</description>
- </param>
- <param name="airbagStatus" type="Boolean" mandatory="false">
- <description>The status of the air bags</description>
- </param>
- <param name="emergencyEvent" type="Boolean" mandatory="false">
- <description>Information related to an emergency event (and if it occurred)</description>
- </param>
- <param name="clusterModeStatus" type="Boolean" mandatory="false">
- <description>The status modes of the cluster</description>
- </param>
- <param name="myKey" type="Boolean" mandatory="false">
- <description>Information related to the MyKey feature</description>
- </param>
- <!-- / Ford Specific Data Items -->
-
- </function>
-
- <function name="GetVehicleData" functionID="GetVehicleDataID" messagetype="response">
-
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="VEHICLE_DATA_NOT_ALLOWED"/>
- <element name="VEHICLE_DATA_NOT_AVAILABLE"/>
- <element name="USER_DISALLOWED"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- <param name="gps" type="GPSData" mandatory="false">
- <description>See GPSData</description>
- </param>
- <param name="speed" type="Float" minvalue="0" maxvalue="700" mandatory="false">
- <description>The vehicle speed in kilometers per hour</description>
- </param>
- <param name="rpm" type="Integer" minvalue="0" maxvalue="20000" mandatory="false">
- <description>The number of revolutions per minute of the engine</description>
- </param>
- <param name="fuelLevel" type="Float" minvalue="-6" maxvalue="106" mandatory="false">
- <description>The fuel level in the tank (percentage)</description>
- </param>
- <param name="fuelLevel_State" type="ComponentVolumeStatus" mandatory="false">
- <description>The fuel level state</description>
- </param>
- <param name="instantFuelConsumption" type="Float" minvalue="0" maxvalue="25575" mandatory="false">
- <description>The instantaneous fuel consumption in microlitres</description>
- </param>
- <param name="externalTemperature" type="Float" minvalue="-40" maxvalue="100" mandatory="false">
- <description>The external temperature in degrees celsius</description>
- </param>
- <param name="vin" type="String" maxlength="17" mandatory="false">
- <description>Vehicle identification number</description>
- </param>
- <param name="prndl" type="PRNDL" mandatory="false">
- <description>See PRNDL</description>
- </param>
- <param name="tirePressure" type="TireStatus" mandatory="false">
- <description>See TireStatus</description>
- </param>
- <param name="odometer" type="Integer" minvalue="0" maxvalue="17000000" mandatory="false">
- <description>Odometer in km</description>
- </param>
- <param name="beltStatus" type="BeltStatus" mandatory="false">
- <description>The status of the seat belts</description>
- </param>
- <param name="bodyInformation" type="BodyInformation" mandatory="false">
- <description>The body information including power modes</description>
- </param>
- <param name="deviceStatus" type="DeviceStatus" mandatory="false">
- <description>The device status including signal and battery strength</description>
- </param>
- <param name="driverBraking" type="VehicleDataEventStatus" mandatory="false">
- <description>The status of the brake pedal</description>
- </param>
- <param name="wiperStatus" type="WiperStatus" mandatory="false">
- <description>The status of the wipers</description>
- </param>
- <param name="headLampStatus" type="HeadLampStatus" mandatory="false">
- <description>Status of the head lamps</description>
- </param>
- <param name="engineTorque" type="Float" minvalue="-1000" maxvalue="2000" mandatory="false">
- <description>Torque value for engine (in Nm) on non-diesel variants</description>
- </param>
- <param name="accPedalPosition" type="Float" minvalue="0" maxvalue="100" mandatory="false">
- <description>Accelerator pedal position (percentage depressed)</description>
- </param>
- <param name="steeringWheelAngle" type="Float" minvalue="-2000" maxvalue="2000" mandatory="false">
- <description>Current angle of the steering wheel (in deg)</description>
- </param>
-
- <!-- Ford Specific Data Items -->
- <param name="eCallInfo" type="ECallInfo" mandatory="false">
- <description>Emergency Call notification and confirmation data</description>
- </param>
- <param name="airbagStatus" type="AirbagStatus" mandatory="false">
- <description>The status of the air bags</description>
- </param>
- <param name="emergencyEvent" type="EmergencyEvent" mandatory="false">
- <description>Information related to an emergency event (and if it occurred)</description>
- </param>
- <param name="clusterModeStatus" type="ClusterModeStatus" mandatory="false">
- <description>The status modes of the cluster</description>
- </param>
- <param name="myKey" type="MyKey" mandatory="false">
- <description>Information related to the MyKey feature</description>
- </param>
- <!-- / Ford Specific Data Items -->
-
- </function>
-
- <function name="ReadDID" functionID="ReadDIDID" messagetype="request">
- <description>Non periodic vehicle data read request</description>
-
- <param name="ecuName" type="Integer" minvalue="0" maxvalue="65535" mandatory="true">
- <description>Name of ECU.</description>
- </param>
- <param name="didLocation" type="Integer" minvalue="0" maxvalue="65535" minsize="1" maxsize="1000" array="true" mandatory="true">
- <description>Get raw data from vehicle data DID location(s)</description>
- </param>
- </function>
-
- <function name="ReadDID" functionID="ReadDIDID" messagetype="response">
-
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="DISALLOWED"/>
- <element name="USER_DISALLOWED"/>
- <element name="TRUNCATED_DATA"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- <param name="didResult" type="DIDResult" minsize="0" maxsize="1000" array="true" mandatory="false">
- <description>Array of requested DID results (with data if available).</description>
- </param>
-
- </function>
-
- <function name="GetDTCs" functionID="GetDTCsID" messagetype="request">
- <description>Vehicle module diagnostic trouble code request.</description>
-
- <param name="ecuName" type="Integer" minvalue="0" maxvalue="65535" mandatory="true">
- <description>Name of ECU.</description>
- </param>
-
- <param name="dtcMask" type="Integer" minvalue="0" maxvalue="255" mandatory="false">
- <description>DTC Mask Byte to be sent in diagnostic request to module .</description>
- </param>
-
- </function>
-
- <function name="GetDTCs" functionID="GetDTCsID" messagetype="response">
-
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="DISALLOWED"/>
- <element name="USER_DISALLOWED"/>
- <element name="TRUNCATED_DATA"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- <param name="ecuHeader" type="Integer" minvalue="0" maxvalue="65535" mandatory="true">
- <description>2 byte ECU Header for DTC response (as defined in VHR_Layout_Specification_DTCs.pdf)</description>
- </param>
-
- <param name="dtc" type="String" mandatory="false" minsize="1" maxsize="15" maxlength="10" array="true">
- <description>
- Array of all reported DTCs on module (ecuHeader contains information if list is truncated).
- Each DTC is represented by 4 bytes (3 bytes of data and 1 byte status as defined in VHR_Layout_Specification_DTCs.pdf).
- </description>
- </param>
-
- </function>
-
- <function name="DiagnosticMessage" functionID="DiagnosticMessageID" messagetype="request">
- <description>Non periodic vehicle diagnostic request</description>
-
- <param name="targetID" type="Integer" minvalue="0" maxvalue="65535" mandatory="true">
- <description>Name of target ECU.</description>
- </param>
-
- <param name="messageLength" type="Integer" minvalue="0" maxvalue="65535" mandatory="true">
- <description>Length of message (in bytes).</description>
- </param>
-
- <param name="messageData" type="Integer" minvalue="0" maxvalue="255" minsize="1" maxsize="65535" array="true" mandatory="true">
- <description>
- Array of bytes comprising CAN message.
- </description>
- </param>
- </function>
-
- <function name="DiagnosticMessage" functionID="DiagnosticMessageID" messagetype="response">
-
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="DISALLOWED"/>
- <element name="USER_DISALLOWED"/>
- <element name="TRUNCATED_DATA"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- <param name="messageDataResult" type="Integer" minvalue="0" maxvalue="255" minsize="1" maxsize="65535" array="true" mandatory="true">
- <description>
- Array of bytes comprising CAN message result.
- </description>
- </param>
-
- </function>
-
- <function name="ScrollableMessage" functionID="ScrollableMessageID" messagetype="request">
- <description>Creates a full screen overlay containing a large block of formatted text that can be scrolled with up to 8 SoftButtons defined</description>
- <param name="scrollableMessageBody" type="String" maxlength="500" mandatory="true">
- <description>Body of text that can include newlines and tabs.</description>
- </param>
- <param name="timeout" type="Integer" minvalue="1000" maxvalue="65535" defvalue="30000" mandatory="false">
- <description>App defined timeout. Indicates how long of a timeout from the last action (i.e. scrolling message resets timeout).</description>
- </param>
- <param name="softButtons" type="SoftButton" minsize="0" maxsize="8" array="true" mandatory="false">
- <description>
- App defined SoftButtons.
- If omitted on supported displays, only the system defined "Close" SoftButton will be displayed.
- </description>
- </param>
- </function>
-
- <function name="ScrollableMessage" functionID="ScrollableMessageID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="CHAR_LIMIT_EXCEEDED"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="DISALLOWED"/>
- <element name="UNSUPPORTED_RESOURCE"/>
- <element name="REJECTED"/>
- <element name="ABORTED"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- </function>
-
- <function name="Slider" functionID="SliderID" messagetype="request">
- <description>Creates a full screen or pop-up overlay (depending on platform) with a single user controlled slider.</description>
- <param name="numTicks" type="Integer" minvalue="2" maxvalue="26" mandatory="true">
- <description>Number of selectable items on a horizontal axis</description>
- </param>
- <param name="position" type="Integer" minvalue="1" maxvalue="26" mandatory="true">
- <description>Initial position of slider control (cannot exceed numTicks)</description>
- </param>
- <param name="sliderHeader" type="String" maxlength="500" mandatory="true">
- <description>Text header to display</description>
- </param>
- <param name="sliderFooter" type="String" maxlength="500" minsize="1" maxsize="26" array="true" mandatory="false">
- <description>
- Text footer to display (meant to display min/max threshold descriptors).
- For a static text footer, only one footer string shall be provided in the array.
- For a dynamic text footer, the number of footer text string in the array must match the numTicks value.
- For a dynamic text footer, text array string should correlate with potential slider position index.
- If omitted on supported displays, no footer text shall be displayed.
- </description>
- </param>
- <param name="timeout" type="Integer" minvalue="1000" maxvalue="65535" defvalue="10000" mandatory="false">
- <description>
- App defined timeout. Indicates how long of a timeout from the last action (i.e. sliding control resets timeout).
- If omitted, the value is set to 10000.
- </description>
- </param>
- </function>
-
- <function name="Slider" functionID="SliderID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="SAVED"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="DISALLOWED"/>
- <element name="UNSUPPORTED_RESOURCE"/>
- <element name="REJECTED"/>
- <element name="ABORTED"/>
- <element name="TIMED_OUT"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- <param name="sliderPosition" type="Integer" minvalue="1" maxvalue="26" mandatory="false">
- <description>
- Current slider value returned when saved or canceled (aborted)
- This value is only returned for resultCodes "SAVED" or "ABORTED"
- </description>
- </param>
- </function>
-
- <function name="ShowConstantTBT" functionID="ShowConstantTBTID" messagetype="request">
- <param name="navigationText1" type="String" minlength="0" maxlength="500" mandatory="false">
- </param>
- <param name="navigationText2" type="String" minlength="0" maxlength="500" mandatory="false">
- </param>
- <param name="eta" type="String" minlength="0" maxlength="500" mandatory="false">
- </param>
- <param name="timeToDestination" type="String" minlength="0" maxlength="500" mandatory="false">
- </param>
- <param name="totalDistance" type="String" minlength="0" maxlength="500" mandatory="false">
- </param>
- <param name="turnIcon" type="Image" mandatory="false">
- </param>
- <param name="nextTurnIcon" type="Image" mandatory="false">
- </param>
- <param name="distanceToManeuver" type="Float" minvalue="0" maxvalue="1000000000" mandatory="false">
- <description>
- Fraction of distance till next maneuver (starting from when AlertManeuver is triggered).
- Used to calculate progress bar.
- </description>
- </param>
- <param name="distanceToManeuverScale" type="Float" minvalue="0" maxvalue="1000000000" mandatory="false">
- <description>
- Distance till next maneuver (starting from) from previous maneuver.
- Used to calculate progress bar.
- </description>
- </param>
- <param name="maneuverComplete" type="Boolean" mandatory="false">
- <description>
- If and when a maneuver has completed while an AlertManeuver is active, the app must send this value set to TRUE in order to clear the AlertManeuver overlay.
- If omitted the value will be assumed as FALSE.
- </description>
- </param>
- <param name="softButtons" type="SoftButton" minsize="0" maxsize="3" array="true" mandatory="false">
- <description>
- Three dynamic SoftButtons available (first SoftButton is fixed to "Turns").
- If omitted on supported displays, the currently displayed SoftButton values will not change.
- </description>
- </param>
- </function>
-
- <function name="ShowConstantTBT" functionID="ShowConstantTBTID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="DISALLOWED"/>
- <element name="UNSUPPORTED_REQUEST"/>
- <element name="UNSUPPORTED_RESOURCE"/>
- </param>
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="AlertManeuver" functionID="AlertManeuverID" messagetype="request">
- <param name="ttsChunks" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>An array of text chunks of type TTSChunk. See TTSChunk</description>
- </param>
- <param name="softButtons" type="SoftButton" minsize="0" maxsize="3" array="true" mandatory="false">
- <description>If omitted on supported displays, only the system defined "Close" SoftButton shall be displayed.</description>
- </param>
- </function>
-
- <function name="AlertManeuver" functionID="AlertManeuverID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="IGNORED"/>
- <element name="DISALLOWED"/>
- <element name="UNSUPPORTED_REQUEST"/>
- <element name="UNSUPPORTED_RESOURCE"/>
- <element name="ABORTED"/>
- <element name="WARNINGS"/>
- </param>
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="UpdateTurnList" functionID="UpdateTurnListID" messagetype="request">
- <param name="turnList" type="Turn" minsize="1" maxsize="100" array="true" mandatory="false">
- </param>
- <param name="softButtons" type="SoftButton" minsize="0" maxsize="1" array="true" mandatory="false">
- <description>If omitted on supported displays, app-defined SoftButton will be left blank.</description>
- </param>
- </function>
-
- <function name="UpdateTurnList" functionID="UpdateTurnListID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="DISALLOWED"/>
- <element name="UNSUPPORTED_REQUEST"/>
- <element name="UNSUPPORTED_RESOURCE"/>
- </param>
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="ChangeRegistration" functionID="ChangeRegistrationID" messagetype="request">
- <param name="language" type="Language" mandatory="true">
- <description>Requested voice engine (VR+TTS) language registration</description>
- </param>
- <param name="hmiDisplayLanguage" type="Language" mandatory="true">
- <description>Request display language registration</description>
- </param>
- <param name="appName" type="String" maxlength="100" mandatory="false">
- <description>Request new app name registration</description>
- </param>
- <param name="ttsName" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" >
- <description>Request new ttsName registration</description>
- </param>
- <param name="ngnMediaScreenAppName" type="String" maxlength="100" mandatory="false">
- <description>Request new app short name registration</description>
- </param>
- <param name="vrSynonyms" type="String" maxlength="40" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>Request new VR synonyms registration</description>
- </param>
-
-</function>
-
-
-
- <function name="ChangeRegistration" functionID="ChangeRegistrationID" messagetype="response">
-
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description>
- true, if successful
- false, if failed
- </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="DISALLOWED"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- </function>
-
- <function name="GenericResponse" functionID="GenericResponseID" messagetype="response">
- <description>
- Generic Response is sent, when the name of a received msg cannot be retrieved. Only used in case of an error.
- Currently, only resultCode INVALID_DATA is used.
- </description>
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="INVALID_DATA"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="PutFile" functionID="PutFileID" messagetype="request">
- <description>
- Used to push a binary data onto the SYNC module from a mobile device, such as icons and album art
- Not supported on first generation SYNC vehicles.
- Binary data is in binary part of hybrid msg.
- </description>
-
- <param name="syncFileName" type="String" maxlength="255" mandatory="true">
- <description>File reference name.</description>
- </param>
-
- <param name="fileType" type="FileType" mandatory="true">
- <description>Selected file type.</description>
- </param>
-
- <param name="persistentFile" type="Boolean" defvalue="false" mandatory="false">
- <description>
- Indicates if the file is meant to persist between sessions / ignition cycles.
- If set to TRUE, then the system will aim to persist this file through session / cycles.
- While files with this designation will have priority over others, they are subject to deletion by the system at any time.
- In the event of automatic deletion by the system, the app will receive a rejection and have to resend the file.
- If omitted, the value will be set to false.
- </description>
- </param>
-
- <param name="systemFile" type="Boolean" defvalue="false" mandatory="false" >
- <description>
- Indicates if the file is meant to be passed thru core to elsewhere on the system.
- If set to TRUE, then the system will instead pass the data thru as it arrives to a predetermined area outside of core.
- If omitted, the value will be set to false.
- </description>
- </param>
-
- <param name="offset" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
- <description>Optional offset in bytes for resuming partial data chunks</description>
- </param>
- <param name="length" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
- <description>
- Optional length in bytes for resuming partial data chunks
- If offset is set to 0, then length is the total length of the file to be downloaded
- </description>
- </param>
-
- </function>
-
- <function name="PutFile" functionID="PutFileID" messagetype="response">
- <description>Response is sent, when the file data was copied (success case). Or when an error occured.</description>
- <description>Not supported on First generation SYNC vehicles. </description>
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="UNSUPPORTED_REQUEST"/>
- </param>
-
- <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
- <description>
- Provides the total local space available in SDL Core for the registered app.
- If the transfer has systemFile enabled, then the value will be set to 0 automatically.
- </description>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="DeleteFile" functionID="DeleteFileID" messagetype="request">
- <description>
- Used to delete a file resident on the SYNC module in the app's local cache.
- Not supported on first generation SYNC vehicles.
- </description>
-
- <param name="syncFileName" type="String" maxlength="500" mandatory="true">
- <description>File reference name.</description>
- </param>
-
- </function>
-
- <function name="DeleteFile" functionID="DeleteFileID" messagetype="response">
- <description>
- Response is sent, when the file data was deleted (success case). Or when an error occured.
- Not supported on First generation SYNC vehicles.
- </description>
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="UNSUPPORTED_REQUEST"/>
- </param>
-
- <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
- <description>Provides the total local space available on SYNC for the registered app.</description>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="ListFiles" functionID="ListFilesID" messagetype="request">
- <description>
- Requests the current list of resident filenames for the registered app.
- Not supported on first generation SYNC vehicles.
- </description>
- </function>
-
- <function name="ListFiles" functionID="ListFilesID" messagetype="response">
- <description>
- Returns the current list of resident filenames for the registered app along with the current space available
- Not supported on First generation SYNC vehicles.
- </description>
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="UNSUPPORTED_REQUEST"/>
- </param>
-
- <param name="filenames" type="String" maxlength="500" minsize="0" maxsize="1000" array="true" mandatory="false">
- <description>
- An array of all filenames resident on SYNC for the given registered app.
- If omitted, then no files currently reside on the system.
- </description>
- </param>
-
- <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
- <description>Provides the total local space available on SYNC for the registered app.</description>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="SetAppIcon" functionID="SetAppIconID" messagetype="request">
- <description>
- Used to set existing local file on SYNC as the app's icon
- Not supported on first generation SYNC vehicles.
- </description>
-
- <param name="syncFileName" type="String" maxlength="500" mandatory="true">
- <description>File reference name.</description>
- </param>
-
- </function>
-
- <function name="SetAppIcon" functionID="SetAppIconID" messagetype="response">
- <description>
- Response is sent, when the file data was copied (success case). Or when an error occured.
- Not supported on First generation SYNC vehicles.
- </description>
-
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="UNSUPPORTED_REQUEST"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- </function>
-
- <function name="SetDisplayLayout" functionID="SetDisplayLayoutID" messagetype="request">
- <description>
- Used to set an alternate display layout.
- If not sent, default screen for given platform will be shown
- </description>
-
- <param name="displayLayout" type="String" maxlength="500" mandatory="true">
- <description>
- Predefined or dynamically created screen layout.
- Currently only predefined screen layouts are defined.
- </description>
- </param>
-
- </function>
-
- <function name="SetDisplayLayout" functionID="SetDisplayLayoutID" messagetype="response">
-
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="UNSUPPORTED_REQUEST"/>
- </param>
-
- <param name="displayCapabilities" type="DisplayCapabilities" mandatory="false">
- <description>See DisplayCapabilities</description>
- </param>
-
- <param name="buttonCapabilities" type="ButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>See ButtonCapabilities</description >
- </param>
-
- <param name="softButtonCapabilities" type="SoftButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false">
- <description>If returned, the platform supports on-screen SoftButtons; see SoftButtonCapabilities.</description >
- </param>
-
- <param name="presetBankCapabilities" type="PresetBankCapabilities" mandatory="false">
- <description>If returned, the platform supports custom on-screen Presets; see PresetBankCapabilities.</description >
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
-
- </function>
-
- <function name="SystemRequest" functionID="SystemRequestID" messagetype="request" >
- <description>An asynchronous request from the device; binary data can be included in hybrid part of message for some requests (such as HTTP, Proprietary, or Authentication requests)</description>
- <param name="requestType" type="RequestType" mandatory="true">
- <description>
- The type of system request.
- Note that Proprietary requests should forward the binary data to the known proprietary module on the system.
- </description>
- </param>
- <param name="fileName" type="String" maxlength="255" mandatory="false">
- <description>
- Filename of HTTP data to store in predefined system staging area.
- Mandatory if requestType is HTTP.
- PROPRIETARY requestType should ignore this parameter.
- </description>
- </param>
- </function>
-
- <function name="SystemRequest" functionID="SystemRequestID" messagetype="response" >
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="INVALID_CERT"/>
- <element name="EXPIRED_CERT"/>
- <element name="UNSUPPORTED_REQUEST"/>
- <element name="UNSUPPORTED_RESOURCE"/>
- <element name="DISALLOWED"/>
- <element name="ABORTED"/>
- <element name="WARNINGS"/>
- <element name="TIMED_OUT"/>
- <element name="IGNORED"/>
- </param>
- </function>
-
- <function name="SendHapticData" functionID="SendHapticDataID" messagetype="request" >
- <description>
- Send the spatial data gathered from SDLCarWindow or VirtualDisplayEncoder to the HMI.
- This data will be utilized by the HMI to determine how and when haptic events should occur
- </description>
- <param name="hapticRectData" type="HapticRect" minsize="0" maxsize="1000" mandatory="false" array="true">
- <description>
- Array of rectangle data structures that represent the locations of all user controls present on the HMI.
- This data should be updated if/when the application presents a new screen.
- When a request is sent, if successful, it will replace all rectangle data previously sent through RPC.
- If an empty array is sent, the existing rectangle data will be cleared
- </description>
- </param>
- </function>
-
- <function name="SendHapticData" functionID="SendHapticDataID" messagetype="response" >
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="DISALLOWED"/>
- </param>
- </function>
-
- <function name="SendLocation" functionID="SendLocationID" messagetype="request">
- <param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180" mandatory="false">
- </param>
- <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>
- </param>
- <param name="locationDescription" type="String" maxlength="500" mandatory="false">
- <description>
- Description intended location / establishment (if applicable)
- </description>
- </param>
- <param name="addressLines" type="String" maxlength="500" minsize="0" maxsize="4" array="true" mandatory="false">
- <description>
- Location address (if applicable)
- </description>
- </param>
- <param name="phoneNumber" type="String" maxlength="500" mandatory="false">
- <description>
- Phone number of intended location / establishment (if applicable)
- </description>
- </param>
- <param name="locationImage" type="Image" mandatory="false">
- <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>
- <param name="deliveryMode" type="DeliveryMode" mandatory="false">
- <description>Defines the mode of prompt for user</description>
- </param>
- </function>
-
- <function name="SendLocation" functionID="SendLocationID" messagetype="response" >
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="UNSUPPORTED_RESOURCE"/>
- <element name="DISALLOWED"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="DialNumber" functionID="DialNumberID" messagetype="request">
- <description>Dials a phone number and switches to phone application.</description>
-
- <param name="number" type="String" maxlength="40" mandatory="true">
- <description>
- Phone number is a string, which can be up to 40 chars.
- All characters shall be stripped from string except digits 0-9 and * # , ; +
- </description>
- </param>
- </function>
-
- <function name="DialNumber" functionID="DialNumberID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description>true, if successful</description>
- <description>false, if failed</description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="SubscribeWayPoints" functionID="SubscribeWayPointsID" messagetype="request">
- <description>To subscribe in getting changes for Waypoints/destinations</description>
- </function>
-
- <function name="SubscribeWayPoints" functionID="SubscribeWayPointsID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="UNSUPPORTED_RESOURCE"/>
- <element name="IGNORED"/>
- <element name="DISALLOWED"/>
- </param>
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
- <function name="GetWayPoints" functionID="GetWayPointsID" messagetype="request">
- <description>Request for getting waypoint/destination data.</description>
- <param name="wayPointType" type="WayPointType" mandatory="true">
- <description>To request for either the destination only or for all waypoints including destination</description>
- </param>
- </function>
-
- <function name="GetWayPoints" functionID="GetWayPointsID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="TIMED_OUT"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="UNSUPPORTED_RESOURCE"/>
- <element name="IGNORED"/>
- <element name="IN_USE"/>
- <element name="DISALLOWED"/>
- </param>
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- <param name="wayPoints" type="LocationDetails" mandatory="false" array="true" minsize="1" maxsize="10">
- <description>See LocationDetails</description>
- </param>
- </function>
-
- <function name="UnsubscribeWayPoints" functionID="UnsubscribeWayPointsID" messagetype="request">
- <description>Request to unsubscribe from WayPoints and Destination</description>
- </function>
-
- <function name="UnsubscribeWayPoints" functionID="UnsubscribeWayPointsID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="UNSUPPORTED_RESOURCE"/>
- <element name="IGNORED"/>
- <element name="DISALLOWED"/>
- </param>
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- <param name="wayPoints" type="LocationDetails" mandatory="false" array="true" minsize="1" maxsize="10">
- <description>See LocationDetails</description>
- </param>
- </function>
-
- <function name="GetSystemCapability" functionID="GetSystemCapabilityID" messagetype="request">
- <param name="systemCapabilityType" type="SystemCapabilityType" mandatory="true">
- <description>The type of system capability to get more information on</description>
- </param>
- </function>
-
- <function name="GetSystemCapability" functionID="GetSystemCapabilityID" messagetype="response">
- <param name="systemCapability" type="SystemCapability" mandatory="true">
- </param>
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="IGNORED"/>
- <element name="DISALLOWED"/>
- <element name="USER_DISALLOWED"/>
- <element name="UNSUPPORTED_RESOURCE"/><description>The capability does not exist on the module</description>
- <element name="DATA_NOT_AVAILABLE"/><description>The capability should exist on the module but there was an error retrieving the data.</description>
- </param>
- <param name="info" type="String" maxlength="1000" mandatory="false">
- </param>
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true if successful; false, if failed </description>
- </param>
- </function>
-
- <!-- Notifications -->
-
- <function name="OnHMIStatus" functionID="OnHMIStatusID" messagetype="notification">
- <param name="hmiLevel" type="HMILevel" mandatory="true">
- <description>See HMILevel</description>
- </param>
-
- <param name="audioStreamingState" type="AudioStreamingState" mandatory="true">
- <description>See AudioStreamingState</description>
- </param>
-
- <param name="systemContext" type="SystemContext" mandatory="true">
- <description>See SystemContext</description>
- </param>
- </function>
-
- <function name="OnAppInterfaceUnregistered" functionID="OnAppInterfaceUnregisteredID" messagetype="notification">
- <param name="reason" type="AppInterfaceUnregisteredReason" mandatory="true">
- <description>See AppInterfaceUnregisteredReason</description>
- </param>
- </function>
-
- <function name="OnButtonEvent" functionID="OnButtonEventID" messagetype="notification">
- <description>Notifies application of UP/DOWN events for buttons to which the application is subscribed.</description>
- <param name="buttonName" type="ButtonName" mandatory="true"/>
- <param name="buttonEventMode" type="ButtonEventMode" mandatory="true">
- <description>Indicates whether this is an UP or DOWN event.</description>
- </param>
- <param name="customButtonID" type="Integer" minvalue="0" maxvalue="65536" mandatory="false">
- <description>If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. (e.g. softButton ID)</description>
- </param>
- </function>
-
- <function name="OnButtonPress" functionID="OnButtonPressID" messagetype="notification">
- <description>Notifies application of LONG/SHORT press events for buttons to which the application is subscribed.</description>
- <param name="buttonName" type="ButtonName" mandatory="true"/>
- <param name="buttonPressMode" type="ButtonPressMode" mandatory="true">
- <description>Indicates whether this is a LONG or SHORT button press event.</description>
- </param>
- <param name="customButtonID" type="Integer" minvalue="0" maxvalue="65536" mandatory="false">
- <description>If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. (e.g. softButton ID)</description>
- </param>
- </function>
-
- <function name="OnVehicleData" functionID="OnVehicleDataID" messagetype="notification">
- <description>Callback for the periodic and non periodic vehicle data read function.</description>
- <param name="gps" type="GPSData" mandatory="false">
- <description>See GPSData</description>
- </param>
- <param name="speed" type="Float" minvalue="0" maxvalue="700" mandatory="false">
- <description>The vehicle speed in kilometers per hour</description>
- </param>
- <param name="rpm" type="Integer" minvalue="0" maxvalue="20000" mandatory="false">
- <description>The number of revolutions per minute of the engine</description>
- </param>
- <param name="fuelLevel" type="Float" minvalue="-6" maxvalue="106" mandatory="false">
- <description>The fuel level in the tank (percentage)</description>
- </param>
- <param name="fuelLevel_State" type="ComponentVolumeStatus" mandatory="false">
- <description>The fuel level state</description>
- </param>
- <param name="instantFuelConsumption" type="Float" minvalue="0" maxvalue="25575" mandatory="false">
- <description>The instantaneous fuel consumption in microlitres</description>
- </param>
- <param name="externalTemperature" type="Float" minvalue="-40" maxvalue="100" mandatory="false">
- <description>The external temperature in degrees celsius</description>
- </param>
- <param name="vin" type="String" maxlength="17" mandatory="false">
- <description>Vehicle identification number.</description>
- </param>
- <param name="prndl" type="PRNDL" mandatory="false">
- <description>See PRNDL</description>
- </param>
- <param name="tirePressure" type="TireStatus" mandatory="false">
- <description>See TireStatus</description>
- </param>
- <param name="odometer" type="Integer" minvalue="0" maxvalue="17000000" mandatory="false">
- <description>Odometer in km</description>
- </param>
- <param name="beltStatus" type="BeltStatus" mandatory="false">
- <description>The status of the seat belts</description>
- </param>
- <param name="bodyInformation" type="BodyInformation" mandatory="false">
- <description>The body information including power modes</description>
- </param>
- <param name="deviceStatus" type="DeviceStatus" mandatory="false">
- <description>The device status including signal and battery strength</description>
- </param>
- <param name="driverBraking" type="VehicleDataEventStatus" mandatory="false">
- <description>The status of the brake pedal</description>
- </param>
- <param name="wiperStatus" type="WiperStatus" mandatory="false">
- <description>The status of the wipers</description>
- </param>
- <param name="headLampStatus" type="HeadLampStatus" mandatory="false">
- <description>Status of the head lamps</description>
- </param>
- <param name="engineTorque" type="Float" minvalue="-1000" maxvalue="2000" mandatory="false">
- <description>Torque value for engine (in Nm) on non-diesel variants</description>
- </param>
- <param name="accPedalPosition" type="Float" minvalue="0" maxvalue="100" mandatory="false">
- <description>Accelerator pedal position (percentage depressed)</description>
- </param>
- <param name="steeringWheelAngle" type="Float" minvalue="-2000" maxvalue="2000" mandatory="false">
- <description>Current angle of the steering wheel (in deg)</description>
- </param>
-
- <!-- Ford Specific Vehicle Data -->
- <param name="eCallInfo" type="ECallInfo" mandatory="false">
- <description>Emergency Call notification and confirmation data</description>
- </param>
- <param name="airbagStatus" type="AirbagStatus" mandatory="false">
- <description>The status of the air bags</description>
- </param>
- <param name="emergencyEvent" type="EmergencyEvent" mandatory="false">
- <description>Information related to an emergency event (and if it occurred)</description>
- </param>
- <param name="clusterModeStatus" type="ClusterModeStatus" mandatory="false">
- <description>The status modes of the cluster</description>
- </param>
- <param name="myKey" type="MyKey" mandatory="false">
- <description>Information related to the MyKey feature</description>
- </param>
- <!-- / Ford Specific Vehicle Data -->
-
- </function>
-
- <function name="OnCommand" functionID="OnCommandID" messagetype="notification">
- <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
- <description>Command ID, which is related to a specific menu entry</description>
- </param>
-
- <param name="triggerSource" type="TriggerSource" mandatory="true">
- <description>See TriggerSource</description>
- </param>
- </function>
-
- <function name="OnTBTClientState" functionID="OnTBTClientStateID" messagetype="notification" >
- <description>Provides applications with notifications specific to the current TBT client status on the module</description>
- <param name="state" type="TBTState" mandatory="true">
- <description>Current State of TBT client</description>
- </param>
- </function>
-
- <function name="OnDriverDistraction" functionID="OnDriverDistractionID" messagetype="notification" >
- <description>Provides driver distraction state to mobile applications</description>
- <param name="state" type="DriverDistractionState" mandatory="true">
- <description>Current State of Driver Distraction</description>
- </param>
- </function>
-
- <function name="OnPermissionsChange" functionID="OnPermissionsChangeID" messagetype="notification" >
- <description>Provides update to app of which policy-table-enabled functions are available</description>
- <param name="permissionItem" type="PermissionItem" minsize="0" maxsize="500" array="true" mandatory="true">
- <description>Change in permissions for a given set of RPCs</description>
- </param>
- </function>
-
- <function name="OnAudioPassThru" functionID="OnAudioPassThruID" messagetype="notification">
- <description>Binary data is in binary part of hybrid msg</description>
- </function>
-
- <function name="OnLanguageChange" functionID="OnLanguageChangeID" messagetype="notification">
- <param name="language" type="Language" mandatory="true">
- <description>Current SYNC voice engine (VR+TTS) language</description>
- </param>
- <param name="hmiDisplayLanguage" type="Language" mandatory="true">
- <description>Current display language</description>
- </param>
- </function>
-
- <function name="OnKeyboardInput" functionID="OnKeyboardInputID" messagetype="notification" >
-
- <description>On-screen keyboard event.</description>
- <description>Can be full string or individual keypresses depending on keyboard mode.</description>
-
- <param name="event" type="KeyboardEvent" mandatory="true">
- <description>On-screen keyboard input data.</description>
- </param>
-
- <param name="data" type="String" maxlength="500" mandatory="false">
- <description>On-screen keyboard input data.</description>
- <description>For dynamic keypress events, this will be the current compounded string of entry text.</description>
- <description>For entry submission events, this will be the full text entry (this will always return regardless of the mode).</description>
- <description>For entry cancelled and entry aborted events, this data param will be omitted.</description>
- </param>
-
- </function>
-
- <function name="OnTouchEvent" functionID="OnTouchEventID" messagetype="notification" >
- <description>Notifies about touch events on the screen's prescribed area</description>
- <param name="type" type="TouchType" mandatory="true">
- <description>The type of touch event.</description>
- </param>
- <param name="event" type="TouchEvent" mandatory="true" minsize="1" maxsize="10" array="true">
- <description>List of all individual touches involved in this event.</description>
- </param>
- </function>
-
- <function name="OnSystemRequest" functionID="OnSystemRequestID" messagetype="notification" >
- <description>
- An asynchronous request from the system for specific data from the device or the cloud or response to a request from the device or cloud
- Binary data can be included in hybrid part of message for some requests (such as Authentication request responses)
- </description>
- <param name="requestType" type="RequestType" mandatory="true">
- <description>The type of system request.</description>
- </param>
- <param name="url" type="String" maxlength="1000" mandatory="false">
- <description>
- Optional URL for HTTP requests.
- If blank, the binary data shall be forwarded to the app.
- If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds.
- </description>
- </param>
- <param name="timeout" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
- <description>
- Optional timeout for HTTP requests
- Required if a URL is provided
- </description>
- </param>
- <param name="fileType" type="FileType" mandatory="false">
- <description>Optional file type (meant for HTTP file requests).</description>
- </param>
- <param name="offset" type="Integer" minvalue="0" maxvalue="100000000000" mandatory="false">
- <description>Optional offset in bytes for resuming partial data chunks</description>
- </param>
- <param name="length" type="Integer" minvalue="0" maxvalue="100000000000" mandatory="false">
- <description>Optional length in bytes for resuming partial data chunks</description>
- </param>
- </function>
-
- <function name="OnHashChange" functionID="OnHashChangeID" messagetype="notification">
- <description>
- Notification containing an updated hashID which can be used over connection cycles (i.e. loss of connection, ignition cycles, etc.).
- Sent after initial registration and subsequently after any change in the calculated hash of all persisted app data.
- </description>
- <param name="hashID" type="String" maxlength="100" mandatory="true">
- <description>Calculated hash ID to be referenced during RegisterAppInterface.</description>
- </param>
- </function>
-
- <function name="OnWayPointChange" functionID="OnWayPointChangeID" messagetype="notification">
- <description>Notification which provides the entire LocationDetails when there is a change to any waypoints or destination.</description>
- <param name="wayPoints" type="LocationDetails" mandatory="true" array="true" minsize="1" maxsize="10">
- <description>See LocationDetails</description>
- </param>
- </function>
-
-<!-- ~~~~~~~~~~~~~~~~~~ -->
-<!-- Ford Specific APIs -->
-<!-- ~~~~~~~~~~~~~~~~~~ -->
-
- <function name="EncodedSyncPData" functionID="EncodedSyncPDataID" messagetype="request" >
- <description>
- Allows encoded data in the form of SyncP packets to be sent to the SYNC module.
- Legacy / v1 Protocol implementation; use SyncPData instead.
- *** DEPRECATED ***
- </description>
-
- <param name="data" type="String" maxlength="1000000" minsize="1" maxsize="100" array="true" mandatory="true">
- <description>Contains base64 encoded string of SyncP packets.</description>
- <todo>What is the maxlength?</todo>
- </param>
- </function>
-
- <function name="EncodedSyncPData" functionID="EncodedSyncPDataID" messagetype="response" >
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
-
-<!-- Deprecating - covered by SystemRequest
- <function name="SyncPData" functionID="SyncPDataID" messagetype="request" >
- <description>
- Allows binary data in the form of SyncP packets to be sent to the SYNC module.
- Binary data is in binary part of hybrid msg.
- </description>
- </function>
-
- <function name="SyncPData" functionID="SyncPDataID" messagetype="response" >
- <param name="success" type="Boolean" platform="documentation" mandatory="true">
- <description> true, if successful; false, if failed </description>
- </param>
-
- <param name="resultCode" type="Result" platform="documentation" mandatory="true">
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- </param>
-
- <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
- <description>Provides additional human readable info regarding the result.</description>
- </param>
- </function>
--->
-
- <function name="OnEncodedSyncPData" functionID="OnEncodedSyncPDataID" messagetype="notification" >
- <description>
- Callback including encoded data of any SyncP packets that SYNC needs to send back to the mobile device.
- Legacy / v1 Protocol implementation; responds to EncodedSyncPData.
- *** DEPRECATED ***
- </description>
- <param name="data" type="String" maxlength="1000000" minsize="1" maxsize="100" mandatory="true" array="true">
- <description>Contains base64 encoded string of SyncP packets.</description>
- </param>
- <param name="URL" type="String" maxlength="1000" mandatory="false">
- <description>
- If blank, the SyncP data shall be forwarded to the app.
- If not blank, the SyncP data shall be forwarded to the provided URL.
- </description>
- </param>
- <param name="Timeout" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
- <description>
- If blank, the SyncP data shall be forwarded to the app.
- If not blank, the SyncP data shall be forwarded with the provided timeout in seconds.
- </description>
- </param>
- </function>
-
-<function name="ButtonPress" functionID="ButtonPressID" messagetype="request">
- <param name="moduleType" type="ModuleType" mandatory="true" >
- <description>The module where the button should be pressed</description>
- </param>
- <param name="buttonName" type="ButtonName" mandatory="true" >
- <description>The name of supported RC climate or radio button.</description>
- </param>
- <param name="buttonPressMode" type="ButtonPressMode" mandatory="true" >
- <description>Indicates whether this is a LONG or SHORT button press event.</description>
- </param>
-</function>
-
-<function name="ButtonPress" functionID="ButtonPressID" messagetype="response">
- <param name="resultCode" type="Result" platform="documentation" mandatory="true" >
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="IGNORED"/>
- <element name="DISALLOWED"/>
- <element name="USER_DISALLOWED"/>
- <element name="IN_USE"/>
- </param>
- <param name="info" type="String" maxlength="1000" mandatory="false">
- </param>
- <param name="success" type="Boolean" platform="documentation" mandatory="true" >
- <description> true if successful; false, if failed </description>
- </param>
-</function>
-
-<function name="GetInteriorVehicleData" functionID="GetInteriorVehicleDataID" messagetype="request">
- <param name="moduleType" type="ModuleType" mandatory="true" >
- <description>
- The type of a RC module to retrieve module data from the vehicle.
- In the future, this should be the Identification of a module.
- </description>
- </param>
- <param name="subscribe" type="Boolean" mandatory="false" defvalue="false">
- <description>
- If subscribe is true, the head unit will register onInteriorVehicleData notifications for the requested moduelType.
- If subscribe is false, the head unit will unregister onInteriorVehicleData notifications for the requested moduelType.
- </description>
- </param>
-</function>
-
- <function name="GetInteriorVehicleData" functionID="GetInteriorVehicleDataID" messagetype="response">
- <param name="moduleData" type="ModuleData" mandatory="true" >
- </param>
- <param name="resultCode" type="Result" platform="documentation" mandatory="true" >
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="IGNORED"/>
- <element name="DISALLOWED"/>
- <element name="USER_DISALLOWED"/>
- <element name="UNSUPPORTED_RESOURCE"/>
- </param>
- <param name="info" type="String" maxlength="1000" mandatory="false">
- </param>
- <param name="success" type="Boolean" platform="documentation" mandatory="true" >
- <description> true if successful; false, if failed </description>
- </param>
- <param name="isSubscribed" type="Boolean" mandatory="false" >
- <description>
- It is a conditional-mandatory parameter: must be returned in case "subscribe" parameter was present in the related request.
- if "true" - the "moduleType" from request is successfully subscribed and the head unit will send onInteriorVehicleData notifications for the moduleType.
- if "false" - the "moduleType" from request is either unsubscribed or failed to subscribe.
- </description>
- </param>
-
- </function>
-
- <function name="SetInteriorVehicleData" functionID="SetInteriorVehicleDataID" messagetype="request">
- <param name="moduleData" type="ModuleData" mandatory="true" >
- <description>The module data to set for the requested RC module.</description>
- </param>
- </function>
-
- <function name="SetInteriorVehicleData" functionID="SetInteriorVehicleDataID" messagetype="response">
- <description>Used to set the values of one remote control module </description>
- <param name="moduleData" type="ModuleData" mandatory="true" >
- </param>
- <param name="resultCode" type="Result" platform="documentation" mandatory="true" >
- <description>See Result</description>
- <element name="SUCCESS"/>
- <element name="INVALID_DATA"/>
- <element name="OUT_OF_MEMORY"/>
- <element name="TOO_MANY_PENDING_REQUESTS"/>
- <element name="APPLICATION_NOT_REGISTERED"/>
- <element name="GENERIC_ERROR"/>
- <element name="REJECTED"/>
- <element name="IGNORED"/>
- <element name="DISALLOWED"/>
- <element name="USER_DISALLOWED"/>
- <element name="READ_ONLY"/>
- <element name="UNSUPPORTED_RESOURCE"/>
- </param>
- <param name="info" type="String" maxlength="1000" mandatory="false">
- </param>
- <param name="success" type="Boolean" platform="documentation" mandatory="true" >
- <description> true if successful; false, if failed </description>
- </param>
- </function>
-
-
- <function name="OnInteriorVehicleData" functionID="OnInteriorVehicleDataID" messagetype="notification">
- <param name="moduleData" type="ModuleData" mandatory="true">
- </param>
- </function>
-
-<!-- Deprecating - covered by OnSystemRequest
- <function name="OnSyncPData" functionID="OnSyncPDataID" messagetype="notification" >
- <description>
- Callback including binary data of any SyncP packets that SYNC needs to send back to the mobile device.
- Responds to SyncPData.
- Binary data is in binary part of hybrid msg.
- </description>
-
- <param name="URL" type="String" maxlength="1000" mandatory="false">
- <description>
- If blank, the SyncP data shall be forwarded to the app.
- If not blank, the SyncP data shall be forwarded to the provided URL.
- </description>
- </param>
- <param name="Timeout" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
- <description>
- If blank, the SyncP data shall be forwarded to the app.
- If not blank, the SyncP data shall be forwarded with the provided timeout in seconds.
- </description>
- </param>
-
- </function>
--->
-</interface>
+<?xml version="1.0" standalone="no"?> +<?xml-stylesheet type="text/xml" href="protocol2html.xsl"?> + +<interface name="SmartDeviceLink RAPI" version="4.5.0" date="2017-09-22"> + <enum name="Result" internal_scope="base"> + <element name="SUCCESS"> + <description>The request succeeded</description> + </element> + <element name="UNSUPPORTED_REQUEST"> + <description>The request is not supported by the headunit</description> + </element> + <element name="UNSUPPORTED_RESOURCE"> + <description> + A button that was requested for subscription is not supported under the current system. + </description> + </element> + <element name="DISALLOWED"> + <description>RPC is not authorized in local policy table.</description> + </element> + <element name="REJECTED"> + <description> + The requested command was rejected, e.g. because mobile app is in background and cannot perform any HMI commands. + Or an HMI command (e.g. Speak) is rejected because a higher priority HMI command (e.g. Alert) is playing. + </description> + </element> + <element name="ABORTED"> + <description> + A command was aborted, for example due to user interaction (e.g. user pressed button). + Or an HMI command (e.g. Speak) is aborted because a higher priority HMI command (e.g. Alert) was requested. + </description> + </element> + <element name="IGNORED"> + <description> + A command was ignored, because the intended result is already in effect. + For example, SetMediaClockTimer was used to pause the media clock although the clock is paused already. + NOTE: potentially replaces SUBSCRIBED_ALREADY + </description> + </element> + <element name="RETRY"> + <description>The user interrupted the RPC (e.g. PerformAudioPassThru) and indicated to start over. Note, the app must issue the new RPC.</description> + </element> + <element name="IN_USE"> + <description> + The data may not be changed, because it is currently in use. + For example when trying to delete a command set that is currently involved in an interaction. + </description> + </element> + <element name="VEHICLE_DATA_NOT_AVAILABLE"> + <description>The requested vehicle data is not available on this vehicle or is not published.</description> + </element> + <element name="TIMED_OUT"> + <description>Overlay reached the maximum timeout and closed.</description> + </element> + <element name="INVALID_DATA"> + <description> + The data sent is invalid. For example: + Invalid Json syntax + Parameters out of bounds (number or enum range) + Mandatory parameters not provided + Parameter provided with wrong type + Invalid characters + Empty string + </description> + </element> + <element name="CHAR_LIMIT_EXCEEDED"></element> + <element name="INVALID_ID"> + <description> + One of the provided IDs is not valid. For example + This applies to CorrelationID, SubscriptionID, CommandID, MenuID, etc. + </description> + </element> + <element name="DUPLICATE_NAME"> + <description>There was a conflict with an registered name (application or menu item) or vr command</description> + </element> + <element name="APPLICATION_NOT_REGISTERED"> + <description>An command can not be executed because no application has been registered with RegisterApplication.</description> + </element> + <element name="WRONG_LANGUAGE"> + <description> + The requested language is currently not supported. + Might be because of a mismatch of the currently active language on the headunit and the requested language + </description> + </element> + <element name="OUT_OF_MEMORY"> + <description>The system could not process the request because the necessary memory couldn't be allocated</description> + </element> + <element name="TOO_MANY_PENDING_REQUESTS"> + <description>There are too many requests pending (means, that the response has not been delivered, yet).There may be a maximum of 1000 pending requests at a time.</description> + </element> + <element name="TOO_MANY_APPLICATIONS"> + <description>There are already too many registered applications</description> + </element> + <element name="APPLICATION_REGISTERED_ALREADY"> + <description>RegisterApplication has been called again, after a RegisterApplication was successful before.</description> + </element> + <element name="WARNINGS"> + <description>The RPC (e.g. SubscribeVehicleData) executed successfully but one or more items have a warning or failure.</description> + </element> + <element name="GENERIC_ERROR"> + <description>Provided data is valid but something went wrong in the lower layers.</description> + </element> + <element name="USER_DISALLOWED"> + <description>RPC is included in a functional group explicitly blocked by the user.</description> + </element> + <element name="TRUNCATED_DATA"> + <description>The RPC (e.g. ReadDID) executed successfully but the data exceeded the platform maximum threshold and thus, only part of the data is available.</description> + </element> + <element name="UNSUPPORTED_VERSION"> + <description>Sync doesn't support the protocol that is requested by the mobile application</description> + </element> + <element name="VEHICLE_DATA_NOT_ALLOWED"> + <description>The user has turned off access to vehicle data, and it is globally unavailable to mobile applications.</description> + </element> + <element name="FILE_NOT_FOUND"> + <description>A specified file could not be found on the headunit.</description> + </element> + <element name="CANCEL_ROUTE"> + <description>User selected to Cancel Route.</description> + </element> + <element name="SAVED"> + <description>The RPC (e.g. Slider) executed successfully and the user elected to save the current position / value.</description> + </element> + <element name="INVALID_CERT"> + <description>The certificate provided during authentication is invalid.</description> + </element> + <element name="EXPIRED_CERT"> + <description>The certificate provided during authentication is expired.</description> + </element> + <element name="RESUME_FAILED"> + <description>The provided hash ID does not match the hash of the current set of registered data or the core could not resume the previous data.</description> + </element> + <element name="DATA_NOT_AVAILABLE"> + <description>The requested information is currently not available. This is different than UNSUPPORTED_RESOURCE because it implies the data is at some point available. </description> + </element> + <element name="READ_ONLY"> + <description>The value being set is read only</description> + </element> + </enum> + + <enum name="ButtonPressMode"> + <element name="LONG"> + <description> + A button was released, after it was pressed for a long time + Actual timing is defined by the headunit and may vary + </description> + </element> + <element name="SHORT"> + <description> + A button was released, after it was pressed for a short time + Actual timing is defined by the headunit and may vary + </description> + </element> + </enum> + + <enum name="ButtonEventMode"> + <element name="BUTTONUP"> + <description>A button has been released up</description> + </element> + <element name="BUTTONDOWN"> + <description>A button has been pressed down</description> + </element> + </enum> + + <enum name="Language"> + <element name="EN-US" internal_name="EN_US"> + <description>English - US</description> + </element> + <element name="ES-MX" internal_name="ES_MX"> + <description>Spanish - Mexico</description> + </element> + <element name="FR-CA" internal_name="FR_CA"> + <description>French - Canada</description> + </element> + <element name="DE-DE" internal_name="DE_DE"> + <description>German - Germany</description> + </element> + <element name="ES-ES" internal_name="ES_ES"> + <description>Spanish - Spain</description> + </element> + <element name="EN-GB" internal_name="EN_GB"> + <description>English - GB</description> + </element> + <element name="RU-RU" internal_name="RU_RU"> + <description>Russian - Russia</description> + </element> + <element name="TR-TR" internal_name="TR_TR"> + <description>Turkish - Turkey</description> + </element> + <element name="PL-PL" internal_name="PL_PL"> + <description>Polish - Poland</description> + </element> + <element name="FR-FR" internal_name="FR_FR"> + <description>French - France</description> + </element> + <element name="IT-IT" internal_name="IT_IT"> + <description>Italian - Italy</description> + </element> + <element name="SV-SE" internal_name="SV_SE"> + <description>Swedish - Sweden</description> + </element> + <element name="PT-PT" internal_name="PT_PT"> + <description>Portuguese - Portugal</description> + </element> + <element name="NL-NL" internal_name="NL_NL"> + <description>Dutch (Standard) - Netherlands</description> + </element> + <element name="EN-AU" internal_name="EN_AU"> + <description>English - Australia</description> + </element> + <element name="ZH-CN" internal_name="ZH_CN"> + <description>Mandarin - China</description> + </element> + <element name="ZH-TW" internal_name="ZH_TW"> + <description>Mandarin - Taiwan</description> + </element> + <element name="JA-JP" internal_name="JA_JP"> + <description>Japanese - Japan</description> + </element> + <element name="AR-SA" internal_name="AR_SA"> + <description>Arabic - Saudi Arabia</description> + </element> + <element name="KO-KR" internal_name="KO_KR"> + <description>Korean - South Korea</description> + </element> + <element name="PT-BR" internal_name="PT_BR"> + <description>Portuguese - Brazil</description> + </element> + <element name="CS-CZ" internal_name="CS_CZ"> + <description>Czech - Czech Republic</description> + </element> + <element name="DA-DK" internal_name="DA_DK"> + <description>Danish - Denmark</description> + </element> + <element name="NO-NO" internal_name="NO_NO"> + <description>Norwegian - Norway</description> + </element> + <element name="NL-BE" internal_name="NL_BE"> + <description>Dutch (Flemish) - Belgium</description> + </element> + <element name="EL-GR" internal_name="EL_GR"> + <description>Greek - Greece</description> + </element> + <element name="HU-HU" internal_name="HU_HU"> + <description>Hungarian - Hungary</description> + </element> + <element name="FI-FI" internal_name="FI_FI"> + <description>Finnish - Finland</description> + </element> + <element name="SK-SK" internal_name="SK_SK"> + <description>Slovak - Slovakia</description> + </element> + <element name="EN-IN" internal_name="EN_IN"> + <description>English - India</description> + </element> + <element name="TH-TH" internal_name="TH_TH"> + <description>Thai - Thailand</description> + </element> + <element name="EN-SA" internal_name="EN_SA"> + <description>English - Middle East</description> + </element> + <element name="HE-IL" internal_name="HE_IL"> + <description>Hebrew - Israel</description> + </element> + <element name="RO-RO" internal_name="RO_RO"> + <description>Romanian - Romania</description> + </element> + <element name="UK-UA" internal_name="UK_UA"> + <description>Ukrainian - Ukraine</description> + </element> + <element name="ID-ID" internal_name="ID_ID"> + <description>Indonesian - Indonesia</description> + </element> + <element name="VI-VN" internal_name="VI_VN"> + <description>Vietnamese - Vietnam</description> + </element> + <element name="MS-MY" internal_name="MS_MY"> + <description>Malay - Malaysia</description> + </element> + <element name="HI-IN" internal_name="HI_IN"> + <description>Hindi - India</description> + </element> + </enum> + + <enum name="UpdateMode"> + <description>Describes how the media clock timer should behave on the platform</description> + <element name="COUNTUP" > + <description>Starts the media clock timer counting upwards, as in time elapsed.</description> + </element> + <element name="COUNTDOWN" > + <description>Starts the media clock timer counting downwards, as in time remaining.</description> + </element> + <element name="PAUSE" > + <description>Pauses the media clock timer</description> + </element> + <element name="RESUME" > + <description>Resume the media clock timer</description> + </element> + <element name="CLEAR" > + <description>Clears the media clock timer (previously done through Show->mediaClock)</description> + </element> + </enum> + + <enum name="TimerMode"> + <element name="UP" > + <description>Causes the media clock timer to update from 0:00 to a specified time</description> + </element> + <element name="DOWN" > + <description>Causes the media clock timer to update from a specified time to 0:00</description> + </element> + <element name="NONE" > + <description>Indicates to not use the media clock timer</description> + </element> + </enum> + + <enum name="InteractionMode"> + <description>For application-requested interactions, this mode indicates the method in which the user is notified and uses the interaction.</description> + <element name="MANUAL_ONLY" > + <description>This mode causes the interaction to only occur on the display, meaning the choices are provided only via the display. No Voice Interaction.</description> + </element> + <element name="VR_ONLY" > + <description>This mode causes the interaction to only occur using the headunits VR system. Selections are made by saying the command.</description> + </element> + <element name="BOTH" > + <description>This mode causes both a VR and display selection option for an interaction. The user will first be asked via Voice Interaction (if available). If this is unsuccessful, the system will switch to manual input.</description> + </element> + </enum> + + <enum name="LayoutMode"> + <description>For touchscreen interactions, the mode of how the choices are presented.</description> + <element name="ICON_ONLY" > + <description>This mode causes the interaction to display the previous set of choices as icons.</description> + </element> + <element name="ICON_WITH_SEARCH" > + <description>This mode causes the interaction to display the previous set of choices as icons along with a search field in the HMI.</description> + </element> + <element name="LIST_ONLY" > + <description>This mode causes the interaction to display the previous set of choices as a list.</description> + </element> + <element name="LIST_WITH_SEARCH" > + <description>This mode causes the interaction to display the previous set of choices as a list along with a search field in the HMI.</description> + </element> + <element name="KEYBOARD" > + <description>This mode causes the interaction to immediately display a keyboard entry through the HMI.</description> + </element> + </enum> + + <enum name="HMILevel"> + <description>Enumeration that describes current levels of HMI.</description> + <element name="FULL" internal_name="HMI_FULL" /> + <element name="LIMITED" internal_name="HMI_LIMITED" /> + <element name="BACKGROUND" internal_name="HMI_BACKGROUND" /> + <element name="NONE" internal_name="HMI_NONE" /> + </enum> + + <enum name="AudioStreamingState"> + <description>Enumeration that describes possible states of audio streaming.</description> + <element name="AUDIBLE" /> + <element name="ATTENUATED" /> + <element name="NOT_AUDIBLE" /> + </enum> + + <enum name="SystemAction"> + <description>Enumeration that describes system actions that can be triggered.</description> + <element name="DEFAULT_ACTION"> + <description>Default action occurs. Standard behavior (e.g. SoftButton clears overlay).</description> + </element> + <element name="STEAL_FOCUS"> + <description>App is brought into HMI_FULL.</description> + </element> + <element name="KEEP_CONTEXT"> + <description>Current system context is maintained. An overlay is persisted even though a SoftButton has been pressed and the notification sent.</description> + </element> + </enum> + + <enum name="SystemContext"> + <description>Enumeration that describes possible contexts an app's HMI might be in. Communicated to whichever app is in HMI FULL, except Alert.</description> + <element name="MAIN" internal_name="SYSCTXT_MAIN"> + <description>The app's persistent display (whether media/non-media/navigation) is fully visible onscreen.</description> + </element> + <element name="VRSESSION" internal_name="SYSCTXT_VRSESSION"> + <description>The system is currently in a VR session (with whatever dedicated VR screen being overlaid onscreen).</description> + </element> + <element name="MENU" internal_name="SYSCTXT_MENU"> + <description>The system is currently displaying an in-App menu onscreen.</description> + </element> + <element name="HMI_OBSCURED" internal_name="SYSCTXT_HMI_OBSCURED"> + <description>The app's display HMI is currently being obscured by either a system or other app's overlay.</description> + </element> + <element name="ALERT" internal_name="SYSCTXT_ALERT"> + <description>Broadcast only to whichever app has an alert currently being displayed.</description> + </element> + </enum> + + <enum name="SoftButtonType"> + <description>Contains information about the SoftButton capabilities.</description> + <element name="TEXT" internal_name="SBT_TEXT"/> + <element name="IMAGE" internal_name="SBT_IMAGE"/> + <element name="BOTH" internal_name="SBT_BOTH"/> + </enum> + + <enum name="AppInterfaceUnregisteredReason"> + <description>Error code, which comes from the module side.</description> + <!-- Deprecate + <element name="USER_EXIT" /> + --> + <element name="IGNITION_OFF" /> + <element name="BLUETOOTH_OFF" /> + <element name="USB_DISCONNECTED" /> + <element name="REQUEST_WHILE_IN_NONE_HMI_LEVEL" /> + <element name="TOO_MANY_REQUESTS" /> + <element name="DRIVER_DISTRACTION_VIOLATION" /> + <element name="LANGUAGE_CHANGE" /> + <element name="MASTER_RESET" /> + <element name="FACTORY_DEFAULTS" /> + <element name="APP_UNAUTHORIZED" /> + <element name="PROTOCOL_VIOLATION" /> + <element name="UNSUPPORTED_HMI_RESOURCE" /> + </enum> + + <enum name="TriggerSource"> + <description>Indicates the source from where the command was triggered.</description> + <element name="MENU" internal_name="TS_MENU" /> + <element name="VR" internal_name="TS_VR" /> + <element name="KEYBOARD" internal_name="TS_KEYBOARD" /> + </enum> + + <enum name="HmiZoneCapabilities"> + <description>Contains information about the HMI zone capabilities.</description> + <description>For future use.</description> + <element name="FRONT" /> + <element name="BACK" /> + </enum> + + <enum name="SpeechCapabilities"> + <description>Contains information about the TTS capabilities.</description> + <element name="TEXT" internal_name="SC_TEXT"/> + <element name="SAPI_PHONEMES" /> + <element name="LHPLUS_PHONEMES" /> + <element name="PRE_RECORDED" /> + <element name="SILENCE" /> + </enum> + + <enum name="VrCapabilities"> + <description>Contains information about the VR capabilities.</description> + <element name="TEXT" internal_name="VR_TEXT"/> + </enum> + + <enum name="PrerecordedSpeech"> + <description>Contains a list of prerecorded speech items present on the platform.</description> + <element name="HELP_JINGLE" /> + <element name="INITIAL_JINGLE" /> + <element name="LISTEN_JINGLE" /> + <element name="POSITIVE_JINGLE" /> + <element name="NEGATIVE_JINGLE" /> + </enum> + + <enum name="SamplingRate"> + <description>Describes different sampling options for PerformAudioPassThru.</description> + <element name="8KHZ" internal_name="SamplingRate_8KHZ"/> + <element name="16KHZ" internal_name="SamplingRate_16KHZ"/> + <element name="22KHZ" internal_name="SamplingRate_22KHZ"/> + <element name="44KHZ" internal_name="SamplingRate_44KHZ"/> + </enum> + + <enum name="BitsPerSample"> + <description>Describes different quality options for PerformAudioPassThru.</description> + <element name="8_BIT" internal_name="BitsPerSample_8_BIT"/> + <element name="16_BIT" internal_name="BitsPerSample_16_BIT"/> + </enum> + + <enum name="AudioType"> + <description>Describes different audio type options for PerformAudioPassThru.</description> + <element name="PCM" /> + </enum> + + <struct name="AudioPassThruCapabilities"> + <description> + Describes different audio type configurations for PerformAudioPassThru. + e.g. {8kHz,8-bit,PCM} + </description> + <param name="samplingRate" type="SamplingRate" mandatory="true"/> + <param name="bitsPerSample" type="BitsPerSample" mandatory="true"/> + <param name="audioType" type="AudioType" mandatory="true"/> + </struct> + + <enum name="VehicleDataType"> + <description>Defines the data types that can be published and subscribed to.</description> + <element name="VEHICLEDATA_GPS"> + <description>Notifies GPSData may be subscribed</description> + </element> + <element name="VEHICLEDATA_SPEED" /> + <element name="VEHICLEDATA_RPM" /> + <element name="VEHICLEDATA_FUELLEVEL" /> + <element name="VEHICLEDATA_FUELLEVEL_STATE" /> + <element name="VEHICLEDATA_FUELCONSUMPTION" /> + <element name="VEHICLEDATA_EXTERNTEMP" /> + <element name="VEHICLEDATA_VIN" /> + <element name="VEHICLEDATA_PRNDL" /> + <element name="VEHICLEDATA_TIREPRESSURE" /> + <element name="VEHICLEDATA_ODOMETER" /> + <element name="VEHICLEDATA_BELTSTATUS" /> + <element name="VEHICLEDATA_BODYINFO" /> + <element name="VEHICLEDATA_DEVICESTATUS" /> + <element name="VEHICLEDATA_ECALLINFO" /> + <element name="VEHICLEDATA_AIRBAGSTATUS" /> + <element name="VEHICLEDATA_EMERGENCYEVENT" /> + <element name="VEHICLEDATA_CLUSTERMODESTATUS" /> + <element name="VEHICLEDATA_MYKEY" /> + <element name="VEHICLEDATA_BRAKING" /> + <element name="VEHICLEDATA_WIPERSTATUS" /> + <element name="VEHICLEDATA_HEADLAMPSTATUS" /> + <element name="VEHICLEDATA_BATTVOLTAGE" /> + <element name="VEHICLEDATA_ENGINETORQUE" /> + <element name="VEHICLEDATA_ACCPEDAL" /> + <element name="VEHICLEDATA_STEERINGWHEEL" /> + </enum> + + <enum name="ButtonName"> + <description>Defines the hard (physical) and soft (touchscreen) buttons available from the module</description> + <element name="OK" /> + <element name="SEEKLEFT" /> + <element name="SEEKRIGHT" /> + <element name="TUNEUP" /> + <element name="TUNEDOWN" /> + <element name="PRESET_0" /> + <element name="PRESET_1" /> + <element name="PRESET_2" /> + <element name="PRESET_3" /> + <element name="PRESET_4" /> + <element name="PRESET_5" /> + <element name="PRESET_6" /> + <element name="PRESET_7" /> + <element name="PRESET_8" /> + <element name="PRESET_9" /> + <element name="CUSTOM_BUTTON" /> + <element name="SEARCH" /> + <!-- Climate Buttons --> + <element name="AC_MAX" /> + <element name="AC" /> + <element name="RECIRCULATE" /> + <element name="FAN_UP" /> + <element name="FAN_DOWN" /> + <element name="TEMP_UP" /> + <element name="TEMP_DOWN" /> + <element name="DEFROST_MAX" /> + <element name="DEFROST" /> + <element name="DEFROST_REAR" /> + <element name="UPPER_VENT" /> + <element name="LOWER_VENT" /> + <!-- Radio Buttons --> + <element name="VOLUME_UP" /> + <element name="VOLUME_DOWN" /> + <element name="EJECT" /> + <element name="SOURCE" /> + <element name="SHUFFLE" /> + <element name="REPEAT" /> + </enum> + + <enum name="MediaClockFormat"> + <element name="CLOCK1"> + <description> + minutesFieldWidth = 2;minutesFieldMax = 19;secondsFieldWidth = 2;secondsFieldMax = 99;maxHours = 19;maxMinutes = 59;maxSeconds = 59; + used for Type II and CID headunits + </description> + </element> + <element name="CLOCK2"> + <description> + minutesFieldWidth = 3;minutesFieldMax = 199;secondsFieldWidth = 2;secondsFieldMax = 99;maxHours = 59;maxMinutes = 59;maxSeconds = 59; + used for Type V headunit + </description> + </element> + <element name="CLOCK3"> + <description> + minutesFieldWidth = 2;minutesFieldMax = 59;secondsFieldWidth = 2;secondsFieldMax = 59;maxHours = 9;maxMinutes = 59;maxSeconds = 59; + used for GEN1.1 MFD3/4/5 headunits + </description> + </element> + <element name="CLOCKTEXT1"> + <description> + 5 characters possible + Format: 1|sp c :|sp c c + 1|sp : digit "1" or space + c : character out of following character set: sp|0-9|[letters, see TypeII column in XLS. See [@TODO: create file ref]] + :|sp : colon or space + used for Type II headunit + </description> + </element> + <element name="CLOCKTEXT2"> + <description> + 5 chars possible + Format: 1|sp c :|sp c c + 1|sp : digit "1" or space + c : character out of following character set: sp|0-9|[letters, see CID column in XLS. See [@TODO: create file ref]] + :|sp : colon or space + used for CID headunit + NOTE: difference between CLOCKTEXT1 and CLOCKTEXT2 is the supported character set + </description> + </element> + <element name="CLOCKTEXT3"> + <description> + 6 chars possible + Format: 1|sp c c :|sp c c + 1|sp : digit "1" or space + c : character out of following character set: sp|0-9|[letters, see Type 5 column in XLS]. See [@TODO: create file ref] + :|sp : colon or space + used for Type V headunit + </description> + </element> + <element name="CLOCKTEXT4"> + <description> + 6 chars possible + Format: c :|sp c c : c c + :|sp : colon or space + c : character out of following character set: sp|0-9|[letters]. + used for GEN1.1 MFD3/4/5 headunits + </description> + </element> + </enum> + + <enum name="DisplayType"> + <description>See DAES for further infos regarding the displays</description> + <element name="CID"/> + <element name="TYPE2" /> + <element name="TYPE5" /> + <element name="NGN" /> + <element name="GEN2_8_DMA" /> + <element name="GEN2_6_DMA" /> + <element name="MFD3" /> + <element name="MFD4" /> + <element name="MFD5" /> + <element name="GEN3_8-INCH" internal_name="GEN3_8_INCH" /> + <element name="SDL_GENERIC" /> + </enum> + + <enum name="TextFieldName"> + <element name="mainField1"> + <description>The first line of first set of main fields of the persistent display; applies to "Show"</description> + </element> + + <element name="mainField2"> + <description>The second line of first set of main fields of the persistent display; applies to "Show"</description> + </element> + + <element name="mainField3"> + <description>The first line of second set of main fields of persistent display; applies to "Show"</description> + </element> + + <element name="mainField4"> + <description>The second line of second set of main fields of the persistent display; applies to "Show"</description> + </element> + + <element name="statusBar"> + <description>The status bar on NGN; applies to "Show"</description> + </element> + + <element name="mediaClock"> + <description>Text value for MediaClock field; applies to "Show"</description> + </element> + + <element name="mediaTrack"> + <description>The track field of NGN and GEN1.1 MFD displays. This field is only available for media applications; applies to "Show"</description> + </element> + + <element name="alertText1"> + <description>The first line of the alert text field; applies to "Alert"</description> + </element> + + <element name="alertText2"> + <description>The second line of the alert text field; applies to "Alert"</description> + </element> + + <element name="alertText3"> + <description>The third line of the alert text field; applies to "Alert"</description> + </element> + + <element name="scrollableMessageBody"> + <description>Long form body of text that can include newlines and tabs; applies to "ScrollableMessage"</description> + </element> + + <element name="initialInteractionText"> + <description> First line suggestion for a user response (in the case of VR enabled interaction)</description> + </element> + + <element name="navigationText1"> + <description> First line of navigation text</description> + </element> + + <element name="navigationText2"> + <description> Second line of navigation text</description> + </element> + + <element name="ETA"> + <description> Estimated Time of Arrival time for navigation</description> + </element> + + <element name="totalDistance"> + <description> Total distance to destination for navigation</description> + </element> + + <element name="audioPassThruDisplayText1"> + <description> First line of text for audio pass thru</description> + </element> + + <element name="audioPassThruDisplayText2"> + <description> Second line of text for audio pass thru</description> + </element> + + <element name="sliderHeader"> + <description> Header text for slider</description> + </element> + + <element name="sliderFooter"> + <description> Footer text for slider</description> + </element> + + <element name="menuName"> + <description> Primary text for Choice</description> + </element> + + <element name="secondaryText"> + <description> Secondary text for Choice</description> + </element> + + <element name="tertiaryText"> + <description> Tertiary text for Choice</description> + </element> + + <element name="menuTitle"> + <description> Optional text to label an app menu button (for certain touchscreen platforms).</description> + </element> + + <element name="locationName"> + <description> Optional name / title of intended location for SendLocation.</description> + </element> + + <element name="locationDescription"> + <description> Optional description of intended location / establishment (if applicable) for SendLocation.</description> + </element> + + <element name="addressLines"> + <description> Optional location address (if applicable) for SendLocation.</description> + </element> + + <element name="phoneNumber"> + <description> Optional hone number of intended location / establishment (if applicable) for SendLocation.</description> + </element> + + </enum> + + <enum name="ImageFieldName"> + <element name="softButtonImage"> + <description>The image field for SoftButton</description> + </element> + + <element name="choiceImage"> + <description>The first image field for Choice</description> + </element> + + <element name="choiceSecondaryImage"> + <description>The secondary image field for Choice</description> + </element> + + <element name="vrHelpItem"> + <description>The image field for vrHelpItem</description> + </element> + + <element name="turnIcon"> + <description>The image field for Turn</description> + </element> + + <element name="menuIcon"> + <description>The image field for the menu icon in SetGlobalProperties</description> + </element> + + <element name="cmdIcon"> + <description>The image field for AddCommand</description> + </element> + + <element name="appIcon"> + <description>The image field for the app icon (set by setAppIcon)</description> + </element> + + <element name="graphic"> + <description>The image field for Show</description> + </element> + + <element name="showConstantTBTIcon"> + <description>The primary image field for ShowConstantTBT</description> + </element> + + <element name="showConstantTBTNextTurnIcon"> + <description>The secondary image field for ShowConstantTBT</description> + </element> + + <element name="locationImage"> + <description>The optional image of a destination / location</description> + </element> + + </enum> + + <enum name="CharacterSet"> + <description>The list of potential character sets</description> + <element name="TYPE2SET"> + <description>See [@TODO: create file ref]</description> + </element> + <element name="TYPE5SET"> + <description>See [@TODO: create file ref]</description> + </element> + <element name="CID1SET"> + <description>See [@TODO: create file ref]</description> + </element> + <element name="CID2SET"> + <description>See [@TODO: create file ref]</description> + </element> + </enum> + + <enum name="TextAlignment"> + <description>The list of possible alignments, left, right, or centered</description> + <element name="LEFT_ALIGNED" /> + <element name="RIGHT_ALIGNED" /> + <element name="CENTERED" /> + </enum> + + <enum name="TBTState"> + <description>Enumeration that describes possible states of turn-by-turn client or AppLink app.</description> + <element name="ROUTE_UPDATE_REQUEST" /> + <element name="ROUTE_ACCEPTED" /> + <element name="ROUTE_REFUSED" /> + <element name="ROUTE_CANCELLED" /> + <element name="ETA_REQUEST" /> + <element name="NEXT_TURN_REQUEST" /> + <element name="ROUTE_STATUS_REQUEST" /> + <element name="ROUTE_SUMMARY_REQUEST" /> + <element name="TRIP_STATUS_REQUEST" /> + <element name="ROUTE_UPDATE_REQUEST_TIMEOUT" /> + </enum> + + <enum name="DriverDistractionState"> + <description>Enumeration that describes possible states of driver distraction.</description> + <element name="DD_ON" /> + <element name="DD_OFF" /> + </enum> + + <enum name="ImageType"> + <description>Contains information about the type of image.</description> + <element name="STATIC" /> + <element name="DYNAMIC" /> + </enum> + + <enum name="DeliveryMode"> + <description>The mode in which the SendLocation request is sent</description> + <element name="PROMPT" /> + <element name="DESTINATION" /> + <element name="QUEUE" /> + </enum> + + <enum name="VideoStreamingProtocol"> + <description>Enum for each type of video streaming protocol type.</description> + <element name="RAW"> + <description>Raw stream bytes that contains no timestamp data and is the lowest supported video streaming</description> + </element> + <element name="RTP"> + <description>RTP facilitates the transfer of real-time data. Information provided by this protocol include timestamps (for synchronization), sequence numbers (for packet loss and reordering detection) and the payload format which indicates the encoded format of the data.</description> + </element> + <element name="RTSP"> + <description>The transmission of streaming data itself is not a task of RTSP. Most RTSP servers use the Real-time Transport Protocol (RTP) in conjunction with Real-time Control Protocol (RTCP) for media stream delivery. However, some vendors implement proprietary transport protocols. </description> + </element> + <element name="RTMP"> + <description> Real-Time Messaging Protocol (RTMP) was initially a proprietary protocol developed by Macromedia for streaming audio, video and data over the Internet, between a Flash player and a server. Macromedia is now owned by Adobe, which has released an incomplete version of the specification of the protocol for public use.</description> + </element> + <element name="WEBM"> + <description>The WebM container is based on a profile of Matroska. WebM initially supported VP8 video and Vorbis audio streams. In 2013 it was updated to accommodate VP9 video and Opus audio.</description> + </element> + </enum> + + <enum name="VideoStreamingCodec"> + <description>Enum for each type of video streaming codec.</description> + <element name="H264"> + <description>A block-oriented motion-compensation-based video compression standard. As of 2014 it is one of the most commonly used formats for the recording, compression, and distribution of video content.</description> + </element> + <element name="H265"> + <description>High Efficiency Video Coding (HEVC), also known as H.265 and MPEG-H Part 2, is a video compression standard, one of several potential successors to the widely used AVC (H.264 or MPEG-4 Part 10). In comparison to AVC, HEVC offers about double the data compression ratio at the same level of video quality, or substantially improved video quality at the same bit rate. It supports resolutions up to 8192x4320, including 8K UHD.</description> + </element> + <element name="Theora"> + <description>Theora is derived from the formerly proprietary VP3 codec, released into the public domain by On2 Technologies. It is broadly comparable in design and bitrate efficiency to MPEG-4 Part 2, early versions of Windows Media Video, and RealVideo while lacking some of the features present in some of these other codecs. It is comparable in open standards philosophy to the BBC's Dirac codec.</description> + </element> + <element name="VP8"> + <description>VP8 can be multiplexed into the Matroska-based container format WebM along with Vorbis and Opus audio. The image format WebP is based on VP8's intra-frame coding. VP8's direct successor, VP9, and the emerging royalty-free internet video format AV1 from the Alliance for Open Media (AOMedia) are based on VP8.</description> + </element> + <element name="VP9"> + <description>Similar to VP8, but VP9 is customized for video resolutions beyond high-definition video (UHD) and also enables lossless compression.</description> + </element> + </enum> + + <struct name="Image"> + <param name="value" minlength="0" maxlength="65535" type="String" mandatory="true"> + <description>Either the static hex icon value or the binary image file name identifier (sent by PutFile).</description> + </param> + <param name="imageType" type="ImageType" mandatory="true"> + <description>Describes, whether it is a static or dynamic image.</description> + </param> + </struct> + + <struct name="SoftButton"> + <param name="type" type="SoftButtonType" mandatory="true"> + <description>Describes, whether it is text, highlighted text, icon, or dynamic image. See softButtonType</description> + </param> + <param name="text" minlength="0" maxlength="500" type="String" mandatory="false"> + <description>Optional text to display (if defined as TEXT or BOTH)</description> + </param> + <param name="image" type="Image" mandatory="false"> + <description>Optional image struct for SoftButton (if defined as IMAGE or BOTH)</description> + </param> + <param name="isHighlighted" type="Boolean" defvalue="false" mandatory="false"> + <description> + True, if highlighted + False, if not highlighted + </description> + </param> + <param name="softButtonID" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"> + <description>Value which is returned via OnButtonPress / OnButtonEvent</description> + </param> + <param name="systemAction" type="SystemAction" defvalue="DEFAULT_ACTION" mandatory="false"> + <description>Parameter indicating whether selecting a SoftButton shall call a specific system action. This is intended to allow Notifications to bring the callee into full / focus; or in the case of persistent overlays, the overlay can persist when a SoftButton is pressed.</description> + </param> + </struct> + + <struct name="Choice"> + <description>A choice is an option given to the user, which can be selected either by menu, or through voice recognition system.</description> + <param name="choiceID" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"/> + <param name="menuName" type="String" maxlength="500" mandatory="true"/> + <param name="vrCommands" type="String" minsize="1" maxsize="100" maxlength="99" array="true" mandatory="true"/> + <param name="image" type="Image" mandatory="false"/> + <param name="secondaryText" maxlength="500" type="String" mandatory="false"> + <description>Optional secondary text to display; e.g. address of POI in a search result entry</description> + </param> + <param name="tertiaryText" maxlength="500" type="String" mandatory="false"> + <description>Optional tertiary text to display; e.g. distance to POI for a search result entry</description> + </param> + <param name="secondaryImage" type="Image" mandatory="false"> + <description>Optional secondary image struct for choice</description> + </param> + </struct> + + <struct name="VrHelpItem"> + <param name="text" maxlength="500" type="String" mandatory="true"> + <description>Text to display for VR Help item</description> + </param> + <param name="image" type="Image" mandatory="false"> + <description>Image struct for VR Help item</description> + </param> + <param name="position" type="Integer" minvalue="1" maxvalue="100" mandatory="true"> + <description>Position to display item in VR Help list</description> + </param> + </struct> + + <struct name="SyncMsgVersion"> + <description>Specifies the version number of the SmartDeviceLink protocol that is supported by the mobile application</description> + + <param name="majorVersion" type="Integer" minvalue="1" maxvalue="10" mandatory="true"> + <description>The major version indicates versions that is not-compatible to previous versions.</description> + </param> + <param name="minorVersion" type="Integer" minvalue="0" maxvalue="1000" mandatory="true"> + <description>The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality)</description> + </param> + <param name="patchVersion" type="Integer" minvalue="0" maxvalue="1000" mandatory="false"> + <description>The patch version indicates a fix to existing functionality in a previous version that should still be able to be run on an older version </description> + </param> + </struct> + + <enum name="GlobalProperty"> + <description>The different global properties.</description> + <element name="HELPPROMPT"> + <description>The property helpPrompt of setGlobalProperties</description> + </element> + <element name="TIMEOUTPROMPT"> + <description>The property timeoutPrompt of setGlobalProperties</description> + </element> + <element name="VRHELPTITLE"> + <description>The property vrHelpTitle of setGlobalProperties</description> + </element> + <element name="VRHELPITEMS"> + <description>The property array of vrHelp of setGlobalProperties</description> + </element> + <element name="MENUNAME"> + <description>The property in-app menu name of setGlobalProperties</description> + </element> + <element name="MENUICON"> + <description>The property in-app menu icon of setGlobalProperties</description> + </element> + <element name="KEYBOARDPROPERTIES"> + <description>The on-screen keyboard configuration of setGlobalProperties</description> + </element> + </enum> + + <enum name="CompassDirection"> + <description>The list of potential compass directions</description> + <element name="NORTH"> + </element> + <element name="NORTHWEST"> + </element> + <element name="WEST"> + </element> + <element name="SOUTHWEST"> + </element> + <element name="SOUTH"> + </element> + <element name="SOUTHEAST"> + </element> + <element name="EAST"> + </element> + <element name="NORTHEAST"> + </element> + </enum> + + <enum name="Dimension"> + <description>The supported dimensions of the GPS</description> + <element name="NO_FIX" internal_name="Dimension_NO_FIX"> + <description>No GPS at all</description> + </element> + <element name="2D" internal_name="Dimension_2D"> + <description>Longitude and latitude</description> + </element> + <element name="3D" internal_name="Dimension_3D"> + <description>Longitude and latitude and altitude</description> + </element> + </enum> + + <enum name="PRNDL"> + <description>The selected gear.</description> + <element name="PARK"> + <description>Parking</description> + </element> + <element name="REVERSE"> + <description>Reverse gear</description> + </element> + <element name="NEUTRAL"> + <description>No gear</description> + </element> + <element name="DRIVE"> + </element> + <element name="SPORT"> + <description>Drive Sport mode</description> + </element> + <element name="LOWGEAR"> + <description>1st gear hold</description> + </element> + <element name="FIRST"> + </element> + <element name="SECOND"> + </element> + <element name="THIRD"> + </element> + <element name="FOURTH"> + </element> + <element name="FIFTH"> + </element> + <element name="SIXTH"> + </element> + <element name="SEVENTH"> + </element> + <element name="EIGHTH"> + </element> + <element name="UNKNOWN"> + </element> + <element name="FAULT"> + </element> + </enum> + + <enum name="ComponentVolumeStatus"> + <description>The volume status of a vehicle component.</description> + <element name="UNKNOWN" internal_name="CVS_UNKNOWN"> + </element> + <element name="NORMAL" internal_name="CVS_NORMAL"> + </element> + <element name="LOW" internal_name="CVS_LOW"> + </element> + <element name="FAULT" internal_name="CVS_FAULT"> + </element> + <element name="ALERT" internal_name="CVS_ALERT"> + </element> + <element name="NOT_SUPPORTED" internal_name="CVS_NOT_SUPPORTED"> + </element> + </enum> + + <struct name="SingleTireStatus"> + <param name="status" type="ComponentVolumeStatus" mandatory="true"> + <description>See ComponentVolumeStatus.</description> + </param> + </struct> + + <enum name="WarningLightStatus"> + <description>Reflects the status of a cluster instrument warning light.</description> + <element name="OFF" internal_name="WLS_OFF"> + </element> + <element name="ON" internal_name="WLS_ON"> + </element> + <element name="FLASH" internal_name="WLS_FLASH"> + </element> + <element name="NOT_USED" internal_name="WLS_NOT_USED"> + </element> + </enum> + + <enum name="VehicleDataNotificationStatus"> + <description>Reflects the status of a vehicle data notification.</description> + <element name="NOT_SUPPORTED" internal_name="VDNS_NOT_SUPPORTED"> + </element> + <element name="NORMAL" internal_name="VDNS_NORMAL"> + </element> + <element name="ACTIVE" internal_name="VDNS_ACTIVE"> + </element> + <element name="NOT_USED" internal_name="VDNS_NOT_USED"> + </element> + </enum> + + <enum name="IgnitionStableStatus"> + <description>Reflects the ignition switch stability.</description> + <element name="IGNITION_SWITCH_NOT_STABLE"> + </element> + <element name="IGNITION_SWITCH_STABLE"> + </element> + <element name="MISSING_FROM_TRANSMITTER"> + </element> + </enum> + + <enum name="IgnitionStatus"> + <description>Reflects the status of ignition.</description> + <element name="UNKNOWN" internal_name="IS_UNKNOWN"> + </element> + <element name="OFF" internal_name="IS_OFF"> + </element> + <element name="ACCESSORY" internal_name="IS_ACCESSORY"> + </element> + <element name="RUN" internal_name="IS_RUN"> + </element> + <element name="START" internal_name="IS_START"> + </element> + <element name="INVALID" internal_name="IS_INVALID"> + </element> + </enum> + + <enum name="VehicleDataEventStatus"> + <description>Reflects the status of a vehicle data event; e.g. a seat belt event status.</description> + <element name="NO_EVENT" internal_name="VDES_NO_EVENT"> + </element> + <element name="NO" internal_name="VDES_NO"> + </element> + <element name="YES" internal_name="VDES_YES"> + </element> + <element name="NOT_SUPPORTED" internal_name="VDES_NOT_SUPPORTED"> + </element> + <element name="FAULT" internal_name="VDES_FAULT"> + </element> + </enum> + + <enum name="DeviceLevelStatus"> + <description>Reflects the reported battery status of the connected device, if reported.</description> + <element name="ZERO_LEVEL_BARS"> + </element> + <element name="ONE_LEVEL_BARS"> + </element> + <element name="TWO_LEVEL_BARS"> + </element> + <element name="THREE_LEVEL_BARS"> + </element> + <element name="FOUR_LEVEL_BARS"> + </element> + <element name="NOT_PROVIDED"> + </element> + </enum> + + <enum name="PrimaryAudioSource"> + <description>Reflects the current primary audio source (if selected).</description> + <element name="NO_SOURCE_SELECTED"> + </element> + <element name="USB"> + </element> + <element name="USB2"> + </element> + <element name="BLUETOOTH_STEREO_BTST"> + </element> + <element name="LINE_IN"> + </element> + <element name="IPOD"> + </element> + <element name="MOBILE_APP"> + </element> + </enum> + + <enum name="WiperStatus"> + <description>Reflects the status of the wipers.</description> + <element name="OFF" /> + <element name="AUTO_OFF" /> + <element name="OFF_MOVING" /> + <element name="MAN_INT_OFF" /> + <element name="MAN_INT_ON" /> + <element name="MAN_LOW" /> + <element name="MAN_HIGH" /> + <element name="MAN_FLICK" /> + <element name="WASH" /> + <element name="AUTO_LOW" /> + <element name="AUTO_HIGH" /> + <element name="COURTESYWIPE" /> + <element name="AUTO_ADJUST" /> + <element name="STALLED" /> + <element name="NO_DATA_EXISTS" /> + </enum> + + <enum name="VehicleDataStatus"> + <description>Reflects the status of a binary vehicle data item.</description> + <element name="NO_DATA_EXISTS" internal_name="VDS_NO_DATA_EXISTS"> + </element> + <element name="OFF" internal_name="VDS_OFF"> + </element> + <element name="ON" internal_name="VDS_ON"> + </element> + </enum> + + <enum name="MaintenanceModeStatus"> + <description>Reflects the status of a vehicle maintenance mode.</description> + <element name="NORMAL" internal_name="MMS_NORMAL"> + </element> + <element name="NEAR" internal_name="MMS_NEAR"> + </element> + <element name="ACTIVE" internal_name="MMS_ACTIVE"> + </element> + <element name="FEATURE_NOT_PRESENT" internal_name="MMS_FEATURE_NOT_PRESENT"> + </element> + </enum> + + <enum name="VehicleDataActiveStatus"> + <description>Reflects the status of given vehicle component.</description> + <element name="INACTIVE_NOT_CONFIRMED" internal_name="VDAS_INACTIVE_NOT_CONFIRMED"> + </element> + <element name="INACTIVE_CONFIRMED" internal_name="VDAS_INACTIVE_CONFIRMED"> + </element> + <element name="ACTIVE_NOT_CONFIRMED" internal_name="VDAS_ACTIVE_NOT_CONFIRMED"> + </element> + <element name="ACTIVE_CONFIRMED" internal_name="VDAS_ACTIVE_CONFIRMED"> + </element> + <element name="FAULT" internal_name="VDAS_FAULT"> + </element> + </enum> + + <enum name="AmbientLightStatus"> + <description>Reflects the status of the ambient light sensor.</description> + <element name="NIGHT" /> + <element name="TWILIGHT_1" /> + <element name="TWILIGHT_2" /> + <element name="TWILIGHT_3" /> + <element name="TWILIGHT_4" /> + <element name="DAY" /> + <element name="UNKNOWN" internal_name="ALS_UNKNOWN" /> + <element name="INVALID" /> + </enum> + + <enum name="ModuleType"> + <element name="CLIMATE"/> + <element name="RADIO"/> + </enum> + + <enum name="DefrostZone"> + <element name="FRONT"/> + <element name="REAR"/> + <element name="ALL"/> + <element name="NONE"/> + </enum> + + <enum name="VentilationMode"> + <element name="UPPER"/> + <element name="LOWER"/> + <element name="BOTH"/> + <element name="NONE"/> + </enum> + + <enum name="RadioBand"> + <element name="AM"/> + <element name="FM"/> + <element name="XM"/> + </enum> + + <enum name="RadioState"> + <element name="ACQUIRING"/> + <element name="ACQUIRED"/> + <element name="MULTICAST"/> + <element name="NOT_FOUND"/> + </enum> + + <enum name="TemperatureUnit"> + <element name="FAHRENHEIT"/> + <element name="CELSIUS"/> + </enum> + + <struct name="BeltStatus"> + <param name="driverBeltDeployed" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsDrvBelt_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="passengerBeltDeployed" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsPasBelt_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="passengerBuckleBelted" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsRw1PasBckl_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="driverBuckleBelted" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsRw1DrvBckl_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="leftRow2BuckleBelted" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsRw2lBckl_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="passengerChildDetected" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsRw1PasChld_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="rightRow2BuckleBelted" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsRw2rBckl_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="middleRow2BuckleBelted" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsRw2mBckl_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="middleRow3BuckleBelted" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsRw3mBckl_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="leftRow3BuckleBelted" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsRw3lBckl_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="rightRow3BuckleBelted" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsRw3rBckl_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="leftRearInflatableBelted" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsRw2lRib_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="rightRearInflatableBelted" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsRw2rRib_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="middleRow1BeltDeployed" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsRw1mBelt_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="middleRow1BuckleBelted" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsRw1mBckl_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + </struct> + + <struct name="BodyInformation"> + <param name="parkBrakeActive" type="Boolean" mandatory="true"> + <description>References signal "PrkBrkActv_B_Actl".</description> + </param> + <param name="ignitionStableStatus" type="IgnitionStableStatus" mandatory="true"> + <description>References signal "Ignition_Switch_Stable". See IgnitionStableStatus.</description> + </param> + <param name="ignitionStatus" type="IgnitionStatus" mandatory="true"> + <description>References signal "Ignition_status". See IgnitionStatus.</description> + </param> + <param name="driverDoorAjar" type="Boolean" mandatory="false"> + <description>References signal "DrStatDrv_B_Actl".</description> + </param> + <param name="passengerDoorAjar" type="Boolean" mandatory="false"> + <description>References signal "DrStatPsngr_B_Actl".</description> + </param> + <param name="rearLeftDoorAjar" type="Boolean" mandatory="false"> + <description>References signal "DrStatRl_B_Actl".</description> + </param> + <param name="rearRightDoorAjar" type="Boolean" mandatory="false"> + <description>References signal "DrStatRr_B_Actl".</description> + </param> + </struct> + + <struct name="DeviceStatus"> + <param name="voiceRecOn" type="Boolean" mandatory="true"> + <description>References signal "CPM_VoiceRec_STAT".</description> + </param> + <param name="btIconOn" type="Boolean" mandatory="true"> + <description>References signal "BT_ICON".</description> + </param> + <param name="callActive" type="Boolean" mandatory="true"> + <description>References signal "CPM_Call_Active_STAT".</description> + </param> + <param name="phoneRoaming" type="Boolean" mandatory="true"> + <description>References signal "CPM_Phone_Roaming_STAT".</description> + </param> + <param name="textMsgAvailable" type="Boolean" mandatory="true"> + <description>References signal "CPM_TextMsg_AVAL".</description> + </param> + <param name="battLevelStatus" type="DeviceLevelStatus" mandatory="true"> + <description>Device battery level status. References signal "CPM_Batt_Level_STAT". See DeviceLevelStatus.</description> + </param> + <param name="stereoAudioOutputMuted" type="Boolean" mandatory="true"> + <description>References signal "CPM_Stereo_Audio_Output".</description> + </param> + <param name="monoAudioOutputMuted" type="Boolean" mandatory="true"> + <description>References signal "CPM_Mono_Audio_Output".</description> + </param> + <param name="signalLevelStatus" type="DeviceLevelStatus" mandatory="true"> + <description>Device signal level status. References signal "CPM_Signal_Strength_STAT". See DeviceLevelStatus.</description> + </param> + <param name="primaryAudioSource" type="PrimaryAudioSource" mandatory="true"> + <description>References signal "CPM_Stereo_PAS_Source". See PrimaryAudioSource.</description> + </param> + <param name="eCallEventActive" type="Boolean" mandatory="true"> + <description>References signal "eCall_Event".</description> + </param> + </struct> + + <struct name="HeadLampStatus"> + <param name="lowBeamsOn" type="Boolean" mandatory="true"> + <description>Status of the low beam lamps. References signal "HeadLampLoActv_B_Stat".</description> + </param> + <param name="highBeamsOn" type="Boolean" mandatory="true"> + <description>Status of the high beam lamps. References signal "HeadLghtHiOn_B_Stat".</description> + </param> + <param name="ambientLightSensorStatus" type="AmbientLightStatus" mandatory="false"> + <description>Status of the ambient light sensor.</description> + </param> + </struct> + + <struct name="AppInfo"> + <description>Contains detailed information about the registered application.</description> + + <param name="appDisplayName" type="String" maxlength="100" mandatory="true"> + <description>The name displayed for the mobile application on the mobile device (can differ from the app name set in the initial RAI request).</description> + </param> + + <param name="appBundleID" type="String" maxlength="256" mandatory="true"> + <description>The AppBundleID of an iOS application or package name of the Android application. This supports App Launch strategies for each platform.</description> + </param> + + <param name="appVersion" type="String" maxlength="256" mandatory="true"> + <description>Represents the build version number of this particular mobile app.</description> + </param> + + <param name="appIcon" type="String" maxlength="500" mandatory="false"> + <description>A file reference to the icon utilized by this app (simplifies the process of setting an app icon during app registration).</description> + </param> + </struct> + + <!-- ~~~~~~~~~~~~~~~~~~~~~~~~ --> + <!-- Ford Specific Data Items --> + <!-- ~~~~~~~~~~~~~~~~~~~~~~~~ --> + <enum name="FileType"> + <description>Enumeration listing possible file types.</description> + <element name="GRAPHIC_BMP" /> + <element name="GRAPHIC_JPEG" /> + <element name="GRAPHIC_PNG" /> + <element name="AUDIO_WAVE" /> + <element name="AUDIO_MP3" /> + <element name="AUDIO_AAC" /> + <element name="BINARY" /> + <element name="JSON" /> + </enum> + + <enum name="FuelCutoffStatus" > + <description>Reflects the status of the RCM fuel cutoff.</description> + <element name="TERMINATE_FUEL" internal_name="FCS_TERMINATE_FUEL"> + </element> + <element name="NORMAL_OPERATION" internal_name="FCS_NORMAL_OPERATION"> + </element> + <element name="FAULT" internal_name="FCS_FAULT"> + </element> + </enum> + + <enum name="EmergencyEventType"> + <description>Reflects the emergency event status of the vehicle.</description> + <element name="NO_EVENT" internal_name="EET_NO_EVENT"> + </element> + <element name="FRONTAL" internal_name="EET_FRONTAL"> + </element> + <element name="SIDE" internal_name="EET_SIDE"> + </element> + <element name="REAR" internal_name="EET_REAR"> + </element> + <element name="ROLLOVER" internal_name="EET_ROLLOVER"> + </element> + <element name="NOT_SUPPORTED" internal_name="EET_NOT_SUPPORTED"> + </element> + <element name="FAULT" internal_name="EET_FAULT"> + </element> + </enum> + + <enum name="ECallConfirmationStatus"> + <description>Reflects the status of the eCall Notification.</description> + <element name="NORMAL" internal_name="ECCS_NORMAL"> + </element> + <element name="CALL_IN_PROGRESS" internal_name="ECCS_CALL_IN_PROGRESS"> + </element> + <element name="CALL_CANCELLED" internal_name="ECCS_CALL_CANCELLED"> + </element> + <element name="CALL_COMPLETED"> + </element> + <element name="CALL_UNSUCCESSFUL" internal_name="ECCS_CALL_UNSUCCESSFUL"> + </element> + <element name="ECALL_CONFIGURED_OFF" internal_name="ECCS_ECALL_CONFIGURED_OFF"> + </element> + <element name="CALL_COMPLETE_DTMF_TIMEOUT" internal_name="ECCS_CALL_COMPLETE_DTMF_TIMEOUT"> + </element> + </enum> + + <enum name="PowerModeQualificationStatus" > + <description>Reflects the status of the current power mode qualification.</description> + <element name="POWER_MODE_UNDEFINED"> + </element> + <element name="POWER_MODE_EVALUATION_IN_PROGRESS"> + </element> + <element name="NOT_DEFINED"> + </element> + <element name="POWER_MODE_OK"> + </element> + </enum> + + <enum name="PowerModeStatus"> + <description>Reflects the status of the current power mode.</description> + <element name="KEY_OUT"> + </element> + <element name="KEY_RECENTLY_OUT"> + </element> + <element name="KEY_APPROVED_0"> + </element> + <element name="POST_ACCESORY_0"> + </element> + <element name="ACCESORY_1"> + </element> + <element name="POST_IGNITION_1"> + </element> + <element name="IGNITION_ON_2"> + </element> + <element name="RUNNING_2"> + </element> + <element name="CRANK_3"> + </element> + </enum> + + <enum name="CarModeStatus"> + <description>Reflects the status of the current car mode.</description> + <element name="NORMAL" internal_name="CMS_NORMAL"> + </element> + <element name="FACTORY" internal_name="CMS_FACTORY"> + </element> + <element name="TRANSPORT" internal_name="CMS_TRANSPORT"> + </element> + <element name="CRASH" internal_name="CMS_CRASH"> + </element> + </enum> + + <struct name="ECallInfo"> + <param name="eCallNotificationStatus" type="VehicleDataNotificationStatus" mandatory="true"> + <description>References signal "eCallNotification_4A". See VehicleDataNotificationStatus.</description> + </param> + <param name="auxECallNotificationStatus" type="VehicleDataNotificationStatus" mandatory="true"> + <description>References signal "eCallNotification". See VehicleDataNotificationStatus.</description> + </param> + <param name="eCallConfirmationStatus" type="ECallConfirmationStatus" mandatory="true"> + <description>References signal "eCallConfirmation". See ECallConfirmationStatus.</description> + </param> + </struct> + + <struct name="AirbagStatus"> + <param name="driverAirbagDeployed" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsDrvBag_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="driverSideAirbagDeployed" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsDrvSideBag_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="driverCurtainAirbagDeployed" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsDrvCrtnBag_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="passengerAirbagDeployed" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsPasBag_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="passengerCurtainAirbagDeployed" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsPasCrtnBag_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="driverKneeAirbagDeployed" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsKneeDrvBag_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="passengerSideAirbagDeployed" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsPasSideBag_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + <param name="passengerKneeAirbagDeployed" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsKneePasBag_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + </struct> + + <struct name="EmergencyEvent"> + <param name="emergencyEventType" type="EmergencyEventType" mandatory="true"> + <description>References signal "VedsEvntType_D_Ltchd". See EmergencyEventType.</description> + </param> + <param name="fuelCutoffStatus" type="FuelCutoffStatus" mandatory="true"> + <description>References signal "RCM_FuelCutoff". See FuelCutoffStatus.</description> + </param> + <param name="rolloverEvent" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsEvntRoll_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + + <param name="maximumChangeVelocity" type="Integer" minvalue="0" maxvalue="255" mandatory="true"> + <description>References signal "VedsMaxDeltaV_D_Ltchd". Change in velocity in KPH. Additional reserved values: + 0x00 No event + 0xFE Not supported + 0xFF Fault + </description> + </param> + <param name="multipleEvents" type="VehicleDataEventStatus" mandatory="true"> + <description>References signal "VedsMultiEvnt_D_Ltchd". See VehicleDataEventStatus.</description> + </param> + </struct> + + <struct name="ClusterModeStatus"> + <param name="powerModeActive" type="Boolean" mandatory="true"> + <description>References signal "PowerMode_UB".</description> + </param> + <param name="powerModeQualificationStatus" type="PowerModeQualificationStatus" mandatory="true"> + <description>References signal "PowerModeQF". See PowerModeQualificationStatus.</description> + </param> + <param name="carModeStatus" type="CarModeStatus" mandatory="true"> + <description>References signal "CarMode". See CarMode.</description> + </param> + <param name="powerModeStatus" type="PowerModeStatus" mandatory="true"> + <description>References signal "PowerMode". See PowerMode.</description> + </param> + </struct> + + <struct name="MyKey"> + <param name="e911Override" type="VehicleDataStatus" mandatory="true"> + <description>Indicates whether e911 override is on. References signal "MyKey_e911Override_St". See VehicleDataStatus.</description> + </param> + </struct> + + <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~ --> + <!-- / Ford Specific Data Items --> + <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~ --> + + <enum name="VehicleDataResultCode"> + <description>Enumeration that describes possible result codes of a vehicle data entry request.</description> + <element name="SUCCESS" internal_name="VDRC_SUCCESS"> + <description>Individual vehicle data item / DTC / DID request or subscription successful</description> + </element> + <element name="TRUNCATED_DATA" internal_name="VDRC_TRUNCATED_DATA"> + <description>DTC / DID request successful, however, not all active DTCs or full contents of DID location available</description> + </element> + <element name="DISALLOWED" internal_name="VDRC_DISALLOWED"> + <description>This vehicle data item is not allowed for this app by Ford.</description> + </element> + <element name="USER_DISALLOWED" internal_name="VDRC_USER_DISALLOWED"> + <description>The user has not granted access to this type of vehicle data item at this time.</description> + </element> + <element name="INVALID_ID" internal_name="VDRC_INVALID_ID"> + <description>The ECU ID referenced is not a valid ID on the bus / system.</description> + </element> + <element name="VEHICLE_DATA_NOT_AVAILABLE" internal_name="VDRC_DATA_NOT_AVAILABLE"> + <description>The requested vehicle data item / DTC / DID is not currently available or responding on the bus / system.</description> + </element> + <element name="DATA_ALREADY_SUBSCRIBED" internal_name="VDRC_DATA_ALREADY_SUBSCRIBED"> + <description>The vehicle data item is already subscribed.</description> + </element> + <element name="DATA_NOT_SUBSCRIBED" internal_name="VDRC_DATA_NOT_SUBSCRIBED"> + <description>The vehicle data item cannot be unsubscribed because it is not currently subscribed.</description> + </element> + <element name="IGNORED" internal_name="VDRC_IGNORED"> + <description>The request for this item is ignored because it is already in progress.</description> + </element> + </enum> + + <struct name="TireStatus"> + <description>The status and pressure of the tires.</description> + + <param name="pressureTelltale" type="WarningLightStatus" mandatory="true"> + <description>Status of the Tire Pressure Telltale. See WarningLightStatus.</description> + </param> + <param name="leftFront" type="SingleTireStatus" mandatory="true"> + <description>The status of the left front tire.</description> + </param> + <param name="rightFront" type="SingleTireStatus" mandatory="true"> + <description>The status of the right front tire.</description> + </param> + <param name="leftRear" type="SingleTireStatus" mandatory="true"> + <description>The status of the left rear tire.</description> + </param> + <param name="rightRear" type="SingleTireStatus" mandatory="true"> + <description>The status of the right rear tire.</description> + </param> + <param name="innerLeftRear" type="SingleTireStatus" mandatory="true"> + <description>The status of the inner left rear.</description> + </param> + <param name="innerRightRear" type="SingleTireStatus" mandatory="true"> + <description>The status of the inner right rear.</description> + </param> + </struct> + + <struct name="GPSData"> + <description>Struct with the GPS data.</description> + <param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180" mandatory="true"> + </param> + <param name="latitudeDegrees" type="Float" minvalue="-90" maxvalue="90" mandatory="true"> + </param> + <param name="utcYear" type="Integer" minvalue="2010" maxvalue="2100" mandatory="true"> + <description>The current UTC year.</description> + </param> + <param name="utcMonth" type="Integer" minvalue="1" maxvalue="12" mandatory="true"> + <description>The current UTC month.</description> + </param> + <param name="utcDay" type="Integer" minvalue="1" maxvalue="31" mandatory="true"> + <description>The current UTC day.</description> + </param> + <param name="utcHours" type="Integer" minvalue="0" maxvalue="23" mandatory="true"> + <description>The current UTC hour.</description> + </param> + <param name="utcMinutes" type="Integer" minvalue="0" maxvalue="59" mandatory="true"> + <description>The current UTC minute.</description> + </param> + <param name="utcSeconds" type="Integer" minvalue="0" maxvalue="59" mandatory="true"> + <description>The current UTC second.</description> + </param> + <param name="compassDirection" type="CompassDirection" mandatory="true"> + <description>See CompassDirection.</description> + </param> + <param name="pdop" type="Float" minvalue="0" maxvalue="10" defvalue="0" mandatory="true"> + <description>PDOP. If undefined or unavailable, then value shall be set to 0.</description> + </param> + <param name="hdop" type="Float" minvalue="0" maxvalue="10" defvalue="0" mandatory="true"> + <description>HDOP. If value is unknown, value shall be set to 0.</description> + </param> + <param name="vdop" type="Float" minvalue="0" maxvalue="10" defvalue="0" mandatory="true"> + <description>VDOP. If value is unknown, value shall be set to 0.</description> + </param> + <param name="actual" type="Boolean" mandatory="true"> + <description> + True, if actual. + False, if inferred. + </description> + </param> + <param name="satellites" type="Integer" minvalue="0" maxvalue="31" mandatory="true"> + <description>Number of satellites in view</description> + </param> + <param name="dimension" type="Dimension" mandatory="true"> + <description>See Dimension</description> + </param> + <param name="altitude" type="Float" minvalue="-10000" maxvalue="10000" mandatory="true"> + <description>Altitude in meters</description> + </param> + <param name="heading" type="Float" minvalue="0" maxvalue="359.99" mandatory="true"> + <description>The heading. North is 0. Resolution is 0.01</description> + </param> + <param name="speed" type="Float" minvalue="0" maxvalue="500" mandatory="true"> + <description>The speed in KPH</description> + </param> + </struct> + + <struct name="VehicleDataResult"> + <description>Individual published data request result</description> + <param name="dataType" type="VehicleDataType" mandatory="true"> + <description>Defined published data element type.</description> + </param> + <param name="resultCode" type="VehicleDataResultCode" mandatory="true"> + <description>Published data result code.</description> + </param> + </struct> + + <struct name="DIDResult"> + <description>Individual requested DID result and data</description> + <param name="resultCode" type="VehicleDataResultCode" mandatory="true"> + <description>Individual DID result code.</description> + </param> + <param name="didLocation" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"> + <description>Location of raw data from vehicle data DID</description> + </param> + <param name="data" type="String" maxlength="5000" mandatory="false"> + <description>Raw DID-based data returned for requested element.</description> + </param> + </struct> + + <struct name="StartTime"> + <param name="hours" type="Integer" minvalue="0" maxvalue="59" mandatory="true"> + <description> + The hour of the media clock. + Some radios only support a max of 19 hours. If out of range, it will be rejected. + </description> + </param> + <param name="minutes" type="Integer" minvalue="0" maxvalue="59" mandatory="true"/> + <param name="seconds" type="Integer" minvalue="0" maxvalue="59" mandatory="true"/> + </struct> + + <struct name="TextField"> + <param name="name" type="TextFieldName" mandatory="true"> + <description>The name that identifies the field. See TextFieldName.</description> + </param> + <param name="characterSet" type="CharacterSet" mandatory="true"> + <description>The character set that is supported in this field. See CharacterSet.</description> + </param> + <param name="width" type="Integer" minvalue="1" maxvalue="500" mandatory="true"> + <description>The number of characters in one row of this field.</description> + </param> + <param name="rows" type="Integer" minvalue="1" maxvalue="8" mandatory="true"> + <description>The number of rows of this field.</description> + </param> + </struct> + + <struct name="ImageResolution"> + <param name="resolutionWidth" type="Integer" minvalue="1" maxvalue="10000" mandatory="true"> + <description>The image resolution width.</description> + </param> + <param name="resolutionHeight" type="Integer" minvalue="1" maxvalue="10000" mandatory="true"> + <description>The image resolution height.</description> + </param> + </struct> + + <struct name="ImageField"> + <param name="name" type="ImageFieldName" mandatory="true"> + <description>The name that identifies the field. See ImageFieldName.</description> + </param> + <param name="imageTypeSupported" type="FileType" minsize="1" maxsize="100" array="true" mandatory="true"> + <description>The image types that are supported in this field. See FileType.</description> + </param> + <param name="imageResolution" type="ImageResolution" mandatory="false"> + <description>The image resolution of this field.</description> + </param> + </struct> + + <struct name="TouchCoord"> + <param name="x" type="Integer" mandatory="true" minvalue="0" maxvalue="10000"> + <description>The x coordinate of the touch.</description> + </param> + <param name="y" type="Integer" mandatory="true" minvalue="0" maxvalue="10000"> + <description>The y coordinate of the touch.</description> + </param> + </struct> + + <enum name="TouchType"> + <element name="BEGIN"/> + <element name="MOVE"/> + <element name="END"/> + <element name="CANCEL"/> + </enum> + + <struct name="TouchEvent"> + <param name="id" type="Integer" mandatory="true" minvalue="0" maxvalue="9"> + <description> + A touch's unique identifier. The application can track the current touch events by id. + If a touch event has type begin, the id should be added to the set of touches. + If a touch event has type end, the id should be removed from the set of touches. + </description> + </param> + <param name="ts" type="Integer" mandatory="true" array="true" minvalue="0" maxvalue="2000000000" minsize="1" maxsize="1000"> + <description> + The time that the touch was recorded. This number can the time since the beginning of the session or something else as long as the units are in milliseconds. + The timestamp is used to determined the rate of change of position of a touch. + The application also uses the time to verify whether two touches, with different ids, are part of a single action by the user. + If there is only a single timestamp in this array, it is the same for every coordinate in the coordinates array. + </description> + </param> + <param name="c" type="TouchCoord" mandatory="true" array="true" minsize="1" maxsize="1000"> + </param> + </struct> + + <struct name="TouchEventCapabilities"> + <param name="pressAvailable" type="Boolean" mandatory="true"> + </param> + <param name="multiTouchAvailable" type="Boolean" mandatory="true"> + </param> + <param name="doublePressAvailable" type="Boolean" mandatory="true"> + </param> + </struct> + + <struct name="ScreenParams"> + <param name="resolution" type="ImageResolution" mandatory="true"> + <description>The resolution of the prescribed screen area.</description> + </param> + <param name="touchEventAvailable" type="TouchEventCapabilities" mandatory="false"> + <description>Types of screen touch events available in screen area.</description> + </param> + </struct> + + <enum name="PermissionStatus"> + <description>Enumeration that describes possible permission states of a policy table entry.</description> + <element name="ALLOWED" internal_name="PS_ALLOWED"/> + <element name="DISALLOWED" internal_name="PS_DISALLOWED"/> + <element name="USER_DISALLOWED" internal_name="PS_USER_DISALLOWED"/> + <element name="USER_CONSENT_PENDING" internal_name="PS_USER_CONSENT_PENDING"/> + </enum> + + <struct name="HMIPermissions"> + <param name="allowed" type="HMILevel" minsize="0" maxsize="100" array="true" mandatory="true"> + <description>A set of all HMI levels that are permitted for this given RPC.</description> + </param> + <param name="userDisallowed" type="HMILevel" minsize="0" maxsize="100" array="true" mandatory="true"> + <description>A set of all HMI levels that are prohibited for this given RPC.</description> + </param> + </struct> + + <struct name="ParameterPermissions"> + <param name="allowed" type="String" minsize="0" maxsize="100" maxlength = "100" array="true" mandatory="true"> + <description>A set of all parameters that are permitted for this given RPC.</description> + </param> + <param name="userDisallowed" type="String" minsize="0" maxsize="100" maxlength = "100" array="true" mandatory="true"> + <description>A set of all parameters that are prohibited for this given RPC.</description> + </param> + </struct> + + <struct name="PermissionItem"> + <param name="rpcName" type="String" maxlength="100" mandatory="true"> + <description>Name of the individual RPC in the policy table.</description> + </param> + <param name="hmiPermissions" type="HMIPermissions" mandatory="true"/> + <param name="parameterPermissions" type="ParameterPermissions" mandatory="true"/> + </struct> + + <struct name="DisplayCapabilities"> + <description>Contains information about the display capabilities.</description> + <param name="displayType" type="DisplayType" mandatory="true"> + <description>The type of the display. See DisplayType</description> + </param> + <param name="textFields" type="TextField" minsize="1" maxsize="100" array="true" mandatory="true"> + <description>A set of all fields that support text data. See TextField</description> + </param> + <param name="imageFields" type="ImageField" minsize="1" maxsize="100" array="true" mandatory="false"> + <description>A set of all fields that support images. See ImageField</description> + </param> + <param name="mediaClockFormats" type="MediaClockFormat" minsize="0" maxsize="100" array="true" mandatory="true"> + <description>A set of all supported formats of the media clock. See MediaClockFormat</description> + </param> + <param name="graphicSupported" type="Boolean" mandatory="true"> + <description>The display's persistent screen supports referencing a static or dynamic image.</description> + </param> + <param name="templatesAvailable" type="String" minsize="0" maxsize="100" maxlength="100" array="true" mandatory="false"> + <description>A set of all predefined persistent display templates available on headunit. To be referenced in SetDisplayLayout.</description> + </param> + <param name="screenParams" type="ScreenParams" mandatory="false"> + <description>A set of all parameters related to a prescribed screen area (e.g. for video / touch input).</description> + </param> + <param name="numCustomPresetsAvailable" type="Integer" minvalue="1" maxvalue="100" mandatory="false"> + <description>The number of on-screen custom presets available (if any); otherwise omitted.</description> + </param> + + <!-- TODO: Add pixel density? --> + </struct> + <struct name="ButtonCapabilities"> + <description>Contains information about a button's capabilities.</description> + <param name="name" type="ButtonName" mandatory="true"> + <description>The name of the button. See ButtonName.</description> + </param> + <param name="shortPressAvailable" type="Boolean" mandatory="true"> + <description> + The button supports a short press. + Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked. + </description> + </param> + <param name="longPressAvailable" type="Boolean" mandatory="true"> + <description> + The button supports a LONG press. + Whenever the button is pressed long, onButtonPressed( LONG) will be invoked. + </description> + </param> + <param name="upDownAvailable" type="Boolean" mandatory="true"> + <description> + The button supports "button down" and "button up". + Whenever the button is pressed, onButtonEvent( DOWN) will be invoked. + Whenever the button is released, onButtonEvent( UP) will be invoked. + </description> + </param> + </struct> + <struct name="SoftButtonCapabilities"> + <description>Contains information about a SoftButton's capabilities.</description> + <param name="shortPressAvailable" type="Boolean" mandatory="true"> + <description> + The button supports a short press. + Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked. + </description> + </param> + <param name="longPressAvailable" type="Boolean" mandatory="true"> + <description> + The button supports a LONG press. + Whenever the button is pressed long, onButtonPressed( LONG) will be invoked. + </description> + </param> + <param name="upDownAvailable" type="Boolean" mandatory="true"> + <description> + The button supports "button down" and "button up". + Whenever the button is pressed, onButtonEvent( DOWN) will be invoked. + Whenever the button is released, onButtonEvent( UP) will be invoked. + </description> + </param> + <param name="imageSupported" type="Boolean" mandatory="true"> + <description>The button supports referencing a static or dynamic image.</description> + </param> + </struct> + <struct name="PresetBankCapabilities"> + <description>Contains information about on-screen preset capabilities.</description> + <param name="onScreenPresetsAvailable" type="Boolean" mandatory="true"> + <description>Onscreen custom presets are available.</description> + </param> + </struct> + <struct name="HMICapabilities"> + <param name="navigation" type="Boolean" mandatory="false"> + <description>Availability of build in Nav. True: Available, False: Not Available</description> + </param> + <param name="phoneCall" type="Boolean" mandatory="false"> + <description>Availability of build in phone. True: Available, False: Not Available </description> + </param> + <param name="videoStreaming" type="Boolean" mandatory="false"> + <description>Availability of video streaming. </description> + </param> + <param name="remoteControl" type="Boolean" mandatory="false"> + <description>Availability of remote control feature. True: Available, False: Not Available</description> + </param> + </struct> + <struct name="MenuParams"> + <param name="parentID" type="Integer" minvalue="0" maxvalue="2000000000" defvalue="0" mandatory="false"> + <description> + unique ID of the sub menu, the command will be added to. + If not provided, it will be provided to the top level of the in application menu. + </description> + </param> + <param name="position" type="Integer" minvalue="0" maxvalue="1000" mandatory="false"> + <description> + Position within the items that are are at top level of the in application menu. + 0 will insert at the front. + 1 will insert at the second position. + if position is greater or equal than the number of items on top level, the sub menu will be appended to the end. + If this param was omitted the entry will be added at the end. + </description> + </param> + <param name="menuName" type="String" maxlength="500" mandatory="true"> + <description>Text to show in the menu for this sub menu.</description> + </param> + </struct> + <struct name="TTSChunk"> + <description>A TTS chunk, that consists of the text/phonemes to speak and the type (like text or SAPI)</description> + <param name="text" minlength="0" maxlength="500" type="String" mandatory="true"> + <description> + The text or phonemes to speak. + May not be empty. + </description> + </param> + <param name="type" type="SpeechCapabilities" mandatory="true"> + <description>Describes, whether it is text or a specific phoneme set. See SpeechCapabilities</description> + </param> + </struct> + <struct name="Turn"> + <param name="navigationText" type="String" maxlength="500" mandatory="false"> + <description>Individual turn text. Must provide at least text or icon for a given turn.</description> + </param> + <param name="turnIcon" type="Image" mandatory="false"> + <description>Individual turn icon. Must provide at least text or icon for a given turn.</description> + </param> + </struct> + <struct name="VehicleType"> + <param name="make" type="String" maxlength="500" mandatory="false"> + <description>Make of the vehicle, e.g. Ford</description> + </param> + <param name="model" type="String" maxlength="500" mandatory="false"> + <description>Model of the vehicle, e.g. Fiesta</description> + </param> + <param name="modelYear" type="String" maxlength="500" mandatory="false"> + <description>Model Year of the vehicle, e.g. 2013</description> + </param> + <param name="trim" type="String" maxlength="500" mandatory="false"> + <description>Trim of the vehicle, e.g. SE</description> + </param> + </struct> + <enum name="KeyboardLayout"> + <description>Enumeration listing possible keyboard layouts.</description> + <element name="QWERTY" /> + <element name="QWERTZ" /> + <element name="AZERTY" /> + </enum> + <enum name="KeyboardEvent" > + <description>Enumeration listing possible keyboard events.</description> + <element name="KEYPRESS" /> + <element name="ENTRY_SUBMITTED" /> + <element name="ENTRY_VOICE" /> + <element name="ENTRY_CANCELLED" /> + <element name="ENTRY_ABORTED" /> + </enum> + <enum name="KeypressMode"> + <description>Enumeration listing possible keyboard events.</description> + <element name="SINGLE_KEYPRESS"> + <description>Each keypress is individually sent as the user presses the keyboard keys.</description> + </element> + <element name="QUEUE_KEYPRESSES"> + <description>The keypresses are queued and a string is eventually sent once the user chooses to submit their entry.</description> + </element> + <element name="RESEND_CURRENT_ENTRY"> + <description>The keypresses are queue and a string is sent each time the user presses a keyboard key; the string contains the entire current entry.</description> + </element> + </enum> + <struct name="KeyboardProperties"> + <description>Configuration of on-screen keyboard (if available).</description> + <param name="language" type="Language" mandatory="false"> + <description>The keyboard language.</description> + </param> + <param name="keyboardLayout" type="KeyboardLayout" mandatory="false" > + <description>Desired keyboard layout.</description> + </param> + <param name="keypressMode" type="KeypressMode" mandatory="false" > + <description> + Desired keypress mode. + If omitted, this value will be set to RESEND_CURRENT_ENTRY. + </description> + </param> + <param name="limitedCharacterList" type="String" maxlength="1" minsize="1" maxsize="100" array="true" mandatory="false"> + <description>Array of keyboard characters to enable.</description> + <description>All omitted characters will be greyed out (disabled) on the keyboard.</description> + <description>If omitted, the entire keyboard will be enabled.</description> + </param> + <param name="autoCompleteText" type="String" maxlength="1000" mandatory="false"> + <description>Allows an app to prepopulate the text field with a suggested or completed entry as the user types</description> + </param> + </struct> + <struct name="DeviceInfo"> + <description>Various information about connecting device.</description> + <param name="hardware" type="String" minlength="0" maxlength="500" mandatory="false"> + <description>Device model</description> + </param> + <param name="firmwareRev" type="String" minlength="0" maxlength="500" mandatory="false"> + <description>Device firmware revision</description> + </param> + <param name="os" type="String" minlength="0" maxlength="500" mandatory="false"> + <description>Device OS</description> + </param> + <param name="osVersion" type="String" minlength="0" maxlength="500" mandatory="false"> + <description>Device OS version</description> + </param> + <param name="carrier" type="String" minlength="0" maxlength="500" mandatory="false"> + <description>Device mobile carrier (if applicable)</description> + </param> + <param name="maxNumberRFCOMMPorts" type="Integer" minvalue="0" maxvalue="100" mandatory="false"> + <description>Omitted if connected not via BT.</description> + </param> + </struct> + <enum name="RequestType"> + <description>Enumeration listing possible asynchronous requests.</description> + <element name="HTTP" /> + <element name="FILE_RESUME" /> + <element name="AUTH_REQUEST" /> + <element name="AUTH_CHALLENGE" /> + <element name="AUTH_ACK" /> + <element name="PROPRIETARY" /> + <element name="QUERY_APPS" /> + <element name="LAUNCH_APP" /> + <element name="LOCK_SCREEN_ICON_URL" /> + <element name="TRAFFIC_MESSAGE_CHANNEL" /> + <element name="DRIVER_PROFILE" /> + <element name="VOICE_SEARCH" /> + <element name="NAVIGATION" /> + <element name="PHONE" /> + <element name="CLIMATE" /> + <element name="SETTINGS" /> + <element name="VEHICLE_DIAGNOSTICS" /> + <element name="EMERGENCY" /> + <element name="MEDIA" /> + <element name="FOTA" /> + </enum> + <enum name="AppHMIType"> + <description>Enumeration listing possible app types.</description> + <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" /> + <element name="PROJECTION" /> + <element name="REMOTE_CONTROL" /> + </enum> + <enum name="PredefinedLayout" platform="documentation"> + <description>Predefined screen layout.</description> + <element name="DEFAULT" rootscreen="true"> + <description> + Default media / non-media screen. + Can be set as a root screen. + </description> + </element> + <element name="MEDIA" rootscreen="true"> + <description> + Default Media screen. + Can be set as a root screen. + </description> + </element> + <element name="NON-MEDIA" internal_name="NON_MEDIA" rootscreen="true"> + <description> + Default Non-media screen. + Can be set as a root screen. + </description> + </element> + <element name="ONSCREEN_PRESETS" rootscreen="true"> + <description> + Custom root media screen containing app-defined onscreen presets. + Can be set as a root screen. + </description> + </element> + <element name="NAV_FULLSCREEN_MAP" rootscreen="true" > + <description> + Custom root template screen containing full screen map with navigation controls. + Can be set as a root screen. + </description> + </element> + <element name="NAV_LIST" rootscreen="true" > + <description> + Custom root template screen containing video represented list. + Can be set as a root screen. + </description> + </element> + <element name="NAV_KEYBOARD" rootscreen="true" > + <description> + Custom root template screen containing video represented keyboard. + Can be set as a root screen. + </description> + </element> + <element name="GRAPHIC_WITH_TEXT" rootscreen="true"> + <description> + Custom root template screen containing half-screen graphic with lines of text. + Can be set as a root screen. + </description> + </element> + <element name="TEXT_WITH_GRAPHIC" rootscreen="true"> + <description> + Custom root template screen containing lines of text with half-screen graphic. + Can be set as a root screen. + </description> + </element> + <element name="TILES_ONLY" rootscreen="true"> + <description> + Custom root template screen containing only tiled SoftButtons. + Can be set as a root screen. + </description> + </element> + <element name="TEXTBUTTONS_ONLY" rootscreen="true"> + <description> + Custom root template screen containing only text SoftButtons. + Can be set as a root screen. + </description> + </element> + <element name="GRAPHIC_WITH_TILES" rootscreen="true"> + <description> + Custom root template screen containing half-screen graphic with tiled SoftButtons. + Can be set as a root screen. + </description> + </element> + <element name="TILES_WITH_GRAPHIC" rootscreen="true"> + <description> + Custom root template screen containing tiled SoftButtons with half-screen graphic. + Can be set as a root screen. + </description> + </element> + <element name="GRAPHIC_WITH_TEXT_AND_SOFTBUTTONS" rootscreen="true"> + <description> + Custom root template screen containing half-screen graphic with text and SoftButtons. + Can be set as a root screen. + </description> + </element> + <element name="TEXT_AND_SOFTBUTTONS_WITH_GRAPHIC" rootscreen="true"> + <description> + Custom root template screen containing text and SoftButtons with half-screen graphic. + Can be set as a root screen. + </description> + </element> + <element name="GRAPHIC_WITH_TEXTBUTTONS" rootscreen="true"> + <description> + Custom root template screen containing half-screen graphic with text only SoftButtons. + Can be set as a root screen. + </description> + </element> + <element name="TEXTBUTTONS_WITH_GRAPHIC" rootscreen="true"> + <description> + Custom root template screen containing text only SoftButtons with half-screen graphic. + Can be set as a root screen. + </description> + </element> + <element name="LARGE_GRAPHIC_WITH_SOFTBUTTONS" rootscreen="true"> + <description> + Custom root template screen containing a large graphic and SoftButtons. + Can be set as a root screen. + </description> + </element> + <element name="DOUBLE_GRAPHIC_WITH_SOFTBUTTONS" rootscreen="true"> + <description> + Custom root template screen containing two graphics and SoftButtons. + Can be set as a root screen. + </description> + </element> + <element name="LARGE_GRAPHIC_ONLY" rootscreen="true"> + <description> + Custom root template screen containing only a large graphic. + Can be set as a root screen. + </description> + </element> + </enum> + <enum name="FunctionID" internal_scope="base"> + <description>Enumeration linking function names with function IDs in AppLink protocol. Assumes enumeration starts at value 0.</description> + <element name="RESERVED" value="0" /> + <!-- + Base Request / Response RPCs + Range = 0x 0000 0001 - 0x 0000 7FFF + --> + <element name="RegisterAppInterfaceID" value="1" hexvalue="1" /> + <element name="UnregisterAppInterfaceID" value="2" hexvalue="2" /> + <element name="SetGlobalPropertiesID" value="3" hexvalue="3" /> + <element name="ResetGlobalPropertiesID" value="4" hexvalue="4" /> + <element name="AddCommandID" value="5" hexvalue="5" /> + <element name="DeleteCommandID" value="6" hexvalue="6" /> + <element name="AddSubMenuID" value="7" hexvalue="7" /> + <element name="DeleteSubMenuID" value="8" hexvalue="8" /> + <element name="CreateInteractionChoiceSetID" value="9" hexvalue="9" /> + <element name="PerformInteractionID" value="10" hexvalue="A" /> + <element name="DeleteInteractionChoiceSetID" value="11" hexvalue="B" /> + <element name="AlertID" value="12" hexvalue="C" /> + <element name="ShowID" value="13" hexvalue="D" /> + <element name="SpeakID" value="14" hexvalue="E" /> + <element name="SetMediaClockTimerID" value="15" hexvalue="F" /> + <element name="PerformAudioPassThruID" value="16" hexvalue="10" /> + <element name="EndAudioPassThruID" value="17" hexvalue="11" /> + <element name="SubscribeButtonID" value="18" hexvalue="12" /> + <element name="UnsubscribeButtonID" value="19" hexvalue="13" /> + <element name="SubscribeVehicleDataID" value="20" hexvalue="14" /> + <element name="UnsubscribeVehicleDataID" value="21" hexvalue="15" /> + <element name="GetVehicleDataID" value="22" hexvalue="16" /> + <element name="ReadDIDID" value="23" hexvalue="17" /> + <element name="GetDTCsID" value="24" hexvalue="18" /> + <element name="ScrollableMessageID" value="25" hexvalue="19" /> + <element name="SliderID" value="26" hexvalue="1A" /> + <element name="ShowConstantTBTID" value="27" hexvalue="1B" /> + <element name="AlertManeuverID" value="28" hexvalue="1C" /> + <element name="UpdateTurnListID" value="29" hexvalue="1D" /> + <element name="ChangeRegistrationID" value="30" hexvalue="1E" /> + <element name="GenericResponseID" value="31" hexvalue="1F" /> + <element name="PutFileID" value="32" hexvalue="20" /> + <element name="DeleteFileID" value="33" hexvalue="21" /> + <element name="ListFilesID" value="34" hexvalue="22" /> + <element name="SetAppIconID" value="35" hexvalue="23" /> + <element name="SetDisplayLayoutID" value="36" hexvalue="24" /> + <element name="DiagnosticMessageID" value="37" hexvalue="25" /> + <element name="SystemRequestID" value="38" hexvalue="26" /> + <element name="SendLocationID" value="39" hexvalue="27" /> + <element name="DialNumberID" value="40" hexvalue="28" /> + <element name="ButtonPressID" value="41" hexvalue="29" /> + <element name="GetInteriorVehicleDataID" value="43" hexvalue="2B" /> + <element name="SetInteriorVehicleDataID" value="44" hexvalue="2C" /> + <element name="GetWayPointsID" value="45" hexvalue="2D" /> + <element name="SubscribeWayPointsID" value="46" hexvalue="2E" /> + <element name="UnsubscribeWayPointsID" value="47" hexvalue="2F" /> + <element name="GetSystemCapabilityID" value="48" hexvalue="30" /> + <element name="SendHapticDataID" value="49" hexvalue="31" /> + + <!-- + Base Notifications + Range = 0x 0000 8000 - 0x 0000 FFFF + --> + + <element name="OnHMIStatusID" value="32768" hexvalue="8000" /> + <element name="OnAppInterfaceUnregisteredID" value="32769" hexvalue="8001" /> + <element name="OnButtonEventID" value="32770" hexvalue="8002" /> + <element name="OnButtonPressID" value="32771" hexvalue="8003" /> + <element name="OnVehicleDataID" value="32772" hexvalue="8004" /> + <element name="OnCommandID" value="32773" hexvalue="8005" /> + <element name="OnTBTClientStateID" value="32774" hexvalue="8006" /> + <element name="OnDriverDistractionID" value="32775" hexvalue="8007" /> + <element name="OnPermissionsChangeID" value="32776" hexvalue="8008" /> + <element name="OnAudioPassThruID" value="32777" hexvalue="8009" /> + <element name="OnLanguageChangeID" value="32778" hexvalue="800A" /> + <element name="OnKeyboardInputID" value="32779" hexvalue="800B" /> + <element name="OnTouchEventID" value="32780" hexvalue="800C" /> + <element name="OnSystemRequestID" value="32781" hexvalue="800D" /> + <element name="OnHashChangeID" value="32782" hexvalue="800E" /> + <element name="OnInteriorVehicleDataID" value="32783" hexvalue="800F" /> + <element name="OnWayPointChangeID" value="32784" hexvalue="8010" /> + + <!-- + Ford Specific Request / Response RPCs + Range = 0x 0001 0000 - 0x 0001 7FFF + --> + + <element name="EncodedSyncPDataID" value="65536" hexvalue="10000" /> + <element name="SyncPDataID" value="65537" hexvalue="10001" /> + + <!-- + Ford Specific Notifications + Range = 0x 0001 8000 - 0x 0001 FFFF + --> + + <element name="OnEncodedSyncPDataID" value="98304" hexvalue="18000" /> + <element name="OnSyncPDataID" value="98305" hexvalue="18001" /> + </enum> + + <enum name="messageType"> + <description> + Enumeration linking message types with function types in WiPro protocol. + Assumes enumeration starts at value 0. + </description> + <element name="request" value="0" /> + <element name="response" value="1" /> + <element name="notification" value="2" /> + </enum> + + <struct name="DateTime"> + <param name="millisecond" type="Integer" minvalue="0" maxvalue="999" mandatory="false"> + <description>Milliseconds </description> + </param> + <param name="second" type="Integer" minvalue="0" maxvalue="60" mandatory="false"> + <description>Seconds part of time</description> + </param> + <param name="minute" type="Integer" minvalue="0" maxvalue="59" mandatory="false"> + <description>Minutes part of time</description> + </param> + <param name="hour" type="Integer" minvalue="0" maxvalue="23" mandatory="false"> + <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="false"> + <description>Day of the month</description> + </param> + <param name="month" type="Integer" minvalue="1" maxvalue="12" mandatory="false"> + <description>Month of the year</description> + </param> + <param name="year" type="Integer" maxvalue="4095" mandatory="false"> + <description>The year in YYYY format</description> + </param> + <param name="tz_hour" type="Integer" minvalue="-12" maxvalue="14" defvalue="0" mandatory="false"> + <description>Time zone offset in Hours wrt UTC.</description> + </param> + <param name="tz_minute" type="Integer" minvalue="0" maxvalue="59" defvalue="0" mandatory="false"> + <description>Time zone offset in Min wrt UTC.</description> + </param> + </struct> + + <enum name="WayPointType"> + <description>Describes what kind of waypoint is requested/provided.</description> + <element name="ALL" /> + <element name="DESTINATION" /> + </enum> + + <struct name="Coordinate"> + <param name="latitudeDegrees" minvalue="-90" maxvalue="90" type="Float" mandatory="true"> + <description>Latitude of the location.</description> + </param> + <param name="longitudeDegrees" minvalue="-180" maxvalue="180" type="Float" mandatory="true"> + <description>Longitude of the location.</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> + + <struct name="LocationDetails"> + <param name="coordinate" type="Coordinate" mandatory="false"> + <description>Latitude/Longitude of the location.</description> + </param> + <param name="locationName" type="String" maxlength="500" mandatory="false"> + <description>Name of location.</description> + </param> + <param name="addressLines" type="String" maxlength="500" minsize="0" maxsize="4" array="true" mandatory="false"> + <description>Location address for display purposes only</description> + </param> + <param name="locationDescription" type="String" maxlength="500" mandatory="false"> + <description>Description intended location / establishment (if applicable)</description> + </param> + <param name="phoneNumber" type="String" maxlength="500" mandatory="false"> + <description>Phone number of location / establishment.</description> + </param> + <param name="locationImage" type="Image" mandatory="false"> + <description>Image / icon of intended location.</description> + </param> + <param name="searchAddress" type="OASISAddress" mandatory="false"> + <description>Address to be used by navigation engines for search</description> + </param> + </struct> + + <enum name="SystemCapabilityType"> + <description>Enumerations of all available system capability types</description> + <element name="NAVIGATION"/> + <element name="PHONE_CALL"/> + <element name="VIDEO_STREAMING"/> + <element name="REMOTE_CONTROL"/> + </enum> + + <struct name="NavigationCapability"> + <description>Extended capabilities for an onboard navigation system</description> + <param name="sendLocationEnabled" type="Boolean" mandatory="false"> + <description>If the module has the ability to add locations to the onboard nav</description> + </param> + <param name="getWayPointsEnabled" type="Boolean" mandatory="false"> + <description>If the module has the ability to return way points from onboard nav</description> + </param> + </struct> + + <struct name="PhoneCapability"> + <description>Extended capabilities of the module's phone feature</description> + <param name="dialNumberEnabled" type="Boolean" mandatory="false"> + <description>If the module has the ability to perform dial number</description> + </param> + </struct> + + <struct name="VideoStreamingFormat"> + <description>Video streaming formats and their specifications.</description> + <param name="protocol" type="VideoStreamingProtocol" mandatory="true"> + <description>Protocol type, see VideoStreamingProtocol</description> + </param> + <param name="codec" type="VideoStreamingCodec" mandatory="true"> + <description>Codec type, see VideoStreamingCodec</description> + </param> + </struct> + + <struct name="VideoStreamingCapability"> + <description>Contains information about this system's video streaming capabilities.</description> + <param name="preferredResolution" type="ImageResolution" mandatory="false"> + <description>The preferred resolution of a video stream for decoding and rendering on HMI.</description> + </param> + <param name="maxBitrate" type="Integer" minvalue="0" maxvalue="2147483647" mandatory="false"> + <description>The maximum bitrate of video stream that is supported, in kbps.</description> + </param> + <param name="supportedFormats" type="VideoStreamingFormat" array="true" mandatory="false"> + <description>Detailed information on each format supported by this system, in its preferred order (i.e. the first element in the array is most preferable to the system). Each object will contain a VideoStreamingFormat that describes what can be expected.</description> + </param> + <param name="hapticSpatialDataSupported" type="Boolean" mandatory="false"> + <description>True if the system can utilize the haptic spatial data from the source being streamed. If not included, it can be assumed the module doesn't support haptic spatial data'. </description> + </param> + </struct> + + <!---Remote control --> + + <struct name="Temperature"> + <param name="unit" type="TemperatureUnit" mandatory="true"> + <description>Temperature Unit</description> + </param> + <param name="value" type="Float" mandatory="true"> + <description>Temperature Value in TemperatureUnit specified unit. Range depends on OEM and is not checked by SDL.</description> + </param> + </struct> + + <struct name="RdsData"> + <param name="PS" type="String" minlength="0" maxlength="8" mandatory="false"> + <description>Program Service Name</description> + </param> + <param name="RT" type="String" minlength="0" maxlength="64" mandatory="false"> + <description>Radio Text</description> + </param> + <param name="CT" type="String" minlength="24" maxlength="24" mandatory="false"> + <description>The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD</description> + </param> + <param name="PI" type="String" minlength="0" maxlength="6" mandatory="false"> + <description>Program Identification - the call sign for the radio station</description> + </param> + <param name="PTY" type="Integer" minvalue="0" maxvalue="31" mandatory="false"> + <description>The program type - The region should be used to differentiate between EU and North America program types</description> + </param> + <param name="TP" type="Boolean" mandatory="false"> + <description>Traffic Program Identification - Identifies a station that offers traffic</description> + </param> + <param name="TA" type="Boolean" mandatory="false"> + <description>Traffic Announcement Identification - Indicates an ongoing traffic announcement</description> + </param> + <param name="REG" type="String" mandatory="false"> + <description>Region</description> + </param> + </struct> + + <struct name="RadioControlData"> + <param name="frequencyInteger" type="Integer" minvalue="0" maxvalue="1710" mandatory="false"> + <description>The integer part of the frequency ie for 101.7 this value should be 101</description> + </param> + <param name="frequencyFraction" type="Integer" minvalue="0" maxvalue="9" mandatory="false"> + <description>The fractional part of the frequency for 101.7 is 7</description> + </param> + <param name="band" type="RadioBand" mandatory="false"> + </param> + <param name="rdsData" type="RdsData" mandatory="false"> + </param> + <param name="availableHDs" type="Integer" minvalue="1" maxvalue="3" mandatory="false"> + <description>number of HD sub-channels if available</description> + </param> + <param name="hdChannel" type="Integer" minvalue="1" maxvalue="3" mandatory="false"> + <description>Current HD sub-channel if available</description> + </param> + <param name="signalStrength" type="Integer" minvalue="0" maxvalue="100" mandatory="false"> + </param> + <param name="signalChangeThreshold" type="Integer" minvalue="0" maxvalue="100" mandatory="false"> + <description>If the signal strength falls below the set value for this parameter, the radio will tune to an alternative frequency</description> + </param> + <param name="radioEnable" type="Boolean" mandatory="false"> + <description> True if the radio is on, false is the radio is off</description> + </param> + <param name="state" type="RadioState" mandatory="false"> + </param> + </struct> + + <struct name="ClimateControlData"> + <param name="fanSpeed" type="Integer" minvalue="0" maxvalue="100" mandatory="false"> + </param> + <param name="currentTemperature" type="Temperature" mandatory="false"> + </param> + <param name="desiredTemperature" type="Temperature" mandatory="false"> + </param> + <param name="acEnable" type="Boolean" mandatory="false"> + </param> + <param name="circulateAirEnable" type="Boolean" mandatory="false"> + </param> + <param name="autoModeEnable" type="Boolean" mandatory="false"> + </param> + <param name="defrostZone" type="DefrostZone" mandatory="false"> + </param> + <param name="dualModeEnable" type="Boolean" mandatory="false"> + </param> + <param name="acMaxEnable" type="Boolean" mandatory="false"> + </param> + <param name="ventilationMode" type="VentilationMode" mandatory="false"> + </param> + </struct> + + <struct name="ModuleData"> + <description>The moduleType indicates which type of data should be changed and identifies which data object exists in this struct. For example, if the moduleType is CLIMATE then a "climateControlData" should exist</description> + <param name="moduleType" type="ModuleType" mandatory="true"> + </param> + <param name="radioControlData" type="RadioControlData" mandatory="false"> + </param> + <param name="climateControlData" type="ClimateControlData" mandatory="false"> + </param> + </struct> + + <struct name="RadioControlCapabilities"> + <description>Contains information about a radio control module's capabilities.</description> + <!-- need an ID in the future --> + <param name="moduleName" type="String" maxlength="100" mandatory="true"> + <description> + The short friendly name of the climate control module. + It should not be used to identify a module by mobile application. + </description> + </param> + <param name="radioEnableAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of enable/disable radio. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="radioBandAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of radio band. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="radioFrequencyAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of radio frequency. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="hdChannelAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of HD radio channel. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="rdsDataAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the getting Radio Data System (RDS) data. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="availableHDsAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the getting the number of available HD channels. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="stateAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the getting the Radio state. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="signalStrengthAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the getting the signal strength. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="signalChangeThresholdAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the getting the signal Change Threshold. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + </struct> + + <struct name="ClimateControlCapabilities"> + <description>Contains information about a climate control module's capabilities.</description> + <!-- need an ID in the future --> + <param name="moduleName" type="String" maxlength="100" mandatory="true"> + <description>The short friendly name of the climate control module. + It should not be used to identify a module by mobile application.</description> + </param> + <param name="fanSpeedAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of fan speed. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="desiredTemperatureAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of desired temperature. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="acEnableAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of turn on/off AC. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="acMaxEnableAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of enable/disable air conditioning is ON on the maximum level. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="circulateAirEnableAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of enable/disable circulate Air mode. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="autoModeEnableAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of enable/disable auto mode. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="dualModeEnableAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of enable/disable dual mode. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="defrostZoneAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of defrost zones. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="defrostZone" type="DefrostZone" minsize="1" maxsize="100" array="true" mandatory="false"> + <description> + A set of all defrost zones that are controllable. + </description> + </param> + <param name="ventilationModeAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of air ventilation mode. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="ventilationMode" type="VentilationMode" minsize="1" maxsize="100" array="true" mandatory="false"> + <description> + A set of all ventilation modes that are controllable. + </description> + </param> + </struct> + + <struct name="RemoteControlCapabilities"> + <param name="climateControlCapabilities" type="ClimateControlCapabilities" mandatory="false" minsize="1" maxsize="100" array="true"> + <description>If included, the platform supports RC climate controls. For this baseline version, maxsize=1. i.e. only one climate control module is supported.</description > + </param> + <param name="radioControlCapabilities" type="RadioControlCapabilities" mandatory="false" minsize="1" maxsize="100" array="true"> + <description>If included, the platform supports RC radio controls.For this baseline version, maxsize=1. i.e. only one radio control module is supported.</description > + </param> + <param name="buttonCapabilities" type="ButtonCapabilities" mandatory="false" minsize="1" maxsize="100" array="true" > + <description>If included, the platform supports RC button controls with the included button names.</description > + </param> + </struct> + + <!-- End of RC --> + <struct name="SystemCapability"> + <description>The systemCapabilityType indicates which type of data should be changed and identifies which data object exists in this struct. For example, if the SystemCapability Type is NAVIGATION then a "navigationCapability" should exist</description> + <param name="systemCapabilityType" type="SystemCapabilityType" mandatory="true"> + <description>Used as a descriptor of what data to expect in this struct. The corresponding param to this enum should be included and the only other para included.</description> + </param> + <param name="navigationCapability" type="NavigationCapability" mandatory="false"> + <description>Describes extended capabilities for onboard navigation system </description> + </param> + <param name="phoneCapability" type="PhoneCapability" mandatory="false"> + <description>Describes extended capabilities of the module's phone feature</description> + </param> + <param name="videoStreamingCapability" type="VideoStreamingCapability" mandatory="false"> + <description>Describes extended capabilities of the module's phone feature</description> + </param> + <param name="remoteControlCapability" type="RemoteControlCapabilities" mandatory="false"> + <description>Describes extended capabilities of the module's phone feature</description> + </param> + </struct> + + <enum name="MetadataType"> + <element name="mediaTitle"> + <description>The data in this field contains the title of the currently playing audio track.</description> + </element> + <element name="mediaArtist"> + <description>The data in this field contains the artist or creator of the currently playing audio track.</description> + </element> + <element name="mediaAlbum"> + <description>The data in this field contains the album title of the currently playing audio track.</description> + </element> + <element name="mediaYear"> + <description>The data in this field contains the creation year of the currently playing audio track.</description> + </element> + <element name="mediaGenre"> + <description>The data in this field contains the genre of the currently playing audio track.</description> + </element> + <element name="mediaStation"> + <description>The data in this field contains the name of the current source for the media.</description> + </element> + <element name="rating"> + <description>The data in this field is a rating.</description> + </element> + <element name="currentTemperature"> + <description>The data in this field is the current temperature.</description> + </element> + <element name="maximumTemperature"> + <description>The data in this field is the maximum temperature for the day.</description> + </element> + <element name="minimumTemperature"> + <description>The data in this field is the minimum temperature for the day.</description> + </element> + <element name="weatherTerm"> + <description>The data in this field describes the current weather (ex. cloudy, clear, etc.).</description> + </element> + <element name="humidity"> + <description>The data in this field describes the current humidity value.</description> + </element> + </enum> + + <struct name="MetadataTags"> + <param name="mainField1" type="MetadataType" minsize="0" maxsize="5" array="true" mandatory="false"> + <description>The type of data contained in the "mainField1" text field.</description> + </param> + <param name="mainField2" type="MetadataType" minsize="0" maxsize="5" array="true" mandatory="false"> + <description>The type of data contained in the "mainField2" text field.</description> + </param> + <param name="mainField3" type="MetadataType" minsize="0" maxsize="5" array="true" mandatory="false"> + <description>The type of data contained in the "mainField3" text field.</description> + </param> + <param name="mainField4" type="MetadataType" minsize="0" maxsize="5" array="true" mandatory="false"> + <description>The type of data contained in the "mainField4" text field.</description> + </param> + </struct> + + <struct name="Rectangle"> + <param name="x" type="Float" mandatory="true"> + <description>The upper left X-coordinate of the rectangle</description> + </param> + <param name="y" type="Float" mandatory="true"> + <description>The upper left Y-coordinate of the rectangle</description> + </param> + <param name="width" type="Float" mandatory="true"> + <description>The width of the rectangle</description> + </param> + <param name="height" type="Float" mandatory="true"> + <description>The height of the rectangle</description> + </param> + </struct> + + <struct name="HapticRect"> + <description>Defines haptic data for each user control object for video streaming application</description> + <param name="id" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> + <description>A user control spatial identifier</description> + </param> + <param name="rect" type="Rectangle" mandatory="true"> + <description>The position of the haptic rectangle to be highlighted. The center of this rectangle will be "touched" when a press occurs.</description> + </param> + </struct> + + <!-- Requests/Responses --> + + <function name="RegisterAppInterface" functionID="RegisterAppInterfaceID" messagetype="request"> + <description> + Establishes an interface with a mobile application. + Before registerAppInterface no other commands will be accepted/executed. + </description> + + <param name="syncMsgVersion" type="SyncMsgVersion" mandatory="true"> + <description>See SyncMsgVersion</description> + </param> + + <param name="appName" type="String" maxlength="100" mandatory="true"> + <description> + The mobile application name, e.g. "Ford Drive Green". + Needs to be unique over all applications. + May not be empty. + May not start with a new line character. + May not interfere with any name or synonym of previously registered applications and any predefined blacklist of words (global commands) + Needs to be unique over all applications. Applications with the same name will be rejected. + Only characters from char set [@TODO: Create char set (character/hex value) for each ACM and refer to] are supported. + </description> + </param> + + <param name="ttsName" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" > + <description> + TTS string for VR recognition of the mobile application name, e.g. "Ford Drive Green". + Meant to overcome any failing on speech engine in properly pronouncing / understanding app name. + Needs to be unique over all applications. + May not be empty. + May not start with a new line character. + Only characters from char set [@TODO: Create char set (character/hex value) for each ACM and refer to] are supported. + </description> + </param> + + <param name="ngnMediaScreenAppName" type="String" maxlength="100" mandatory="false"> + <description> + Provides an abbreviated version of the app name (if needed), that will be displayed on the NGN media screen. + If not provided, the appName is used instead (and will be truncated if too long) + Only characters from char set [@TODO: Create char set (character/hex value) for each ACM and refer to] are supported. + </description> + </param> + + <param name="vrSynonyms" type="String" maxlength="40" minsize="1" maxsize="100" array="true" mandatory="false"> + <description> + Defines an additional voice recognition command. + May not interfere with any app name of previously registered applications and any predefined blacklist of words (global commands) + Only characters from char set [@TODO: Create char set (character/hex value) for each ACM and refer to] are supported. + </description> + </param> + + <param name="isMediaApplication" type="Boolean" mandatory="true"> + <description> + Indicates if the application is a media or a non-media application. + Only media applications will be able to stream audio to the module that is audible outside of the BT media source. + </description> + </param> + <param name="languageDesired" type="Language" mandatory="true"> + <description> + See Language + Current app's expected VR+TTS language + If there is a mismatch with the module, the app will be able to change this registration with changeRegistration prior to app being brought into focus. + </description> + </param> + <param name="hmiDisplayLanguageDesired" type="Language" mandatory="true"> + <description> + See Language + Current app's expected display language + If there is a mismatch with the module, the app will be able to change this registration with changeRegistration prior to app being brought into focus. + </description> + </param> + + <param name="appHMIType" type="AppHMIType" minsize="1" maxsize="100" array="true" mandatory="false"> + <description> + See AppHMIType + List of all applicable app HMI types stating which HMI classifications to be given to the app. + </description> + </param> + + <param name="hashID" type="String" maxlength="100" mandatory="false"> + <description> + ID used to uniquely identify current state of all app data that can persist through connection cycles (e.g. ignition cycles). + This registered data (commands, submenus, choice sets, etc.) can be reestablished without needing to explicitly reregister each piece. + If omitted, then the previous state of an app's commands, etc. will not be restored. + When sending hashID, all RegisterAppInterface parameters should still be provided (e.g. ttsName, etc.). + </description> + </param> + <param name="deviceInfo" type="DeviceInfo" mandatory="false"> + <description> + See DeviceInfo. + </description> + </param> + <param name="appID" type="String" maxlength="100" mandatory="true"> + <description>ID used to validate app with policy table entries</description> + </param> + <param name="appInfo" type="AppInfo" mandatory="false"> + <description> + See AppInfo. + </description> + </param> + </function> + + <function name="RegisterAppInterface" functionID="RegisterAppInterfaceID" messagetype="response"> + <description>The response to registerAppInterface</description> + + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="GENERIC_ERROR"/> + <element name="DUPLICATE_NAME"/> + <element name="TOO_MANY_APPLICATIONS"/> + <element name="APPLICATION_REGISTERED_ALREADY"/> + <element name="UNSUPPORTED_VERSION"/> + <element name="WRONG_LANGUAGE"/> + <element name="DISALLOWED"/> + <element name="WARNINGS"/> + <element name="RESUME_FAILED"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + <param name="syncMsgVersion" type="SyncMsgVersion" mandatory="false"> + <description>See SyncMsgVersion</description> + </param> + + <param name="language" type="Language" mandatory="false"> + <description>The currently active VR+TTS language on the module. See "Language" for options.</description> + </param> + + <param name="hmiDisplayLanguage" type="Language" mandatory="false"> + <description>The currently active display language on the module. See "Language" for options.</description> + </param> + + <param name="displayCapabilities" type="DisplayCapabilities" mandatory="false"> + <description>See DisplayCapabilities</description> + </param> + + <param name="buttonCapabilities" type="ButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false"> + <description>See ButtonCapabilities</description > + </param> + + <param name="softButtonCapabilities" type="SoftButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false"> + <description>If returned, the platform supports on-screen SoftButtons; see SoftButtonCapabilities.</description > + </param> + + <param name="presetBankCapabilities" type="PresetBankCapabilities" mandatory="false"> + <description>If returned, the platform supports custom on-screen Presets; see PresetBankCapabilities.</description > + </param> + <param name="hmiZoneCapabilities" type="HmiZoneCapabilities" minsize="1" maxsize="100" array="true" mandatory="false"> + <description>See HmiZoneCapabilities</description> + </param> + <param name="speechCapabilities" type="SpeechCapabilities" minsize="1" maxsize="100" array="true" mandatory="false"> + <description>See SpeechCapabilities</description> + </param> + + <param name="prerecordedSpeech" type="PrerecordedSpeech" minsize="1" maxsize="100" array="true" mandatory="false"> + <description>See PrerecordedSpeech</description> + </param> + + <param name="vrCapabilities" type="VrCapabilities" minsize="1" maxsize="100" array="true" mandatory="false"> + <description>See VrCapabilities</description> + </param> + + <param name="audioPassThruCapabilities" type="AudioPassThruCapabilities" minsize="1" maxsize="100" array="true" mandatory="false"> + <description>See AudioPassThruCapability</description> + </param> + + <param name="pcmStreamCapabilities" type="AudioPassThruCapabilities" array="false" mandatory="false"> + <description>See AudioPassThruCapability</description> + </param> + + <param name="vehicleType" type="VehicleType" mandatory="false"> + <description>Specifies the vehicle's type. See VehicleType.</description> + </param> + + <param name="supportedDiagModes" type="Integer" minvalue="0" maxvalue="255" array="true" minsize="1" maxsize="100" mandatory="false" > + <description> + Specifies the white-list of supported diagnostic modes (0x00-0xFF) capable for DiagnosticMessage requests. + If a mode outside this list is requested, it will be rejected. + </description> + </param> + + <param name="hmiCapabilities" type="HMICapabilities" mandatory="false"> + <description>Specifies the HMI’s capabilities. See HMICapabilities.</description> + </param> + + <param name="sdlVersion" type="String" maxlength="100" mandatory="false" platform="documentation"> + <description>The SmartDeviceLink version.</description> + </param> + + <param name="systemSoftwareVersion" type="String" maxlength="100" mandatory="false" platform="documentation"> + <description>The software version of the system that implements the SmartDeviceLink core.</description> + </param> + </function> + + <function name="UnregisterAppInterface" functionID="UnregisterAppInterfaceID" messagetype="request"> + <description> + Closes an interface from a mobile application. + After unregisterAppInterface, no commands other than registerAppInterface will be accepted/executed. + Will fail, if no registerAppInterface was completed successfully before. + </description> + </function> + + <function name="UnregisterAppInterface" functionID="UnregisterAppInterfaceID" messagetype="response"> + + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + </function> + + <function name="SetGlobalProperties" functionID="SetGlobalPropertiesID" messagetype="request"> + <description>Allows setting global properties.</description> + + <param name="helpPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" > + <description> + The help prompt. + An array of text chunks of type TTSChunk. See TTSChunk. + The array must have at least one item. + </description> + </param> + + <param name="timeoutPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" > + <description> + Help text for a wait timeout. + An array of text chunks of type TTSChunk. See TTSChunk. + The array must have at least one item. + </description> + </param> + + <param name="vrHelpTitle" type="String" maxlength="500" mandatory="false"> + <description> + VR Help Title text. + If omitted on supported displays, the default module help title shall be used. + If omitted and one or more vrHelp items are provided, the request will be rejected. + </description> + </param> + + <param name="vrHelp" type="VrHelpItem" minsize="1" maxsize="100" array="true" mandatory="false"> + <description> + VR Help Items. + If omitted on supported displays, the default AppLink VR help / What Can I Say? screen shall be used. + If the list of VR Help Items contains nonsequential positions (e.g. [1,2,4]), the RPC shall be rejected. + If omitted and a vrHelpTitle is provided, the request will be rejected. + </description> + </param> + <param name="menuTitle" maxlength="500" type="String" mandatory="false"> + <description>Optional text to label an app menu button (for certain touchscreen platforms).</description> + </param> + + <param name="menuIcon" type="Image" mandatory="false"> + <description>>Optional icon to draw on an app menu button (for certain touchscreen platforms).</description> + </param> + + <param name="keyboardProperties" type="KeyboardProperties" mandatory="false"> + <description>On-screen keyboard configuration (if available).</description> + </param> + </function> + + <function name="SetGlobalProperties" functionID="SetGlobalPropertiesID" messagetype="response"> + + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="UNSUPPORTED_RESOURCE"/> + <element name="WARNINGS"/> + <element name="DISALLOWED"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + </function> + + <function name="ResetGlobalProperties" functionID="ResetGlobalPropertiesID" messagetype="request"> + <description>Allows resetting global properties.</description> + + <param name="properties" type="GlobalProperty" minsize="1" maxsize="100" array="true" mandatory="true"> + <description>Contains the names of all global properties (like timeoutPrompt) that should be unset. Resetting means, that they have the same value as at start up (default)</description> + </param> + </function> + + <function name="ResetGlobalProperties" functionID="ResetGlobalPropertiesID" messagetype="response"> + + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="DISALLOWED"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="AddCommand" functionID="AddCommandID" messagetype="request"> + <description> + Adds a command to the in application menu. + Either menuParams or vrCommands must be provided. + </description> + + <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> + <description>unique ID of the command to add.</description> + </param> + + <param name="menuParams" type="MenuParams" mandatory="false"> + <description>Optional sub value containing menu parameters</description> + </param> + + <param name="vrCommands" type="String" minsize="1" maxsize="100" maxlength="99" array="true" mandatory="false"> + <description> + An array of strings to be used as VR synonyms for this command. + If this array is provided, it may not be empty. + </description> + </param> + + <param name="cmdIcon" type="Image" mandatory="false"> + <description> + Image struct determining whether static or dynamic icon. + If omitted on supported displays, no (or the default if applicable) icon shall be displayed. + </description> + </param> + + </function> + + <function name="AddCommand" functionID="AddCommandID" messagetype="response"> + + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="INVALID_ID"/> + <element name="DUPLICATE_NAME"/> + <element name="UNSUPPORTED_RESOURCE"/> + <element name="DISALLOWED"/> + <element name="WARNINGS"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + </function> + + <function name="DeleteCommand" functionID="DeleteCommandID" messagetype="request"> + <description>Deletes all commands from the in-application menu with the specified command id.</description> + + <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> + <description>ID of the command(s) to delete.</description> + </param> + + </function> + + <function name="DeleteCommand" functionID="DeleteCommandID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="INVALID_ID"/> + <element name="IN_USE"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + </function> + + <function name="AddSubMenu" functionID="AddSubMenuID" messagetype="request"> + <description>Adds a sub menu to the in-application menu.</description> + + <param name="menuID" type="Integer" minvalue="1" maxvalue="2000000000" mandatory="true"> + <description>unique ID of the sub menu to add.</description> + </param> + + <param name="position" type="Integer" minvalue="0" maxvalue="1000" defvalue="1000" mandatory="false"> + <description> + Position within the items that are are at top level of the in application menu. + 0 will insert at the front. + 1 will insert at the second position. + If position is greater or equal than the number of items on top level, the sub menu will be appended to the end. + Position of any submenu will always be located before the return and exit options + If this param was omitted the entry will be added at the end. + </description> + </param> + + <param name="menuName" maxlength="500" type="String" mandatory="true"> + <description>Text to show in the menu for this sub menu.</description> + </param> + </function> + + <function name="AddSubMenu" functionID="AddSubMenuID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="INVALID_ID"/> + <element name="DUPLICATE_NAME"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="DeleteSubMenu" functionID="DeleteSubMenuID" messagetype="request"> + <description>Deletes a submenu from the in-application menu.</description> + + <param name="menuID" type="Integer" minvalue="1" maxvalue="2000000000" mandatory="true"> + <description>The "menuID" of the submenu to delete. (See addSubMenu.menuID)</description> + </param> + + </function> + + <function name="DeleteSubMenu" functionID="DeleteSubMenuID" messagetype="response"> + + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="INVALID_ID"/> + <element name="IN_USE"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + </function> + + <function name="CreateInteractionChoiceSet" functionID="CreateInteractionChoiceSetID" messagetype="request"> + <description>creates interaction choice set to be used later by performInteraction</description> + + <param name="interactionChoiceSetID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> + <description>Unique ID used for this interaction choice set.</description> + </param> + + <param name="choiceSet" type="Choice" minsize="1" maxsize="100" array="true" mandatory="true"/> + </function> + + <function name="CreateInteractionChoiceSet" functionID="CreateInteractionChoiceSetID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="INVALID_ID"/> + <element name="DUPLICATE_NAME"/> + <element name="UNSUPPORTED_RESOURCE"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="PerformInteraction" functionID="PerformInteractionID" messagetype="request"> + <description>Triggers an interaction (e.g. "Permit GPS?" - Yes, no, Always Allow).</description> + + <param name="initialText" type="String" maxlength="500" mandatory="true"> + <description> + Text to be displayed first. + </description> + </param> + + <param name="initialPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false"> + <description> + This is the initial prompt spoken to the user at the start of an interaction. + An array of text chunks of type TTSChunk. See TTSChunk. + The array must have at least one item. + </description> + </param> + + <param name="interactionMode" type="InteractionMode" mandatory="true"> + <description>See InteractionMode.</description> + </param> + + <param name="interactionChoiceSetIDList" type="Integer" minsize="0" maxsize="100" minvalue="0" maxvalue="2000000000" array="true" mandatory="true"> + <description>List of interaction choice set IDs to use with an interaction.</description> + </param> + + <param name="helpPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false"> + <description> + Help text. This is the spoken string when a user speaks "help" when the interaction is occurring. + An array of text chunks of type TTSChunk. See TTSChunk. + The array must have at least one item. + </description> + </param> + + <param name="timeoutPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false"> + <description> + Timeout text. This text is spoken when a VR interaction times out. + An array of text chunks of type TTSChunk. See TTSChunk. + The array must have at least one item. + </description> + </param> + + <param name="timeout" type="Integer" minvalue="5000" maxvalue="100000" defvalue="10000" mandatory="false"> + <description> + Timeout in milliseconds. + If omitted a standard value of 10000 milliseconds is used. + Applies only to the menu portion of the interaction. The VR timeout will be handled by the platform. + </description> + </param> + + <param name="vrHelp" type="VrHelpItem" minsize="1" maxsize="100" array="true" mandatory="false"> + <description> + Ability to send suggested VR Help Items to display on-screen during Perform Interaction. + If omitted on supported displays, the default generated list of suggested choices shall be displayed. + </description> + </param> + + <param name="interactionLayout" type="LayoutMode" mandatory="false"> + <description>See LayoutMode.</description> + </param> + + </function> + + <function name="PerformInteraction" functionID="PerformInteractionID" messagetype="response"> + + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="INVALID_ID"/> + <element name="DUPLICATE_NAME"/> + <element name="TIMED_OUT"/> + <element name="ABORTED"/> + <element name="UNSUPPORTED_RESOURCE"/> + <element name="WARNINGS"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + <param name="choiceID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false"> + <description> + ID of the choice that was selected in response to PerformInteraction. + Only is valid if general result is "success:true". + </description> + </param> + + <param name="manualTextEntry" type="String" maxlength="500" mandatory="false"> + <description> + Manually entered text selection, e.g. through keyboard + Can be returned in lieu of choiceID, depending on trigger source + </description> + </param> + + <param name="triggerSource" type="TriggerSource" mandatory="false"> + <description> + See TriggerSource + Only is valid if resultCode is SUCCESS. + </description> + </param> + + </function> + + <function name="DeleteInteractionChoiceSet" functionID="DeleteInteractionChoiceSetID" messagetype="request"> + <description>Deletes interaction choice set that has been created with "CreateInteractionChoiceSet".</description> + <description>The interaction may only be deleted when not currently in use by a "performInteraction".</description> + + <param name="interactionChoiceSetID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> + <description>ID of the interaction choice set to delete.</description> + </param> + </function> + + <function name="DeleteInteractionChoiceSet" functionID="DeleteInteractionChoiceSetID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="INVALID_ID"/> + <element name="IN_USE"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="Alert" functionID="AlertID" messagetype="request"> + <description>Shows an alert which typically consists of text-to-speech message and text on the display. At least either alertText1, alertText2 or TTSChunks need to be provided.</description> + + <param name="alertText1" type="String" maxlength="500" mandatory="false"> + <description>The first line of the alert text field</description> + </param> + + <param name="alertText2" type="String" maxlength="500" mandatory="false"> + <description>The second line of the alert text field</description> + </param> + + <param name="alertText3" type="String" maxlength="500" mandatory="false"> + <description>The optional third line of the alert text field</description> + </param> + + <param name="ttsChunks" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false"> + <description> + An array of text chunks of type TTSChunk. See TTSChunk. + The array must have at least one item. + </description> + </param> + + <param name="duration" type="Integer" minvalue="3000" maxvalue="10000" defvalue="5000" mandatory="false"> + <description> + Timeout in milliseconds. + Typical timeouts are 3-5 seconds. + If omitted, timeout is set to 5s. + </description> + </param> + + <param name="playTone" type="Boolean" mandatory="false"> + <description> + Defines if tone should be played. Tone is played before TTS. + If omitted, no tone is played. + </description> + </param> + + <param name="progressIndicator" type="Boolean" mandatory="false"> + <description> + If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc. + </description> + </param> + + <param name="softButtons" type="SoftButton" minsize="0" maxsize="4" array="true" mandatory="false"> + <description> + App defined SoftButtons. + If omitted on supported displays, the displayed alert shall not have any SoftButtons. + </description> + </param> + + </function> + + <function name="Alert" functionID="AlertID" messagetype="response"> + + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="ABORTED"/> + <element name="DISALLOWED"/> + <element name="USER_DISALLOWED"/> + <element name="UNSUPPORTED_RESOURCE"/> + <element name="WARNINGS"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + <param name="tryAgainTime" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false"> + <description> + Amount of time (in seconds) that an app must wait before resending an alert. + If provided, another system event or overlay currently has a higher priority than this alert. + An app must not send an alert without waiting at least the amount of time dictated. + </description> + </param> + + </function> + + <function name="Show" functionID="ShowID" messagetype="request"> + <description>Updates the persistent display. Supported fields depend on display capabilities.</description> + + <param name="mainField1" type="String" minlength="0" maxlength="500" mandatory="false"> + <description> + The text that should be displayed in a single or upper display line. + If this text is not set, the text of mainField1 stays unchanged. + If this text is empty "", the field will be cleared. + </description> + </param> + + <param name="mainField2" type="String" minlength="0" maxlength="500" mandatory="false"> + <description> + The text that should be displayed on the second display line. + If this text is not set, the text of mainField2 stays unchanged. + If this text is empty "", the field will be cleared. + </description> + </param> + + <param name="mainField3" type="String" minlength="0" maxlength="500" mandatory="false"> + <description> + The text that should be displayed on the second "page" first display line. + If this text is not set, the text of mainField3 stays unchanged. + If this text is empty "", the field will be cleared. + </description> + </param> + + <param name="mainField4" type="String" minlength="0" maxlength="500" mandatory="false"> + <description> + The text that should be displayed on the second "page" second display line. + If this text is not set, the text of mainField4 stays unchanged. + If this text is empty "", the field will be cleared. + </description> + </param> + + <param name="alignment" type="TextAlignment" mandatory="false"> + <description> + Specifies how mainField1 and mainField2 texts should be aligned on display. + If omitted, texts will be centered. + </description> + </param> + + <param name="statusBar" type="String" minlength="0" maxlength="500" mandatory="false"> + <description>Requires investigation regarding the nav display capabilities. Potentially lower lowerStatusBar, upperStatusBar, titleBar, etc.</description> + </param> + + <param name="mediaClock" type="String" minlength="0" maxlength="500" mandatory="false"> + <description> + Text value for MediaClock field. Has to be properly formatted by Mobile App according to the module's capabilities. + If this text is set, any automatic media clock updates previously set with SetMediaClockTimer will be stopped. + </description> + </param> + + <param name="mediaTrack" type="String" minlength="0" maxlength="500" mandatory="false"> + <description> + The text that should be displayed in the track field. + If this text is not set, the text of mediaTrack stays unchanged. + If this text is empty "", the field will be cleared. + </description> + </param> + + <param name="graphic" type="Image" mandatory="false"> + <description> + Image struct determining whether static or dynamic image to display in app. + If omitted on supported displays, the displayed graphic shall not change. + </description> + </param> + + <param name="secondaryGraphic" type="Image" mandatory="false"> + <description> + Image struct determining whether static or dynamic secondary image to display in app. + If omitted on supported displays, the displayed secondary graphic shall not change. + </description> + </param> + + + <param name="softButtons" type="SoftButton" minsize="0" maxsize="8" array="true" mandatory="false"> + <description> + App defined SoftButtons. + If omitted on supported displays, the currently displayed SoftButton values will not change. + </description> + </param> + + <param name="customPresets" type="String" maxlength="500" minsize="0" maxsize="10" array="true" mandatory="false"> + <description> + App labeled on-screen presets (i.e. on-screen media presets or dynamic search suggestions). + If omitted on supported displays, the presets will be shown as not defined. + </description> + </param> + + <param name="metadataTags" type="MetadataTags" mandatory="false"> + <description>App defined metadata information. See MetadataStruct. Uses mainField1, mainField2, mainField3, mainField4. + If omitted on supported displays, the currently set metadata tags will not change. + If any text field contains no tags or the none tag, the metadata tag for that textfield should be removed.</description> + </param> + </function> + + <function name="Show" functionID="ShowID" messagetype="response"> + + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="DISALLOWED"/> + <element name="UNSUPPORTED_RESOURCE"/> + <element name="WARNINGS"/> + <element name="ABORTED"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="Speak" functionID="SpeakID" messagetype="request"> + <description>Speaks a text.</description> + + <param name="ttsChunks" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="true"> + <description> + An array of text chunks of type TTSChunk. See TTSChunk. + The array must have at least one item. + </description> + </param> + + </function> + + <function name="Speak" functionID="SpeakID" messagetype="response"> + + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="DISALLOWED"/> + <element name="ABORTED"/> + <element name="WARNINGS"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + </function> + + <function name="SetMediaClockTimer" functionID="SetMediaClockTimerID" messagetype="request"> + <description>Sets the initial media clock value and automatic update method.</description> + + <param name="startTime" type="StartTime" mandatory="false"> + <description> + See StartTime. + startTime must be provided for "COUNTUP" and "COUNTDOWN". + startTime will be ignored for "RESUME", and "CLEAR" + startTime can be sent for "PAUSE", in which case it will update the paused startTime + </description> + </param> + + <param name="endTime" type="StartTime" mandatory="false"> + <description> + See StartTime. + endTime can be provided for "COUNTUP" and "COUNTDOWN"; to be used to calculate any visual progress bar (if not provided, this feature is ignored) + If endTime is greater then startTime for COUNTDOWN or less than startTime for COUNTUP, then the request will return an INVALID_DATA. + endTime will be ignored for "RESUME", and "CLEAR" + endTime can be sent for "PAUSE", in which case it will update the paused endTime + </description> + </param> + + <param name="updateMode" type="UpdateMode" mandatory="true"> + <description> + Enumeration to control the media clock. + In case of pause, resume, or clear, the start time value is ignored and shall be left out. For resume, the time continues with the same value as it was when paused. + </description> + </param> + </function> + + <function name="SetMediaClockTimer" functionID="SetMediaClockTimerID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="IGNORED"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="PerformAudioPassThru" functionID="PerformAudioPassThruID" messagetype="request"> + <description>Starts audio pass thru session </description> + <param name="initialPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false"> + <description> + The module will speak this prompt before opening the audio pass thru session. + An array of text chunks of type TTSChunk. See TTSChunk. + The array must have at least one item. + If omitted, then no initial prompt is spoken. + </description> + </param> + <param name="audioPassThruDisplayText1" type="String" mandatory="false" maxlength="500"> + <description>First line of text displayed during audio capture.</description> + </param> + <param name="audioPassThruDisplayText2" type="String" mandatory="false" maxlength="500"> + <description>Second line of text displayed during audio capture.</description> + </param> + <param name="samplingRate" type="SamplingRate" mandatory="true"> + <description> This value shall be allowed at 8 kHz or 16 or 22 or 44 kHz.</description> + </param> + <param name="maxDuration" type="Integer" minvalue="1" maxvalue="1000000" mandatory="true"> + <description>The maximum duration of audio recording in milliseconds. </description> + </param> + <param name="bitsPerSample" type="BitsPerSample" mandatory="true"> + <description>Specifies the quality the audio is recorded. Currently 8 bit or 16 bit.</description> + </param> + <param name="audioType" type="AudioType" mandatory="true"> + <description>Specifies the type of audio data being requested.</description> + </param> + <param name="muteAudio" type="Boolean" mandatory="false"> + <description> + Defines if the current audio source should be muted during the APT session. If not, the audio source will play without interruption. + If omitted, the value is set to true. + </description> + </param> + </function> + + <function name="PerformAudioPassThru" functionID="PerformAudioPassThruID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="DISALLOWED"/> + <element name="REJECTED"/> + <element name="ABORTED"/> + <element name="RETRY"/> + <element name="WARNINGS"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="EndAudioPassThru" functionID="EndAudioPassThruID" messagetype="request"> + <description>When this request is invoked, the audio capture stops.</description> + </function> + + <function name="EndAudioPassThru" functionID="EndAudioPassThruID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="DISALLOWED"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="SubscribeButton" functionID="SubscribeButtonID" messagetype="request"> + <description> + Subscribes to built-in HMI buttons. + The application will be notified by the OnButtonEvent and OnButtonPress. + To unsubscribe the notifications, use unsubscribeButton. + </description> + + <param name="buttonName" type="ButtonName" mandatory="true"> + <description>Name of the button to subscribe.</description> + </param> + </function> + + <function name="SubscribeButton" functionID="SubscribeButtonID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="UNSUPPORTED_RESOURCE" /> + <element name="IGNORED" /> + <element name="REJECTED"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="UnsubscribeButton" functionID="UnsubscribeButtonID" messagetype="request"> + <description>Unsubscribes from built-in HMI buttons.</description> + + <param name="buttonName" type="ButtonName" mandatory="true"> + <description>Name of the button to unsubscribe.</description> + </param> + </function> + + <function name="UnsubscribeButton" functionID="UnsubscribeButtonID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="UNSUPPORTED_RESOURCE" /> + <element name="IGNORED" /> + <element name="REJECTED"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="SubscribeVehicleData" functionID="SubscribeVehicleDataID" messagetype="request"> + <description> + Subscribes for specific published data items. + The data will be only sent if it has changed. + The application will be notified by the onVehicleData notification whenever new data is available. + To unsubscribe the notifications, use unsubscribe with the same subscriptionType. + </description> + + <param name="gps" type="Boolean" mandatory="false"> + <description>See GPSData</description> + </param> + <param name="speed" type="Boolean" mandatory="false"> + <description>The vehicle speed in kilometers per hour</description> + </param> + <param name="rpm" type="Boolean" mandatory="false"> + <description>The number of revolutions per minute of the engine</description> + </param> + <param name="fuelLevel" type="Boolean" mandatory="false"> + <description>The fuel level in the tank (percentage)</description> + </param> + <param name="fuelLevel_State" type="Boolean" mandatory="false"> + <description>The fuel level state</description> + </param> + <param name="instantFuelConsumption" type="Boolean" mandatory="false"> + <description>The instantaneous fuel consumption in microlitres</description> + </param> + <param name="externalTemperature" type="Boolean" mandatory="false"> + <description>The external temperature in degrees celsius</description> + </param> + <param name="prndl" type="Boolean" mandatory="false"> + <description>See PRNDL</description> + </param> + <param name="tirePressure" type="Boolean" mandatory="false"> + <description>See TireStatus</description> + </param> + <param name="odometer" type="Boolean" mandatory="false"> + <description>Odometer in km</description> + </param> + <param name="beltStatus" type="Boolean" mandatory="false"> + <description>The status of the seat belts</description> + </param> + <param name="bodyInformation" type="Boolean" mandatory="false"> + <description>The body information including power modes</description> + </param> + <param name="deviceStatus" type="Boolean" mandatory="false"> + <description>The device status including signal and battery strength</description> + </param> + <param name="driverBraking" type="Boolean" mandatory="false"> + <description>The status of the brake pedal</description> + </param> + <param name="wiperStatus" type="Boolean" mandatory="false"> + <description>The status of the wipers</description> + </param> + <param name="headLampStatus" type="Boolean" mandatory="false"> + <description>Status of the head lamps</description> + </param> + <param name="engineTorque" type="Boolean" mandatory="false"> + <description>Torque value for engine (in Nm) on non-diesel variants</description> + </param> + <param name="accPedalPosition" type="Boolean" mandatory="false"> + <description>Accelerator pedal position (percentage depressed)</description> + </param> + <param name="steeringWheelAngle" type="Boolean" mandatory="false"> + <description>Current angle of the steering wheel (in deg)</description> + </param> + + <!-- Ford Specific Data Items --> + <param name="eCallInfo" type="Boolean" mandatory="false"> + <description>Emergency Call notification and confirmation data</description> + </param> + <param name="airbagStatus" type="Boolean" mandatory="false"> + <description>The status of the air bags</description> + </param> + <param name="emergencyEvent" type="Boolean" mandatory="false"> + <description>Information related to an emergency event (and if it occurred)</description> + </param> + <param name="clusterModeStatus" type="Boolean" mandatory="false"> + <description>The status modes of the cluster</description> + </param> + <param name="myKey" type="Boolean" mandatory="false"> + <description>Information related to the MyKey feature</description> + </param> + + <!-- / Ford Specific Data Items --> + + </function> + + <function name="SubscribeVehicleData" functionID="SubscribeVehicleDataID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="WARNINGS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED" /> + <element name="IGNORED" /> + <element name="DISALLOWED"/> + <element name="USER_DISALLOWED"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + <param name="gps" type="VehicleDataResult" mandatory="false"> + <description>See GPSData</description> + </param> + <param name="speed" type="VehicleDataResult" mandatory="false"> + <description>The vehicle speed in kilometers per hour</description> + </param> + <param name="rpm" type="VehicleDataResult" mandatory="false"> + <description>The number of revolutions per minute of the engine</description> + </param> + <param name="fuelLevel" type="VehicleDataResult" mandatory="false"> + <description>The fuel level in the tank (percentage)</description> + </param> + <param name="fuelLevel_State" type="VehicleDataResult" mandatory="false"> + <description>The fuel level state</description> + </param> + <param name="instantFuelConsumption" type="VehicleDataResult" mandatory="false"> + <description>The instantaneous fuel consumption in microlitres</description> + </param> + <param name="externalTemperature" type="VehicleDataResult" mandatory="false"> + <description>The external temperature in degrees celsius.</description> + </param> + <param name="prndl" type="VehicleDataResult" mandatory="false"> + <description>See PRNDL</description> + </param> + <param name="tirePressure" type="VehicleDataResult" mandatory="false"> + <description>See TireStatus</description> + </param> + <param name="odometer" type="VehicleDataResult" mandatory="false"> + <description>Odometer in km</description> + </param> + <param name="beltStatus" type="VehicleDataResult" mandatory="false"> + <description>The status of the seat belts</description> + </param> + <param name="bodyInformation" type="VehicleDataResult" mandatory="false"> + <description>The body information including power modes</description> + </param> + <param name="deviceStatus" type="VehicleDataResult" mandatory="false"> + <description>The device status including signal and battery strength</description> + </param> + <param name="driverBraking" type="VehicleDataResult" mandatory="false"> + <description>The status of the brake pedal</description> + </param> + <param name="wiperStatus" type="VehicleDataResult" mandatory="false"> + <description>The status of the wipers</description> + </param> + <param name="headLampStatus" type="VehicleDataResult" mandatory="false"> + <description>Status of the head lamps</description> + </param> + <param name="engineTorque" type="VehicleDataResult" mandatory="false"> + <description>Torque value for engine (in Nm) on non-diesel variants</description> + </param> + <param name="accPedalPosition" type="VehicleDataResult" mandatory="false"> + <description>Accelerator pedal position (percentage depressed)</description> + </param> + <param name="steeringWheelAngle" type="VehicleDataResult" mandatory="false"> + <description>Current angle of the steering wheel (in deg)</description> + </param> + + <!-- Ford Specific Data Items --> + <param name="eCallInfo" type="VehicleDataResult" mandatory="false"> + <description>Emergency Call notification and confirmation data</description> + </param> + <param name="airbagStatus" type="VehicleDataResult" mandatory="false"> + <description>The status of the air bags</description> + </param> + <param name="emergencyEvent" type="VehicleDataResult" mandatory="false"> + <description>Information related to an emergency event (and if it occurred)</description> + </param> + <param name="clusterModes" type="VehicleDataResult" mandatory="false"> + <description>The status modes of the cluster</description> + </param> + <param name="myKey" type="VehicleDataResult" mandatory="false"> + <description>Information related to the MyKey feature</description> + </param> + <!-- / Ford Specific Data Items --> + + </function> + + <function name="UnsubscribeVehicleData" functionID="UnsubscribeVehicleDataID" messagetype="request"> + <description>This function is used to unsubscribe the notifications from the subscribeVehicleData function.</description> + + <param name="gps" type="Boolean" mandatory="false"> + <description>See GPSData</description> + </param> + <param name="speed" type="Boolean" mandatory="false"> + <description>The vehicle speed in kilometers per hour</description> + </param> + <param name="rpm" type="Boolean" mandatory="false"> + <description>The number of revolutions per minute of the engine</description> + </param> + <param name="fuelLevel" type="Boolean" mandatory="false"> + <description>The fuel level in the tank (percentage)</description> + </param> + <param name="fuelLevel_State" type="Boolean" mandatory="false"> + <description>The fuel level state</description> + </param> + <param name="instantFuelConsumption" type="Boolean" mandatory="false"> + <description>The instantaneous fuel consumption in microlitres</description> + </param> + <param name="externalTemperature" type="Boolean" mandatory="false"> + <description>The external temperature in degrees celsius.</description> + </param> + <param name="prndl" type="Boolean" mandatory="false"> + <description>See PRNDL</description> + </param> + <param name="tirePressure" type="Boolean" mandatory="false"> + <description>See TireStatus</description> + </param> + <param name="odometer" type="Boolean" mandatory="false"> + <description>Odometer in km</description> + </param> + <param name="beltStatus" type="Boolean" mandatory="false"> + <description>The status of the seat belts</description> + </param> + <param name="bodyInformation" type="Boolean" mandatory="false"> + <description>The body information including power modes</description> + </param> + <param name="deviceStatus" type="Boolean" mandatory="false"> + <description>The device status including signal and battery strength</description> + </param> + <param name="driverBraking" type="Boolean" mandatory="false"> + <description>The status of the brake pedal</description> + </param> + <param name="wiperStatus" type="Boolean" mandatory="false"> + <description>The status of the wipers</description> + </param> + <param name="headLampStatus" type="Boolean" mandatory="false"> + <description>Status of the head lamps</description> + </param> + <param name="engineTorque" type="Boolean" mandatory="false"> + <description>Torque value for engine (in Nm) on non-diesel variants</description> + </param> + <param name="accPedalPosition" type="Boolean" mandatory="false"> + <description>Accelerator pedal position (percentage depressed)</description> + </param> + <param name="steeringWheelAngle" type="Boolean" mandatory="false"> + <description>Current angle of the steering wheel (in deg)</description> + </param> + + <!-- Ford Specific Data Items --> + <param name="eCallInfo" type="Boolean" mandatory="false"> + <description>Emergency Call notification and confirmation data</description> + </param> + <param name="airbagStatus" type="Boolean" mandatory="false"> + <description>The status of the air bags</description> + </param> + <param name="emergencyEvent" type="Boolean" mandatory="false"> + <description>Information related to an emergency event (and if it occurred)</description> + </param> + <param name="clusterModeStatus" type="Boolean" mandatory="false"> + <description>The status modes of the cluster</description> + </param> + <param name="myKey" type="Boolean" mandatory="false"> + <description>Information related to the MyKey feature</description> + </param> + <!-- / Ford Specific Data Items --> + + </function> + + <function name="UnsubscribeVehicleData" functionID="UnsubscribeVehicleDataID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="WARNINGS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED" /> + <element name="IGNORED" /> + <element name="DISALLOWED"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + <param name="gps" type="VehicleDataResult" mandatory="false"> + <description>See GPSData</description> + </param> + <param name="speed" type="VehicleDataResult" mandatory="false"> + <description>The vehicle speed in kilometers per hour</description> + </param> + <param name="rpm" type="VehicleDataResult" mandatory="false"> + <description>The number of revolutions per minute of the engine</description> + </param> + <param name="fuelLevel" type="VehicleDataResult" mandatory="false"> + <description>The fuel level in the tank (percentage)</description> + </param> + <param name="fuelLevel_State" type="VehicleDataResult" mandatory="false"> + <description>The fuel level state</description> + </param> + <param name="instantFuelConsumption" type="VehicleDataResult" mandatory="false"> + <description>The instantaneous fuel consumption in microlitres</description> + </param> + <param name="externalTemperature" type="VehicleDataResult" mandatory="false"> + <description>The external temperature in degrees celsius</description> + </param> + <param name="prndl" type="VehicleDataResult" mandatory="false"> + <description>See PRNDL</description> + </param> + <param name="tirePressure" type="VehicleDataResult" mandatory="false"> + <description>See TireStatus</description> + </param> + <param name="odometer" type="VehicleDataResult" mandatory="false"> + <description>Odometer in km</description> + </param> + <param name="beltStatus" type="VehicleDataResult" mandatory="false"> + <description>The status of the seat belts</description> + </param> + <param name="bodyInformation" type="VehicleDataResult" mandatory="false"> + <description>The body information including power modes</description> + </param> + <param name="deviceStatus" type="VehicleDataResult" mandatory="false"> + <description>The device status including signal and battery strength</description> + </param> + <param name="driverBraking" type="VehicleDataResult" mandatory="false"> + <description>The status of the brake pedal</description> + </param> + <param name="wiperStatus" type="VehicleDataResult" mandatory="false"> + <description>The status of the wipers</description> + </param> + <param name="headLampStatus" type="VehicleDataResult" mandatory="false"> + <description>Status of the head lamps</description> + </param> + <param name="engineTorque" type="VehicleDataResult" mandatory="false"> + <description>Torque value for engine (in Nm) on non-diesel variants</description> + </param> + <param name="accPedalPosition" type="VehicleDataResult" mandatory="false"> + <description>Accelerator pedal position (percentage depressed)</description> + </param> + <param name="steeringWheelAngle" type="VehicleDataResult" mandatory="false"> + <description>Current angle of the steering wheel (in deg)</description> + </param> + + <!-- Ford Specific Data Items --> + <param name="eCallInfo" type="VehicleDataResult" mandatory="false"> + <description>Emergency Call notification and confirmation data</description> + </param> + <param name="airbagStatus" type="VehicleDataResult" mandatory="false" > + <description>The status of the air bags</description> + </param> + <param name="emergencyEvent" type="VehicleDataResult" mandatory="false"> + <description>Information related to an emergency event (and if it occurred)</description> + </param> + <param name="clusterModes" type="VehicleDataResult" mandatory="false"> + <description>The status modes of the cluster</description> + </param> + <param name="myKey" type="VehicleDataResult" mandatory="false"> + <description>Information related to the MyKey feature</description> + </param> + <!-- / Ford Specific Data Items --> + + </function> + + <function name="GetVehicleData" functionID="GetVehicleDataID" messagetype="request"> + <description>Non periodic vehicle data read request.</description> + + <param name="gps" type="Boolean" mandatory="false"> + <description>See GPSData</description> + </param> + <param name="speed" type="Boolean" mandatory="false"> + <description>The vehicle speed in kilometers per hour</description> + </param> + <param name="rpm" type="Boolean" mandatory="false"> + <description>The number of revolutions per minute of the engine</description> + </param> + <param name="fuelLevel" type="Boolean" mandatory="false"> + <description>The fuel level in the tank (percentage)</description> + </param> + <param name="fuelLevel_State" type="Boolean" mandatory="false"> + <description>The fuel level state</description> + </param> + <param name="instantFuelConsumption" type="Boolean" mandatory="false"> + <description>The instantaneous fuel consumption in microlitres</description> + </param> + <param name="externalTemperature" type="Boolean" mandatory="false"> + <description>The external temperature in degrees celsius</description> + </param> + <param name="vin" type="Boolean" mandatory="false"> + <description>Vehicle identification number</description> + </param> + <param name="prndl" type="Boolean" mandatory="false"> + <description>See PRNDL</description> + </param> + <param name="tirePressure" type="Boolean" mandatory="false"> + <description>See TireStatus</description> + </param> + <param name="odometer" type="Boolean" mandatory="false"> + <description>Odometer in km</description> + </param> + <param name="beltStatus" type="Boolean" mandatory="false"> + <description>The status of the seat belts</description> + </param> + <param name="bodyInformation" type="Boolean" mandatory="false"> + <description>The body information including ignition status and internal temp</description> + </param> + <param name="deviceStatus" type="Boolean" mandatory="false"> + <description>The device status including signal and battery strength</description> + </param> + <param name="driverBraking" type="Boolean" mandatory="false"> + <description>The status of the brake pedal</description> + </param> + <param name="wiperStatus" type="Boolean" mandatory="false"> + <description>The status of the wipers</description> + </param> + <param name="headLampStatus" type="Boolean" mandatory="false"> + <description>Status of the head lamps</description> + </param> + <param name="engineTorque" type="Boolean" mandatory="false"> + <description>Torque value for engine (in Nm) on non-diesel variants</description> + </param> + <param name="accPedalPosition" type="Boolean" mandatory="false"> + <description>Accelerator pedal position (percentage depressed)</description> + </param> + <param name="steeringWheelAngle" type="Boolean" mandatory="false"> + <description>Current angle of the steering wheel (in deg)</description> + </param> + + <!-- Ford Specific Data Items --> + <param name="eCallInfo" type="Boolean" mandatory="false"> + <description>Emergency Call notification and confirmation data</description> + </param> + <param name="airbagStatus" type="Boolean" mandatory="false"> + <description>The status of the air bags</description> + </param> + <param name="emergencyEvent" type="Boolean" mandatory="false"> + <description>Information related to an emergency event (and if it occurred)</description> + </param> + <param name="clusterModeStatus" type="Boolean" mandatory="false"> + <description>The status modes of the cluster</description> + </param> + <param name="myKey" type="Boolean" mandatory="false"> + <description>Information related to the MyKey feature</description> + </param> + <!-- / Ford Specific Data Items --> + + </function> + + <function name="GetVehicleData" functionID="GetVehicleDataID" messagetype="response"> + + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="VEHICLE_DATA_NOT_ALLOWED"/> + <element name="VEHICLE_DATA_NOT_AVAILABLE"/> + <element name="USER_DISALLOWED"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + <param name="gps" type="GPSData" mandatory="false"> + <description>See GPSData</description> + </param> + <param name="speed" type="Float" minvalue="0" maxvalue="700" mandatory="false"> + <description>The vehicle speed in kilometers per hour</description> + </param> + <param name="rpm" type="Integer" minvalue="0" maxvalue="20000" mandatory="false"> + <description>The number of revolutions per minute of the engine</description> + </param> + <param name="fuelLevel" type="Float" minvalue="-6" maxvalue="106" mandatory="false"> + <description>The fuel level in the tank (percentage)</description> + </param> + <param name="fuelLevel_State" type="ComponentVolumeStatus" mandatory="false"> + <description>The fuel level state</description> + </param> + <param name="instantFuelConsumption" type="Float" minvalue="0" maxvalue="25575" mandatory="false"> + <description>The instantaneous fuel consumption in microlitres</description> + </param> + <param name="externalTemperature" type="Float" minvalue="-40" maxvalue="100" mandatory="false"> + <description>The external temperature in degrees celsius</description> + </param> + <param name="vin" type="String" maxlength="17" mandatory="false"> + <description>Vehicle identification number</description> + </param> + <param name="prndl" type="PRNDL" mandatory="false"> + <description>See PRNDL</description> + </param> + <param name="tirePressure" type="TireStatus" mandatory="false"> + <description>See TireStatus</description> + </param> + <param name="odometer" type="Integer" minvalue="0" maxvalue="17000000" mandatory="false"> + <description>Odometer in km</description> + </param> + <param name="beltStatus" type="BeltStatus" mandatory="false"> + <description>The status of the seat belts</description> + </param> + <param name="bodyInformation" type="BodyInformation" mandatory="false"> + <description>The body information including power modes</description> + </param> + <param name="deviceStatus" type="DeviceStatus" mandatory="false"> + <description>The device status including signal and battery strength</description> + </param> + <param name="driverBraking" type="VehicleDataEventStatus" mandatory="false"> + <description>The status of the brake pedal</description> + </param> + <param name="wiperStatus" type="WiperStatus" mandatory="false"> + <description>The status of the wipers</description> + </param> + <param name="headLampStatus" type="HeadLampStatus" mandatory="false"> + <description>Status of the head lamps</description> + </param> + <param name="engineTorque" type="Float" minvalue="-1000" maxvalue="2000" mandatory="false"> + <description>Torque value for engine (in Nm) on non-diesel variants</description> + </param> + <param name="accPedalPosition" type="Float" minvalue="0" maxvalue="100" mandatory="false"> + <description>Accelerator pedal position (percentage depressed)</description> + </param> + <param name="steeringWheelAngle" type="Float" minvalue="-2000" maxvalue="2000" mandatory="false"> + <description>Current angle of the steering wheel (in deg)</description> + </param> + + <!-- Ford Specific Data Items --> + <param name="eCallInfo" type="ECallInfo" mandatory="false"> + <description>Emergency Call notification and confirmation data</description> + </param> + <param name="airbagStatus" type="AirbagStatus" mandatory="false"> + <description>The status of the air bags</description> + </param> + <param name="emergencyEvent" type="EmergencyEvent" mandatory="false"> + <description>Information related to an emergency event (and if it occurred)</description> + </param> + <param name="clusterModeStatus" type="ClusterModeStatus" mandatory="false"> + <description>The status modes of the cluster</description> + </param> + <param name="myKey" type="MyKey" mandatory="false"> + <description>Information related to the MyKey feature</description> + </param> + <!-- / Ford Specific Data Items --> + + </function> + + <function name="ReadDID" functionID="ReadDIDID" messagetype="request"> + <description>Non periodic vehicle data read request</description> + + <param name="ecuName" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"> + <description>Name of ECU.</description> + </param> + <param name="didLocation" type="Integer" minvalue="0" maxvalue="65535" minsize="1" maxsize="1000" array="true" mandatory="true"> + <description>Get raw data from vehicle data DID location(s)</description> + </param> + </function> + + <function name="ReadDID" functionID="ReadDIDID" messagetype="response"> + + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="DISALLOWED"/> + <element name="USER_DISALLOWED"/> + <element name="TRUNCATED_DATA"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + <param name="didResult" type="DIDResult" minsize="0" maxsize="1000" array="true" mandatory="false"> + <description>Array of requested DID results (with data if available).</description> + </param> + + </function> + + <function name="GetDTCs" functionID="GetDTCsID" messagetype="request"> + <description>Vehicle module diagnostic trouble code request.</description> + + <param name="ecuName" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"> + <description>Name of ECU.</description> + </param> + + <param name="dtcMask" type="Integer" minvalue="0" maxvalue="255" mandatory="false"> + <description>DTC Mask Byte to be sent in diagnostic request to module .</description> + </param> + + </function> + + <function name="GetDTCs" functionID="GetDTCsID" messagetype="response"> + + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="DISALLOWED"/> + <element name="USER_DISALLOWED"/> + <element name="TRUNCATED_DATA"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + <param name="ecuHeader" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"> + <description>2 byte ECU Header for DTC response (as defined in VHR_Layout_Specification_DTCs.pdf)</description> + </param> + + <param name="dtc" type="String" mandatory="false" minsize="1" maxsize="15" maxlength="10" array="true"> + <description> + Array of all reported DTCs on module (ecuHeader contains information if list is truncated). + Each DTC is represented by 4 bytes (3 bytes of data and 1 byte status as defined in VHR_Layout_Specification_DTCs.pdf). + </description> + </param> + + </function> + + <function name="DiagnosticMessage" functionID="DiagnosticMessageID" messagetype="request"> + <description>Non periodic vehicle diagnostic request</description> + + <param name="targetID" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"> + <description>Name of target ECU.</description> + </param> + + <param name="messageLength" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"> + <description>Length of message (in bytes).</description> + </param> + + <param name="messageData" type="Integer" minvalue="0" maxvalue="255" minsize="1" maxsize="65535" array="true" mandatory="true"> + <description> + Array of bytes comprising CAN message. + </description> + </param> + </function> + + <function name="DiagnosticMessage" functionID="DiagnosticMessageID" messagetype="response"> + + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="DISALLOWED"/> + <element name="USER_DISALLOWED"/> + <element name="TRUNCATED_DATA"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + <param name="messageDataResult" type="Integer" minvalue="0" maxvalue="255" minsize="1" maxsize="65535" array="true" mandatory="true"> + <description> + Array of bytes comprising CAN message result. + </description> + </param> + + </function> + + <function name="ScrollableMessage" functionID="ScrollableMessageID" messagetype="request"> + <description>Creates a full screen overlay containing a large block of formatted text that can be scrolled with up to 8 SoftButtons defined</description> + <param name="scrollableMessageBody" type="String" maxlength="500" mandatory="true"> + <description>Body of text that can include newlines and tabs.</description> + </param> + <param name="timeout" type="Integer" minvalue="1000" maxvalue="65535" defvalue="30000" mandatory="false"> + <description>App defined timeout. Indicates how long of a timeout from the last action (i.e. scrolling message resets timeout).</description> + </param> + <param name="softButtons" type="SoftButton" minsize="0" maxsize="8" array="true" mandatory="false"> + <description> + App defined SoftButtons. + If omitted on supported displays, only the system defined "Close" SoftButton will be displayed. + </description> + </param> + </function> + + <function name="ScrollableMessage" functionID="ScrollableMessageID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="CHAR_LIMIT_EXCEEDED"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="DISALLOWED"/> + <element name="UNSUPPORTED_RESOURCE"/> + <element name="REJECTED"/> + <element name="ABORTED"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + </function> + + <function name="Slider" functionID="SliderID" messagetype="request"> + <description>Creates a full screen or pop-up overlay (depending on platform) with a single user controlled slider.</description> + <param name="numTicks" type="Integer" minvalue="2" maxvalue="26" mandatory="true"> + <description>Number of selectable items on a horizontal axis</description> + </param> + <param name="position" type="Integer" minvalue="1" maxvalue="26" mandatory="true"> + <description>Initial position of slider control (cannot exceed numTicks)</description> + </param> + <param name="sliderHeader" type="String" maxlength="500" mandatory="true"> + <description>Text header to display</description> + </param> + <param name="sliderFooter" type="String" maxlength="500" minsize="1" maxsize="26" array="true" mandatory="false"> + <description> + Text footer to display (meant to display min/max threshold descriptors). + For a static text footer, only one footer string shall be provided in the array. + For a dynamic text footer, the number of footer text string in the array must match the numTicks value. + For a dynamic text footer, text array string should correlate with potential slider position index. + If omitted on supported displays, no footer text shall be displayed. + </description> + </param> + <param name="timeout" type="Integer" minvalue="1000" maxvalue="65535" defvalue="10000" mandatory="false"> + <description> + App defined timeout. Indicates how long of a timeout from the last action (i.e. sliding control resets timeout). + If omitted, the value is set to 10000. + </description> + </param> + </function> + + <function name="Slider" functionID="SliderID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="SAVED"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="DISALLOWED"/> + <element name="UNSUPPORTED_RESOURCE"/> + <element name="REJECTED"/> + <element name="ABORTED"/> + <element name="TIMED_OUT"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + <param name="sliderPosition" type="Integer" minvalue="1" maxvalue="26" mandatory="false"> + <description> + Current slider value returned when saved or canceled (aborted) + This value is only returned for resultCodes "SAVED" or "ABORTED" + </description> + </param> + </function> + + <function name="ShowConstantTBT" functionID="ShowConstantTBTID" messagetype="request"> + <param name="navigationText1" type="String" minlength="0" maxlength="500" mandatory="false"> + </param> + <param name="navigationText2" type="String" minlength="0" maxlength="500" mandatory="false"> + </param> + <param name="eta" type="String" minlength="0" maxlength="500" mandatory="false"> + </param> + <param name="timeToDestination" type="String" minlength="0" maxlength="500" mandatory="false"> + </param> + <param name="totalDistance" type="String" minlength="0" maxlength="500" mandatory="false"> + </param> + <param name="turnIcon" type="Image" mandatory="false"> + </param> + <param name="nextTurnIcon" type="Image" mandatory="false"> + </param> + <param name="distanceToManeuver" type="Float" minvalue="0" maxvalue="1000000000" mandatory="false"> + <description> + Fraction of distance till next maneuver (starting from when AlertManeuver is triggered). + Used to calculate progress bar. + </description> + </param> + <param name="distanceToManeuverScale" type="Float" minvalue="0" maxvalue="1000000000" mandatory="false"> + <description> + Distance till next maneuver (starting from) from previous maneuver. + Used to calculate progress bar. + </description> + </param> + <param name="maneuverComplete" type="Boolean" mandatory="false"> + <description> + If and when a maneuver has completed while an AlertManeuver is active, the app must send this value set to TRUE in order to clear the AlertManeuver overlay. + If omitted the value will be assumed as FALSE. + </description> + </param> + <param name="softButtons" type="SoftButton" minsize="0" maxsize="3" array="true" mandatory="false"> + <description> + Three dynamic SoftButtons available (first SoftButton is fixed to "Turns"). + If omitted on supported displays, the currently displayed SoftButton values will not change. + </description> + </param> + </function> + + <function name="ShowConstantTBT" functionID="ShowConstantTBTID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="DISALLOWED"/> + <element name="UNSUPPORTED_REQUEST"/> + <element name="UNSUPPORTED_RESOURCE"/> + </param> + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="AlertManeuver" functionID="AlertManeuverID" messagetype="request"> + <param name="ttsChunks" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false"> + <description>An array of text chunks of type TTSChunk. See TTSChunk</description> + </param> + <param name="softButtons" type="SoftButton" minsize="0" maxsize="3" array="true" mandatory="false"> + <description>If omitted on supported displays, only the system defined "Close" SoftButton shall be displayed.</description> + </param> + </function> + + <function name="AlertManeuver" functionID="AlertManeuverID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="IGNORED"/> + <element name="DISALLOWED"/> + <element name="UNSUPPORTED_REQUEST"/> + <element name="UNSUPPORTED_RESOURCE"/> + <element name="ABORTED"/> + <element name="WARNINGS"/> + </param> + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="UpdateTurnList" functionID="UpdateTurnListID" messagetype="request"> + <param name="turnList" type="Turn" minsize="1" maxsize="100" array="true" mandatory="false"> + </param> + <param name="softButtons" type="SoftButton" minsize="0" maxsize="1" array="true" mandatory="false"> + <description>If omitted on supported displays, app-defined SoftButton will be left blank.</description> + </param> + </function> + + <function name="UpdateTurnList" functionID="UpdateTurnListID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="DISALLOWED"/> + <element name="UNSUPPORTED_REQUEST"/> + <element name="UNSUPPORTED_RESOURCE"/> + </param> + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="ChangeRegistration" functionID="ChangeRegistrationID" messagetype="request"> + <param name="language" type="Language" mandatory="true"> + <description>Requested voice engine (VR+TTS) language registration</description> + </param> + <param name="hmiDisplayLanguage" type="Language" mandatory="true"> + <description>Request display language registration</description> + </param> + <param name="appName" type="String" maxlength="100" mandatory="false"> + <description>Request new app name registration</description> + </param> + <param name="ttsName" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" > + <description>Request new ttsName registration</description> + </param> + <param name="ngnMediaScreenAppName" type="String" maxlength="100" mandatory="false"> + <description>Request new app short name registration</description> + </param> + <param name="vrSynonyms" type="String" maxlength="40" minsize="1" maxsize="100" array="true" mandatory="false"> + <description>Request new VR synonyms registration</description> + </param> + + </function> + + + + <function name="ChangeRegistration" functionID="ChangeRegistrationID" messagetype="response"> + + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> + true, if successful + false, if failed + </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="DISALLOWED"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + </function> + + <function name="GenericResponse" functionID="GenericResponseID" messagetype="response"> + <description> + Generic Response is sent, when the name of a received msg cannot be retrieved. Only used in case of an error. + Currently, only resultCode INVALID_DATA is used. + </description> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="INVALID_DATA"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="PutFile" functionID="PutFileID" messagetype="request"> + <description> + Used to push a binary data onto the module from a mobile device, such as icons and album art + Not supported on first generation of SDL enabled modules. + Binary data is in binary part of hybrid msg. + </description> + + <param name="syncFileName" type="String" maxlength="255" mandatory="true"> + <description>File reference name.</description> + </param> + + <param name="fileType" type="FileType" mandatory="true"> + <description>Selected file type.</description> + </param> + + <param name="persistentFile" type="Boolean" defvalue="false" mandatory="false"> + <description> + Indicates if the file is meant to persist between sessions / ignition cycles. + If set to TRUE, then the system will aim to persist this file through session / cycles. + While files with this designation will have priority over others, they are subject to deletion by the system at any time. + In the event of automatic deletion by the system, the app will receive a rejection and have to resend the file. + If omitted, the value will be set to false. + </description> + </param> + + <param name="systemFile" type="Boolean" defvalue="false" mandatory="false" > + <description> + Indicates if the file is meant to be passed thru core to elsewhere on the system. + If set to TRUE, then the system will instead pass the data thru as it arrives to a predetermined area outside of core. + If omitted, the value will be set to false. + </description> + </param> + + <param name="offset" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false"> + <description>Optional offset in bytes for resuming partial data chunks</description> + </param> + <param name="length" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false"> + <description> + Optional length in bytes for resuming partial data chunks + If offset is set to 0, then length is the total length of the file to be downloaded + </description> + </param> + </function> + + <function name="PutFile" functionID="PutFileID" messagetype="response"> + <description>Response is sent, when the file data was copied (success case). Or when an error occurred.</description> + <description>Not supported on first generation SDL enabled vehicles. </description> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="UNSUPPORTED_REQUEST"/> + </param> + + <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> + <description> + Provides the total local space available in SDL Core for the registered app. + If the transfer has systemFile enabled, then the value will be set to 0 automatically. + </description> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="DeleteFile" functionID="DeleteFileID" messagetype="request"> + <description> + Used to delete a file resident on the module in the app's local cache. + Not supported on first generation SDL enabled vehicles. + </description> + + <param name="syncFileName" type="String" maxlength="500" mandatory="true"> + <description>File reference name.</description> + </param> + + </function> + + <function name="DeleteFile" functionID="DeleteFileID" messagetype="response"> + <description> + Response is sent, when the file data was deleted (success case). Or when an error occurred. + Not supported on First generation SDL enabled vehicles. + </description> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="UNSUPPORTED_REQUEST"/> + </param> + + <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> + <description>Provides the total local space available on the module for the registered app.</description> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="ListFiles" functionID="ListFilesID" messagetype="request"> + <description> + Requests the current list of resident filenames for the registered app. + Not supported on first generation SDL enabled vehicles. + </description> + </function> + + <function name="ListFiles" functionID="ListFilesID" messagetype="response"> + <description> + Returns the current list of resident filenames for the registered app along with the current space available + Not supported on First generation SDL enabled vehicles. + </description> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="UNSUPPORTED_REQUEST"/> + </param> + + <param name="filenames" type="String" maxlength="500" minsize="0" maxsize="1000" array="true" mandatory="false"> + <description> + An array of all filenames resident on the module for the given registered app. + If omitted, then no files currently reside on the system. + </description> + </param> + + <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> + <description>Provides the total local space available on the module for the registered app.</description> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="SetAppIcon" functionID="SetAppIconID" messagetype="request"> + <description> + Used to set existing local file on the module as the app's icon + Not supported on first generation SDL enabled vehicles. + </description> + + <param name="syncFileName" type="String" maxlength="500" mandatory="true"> + <description>File reference name.</description> + </param> + + </function> + + <function name="SetAppIcon" functionID="SetAppIconID" messagetype="response"> + <description> + Response is sent, when the file data was copied (success case). Or when an error occurred. + Not supported on First generation SDL enabled vehicles. + </description> + + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="UNSUPPORTED_REQUEST"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + </function> + + <function name="SetDisplayLayout" functionID="SetDisplayLayoutID" messagetype="request"> + <description> + Used to set an alternate display layout. + If not sent, default screen for given platform will be shown + </description> + + <param name="displayLayout" type="String" maxlength="500" mandatory="true"> + <description> + Predefined or dynamically created screen layout. + Currently only predefined screen layouts are defined. + </description> + </param> + + </function> + + <function name="SetDisplayLayout" functionID="SetDisplayLayoutID" messagetype="response"> + + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="UNSUPPORTED_REQUEST"/> + </param> + + <param name="displayCapabilities" type="DisplayCapabilities" mandatory="false"> + <description>See DisplayCapabilities</description> + </param> + + <param name="buttonCapabilities" type="ButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false"> + <description>See ButtonCapabilities</description > + </param> + + <param name="softButtonCapabilities" type="SoftButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false"> + <description>If returned, the platform supports on-screen SoftButtons; see SoftButtonCapabilities.</description > + </param> + + <param name="presetBankCapabilities" type="PresetBankCapabilities" mandatory="false"> + <description>If returned, the platform supports custom on-screen Presets; see PresetBankCapabilities.</description > + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + </function> + + <function name="SystemRequest" functionID="SystemRequestID" messagetype="request" > + <description>An asynchronous request from the device; binary data can be included in hybrid part of message for some requests (such as HTTP, Proprietary, or Authentication requests)</description> + <param name="requestType" type="RequestType" mandatory="true"> + <description> + The type of system request. + Note that Proprietary requests should forward the binary data to the known proprietary module on the system. + </description> + </param> + <param name="fileName" type="String" maxlength="255" mandatory="false"> + <description> + Filename of HTTP data to store in predefined system staging area. + Mandatory if requestType is HTTP. + PROPRIETARY requestType should ignore this parameter. + </description> + </param> + </function> + + <function name="SystemRequest" functionID="SystemRequestID" messagetype="response" > + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="INVALID_CERT"/> + <element name="EXPIRED_CERT"/> + <element name="UNSUPPORTED_REQUEST"/> + <element name="UNSUPPORTED_RESOURCE"/> + <element name="DISALLOWED"/> + <element name="ABORTED"/> + <element name="WARNINGS"/> + <element name="TIMED_OUT"/> + <element name="IGNORED"/> + </param> + </function> + + <function name="SendLocation" functionID="SendLocationID" messagetype="request"> + <param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180" mandatory="false"> + </param> + <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> + </param> + <param name="locationDescription" type="String" maxlength="500" mandatory="false"> + <description> + Description intended location / establishment (if applicable) + </description> + </param> + <param name="addressLines" type="String" maxlength="500" minsize="0" maxsize="4" array="true" mandatory="false"> + <description> + Location address (if applicable) + </description> + </param> + <param name="phoneNumber" type="String" maxlength="500" mandatory="false"> + <description> + Phone number of intended location / establishment (if applicable) + </description> + </param> + <param name="locationImage" type="Image" mandatory="false"> + <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> + <param name="deliveryMode" type="DeliveryMode" mandatory="false"> + <description>Defines the mode of prompt for user</description> + </param> + </function> + + <function name="SendLocation" functionID="SendLocationID" messagetype="response" > + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="UNSUPPORTED_RESOURCE"/> + <element name="DISALLOWED"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="DialNumber" functionID="DialNumberID" messagetype="request"> + <description>Dials a phone number and switches to phone application.</description> + + <param name="number" type="String" maxlength="40" mandatory="true"> + <description> + Phone number is a string, which can be up to 40 chars. + All characters shall be stripped from string except digits 0-9 and * # , ; + + </description> + </param> + </function> + + <function name="DialNumber" functionID="DialNumberID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description>true, if successful</description> + <description>false, if failed</description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="ButtonPress" functionID="ButtonPressID" messagetype="request"> + <param name="moduleType" type="ModuleType" mandatory="true"> + <description>The module where the button should be pressed</description> + </param> + <param name="buttonName" type="ButtonName" mandatory="true"> + <description>The name of supported RC climate or radio button.</description> + </param> + <param name="buttonPressMode" type="ButtonPressMode" mandatory="true"> + <description>Indicates whether this is a LONG or SHORT button press event.</description> + </param> + </function> + + <function name="ButtonPress" functionID="ButtonPressID" messagetype="response"> + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="IGNORED"/> + <element name="DISALLOWED"/> + <element name="USER_DISALLOWED"/> + <element name="IN_USE"/> + </param> + <param name="info" type="String" maxlength="1000" mandatory="false"> + </param> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + </function> + + <function name="GetInteriorVehicleData" functionID="GetInteriorVehicleDataID" messagetype="request"> + <param name="moduleType" type="ModuleType" mandatory="true"> + <description> + The type of a RC module to retrieve module data from the vehicle. + In the future, this should be the Identification of a module. + </description> + </param> + <param name="subscribe" type="Boolean" mandatory="false" defvalue="false"> + <description> + If subscribe is true, the head unit will register onInteriorVehicleData notifications for the requested moduelType. + If subscribe is false, the head unit will unregister onInteriorVehicleData notifications for the requested moduelType. + </description> + </param> + </function> + + <function name="GetInteriorVehicleData" functionID="GetInteriorVehicleDataID" messagetype="response"> + <param name="moduleData" type="ModuleData" mandatory="true"> + </param> + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="IGNORED"/> + <element name="DISALLOWED"/> + <element name="USER_DISALLOWED"/> + <element name="UNSUPPORTED_RESOURCE"/> + </param> + <param name="info" type="String" maxlength="1000" mandatory="false"> + </param> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + <param name="isSubscribed" type="Boolean" mandatory="false" > + <description> + It is a conditional-mandatory parameter: must be returned in case "subscribe" parameter was present in the related request. + if "true" - the "moduleType" from request is successfully subscribed and the head unit will send onInteriorVehicleData notifications for the moduleType. + if "false" - the "moduleType" from request is either unsubscribed or failed to subscribe. + </description> + </param> + </function> + + <function name="SetInteriorVehicleData" functionID="SetInteriorVehicleDataID" messagetype="request"> + <param name="moduleData" type="ModuleData" mandatory="true"> + <description>The module data to set for the requested RC module.</description> + </param> + </function> + + <function name="SetInteriorVehicleData" functionID="SetInteriorVehicleDataID" messagetype="response"> + <description>Used to set the values of one remote control module </description> + <param name="moduleData" type="ModuleData" mandatory="true"> + </param> + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="IGNORED"/> + <element name="DISALLOWED"/> + <element name="USER_DISALLOWED"/> + <element name="READ_ONLY"/> + <element name="UNSUPPORTED_RESOURCE"/> + <element name="IN_USE"/> + </param> + <param name="info" type="String" maxlength="1000" mandatory="false"> + </param> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + </function> + + <function name="SubscribeWayPoints" functionID="SubscribeWayPointsID" messagetype="request"> + <description>To subscribe in getting changes for Waypoints/destinations</description> + </function> + + <function name="SubscribeWayPoints" functionID="SubscribeWayPointsID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="UNSUPPORTED_RESOURCE"/> + <element name="IGNORED"/> + <element name="DISALLOWED"/> + </param> + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <function name="GetWayPoints" functionID="GetWayPointsID" messagetype="request"> + <description>Request for getting waypoint/destination data.</description> + <param name="wayPointType" type="WayPointType" mandatory="true"> + <description>To request for either the destination only or for all waypoints including destination</description> + </param> + </function> + + <function name="GetWayPoints" functionID="GetWayPointsID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="TIMED_OUT"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="UNSUPPORTED_RESOURCE"/> + <element name="IGNORED"/> + <element name="IN_USE"/> + <element name="DISALLOWED"/> + </param> + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + <param name="wayPoints" type="LocationDetails" mandatory="false" array="true" minsize="1" maxsize="10"> + <description>See LocationDetails</description> + </param> + </function> + + <function name="UnsubscribeWayPoints" functionID="UnsubscribeWayPointsID" messagetype="request"> + <description>Request to unsubscribe from WayPoints and Destination</description> + </function> + + <function name="UnsubscribeWayPoints" functionID="UnsubscribeWayPointsID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="UNSUPPORTED_RESOURCE"/> + <element name="IGNORED"/> + <element name="DISALLOWED"/> + </param> + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + <param name="wayPoints" type="LocationDetails" mandatory="false" array="true" minsize="1" maxsize="10"> + <description>See LocationDetails</description> + </param> + </function> + + <function name="GetSystemCapability" functionID="GetSystemCapabilityID" messagetype="request"> + <description>Request for expanded information about a supported system/HMI capability</description> + <param name="systemCapabilityType" type="SystemCapabilityType" mandatory="true"> + <description>The type of system capability to get more information on</description> + </param> + </function> + + <function name="GetSystemCapability" functionID="GetSystemCapabilityID" messagetype="response"> + <param name="systemCapability" type="SystemCapability" mandatory="true"> + </param> + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="IGNORED"/> + <element name="DISALLOWED"/> + <element name="USER_DISALLOWED"/> + <element name="UNSUPPORTED_RESOURCE"> + <description>The capability does not exist on the module</description> + </element> + <element name="DATA_NOT_AVAILABLE"> + <description>The capability should exist on the module but there was an error retrieving the data.</description> + </element> + </param> + <param name="info" type="String" maxlength="1000" mandatory="false"> + <description>Provides additional human readable info regarding the result.</description> + </param> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + </function> + + <function name="SendHapticData" functionID="SendHapticDataID" messagetype="request"> + <description>Send the spatial data gathered from SDLCarWindow or VirtualDisplayEncoder to the HMI. This data will be utilized by the HMI to determine how and when haptic events should occur</description> + <param name="hapticRectData" type="HapticRect" minsize="0" maxsize="1000" mandatory="false" array="true"> + <description>Array of spatial data structures that represent the locations of all user controls present on the HMI. This data should be updated if/when the application presents a new screen. When a request is sent, if successful, it will replace all spatial data previously sent through RPC. If an empty array is sent, the existing spatial data will be cleared</description> + </param> + </function> + + <function name="SendHapticData" functionID="SendHapticDataID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false if failed </description> + </param> + <param name="info" type="String" maxlength="1000" mandatory="false"> + <description>Provides additional human readable info regarding the result.</description> + </param> + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="GENERIC_ERROR"/> + </param> + </function> + + <!-- Notifications --> + + <function name="OnHMIStatus" functionID="OnHMIStatusID" messagetype="notification"> + <param name="hmiLevel" type="HMILevel" mandatory="true"> + <description>See HMILevel</description> + </param> + + <param name="audioStreamingState" type="AudioStreamingState" mandatory="true"> + <description>See AudioStreamingState</description> + </param> + + <param name="systemContext" type="SystemContext" mandatory="true"> + <description>See SystemContext</description> + </param> + </function> + + <function name="OnAppInterfaceUnregistered" functionID="OnAppInterfaceUnregisteredID" messagetype="notification"> + <param name="reason" type="AppInterfaceUnregisteredReason" mandatory="true"> + <description>See AppInterfaceUnregisteredReason</description> + </param> + </function> + + <function name="OnButtonEvent" functionID="OnButtonEventID" messagetype="notification"> + <description>Notifies application of UP/DOWN events for buttons to which the application is subscribed.</description> + <param name="buttonName" type="ButtonName" mandatory="true"/> + <param name="buttonEventMode" type="ButtonEventMode" mandatory="true"> + <description>Indicates whether this is an UP or DOWN event.</description> + </param> + <param name="customButtonID" type="Integer" minvalue="0" maxvalue="65536" mandatory="false"> + <description>If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. (e.g. softButton ID)</description> + </param> + </function> + + <function name="OnButtonPress" functionID="OnButtonPressID" messagetype="notification"> + <description>Notifies application of LONG/SHORT press events for buttons to which the application is subscribed.</description> + <param name="buttonName" type="ButtonName" mandatory="true"/> + <param name="buttonPressMode" type="ButtonPressMode" mandatory="true"> + <description>Indicates whether this is a LONG or SHORT button press event.</description> + </param> + <param name="customButtonID" type="Integer" minvalue="0" maxvalue="65536" mandatory="false"> + <description>If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. (e.g. softButton ID)</description> + </param> + </function> + + <function name="OnVehicleData" functionID="OnVehicleDataID" messagetype="notification"> + <description>Callback for the periodic and non periodic vehicle data read function.</description> + <param name="gps" type="GPSData" mandatory="false"> + <description>See GPSData</description> + </param> + <param name="speed" type="Float" minvalue="0" maxvalue="700" mandatory="false"> + <description>The vehicle speed in kilometers per hour</description> + </param> + <param name="rpm" type="Integer" minvalue="0" maxvalue="20000" mandatory="false"> + <description>The number of revolutions per minute of the engine</description> + </param> + <param name="fuelLevel" type="Float" minvalue="-6" maxvalue="106" mandatory="false"> + <description>The fuel level in the tank (percentage)</description> + </param> + <param name="fuelLevel_State" type="ComponentVolumeStatus" mandatory="false"> + <description>The fuel level state</description> + </param> + <param name="instantFuelConsumption" type="Float" minvalue="0" maxvalue="25575" mandatory="false"> + <description>The instantaneous fuel consumption in microlitres</description> + </param> + <param name="externalTemperature" type="Float" minvalue="-40" maxvalue="100" mandatory="false"> + <description>The external temperature in degrees celsius</description> + </param> + <param name="vin" type="String" maxlength="17" mandatory="false"> + <description>Vehicle identification number.</description> + </param> + <param name="prndl" type="PRNDL" mandatory="false"> + <description>See PRNDL</description> + </param> + <param name="tirePressure" type="TireStatus" mandatory="false"> + <description>See TireStatus</description> + </param> + <param name="odometer" type="Integer" minvalue="0" maxvalue="17000000" mandatory="false"> + <description>Odometer in km</description> + </param> + <param name="beltStatus" type="BeltStatus" mandatory="false"> + <description>The status of the seat belts</description> + </param> + <param name="bodyInformation" type="BodyInformation" mandatory="false"> + <description>The body information including power modes</description> + </param> + <param name="deviceStatus" type="DeviceStatus" mandatory="false"> + <description>The device status including signal and battery strength</description> + </param> + <param name="driverBraking" type="VehicleDataEventStatus" mandatory="false"> + <description>The status of the brake pedal</description> + </param> + <param name="wiperStatus" type="WiperStatus" mandatory="false"> + <description>The status of the wipers</description> + </param> + <param name="headLampStatus" type="HeadLampStatus" mandatory="false"> + <description>Status of the head lamps</description> + </param> + <param name="engineTorque" type="Float" minvalue="-1000" maxvalue="2000" mandatory="false"> + <description>Torque value for engine (in Nm) on non-diesel variants</description> + </param> + <param name="accPedalPosition" type="Float" minvalue="0" maxvalue="100" mandatory="false"> + <description>Accelerator pedal position (percentage depressed)</description> + </param> + <param name="steeringWheelAngle" type="Float" minvalue="-2000" maxvalue="2000" mandatory="false"> + <description>Current angle of the steering wheel (in deg)</description> + </param> + + <!-- Ford Specific Vehicle Data --> + <param name="eCallInfo" type="ECallInfo" mandatory="false"> + <description>Emergency Call notification and confirmation data</description> + </param> + <param name="airbagStatus" type="AirbagStatus" mandatory="false"> + <description>The status of the air bags</description> + </param> + <param name="emergencyEvent" type="EmergencyEvent" mandatory="false"> + <description>Information related to an emergency event (and if it occurred)</description> + </param> + <param name="clusterModeStatus" type="ClusterModeStatus" mandatory="false"> + <description>The status modes of the cluster</description> + </param> + <param name="myKey" type="MyKey" mandatory="false"> + <description>Information related to the MyKey feature</description> + </param> + <!-- / Ford Specific Vehicle Data --> + + </function> + + <function name="OnCommand" functionID="OnCommandID" messagetype="notification"> + <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> + <description>Command ID, which is related to a specific menu entry</description> + </param> + + <param name="triggerSource" type="TriggerSource" mandatory="true"> + <description>See TriggerSource</description> + </param> + </function> + + <function name="OnTBTClientState" functionID="OnTBTClientStateID" messagetype="notification" > + <description>Provides applications with notifications specific to the current TBT client status on the module</description> + <param name="state" type="TBTState" mandatory="true"> + <description>Current State of TBT client</description> + </param> + </function> + + <function name="OnDriverDistraction" functionID="OnDriverDistractionID" messagetype="notification" > + <description>Provides driver distraction state to mobile applications</description> + <param name="state" type="DriverDistractionState" mandatory="true"> + <description>Current State of Driver Distraction</description> + </param> + </function> + + <function name="OnPermissionsChange" functionID="OnPermissionsChangeID" messagetype="notification" > + <description>Provides update to app of which policy-table-enabled functions are available</description> + <param name="permissionItem" type="PermissionItem" minsize="0" maxsize="500" array="true" mandatory="true"> + <description>Change in permissions for a given set of RPCs</description> + </param> + </function> + + <function name="OnAudioPassThru" functionID="OnAudioPassThruID" messagetype="notification"> + <description>Binary data is in binary part of hybrid msg</description> + </function> + + <function name="OnLanguageChange" functionID="OnLanguageChangeID" messagetype="notification"> + <param name="language" type="Language" mandatory="true"> + <description>Current SDL voice engine (VR+TTS) language</description> + </param> + <param name="hmiDisplayLanguage" type="Language" mandatory="true"> + <description>Current display language</description> + </param> + </function> + + <function name="OnKeyboardInput" functionID="OnKeyboardInputID" messagetype="notification" > + + <description>On-screen keyboard event.</description> + <description>Can be full string or individual keypresses depending on keyboard mode.</description> + + <param name="event" type="KeyboardEvent" mandatory="true"> + <description>On-screen keyboard input data.</description> + </param> + + <param name="data" type="String" maxlength="500" mandatory="false"> + <description>On-screen keyboard input data.</description> + <description>For dynamic keypress events, this will be the current compounded string of entry text.</description> + <description>For entry submission events, this will be the full text entry (this will always return regardless of the mode).</description> + <description>For entry cancelled and entry aborted events, this data param will be omitted.</description> + </param> + + </function> + + <function name="OnTouchEvent" functionID="OnTouchEventID" messagetype="notification" > + <description>Notifies about touch events on the screen's prescribed area</description> + <param name="type" type="TouchType" mandatory="true"> + <description>The type of touch event.</description> + </param> + <param name="event" type="TouchEvent" mandatory="true" minsize="1" maxsize="10" array="true"> + <description>List of all individual touches involved in this event.</description> + </param> + </function> + + <function name="OnSystemRequest" functionID="OnSystemRequestID" messagetype="notification" > + <description> + An asynchronous request from the system for specific data from the device or the cloud or response to a request from the device or cloud + Binary data can be included in hybrid part of message for some requests (such as Authentication request responses) + </description> + <param name="requestType" type="RequestType" mandatory="true"> + <description>The type of system request.</description> + </param> + <param name="url" type="String" maxlength="1000" mandatory="false"> + <description> + Optional URL for HTTP requests. + If blank, the binary data shall be forwarded to the app. + If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds. + </description> + </param> + <param name="timeout" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false"> + <description> + Optional timeout for HTTP requests + Required if a URL is provided + </description> + </param> + <param name="fileType" type="FileType" mandatory="false"> + <description>Optional file type (meant for HTTP file requests).</description> + </param> + <param name="offset" type="Integer" minvalue="0" maxvalue="100000000000" mandatory="false"> + <description>Optional offset in bytes for resuming partial data chunks</description> + </param> + <param name="length" type="Integer" minvalue="0" maxvalue="100000000000" mandatory="false"> + <description>Optional length in bytes for resuming partial data chunks</description> + </param> + </function> + + <function name="OnHashChange" functionID="OnHashChangeID" messagetype="notification"> + <description> + Notification containing an updated hashID which can be used over connection cycles (i.e. loss of connection, ignition cycles, etc.). + Sent after initial registration and subsequently after any change in the calculated hash of all persisted app data. + </description> + <param name="hashID" type="String" maxlength="100" mandatory="true"> + <description>Calculated hash ID to be referenced during RegisterAppInterface.</description> + </param> + </function> + + <function name="OnWayPointChange" functionID="OnWayPointChangeID" messagetype="notification"> + <description>Notification which provides the entire LocationDetails when there is a change to any waypoints or destination.</description> + <param name="wayPoints" type="LocationDetails" mandatory="true" array="true" minsize="1" maxsize="10"> + <description>See LocationDetails</description> + </param> + </function> + + <function name="OnInteriorVehicleData" functionID="OnInteriorVehicleDataID" messagetype="notification"> + <param name="moduleData" type="ModuleData" mandatory="true"> + </param> + </function> + + <!-- ~~~~~~~~~~~~~~~~~~ --> + <!-- Ford Specific APIs --> + <!-- ~~~~~~~~~~~~~~~~~~ --> + + <function name="EncodedSyncPData" functionID="EncodedSyncPDataID" messagetype="request" > + <description> + Allows encoded data in the form of SyncP packets to be sent to the SYNC module. + Legacy / v1 Protocol implementation; use SyncPData instead. + *** DEPRECATED *** + </description> + + <param name="data" type="String" maxlength="1000000" minsize="1" maxsize="100" array="true" mandatory="true"> + <description>Contains base64 encoded string of SyncP packets.</description> + <todo>What is the maxlength?</todo> + </param> + </function> + + <function name="EncodedSyncPData" functionID="EncodedSyncPDataID" messagetype="response" > + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + + <!-- Deprecating - covered by SystemRequest + <function name="SyncPData" functionID="SyncPDataID" messagetype="request" > + <description> + Allows binary data in the form of SyncP packets to be sent to the SYNC module. + Binary data is in binary part of hybrid msg. + </description> + </function> + + <function name="SyncPData" functionID="SyncPDataID" messagetype="response" > + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + --> + + <function name="OnEncodedSyncPData" functionID="OnEncodedSyncPDataID" messagetype="notification" > + <description> + Callback including encoded data of any SyncP packets that SYNC needs to send back to the mobile device. + Legacy / v1 Protocol implementation; responds to EncodedSyncPData. + *** DEPRECATED *** + </description> + <param name="data" type="String" maxlength="1000000" minsize="1" maxsize="100" mandatory="true" array="true"> + <description>Contains base64 encoded string of SyncP packets.</description> + </param> + <param name="URL" type="String" maxlength="1000" mandatory="false"> + <description> + If blank, the SyncP data shall be forwarded to the app. + If not blank, the SyncP data shall be forwarded to the provided URL. + </description> + </param> + <param name="Timeout" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false"> + <description> + If blank, the SyncP data shall be forwarded to the app. + If not blank, the SyncP data shall be forwarded with the provided timeout in seconds. + </description> + </param> + </function> + + + <!-- Deprecating - covered by OnSystemRequest + <function name="OnSyncPData" functionID="OnSyncPDataID" messagetype="notification" > + <description> + Callback including binary data of any SyncP packets that SYNC needs to send back to the mobile device. + Responds to SyncPData. + Binary data is in binary part of hybrid msg. + </description> + + <param name="URL" type="String" maxlength="1000" mandatory="false"> + <description> + If blank, the SyncP data shall be forwarded to the app. + If not blank, the SyncP data shall be forwarded to the provided URL. + </description> + </param> + <param name="Timeout" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false"> + <description> + If blank, the SyncP data shall be forwarded to the app. + If not blank, the SyncP data shall be forwarded with the provided timeout in seconds. + </description> + </param> + + </function> + --> +</interface> diff --git a/src/components/media_manager/include/media_manager/audio/from_mic_to_file_recorder_thread.h b/src/components/media_manager/include/media_manager/audio/from_mic_to_file_recorder_thread.h index f0c6d3c48f..ded709b1fa 100644 --- a/src/components/media_manager/include/media_manager/audio/from_mic_to_file_recorder_thread.h +++ b/src/components/media_manager/include/media_manager/audio/from_mic_to_file_recorder_thread.h @@ -74,6 +74,7 @@ class FromMicToFileRecorderThread : public threads::ThreadDelegate { } GstTimeout; void initArgs(); + void deinitArgs(); void psleep(void* timeout); diff --git a/src/components/media_manager/include/media_manager/file_streamer_adapter.h b/src/components/media_manager/include/media_manager/file_streamer_adapter.h index 293c6721ee..c4c91a98d8 100644 --- a/src/components/media_manager/include/media_manager/file_streamer_adapter.h +++ b/src/components/media_manager/include/media_manager/file_streamer_adapter.h @@ -54,6 +54,8 @@ class FileStreamerAdapter : public StreamerAdapter { const std::string& app_storage_folder); virtual ~FileStreamer(); + virtual void Close() {} + protected: virtual bool Connect(); virtual void Disconnect(); diff --git a/src/components/media_manager/include/media_manager/pipe_streamer_adapter.h b/src/components/media_manager/include/media_manager/pipe_streamer_adapter.h index 1e998ef82f..c079e04954 100644 --- a/src/components/media_manager/include/media_manager/pipe_streamer_adapter.h +++ b/src/components/media_manager/include/media_manager/pipe_streamer_adapter.h @@ -53,6 +53,8 @@ class PipeStreamerAdapter : public StreamerAdapter { const std::string& app_storage_folder); virtual ~PipeStreamer(); + virtual void Close() {} + protected: virtual bool Connect(); virtual void Disconnect(); diff --git a/src/components/media_manager/include/media_manager/socket_streamer_adapter.h b/src/components/media_manager/include/media_manager/socket_streamer_adapter.h index 45311b6077..3b647a0b83 100644 --- a/src/components/media_manager/include/media_manager/socket_streamer_adapter.h +++ b/src/components/media_manager/include/media_manager/socket_streamer_adapter.h @@ -55,6 +55,8 @@ class SocketStreamerAdapter : public StreamerAdapter { const std::string& header); virtual ~SocketStreamer(); + virtual void Close(); + protected: virtual bool Connect(); virtual void Disconnect(); diff --git a/src/components/media_manager/include/media_manager/streamer_adapter.h b/src/components/media_manager/include/media_manager/streamer_adapter.h index 30353b8d09..5ac8e05cac 100644 --- a/src/components/media_manager/include/media_manager/streamer_adapter.h +++ b/src/components/media_manager/include/media_manager/streamer_adapter.h @@ -72,6 +72,8 @@ class StreamerAdapter : public MediaAdapterImpl { virtual void threadMain(); virtual void exitThreadMain(); + virtual void Close() = 0; + protected: virtual bool Connect() = 0; virtual void Disconnect() = 0; diff --git a/src/components/media_manager/src/audio/from_mic_to_file_recorder_thread.cc b/src/components/media_manager/src/audio/from_mic_to_file_recorder_thread.cc index 0239795d75..99548e71bd 100644 --- a/src/components/media_manager/src/audio/from_mic_to_file_recorder_thread.cc +++ b/src/components/media_manager/src/audio/from_mic_to_file_recorder_thread.cc @@ -32,6 +32,7 @@ #include "media_manager/audio/from_mic_to_file_recorder_thread.h" #include <unistd.h> +#include <cstring> #include <sstream> #include "utils/logger.h" @@ -88,11 +89,23 @@ void FromMicToFileRecorderThread::initArgs() { argv_[3] = new gchar[3]; argv_[4] = new gchar[durationString_.length() + 1]; - argv_[0] = const_cast<gchar*>(std::string("AudioManager").c_str()); - argv_[1] = const_cast<gchar*>(oKey_.c_str()); - argv_[2] = const_cast<gchar*>(outputFileName_.c_str()); - argv_[3] = const_cast<gchar*>(tKey_.c_str()); - argv_[4] = const_cast<gchar*>(durationString_.c_str()); + std::strcpy(argv_[0], "AudioManager"); + std::strcpy(argv_[1], oKey_.c_str()); + std::strcpy(argv_[2], outputFileName_.c_str()); + std::strcpy(argv_[3], tKey_.c_str()); + std::strcpy(argv_[4], durationString_.c_str()); +} + +void FromMicToFileRecorderThread::deinitArgs() { + LOG4CXX_AUTO_TRACE(logger_); + + if (argv_) { + for (int32_t i = 0; i < argc_; i++) { + delete[] argv_[i]; + } + delete[] argv_; + argv_ = NULL; + } } void FromMicToFileRecorderThread::threadMain() { @@ -136,6 +149,13 @@ void FromMicToFileRecorderThread::threadMain() { "length of time in seconds to capture", "int32_t"}, {NULL}}; + // g_option_context_parse() modifies params, so keep argc_ and argv_ + int32_t argc = argc_; + gchar** argv = new gchar* [argc]; + for (int32_t i = 0; i < argc; i++) { + argv[i] = argv_[i]; + } + #ifndef GLIB_VERSION_2_32 // g_thread_init() does nothing since 2.32 if (!g_thread_supported()) { g_thread_init(NULL); @@ -145,7 +165,7 @@ void FromMicToFileRecorderThread::threadMain() { context = g_option_context_new("-- M-AUDIO RAW"); g_option_context_add_main_entries(context, entries, NULL); g_option_context_add_group(context, gst_init_get_option_group()); - if (!g_option_context_parse(context, &argc_, &argv_, &err)) { + if (!g_option_context_parse(context, &argc, &argv, &err)) { g_error("%s\n", err->message); } @@ -159,7 +179,10 @@ void FromMicToFileRecorderThread::threadMain() { LOG4CXX_TRACE(logger_, "Duration set to: " << duration); // Initialize gstreamer and setup the main loop information - gst_init(&argc_, &argv_); + gst_init(&argc, &argv); + + delete[] argv; + argv = NULL; pipeline = gst_pipeline_new("vga2usb-h264"); @@ -207,10 +230,7 @@ void FromMicToFileRecorderThread::threadMain() { gst_object_unref(GST_OBJECT(pipeline)); g_option_context_free(context); - if (argv_) { - delete[] argv_; - argv_ = NULL; - } + deinitArgs(); return; } } @@ -238,10 +258,7 @@ void FromMicToFileRecorderThread::threadMain() { g_main_loop_unref(loop); g_option_context_free(context); - if (argv_) { - delete[] argv_; - argv_ = NULL; - } + deinitArgs(); loop = NULL; } diff --git a/src/components/media_manager/src/socket_streamer_adapter.cc b/src/components/media_manager/src/socket_streamer_adapter.cc index 2bb0fe10ec..60b01c901b 100644 --- a/src/components/media_manager/src/socket_streamer_adapter.cc +++ b/src/components/media_manager/src/socket_streamer_adapter.cc @@ -108,13 +108,21 @@ bool SocketStreamerAdapter::SocketStreamer::Connect() { return true; } +void SocketStreamerAdapter::SocketStreamer::Close() { + Disconnect(); +} + void SocketStreamerAdapter::SocketStreamer::Disconnect() { LOG4CXX_AUTO_TRACE(logger); if (0 < send_socket_fd_) { + shutdown(send_socket_fd_, SHUT_RDWR); close(send_socket_fd_); + send_socket_fd_ = 0; } if (0 < socket_fd_) { + shutdown(socket_fd_, SHUT_RDWR); close(socket_fd_); + socket_fd_ = 0; } } diff --git a/src/components/media_manager/src/streamer_adapter.cc b/src/components/media_manager/src/streamer_adapter.cc index 20c067da1c..90a40b1add 100644 --- a/src/components/media_manager/src/streamer_adapter.cc +++ b/src/components/media_manager/src/streamer_adapter.cc @@ -44,9 +44,12 @@ StreamerAdapter::StreamerAdapter(Streamer* const streamer) } StreamerAdapter::~StreamerAdapter() { - delete streamer_; + if (streamer_) { + streamer_->Close(); + } thread_->join(); threads::DeleteThread(thread_); + delete streamer_; } void StreamerAdapter::StartActivity(int32_t application_key) { diff --git a/src/components/media_manager/test/media_manager_impl_test.cc b/src/components/media_manager/test/media_manager_impl_test.cc index 7d0226fa67..a9dc27d7a3 100644 --- a/src/components/media_manager/test/media_manager_impl_test.cc +++ b/src/components/media_manager/test/media_manager_impl_test.cc @@ -123,10 +123,12 @@ class MediaManagerImplTest : public ::testing::Test { .WillOnce(Return(mock_app_)); EXPECT_CALL(mock_media_manager_settings_, app_storage_folder()) .WillOnce(ReturnRef(kStorageFolder)); +#ifndef EXTENDED_MEDIA_MODE EXPECT_CALL(mock_media_manager_settings_, app_resource_folder()) .WillOnce(ReturnRef(kResourceFolder)); EXPECT_CALL(mock_media_manager_settings_, recording_file_source()) .WillOnce(ReturnRef(kRecordingFileSource)); +#endif } void InitMediaManagerPrecondition(const std::string& server_type) { diff --git a/src/components/policy/policy_external/include/policy/cache_manager.h b/src/components/policy/policy_external/include/policy/cache_manager.h index 428a9bd2f6..aa5360d2b7 100644 --- a/src/components/policy/policy_external/include/policy/cache_manager.h +++ b/src/components/policy/policy_external/include/policy/cache_manager.h @@ -731,6 +731,13 @@ class CacheManager : public CacheManagerInterface { */ void ResetCalculatedPermissionsForDevice(const std::string& device_id); + /** + * @brief Transform to lower case all non default application names in + * applications policies section + * @param pt polict rable for update + */ + void MakeLowerCaseAppNames(policy_table::Table& pt) const; + void AddCalculatedPermissions(const std::string& device_id, const std::string& policy_app_id, const policy::Permissions& permissions); diff --git a/src/components/policy/policy_external/include/policy/policy_helper.h b/src/components/policy/policy_external/include/policy/policy_helper.h index 42c1ec0b46..6945f45b45 100644 --- a/src/components/policy/policy_external/include/policy/policy_helper.h +++ b/src/components/policy/policy_external/include/policy/policy_helper.h @@ -199,6 +199,23 @@ struct CheckAppPolicy { CheckAppPolicyResults& out_results_; }; +/** + * @brief Helper struct for filling actions to be done for processed application + * using CheckAppPolicyResults data as a source + */ +struct FillActionsForAppPolicies { + FillActionsForAppPolicies( + ApplicationsPoliciesActions& actions, + const policy_table::ApplicationPolicies& app_policies) + : actions_(actions), app_policies_(app_policies) {} + + void operator()(const policy::CheckAppPolicyResults::value_type& value); + + private: + ApplicationsPoliciesActions& actions_; + const policy_table::ApplicationPolicies& app_policies_; +}; + /* * @brief Fill permissions data with merged rpc permissions for hmi levels and * parameters diff --git a/src/components/policy/policy_external/include/policy/policy_manager_impl.h b/src/components/policy/policy_external/include/policy/policy_manager_impl.h index f8d226c86a..80ceb06e7e 100644 --- a/src/components/policy/policy_external/include/policy/policy_manager_impl.h +++ b/src/components/policy/policy_external/include/policy/policy_manager_impl.h @@ -719,8 +719,9 @@ class PolicyManagerImpl : public PolicyManager { /** * @brief Processes results from policy table update analysis done by - * CheckPermissionsChanges() by sending OnPermissionChange and - * OnAppPermissionChanged notifications + * CheckPermissionsChanges() by filling ApplicationsPoliciesActions struct + * with actions which should be done for every application and passes them to + * ProcessActionsForAppPolicies() * @param results Collection of per-application results * @param app_policies Reference to updated application policies section as * a data source for generating notifications data @@ -730,6 +731,19 @@ class PolicyManagerImpl : public PolicyManager { const policy_table::ApplicationPolicies& app_policies); /** + * @brief Processes actions filled in ProcessAppPolicyCheckResults() for every + * application by sending OnPermissionChange and OnAppPermissionChanged + * notifications and by checking consent where it needed + * @param actions Reference to map with actions to be done or not for every + * application + * @param app_policies Reference to updated application policies section as + * a data source for generating notifications data + */ + void ProcessActionsForAppPolicies( + const ApplicationsPoliciesActions& actions, + const policy_table::ApplicationPolicies& app_policies); + + /** * @brief Fill structure to be sent with OnPermissionsChanged notification * * @param Policy table struct, which contains rpc functional groups data diff --git a/src/components/policy/policy_external/include/policy/policy_types.h b/src/components/policy/policy_external/include/policy/policy_types.h index 9ba1a1cfff..f57919b6f7 100644 --- a/src/components/policy/policy_external/include/policy/policy_types.h +++ b/src/components/policy/policy_external/include/policy/policy_types.h @@ -432,6 +432,28 @@ struct ExternalConsentStatusItemSorter { }; /** + * @brief The ApplicationPolicyActions struct contains actions which should be + * done for some application + */ +struct ApplicationPolicyActions { + ApplicationPolicyActions() + : is_notify_system(false) + , is_send_permissions_to_app(false) + , is_consent_needed(false) {} + + bool is_notify_system; + bool is_send_permissions_to_app; + bool is_consent_needed; +}; + +/** + * @brief ApplicationsPoliciesActions map of actions to be done for every + * application + */ +typedef std::map<std::string, ApplicationPolicyActions> + ApplicationsPoliciesActions; + +/** * @brief Customer connectivity settings status */ typedef std::set<ExternalConsentStatusItem, ExternalConsentStatusItemSorter> diff --git a/src/components/policy/policy_external/src/cache_manager.cc b/src/components/policy/policy_external/src/cache_manager.cc index 22040c88b2..b5e44014dd 100644 --- a/src/components/policy/policy_external/src/cache_manager.cc +++ b/src/components/policy/policy_external/src/cache_manager.cc @@ -340,7 +340,10 @@ const policy_table::AppHMITypes* CacheManager::GetHMITypes( pt_->policy_table.app_policies_section.apps; policy_table::ApplicationPolicies::const_iterator i = apps.find(app_id); if (i != apps.end()) { - return &(*i->second.AppHMIType); + const policy_table::AppHMITypes& app_hmi_types = *i->second.AppHMIType; + if (app_hmi_types.is_initialized()) { + return &app_hmi_types; + } } return NULL; } @@ -630,7 +633,7 @@ void CacheManager::ProcessUpdate( *(initial_policy_iter->second.RequestType); const std::string& app_id = initial_policy_iter->first; - RequestTypes merged_pt_request_types; + bool update_request_types = true; if (app_id == kDefaultId || app_id == kPreDataConsentId) { if (new_request_types.is_omitted()) { @@ -638,25 +641,28 @@ void CacheManager::ProcessUpdate( "Application " << app_id << " has omitted RequestTypes." " Previous values will be kept."); - return; - } - if (new_request_types.empty()) { + update_request_types = false; + } else if (new_request_types.empty()) { if (new_request_types.is_cleaned_up()) { LOG4CXX_INFO(logger_, "Application " << app_id << " has cleaned up all values." " Previous values will be kept."); - return; + update_request_types = false; + } else { + LOG4CXX_INFO(logger_, + "Application " << app_id + << " has empty RequestTypes." + " Any parameter will be allowed."); } - LOG4CXX_INFO(logger_, - "Application " << app_id - << " has empty RequestTypes." - " Any parameter will be allowed."); } - merged_pt_request_types = new_request_types; - } else { - merged_pt_request_types = new_request_types; } + + const RequestTypes merged_pt_request_types = + update_request_types + ? new_request_types + : *(pt_->policy_table.app_policies_section.apps[app_id].RequestType); + pt_->policy_table.app_policies_section.apps[app_id] = initial_policy_iter->second; *(pt_->policy_table.app_policies_section.apps[app_id].RequestType) = @@ -682,15 +688,6 @@ bool CacheManager::ApplyUpdate(const policy_table::Table& update_pt) { pt_->policy_table.app_policies_section.apps[iter->first].set_to_null(); pt_->policy_table.app_policies_section.apps[iter->first].set_to_string( ""); - } else if (policy::kDefaultId == (iter->second).get_string()) { - policy_table::ApplicationPolicies::const_iterator iter_default = - update_pt.policy_table.app_policies_section.apps.find(kDefaultId); - if (update_pt.policy_table.app_policies_section.apps.end() == - iter_default) { - LOG4CXX_ERROR(logger_, "The default section was not found in PTU"); - continue; - } - ProcessUpdate(iter_default); } else { ProcessUpdate(iter); } @@ -2252,6 +2249,27 @@ void CacheManager::FillDeviceSpecificData() { } } +void CacheManager::MakeLowerCaseAppNames(policy_table::Table& pt) const { + policy_table::ApplicationPolicies& apps = + pt.policy_table.app_policies_section.apps; + for (policy_table::ApplicationPolicies::iterator iter = apps.begin(); + iter != apps.end();) { + std::string key = iter->first; + if (key == kDefaultId || key == kPreDataConsentId || key == kDeviceId) { + ++iter; + continue; + } + + std::transform(key.begin(), key.end(), key.begin(), ::tolower); + if (key.compare(iter->first) != 0) { + std::swap(apps[key], iter->second); + iter = apps.erase(iter); + } else { + ++iter; + } + } +} + bool CacheManager::LoadFromBackup() { sync_primitives::AutoLock lock(cache_lock_); pt_ = backup_->GenerateSnapshot(); @@ -2294,6 +2312,8 @@ bool CacheManager::LoadFromFile(const std::string& file_name, "Policy table content loaded:" << s_writer.write(table.ToJsonValue())); #endif // ENABLE_LOG + MakeLowerCaseAppNames(table); + if (!table.is_valid()) { rpc::ValidationReport report("policy_table"); table.ReportErrors(&report); diff --git a/src/components/policy/policy_external/src/policy_helper.cc b/src/components/policy/policy_external/src/policy_helper.cc index 3041323489..5425777833 100644 --- a/src/components/policy/policy_external/src/policy_helper.cc +++ b/src/components/policy/policy_external/src/policy_helper.cc @@ -484,6 +484,41 @@ bool CheckAppPolicy::IsRequestTypeChanged( return diff.size(); } +void FillActionsForAppPolicies::operator()( + const policy::CheckAppPolicyResults::value_type& value) { + const std::string app_id = value.first; + const policy_table::ApplicationPolicies::const_iterator app_policy = + app_policies_.find(app_id); + + if (app_policies_.end() == app_policy) { + return; + } + + if (IsPredefinedApp(*app_policy)) { + return; + } + + switch (value.second) { + case RESULT_APP_REVOKED: + case RESULT_NICKNAME_MISMATCH: + actions_[app_id].is_notify_system = true; + return; + case RESULT_CONSENT_NEEDED: + case RESULT_PERMISSIONS_REVOKED_AND_CONSENT_NEEDED: + actions_[app_id].is_consent_needed = true; + break; + case RESULT_CONSENT_NOT_REQIURED: + case RESULT_PERMISSIONS_REVOKED: + case RESULT_REQUEST_TYPE_CHANGED: + break; + case RESULT_NO_CHANGES: + default: + return; + } + actions_[app_id].is_notify_system = true; + actions_[app_id].is_send_permissions_to_app = true; +} + FillNotificationData::FillNotificationData(Permissions& data, GroupConsent group_state, GroupConsent undefined_group_consent, diff --git a/src/components/policy/policy_external/src/policy_manager_impl.cc b/src/components/policy/policy_external/src/policy_manager_impl.cc index 8a80e7755b..d50779383a 100644 --- a/src/components/policy/policy_external/src/policy_manager_impl.cc +++ b/src/components/policy/policy_external/src/policy_manager_impl.cc @@ -385,53 +385,45 @@ CheckAppPolicyResults PolicyManagerImpl::CheckPermissionsChanges( void PolicyManagerImpl::ProcessAppPolicyCheckResults( const CheckAppPolicyResults& results, const policy_table::ApplicationPolicies& app_policies) { - CheckAppPolicyResults::const_iterator it_results = results.begin(); + ApplicationsPoliciesActions actions_for_apps_policies; + FillActionsForAppPolicies filler(actions_for_apps_policies, app_policies); - for (; results.end() != it_results; ++it_results) { - const policy_table::ApplicationPolicies::const_iterator app_policy = - app_policies.find(it_results->first); + std::for_each(results.begin(), results.end(), filler); + ProcessActionsForAppPolicies(actions_for_apps_policies, app_policies); +} + +void PolicyManagerImpl::ProcessActionsForAppPolicies( + const ApplicationsPoliciesActions& actions, + const policy_table::ApplicationPolicies& app_policies) { + ApplicationsPoliciesActions::const_iterator it_actions = actions.begin(); + for (; it_actions != actions.end(); ++it_actions) { + policy_table::ApplicationPolicies::const_iterator app_policy = + app_policies.find(it_actions->first); if (app_policies.end() == app_policy) { continue; } - if (IsPredefinedApp(*app_policy)) { - continue; - } + if (it_actions->second.is_consent_needed) { + // Post-check after ExternalConsent consent changes + const std::string& policy_app_id = app_policy->first; + if (!IsConsentNeeded(policy_app_id)) { + sync_primitives::AutoLock lock(app_permissions_diff_lock_); - switch (it_results->second) { - case RESULT_NO_CHANGES: - continue; - case RESULT_APP_REVOKED: - NotifySystem(*app_policy); - continue; - case RESULT_NICKNAME_MISMATCH: - NotifySystem(*app_policy); - continue; - case RESULT_CONSENT_NEEDED: - case RESULT_PERMISSIONS_REVOKED_AND_CONSENT_NEEDED: { - // Post-check after ExternalConsent consent changes - const std::string policy_app_id = app_policy->first; - if (!IsConsentNeeded(policy_app_id)) { - sync_primitives::AutoLock lock(app_permissions_diff_lock_); - - PendingPermissions::iterator app_id_diff = - app_permissions_diff_.find(policy_app_id); - - if (app_permissions_diff_.end() != app_id_diff) { - app_id_diff->second.appPermissionsConsentNeeded = false; - } + PendingPermissions::iterator app_id_diff = + app_permissions_diff_.find(policy_app_id); + + if (app_permissions_diff_.end() != app_id_diff) { + app_id_diff->second.appPermissionsConsentNeeded = false; } - } break; - case RESULT_CONSENT_NOT_REQIURED: - case RESULT_PERMISSIONS_REVOKED: - case RESULT_REQUEST_TYPE_CHANGED: - break; - default: - continue; + } + } + if (it_actions->second.is_notify_system) { + NotifySystem(*app_policy); + } + if (it_actions->second.is_send_permissions_to_app) { + SendPermissionsToApp(*app_policy); } - NotifySystem(*app_policy); - SendPermissionsToApp(*app_policy); } } diff --git a/src/components/policy/policy_external/src/sql_pt_queries.cc b/src/components/policy/policy_external/src/sql_pt_queries.cc index e3e1029692..4afce16885 100644 --- a/src/components/policy/policy_external/src/sql_pt_queries.cc +++ b/src/components/policy/policy_external/src/sql_pt_queries.cc @@ -137,7 +137,7 @@ const std::string kCreateSchema = "CREATE INDEX `rpc.select_rpc_name_hmi_level` " " ON `rpc`(`name`,`hmi_level_value`);" "CREATE TABLE IF NOT EXISTS `application`( " - " `id` VARCHAR(45) PRIMARY KEY NOT NULL, " + " `id` VARCHAR(45) PRIMARY KEY NOT NULL COLLATE NOCASE, " " `keep_context` BOOLEAN, " " `steal_focus` BOOLEAN, " " `default_hmi` VARCHAR(45), " @@ -160,7 +160,7 @@ const std::string kCreateSchema = "CREATE INDEX IF NOT EXISTS `application.fk_application_priorities1_idx` " " ON `application`(`priority_value`); " "CREATE TABLE IF NOT EXISTS `app_group`( " - " `application_id` VARCHAR(45) NOT NULL, " + " `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, " " `functional_group_id` INTEGER NOT NULL, " " PRIMARY KEY(`application_id`,`functional_group_id`), " " CONSTRAINT `fk_application_has_functional_group_application1` " @@ -175,9 +175,9 @@ const std::string kCreateSchema = " ON `app_group`(`functional_group_id`); " "CREATE INDEX IF NOT EXISTS " "`app_group.fk_application_has_functional_group_application1_idx` " - " ON `app_group`(`application_id`); " + " ON `app_group`(`application_id` COLLATE NOCASE); " "CREATE TABLE IF NOT EXISTS `preconsented_group`( " - " `application_id` VARCHAR(45) NOT NULL, " + " `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, " " `functional_group_id` INTEGER NOT NULL, " " PRIMARY KEY(`application_id`,`functional_group_id`), " " CONSTRAINT `fk_application_has_functional_group_application2` " @@ -193,7 +193,7 @@ const std::string kCreateSchema = " ON `preconsented_group`(`functional_group_id`); " "CREATE INDEX IF NOT EXISTS " "`preconsented_group.fk_application_has_functional_group_application2_idx` " - " ON `preconsented_group`(`application_id`); " + " ON `preconsented_group`(`application_id` COLLATE NOCASE); " "CREATE TABLE IF NOT EXISTS `seconds_between_retry`( " " `index` INTEGER PRIMARY KEY NOT NULL, " " `value` INTEGER NOT NULL " @@ -220,7 +220,7 @@ const std::string kCreateSchema = "`device_consent_group.fk_device_has_functional_group_device1_idx` " " ON `device_consent_group`(`device_id`); " "CREATE TABLE IF NOT EXISTS `app_level`( " - " `application_id` VARCHAR(45) PRIMARY KEY NOT NULL, " + " `application_id` VARCHAR(45) PRIMARY KEY NOT NULL COLLATE NOCASE, " " `minutes_in_hmi_full` INTEGER DEFAULT 0, " " `minutes_in_hmi_limited` INTEGER DEFAULT 0, " " `minutes_in_hmi_background` INTEGER DEFAULT 0, " @@ -247,24 +247,24 @@ const std::string kCreateSchema = " REFERENCES `language`(`code`) " "); " "CREATE INDEX IF NOT EXISTS `app_level.fk_app_levels_application1_idx` " - " ON `app_level`(`application_id`); " + " ON `app_level`(`application_id` COLLATE NOCASE); " "CREATE INDEX IF NOT EXISTS `app_level.fk_app_level_language1_idx` " " ON `app_level`(`app_registration_language_gui`); " "CREATE INDEX IF NOT EXISTS `app_level.fk_app_level_language2_idx` " " ON `app_level`(`app_registration_language_vui`); " "CREATE TABLE IF NOT EXISTS `nickname`( " - " `name` VARCHAR(100) NOT NULL, " - " `application_id` VARCHAR(45) NOT NULL, " + " `name` VARCHAR(100) NOT NULL COLLATE NOCASE, " + " `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, " " PRIMARY KEY(`name`,`application_id`), " " CONSTRAINT `fk_nickname_application1` " " FOREIGN KEY(`application_id`) " " REFERENCES `application`(`id`) " "); " "CREATE INDEX IF NOT EXISTS `nickname.fk_nickname_application1_idx` " - " ON `nickname`(`application_id`); " + " ON `nickname`(`application_id` COLLATE NOCASE); " "CREATE TABLE IF NOT EXISTS `app_type`( " " `name` VARCHAR(50) NOT NULL, " - " `application_id` VARCHAR(45) NOT NULL, " + " `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, " " PRIMARY KEY(`name`,`application_id`), " " CONSTRAINT `fk_app_type_application1` " " FOREIGN KEY(`application_id`) " @@ -272,17 +272,17 @@ const std::string kCreateSchema = "); " "CREATE TABLE IF NOT EXISTS `request_type`( " " `request_type` VARCHAR(50) NOT NULL, " - " `application_id` VARCHAR(45) NOT NULL, " + " `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, " " PRIMARY KEY(`request_type`,`application_id`), " " CONSTRAINT `fk_app_type_application1` " " FOREIGN KEY(`application_id`) " " REFERENCES `application`(`id`) " "); " "CREATE INDEX IF NOT EXISTS `app_type.fk_app_type_application1_idx` " - " ON `app_type`(`application_id`); " + " ON `app_type`(`application_id` COLLATE NOCASE); " "CREATE TABLE IF NOT EXISTS `consent_group`( " " `device_id` VARCHAR(100) NOT NULL, " - " `application_id` VARCHAR(45) NOT NULL, " + " `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, " " `functional_group_id` INTEGER NOT NULL, " " `is_consented` BOOL NOT NULL, " " `input` VARCHAR(45), " @@ -301,7 +301,7 @@ const std::string kCreateSchema = "); " "CREATE TABLE IF NOT EXISTS `external_consent_status_group`( " " `device_id` VARCHAR(100) NOT NULL, " - " `application_id` VARCHAR(45) NOT NULL, " + " `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, " " `functional_group_id` INTEGER NOT NULL, " " `is_consented` BOOL NOT NULL, " " `input` VARCHAR(45), " @@ -327,13 +327,13 @@ const std::string kCreateSchema = "CREATE TABLE IF NOT EXISTS `endpoint`( " " `service` INTEGER NOT NULL, " " `url` VARCHAR(100) NOT NULL, " - " `application_id` VARCHAR(45) NOT NULL, " + " `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, " " CONSTRAINT `fk_endpoint_application1` " " FOREIGN KEY(`application_id`) " " REFERENCES `application`(`id`) " "); " "CREATE INDEX IF NOT EXISTS `endpoint.fk_endpoint_application1_idx` " - " ON `endpoint`(`application_id`); " + " ON `endpoint`(`application_id` COLLATE NOCASE); " "CREATE TABLE IF NOT EXISTS `message`( " " `id` INTEGER PRIMARY KEY NOT NULL, " " `tts` TEXT, " @@ -374,14 +374,14 @@ const std::string kCreateSchema = /* module type */ "CREATE TABLE IF NOT EXISTS `module_type`( " " `name` VARCHAR(50) NOT NULL, " - " `application_id` VARCHAR(45) NOT NULL, " + " `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, " " PRIMARY KEY(`name`,`application_id`), " " CONSTRAINT `fk_module_type_application1` " " FOREIGN KEY(`application_id`) " " REFERENCES `application`(`id`) " "); " "CREATE INDEX IF NOT EXISTS `module_type.fk_module_type_application1_idx` " - " ON `module_type`(`application_id`); " + " ON `module_type`(`application_id` COLLATE NOCASE); " "CREATE INDEX IF NOT EXISTS `message.fk_messages_languages1_idx` " " ON `message`(`language_code`);" diff --git a/src/components/policy/policy_external/test/policy_manager_impl_ptu_test.cc b/src/components/policy/policy_external/test/policy_manager_impl_ptu_test.cc index c958f6bcd7..da0cd913b6 100644 --- a/src/components/policy/policy_external/test/policy_manager_impl_ptu_test.cc +++ b/src/components/policy/policy_external/test/policy_manager_impl_ptu_test.cc @@ -1344,7 +1344,7 @@ TEST_F(PolicyManagerImplTest2, // Add app policy_manager_->AddApplication(section_name, HmiTypes(policy_table::AHT_DEFAULT)); - EXPECT_CALL(listener_, OnPendingPermissionChange(section_name)).Times(2); + EXPECT_CALL(listener_, OnPendingPermissionChange(section_name)); // PTU has single invalid RequestTypes, which must be dropped and replaced // with default RT diff --git a/src/components/policy/policy_regular/include/policy/cache_manager.h b/src/components/policy/policy_regular/include/policy/cache_manager.h index c5d4c848f4..44827e2602 100644 --- a/src/components/policy/policy_regular/include/policy/cache_manager.h +++ b/src/components/policy/policy_regular/include/policy/cache_manager.h @@ -722,6 +722,13 @@ class CacheManager : public CacheManagerInterface { void PersistData(); + /** + * @brief Transform to lower case all non default application names in + * applications policies section + * @param pt polict rable for update + */ + void MakeLowerCaseAppNames(policy_table::Table& pt) const; + void ResetCalculatedPermissions(); void AddCalculatedPermissions(const std::string& device_id, diff --git a/src/components/policy/policy_regular/src/cache_manager.cc b/src/components/policy/policy_regular/src/cache_manager.cc index 78674c81f3..98652656c3 100644 --- a/src/components/policy/policy_regular/src/cache_manager.cc +++ b/src/components/policy/policy_regular/src/cache_manager.cc @@ -36,6 +36,7 @@ #include <functional> #include <ctime> #include <cmath> +#include <sstream> #include "utils/file_system.h" #include "json/reader.h" @@ -133,7 +134,10 @@ const policy_table::AppHMITypes* CacheManager::GetHMITypes( pt_->policy_table.app_policies_section.apps; policy_table::ApplicationPolicies::const_iterator i = apps.find(app_id); if (i != apps.end()) { - return &(*i->second.AppHMIType); + const policy_table::AppHMITypes& app_hmi_types = *i->second.AppHMIType; + if (app_hmi_types.is_initialized()) { + return &app_hmi_types; + } } return NULL; } @@ -238,16 +242,6 @@ bool CacheManager::ApplyUpdate(const policy_table::Table& update_pt) { pt_->policy_table.app_policies_section.apps[iter->first].set_to_null(); pt_->policy_table.app_policies_section.apps[iter->first].set_to_string( ""); - } else if (policy::kDefaultId == (iter->second).get_string()) { - policy_table::ApplicationPolicies::const_iterator iter_default = - update_pt.policy_table.app_policies_section.apps.find(kDefaultId); - if (update_pt.policy_table.app_policies_section.apps.end() == - iter_default) { - LOG4CXX_ERROR(logger_, "The default section was not found in PTU"); - continue; - } - pt_->policy_table.app_policies_section.apps[iter->first] = - iter_default->second; } else { pt_->policy_table.app_policies_section.apps[iter->first] = iter->second; } @@ -1404,6 +1398,27 @@ bool CacheManager::LoadFromBackup() { return true; } +void CacheManager::MakeLowerCaseAppNames(policy_table::Table& pt) const { + policy_table::ApplicationPolicies& apps = + pt.policy_table.app_policies_section.apps; + for (policy_table::ApplicationPolicies::iterator iter = apps.begin(); + iter != apps.end();) { + std::string key = iter->first; + if (key == kDefaultId || key == kPreDataConsentId || key == kDeviceId) { + ++iter; + continue; + } + + std::transform(key.begin(), key.end(), key.begin(), ::tolower); + if (key.compare(iter->first) != 0) { + std::swap(apps[key], iter->second); + iter = apps.erase(iter); + } else { + ++iter; + } + } +} + bool CacheManager::LoadFromFile(const std::string& file_name, policy_table::Table& table) { LOG4CXX_AUTO_TRACE(logger_); @@ -1432,6 +1447,8 @@ bool CacheManager::LoadFromFile(const std::string& file_name, LOG4CXX_DEBUG(logger_, "PT out:"); LOG4CXX_DEBUG(logger_, s_writer.write(table.ToJsonValue())); + MakeLowerCaseAppNames(table); + if (!table.is_valid()) { rpc::ValidationReport report("policy_table"); table.ReportErrors(&report); @@ -1439,6 +1456,7 @@ bool CacheManager::LoadFromFile(const std::string& file_name, "Parsed table is not valid " << rpc::PrettyFormat(report)); return false; } + return true; } diff --git a/src/components/policy/policy_regular/src/sql_pt_queries.cc b/src/components/policy/policy_regular/src/sql_pt_queries.cc index 7938eb4085..ef4ef49273 100644 --- a/src/components/policy/policy_regular/src/sql_pt_queries.cc +++ b/src/components/policy/policy_regular/src/sql_pt_queries.cc @@ -123,7 +123,7 @@ const std::string kCreateSchema = "CREATE INDEX `rpc.select_rpc_name_hmi_level` " " ON `rpc`(`name`,`hmi_level_value`);" "CREATE TABLE IF NOT EXISTS `application`( " - " `id` VARCHAR(45) PRIMARY KEY NOT NULL, " + " `id` VARCHAR(45) PRIMARY KEY NOT NULL COLLATE NOCASE, " " `keep_context` BOOLEAN, " " `steal_focus` BOOLEAN, " " `default_hmi` VARCHAR(45), " @@ -147,7 +147,7 @@ const std::string kCreateSchema = "CREATE INDEX IF NOT EXISTS `application.fk_application_priorities1_idx` " " ON `application`(`priority_value`); " "CREATE TABLE IF NOT EXISTS `app_group`( " - " `application_id` VARCHAR(45) NOT NULL, " + " `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, " " `functional_group_id` INTEGER NOT NULL, " " PRIMARY KEY(`application_id`,`functional_group_id`), " " CONSTRAINT `fk_application_has_functional_group_application1` " @@ -162,9 +162,9 @@ const std::string kCreateSchema = " ON `app_group`(`functional_group_id`); " "CREATE INDEX IF NOT EXISTS " "`app_group.fk_application_has_functional_group_application1_idx` " - " ON `app_group`(`application_id`); " + " ON `app_group`(`application_id` COLLATE NOCASE); " "CREATE TABLE IF NOT EXISTS `preconsented_group`( " - " `application_id` VARCHAR(45) NOT NULL, " + " `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, " " `functional_group_id` INTEGER NOT NULL, " " PRIMARY KEY(`application_id`,`functional_group_id`), " " CONSTRAINT `fk_application_has_functional_group_application2` " @@ -180,7 +180,7 @@ const std::string kCreateSchema = " ON `preconsented_group`(`functional_group_id`); " "CREATE INDEX IF NOT EXISTS " "`preconsented_group.fk_application_has_functional_group_application2_idx` " - " ON `preconsented_group`(`application_id`); " + " ON `preconsented_group`(`application_id` COLLATE NOCASE); " "CREATE TABLE IF NOT EXISTS `seconds_between_retry`( " " `index` INTEGER PRIMARY KEY NOT NULL, " " `value` INTEGER NOT NULL " @@ -207,7 +207,7 @@ const std::string kCreateSchema = "`device_consent_group.fk_device_has_functional_group_device1_idx` " " ON `device_consent_group`(`device_id`); " "CREATE TABLE IF NOT EXISTS `app_level`( " - " `application_id` VARCHAR(45) PRIMARY KEY NOT NULL, " + " `application_id` VARCHAR(45) PRIMARY KEY NOT NULL COLLATE NOCASE, " " `minutes_in_hmi_full` INTEGER DEFAULT 0, " " `minutes_in_hmi_limited` INTEGER DEFAULT 0, " " `minutes_in_hmi_background` INTEGER DEFAULT 0, " @@ -234,24 +234,24 @@ const std::string kCreateSchema = " REFERENCES `language`(`code`) " "); " "CREATE INDEX IF NOT EXISTS `app_level.fk_app_levels_application1_idx` " - " ON `app_level`(`application_id`); " + " ON `app_level`(`application_id` COLLATE NOCASE); " "CREATE INDEX IF NOT EXISTS `app_level.fk_app_level_language1_idx` " " ON `app_level`(`app_registration_language_gui`); " "CREATE INDEX IF NOT EXISTS `app_level.fk_app_level_language2_idx` " " ON `app_level`(`app_registration_language_vui`); " "CREATE TABLE IF NOT EXISTS `nickname`( " - " `name` VARCHAR(100) NOT NULL, " - " `application_id` VARCHAR(45) NOT NULL, " + " `name` VARCHAR(100) NOT NULL COLLATE NOCASE, " + " `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, " " PRIMARY KEY(`name`,`application_id`), " " CONSTRAINT `fk_nickname_application1` " " FOREIGN KEY(`application_id`) " " REFERENCES `application`(`id`) " "); " "CREATE INDEX IF NOT EXISTS `nickname.fk_nickname_application1_idx` " - " ON `nickname`(`application_id`); " + " ON `nickname`(`application_id` COLLATE NOCASE); " "CREATE TABLE IF NOT EXISTS `app_type`( " " `name` VARCHAR(50) NOT NULL, " - " `application_id` VARCHAR(45) NOT NULL, " + " `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, " " PRIMARY KEY(`name`,`application_id`), " " CONSTRAINT `fk_app_type_application1` " " FOREIGN KEY(`application_id`) " @@ -259,17 +259,17 @@ const std::string kCreateSchema = "); " "CREATE TABLE IF NOT EXISTS `request_type`( " " `request_type` VARCHAR(50) NOT NULL, " - " `application_id` VARCHAR(45) NOT NULL, " + " `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, " " PRIMARY KEY(`request_type`,`application_id`), " " CONSTRAINT `fk_app_type_application1` " " FOREIGN KEY(`application_id`) " " REFERENCES `application`(`id`) " "); " "CREATE INDEX IF NOT EXISTS `app_type.fk_app_type_application1_idx` " - " ON `app_type`(`application_id`); " + " ON `app_type`(`application_id` COLLATE NOCASE); " "CREATE TABLE IF NOT EXISTS `consent_group`( " " `device_id` VARCHAR(100) NOT NULL, " - " `application_id` VARCHAR(45) NOT NULL, " + " `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, " " `functional_group_id` INTEGER NOT NULL, " " `is_consented` BOOL NOT NULL, " " `input` VARCHAR(45), " @@ -294,13 +294,13 @@ const std::string kCreateSchema = "CREATE TABLE IF NOT EXISTS `endpoint`( " " `service` VARCHAR(100) NOT NULL, " " `url` VARCHAR(100) NOT NULL, " - " `application_id` VARCHAR(45) NOT NULL, " + " `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, " " CONSTRAINT `fk_endpoint_application1` " " FOREIGN KEY(`application_id`) " " REFERENCES `application`(`id`) " "); " "CREATE INDEX IF NOT EXISTS `endpoint.fk_endpoint_application1_idx` " - " ON `endpoint`(`application_id`); " + " ON `endpoint`(`application_id` COLLATE NOCASE); " "CREATE TABLE IF NOT EXISTS `message`( " " `id` INTEGER PRIMARY KEY NOT NULL, " " `tts` TEXT, " diff --git a/src/components/protocol_handler/include/protocol_handler/protocol_handler_impl.h b/src/components/protocol_handler/include/protocol_handler/protocol_handler_impl.h index 7521137d5a..c5a45c0dfe 100644 --- a/src/components/protocol_handler/include/protocol_handler/protocol_handler_impl.h +++ b/src/components/protocol_handler/include/protocol_handler/protocol_handler_impl.h @@ -247,7 +247,7 @@ class ProtocolHandlerImpl */ void SendStartSessionAck(ConnectionID connection_id, uint8_t session_id, - uint8_t protocol_version, + uint8_t input_protocol_version, uint32_t hash_code, uint8_t service_type, bool protection); diff --git a/src/components/protocol_handler/include/protocol_handler/protocol_packet.h b/src/components/protocol_handler/include/protocol_handler/protocol_packet.h index 31b4c12ea6..1c427533e6 100644 --- a/src/components/protocol_handler/include/protocol_handler/protocol_packet.h +++ b/src/components/protocol_handler/include/protocol_handler/protocol_packet.h @@ -79,13 +79,16 @@ class ProtocolPacket { uint8_t majorVersion; uint8_t minorVersion; uint8_t patchVersion; - static inline uint8_t cmp(const ProtocolVersion& version1, + static inline int16_t cmp(const ProtocolVersion& version1, const ProtocolVersion& version2) { - uint8_t diff = version1.majorVersion - version2.majorVersion; + int16_t diff = + static_cast<int16_t>(version1.majorVersion - version2.majorVersion); if (diff == 0) { - diff = version1.minorVersion - version2.minorVersion; + diff = + static_cast<int16_t>(version1.minorVersion - version2.minorVersion); if (diff == 0) { - diff = version1.minorVersion - version2.minorVersion; + diff = static_cast<int16_t>(version1.patchVersion - + version2.patchVersion); } } return diff; diff --git a/src/components/protocol_handler/src/protocol_handler_impl.cc b/src/components/protocol_handler/src/protocol_handler_impl.cc index 125e033147..23ac2927ef 100644 --- a/src/components/protocol_handler/src/protocol_handler_impl.cc +++ b/src/components/protocol_handler/src/protocol_handler_impl.cc @@ -190,7 +190,7 @@ void set_hash_id(uint32_t hash_id, protocol_handler::ProtocolPacket& packet) { void ProtocolHandlerImpl::SendStartSessionAck(ConnectionID connection_id, uint8_t session_id, - uint8_t protocol_version, + uint8_t input_protocol_version, uint32_t hash_id, uint8_t service_type, bool protection) { @@ -198,7 +198,7 @@ void ProtocolHandlerImpl::SendStartSessionAck(ConnectionID connection_id, ProtocolPacket::ProtocolVersion fullVersion; SendStartSessionAck(connection_id, session_id, - protocol_version, + input_protocol_version, hash_id, service_type, protection, @@ -208,7 +208,7 @@ void ProtocolHandlerImpl::SendStartSessionAck(ConnectionID connection_id, void ProtocolHandlerImpl::SendStartSessionAck( ConnectionID connection_id, uint8_t session_id, - uint8_t protocol_version, + uint8_t input_protocol_version, uint32_t hash_id, uint8_t service_type, bool protection, @@ -220,7 +220,7 @@ void ProtocolHandlerImpl::SendStartSessionAck( SendStartSessionAck(connection_id, session_id, - protocol_version, + input_protocol_version, hash_id, service_type, protection, @@ -233,7 +233,7 @@ void ProtocolHandlerImpl::SendStartSessionAck( void ProtocolHandlerImpl::SendStartSessionAck( ConnectionID connection_id, uint8_t session_id, - uint8_t protocol_version, + uint8_t input_protocol_version, uint32_t hash_id, uint8_t service_type, bool protection, @@ -241,22 +241,31 @@ void ProtocolHandlerImpl::SendStartSessionAck( BsonObject& params) { LOG4CXX_AUTO_TRACE(logger_); - uint8_t maxProtocolVersion = SupportedSDLProtocolVersion(); + uint8_t ack_protocol_version = SupportedSDLProtocolVersion(); const bool proxy_supports_v5_protocol = - protocol_version >= PROTOCOL_VERSION_5 || + input_protocol_version >= PROTOCOL_VERSION_5 || (ServiceTypeFromByte(service_type) == kRpc && full_version.majorVersion >= PROTOCOL_VERSION_5); + if (kRpc != service_type) { + // In case if input protocol version os bigger then supported, SDL should + // respond with maximum supported protocol version + ack_protocol_version = input_protocol_version < ack_protocol_version + ? input_protocol_version + : ack_protocol_version; + } + // We can't send a V5+ packet if the proxy doesn't support it, // so we manually set a maximum of V4 in that case - if (!proxy_supports_v5_protocol && maxProtocolVersion >= PROTOCOL_VERSION_5) { - maxProtocolVersion = PROTOCOL_VERSION_4; + if (!proxy_supports_v5_protocol && + ack_protocol_version >= PROTOCOL_VERSION_5) { + ack_protocol_version = PROTOCOL_VERSION_4; } ProtocolFramePtr ptr( new protocol_handler::ProtocolPacket(connection_id, - maxProtocolVersion, + ack_protocol_version, protection, FRAME_TYPE_CONTROL, service_type, @@ -266,7 +275,7 @@ void ProtocolHandlerImpl::SendStartSessionAck( message_counters_[session_id]++)); // Cannot include a constructed payload if either side doesn't support it - if (maxProtocolVersion >= PROTOCOL_VERSION_5) { + if (ack_protocol_version >= PROTOCOL_VERSION_5) { ServiceType serviceTypeValue = ServiceTypeFromByte(service_type); bson_object_put_int64( @@ -285,7 +294,7 @@ void ProtocolHandlerImpl::SendStartSessionAck( ? &defaultProtocolVersion : ProtocolPacket::ProtocolVersion::min(full_version, defaultProtocolVersion); - char protocolVersionString[255]; + char protocolVersionString[256]; strncpy(protocolVersionString, (*minVersion).to_string().c_str(), 255); bson_object_put_string( ¶ms, strings::protocol_version, protocolVersionString); @@ -1205,7 +1214,8 @@ class StartSessionHandler : public security_manager::SecurityManagerListener { , hash_id_(hash_id) , service_type_(service_type) , force_protected_service_(force_protected_service) - , full_version_() {} + , full_version_() + , payload_(NULL) {} StartSessionHandler(uint32_t connection_key, ProtocolHandlerImpl* protocol_handler, SessionObserver& session_observer, @@ -1528,12 +1538,37 @@ void ProtocolHandlerImpl::NotifySessionStartedResult( } BsonObject start_session_ack_params; + bson_object_initialize_default(&start_session_ack_params); // when video service is successfully started, copy input parameters // ("width", "height", "videoProtocol", "videoCodec") to the ACK packet if (packet->service_type() == kMobileNav && packet->data() != NULL) { - start_session_ack_params = bson_object_from_bytes(packet->data()); - } else { - bson_object_initialize_default(&start_session_ack_params); + BsonObject req_param = bson_object_from_bytes(packet->data()); + BsonElement* element = NULL; + + if ((element = bson_object_get(&req_param, strings::height)) != NULL && + element->type == TYPE_INT32) { + bson_object_put_int32(&start_session_ack_params, + strings::height, + bson_object_get_int32(&req_param, strings::height)); + } + if ((element = bson_object_get(&req_param, strings::width)) != NULL && + element->type == TYPE_INT32) { + bson_object_put_int32(&start_session_ack_params, + strings::width, + bson_object_get_int32(&req_param, strings::width)); + } + char* protocol = + bson_object_get_string(&req_param, strings::video_protocol); + if (protocol != NULL) { + bson_object_put_string( + &start_session_ack_params, strings::video_protocol, protocol); + } + char* codec = bson_object_get_string(&req_param, strings::video_codec); + if (codec != NULL) { + bson_object_put_string( + &start_session_ack_params, strings::video_codec, codec); + } + bson_object_deinitialize(&req_param); } ProtocolPacket::ProtocolVersion* fullVersion; @@ -1935,33 +1970,34 @@ void ProtocolHandlerImpl::SendFramesNumber(uint32_t connection_key, LOG4CXX_DEBUG( logger_, "SendFramesNumber MobileNaviAck for session " << connection_key); - // TODO(EZamakhov): add protocol version check - to avoid send for - // PROTOCOL_VERSION_1 transport_manager::ConnectionUID connection_id = 0; uint8_t session_id = 0; session_observer_.PairFromKey(connection_key, &connection_id, &session_id); uint8_t protocol_version; if (session_observer_.ProtocolVersionUsed( connection_id, session_id, protocol_version)) { - ProtocolFramePtr ptr( - new protocol_handler::ProtocolPacket(connection_id, - protocol_version, - PROTECTION_OFF, - FRAME_TYPE_CONTROL, - SERVICE_TYPE_NAVI, - FRAME_DATA_SERVICE_DATA_ACK, - session_id, - 0, - message_counters_[session_id]++)); - - // Flow control data shall be 4 bytes according Ford Protocol - DCHECK(sizeof(number_of_frames) == 4); - number_of_frames = LE_TO_BE32(number_of_frames); - ptr->set_data(reinterpret_cast<const uint8_t*>(&number_of_frames), - sizeof(number_of_frames)); - raw_ford_messages_to_mobile_.PostMessage( - impl::RawFordMessageToMobile(ptr, false)); - LOG4CXX_DEBUG(logger_, "SendFramesNumber finished successfully"); + if (protocol_version > PROTOCOL_VERSION_1 && + protocol_version < PROTOCOL_VERSION_5) { + ProtocolFramePtr ptr(new protocol_handler::ProtocolPacket( + connection_id, + protocol_version, + PROTECTION_OFF, + FRAME_TYPE_CONTROL, + SERVICE_TYPE_NAVI, + FRAME_DATA_SERVICE_DATA_ACK, + session_id, + 0, + message_counters_[session_id]++)); + + // Flow control data shall be 4 bytes according Ford Protocol + DCHECK(sizeof(number_of_frames) == 4); + number_of_frames = LE_TO_BE32(number_of_frames); + ptr->set_data(reinterpret_cast<const uint8_t*>(&number_of_frames), + sizeof(number_of_frames)); + raw_ford_messages_to_mobile_.PostMessage( + impl::RawFordMessageToMobile(ptr, false)); + LOG4CXX_DEBUG(logger_, "SendFramesNumber finished successfully"); + } } else { LOG4CXX_WARN( logger_, diff --git a/src/components/protocol_handler/src/protocol_packet.cc b/src/components/protocol_handler/src/protocol_packet.cc index 39871d5bae..ae52849de6 100644 --- a/src/components/protocol_handler/src/protocol_packet.cc +++ b/src/components/protocol_handler/src/protocol_packet.cc @@ -84,7 +84,7 @@ ProtocolPacket::ProtocolVersion::ProtocolVersion(std::string versionString) } std::string ProtocolPacket::ProtocolVersion::to_string() { - char versionString[255]; + char versionString[256]; snprintf(versionString, 255, "%u.%u.%u", diff --git a/src/components/protocol_handler/test/protocol_handler_tm_test.cc b/src/components/protocol_handler/test/protocol_handler_tm_test.cc index 89b9faedaa..d7850e4df1 100644 --- a/src/components/protocol_handler/test/protocol_handler_tm_test.cc +++ b/src/components/protocol_handler/test/protocol_handler_tm_test.cc @@ -65,6 +65,8 @@ using protocol_handler::PROTECTION_OFF; using protocol_handler::PROTOCOL_VERSION_1; using protocol_handler::PROTOCOL_VERSION_2; using protocol_handler::PROTOCOL_VERSION_3; +using protocol_handler::PROTOCOL_VERSION_4; +using protocol_handler::PROTOCOL_VERSION_5; using protocol_handler::PROTOCOL_VERSION_MAX; using protocol_handler::FRAME_TYPE_CONTROL; using protocol_handler::FRAME_TYPE_SINGLE; @@ -79,6 +81,7 @@ using protocol_handler::FRAME_DATA_END_SERVICE_ACK; using protocol_handler::FRAME_DATA_END_SERVICE; using protocol_handler::FRAME_DATA_HEART_BEAT; using protocol_handler::FRAME_DATA_HEART_BEAT_ACK; +using protocol_handler::FRAME_DATA_SERVICE_DATA_ACK; using protocol_handler::FRAME_DATA_SINGLE; using protocol_handler::FRAME_DATA_FIRST; using protocol_handler::FRAME_DATA_LAST_CONSECUTIVE; @@ -2143,6 +2146,59 @@ TEST_F(ProtocolHandlerImplTest, SendMessageToMobileApp_SendMultiframeMessage) { EXPECT_TRUE(waiter->WaitFor(times, kAsyncExpectationsTimeout)); } +TEST_F(ProtocolHandlerImplTest, SendServiceDataAck_PreVersion5) { + ::utils::SharedPtr<TestAsyncWaiter> waiter = + utils::MakeShared<TestAsyncWaiter>(); + uint32_t times = 0; + + AddSession(waiter, times); + + EXPECT_CALL(session_observer_mock, PairFromKey(connection_key, _, _)) + .WillOnce( + DoAll(SetArgPointee<1>(connection_id), SetArgPointee<2>(session_id))); + EXPECT_CALL(session_observer_mock, ProtocolVersionUsed(connection_id, _, _)) + .WillRepeatedly( + DoAll(SetArgReferee<2>(PROTOCOL_VERSION_4), Return(true))); + + EXPECT_CALL(transport_manager_mock, + SendMessageToDevice(ExpectedMessage(FRAME_TYPE_CONTROL, + FRAME_DATA_SERVICE_DATA_ACK, + PROTECTION_OFF, + kMobileNav))) + .WillOnce(DoAll(NotifyTestAsyncWaiter(waiter), Return(E_SUCCESS))); + times++; + + protocol_handler_impl->SendFramesNumber(connection_key, 0); + + EXPECT_TRUE(waiter->WaitFor(times, kAsyncExpectationsTimeout)); +} + +TEST_F(ProtocolHandlerImplTest, SendServiceDataAck_AfterVersion5) { + ::utils::SharedPtr<TestAsyncWaiter> waiter = + utils::MakeShared<TestAsyncWaiter>(); + uint32_t times = 0; + + AddSession(waiter, times); + + EXPECT_CALL(session_observer_mock, PairFromKey(connection_key, _, _)) + .WillOnce( + DoAll(SetArgPointee<1>(connection_id), SetArgPointee<2>(session_id))); + EXPECT_CALL(session_observer_mock, ProtocolVersionUsed(connection_id, _, _)) + .WillRepeatedly( + DoAll(SetArgReferee<2>(PROTOCOL_VERSION_5), Return(true))); + + // It is expected that Service Data ACK is NOT sent for version 5+ + EXPECT_CALL(transport_manager_mock, + SendMessageToDevice(ExpectedMessage(FRAME_TYPE_CONTROL, + FRAME_DATA_SERVICE_DATA_ACK, + PROTECTION_OFF, + kMobileNav))).Times(0); + + protocol_handler_impl->SendFramesNumber(connection_key, 0); + + EXPECT_TRUE(waiter->WaitFor(times, kAsyncExpectationsTimeout)); +} + } // namespace protocol_handler_test } // namespace components } // namespace test diff --git a/src/components/remote_control/include/remote_control/remote_control_plugin.h b/src/components/remote_control/include/remote_control/remote_control_plugin.h index 6e36470b06..1e7d49c18e 100644 --- a/src/components/remote_control/include/remote_control/remote_control_plugin.h +++ b/src/components/remote_control/include/remote_control/remote_control_plugin.h @@ -116,13 +116,14 @@ class RemoteControlPlugin : public RemotePluginInterface { */ void set_service(application_manager::ServicePtr service) OVERRIDE; - /* + /** * @brief OnApplicationEvent Processes application related events * @param event Event - * @param application_id Application id + * @param application Pointer to application struct */ - void OnApplicationEvent(functional_modules::ApplicationEvent event, - const uint32_t application_id) OVERRIDE; + void OnApplicationEvent( + functional_modules::ApplicationEvent event, + application_manager::ApplicationSharedPtr application) OVERRIDE; /** * @brief OnPolicyEvent Processes policy related events diff --git a/src/components/remote_control/include/remote_control/resource_allocation_manager.h b/src/components/remote_control/include/remote_control/resource_allocation_manager.h index e9712370d9..f789fe4af9 100644 --- a/src/components/remote_control/include/remote_control/resource_allocation_manager.h +++ b/src/components/remote_control/include/remote_control/resource_allocation_manager.h @@ -78,10 +78,11 @@ class ResourceAllocationManager { /** * @brief OnApplicationEvent Processes application related events * @param event Event - * @param application_id Application id + * @param application Pointer to application struct */ - virtual void OnApplicationEvent(functional_modules::ApplicationEvent event, - const uint32_t application_id) = 0; + virtual void OnApplicationEvent( + functional_modules::ApplicationEvent event, + application_manager::ApplicationSharedPtr application) = 0; /** * @brief OnPolicyEvent Processes policy related events diff --git a/src/components/remote_control/include/remote_control/resource_allocation_manager_impl.h b/src/components/remote_control/include/remote_control/resource_allocation_manager_impl.h index a62d1b091c..57c2a8f360 100644 --- a/src/components/remote_control/include/remote_control/resource_allocation_manager_impl.h +++ b/src/components/remote_control/include/remote_control/resource_allocation_manager_impl.h @@ -37,12 +37,13 @@ class ResourceAllocationManagerImpl : public ResourceAllocationManager { const uint32_t app_id) FINAL; /** - * @brief OnApplicationEvent Processes application related events + * @brief OnApplicationEvent Notifies modules on certain application events * @param event Event - * @param application_id Application id + * @param application Pointer to application struct */ - void OnApplicationEvent(functional_modules::ApplicationEvent event, - const uint32_t application_id) FINAL; + void OnApplicationEvent( + functional_modules::ApplicationEvent event, + application_manager::ApplicationSharedPtr application) FINAL; /** * @brief OnPolicyEvent Processes policy related events diff --git a/src/components/remote_control/src/remote_control_plugin.cc b/src/components/remote_control/src/remote_control_plugin.cc index e5a073d15e..921fc3794c 100644 --- a/src/components/remote_control/src/remote_control_plugin.cc +++ b/src/components/remote_control/src/remote_control_plugin.cc @@ -321,9 +321,17 @@ ResourceAllocationManager& RemoteControlPlugin::resource_allocation_manager() { } void RemoteControlPlugin::OnApplicationEvent( - functional_modules::ApplicationEvent event, const uint32_t application_id) { + functional_modules::ApplicationEvent event, + application_manager::ApplicationSharedPtr application) { LOG4CXX_AUTO_TRACE(logger_); - resource_allocation_manager_.OnApplicationEvent(event, application_id); + if (false == service()->IsRemoteControlApplication(application)) { + LOG4CXX_DEBUG(logger_, + "Application " << application->app_id() + << " has no remote control functionality." + << " Event will be ignored for RC plugin"); + return; + } + resource_allocation_manager_.OnApplicationEvent(event, application); } void RemoteControlPlugin::OnPolicyEvent(functional_modules::PolicyEvent event) { diff --git a/src/components/remote_control/src/resource_allocation_manager_impl.cc b/src/components/remote_control/src/resource_allocation_manager_impl.cc index fd6c2d8fb8..233cc79764 100644 --- a/src/components/remote_control/src/resource_allocation_manager_impl.cc +++ b/src/components/remote_control/src/resource_allocation_manager_impl.cc @@ -162,15 +162,16 @@ void ResourceAllocationManagerImpl::ProcessApplicationPolicyUpdate() { RCAppExtensionPtr ResourceAllocationManagerImpl::GetApplicationExtention( application_manager::ApplicationSharedPtr application) { LOG4CXX_AUTO_TRACE(logger_); + + RCAppExtensionPtr rc_app_extension; if (!application) { - return NULL; + return rc_app_extension; } - RCAppExtensionPtr rc_app_extension; application_manager::AppExtensionPtr app_extension = application->QueryInterface(rc_plugin_.GetModuleID()); if (!app_extension) { - return NULL; + return rc_app_extension; } rc_app_extension = @@ -181,6 +182,7 @@ RCAppExtensionPtr ResourceAllocationManagerImpl::GetApplicationExtention( } void ResourceAllocationManagerImpl::RemoveAppsSubscriptions(const Apps& apps) { + LOG4CXX_AUTO_TRACE(logger_); Apps::const_iterator app = apps.begin(); for (; apps.end() != app; ++app) { application_manager::ApplicationSharedPtr app_ptr = *app; @@ -317,20 +319,22 @@ void ResourceAllocationManagerImpl::OnDriverDisallowed( } void ResourceAllocationManagerImpl::OnApplicationEvent( - functional_modules::ApplicationEvent event, const uint32_t application_id) { + functional_modules::ApplicationEvent event, + application_manager::ApplicationSharedPtr application) { LOG4CXX_AUTO_TRACE(logger_); - LOG4CXX_DEBUG(logger_, "Event " << event << " came for " << application_id); + LOG4CXX_DEBUG(logger_, + "Event " << event << " came for " << application->app_id()); if (functional_modules::ApplicationEvent::kApplicationExit == event || functional_modules::ApplicationEvent::kApplicationUnregistered == event) { - Resources acquired_modules = GetAcquiredResources(application_id); + Resources acquired_modules = GetAcquiredResources(application->app_id()); Resources::const_iterator module = acquired_modules.begin(); for (; acquired_modules.end() != module; ++module) { - ReleaseResource(*module, application_id); + ReleaseResource(*module, application->app_id()); } Apps app_list; - app_list.push_back(rc_plugin_.service()->GetApplication(application_id)); + app_list.push_back(application); RemoveAppsSubscriptions(app_list); } } diff --git a/src/components/remote_control/test/include/mock_remote_control_plugin.h b/src/components/remote_control/test/include/mock_remote_control_plugin.h index 2e221ca75d..a8143f448c 100644 --- a/src/components/remote_control/test/include/mock_remote_control_plugin.h +++ b/src/components/remote_control/test/include/mock_remote_control_plugin.h @@ -43,7 +43,7 @@ class MockRemotePluginInterface : public remote_control::RemotePluginInterface { remote_control::ResourceAllocationManager&()); MOCK_METHOD2(OnApplicationEvent, void(functional_modules::ApplicationEvent event, - const uint32_t application_id)); + application_manager::ApplicationSharedPtr application)); MOCK_METHOD1(OnPolicyEvent, void(functional_modules::PolicyEvent event)); }; diff --git a/src/components/remote_control/test/include/mock_resource_allocation_manager.h b/src/components/remote_control/test/include/mock_resource_allocation_manager.h index d55af2b00d..6337d8a32a 100644 --- a/src/components/remote_control/test/include/mock_resource_allocation_manager.h +++ b/src/components/remote_control/test/include/mock_resource_allocation_manager.h @@ -20,7 +20,7 @@ class MockResourceAllocationManager void(const std::string& module_type, const uint32_t app_id)); MOCK_METHOD2(OnApplicationEvent, void(functional_modules::ApplicationEvent event, - const uint32_t application_id)); + application_manager::ApplicationSharedPtr application)); MOCK_METHOD1(OnPolicyEvent, void(functional_modules::PolicyEvent event)); MOCK_METHOD1(SetAccessMode, void(const hmi_apis::Common_RCAccessMode::eType access_mode)); diff --git a/src/components/remote_control/test/src/resource_allocation_manager_impl_test.cc b/src/components/remote_control/test/src/resource_allocation_manager_impl_test.cc index 4d1b399add..a69702d424 100644 --- a/src/components/remote_control/test/src/resource_allocation_manager_impl_test.cc +++ b/src/components/remote_control/test/src/resource_allocation_manager_impl_test.cc @@ -258,8 +258,11 @@ TEST_F(RAManagerTest, AppExit_ReleaseResource) { ra_manager.AcquireResource(kModuleType1, kAppId1)); // Act + application_manager::ApplicationSharedPtr app_ptr(mock_app_1_); + EXPECT_CALL(*mock_app_1_, app_id()).WillRepeatedly(Return(kAppId1)); + ra_manager.OnApplicationEvent( - functional_modules::ApplicationEvent::kApplicationExit, kAppId1); + functional_modules::ApplicationEvent::kApplicationExit, app_ptr); EXPECT_CALL(*mock_service_, GetApplication(kAppId2)) .WillRepeatedly(Return(mock_app_2_)); @@ -289,8 +292,10 @@ TEST_F(RAManagerTest, AnotherAppExit_NoReleaseResource) { .WillOnce(Return(rc_extention_ptr)); // Act + application_manager::ApplicationSharedPtr app_ptr(mock_app_2_); + EXPECT_CALL(*mock_app_2_, app_id()).WillRepeatedly(Return(kAppId2)); ra_manager.OnApplicationEvent( - functional_modules::ApplicationEvent::kApplicationExit, kAppId2); + functional_modules::ApplicationEvent::kApplicationExit, app_ptr); EXPECT_CALL(*mock_service_, GetApplication(kAppId2)) .WillOnce(Return(mock_app_2_)); @@ -318,8 +323,11 @@ TEST_F(RAManagerTest, AppUnregistered_ReleaseResource) { ra_manager.AcquireResource(kModuleType1, kAppId1)); // Act + application_manager::ApplicationSharedPtr app_ptr(mock_app_1_); + EXPECT_CALL(*mock_app_1_, app_id()).WillRepeatedly(Return(kAppId1)); + ra_manager.OnApplicationEvent( - functional_modules::ApplicationEvent::kApplicationUnregistered, kAppId1); + functional_modules::ApplicationEvent::kApplicationUnregistered, app_ptr); EXPECT_CALL(*mock_service_, GetApplication(kAppId2)) .WillOnce(Return(mock_app_2_)); @@ -348,8 +356,11 @@ TEST_F(RAManagerTest, AnotherAppUnregistered_NoReleaseResource) { .WillOnce(Return(rc_extention_ptr)); // Act + application_manager::ApplicationSharedPtr app_ptr(mock_app_2_); + EXPECT_CALL(*mock_app_2_, app_id()).WillRepeatedly(Return(kAppId2)); + ra_manager.OnApplicationEvent( - functional_modules::ApplicationEvent::kApplicationUnregistered, kAppId2); + functional_modules::ApplicationEvent::kApplicationUnregistered, app_ptr); EXPECT_CALL(*mock_service_, GetApplication(kAppId2)) .WillOnce(Return(mock_app_2_)); diff --git a/src/components/transport_manager/src/transport_adapter/threaded_socket_connection.cc b/src/components/transport_manager/src/transport_adapter/threaded_socket_connection.cc index 135babdeb0..9d594affe4 100644 --- a/src/components/transport_manager/src/transport_adapter/threaded_socket_connection.cc +++ b/src/components/transport_manager/src/transport_adapter/threaded_socket_connection.cc @@ -173,6 +173,7 @@ void ThreadedSocketConnection::threadMain() { if (!Establish(&connect_error)) { LOG4CXX_ERROR(logger_, "Connection Establish failed"); delete connect_error; + Abort(); } LOG4CXX_DEBUG(logger_, "Connection established"); controller_->ConnectDone(device_handle(), application_handle()); diff --git a/src/components/transport_manager/src/transport_manager_impl.cc b/src/components/transport_manager/src/transport_manager_impl.cc index 433885a606..831ff0980e 100644 --- a/src/components/transport_manager/src/transport_manager_impl.cc +++ b/src/components/transport_manager/src/transport_manager_impl.cc @@ -621,29 +621,23 @@ void TransportManagerImpl::AddConnection(const ConnectionInternal& c) { connections_.push_back(c); } -namespace { -struct ConnectionFinder { - const uint32_t id_; - ConnectionFinder(const uint32_t id) : id_(id) {} - bool operator()(const transport_manager::TransportManagerImpl::Connection& - connection) const { - return id_ == connection.id; - } -}; -} - void TransportManagerImpl::RemoveConnection( const uint32_t id, transport_adapter::TransportAdapter* transport_adapter) { LOG4CXX_AUTO_TRACE(logger_); LOG4CXX_DEBUG(logger_, "Id: " << id); sync_primitives::AutoWriteLock lock(connections_lock_); - const std::vector<ConnectionInternal>::iterator it = std::find_if( - connections_.begin(), connections_.end(), ConnectionFinder(id)); - if (connections_.end() != it) { - if (transport_adapter) { - transport_adapter->RemoveFinalizedConnection(it->device, it->application); + std::vector<ConnectionInternal>::iterator it = connections_.begin(); + while (it != connections_.end()) { + if (it->id == id) { + if (transport_adapter) { + transport_adapter->RemoveFinalizedConnection(it->device, + it->application); + } + connections_.erase(it++); + break; + } else { + ++it; } - connections_.erase(it); } } diff --git a/src/components/utils/test/generated_code_with_sqlite_test.cc b/src/components/utils/test/generated_code_with_sqlite_test.cc index d37b46f801..1c829c838c 100644 --- a/src/components/utils/test/generated_code_with_sqlite_test.cc +++ b/src/components/utils/test/generated_code_with_sqlite_test.cc @@ -66,7 +66,7 @@ const std::string GeneratedCodeTest::kEndpointsCreation = "CREATE TABLE Endpoints (" "endpoint_id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL," "service_id VARCHAR(45) NOT NULL," - "application_id VARCHAR(45)," + "application_id VARCHAR(45) COLLATE NOCASE," "url VARCHAR(45) NOT NULL," "is_default INTEGER NOT NULL CHECK(is_default>=0))"; @@ -77,14 +77,14 @@ const std::string GeneratedCodeTest::kEndpointsContent = const std::string GeneratedCodeTest::kAppPoliciesCreation = "CREATE TABLE AppPolicies (" "id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL," - "application_id VARCHAR(45)," + "application_id VARCHAR(45) COLLATE NOCASE," "priority VARCHAR(45)," "is_default INTEGER NOT NULL CHECK(is_default>=0))"; const std::string GeneratedCodeTest::kGroupsCreation = "CREATE TABLE Groups (" "id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL," - "application_id VARCHAR(45) NOT NULL," + "application_id VARCHAR(45) NOT NULL COLLATE NOCASE," "group_name VARCHAR(45) NOT NULL )"; TEST_F(GeneratedCodeTest, diff --git a/src/components/utils/test/policy.sql b/src/components/utils/test/policy.sql index 406579f6b7..292855734e 100644 --- a/src/components/utils/test/policy.sql +++ b/src/components/utils/test/policy.sql @@ -108,7 +108,7 @@ BEGIN TRANSACTION; CREATE INDEX `rpc.select_rpc_name_hmi_level` ON `rpc`(`name`,`hmi_level_value`); CREATE TABLE IF NOT EXISTS `application`( - `id` VARCHAR(45) PRIMARY KEY NOT NULL, + `id` VARCHAR(45) PRIMARY KEY NOT NULL COLLATE NOCASE, `keep_context` BOOLEAN, `steal_focus` BOOLEAN, `default_hmi` VARCHAR(45), @@ -131,7 +131,7 @@ BEGIN TRANSACTION; CREATE INDEX IF NOT EXISTS `application.fk_application_priorities1_idx` ON `application`(`priority_value`); CREATE TABLE IF NOT EXISTS `app_group`( - `application_id` VARCHAR(45) NOT NULL, + `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, `functional_group_id` INTEGER NOT NULL, PRIMARY KEY(`application_id`,`functional_group_id`), CONSTRAINT `fk_application_has_functional_group_application1` @@ -144,9 +144,9 @@ BEGIN TRANSACTION; CREATE INDEX IF NOT EXISTS `app_group.fk_application_has_functional_group_functional_group1_idx` ON `app_group`(`functional_group_id`); CREATE INDEX IF NOT EXISTS `app_group.fk_application_has_functional_group_application1_idx` - ON `app_group`(`application_id`); + ON `app_group`(`application_id` COLLATE NOCASE); CREATE TABLE IF NOT EXISTS `preconsented_group`( - `application_id` VARCHAR(45) NOT NULL, + `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, `functional_group_id` INTEGER NOT NULL, PRIMARY KEY(`application_id`,`functional_group_id`), CONSTRAINT `fk_application_has_functional_group_application2` @@ -161,7 +161,7 @@ BEGIN TRANSACTION; ON `preconsented_group`(`functional_group_id`); CREATE INDEX IF NOT EXISTS `preconsented_group.fk_application_has_functional_group_application2_idx` - ON `preconsented_group`(`application_id`); + ON `preconsented_group`(`application_id` COLLATE NOCASE); CREATE TABLE IF NOT EXISTS `seconds_between_retry`( `index` INTEGER PRIMARY KEY NOT NULL, `value` INTEGER NOT NULL @@ -187,7 +187,7 @@ BEGIN TRANSACTION; `device_consent_group.fk_device_has_functional_group_device1_idx` ON `device_consent_group`(`device_id`); CREATE TABLE IF NOT EXISTS `app_level`( - `application_id` VARCHAR(45) PRIMARY KEY NOT NULL, + `application_id` VARCHAR(45) PRIMARY KEY NOT NULL COLLATE NOCASE, `minutes_in_hmi_full` INTEGER DEFAULT 0, `minutes_in_hmi_limited` INTEGER DEFAULT 0, `minutes_in_hmi_background` INTEGER DEFAULT 0, @@ -214,34 +214,34 @@ BEGIN TRANSACTION; REFERENCES `language`(`code`) ); CREATE INDEX IF NOT EXISTS `app_level.fk_app_levels_application1_idx` - ON `app_level`(`application_id`); + ON `app_level`(`application_id` COLLATE NOCASE); CREATE INDEX IF NOT EXISTS `app_level.fk_app_level_language1_idx` ON `app_level`(`app_registration_language_gui`); CREATE INDEX IF NOT EXISTS `app_level.fk_app_level_language2_idx` ON `app_level`(`app_registration_language_vui`); CREATE TABLE IF NOT EXISTS `nickname`( - `name` VARCHAR(100) NOT NULL, - `application_id` VARCHAR(45) NOT NULL, + `name` VARCHAR(100) NOT NULL COLLATE NOCASE, + `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, PRIMARY KEY(`name`,`application_id`), CONSTRAINT `fk_nickname_application1` FOREIGN KEY(`application_id`) REFERENCES `application`(`id`) ); CREATE INDEX IF NOT EXISTS `nickname.fk_nickname_application1_idx` - ON `nickname`(`application_id`); + ON `nickname`(`application_id` COLLATE NOCASE); CREATE TABLE IF NOT EXISTS `app_type`( `name` VARCHAR(50) NOT NULL, - `application_id` VARCHAR(45) NOT NULL, + `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, PRIMARY KEY(`name`,`application_id`), CONSTRAINT `fk_app_type_application1` FOREIGN KEY(`application_id`) REFERENCES `application`(`id`) ); CREATE INDEX IF NOT EXISTS `app_type.fk_app_type_application1_idx` - ON `app_type`(`application_id`); + ON `app_type`(`application_id` COLLATE NOCASE); CREATE TABLE IF NOT EXISTS `consent_group`( `device_id` VARCHAR(100) NOT NULL, - `application_id` VARCHAR(45) NOT NULL, + `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, `functional_group_id` INTEGER NOT NULL, `is_consented` BOOL NOT NULL, `input` VARCHAR(45), @@ -265,13 +265,13 @@ BEGIN TRANSACTION; CREATE TABLE IF NOT EXISTS `endpoint`( `service` INTEGER NOT NULL, `url` VARCHAR(100) NOT NULL, - `application_id` VARCHAR(45) NOT NULL, + `application_id` VARCHAR(45) NOT NULL COLLATE NOCASE, CONSTRAINT `fk_endpoint_application1` FOREIGN KEY(`application_id`) REFERENCES `application`(`id`) ); CREATE INDEX IF NOT EXISTS `endpoint.fk_endpoint_application1_idx` - ON `endpoint`(`application_id`); + ON `endpoint`(`application_id` COLLATE NOCASE); CREATE TABLE IF NOT EXISTS `message`( `id` INTEGER PRIMARY KEY NOT NULL, `tts` TEXT, diff --git a/tools/InterfaceGenerator/generator/parsers/RPCBase.py b/tools/InterfaceGenerator/generator/parsers/RPCBase.py index 59edf4a9b3..4853916dad 100755 --- a/tools/InterfaceGenerator/generator/parsers/RPCBase.py +++ b/tools/InterfaceGenerator/generator/parsers/RPCBase.py @@ -655,7 +655,11 @@ class Parser(object): raise ParseError("Unexpected attributes for element '" + element_name + "' of parameter '" + params["name"]) - if len(subelement.getchildren()) != 0: + children = subelement.getchildren() + for child in children: + if child.tag == "description": + children.remove(child) + if len(children) != 0: raise ParseError("Unexpected subelements for element '" + element_name + "' of parameter '" + params["name"]) |