Alexa.Networking.HomeNetworkController Interface 3

Implement the Alexa.Networking.HomeNetworkController interface in your Alexa skill to represent a home network. The HomeNetworkController interface is an abstract representation of a home network, and represents an IP network router. For an overview of the Alexa networking API, see Understand Networking and Wi-Fi Skills.

Before you test a skill that uses the HomeNetworkController interface, make sure you use the Alexa app to add a device to the network you're testing with. For more details, see Overview of Wi-Fi Skills.

For the list of languages that the HomeNetworkController interface supports, see List of Alexa Interfaces and Supported Languages. For the definitions of the message properties, see Alexa Interface Message and Property Reference.

Discovery

You describe endpoints that support Alexa.Networking.HomeNetworkController using the standard discovery mechanism described in Alexa.Discovery.

For the full list of display categories, see display categories.

Discover response example

The following example shows a Discover.Response message for a network router that supports the HomeNetworkController interface.

Copied to clipboard.

{
  "event": {
    "header": {
      "namespace": "Alexa.Discovery",
      "name": "Discover.Response",
      "payloadVersion": "3",
      "messageId": "Unique identifier, preferably a version 4 UUID"
    },
    "payload": {
      "endpoints": [
        {
          "endpointId": "Unique ID of the endpoint",
          "manufacturerName": "Manufacturer of the endpoint",
          "description": "Description to be shown in the Alexa app",
          "friendlyName": "Your device name, displayed in the Alexa app, optional for this interface",
          "displayCategories": ["NETWORK_HARDWARE"],
          "cookie": {},
          "capabilities": [
            {
              "type": "AlexaInterface",
              "interface": "Alexa.Networking.HomeNetworkController",
              "version": "3"
            },
            {
              "type": "AlexaInterface",
              "interface": "Alexa",
              "version": "3"
            }
          ]
        }
      ]
    }
  }
}

Last updated: Nov 08, 2022