Skip to content

Latest commit

 

History

History
113 lines (88 loc) · 8.41 KB

README.md

File metadata and controls

113 lines (88 loc) · 8.41 KB
Raw

OpenPilot 🔗 Siri Shortcuts 🔗

banner

A set of iOS (and macOS) Shortcuts that let you quickly set the OpenPilot navigation 🔗 destination from your iPhone, hands-free or not.

  • Users with Comma Prime subscriptions: The Comma Connect API can be used to easily set the navigation destination on your Comma device
  • Users without Comma Prime subscriptions: these shortcuts can still be used by making the API calls directly to your Comma device's IP address using
    • An external data hotspot that supports local networking, or
    • The Comma device's own hotspot, where you have your own sim card for data
    • The OpenPilot code must be changed to enable this:
      • This commit on GitHub 🔗 for the changes necessary to use navigation without a Comma Prime subscription, and
      • This commit 🔗 for the followup changes to enable use of these shortcuts

Here are Siri Shortcuts that provide the following functions for iPhone, iPad, and Mac users.

  1. Navigate with OpenPilot: Set OpenPilot navigation destination from a specified location/pin in Apple Maps, Google Maps, or Waze using the share sheet 🔗
  2. OpenPilot Search: Search for and select destinations
    • by saying "(Hey) Siri, OpenPilot search" or
    • by tapping the shortcut/widget/home screen icon followed by your destination (after the prompt)
  3. Go to work — Go home
    • by saying "(Hey) Siri, OpenPilot go to work" or
    • by saying "(Hey) Siri, OpenPilot go home", or
    • by tapping the shortcut/widget/home screen icon
  4. Go to favorite by saying "(Hey) Siri, OpenPilot go to favorite", then selecting a favorite from the list by voice or by tapping
  5. Go to recent by saying "(Hey) Siri, OpenPilot go to recent", then selecting one of the recent locations in the list
  6. Go to next event by saying "(Hey) Siri, OpenPilot go to next event", then perhaps selecting one of the recent locations in the list

Installation

  1. Acquire a JWT authentication 🔗 token at jwt.comma.ai 🔗, where you'll login using the same method you use at Comma Connect
  2. Go to Comma Connect 🔗 or UserAdmin 🔗 to get your Comma device dongle id (16 hex characters)
  3. Download and install the OpenPilot Siri Shortcuts by tapping the following links on your iPhone, iPad, or Mac
    • Complete the setup process for each shortcut (except search which has none). The data you'll provide is described after each install link
    • On first run, you'll be prompted to give permission for the shortcuts to do things
    1. Navigate with OpenPilot 🔗 JWT token dongle id set multi-device behavior set default map app set number of recent locations to show
    2. OpenPilot search 🔗
    3. OpenPilot go home 🔗 set home address
    4. OpenPilot go to work 🔗 set work address
    5. OpenPilot go to favorite 🔗 set one or more favorite places
    6. OpenPilot go to recent 🔗
    7. OpenPilot go to next event 🔗
  4. Run all shortcuts immediately to acquire permissions and enable hands-free use on subsequent runs
  5. The shortcuts will check for updates when you use them, and you'll be prompted to update if newer versions are available.

Navigate with OpenPilot

  • This is the main shortcut that actually performs the API call 🔗. This shortcut works in two ways, via the "Share Sheet" 🔗 and by being called by other shortcuts, providing a valid location as input.
  • To use with Apple Maps (see images):
    1. Tap the share button for a selected location/pin in Apple Maps
    2. Select "Navigate with OpenPilot" from the list of share actions
      1. If you don't see it in the list, or want it to appear higher for easier access, scroll down and select "edit actions"
      2. Tap the plus sign next to "Navigate with OpenPilot"
      3. Arrange the favorite actions to your liking
    3. That's it! You should see a notification indicating that navigation has been set on your Comma device, and directions will open automatically in Apple Maps
  • Google Maps: The process is identical, and directions will open in Google Maps
  • Waze: The process is similar
    1. Select a location, tap "Send", then "more options" to open the share sheet, then select "Navigate with OpenPilot"
    2. Finish starting directions in Waze
  • This shortcut takes text (for Waze), URLs (for Google Maps), and MapLinks (for Apple Maps) as input from the share sheet.
    • You can also run it from other shortcuts, such as in the other shortcuts provided here. This makes it very easy to extend the functionality.
    • If you do anything cool, be sure to let me know so it can be added here!

images showing use of share sheet shortcut

OpenPilot search

  • Voice search for locations, places or addresses, and choose from a visual + voice menu of results. Pick one and OpenPilot + iPhone navigation will start

OpenPilot search

  1. Four ways to use:
    1. Say "(Hey) Siri, OpenPilot search" , or
      • (becuase "OpenPilot search" is the name of the Shortcut, and every shortcut is callable by name automatically)
    2. Save the shortcut to a home/lock screen widget 🔗, or
    3. Save the shortcut as a home screen icon 🔗, or
    4. Tap the Shortcut in the Shortcuts app.
  2. Wait for the prompt "what text?"
    • ("what text?" was not my idea; you can't change the prompt; smh)
  3. Say the (mostly) complete address or location name without any long pauses
  4. You'll be presented with a list of results, and Siri will begin to read them. You can respond verbally or tap one of the results (even with CarPlay 🚗). Select one of the results or tap/say cancel to cancel.
  5. The default map app you specified during setup will open with directions to the destination, and you'll see a notification that navigation was set on your Comma device.

Go home

  • This simple shortcut lets you save one address
  • When run, it passes this location to the Navigate with OpenPilot Shortcut
  • Does not need to match the "home" address saved on Comma Connect

Go to work

  • Same Shortcut (as "Go home"), Different Destination
  • You see how these could be replicated to add more
  • Does not need to match the "work" address saved on Comma Connect

Go to favorite

  • Similar to home/work, but this one lets you specify multiple place names and locations
  • When run, you can select one of the favorites from the list, verbally or by tapping (even in CarPlay 🚗)
  • There is no set format to use for the specified locations
  • The specified locations are used to search, and the top result is used. They need to be complete enough that the desired place will be the top result

Go to recent

  • Similar to Go to favorites, but you'll choose from a list of recent locations
  • This shortcut just calls Navigate with OpenPilot without providing a location, causing it to run in recent location mode
  • Inspired by BitNotFound#5466 on Discord

Go to next event

  • This shortcut fetches your next calendar event that has a location specified, and sets OpenPilot and phone navigation to its location