Alexa.BrightnessControllerインターフェース



Alexa.BrightnessControllerインターフェース

Alexa.BrightnessControllerインターフェースには、電球などのエンドポイントの輝度を制御し、レポートするために使用されるメッセージが含まれます。このインターフェースは、輝度の調整に対応している機器に対して、より汎用的なAlexa.PercentageControllerインターフェースの代わりに使用するようにします。調光スイッチなどエンドポイントの電力レベルに固有のリクエストを処理するには、Alexa.PowerLevelControllerを参照してください。

ディレクティブ

このインターフェースの制御とクエリーのディレクティブは、以下の言語のスキルで使用できます。

  • 英語 - すべてのロケール
  • フランス語(フランス)
  • ドイツ語
  • イタリア語
  • 日本語
  • スペイン語(スペイン)

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

AdjustBrightness

エンドポイントの輝度を、指定された正の値または負の値に基づいて上または下に調整します。

ユーザー: Alexa, dim device ##%
ユーザー: Alexa, dimme Smart Home-Gerät ##%
ユーザー: Alexa, diminue le device de ##%
ユーザー:デバイスを##%パーセント暗くして

リクエストの例:


{
  "directive": {
    "header": {
      "namespace": "Alexa.BrightnessController",
      "name": "AdjustBrightness",
      "payloadVersion": "3",
      "messageId": "abc-123-def-456",
      "correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8ptlAKulUj90jSqg=="
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "access-token-from-Amazon"
      },
      "endpointId": "appliance-001",
      "cookie": {}
    },
    "payload": {
      "brightnessDelta": 3
    }
  }
}

ペイロードの詳細

フィールド 説明 必須
brightnessDelta リクエストされた輝度の変化量です。パーセンテージで変化します。明るさのパーセンテージを増減させるために使用する正または負の整数値です。たとえば、最初の値が97で、与えられた値が3の場合、最終的な値は100になります。 -100から100までの整数です(両端の値を含む)。

SetBrightness

エンドポイントの輝度値を設定します。

ユーザー: Alexa, set the device to ##%
ユーザー: Alexa, stelle Smart Home-Gerät auf ##%
ユーザー:デバイスの明るさを##パーセントにして
ユーザー: Alexa, règle la luminosité de device à ##%

リクエストの例:

{
  "directive": {
    "header": {
      "namespace": "Alexa.BrightnessController",
      "name": "SetBrightness",
      "payloadVersion": "3",
      "messageId": "abc-123-def-456",
      "correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8ptlAKulUj90jSqg=="
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "access-token-from-skill"
      },
      "endpointId": "appliance-001",
      "cookie": {}
    },
    "payload": {
      "brightness": 42
    }
  }
}

ペイロードの詳細

フィールド 説明 必須
brightness 指定の輝度をパーセントで表した値です。 0から100までの整数です(両端の値を含む)。

プロパティとイベント

この機能では、次のいずれかの応答を使用する必要があります。

  • 同期的に、Lambda関数からAlexaにResponseイベントを送信します。
  • 非同期的に、AlexaイベントゲートウェイにResponseイベントを送信します。非同期的に応答する場合、認可トークンにscopeを含めてユーザーを識別し、相関トークンを含めて応答先のディレクティブを識別する必要があります。

応答を送信する場合、メッセージのcontextにインターフェースのプロパティの状態を含める必要があります。

プロパティ

プロパティ名 説明
brightness 輝度をご覧ください。 0~100までの整数(両端の値を含む)で表した、スマート電球などの機器の輝度です。

応答

輝度制御ディレクティブの処理が成功した場合、Responseイベントにより応答する必要があります。

応答の例

{
  "context": {
    "properties": [ {
      "namespace": "Alexa.BrightnessController",
      "name": "brightness",
      "value": 42,
      "timeOfSample": "2017-02-03T16:20:50.52Z",
      "uncertaintyInMilliseconds": 1000
    } ]
  },
  "event": {
    "header": {
      "namespace": "Alexa",
      "name": "Response",
      "payloadVersion": "3",
      "messageId": "abc-123-def-456",
      "correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8ptlAKulUj90jSqg=="
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "access-token-from-Amazon"
      },
      "endpointId": "appliance-001"
    },
    "payload": {}
  }
}

ErrorResponse

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

その他のサンプルコード

リクエストと応答のサンプルについては、AlexaスマートホームのGitHubリポジトリで以下を参照してください。

BrightnessController

インターフェース 説明
Alexa.PercentageController パーセンテージを設定します。
Alexa.ColorController 照明エンドポイントの色を設定します。
Alexa.PowerLevelController エンドポイントの電力レベルを制御します。