Requesting CarPlay Entitlements

Configure your CarPlay-enabled app with the entitlements it requires.

Overview

To integrate with CarPlay, you must request the appropriate entitlement for your app’s category at CarPlay Contact Us and agree to the CarPlay Entitlement Addendum. Apple reviews each application using predefined criteria. If your request meets the criteria, Apple adds the entitlement to your developer account using managed capabilities. For more information, see Provisioning with managed capabilities.

After you receive the entitlement, you need to configure your Xcode project to use it, which involves several steps. You create or update an App ID, generate a provisioning profile, and add an Entitlements.plist file to your target. Your project’s code signing settings also require minor changes.

Add CarPlay Capabilities to Your App ID

Update the App ID of your CarPlay-enabled app to include the necessary CarPlay capabilities by following these steps:

Complete the actions in Register an App ID to create an App ID if you don’t already have one.
Sign in to your Apple Developer account and select Certificates, Identifiers & Profiles.
Select Identifiers in the menu on the left.
Select your app’s App ID.
Choose the Additional Capabilities tab.
Enable the CarPlay capabilities that your app requires.
Click the Save button.
Create a new provisioning profile for the updated App ID. For more information, see Create a development provisioning profile.

[Image]

Import the CarPlay Provisioning Profile

Configure your Xcode project to use the new provisioning profile when it code signs your CarPlay-enabled app by following these steps:

In Xcode, select your project in the Project navigator.
In the project editor, choose Signing & Capabilities.
Click All in the scope bar, and then deselect “Automatically manage signing”.
Click the Provisioning Profile pop-up menu and choose Download Profile.
Select your CarPlay provisioning profile from the left column and click Select Profile.

Add an Entitlements File

Use an Entitlements.plist file to specify the entitlements that your CarPlay-enabled app requires. They must match the capabilities you add to your App ID. CarPlay uses this file to determine the framework functionality to allow.

To create the entitlements file:

In Xcode, select your project in the Project navigator.
Choose File > New > File, select Property List from the Resource section, and click Next.
Enter Entitlements as the filename and click Create.
In the project editor, choose Build Settings.
Click All and Combined in the scope bar.
Use the search box to find the Code Signing Entitlements setting.
Enter the full path of the Entitlements.plist file as the setting’s value.
Open the file in Xcode and add the applicable entitlement from the table below as a Boolean.

Entitlement	Category
`com.apple.developer.carplay-audio`	Audio
`com.apple.developer.carplay-communication`	Communication
`com.apple.developer.carplay-charging`	EV Charging``
`com.apple.developer.carplay-maps`	Navigation
`com.apple.developer.carplay-parking`	Parking``
`com.apple.developer.carplay-quick-ordering`	Quick Food Ordering

The following example shows the contents of a CarPlay-enabled app’s Entitlements.plist file with the audio entitlement:

<key>com.apple.developer.carplay-audio</key>
<true/>

Test Your Configuration

In Xcode, use a simulator to build and run your project. After Simulator launches, choose I/O > External Displays > CarPlay. Your app appears on the CarPlay Home screen.