歡迎來到 Google Home 開發人員中心，你可以在這裡學習如何學習智慧型住宅動作。注意事項：您將在 Actions 主控台建構動作。

智慧型住宅網路控制交易結構定義

action.devices.traits.NetworkControl - 這個特性代表的裝置支援回報網路資料及執行網路特定作業。

裝置屬性

具此特性的裝置可能會在 SYNC 作業中回報下列屬性。如要進一步瞭解如何處理 SYNC 意圖，請參閱意圖執行要求。

屬性 類型 說明
supportsEnablingGuestNetwork 布林

(預設值：false)

如果可以啟用訪客網路，請設為 true。
supportsDisablingGuestNetwork 布林

(預設值：false)

如果可以停用訪客網路，請設為 true。
supportsGettingGuestNetworkPassword 布林

(預設值：false)

如果可透過 GetGuestNetworkPassword 指令取得訪客網路密碼，則設為 true。
networkProfiles 陣列

表示支援的網路設定檔名稱。
[item, ...] String

代表一組相關裝置的網路設定檔名稱。
supportsEnablingNetworkProfile 布林

(預設值："false")

如果可以啟用網路設定檔，請設為 true。
supportsDisablingNetworkProfile 布林

(預設值："false")

如果網路設定檔可以停用，請設為 true。
supportsNetworkDownloadSpeedTest 布林

(預設值：false)

如果可以執行下載速度測試，請設為 true。
supportsNetworkUploadSpeedTest 布林

(預設值：false)

如果可以執行上傳速度測試，請設為 true。

範例

支援訪客網路、設定檔和速度測試的網路裝置。

{
  "supportsEnablingGuestNetwork": true,
  "supportsDisablingGuestNetwork": true,
  "supportsEnablingNetworkProfile": true,
  "supportsDisablingNetworkProfile": true,
  "supportsNetworkDownloadSpeedTest": true,
  "supportsNetworkUploadSpeedTest": true,
  "supportsGettingGuestNetworkPassword": true,
  "networkProfiles": [
    "Kids"
  ]
}

裝置狀態

具有這個特性的實體可能會在 QUERY 作業中回報下列狀態。如要進一步瞭解如何處理 QUERY 意圖，請參閱意圖執行要求。

州 類型 說明
networkEnabled 布林

是否已啟用主要網路。
networkSettings 物件

包含主要網路的 SSID。
ssid String

必要。

網路 SSID。
guestNetworkEnabled 布林

訪客網路是否已啟用。
guestNetworkSettings 物件

包含訪客網路的 SSID。
ssid String

必要。

網路 SSID。
numConnectedDevices 整數

已連線至網路的裝置數量。
networkUsageMB Number

網路用量 (以 MB 為單位)。網路用量在目前帳單週期內，建議您針對帳單週期網路用量限制監控用量。
networkUsageLimitMB Number

網路用量限制 (MB)。網路用量限制在目前帳單週期內。
networkUsageUnlimited 布林

網路用量是否受限如果設為 true，系統會忽略裝置狀態 networkUsageLimitMB。
lastNetworkDownloadSpeedTest 物件

包含最近一次網路下載速度測試的結果。
downloadSpeedMbps Number

上次網路速度測試的下載速度 (Mbps，每秒百萬位元數)。
unixTimestampSec 整數

上次執行網路下載速度測試的 Unix 時間戳記 (自 Unix Epoch 起算的秒數)，
status String

指出上次網路下載速度測試成功或失敗。

支援的值：

SUCCESS
FAILURE
lastNetworkUploadSpeedTest 物件

包含最近一次網路上傳速度測試的結果。
uploadSpeedMbps Number

上次上傳速度 (Mbps) 的上傳速度 (每秒百萬位元數)。
unixTimestampSec 整數

上次執行網路上傳速度測試的 Unix 時間戳記 (自 Unix Epoch 起算的秒數)，
status String

指出上次上傳網路速度測試成功或失敗。

支援的值：

SUCCESS
FAILURE
networkSpeedTestInProgress 布林

(預設值：false)

正在執行速度測試。
networkProfilesState 物件

網路設定檔的狀態。這個頂層物件應包含鍵/值組合，其中鍵為 networkProfiles 屬性中列出的其中一個網路設定檔名稱，且值應為該設定檔的對應狀態。
<string> 物件

儲存個別網路設定檔狀態的物件。 鍵的值應為 networkProfiles 屬性中其中一個網路設定檔的名稱。
enabled 布林

網路設定檔目前啟用/停用的狀態。

範例

具備有效網路的裝置

{
  "networkEnabled": true,
  "networkSettings": {
    "ssid": "home-network-123"
  },
  "guestNetworkSettings": {
    "ssid": "home-network-123-guest"
  },
  "numConnectedDevices": 4,
  "networkUsageMB": 100.8
}

具備有效網路和速度測試結果的裝置。

{
  "networkEnabled": true,
  "networkSettings": {
    "ssid": "home-network-123"
  },
  "guestNetworkSettings": {
    "ssid": "home-network-123-guest"
  },
  "numConnectedDevices": 4,
  "networkUsageMB": 100.8,
  "lastNetworkDownloadSpeedTest": {
    "downloadSpeedMbps": 159.8,
    "unixTimestampSec": 1563215576,
    "status": "SUCCESS"
  },
  "lastNetworkUploadSpeedTest": {
    "uploadSpeedMbps": 64.1,
    "unixTimestampSec": 1563215576,
    "status": "SUCCESS"
  }
}

具備有效網路和速度測試的裝置。

{
  "networkEnabled": true,
  "networkSettings": {
    "ssid": "home-network-123"
  },
  "guestNetworkSettings": {
    "ssid": "home-network-123-guest"
  },
  "numConnectedDevices": 4,
  "networkUsageMB": 100.8,
  "networkSpeedTestInProgress": true
}

已停用「兒童」networkProfile 的裝置

{
  "networkEnabled": true,
  "networkSettings": {
    "ssid": "home-network-123"
  },
  "networkProfilesState": {
    "parents": {
      "enabled": true
    },
    "kids": {
      "enabled": false
    }
  }
}

裝置指令

具有此特性的裝置可能會回應 EXECUTE 作業中的下列指令。如要進一步瞭解如何處理 EXECUTE 意圖，請參閱意圖執行要求。

action.devices.commands.EnableDisableGuestNetwork

啟用或停用訪客網路。必須使用 PIN 碼進行次要使用者驗證。如果使用者透過這些指令停用其他安全裝置，系統會將他們的住家安全性視為受影響。

這個指令需要下列屬性： 
{
  "supportsEnablingGuestNetwork": true,
  "supportsDisablingGuestNetwork": true
}

參數

參數 類型 說明
enable 布林

必要。

True 即可啟用訪客網路，傳回 false 即可停用訪客網路。

範例

開啟訪客網路。

{
  "command": "action.devices.commands.EnableDisableGuestNetwork",
  "params": {
    "enable": true
  }
}

action.devices.commands.EnableDisableNetworkProfile

啟用或停用網路設定檔。必須使用 PIN 碼進行次要使用者驗證。如果使用者透過這些指令停用其他安全裝置，系統會將他們的住家安全性視為受影響。

這個指令需要下列屬性： 
{
  "supportsEnablingNetworkProfile": true,
  "supportsDisablingNetworkProfile": true
}

參數

參數 類型 說明
profile String

必要。

networkProfiles 屬性的設定檔名稱。
enable 布林

必要。

True 來啟用設定檔，設為 false 即可停用設定檔。

範例

為孩子關閉網際網路。

{
  "command": "action.devices.commands.EnableDisableNetworkProfile",
  "params": {
    "profile": "Kids",
    "enable": false
  }
}

嘗試控制指定網路設定檔時發生錯誤。

支援的值：

networkProfileNotRecognized

action.devices.commands.GetGuestNetworkPassword

取得訪客網路密碼。必須使用 PIN 碼進行次要使用者驗證。如果使用者透過這些指令停用其他安全裝置，系統會將他們的住家安全性視為受影響。

這個指令需要下列屬性： 
{
  "supportsGettingGuestNetworkPassword": true
}

參數

參數 類型 說明

沒有任何資源

範例

顯示我的訪客 Wi-Fi 密碼。

{
  "command": "action.devices.commands.GetGuestNetworkPassword",
  "params": {}
}

成果

成果 類型 說明
guestNetworkPassword String

必要。

訪客網路的密碼。

範例

顯示我的訪客 Wi-Fi 密碼。

{
  "guestNetworkPassword": "123456"
}

action.devices.commands.TestNetworkSpeed

測試網路下載和上傳速度。

這個指令需要下列屬性： 
{
  "supportsNetworkDownloadSpeedTest": true,
  "supportsNetworkUploadSpeedTest": true
}

參數

參數 類型 說明
testDownloadSpeed 布林

必要。

指出是否應測試下載速度。
testUploadSpeed 布林

必要。

表明是否應測試上傳速度。
followUpToken String

必要。

Google 提供的後續追蹤權杖。

範例

什麼是 Wi-Fi 速度？

{
  "command": "action.devices.commands.TestNetworkSpeed",
  "params": {
    "testDownloadSpeed": true,
    "testUploadSpeed": true,
    "followUpToken": "123"
  }
}

嘗試要求速度測試時發生錯誤。

支援的值：

networkSpeedTestInProgress

後續追蹤回覆

使用這項特性的裝置可能會傳回下列後續回應酬載，做為 EXECUTE 作業的一部分。如要進一步瞭解如何實作後續回應，請參閱「智慧型住宅動作通知」。

酬載包含下列內容：

成功：networkDownloadSpeedMbps

欄位 類型 說明
followUpToken String

必要。

原始 EXECUTE 要求中提供的權杖。
status String

必要。

要求的結果。

支援的值：

SUCCESS
networkDownloadSpeedMbps Number

必要。

網路下載速度 (以百萬位元/秒為單位)。

成功：networkUploadSpeedMbps

欄位 類型 說明
followUpToken String

必要。

原始 EXECUTE 要求中提供的權杖。
status String

必要。

要求的結果。

支援的值：

SUCCESS
networkUploadSpeedMbps Number

必要。

網路上傳速度 (以百萬位元/秒為單位)。

成功：networkDownloadSpeedMbps 和 networkUploadSpeedMbps

欄位 類型 說明
followUpToken String

必要。

原始 EXECUTE 要求中提供的權杖。
status String

必要。

要求的結果。

支援的值：

SUCCESS
networkDownloadSpeedMbps Number

必要。

網路下載速度 (以百萬位元/秒為單位)。
networkUploadSpeedMbps Number

必要。

網路上傳速度 (以百萬位元/秒為單位)。

失敗

欄位 類型 說明
followUpToken String

必要。

原始 EXECUTE 要求中提供的權杖。
status String

必要。

要求的結果。

支援的值：

FAILURE
errorCode String

必要。

這個值可以是這項特徵的任何錯誤代碼，例如 transientError。

範例

Wi-Fi 速度多快？(後續追蹤)

{
  "NetworkControl": {
    "priority": 0,
    "followUpResponse": {
      "status": "SUCCESS",
      "networkDownloadSpeedMbps": 23.3,
      "networkUploadSpeedMbps": 10.2,
      "followUpToken": "1234"
    }
  }
}

Wi-Fi 速度多快？(失敗的後續回覆)

{
  "NetworkControl": {
    "priority": 0,
    "followUpResponse": {
      "status": "FAILURE",
      "errorCode": "transientError",
      "followUpToken": "1234"
    }
  }
}

裝置 ERRORS

請參閱錯誤和例外狀況的完整清單。

嘗試控制指定網路設定檔時發生錯誤。

支援的值：

networkProfileNotRecognized

嘗試要求速度測試時發生錯誤。

支援的值：

networkSpeedTestInProgress