Skip to content

General

Do Not Disturb

#

doNotDisturbOn()

#

Description

Activates Do Not Disturb for the device

Required Paramaters

None Accepted

doNotDisturbOff()

#

Description

Disables Do Not Disturb for the device

Required Paramaters

None Accepted

Volume Control

#

storeCurrentVolume()

#

NOTICE

This is not always accurate. Aquiring the volume level requires media to have been playing or you send a volume change using SmartThings at least once.

Description

  • Captures current device volume

Required Paramaters

  • None Accepted

restoreLastVolume()

#

Description

  • Restores volume to captured volume using storeCurrentVolume()

Required Paramaters

  • None Accepted

setAlarmVolume()

#

NOTICE

Only available on devices that support alarms and/or reminders

Description

  • Sets the Echo Devices Alarm and Reminder Notification volume

Required Paramaters

  • Volume (Integer): Number value between 0-100

Example Usage

  • setAlarmVolume(40)

Change Wake Word

#

setWakeWord()

#

Description

  • Change the alexa wake word used to get Alexa to respond to commands

Required Paramaters

  • WakeWord (String): ["ALEXA", "AMAZON", "ECHO", "COMPUTER"]

    Tips

    At this time you can only use 5 names below

Example Usage

  • setWakeWord("ECHO")

Rename Device

#

renameDevice()

#

Description

  • Changes the alexa device name under your amazon account

Required Paramaters

  • Device Name (String): Any alphanumeric text accepted

Example Usage

  • renameDevice("New Device Name")

Device Activity

#

getDeviceActivity()

#

Description

Updates the activity data for the attributes "wasLastSpokenToDevice" and "lastVoiceActivity" (There can be a minor delay because of Amazon Rate-Limiting)

Required Paramaters

  • None Accepted

Example Usage

  • getDeviceActivity()

Bluetooth Control

#

getBluetoothDevices()

#

Description

  • Refreshes all bluetooth devices for the alexa device

Required Paramaters

  • None Accepted

Example Usage

  • getBluetoothDevices()

connectBluetooth()

#

Description

Will connected a paired bluetooth device by name. (Look at attribute btDevicesPaired for a list of paired device names

Required Paramaters

  • Device Name (String): Look at attribute btDevicesPaired for a list of paired device names

Example Usage

  • connectBluetooth("JBL Pulse 2")

disconnectBluetooth()

#

Description

  • Disconnects the bluetooth device currently connected to the Alexa device

Required Paramaters

  • None Accepted

Example Usage

  • disconnectBluetooth()

removeBluetooth()

#

Description

Removes bluetooth device pairing from alexa device by name. (Look at attribute btDevicesPaired for a list of paired device names

Required Paramaters

  • Device Name (String): Look at attribute btDevicesPaired for a list of paired device names

Example Usage

  • removeBluetooth("JBL Pulse 2")

Sequences

#

executeSequenceCommand()

#

Description

Allows you to send a custom sequence of actions to Amazon as a single command that will be executed one at a time by Amazon.

Required Paramaters

Available Sequence Items (String):

General Items:
  - weather
  - traffic
  - flashbriefing
  - goodnews
  - goodmorning
  - goodnight
  - cleanup
  - singasong
  - tellstory
  - funfact
  - joke
  - playsearch
  - calendartoday
  - calendartomorrow
  - calendarnext
  - stop
  - stopalldevices
  - wait::value (seconds)
  - volume::value (0-100)
  - speak::message
  - announcement::message
  - announcementall::message
  - pushnotification::message

Canned TTS Speech:
  - cannedtts_random::(accepted values below)
    * goodbye
    * confirmations
    * goodmorning
    * compliments
    * birthday
    * goodnight
    * iamhome

Sounds:
  - sound::(accepted values below)

    Bells and Buzzer Sounds:
    * bells
    * buzzer
    * church_bell
    * doorbell1
    * doorbell2
    * doorbell3

    Holiday Sounds:
    * xmas_bells
    * halloween_door

    Misc Sounds:
    * air_horn
    * boing1
    * boing2
    * camera
    * squeaky_door
    * ticking_clock
    * trumpet

    Animals Sounds:
    * cat
    * dog
    * lion
    * rooster
    * wolf

    Scifi Sounds:
    * aircraft
    * engines
    * red_alert
    * shields
    * sirens
    * zap

    Crowd sounds:
    * applause
    * cheer

Music:
  - cloudplayer::search term

Enter the command in a format exactly like this:

volume::40,, speak::this is so silly,, wait::60, weather,, cannedtts_random::goodbye,, traffic,, amazonmusic::green day,, volume::30

NOTE

Each command::value pair needs to be separated by a double comma ,, and the separator between the command and value must be command::value

Example Usage

  • executeSequenceCommand("volume::50,, speak::This is pretty cool,, volume::30")
Last update: 2021-03-22