Alexa.SoftwareComponentReporter 1.0

The Alexa.SoftwareComponentReporter interface allows the device to report software information to the Alexa Voice Service (AVS). Our Solutions Architects use this information to help you troubleshoot any problems.

Capability assertion

A device can implement Alexa.SoftwareComponentReporter 1.0 on its own behalf, but not on behalf of any connected endpoints.

New AVS integrations must assert support through Alexa.Discovery. However, Alexa continues to support existing integrations using the Capabilities API.

Sample Declaration

{
  "type": "AlexaInterface",
  "interface": "Alexa.SoftwareComponentReporter",
  "version": "1.0",
  "configurations": {
    "softwareComponents": [
      {
        "name": "{{STRING}}",
        "version": "{{STRING}}"
      }
    ]
  }
}

Configuration parameters

Value Description Type
softwareComponents Contains information about the software running on the device. list
softwareComponents.name The unique name of a software component running on the device, limited to 256 characters. Use reverse-DNS notation for component names to guarantee global uniqueness. For example, you might report a custom media player as com.company.mediaplayer. string
softwareComponents.version The version of the software component running on the device, limited to 256 characters. Use dot-separated notation with alphanumeric characters, increasing both monotonically and lexicographically. For example, you might report a software version as 1.12.3. string
Was this page helpful?

Last updated: Nov 27, 2023