CarPlay Maps with maui

[xvanneste]

Hello does anyone already create a CarPlay application with CPMapTemplate because I don't find any information about it just thé use of nscoder but I can't understand how to use it....
Thanks a lot

[mikelor]

Check out this series.
https://github.com/christian-strydom/MauiForCars

[rokmeglic71]

This is for GridTemplate, but maybe somebody can benefit from this process we went trough.

1. Requesting CarPlay Entitlements
Read more info on official Apple website.
https://developer.apple.com/documentation/carplay/requesting-carplay-entitlements

2. Add the entitlement into Entitlements.plist
Make sure you add the entitlement you have been granted.
Maybe you have asked for X and you got Y. It won't work if the entitlement will not match with your provisiong profiles.

<key>com.apple.developer.carplay-driving-task</key>
<true/>	

3. Visual Studio - updating profiles
Magic to me. In the end I added Apple account again into Visual Studio and clicked "Download all profiles"

4. Add information to info.plist

<key>UIApplicationSceneManifest</key>
	<dict>
		<key>UIApplicationSupportsMultipleScenes</key>
		<true/>
		<key>UISceneConfigurations</key>
		<dict>
			<!-- Default MAUI scene for iOs -->
			<key>UIWindowSceneSessionRoleApplication</key>
			<array>
				<dict>
					<key>UISceneClassName</key>
					<string>UIWindowScene</string>
					<key>UISceneConfigurationName</key>
					<string>__MAUI_DEFAULT_SCENE_CONFIGURATION__</string>
					<key>UISceneDelegateClassName</key>
                    <!-- iOs scene, match "SceneDelegate" with your class name, other fields can be left as they are -->
					<string>SceneDelegate</string>
				</dict>
			</array>
			<!-- CarPlay scene, match "CarPlaySceneDelegate" with your class name, other fields can be left as they are -->
			<key>CPTemplateApplicationSceneSessionRoleApplication</key>
			<array>
				<dict>
					<key>UISceneClassName</key>
					<string>CPTemplateApplicationScene</string>
					<key>UISceneConfigurationName</key>
					<string>CarPlay</string>
					<key>UISceneDelegateClassName</key>
					<string>CarPlaySceneDelegate</string>
				</dict>
			</array>
		</dict>
	</dict>

5. MauiUISceneDelegate.cs in Platforms/iOS/ - iOS

using Foundation;

namespace Maui.Platforms.iOS
{
    [Register("SceneDelegate")]
    public class SceneDelegate : MauiUISceneDelegate
    {
        
    }
}

6. CarPlaySceneDelegate.cs in Platforms/iOS - CarPlay

using CarPlay;
using CommunityToolkit.Mvvm.Messaging;
using Foundation;

namespace Maui.Platforms.iOS
{
    [Register("CarPlaySceneDelegate")]
    public class CarPlaySceneDelegate : CPTemplateApplicationSceneDelegate
    {
        private CPGridTemplate? cPGridTemplate = null;
        private List<CPGridButton> gridButtons = [];
        private bool dataReload = false;

        private IDispatcherTimer? _reloadTimeoutTimer;

        public CarPlaySceneDelegate()
        {
            // When data changes, we can call from anywhere in the MAUI to reload the data also on the CarPlay screen
            WeakReferenceMessenger.Default.Unregister<CarReloadDataMessage>(this);
            WeakReferenceMessenger.Default.Register<CarReloadDataMessage>(this, (recipient, message) =>
            {
                dataReload = true;
            });

            // Is timer up from previous session?
            if (_reloadTimeoutTimer != null)
            {
                _reloadTimeoutTimer?.Stop();
                _reloadTimeoutTimer = null;
            }

            // Start with new timer for refreshing grid buttons
            _reloadTimeoutTimer = Dispatcher.GetForCurrentThread()?.CreateTimer();
            if (_reloadTimeoutTimer != null)
            {
                _reloadTimeoutTimer.Interval = TimeSpan.FromMilliseconds(250);
                _reloadTimeoutTimer.Tick += async (s, e) =>
                {
                    if (dataReload)
                    {
                        await MainThread.InvokeOnMainThreadAsync(() =>
                        {
                            GetCpGridButtons(false);
                            cPGridTemplate?.UpdateGridButtons([.. gridButtons]);
                        });

                        dataReload = false;
                    }
                };

                _reloadTimeoutTimer.IsRepeating = true;
                _reloadTimeoutTimer.Start();
            }
        }

        private void GetCpGridButtons(bool firstLoad)
        {
            try
            {
                // Get list of Grid buttons
                int limit = 0;
                gridButtons = [];

                // Get all data
                foreach (Data tempData in AllData)
                {
                    // We can only show up to 8 controls on grid list
                    if (limit >= (int)CPGridTemplate.MaximumItems)
                    {
                        limit++;
                        break;
                    }


                    // Add a button with on click handler
                    gridButtons.Add(
                      new CPGridButton(
	                      titleVariants: [tempData.Name],
	                      UIKit.UIImage.FromBundle(tempData.Image),
	                      (gridButton) =>
	                      {
		                      // Do smt on click, for example light on
		                      // In 250 ms we will refresh and the Grid button will get the yellow light image
	                      }
                      )
                    );

                    limit++;
                }
            }
            catch (Exception ex)
            {
                Console.Writeline("Reloading CarPlay view failed");
            }
        }

        [Export("templateApplicationScene:didConnectInterfaceController:to:")]
        public override void DidConnect(CPTemplateApplicationScene templateApplicationScene, CPInterfaceController interfaceController)
        {
            GetCpGridButtons(true);
            cPGridTemplate = new("Maui", [.. gridButtons]);
            interfaceController.SetRootTemplate(cPGridTemplate, false);
        }

        [Export("templateApplicationScene:didDisconnectInterfaceController:from:")]
        public override void DidDisconnect(CPTemplateApplicationScene cpTemplateApplicationScene, CPInterfaceController interfaceController)
        {
            // Clear the timer
            if (_reloadTimeoutTimer != null)
            {
                _reloadTimeoutTimer?.Stop();
                _reloadTimeoutTimer = null;
            }

            interfaceController.Dispose();
        }
    }
}

References - code above was created with help of links bellow and CoPilot AI:

• Maui - info.plist info
• Maui - scene delegate
• Swiftui - can help with Maui understanding
• Where is CarPlay available?
• I notice UIApplicationSupportsMultipleScenes - key to get is started
• Was looking for lifecycle, how to refresh CarPlay data?
• Good overall knowledge
• didConnect handler
• Is UIApplicationSupportsMultipleScenes missing?
• Searching for UISceneConfigurationName help
• How to know when CarPlay is connected?
• Overall knowledge, also for MAUI
• Good code example for CarPlay
• Good code example for CarPlay - 2
• Duck search for starting
• Reddit post - good video
• Official CarPlay Developer Guide
• Official CarPlay - CPGridTemplate info

[davidortinau]

@rokmeglic71 I'm curious about your experience building for CarPlay, and what your use case is. If you're interested in a chat, shoot me an email [email protected]