あなたのAlexaコンソール
?
サポート

Alexa.ColorControllerインターフェース

Alexa.ColorControllerインターフェース

Alexa.ColorControllerインターフェースには、色が変化する電球などのエンドポイントの色を変化させて、レポートするために使用されるメッセージが含まれます。

ディレクティブ

このインターフェースの制御とクエリのディレクティブは、次の言語を対象とするスキルでサポートされています。

  • 英語(米国)
  • 英語(英国)
  • 英語(インド)
  • ドイツ語
  • 日本語

詳細については、「スマートホームスキルを複数の言語で開発する」を参照してください。

SetColor

エンドポイントに照明の色を設定することを要求します。

「Alexa、端末名を◯色にして」

「Alexa、寝室を赤にして」

「Alexa、キッチンの色を青に変えて」

「Alexa, change the kitchen to the color blue」

リクエストの例:

{
    "directive": {
        "header": {
            "namespace": "Alexa.ColorController",
            "name": "SetColor",
            "payloadVersion": "3",
            "messageId": "1bd5d003-31b9-476f-ad03-71d471922820",
            "correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8ptlAKulUj90jSqg=="
        },
        "endpoint": {
            "scope": {
                "type": "BearerToken",
                "token": "some-access-token"
            },
            "endpointId": "appliance-001",
            "cookie": {}
        },
        "payload": {
            "color": {
                "hue": 350.5,
                "saturation": 0.7138,
                "brightness": 0.6524
            }
        }
    }
}

ペイロードの詳細

フィールド 説明 必須
color 照明に設定する色を示します。HSBカラーモデル(hue: 色相、saturation: 彩度、brightness: 輝度)で指定します。 colorオブジェクト

プロパティとイベント

このインターフェースでは、次のいずれかの応答を使用する必要があります。

  • 同期的。つまり、Lambda関数からAlexaにResponseイベントを送信します。
  • 非同期的。つまり、AlexaイベントゲートウェイにResponseイベントを送信します。非同期応答の際には、ユーザーを識別する認可を受けたトークンを含むscope要素と、応答するディレクティブを識別する correlation トークンが必要になります。

Responseを送信するときには、メッセージのcontextにレポート可能なプロパティの状態を含める必要があります。

レポート可能なプロパティ

プロパティ名 説明
color Color 照明に設定する色を示します。HSBカラーモデル(hue: 色相、saturation: 彩度、brightness: 輝度)で値を指定します。

応答

SetColorディレクティブの処理が成功した場合、 Responseイベントにより応答する必要があります。メッセージのcontextにレポート可能なプロパティの状態を含める必要があります。

応答の例

{
    "context": {
        "properties": [ {
            "namespace": "Alexa.ColorController",
            "name": "color",
            "value": {
                "hue": 350.5,
                "saturation": 0.7138,
                "brightness": 0.6524
            },
            "timeOfSample": "2017-02-03T16:20:50.52Z",
            "uncertaintyInMilliseconds": 1000
        } ]
    },
    "event": {
        "header": {
            "namespace": "Alexa",
            "name": "Response",
            "payloadVersion": "3",
            "messageId": "5f8a426e-01e4-4cc9-8b79-65f8bd0fd8a4",
            "correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8ptlAKulUj90jSqg=="
        },
        "endpoint": {
            "scope": {
              "type": "BearerToken",
              "token": "Alexa-access-token"
      },
            "endpointId": "appliance-001"
        },
        "payload": {}
    }
}

ErrorResponse

何らかの理由でお客様のリクエストを完了できない場合は、エラーにより応答する必要があります。詳細については、Error.Responseを参照してください。

追加のサンプルコード

リクエストの例と応答メッセージについては、AlexaスマートホームGitHubリポジトリを参照してください。

ColorController

インターフェース 説明
Alexa.ColorTemperatureController 調整可能な照明エンドポイントの色温度を設定します。