Skip to content

Attributes

In this section, this we review device attributes and some basic example values.


alarmVolume: (String)

#

Description

Current alarm/reminder alert volume.

Example Output

47


alarmSupported: (Boolean)

#

Description

Identifies if device supports alarm management control actions.

Example Output

true


alexaPlaylists: (JSON_Object)

#

Description

Contains current playlist in use by the device.

Example Output

    {
       "Home Audio": [
          {
              "title": "Home Audio",
              "playlistId": "a1553cd7-f732-4f7e-ac3c-995b94860e57",
              "entryList": null,
              "version": "1",
              "trackCount": 0
          }
       ]
    }

alexaWakeWord: (String)

#

Description

Contains the devices current wake word.

Example Output

ALEXA


audioTrackData: (JSON_Object)

#

Description

Contains current music track data as JSON.

Example Output

    {
      "title": "Blinding Lights",
      "artist": "The Weeknd",
      "album": "After Hours [Explicit]",
      "albumArtUrl": "https://m.media-amazon.com/images/I/81XiZxda-8L._UL600_.jpg",
      "mediaSource":"Amazon Music"
    }

btDeviceConnected: (String)

#

Description

Contains the current bluetooth device connected to the alexa device.

Example Output

JBL Pulse 2


btDevicesPaired: (String)

#

Description

Contains a list of currently paired (available) bluetooth devices to the alexa device.

Example Output

[AirPods, JBL Pulse 2]


currentAlbum: (String)

#

Description

Contains a current audio album.

Example Output

Dean Martin


currentStation: (String)

#

Description

Contains a current music source.

Example Output

Holiday Favorites Station


deviceFamily: (String)

#

Description

Contains the device family identifier used by amazon.

Example Output

ROOK


deviceStatus: (String)

#

Description

Contains the current player status.

Example Output

playing_echo_spot_gen1


deviceStyle: (String)

#

Description

Contains the description from the developer for the current device.

Example Output

Echo Spot


deviceType: (String)

#

Description

Contains the device type (model number) identifier used by amazon.

Example Output

A10A33FOX2NUBK


doNotDisturb: (String)

#

Description

Contains the devices current Do not Disturb status.

Example Output

false


followUpMode: (String)

#

Description

Whether the device immediately waits for another command after executing the first one.

Example Output

true


firmwareVer: (String)

#

Description

Contains the devices current firmware revision.

Example Output

625533420


lastAnnouncement: (String)

#

Description

Contains the text used by the last playAnnouncement() command. Useful for replaying the last announcement message.

Example Output

The Front Door Lock is unlocked


lastCmdSentDt: (String)

#

Description

Contains the date/time of the last speak command.

Example Output

Mon Dec 03 09:16:09 EST 2018


lastSpeakCmd: (String)

#

Description

Contains the text used by the last Speak() command. Useful for replaying the last message.

Example Output

The Front Door Lock is unlocked


lastSpokenToTime: (Timestamp)

#

Description

Contains the timestamp of the last command given to the alexa device.

Example Output

1548456169854


lastUpdated: (String)

#

Description

Contains the date/time of the last device data refresh.

Example Output

Dec 3, 2018 - 12:47:43 PM


lastVoiceActivity: (String)

#

Description

Contains the last voice command given to the alexa device.

Example Output

what time is it


onlineStatus: (String)

#

Description

Contains the devices current online status under amazon.

Example Output

online


permissions: (Boolean)

#

Description

Identifies the devices available features.

Example Output

[TTS, alarms, amazonMusic, announce, appleMusic, bluetoothControl, doNotDisturb, flashBriefing, followUpMode, iHeartRadio, isEchoDevice, isMultiroomMember, mediaPlayer, microphone, pandoraRadio, reminders, spotify, tuneInRadio, volumeControl, wakeWord]


supportedMusic: (String)

#

Description

Identifies the devices supported music providers.

Example Output

Amazon Music, Apple Music, My Library, Pandora, TuneIn, iHeartRadio


trackImage: (String)

#

Description

Contains the current track image url.

Example Output

https://m.media-amazon.com/images/I/71mwv+MFxSL.UL600.jpg


trackImageHtml: (String)

#

Description

Contains the current track image as an html object for dashboards.

Example Output


wakeWords: (Enum)

#

Description

Contains list of available alexa wake words.

Example Output

["ALEXA","AMAZON","ECHO","COMPUTER"]


wasLastSpokeToDevice: (Boolean)

#

Description

Used to identify if the device was the last device spoken to on your account.

Example Output

true



Last update: 2021-03-22