Skip to main content

Sounds

iOS
Adding a custom sound to a notification allows you to easily identify the notification without even looking at your device. Home Assistant for iOS comes with some notification sounds pre-installed, but you can also upload your own.

Here is an example notification that uses one of the pre-installed sounds.

automation:- alias: "Notify Mobile App sound"  trigger:    ...  action:    - service: notify.mobile_app_<your_device_id_here>      data:        message: “Your Roommate arrived”        data:          push:            sound: "US-EN-Morgan-Freeman-Roommate-Is-Arriving.wav"

You must use the full filename (including extension) in the payload.

Custom push notification sounds#

The iOS app allows you to use your own custom sounds in push notifications. The sounds must be formatted as 32bit float 48000Hz wav files. Make sure you know the filename of the sound as you will need to reference it in the sound field of the notification payload. To add sounds follow either of the two following methods:

  • You may need to restart your entire device before notification sounds can be played.
  • Uploading a file with the same name as an existing one will overwrite the original.

Via iTunes#

  1. Connect the device to a PC or Mac running the latest version of iTunes.
  2. Go to the device in iTunes.
  3. Select "File Sharing" in the left-hand menu.
  4. Select Home Assistant.
  5. Drag and drop properly formatted sounds (32bit float 48000Hz wav files).
  6. Click Sync in the lower right.
  7. Once the sync is complete, disconnect the device from the computer.
  8. On your iOS device, open the Home Assistant app.
  9. Go to App Configuration -> Notifications -> Sounds.
  10. Tap the "Import sounds from iTunes File Sharing" button.

Assuming that you correctly formatted the sounds they are now available to use in push notifications.

Via Cloud Storage:#

For this method you need to have a cloud storage app (such as Dropbox, Google Drive, iCloud, OneDrive etc.).

  1. If you don't already have the iOS app for your cloud storage setup, find the appropriate app in the App Store, install and log in to it.
  2. Upload your desired notification sounds to a convenient location on your cloud storage.
  3. In the Home Assistant companion app, open the App Configuration page from the sidebar.
  4. Under Settings, tap Notifications and then Sounds.
  5. Tap "Import custom sound".
  6. Navigate to the folder containing the sound or sounds you wish to add. Note you can switch between cloud providers using the Locations button in the upper-left corner.
  7. Tap Select and then the files you wish to add. When you've selected all the files you want tap Done.
  8. Restart your device.

Importing sounds from iOS#

Apart from the tri-tone—the default text tone, which can be accessed with sound: default—the iOS system sounds are not imported into the Home Assistant companion app. These can however be imported through the following steps:

  1. In the Home Assistant companion app, open the App Configuration page from the sidebar.
  2. Under Settings, tap Notifications and then Sounds.
  3. Tap the "System" tab and then "Import system sounds".
  4. After a few seconds you should be informed the files have been successfully imported.
  5. Restart your device.
  6. iOS sounds can now be used. You can view a the App Configuration page under Notifications and then Sounds and System.
For a full list of sounds imported from iOS, click here.This list is representative for iOS 12, the actual list of imported sounds may vary depending on the configuration of your device and iOS version.

3rdParty_DirectionDown_Haptic.caf3rdParty_DirectionUp_Haptic.caf3rdParty_Failure_Haptic.caf3rdParty_Retry_Haptic.caf3rdParty_Start_Haptic.caf3rdParty_Stop_Haptic.caf3rdParty_Success_Haptic.cafaccess_scan_complete.cafAccessSanComplete_Hapticacknowledgment_received.cafacknowledgment_sent.cafalarm.cafAlarm_Haptic.cafAlarm_Nightstand_Haptic.cafAlert_3rdParty_Haptic.cafAlert_3rdParty_Salient_Haptic.cafAlert_ActivityFriendsGoalAttained_Haptic.cafAlert_ActivityGoalAttained_Haptic.cafAlert_ActivityGoalAttained_Salient_Haptic.cafAlert_ActivityGoalBehind_Haptic.cafAlert_ActivityGoalBehind_Salient_Haptic.cafAlert_ActivityGoalClose_Haptic.cafAlert_BatteryLow_10p_Haptic.cafAlert_BatteryLow_5p_Haptic.cafAlert_BatteryLow_5p_Salient_Haptic.cafAlert_Calendar_Haptic.cafAlert_Calendar_Salient_Haptic.cafAlert_Health_Haptic.cafAlert_Mail_Haptic.cafAlert_Mail_Salient_Haptic.cafAlert_MapsDirectionsInApp_Haptic.cafAlert_Messages_1_Haptic.cafAlert_Messages_1_Salient_Haptic.cafAlert_Messages_2_Haptic.cafAlert_Messages_3_Haptic.cafAlert_PassbookBalance_Haptic.cafAlert_PassbookGeofence_Haptic.cafAlert_PassbookGeofence_Salient_Haptic.cafAlert_PhotostreamActivity_Haptic.cafAlert_ReminderDue_Haptic.cafAlert_ReminderDue_Salient_Haptic.cafAlert_SpartanConnected_LowLatency_Haptic.cafAlert_SpartanConnecting_Haptic.cafAlert_SpartanConnecting_LowLatency_Haptic.cafAlert_SpartanDisconnected_LowLatency_Haptic.cafAlert_Voicemail_Haptic.cafAlert_Voicemail_Salient_Haptic.cafAlert_WalkieTalkie_Haptic.cafAnticipate.cafAutoUnlock_Haptic.cafBatteryMagsafe_Haptic.cafBeat_Haptic.cafbegin_record.cafBloom.cafBuddyMigrationStart_Haptic.cafBuddyPairingFailure_Haptic.cafBuddyPairingRemoteConnection_Haptic.cafBuddyPairingRemoteTap_Haptic.cafBuddyPairingSuccess_Haptic.cafbusy_tone_ansi.cafbusy_tone_cept.cafcall_waiting_tone_ansi.cafcall_waiting_tone_cept.cafCalypso.cafcamera_shutter_burst.cafcamera_shutter_burst_begin.cafcamera_shutter_burst_end.cafcamera_timer_countdown.cafcamera_timer_final_second.cafCameraCountdownImminent_Haptic.cafCameraCountdownTick_Haptic.cafCameraShutter_Haptic.cafChoo_Choo.cafconnect_power.cafct-busy.cafct-call-waiting.cafct-congestion.cafct-error.cafct-keytone2.cafct-path-ack.cafDescent.cafDetent_Haptic.cafDoNotDisturb_Haptic.cafdtmf-0.cafdtmf-1.cafdtmf-2.cafdtmf-3.cafdtmf-4.cafdtmf-5.cafdtmf-6.cafdtmf-7.cafdtmf-8.cafdtmf-9.cafdtmf-pound.cafdtmf-star.cafend_call_tone_cept.cafend_record.cafengage_power.cafengage_power_short.cafET_BeginNotification_Haptic.cafET_BeginNotification_Salient_Haptic.cafET_RemoteTap_Receive_Haptic.cafET_RemoteTap_Send_Haptic.cafFanfare.caffocus_change_app_icon.caffocus_change_keyboard.caffocus_change_large.caffocus_change_small.cafgo_to_sleep_alert.cafGoToSleep_Haptic.cafHealthNotificaiton.cafHourlyChime_Haptic.cafHummingbirdCompletion_Haptic.cafHummingbirdNotification_Haptic.cafjbl_ambiguous.cafjbl_begin.cafjbl_cancel.cafjbl_confirm.cafjbl_no_match.cafkey_press_click.cafkey_press_delete.cafkey_press_modifier.cafkeyboard_press_clear.cafkeyboard_press_delete.cafkeyboard_press_normal.cafLadder.caflock.caflong_low_short_high.caflow_power.cafmail-sent.cafMessagesIncoming_Haptic.cafMessagesOutgoing_Haptic.cafmiddle_9_short_double_low.cafMinuet.cafmultiway_invitation.cafMultiwayInvitation.cafMultiwayJoin.cafMultiwayLeave.cafnavigation_pop.cafnavigation_push.cafNavigationGenericManeuver_Haptic.cafNavigationGenericManeuver_Salient_Haptic.cafNavigationLeftTurn_Haptic.cafNavigationLeftTurn_Salient_Haptic.cafNavigationRightTurn_Haptic.cafNavigationRightTurn_Salient_Haptic.cafnew-mail.cafNews_Flash.cafnfc_scan_complete.cafNoir.cafNotification_Haptic.cafNotification_Salient_Haptic.cafOnOffPasscodeFailure_Haptic.cafOnOffPasscodeUnlock_Haptic.cafOnOffPasscodeUnlockCampanion_Haptic.cafOrbExit_Haptic.cafOrbLayers_Haptic.cafpayment_failure.cafpayment_success.cafPhoneAnswer_Haptic.cafPhoneHangUp_Haptic.cafPhoneHold_Haptic.cafphotoShutter.cafPhotosZoomDetent_Haptic.cafPreview_AudioAndHaptic.cafQB_Dictation_Haptic.cafQB_Dictation_Off_Haptic.cafReceivedMessage.cafRemoteCameraShutterBurstBegin_Haptic.cafRemoteCameraShutterBurstEnd_Haptic.cafringback_tone_ansi.cafringback_tone_aus.cafringback_tone_cept.cafringback_tone_hk.cafringback_tone_uk.cafRingerChanged.cafRingtone_2_Ducked_Haptic-sashimi.cafRingtone_2_Haptic-sashimi.cafRingtone_UK_Haptic.cafRingtone_US_Haptic.cafRingtoneDucked_UK_Haptic.cafRingtoneDucked_US_Haptic.cafSalientNotification_Haptic.cafSedentaryTimer_Haptic.cafSedentaryTimer_Salient_Haptic.cafSentMessage.cafshake.cafSherwood_Forest.cafshort_double_high.cafshort_double_low.cafshort_low_high.cafSIMToolkitCallDropped.cafSIMToolkitGeneralBeep.cafSIMToolkitNegativeACK.cafSIMToolkitPositiveACK.cafSIMToolkitSMS.cafSiriAutoSend_Haptic.cafSiriStart_Haptic.cafSiriStopFailure_Haptic.cafSiriStopSuccess_Haptic.cafsms-received1.cafsms-received1.cafsms-received2.cafsms-received3.cafsms-received4.cafsms-received5.cafsms-received6.cafSOSEmergencyContactTextPrompt_Haptic.cafSOSFallDetection_Haptic-Newton.cafSpell.cafStockholm_Haptic.cafStockholmActive_Haptic.cafStockholmActiveSingleCycle_Haptic.cafStockholmFailure_Haptic.cafStopwatchLap_Haptic.cafStopwatchReset_Haptic.cafStopwatchStart_Haptic.cafStopwatchStop_Haptic.cafSuspense.cafSwish.cafSwTest1_Haptic.cafSystemStartup_Haptic.cafTelegraph.cafTimer_Haptic.cafTimerCancel_Haptic.cafTimerPause_Haptic.cafTimerStart_Haptic.cafTimerWheelHoursDetent_Haptic.cafTimerWheelMinutesDetent_Haptic.cafTink.cafTiptoes.cafTock.caftweet_sent.cafTypewriters.cafUISwipe_Haptic.cafUISwitch_Off_Haptic.cafUISwitch_On_Haptic.cafUpdate.cafussd.cafvc~ended.cafvc~invitation-accepted.cafvc~ringing.cafvc~ringing_watch.cafVoiceOver_Click_Haptic.cafWalkieTalkieActiveEnd_Haptic.cafWalkieTalkieActiveStart_Haptic.cafWalkieTalkieReceiveEnd_Haptic.cafWalkieTalkieReceiveStart_Haptic.cafwarsaw.cafWarsaw_Haptic.cafwheels_of_time.cafWorkoutComplete_Haptic.cafWorkoutCompleteAutoDetect.cafWorkoutCountdown_Haptic.cafWorkoutPaceAbove.cafWorkoutPaceBelow.cafWorkoutPaused_Haptic.cafWorkoutPressStart_Haptic.cafWorkoutResumed_Haptic.cafWorkoutResumedAutoDetect.cafWorkoutSaved_Haptic.cafWorkoutSelect_Haptic.cafWorkoutStartAutoDetect.caf

Pre-installed notification sounds#

For a full list of sounds installed with the app, click here.

US-EN-Alexa-Back-Door-Opened.wavUS-EN-Alexa-Back-Door-Unlocked.wavUS-EN-Alexa-Basement-Door-Opened.wavUS-EN-Alexa-Basement-Door-Unlocked.wavUS-EN-Alexa-Boyfriend-Is-Arriving.wavUS-EN-Alexa-Daughter-Is-Arriving.wavUS-EN-Alexa-Front-Door-Opened.wavUS-EN-Alexa-Front-Door-Unlocked.wavUS-EN-Alexa-Garage-Door-Opened.wavUS-EN-Alexa-Girlfriend-Is-Arriving.wavUS-EN-Alexa-Good-Morning.wavUS-EN-Alexa-Good-Night.wavUS-EN-Alexa-Husband-Is-Arriving.wavUS-EN-Alexa-Mail-Has-Arrived.wavUS-EN-Alexa-Motion-At-Back-Door.wavUS-EN-Alexa-Motion-At-Front-Door.wavUS-EN-Alexa-Motion-Detected-Generic.wavUS-EN-Alexa-Motion-In-Back-Yard.wavUS-EN-Alexa-Motion-In-Basement.wavUS-EN-Alexa-Motion-In-Front-Yard.wavUS-EN-Alexa-Motion-In-Garage.wavUS-EN-Alexa-Patio-Door-Opened.wavUS-EN-Alexa-Patio-Door-Unlocked.wavUS-EN-Alexa-Smoke-Detected-Generic.wavUS-EN-Alexa-Smoke-Detected-In-Basement.wavUS-EN-Alexa-Smoke-Detected-In-Garage.wavUS-EN-Alexa-Smoke-Detected-In-Kitchen.wavUS-EN-Alexa-Son-Is-Arriving.wavUS-EN-Alexa-Water-Detected-Generic.wavUS-EN-Alexa-Water-Detected-In-Basement.wavUS-EN-Alexa-Water-Detected-In-Garage.wavUS-EN-Alexa-Water-Detected-In-Kitchen.wavUS-EN-Alexa-Welcome-Home.wavUS-EN-Alexa-Wife-Is-Arriving.wavUS-EN-Daisy-Back-Door-Motion.wavUS-EN-Daisy-Back-Door-Open.wavUS-EN-Daisy-Front-Door-Motion.wavUS-EN-Daisy-Front-Door-Open.wavUS-EN-Daisy-Front-Window-Open.wavUS-EN-Daisy-Garage-Door-Open.wavUS-EN-Daisy-Guest-Bath-Leak.wavUS-EN-Daisy-Kitchen-Sink-Leak.wavUS-EN-Daisy-Kitchen-Window-Open.wavUS-EN-Daisy-Laundry-Room-Leak.wavUS-EN-Daisy-Master-Bath-Leak.wavUS-EN-Daisy-Master-Bedroom-Window-Open.wavUS-EN-Daisy-Office-Window-Open.wavUS-EN-Daisy-Refrigerator-Leak.wavUS-EN-Daisy-Water-Heater-Leak.wavUS-EN-Morgan-Freeman-Back-Door-Closed.wavUS-EN-Morgan-Freeman-Back-Door-Locked.wavUS-EN-Morgan-Freeman-Back-Door-Opened.wavUS-EN-Morgan-Freeman-Back-Door-Unlocked.wavUS-EN-Morgan-Freeman-Basement-Door-Closed.wavUS-EN-Morgan-Freeman-Basement-Door-Locked.wavUS-EN-Morgan-Freeman-Basement-Door-Opened.wavUS-EN-Morgan-Freeman-Basement-Door-Unlocked.wavUS-EN-Morgan-Freeman-Boss-Is-Arriving.wavUS-EN-Morgan-Freeman-Boyfriend-Is-Arriving.wavUS-EN-Morgan-Freeman-Cleaning-Supplies-Closet-Opened.wavUS-EN-Morgan-Freeman-Coworker-Is-Arriving.wavUS-EN-Morgan-Freeman-Daughter-Is-Arriving.wavUS-EN-Morgan-Freeman-Friend-Is-Arriving.wavUS-EN-Morgan-Freeman-Front-Door-Closed.wavUS-EN-Morgan-Freeman-Front-Door-Locked.wavUS-EN-Morgan-Freeman-Front-Door-Opened.wavUS-EN-Morgan-Freeman-Front-Door-Unlocked.wavUS-EN-Morgan-Freeman-Garage-Door-Closed.wavUS-EN-Morgan-Freeman-Garage-Door-Opened.wavUS-EN-Morgan-Freeman-Girlfriend-Is-Arriving.wavUS-EN-Morgan-Freeman-Good-Morning.wavUS-EN-Morgan-Freeman-Good-Night.wavUS-EN-Morgan-Freeman-Liquor-Cabinet-Opened.wavUS-EN-Morgan-Freeman-Motion-Detected.wavUS-EN-Morgan-Freeman-Motion-In-Basement.wavUS-EN-Morgan-Freeman-Motion-In-Bedroom.wavUS-EN-Morgan-Freeman-Motion-In-Game-Room.wavUS-EN-Morgan-Freeman-Motion-In-Garage.wavUS-EN-Morgan-Freeman-Motion-In-Kitchen.wavUS-EN-Morgan-Freeman-Motion-In-Living-Room.wavUS-EN-Morgan-Freeman-Motion-In-Theater.wavUS-EN-Morgan-Freeman-Motion-In-Wine-Cellar.wavUS-EN-Morgan-Freeman-Patio-Door-Closed.wavUS-EN-Morgan-Freeman-Patio-Door-Locked.wavUS-EN-Morgan-Freeman-Patio-Door-Opened.wavUS-EN-Morgan-Freeman-Patio-Door-Unlocked.wavUS-EN-Morgan-Freeman-Roommate-Is-Arriving.wavUS-EN-Morgan-Freeman-Searching-For-Car-Keys.wavUS-EN-Morgan-Freeman-Setting-The-Mood.wavUS-EN-Morgan-Freeman-Smartthings-Detected-A-Flood.wavUS-EN-Morgan-Freeman-Smartthings-Detected-Carbon-Monoxide.wavUS-EN-Morgan-Freeman-Smartthings-Detected-Smoke.wavUS-EN-Morgan-Freeman-Smoke-Detected-In-Basement.wavUS-EN-Morgan-Freeman-Smoke-Detected-In-Garage.wavUS-EN-Morgan-Freeman-Smoke-Detected-In-Kitchen.wavUS-EN-Morgan-Freeman-Someone-Is-Arriving.wavUS-EN-Morgan-Freeman-Son-Is-Arriving.wavUS-EN-Morgan-Freeman-Starting-Movie-Mode.wavUS-EN-Morgan-Freeman-Starting-Party-Mode.wavUS-EN-Morgan-Freeman-Starting-Romance-Mode.wavUS-EN-Morgan-Freeman-Turning-Off-All-The-Lights.wavUS-EN-Morgan-Freeman-Turning-Off-The-Air-Conditioner.wavUS-EN-Morgan-Freeman-Turning-Off-The-Bar-Lights.wavUS-EN-Morgan-Freeman-Turning-Off-The-Chandelier.wavUS-EN-Morgan-Freeman-Turning-Off-The-Family-Room-Lights.wavUS-EN-Morgan-Freeman-Turning-Off-The-Hallway-Lights.wavUS-EN-Morgan-Freeman-Turning-Off-The-Kitchen-Light.wavUS-EN-Morgan-Freeman-Turning-Off-The-Light.wavUS-EN-Morgan-Freeman-Turning-Off-The-Lights.wavUS-EN-Morgan-Freeman-Turning-Off-The-Mood-Lights.wavUS-EN-Morgan-Freeman-Turning-Off-The-TV.wavUS-EN-Morgan-Freeman-Turning-On-The-Air-Conditioner.wavUS-EN-Morgan-Freeman-Turning-On-The-Bar-Lights.wavUS-EN-Morgan-Freeman-Turning-On-The-Chandelier.wavUS-EN-Morgan-Freeman-Turning-On-The-Family-Room-Lights.wavUS-EN-Morgan-Freeman-Turning-On-The-Hallway-Lights.wavUS-EN-Morgan-Freeman-Turning-On-The-Kitchen-Light.wavUS-EN-Morgan-Freeman-Turning-On-The-Light.wavUS-EN-Morgan-Freeman-Turning-On-The-Lights.wavUS-EN-Morgan-Freeman-Turning-On-The-Mood-Lights.wavUS-EN-Morgan-Freeman-Turning-On-The-TV.wavUS-EN-Morgan-Freeman-Vacate-The-Premises.wavUS-EN-Morgan-Freeman-Water-Detected-In-Basement.wavUS-EN-Morgan-Freeman-Water-Detected-In-Garage.wavUS-EN-Morgan-Freeman-Water-Detected-In-Kitchen.wavUS-EN-Morgan-Freeman-Welcome-Home.wavUS-EN-Morgan-Freeman-Wife-Is-Arriving.wav