Smarthome skill Alexa.Discovery request and response has changed?

Question

question

NewUser-6d8179cc-e27a-4ef2-9b12-22c08c4d7cea asked · Aug 09 at 03:09 PM

Smarthome skill Alexa.Discovery request and response has changed?

Hello there, I need a little help with the JSON format of Discovery requests and responses.

The Alexa.Discovery request arriving on my webhook seems to be a little different from the docs (https://developer.amazon.com/it/docs/device-apis/alexa-discovery.html)

I have made the adjustments and ended up with this code:

exports.handler = function (request, context) {
  console.log("req:", request);
  console.log("ctx:", context);
  if (request.directive.header.namespace === 'Alexa.ConnectedHome.Discovery' && request.directive.header.name === 'DiscoverAppliancesRequest') {
      log("DEBUG:", "Discover request",  JSON.stringify(request));
      handleDiscovery(request, context, "");
  }
  else if (request.directive.header.namespace === 'Alexa.PowerController') {
      if (request.directive.header.name === 'TurnOn' || request.directive.header.name === 'TurnOff') {
          log("DEBUG:", "TurnOn or TurnOff Request", JSON.stringify(request));
          handlePowerControl(request, context);
      }
  }

  function handleDiscovery(request, context) {
      var payload = {
          "endpoints":
          [
              {
                  "endpointId": "demo_id",
                  "manufacturerName": "Smart Device Company",
                  "friendlyName": "Bedroom Outlet",
                  "description": "Smart Device Switch",
                  "displayCategories": ["SWITCH"],
                  "cookie": {
                      "key1": "arbitrary key/value pairs for skill to reference this endpoint.",
                      "key2": "There can be multiple entries",
                      "key3": "but they should only be used for reference purposes.",
                      "key4": "This is not a suitable place to maintain current endpoint state."
                  },
                  "capabilities":
                  [
                      {
                        "type": "AlexaInterface",
                        "interface": "Alexa",
                        "version": "3"
                      },
                      {
                          "interface": "Alexa.PowerController",
                          "version": "3",
                          "type": "AlexaInterface",
                          "properties": {
                              "supported": [{
                                  "name": "powerState"
                              }],
                               "retrievable": true
                          }
                      }
                  ]
              }
          ]
      };
      var header = request.directive.header;
      header.name = "Discover.Response";
      log("DEBUG", "Discovery Response: ", JSON.stringify({ header: header, payload: payload }));
      context.succeed({ event: { header: header, payload: payload } });
  }

  function log(message, message1, message2) {
      console.log(message + message1 + message2);
  }

  function handlePowerControl(request, context) {
      // get device ID passed in during discovery
      var requestMethod = request.directive.header.name;
      var responseHeader = request.directive.header;
      responseHeader.namespace = "Alexa";
      responseHeader.name = "Response";
      responseHeader.messageId = responseHeader.messageId + "-R";
      // get user token pass in request
      var requestToken = request.directive.endpoint.scope.token;
      var powerResult;

      if (requestMethod === "TurnOn") {

          // Make the call to your device cloud for control
          // powerResult = stubControlFunctionToYourCloud(endpointId, token, request);
          powerResult = "ON";
      }
     else if (requestMethod === "TurnOff") {
          // Make the call to your device cloud for control and check for success
          // powerResult = stubControlFunctionToYourCloud(endpointId, token, request);
          powerResult = "OFF";
      }
      var contextResult = {
          "properties": [{
              "namespace": "Alexa.PowerController",
              "name": "powerState",
              "value": powerResult,
              "timeOfSample": "2017-09-03T16:20:50.52Z", //retrieve from result.
              "uncertaintyInMilliseconds": 50
          }]
      };
      var response = {
          context: contextResult,
          event: {
              header: responseHeader,
              endpoint: {
                  scope: {
                      type: "BearerToken",
                      token: requestToken
                  },
                  endpointId: "demo_id"
              },
              payload: {}
          }
      };
      log("DEBUG", "Alexa.PowerController ", JSON.stringify(response));
      context.succeed(response);
  }
};

That from the AWS lambda console generate this response:

{
  "event": {
    "header": {
      "messageId": "F8752B11-69BB-4246-B923-3BFB27C06C7D",
      "name": "Discover.Response",
      "namespace": "Alexa.ConnectedHome.Discovery",
      "payloadVersion": "3"
    },
    "payload": {
      "endpoints": [
        {
          "endpointId": "demo_id",
          "manufacturerName": "Smart Device Company",
          "friendlyName": "Bedroom Outlet",
          "description": "Smart Device Switch",
          "displayCategories": [
            "SWITCH"
          ],
          "cookie": {
            "key1": "arbitrary key/value pairs for skill to reference this endpoint.",
            "key2": "There can be multiple entries",
            "key3": "but they should only be used for reference purposes.",
            "key4": "This is not a suitable place to maintain current endpoint state."
          },
          "capabilities": [
            {
              "type": "AlexaInterface",
              "interface": "Alexa",
              "version": "3"
            },
            {
              "interface": "Alexa.PowerController",
              "version": "3",
              "type": "AlexaInterface",
              "properties": {
                "supported": [
                  {
                    "name": "powerState"
                  }
                ],
                "retrievable": true
              }
            }
          ]
        }
      ]
    }
  }
}

But when I test it from the Alexa developer console I got only the message that it is unable to find any device.

Can someone point me to updated documentation or shred some light on what I am doing wrong?

smart home

0

10 |2000 characters needed characters left characters exceeded

Attachments: Up to 2 attachments (including images) can be used with a maximum of 524.3 kB each and 1.0 MB total.

2 Answers

Answer 1 · 2019-08-12T15:17:56Z

barry@amazon answered · Aug 12 at 03:17 PM · ACCEPTED ANSWER

Hello and thank you for your message.

In your code snippet, you are testing request.directive.header.namespace and request.directive.header.name for the values Alexa.ConnectedHome.Discovery and DiscoverAppliancesRequest respectively. However, if you look at the documentation for the Alexa.Discovery directive, you can see that the namespace and the name sent when performing a discovery are Alexa.Discovery and Discover.

Since your code is not waiting for the correct requests, it never gets triggered.

Regards,
Barry

1 · Show 1 · Share

10 |2000 characters needed characters left characters exceeded

Attachments: Up to 2 attachments (including images) can be used with a maximum of 524.3 kB each and 1.0 MB total.

NewUser-6d8179cc-e27a-4ef2-9b12-22c08c4d7cea · Aug 19 at 02:05 PM

Thank you barry.

1 · Share ·

Answer 2 · 2019-08-20T15:15:46Z

NewUser-6d8179cc-e27a-4ef2-9b12-22c08c4d7cea answered · Aug 20 at 03:15 PM

Hello @barry@amazon following the documentation I tried to implement the Alexa.Cooking interface. But I'm facing some trouble. This is the code:

exports.handler = function(request, context) {
  log("DEBUG ", "Request: ", JSON.stringify(request));

  if (
    request.directive.header.namespace === "Alexa.Discovery" &&
    request.directive.header.name === "Discover"
  ) {
    log("DEBUG:", "Discover request", JSON.stringify(request));
    handleDiscovery(request, context, "");
  }
  if (
    request.directive.header.namespace === "Alexa.Cooking" &&
    request.directive.header.name === "SetCookingMode"
  ) {
    handleSetCookingMode(request, context, "");
  }

  function handleDiscovery(request, context) {
    var payload = {
      endpoints: [
        {
          endpointId: "uniqueIdOfApplianceEndpoint",
          manufacturerName: "the manufacturer name of the endpoint",
          friendlyName: "OvenTest",
          description: "a description that is shown to the customer",
          displayCategories: ["MICROWAVE"],
          cookie: {},
          capabilities: [
            {
              type: "AlexaInterface",
              interface: "Alexa",
              version: "3"
            },
            {
              type: "AlexaInterface",
              interface: "Alexa.Cooking",
              version: "3",
              properties: {
                supported: [
                  {
                    name: "cookingMode"
                  },
                  {
                    name: "cookCompletionTime"
                  },
                  {
                    name: "isCookCompletionTimeEstimated"
                  },
                  {
                    name: "cookStartTime"
                  },
                  {
                    name: "foodItem"
                  }
                ],
                proactivelyReported: true,
                retrievable: true
              },
              configuration: {
                supportsRemoteStart: false,
                supportedCookingModes: ["OFF", "DEFROST", "REHEAT"]
              }
            }
          ]
        }
      ]
    };
    var header = request.directive.header;
    header.name = "Discover.Response";
    log(
      "DEBUG",
      "Discovery Response: ",
      JSON.stringify({ header: header, payload: payload })
    );
    context.succeed({ event: { header: header, payload: payload } });
  }

  function handleSetCookingMode(request, context) {
    let requestMethod = request.directive.header.name;
    let responseHeader = request.directive.header;
    responseHeader.namespace = "Alexa";
    responseHeader.name = "Response";
    responseHeader.messageId = responseHeader.messageId + "-R";
    // get user token pass in request
    let requestToken = request.directive.endpoint.scope.token;
    //let cookingMode = "" TODO: dovrei beccarlo dai dati che mi vengono passati dal db o qualcosa del genere.
    let contextResult = {
      properties: [
        {
          namespace: "Alexa.Cooking",
          name: "cookingMode",
          value: request.directive.payload.cookingMode.value,
          timeOfSample: "2017-09-03T16:20:50.52Z", //retrieve from result.
          uncertaintyInMilliseconds: 0
        },
        {
          namespace: "Alexa.Cooking",
          name: "cookCompletionTime",
          value: "2017-09-03T18:20:50.52Z",
          timeOfSample: "2017-09-03T16:20:50.52Z", //retrieve from result.
          uncertaintyInMilliseconds: 0
        },
        {
          namespace: "Alexa.Cooking",
          name: "isCookCompletionTimeEstimated",
          value: false,
          timeOfSample: "2017-09-03T16:20:50.52Z", //retrieve from result.
          uncertaintyInMilliseconds: 0
        },
        {
          namespace: "Alexa.Cooking",
          name: "cookStartTime",
          value: "2017-09-03T16:20:50.52Z",
          timeOfSample: "2017-09-03T16:20:50.52Z", //retrieve from result.
          uncertaintyInMilliseconds: 0
        },
        {
          namespace: "Alexa.Cooking",
          name: "foodItem",
          value: {
            foodName: request.directive.payload.foodItem.foodName,
            foodCategory: "TEST", //TODO: Vediamo come gestirlo
            foodQuantity: request.directive.payload.foodItem.foodQuantity
          },
          timeOfSample: "2017-09-03T16:20:50.52Z", //retrieve from result.
          uncertaintyInMilliseconds: 0
        }
      ]
    };

    let response = {
      event: {
        header: responseHeader,
        endpoint: {
          scope: {
            type: "BearerToken",
            token: requestToken
          },
          endpointId: "uniqueIdOfApplianceEndpoint"
        },
        payload: {}
      },
      context: contextResult,
    };
    log("DEBUG ", "Alexa.Cooking ", JSON.stringify(response));
    context.succeed(response);
  }

  function log(message, message1, message2) {
    console.log(message + message1 + message2);
  }
};

When saying: "defrost three pounds of meat in my oventest" from the skills developer console the endpoint works as expected but I'm getting back: "Hm, oventest is not responding." as textual response. This is the json that my webhook sends back as a response to the skill:

{
  "event": {
    "header": {
      "namespace": "Alexa",
      "name": "Response",
      "payloadVersion": "3",
      "messageId": "57f2128c-91c8-41f5-bd85-efe9da5e224e-R",
      "correlationToken": "Helllo there"
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "Helllo there"
      },
      "endpointId": "uniqueIdOfApplianceEndpoint"
    },
    "payload": {}
  },
  "context": {
    "properties": [
      {
        "namespace": "Alexa.Cooking",
        "name": "cookingMode",
        "value": "DEFROST",
        "timeOfSample": "2017-09-03T16:20:50.52Z",
        "uncertaintyInMilliseconds": 0
      },
      {
        "namespace": "Alexa.Cooking",
        "name": "cookCompletionTime",
        "value": "2017-09-03T18:20:50.52Z",
        "timeOfSample": "2017-09-03T16:20:50.52Z",
        "uncertaintyInMilliseconds": 0
      },
      {
        "namespace": "Alexa.Cooking",
        "name": "isCookCompletionTimeEstimated",
        "value": false,
        "timeOfSample": "2017-09-03T16:20:50.52Z",
        "uncertaintyInMilliseconds": 0
      },
      {
        "namespace": "Alexa.Cooking",
        "name": "cookStartTime",
        "value": "2017-09-03T16:20:50.52Z",
        "timeOfSample": "2017-09-03T16:20:50.52Z",
        "uncertaintyInMilliseconds": 0
      },
      {
        "namespace": "Alexa.Cooking",
        "name": "foodItem",
        "value": {
          "foodName": "meat",
          "foodCategory": "TEST",
          "foodQuantity": {
            "@type": "Weight",
            "value": 3,
            "unit": "POUND"
          }
        },
        "timeOfSample": "2017-09-03T16:20:50.52Z",
        "uncertaintyInMilliseconds": 0
      }
    ]
  }
}

Is this json not well formatted? Thank you in advance for the response!

0 · Show 3 · Share

10 |2000 characters needed characters left characters exceeded

Attachments: Up to 2 attachments (including images) can be used with a maximum of 524.3 kB each and 1.0 MB total.

barry@amazon ♦♦ · Aug 23 at 12:39 PM

Hello and thank you for your message.

The response that you are sending back to Alexa is malformed. If you check this page, you will see that there is no context.properties map. The payload should contain only cookingMode and foodItem maps.

Regards,
Barry

0 · Share ·

NewUser-6d8179cc-e27a-4ef2-9b12-22c08c4d7cea barry@amazon ♦♦ · Aug 26 at 01:30 PM

Hello @barry@amazon, thank you very much for the support!!!

According to the documentation you send to me. The "SetCookingMode directive" does not have "context.properties" but this payload sent to my webhook as request.

I need to know what is the "SetCookingMode response event" format. Because it only says: "Hm, microwave is not responding." after a utterance like "defrost three pounds of meat in my microwave"

Can you help me figure out how to handle this?

0 · Share ·

NewUser-6d8179cc-e27a-4ef2-9b12-22c08c4d7cea barry@amazon ♦♦ · Aug 27 at 01:15 PM

Hello Barry, so I did what you said and the actual "SetCookingMode response event" json that my lambda is sending back to the skill is the following:

{
  "event": {
      "header": {
          "namespace": "Alexa",
          "name": "Response",
          "payloadVersion": "3",
          "messageId": "e454f0ba-b0ba-40a3-a32b-fb5ccda43878-R",
          "correlationToken": "Ciao Mondo"
      },
      "endpoint": {
          "scope": {
              "type": "BearerToken",
              "token": "0b7b6ab68425891c1f604114f0e86760d7704cab"
          },
          "endpointId": "uniqueIdOfApplianceEndpoint"
      },
      "payload": {
          "cookingMode": {
              "value": "WARM"
          },
          "foodItem": {
              "foodName": "meat",
              "foodQuantity": {
                  "@type": "Weight",
                  "value": 3,
                  "unit": "POUND"
              }
          }
      }
  }
}

Now the skill is risponding with "Ok" to the utterance "Defrost three pound of meat on my oventest". So I think that's ok now. As you can see the JSON format is not the same as the documentation says.

Thank you very much for the support!

1 · Share ·

Smarthome skill Alexa.Discovery request and response has changed?

question details

Related Questions