Speech
General Speech
#
replayText()
#
Description
Will replay the last text sent to the device.
Required Paramaters
- None Accepted
Custom Speech
#
setVolumeAndSpeak()
#
NOTICE
This command is highly recommend in place of sending an individual command for both volume and speaking.
When used it is set to Amazon as a single command and executed in a sequence.
Description
Sends volume command first, then plays message.
Required Paramaters
- Volume (Integer):
Number between 0-100 - Message (String):
Text between 1-400 characters in length
Example Usage
setVolumeAndSpeak(47, "The Front door is unlocked")
voiceCmdAsText()
#
Description
Simulates a voice initiated command. Can be used to do anything you can prompt by saying 'alexa'
Required Paramaters
- Command Message (String):
Text between 1-400 characters in length
Example Usage
voiceCmdAsText("Tell FordPass to lock my truck")
parallelSpeak()
#
Description
Used by the main app to indentify simultaenous speech commands and merging them to into a single command to be sent to amazon
Required Paramaters
- Message (String):
Text between 1-400 characters in length
Example Usage
parallelSpeak("The Front door is unlocked")
setVolumeSpeakAndRestore()
#
NOTICE
- This command is highly recommended in place of sending individual commands for setVolume(47), speak("The Front door is unlocked"), and setVolume(30).
- When used it is set to Amazon as a single command and executed in a sequence.
- When the command is called it captures the current volume and restores immediately after the message is played.
Description
Sends volume command first, then plays message, and restores original volume
Required Paramaters
- Volume (Integer):
Number between 0-100 - Message (String):
Text between 1-400 characters in length - Restore Volume (Integer):
Number between 0-100
Example Usage
setVolumeSpeakAndRestore(50, "The Front door is unlocked", 30)
Builin Speech Routines
#
playWeather()
#
Description
Alexa will give the current weather conditions
Optional Paramaters
- Volume (Integer):
Number between 0-100 - Restore Volume (Integer):
Number between 0-100
Example Usage
playWeather()playWeather(30)playWeather(30, 50)
playSingASong()
#
Description
Alexa will sing a random song
Optional Paramaters
- Volume (Integer):
Number between 0-100 - Restore Volume (Integer):
Number between 0-100
Example Usage
playSingASong()playSingASong(30)playSingASong(30, 50)
playFlashBrief()
#
Description
Alexa will play the your flash briefing News (If device supports it)
Optional Paramaters
- Volume (Integer):
Number between 0-100 - Restore Volume (Integer):
Number between 0-100
Example Usage
playFlashBrief()playFlashBrief(30)playFlashBrief(30, 50)
playGoodNews()
#
Description
Alexa will play something containing Good News (If device supports it)
Optional Paramaters
- Volume (Integer):
Number between 0-100 - Restore Volume (Integer):
Number between 0-100
Example Usage
playGoodNews()playGoodNews(30)playGoodNews(30, 50)
sayBirthday()
#
Description
Alexa will say a random happy birthday message
Optional Paramaters
- Volume (Integer):
Number between 0-100 - Restore Volume (Integer):
Number between 0-100
Example Usage
sayBirthday()sayBirthday(30)sayBirthday(30, 50)
sayCompliment()
#
Description
Alexa will say a random compliment message
Optional Paramaters
- Volume (Integer):
Number between 0-100 - Restore Volume (Integer):
Number between 0-100
Example Usage
sayCompliment()sayCompliment(30)sayCompliment(30, 50)
sayGoodbye()
#
Description
Alexa will say a random goodbye message
Optional Paramaters
- Volume (Integer):
Number between 0-100 - Restore Volume (Integer):
Number between 0-100
Example Usage
sayGoodbye()sayGoodbye(30)sayGoodbye(30, 50)
sayGoodMorning()
#
Description
Alexa will play the your good morning run down
Optional Paramaters
- Volume (Integer):
Number between 0-100 - Restore Volume (Integer):
Number between 0-100
Example Usage
sayGoodMorning()sayGoodMorning(30)sayGoodMorning(30, 50)
sayGoodNight()
#
Description
Alexa will say a random good night message
Optional Paramaters
- Volume (Integer):
Number between 0-100 - Restore Volume (Integer):
Number between 0-100
Example Usage
sayGoodNight()sayGoodNight(30)sayGoodNight(30, 50)
sayWelcomeHome()
#
Description
Alexa will say a random welcome home message
Optional Paramaters
- Volume (Integer):
Number between 0-100 - Restore Volume (Integer):
Number between 0-100
Example Usage
sayWelcomeHome()sayWelcomeHome(30)sayWelcomeHome(30, 50)
playTraffic()
#
Description
Alexa will give the current traffic condition on your way to work
Optional Paramaters
- Volume (Integer):
Number between 0-100 - Restore Volume (Integer):
Number between 0-100
Example Usage
playTraffic()playTraffic(30)playTraffic(30, 50)
playTellStory()
#
Description
Alexa will tell a random story
Optional Paramaters
- Volume (Integer):
Number between 0-100 - Restore Volume (Integer):
Number between 0-100
Example Usage
playTellStory()playTellStory(30)playTellStory(30, 50)
playFunFact()
#
Description
Alexa will tell a random fun fact
Optional Paramaters
- Volume (Integer):
Number between 0-100 - Restore Volume (Integer):
Number between 0-100
Example Usage
playFunFact()playFunFact(30)playFunFact(30, 50)
playJoke()
#
Description
Alexa will tell a random joke
Optional Paramaters
- Volume (Integer):
Number between 0-100 - Restore Volume (Integer):
Number between 0-100
Example Usage
playJoke()playJoke(30)playJoke(30, 50)
playCalendarToday()
#
NOTICE
Only available when you connected calendar accounts to your amazon alexa account
Description
Alexa will read all of the calendar events for the day
Optional Paramaters
- Volume (Integer):
Number between 0-100 - Restore Volume (Integer):
Number between 0-100
Example Usage
playCalendarToday()playCalendarToday(30)playCalendarToday(30, 50)
playCalendarTomorrow()
#
NOTICE
Only available when you connected calendar accounts to your amazon alexa account
Description
Alexa will read all of the calendar events for tomorrow
Optional Paramaters
- Volume (Integer):
Number between 0-100 - Restore Volume (Integer):
Number between 0-100
Example Usage
playCalendarTomorrow()playCalendarTomorrow(30)playCalendarTomorrow(30, 50)
playCalendarNext()
#
NOTICE
Only available when you connected calendar accounts to your amazon alexa account
Description
Alexa will read the next calendar event
Optional Paramaters
- Volume (Integer):
Number between 0-100 - Restore Volume (Integer):
Number between 0-100
Example Usage
playCalendarNext()playCalendarNext(30)playCalendarNext(30, 50)
playAnnouncement(message)
#
Description
This will make an announcement with the message on the device executing the command
Required Paramaters
- Message (String):
Text between 1-400 characters in length
Optional Paramaters
- Title (String):
String between 1-40 characters in length (For Echo Show/Spot Display) - Volume (Integer):
Number between 0-100 - Restore Volume (Integer):
Number between 0-100
Example Usage
playAnnouncement("the garage door has opened")playAnnouncement("the garage door has opened", "Door Alert")playAnnouncement("the garage door has opened", "Door Alert", 40)playAnnouncement("the garage door has opened", "Door Alert", 40, 30)
playAnnouncementAll(message)
#
Description
This will make an announcement with the message on all echo devices on your account
Notice: This command is a complicated one. If you want to announce on all of your echo devices just select one device to send the command to. Amazon will send it to all devices on it's end. So a single device can trigger all to speak. I've seen it to where Amazon will rate-limit so if the devices in the announcement so they will not speak.
Required Paramaters
- Message (String):
Text between 1-400 characters in length
Optional Paramaters
- Title(String):
String between 1-400 characters in length (For Echo Show/Spots Display)
Example Usage
playAnnouncementAll("the garage door has opened")playAnnouncementAll("the garage door has opened", "Door Alert")
Sounds
#
playSoundByName()
#
Description
Play sounds found in the Alexa Skills Kit Sound Library (Only Sounds who's file name starts with 'amzn_sfx_')
Required Paramaters
- Sound File Name (String):
String (Should support any alexa skills kit sound that starts with 'amzn_sfx_' | https://developer.amazon.com/docs/custom-skills/ask-soundlibrary.html)
Optional Paramaters
- Volume (Integer):
Number between 0-100 - Restore Volume (Integer):
Number between 0-100
Example Usage
playSoundByName("amzn_sfx_bear_groan_roar_01")playSoundByName("amzn_sfx_bear_groan_roar_01", 50)playSoundByName("amzn_sfx_bear_groan_roar_01", 50, 30)