Alexa.ThermostatController.Configuration.ErrorResponseインターフェース3

Alexa.ThermostatController.Configuration.ErrorResponseインターフェース3

Alexaから送信されたAlexa.ThermostatController.Configurationディレクティブを正しく処理できなかった場合、Alexa.ThermostatController.Configuration.ErrorResponseイベントで応答します。詳細については、Alexa.ThermostatController.Configurationを参照してください。

ErrorResponseイベント

Alexa.ThermostatController.Configuration.ErrorResponseのペイロードでは、エラータイプを指定し、エラー情報のメッセージを含めます。Alexa.ThermostatController.Configurationのエラータイプのリストについては、エラータイプの値を参照してください。エラー応答は、同期応答または非同期応答で送信できます。詳細については、Alexa.ErrorResponseを参照してください。

ErrorResponseイベントのパラメーター

フィールド 説明 型 必須
type エラーのタイプです。Alexaはこれをユーザーと共有します。 文字列 ◯
message エラーのエラーメッセージ。この情報はユーザーには共有されません。 文字列 ◯

ErrorResponseイベントの例

クリップボードにコピーされました。

{
"event": {
    "header": {
      "namespace": "Alexa.ThermostatController.Configuration",
      "name": "ErrorResponse",
      "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
      "correlationToken": "リクエストに一致するopaque相関トークン",
      "payloadVersion": "3"
    },
    "endpoint":{
      "endpointId": "エンドポイントID"
    },
    },
    "payload": {
      "type": "エラータイプ",
      "message": "エラーメッセージ"
    }
  }
}

エラータイプの値

以下の表は、有効なAlexa.ThermostatController.Configurationエラータイプの一覧です。

エラータイプ 説明
CONFIGURATION_UPDATE_NOT_ALLOWED サーモスタットデバイスでは設定変更が許可されていません。設定変更を受け入れるには、ユーザーが直接デバイスを操作する必要があります。
MISSING_SETUP_INFORMATION セットアップに必要な情報がディレクティブにありません。
INVALID_TARGET_STATE 対象の状態がデバイスでサポートされていません。
INVALID_TEMPERATURE_SCALE 温度単位がデバイスでサポートされていません。
INVALID_TERMINAL_CONNECTION 1つ以上の端子接続が無効です。
INVALID_SYSTEM_TYPE HVACシステムのタイプがデバイスでサポートされていません。
HEATING_STAGES_EXCEEDS_LIMIT 暖房の段数が制限を超えています。ペイロードにvalidRangeオブジェクトを含めて、受け入れ可能な範囲を指定してください。
COOLING_STAGES_EXCEEDS_LIMIT 冷却の段数が制限を超えています。ペイロードにvalidRangeオブジェクトを含めて、受け入れ可能な範囲を指定してください。
INVALID_AUXILIARY_HEATING_SYSTEM_TYPE 指定された補助暖房システムがデバイスでサポートされていません。
COOLING_LOCKOUT_TEMPERATURE_VALUE_OUT_OF_RANGE 冷却のロックアウト温度が受け入れ可能な範囲を超えています。ペイロードにvalidRangeオブジェクトを含めて、受け入れ可能な範囲を指定してください。
HEATING_LOCKOUT_TEMPERATURE_VALUE_OUT_OF_RANGE 暖房のロックアウト温度が受け入れ可能な範囲を超えています。ペイロードにvalidRangeオブジェクトを含めて、受け入れ可能な範囲を指定してください。

Alexa.ThermostatController.Configuration.ErrorResponseエラータイプのほかに、ALREADY_IN_OPERATIONなどのAlexaエラータイプを設定できます。詳細については、Alexa.ErrorResponseエラータイプの値を参照してください。

Alexa.ThermostatController.Configuration.ErrorResponseの例

以下の例は、さまざまなエラータイプのペイロードを示しています。

INVALID_TERMINAL_CONNECTION

以下は、INVALID_TERMINAL_CONNECTIONエラータイプのエラー応答の例です。

クリップボードにコピーされました。

{
    "event": {
        "header": {
            "namespace": "Alexa.ThermostatController.Configuration",
            "name": "ErrorResponse",
            "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
            "correlationToken": "リクエストに一致するopaque相関トークン",
            "payloadVersion": "3"
        },
        "endpoint": {
            "endpointId": "エンドポイントID"
        },
        "payload": {
            "type": "INVALID_TERMINAL_CONNECTION",
            "message": "端子U2はサポートされていません。"
        }
    }
}

CONFIGURATION_UPDATE_NOT_ALLOWED

以下は、CONFIGURATION_UPDATE_NOT_ALLOWEDエラータイプのエラー応答例です。

クリップボードにコピーされました。

{
    "event": {
        "header": {
            "namespace": "Alexa.ThermostatController.Configuration",
            "name": "ErrorResponse",
            "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
            "correlationToken": "リクエストに一致するopaque相関トークン",
            "payloadVersion": "3"
        },
        "endpoint": {
            "scope": {
                "type": "BearerToken",
                "token": "OAuth2ベアラートークン"
            },
            "endpointId": "エンドポイントID"
        },
        "payload": {
            "type": "CONFIGURATION_UPDATE_NOT_ALLOWED",
            "message": "デバイスはすでに設定を更新中です。"
        }
    }
}

COOLING_LOCKOUT_TEMPERATURE_VALUE_OUT_OF_RANGE

以下は、COOLING_LOCKOUT_TEMPERATURE_VALUE_OUT_OF_RANGEエラータイプのエラー応答の例です。設定可能な最低および最高温度を示すvalidRangeオブジェクトをペイロードに含めます。最小値と最大値は、Temperatureオブジェクトを含みます。

クリップボードにコピーされました。

{
    "event": {
        "header": {
            "namespace": "Alexa.ThermostatController.Configuration",
            "name": "ErrorResponse",
            "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
            "correlationToken": "リクエストに一致するopaque相関トークン",
            "payloadVersion": "3"
        },
        "endpoint": {
            "endpointId": "エンドポイントID"
        },
        "payload": {
            "type": "COOLING_LOCKOUT_TEMPERATURE_VALUE_OUT_OF_RANGE",
            "message": ".",
            "validRange": {
                "minimumValue": {
                    "value": 60.0,
                    "scale": "FAHRENHEIT"
                },
                "maximumValue": {
                    "value": 80.0,
                    "scale": "FAHRENHEIT"
                }
            }
        }
    }
}

このページは役に立ちましたか？

最終更新日: 2024 年 07 月 03 日