Alexa.ColorTemperatureControllerインターフェース

Alexa.ColorTemperatureController

Alexa.ColorTemperatureControllerインターフェースには、調整可能な白色照明をサポートするエンドポイントの色温度を制御して、レポートするために使用されるメッセージが含まれます。

ディレクティブ

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

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

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

DecreaseColorTemperature

端末のケルビン温度値を下げるリクエスト。このディレクティブは特定の設定を指定しませんが、端末の現在の設定よりも暖色よりの設定をリクエストします。指定した端末の設定をどれくらい調整するかを、現在の設定、機能および他の値に基づいて選択できます。端末の設定をそれ以上下げることができない場合、最小の色温度に設定します。

「Alexa、端末名をもっと暖色/ソフトに設定して」

「Alexa、ダイニングの照明をもっとソフトに設定して」

「Alexa、リビングの照明をもっと暖色にして」

リクエストの例:


{
    "directive": {
        "header": {
            "namespace": "Alexa.ColorTemperatureController",
            "name": "DecreaseColorTemperature",
            "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": {}
    }
}

ペイロードの詳細

フィールド 説明 必須
なし ペイロードに必須または任意のフィールドはありません。 N/A N/A

IncreaseColorTemperature

端末のケルビン温度値を上げるリクエスト。このディレクティブは特定の設定を指定しませんが、端末の現在の設定よりも寒色/白色よりの設定をリクエストします。指定した端末の設定をどれくらい調整するかを、現在の設定、機能および他の値に基づいて選択できます。端末の設定をそれ以上上げることができない場合、最大の色温度に設定します。

「Alexa、端末名をもっと白っぽく/白くして」

「Alexa、ダイニングをもっと白っぽくして」

「Alexa、リビングの照明をもっと白くして」

リクエストの例:


{
    "directive": {
        "header": {
            "namespace": "Alexa.ColorTemperatureController",
            "name": "IncreaseColorTemperature",
            "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": {}
    }
}

ペイロードの詳細

フィールド 説明 必須
なし ペイロードに必須または任意のフィールドはありません。 N/A N/A

SetColorTemperature

指定された端末の色温度を、指定された設定に変更するようリクエストします。次の表は、APIが送信するリクエスト可能な色温度と、関連する値の一覧です。お使いの照明端末がリクエストされた値をサポートしていない場合、端末を利用可能な最も近い値に設定することをお勧めします。

白の色調 colorTemperatureInKelvin値
暖色 2200
電球色 2700
白っぽい色 4000
昼白色 5500
クールホワイト 7000

「Alexa、端末名を白の色調に変更して」

「Alexa、リビングを暖色にして」

「Alexa、キッチンを昼光色に設定して」

「Alexa, change the device name to shade of white」

リクエストの例


{
    "directive": {
        "header": {
            "namespace": "Alexa.ColorTemperatureController",
            "name": "SetColorTemperature",
            "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": {
            "colorTemperatureInKelvin": 7500
        }
    }
}

ペイロードの詳細

フィールド 説明 必須
colorTemperatureinKelvin リクエストされた色温度をケルビン度で示す整数。有効な範囲は1000~10000(両端の値を含む)。 整数

プロパティとイベント

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

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

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

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

プロパティ名 説明
colorTemperatureInKelvin colorTemperatureinKelvin リクエストされた色温度をケルビン度で示す整数。値は、1000~10000までの範囲(両端の値を含む)の整数です。

応答

色温度変更のリクエストへの応答が成功した場合、Responseイベントを送信します。メッセージのcontextにレポート可能なプロパティの状態を含める必要があります。

応答の例

次の例は、調整可能な白色照明をサポートするエンドポイントの応答を示しています。

{
    "context": {
        "properties": [ {
            "namespace": "Alexa.ColorTemperatureController",
            "name": "colorTemperatureInKelvin",
            "value": 7500,
            "timeOfSample": "2017-02-03T16:20:50.52Z",
            "uncertaintyInMilliseconds": 500
        } ]
    },
    "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

デバイスが色温度のディレクティブで制御できないモードに設定されている場合、NOT_SUPPORTED_IN_CURRENT_MODEエラーを返します。たとえば、現在HSB色に設定されている照明にIncreaseColorTemperatureまたはDecreaseColorTemperatureのリクエストが出されたことを示すためにこのエラーを返します。このシナリオでは、Alexaは「それは照明が白の色調に設定されているときだけ可能です」と応答します。

NOT_SUPPORTED_IN_CURRENT_MODEの例

{
  "event": {
    "header": {
      "namespace": "Alexa.ColorTemperatureController",
      "name": "ErrorResponse",
      "messageId": "abc-123-def-456",
      "correlationToken": "abcdef-123456",
      "payloadVersion": "3"
    },
     "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "Alexa-access-token"
      },
      "endpointId": "appliance-001"
    },
    "payload": {
      "type": "NOT_SUPPORTED_IN_CURRENT_MODE",
      "message": "The light is currently set to a color.",
      "currentDeviceMode": "COLOR"
      }
  }
}

ペイロードの詳細

フィールド 説明 必須
currentDeviceMode 現在デバイスは、設定を変更できないモードであることを示します。 文字列です。有効な値は、AUTO、AWAY、COLOR、COOL、HEAT、OTHERのいずれかです。

追加のサンプルコード

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

ColorTemperatureController

インターフェース 説明
Alexa.BrightnessController エンドポイントの輝度を制御します。
Alexa.ColorController 照明エンドポイントの色を設定します。