スマートホームの SensorState トレイトのスキーマ

action.devices.traits.SensorState - このトレイトは、定量的測定と定性的状態の両方に対応しています。

デバイスの属性

このトレイトを持つデバイスは、SYNC オペレーションの一部として次の属性を報告できます。SYNC インテントの処理の詳細については、インテントのフルフィルメントをご覧ください。

属性 タイプ 説明
sensorStatesSupported 配列

必須。

各オブジェクトは、この特定のデバイスでサポートされているセンサー状態の機能を表します。各センサーには、少なくとも記述的機能または数値的機能が必要です。センサーは両方を報告することもできます。この場合、数値が優先されます。
[item, ...] オブジェクト

サポートされているセンサー機能。

少なくとも 1 つの項目が必要です。
name String

必須。

サポートされているセンサータイプ。サポートされているセンサーの表をご覧ください。
descriptiveCapabilities オブジェクト

センサーの機能の説明。
availableStates 配列

必須。

デバイスで使用可能な状態のリスト。センサーが値を返さない場合、「不明」の状態が暗黙的にサポートされます。
[item, ...] String

サポートされている説明的な状態値。

少なくとも 1 つの項目が必要です。
numericCapabilities オブジェクト

センサーが報告できる数値を説明します。
rawValueUnit String

必須。

サポートされている数値単位。

このトレイトがサポートするさまざまな機能とセンサータイプについて詳しくは、サポートされているセンサーをご覧ください。

例

記述的な状態値を報告するセンサー デバイス。

{
  "sensorStatesSupported": [
    {
      "name": "AirQuality",
      "descriptiveCapabilities": {
        "availableStates": [
          "healthy",
          "moderate",
          "unhealthy",
          "very unhealthy"
        ]
      }
    }
  ]
}

数値の状態値を報告するセンサー デバイス。

{
  "sensorStatesSupported": [
    {
      "name": "CarbonMonoxideLevel",
      "numericCapabilities": {
        "rawValueUnit": "PARTS_PER_MILLION"
      }
    }
  ]
}

記述的な値と数値の状態値を報告するセンサー デバイス。

{
  "sensorStatesSupported": [
    {
      "name": "SmokeLevel",
      "numericCapabilities": {
        "rawValueUnit": "PARTS_PER_MILLION"
      },
      "descriptiveCapabilities": {
        "availableStates": [
          "smoke detected",
          "high",
          "no smoke detected"
        ]
      }
    }
  ]
}

サポートされているセンサー

次の表に、サポートされているセンサータイプとそれに関連する機能を示します。

大気質

名前 記述的機能 数値的機能

サポートされている値:

AirQuality

サポートされている値:

healthy
moderate
unhealthy
unhealthy for sensitive groups
very unhealthy
hazardous
good
fair
poor
very poor
severe
unknown

サポートされている値:

AQI

一酸化炭素

名前 記述的機能 数値的機能

サポートされている値:

CarbonMonoxideLevel

サポートされている値:

carbon monoxide detected
high
no carbon monoxide detected
unknown

サポートされている値:

PARTS_PER_MILLION

煙濃度

名前 記述的機能 数値的機能

サポートされている値:

SmokeLevel

サポートされている値:

smoke detected
high
no smoke detected
unknown

サポートされている値:

PARTS_PER_MILLION

フィルター清浄度

名前 記述的機能 数値的機能

サポートされている値:

FilterCleanliness

サポートされている値:

clean
dirty
needs replacement
unknown
 サポートされていません。

水漏れ

名前 記述的機能 数値的機能

サポートされている値:

WaterLeak

サポートされている値:

leak
no leak
unknown
 サポートされていません。

雨センサー

名前 記述的機能 数値的機能

サポートされている値:

RainDetection

サポートされている値:

rain detected
no rain detected
unknown
 サポートされていません。

フィルターの交換時期

名前 記述的機能 数値的機能

サポートされている値:

FilterLifeTime

サポートされている値:

new
good
replace soon
replace now
unknown

サポートされている値:

PERCENTAGE

計算されたフィルターの交換時期

名前 記述的機能 数値的機能

サポートされている値:

PreFilterLifeTime
HEPAFilterLifeTime
Max2FilterLifeTime
 サポートされていません。

サポートされている値:

PERCENTAGE

二酸化炭素濃度

名前 記述的機能 数値的機能

サポートされている値:

CarbonDioxideLevel
 サポートされていません。

サポートされている値:

PARTS_PER_MILLION

粒子状物質

名前 記述的機能 数値的機能

サポートされている値:

PM2.5
PM10
 サポートされていません。

サポートされている値:

MICROGRAMS_PER_CUBIC_METER

揮発性有機化合物

名前 記述的機能 数値的機能

サポートされている値:

VolatileOrganicCompounds
 サポートされていません。

サポートされている値:

PARTS_PER_MILLION

デバイスのステータス

このトレイトを持つエンティティは、QUERY オペレーションの一部として次のステータスを報告できます。QUERY インテントの処理の詳細については、インテントのフルフィルメントをご覧ください。

州 タイプ 説明
currentSensorStateData 配列

必須。

現在のセンサーの状態のリスト。
[item, ...] オブジェクト

センサーの現在の状態。
name String

必須。

センサーのステータス名。sensorStatesSupported の値と一致します。
currentSensorState String

現在の説明的な状態値。sensorStatesSupported の値と一致します。
rawValue 数値

現在の数値的なセンサーの値。
alarmState String

現在のセンサー測定値に対応するアラーム状態。センサーの測定値が危険なレベルに近づいたときに、事前アラームまたはアラームがトリガーされることがあります。

サポートされている値:

IDLE
アラームがアイドル状態です。検出されたレベルは危険ではありません。
PRE_ALARM_1
検出されたレベルは高めですが、緊急レベルには達していません。レベルはすぐに危険なレベルになる可能性があります。
PRE_ALARM_2
デバイスが緊急レベルに達する前に複数のアラートをサポートしている場合、これは PRE_ALARM_1 よりも高い検出レベルを示します。レベルは引き続き上昇し、まもなく緊急レベルに達する可能性があります。
ALARM
検出されたレベルが緊急レベルに達し、アラートがトリガーされました。
alarmSilenceState String

センサーのアラームの消音状態を示します。アクティブなアラームの消音が現在許可されているかどうかも含まれます。この状態は、アラームの前またはアラームの状態がアクティブな場合に提供される場合があります。煙検知機の場合、値 ALLOWED と DISALLOWED は使用されません。Google Home アプリには、アラームをアプリから消音できるかどうかを判断するロジックが組み込まれています。

サポートされている値:

ALLOWED
アラームはサイレントになっておらず、現在アラームをサイレントにしても問題ありません。
DISALLOWED
アラームはサイレントになっておらず、現在、アラームをサイレントにする操作は許可されていません。
SILENCED
アラームが消音されました。

このトレイトがサポートするさまざまな機能とセンサータイプについて詳しくは、サポートされているセンサーをご覧ください。

例

記述的な状態値を報告するセンサー デバイス。

{
  "currentSensorStateData": [
    {
      "name": "AirQuality",
      "currentSensorState": "healthy"
    }
  ]
}

数値の状態値を報告するセンサー デバイス。

{
  "currentSensorStateData": [
    {
      "name": "CarbonMonoxideLevel",
      "rawValue": 200
    }
  ]
}

記述的な値と数値の状態値を報告するセンサー デバイス。

{
  "currentSensorStateData": [
    {
      "name": "SmokeLevel",
      "currentSensorState": "smoke detected",
      "rawValue": 200
    }
  ]
}

記述的な値と数値の状態値を報告し、アラームがアクティブであることを示すセンサー デバイス。

{
  "currentSensorStateData": [
    {
      "name": "SmokeLevel",
      "currentSensorState": "smoke detected",
      "rawValue": 200,
      "alarmState": "ALARM"
    }
  ]
}

記述的な値と数値の状態値を報告し、アラームがサイレント状態であることを示すセンサー デバイス。

{
  "currentSensorStateData": [
    {
      "name": "SmokeLevel",
      "currentSensorState": "smoke detected",
      "rawValue": 200,
      "alarmState": "ALARM",
      "alarmSilenceState": "SILENCED"
    }
  ]
}

デバイスのコマンド

なし。

デバイスの通知

このトレイトを持つデバイスは、デバイスのステータス変更の一部として次の通知ペイロードを返す場合があります。通知の実装の詳細については、スマートホーム アクションの通知をご覧ください。

フィールド タイプ 説明
SensorState オブジェクト

必須。

通知ペイロード:

priority 整数

必須。

通知レベルを表します。現在サポートされている値は 0 です。これは、通知を音声で読み上げる必要があることを示します。
name String

必須。

センサーのステータス名。通知でサポートされているセンサータイプのリストをご覧ください。
currentSensorState String

必須。

現在の説明的な状態値。通知でサポートされているセンサータイプのリストをご覧ください。

通知ペイロードには、次のセンサータイプを含めることができます。

  • AirQuality
  • CarbonMonoxideLevel
  • SmokeLevel
  • FilterCleanliness
  • WaterLeak
  • RainDetection
  • FilterLifeTime

各センサータイプでサポートされているさまざまな機能の詳細については、サポートされているセンサーをご覧ください。

例

煙を検出しました。

{
  "SensorState": {
    "priority": 0,
    "name": "SmokeLevel",
    "currentSensorState": "high"
  }
}

デバイスエラー

エラーと例外の全リストをご覧ください。