Alexa.PowerLevelControllerインターフェース



Alexa.PowerLevelControllerインターフェース

Alexa.PowerLevelControllerインターフェースは、デバイスの電力レベルを制御するために使用するメッセージを記述します。電力レベルの制御をサポートするパワーディマーなどのデバイスには、より一般的な [Alexa.PercentageController][alexa-percentagecontroller] インターフェースの代わりに、このインターフェースを使用します。

PowerLevelControllerインターフェースでサポートされているロケールの一覧については、機能インターフェースとサポートされているロケールの一覧を参照してください。

発話

Alexa.PowerLevelControllerインターフェースを使用する場合、音声対話モデルはすでにビルドされています。以下に、ユーザーの発話の例を示します。

Alexa, set the power to 40 percent on the fan.
Alexa, increase the power level by 12 on the light switch.

ユーザーがこのような発話をしたら、Alexaがそれに対応するディレクティブをスキルに送信します。

プロパティ

powerLevelプロパティ

Alexa.PowerLevelControllerインターフェースは、powerLevelプロパティをプライマリプロパティとして使用します。このプロパティはデバイスの電力レベルを表し、0から100(両端の値を含む)の整数のパーセンテージで表現します。

検出

Alexa.PowerLevelControllerをサポートするエンドポイントは、Alexa.Discoveryの標準検出メカニズムを使用して表します。

Alexaからスキルに状態レポートリクエストが送信されるときにレポートするすべてのインターフェースとプロパティのretrievableをtrueに設定します。変更レポートでAlexaにプロアクティブにレポートするインターフェースとプロパティのproactivelyReportedをtrueに設定します。

表示カテゴリーの一覧は、表示カテゴリーを参照してください。

検出の例

以下は、Alexa.PowerLevelControllerインターフェースとAlexa.ColorControllerインターフェースをサポートする1つのエンドポイントに対するDiscover.Responseメッセージの例です。

{
    "event": {
        "header": {
            "namespace": "Alexa.Discovery",
            "name": "Discover.Response",
            "payloadVersion": "3",
            "messageId": "<メッセージID>"
        },
        "payload": {
            "endpoints":[
                {
                    "endpointId": "<エンドポイントの一意のID>",
                    "manufacturerName": "<エンドポイントのメーカー名>",
                    "modelName": "<エンドポイントのモデル名>",
                    "friendlyName": "<Alexaアプリに表示されているデバイス名>",
                    "description": "<Alexaアプリに表示される説明>",
                    "displayCategories": ["LIGHT"],
                    "cookie": {},
                    "capabilities": [
                        {
                            "type": "AlexaInterface",
                            "interface": "Alexa.PowerLevelController",
                            "version": "3",
                            "properties": {
                                "supported": [
                                    {
                                        "name": "powerLevel"
                                    }
                                ],
                                "proactivelyReported": true,
                                "retrievable": true
                            }
                        },
                        {
                            "type": "AlexaInterface",
                            "interface": "Alexa.ColorController",
                            "version": "3",
                            "properties": {
                                "supported": [
                                    {
                                        "name": "color"
                                    }
                                ],
                                "proactivelyReported": true,
                                "retrievable": true
                            }
                        }
                    ]
                }
            ]
        }
    }
}

ディレクティブ

SetPowerLevelディレクティブ

ユーザーがデバイスの電力レベルを設定できるように、SetPowerLevelディレクティブをサポートします。

以下は、ユーザーの発話の例です。

Alexa, set the power to 40 percent on the fan.

SetPowerLevelディレクティブペイロードの詳細

フィールド 説明 必須
powerLevel デバイスに設定する電力レベルです。0~100(両端の値を含む)のパーセンテージで表現します。 整数

SetPowerLevelディレクティブの例

{
"directive": {
    "header": {
      "namespace": "Alexa.PowerLevelController",
      "name": "SetPowerLevel",
      "messageId": "<メッセージID>",
      "correlationToken": "<opaque相関トークン>",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "<OAuth2ベアラートークン>"
      },
      "endpointId": "<エンドポイントID>",
      "cookie": {}
    },
    "payload": {
      "powerLevel": 40
    }
  }
}

SetPowerLevel応答イベント

SetPowerLevelディレクティブを正しく処理したら、Alexa.Responseイベントを使用して応答します。contextオブジェクトに、変更されたすべてのプロパティの値を含めます。応答は同期または非同期のどちらでも可能です。非同期で応答する場合、相関トークンと、認可トークンを含めたスコープを含めます。

SetPowerLevel応答イベントの例

{
    "event": {
        "header": {
            "namespace": "Alexa",
            "name": "Response",
            "messageId": "<メッセージID>",
            "correlationToken": "<opaque相関トークン>",
            "payloadVersion": "3"
        },
        "endpoint": {
            "scope": {
                "type": "BearerToken",
                "token": "<OAuth2ベアラートークン>"
            },
            "endpointId": "<エンドポイントID>",
        },
        "payload": {}
    },
    "context": {
        "properties": [
            {
                "namespace": "Alexa.PowerLevelController",
                "name": "powerLevel",
                "value": 40,
                "timeOfSample": "2017-02-03T16:20:50.52Z",
                "uncertaintyInMilliseconds": 500
            }
        ]
    }
}

SetPowerLevelディレクティブのエラー処理

SetPowerLevelディレクティブを正しく処理できなかった場合は、Alexa.ErrorResponseイベントを使用して応答します。

AdjustPowerLevelディレクティブ

ユーザーがデバイスの電力レベルを調整できるように、AdjustPowerLevelディレクティブをサポートします。

以下は、ユーザーの発話の例です。

Alexa, increase the power level by 12 on the light switch.

AdjustPowerLevelディレクティブペイロードの詳細

フィールド 説明 必須
powerLevelDelta 電力レベルの変更量です。-100~100(両端の値を含む)のパーセンテージで表現します。 整数

AdjustPowerLevelディレクティブの例

{
"directive": {
    "header": {
      "namespace": "Alexa.PowerLevelController",
      "name": "AdjustPowerLevel",
      "messageId": "<メッセージID>",
      "correlationToken": "<opaque相関トークン>",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "<OAuth2ベアラートークン>"
      },
      "endpointId": "<エンドポイントID>",
      "cookie": {}
    },
    "payload": {
      "powerLevelDelta": 12
    }
  }
}

AdjustPowerLevel応答イベント

AdjustPowerLevelディレクティブを正しく処理したら、Alexa.Responseイベントを使用して応答します。contextオブジェクトに、変更されたすべてのプロパティの値を含めます。応答は同期または非同期のどちらでも可能です。非同期で応答する場合、相関トークンと、認可トークンを含めたスコープを含めます。

AdjustPowerLevel応答イベントの例

{
    "event": {
        "header": {
            "namespace": "Alexa",
            "name": "Response",
            "messageId": "<メッセージID>",
            "correlationToken": "<opaque相関トークン>",
            "payloadVersion": "3"
        },
        "endpoint": {
            "scope": {
                "type": "BearerToken",
                "token": "<OAuth2ベアラートークン>"
            },
            "endpointId": "<エンドポイントID>",
        },
        "payload": {}
    },
    "context": {
        "properties": [
            {
                "namespace": "Alexa.PowerLevelController",
                "name": "powerLevel",
                "value": 52,
                "timeOfSample": "2017-02-03T16:20:50.52Z",
                "uncertaintyInMilliseconds": 500
            }
        ]
    }
}

AdjustPowerLevelディレクティブのエラー処理

AdjustPowerLevelディレクティブを正しく処理できなかった場合は、Alexa.ErrorResponseイベントを使用して応答します。

状態レポート

Alexaはエンドポイントの状態についての情報をリクエストするためにReportStateディレクティブを送信します。AlexaがReportStateディレクティブを送信したら、それに対する応答としてStateReportイベントを送信します。この応答には、contextオブジェクトのすべてのretrievableプロパティの現在の状態を含めます。retrievableプロパティは検出応答で特定します。状態レポートの詳細については、状態レポートについてを参照してください。

StateReport応答イベントの例

{
    "event": {
      "header": {
        "namespace": "Alexa",
        "name": "StateReport",
        "messageId": "<メッセージID>",
        "correlationToken": "<opaque相関トークン>",
        "payloadVersion": "3"
      },
      "endpoint": {
          "scope": {
              "type": "BearerToken",
              "token": "<OAuth2ベアラートークン>"
          },
          "endpointId": "<エンドポイントID>",
      },
      "payload": {}
    },
    "context": {
      "properties": [
       {
           "namespace": "Alexa.PowerLevelController",
           "name": "powerLevel",
           "value": 52,
           "timeOfSample": "2017-02-03T16:20:50.52Z",
           "uncertaintyInMilliseconds": 0
       }
      ]
    }
}

変更レポート

エンドポイントの状態の変化をプロアクティブにレポートするために、ChangeReportイベントを送信します。プロアクティブにレポートするプロパティは検出応答で特定します。変更レポートの詳細については、スマートホームスキルの状態レポートについてを参照してください。

ChangeReportイベントの例

{  
  "event": {
    "header": {
        "namespace": "Alexa",
        "name": "ChangeReport",
        "messageId": "<メッセージID>",
        "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
          "type": "BearerToken",
          "token": "<OAuth2ベアラートークン>"
      },
      "endpointId": "<エンドポイントID>",
    },
    "payload": {
      "change": {
        "cause": {
          "type": "PHYSICAL_INTERACTION"
        },
        "properties": [
            {
                "namespace": "Alexa.PowerLevelController",
                "name": "powerLevel",
                "value": 75,
                "timeOfSample": "2017-02-03T16:20:50.52Z",
                "uncertaintyInMilliseconds": 0
            }
        ]
      }
    }
  },
  "context": {}
}