スマートホーム ネットワーク ガイド
action.devices.types.NETWORK - 個々のデバイスとしてではなく、1 つのエンティティとして制御されるルーターノードまたはメッシュ ネットワークのグループを表します。ネットワーク デバイスは、再起動やソフトウェアの更新を行うほか、サービス品質（QoS）管理や保護者による使用制限を適用するためのモードを持つこともあります。
デバイスは、ゲスト ネットワークの有効化などの操作や、現在のインターネット スループット率などのネットワーク固有の情報の報告を行えます。
タイプがネットワーク アイコンと、関連する類義語とエイリアスを持つことを示します。
デバイスの機能
サービスがサポートする属性や状態、EXECUTE レスポンスと QUERY レスポンスの構築方法など、実装の詳細については、対応するトレイトのドキュメントをご覧ください。
必要な特性
これらのトレイトとコマンドは、お使いのデバイスに必須です。
推奨されるトレイト
これらのトレイトは、お客様のデバイスに該当する場合におすすめです。 ただし、既存のプロダクトの機能に合わせて、使用可能なすべてのトレイトを自由に組み合わせて使用できます。
品質要件
- レイテンシ: 300 ミリ秒以下
- 信頼性: 97% 以上を指定します。
デバイスの例: シンプルなネットワーク
このセクションでは、上記のデバイスタイプとトレイトに基づいた、一般的な「ネットワーク」を表すインテント ペイロードの例について説明します。実装でトレイトを追加または削除する場合は、その変更を反映するようにレスポンスを変更します。
SYNC レスポンスの例
{
"requestId": "6894439706274654512",
"inputs": [
{
"intent": "action.devices.SYNC"
}
]
}
{
"requestId": "6894439706274654512",
"payload": {
"agentUserId": "user123",
"devices": [
{
"id": "123",
"type": "action.devices.types.NETWORK",
"traits": [
"action.devices.traits.Reboot",
"action.devices.traits.NetworkControl"
],
"name": {
"name": "Simple network"
},
"willReportState": true,
"attributes": {
"supportsEnablingNetworkProfile": true,
"supportsDisablingNetworkProfile": true,
"supportsNetworkDownloadSpeedTest": true,
"supportsNetworkUploadSpeedTest": true,
"networkProfiles": [
"kids"
]
},
"deviceInfo": {
"manufacturer": "smart-home-inc",
"model": "hs1234",
"hwVersion": "3.2",
"swVersion": "11.4"
}
}
]
}
}
QUERY レスポンスの例
{
"requestId": "6894439706274654514",
"inputs": [
{
"intent": "action.devices.QUERY",
"payload": {
"devices": [
{
"id": "123"
}
]
}
}
]
}
{
"requestId": "6894439706274654514",
"payload": {
"devices": {
"123": {
"status": "SUCCESS",
"online": true,
"networkEnabled": true,
"networkSettings": {
"ssid": "home-network-123"
}
}
}
}
}
EXECUTE コマンドの例
再起動
コマンド パラメータの詳細については、
action.devices.traits.Reboot リファレンスをご覧ください。
{
"requestId": "6894439706274654516",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.Reboot"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654516",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true
}
}
]
}
}
enableDisableNetworkProfile
コマンド パラメータの詳細については、
action.devices.traits.NetworkControl リファレンスをご覧ください。
{
"requestId": "6894439706274654518",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.EnableDisableNetworkProfile",
"params": {
"profile": "kids",
"enable": false
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654518",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"networkEnabled": true,
"networkSettings": {
"ssid": "home-network-123"
}
}
}
]
}
}
TestNetworkSpeed
コマンド パラメータの詳細については、
action.devices.traits.NetworkControl リファレンスをご覧ください。
{
"requestId": "6894439706274654520",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TestNetworkSpeed",
"params": {
"testDownloadSpeed": true,
"testUploadSpeed": true,
"followUpToken": "123"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654520",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true
}
}
]
}
}