1. 事前準備
身為物聯網 (IoT) 的開發人員,您可以打造智慧型住宅動作,讓使用者能透過 Google Home 應用程式中的觸控設定,以及搭配 Google 助理下達語音指令來操控裝置。
智慧型住宅動作會運用 Home Graph 提供住家和住宅裝置的情境資料,以建立住家的邏輯地圖。取得背景資訊後,Google 助理就能更自然地瞭解使用者要求 (相對於家中位置) 的要求。舉例來說,Home Graph 可以儲存客廳這個概念,而這個概念包含不同製造商生產的多種裝置,例如溫度控制器、燈具、風扇和吸塵器。
必要條件
- 開發人員指南:建立智慧型住宅動作
建構項目
在本程式碼研究室中,您將發布用於管理虛擬智慧洗衣機的雲端服務,然後建立智慧型住宅動作並連結至 Google 助理。
課程內容
- 如何部署智慧型住宅雲端服務
- 如何將服務連結至 Google 助理
- 如何將裝置狀態變更發布至 Google
軟硬體需求
- 網路瀏覽器,例如 Google Chrome
- 已安裝 Google Home 應用程式的 iOS 或 Android 裝置
- Node.js 10.16 或以上版本
- Google Cloud 帳單帳戶
2. 開始使用
啟用活動控制項
如要使用 Google 助理,您必須將特定活動資料提供給 Google。Google 助理需要這類資料才能正常運作;不過,共用資料的要求不只適用於 SDK。如要分享這些資料,請建立 Google 帳戶 (如果還沒有帳戶)。您可以使用任何 Google 帳戶,不一定要是開發人員帳戶。
開啟要搭配 Google 助理使用的 Google 帳戶,並開啟該帳戶的「活動控制項」頁面。
請確保已啟用下列切換開關:
- 網路和應用程式活動:此外,請務必勾選「包括 Chrome 歷史記錄以及採用 Google 服務的網站、應用程式和裝置中的活動記錄」核取方塊。
- 裝置資訊
- 語音和音訊活動
建立動作專案
- 前往 Actions on Google Developer Console。
- 按一下「新增專案」並輸入專案名稱,然後按一下「建立專案」。
選取智慧型住宅應用程式
在動作控制台的總覽畫面上,選取「智慧型住宅」。
如果選擇「智慧型住宅」體驗資訊卡,按一下「開始建築物」,系統就會將您帶往專案控制台。
安裝 Firebase CLI
Firebase 指令列介面 (CLI) 可讓您在本機提供網頁應用程式,並將網頁應用程式部署至 Firebase 託管服務。
如要安裝 CLI,請從終端機執行下列 npm 指令:
npm install -g firebase-tools
如要驗證 CLI 是否已正確安裝,請執行:
firebase --version
執行下列指令,以您的 Google 帳戶授權 Firebase CLI:
firebase login
3. 執行範例應用程式
現在您已設定開發環境,可以部署範例專案,確認所有設定皆正確無誤。
取得原始碼
點選下方連結,即可在開發機器上下載這個程式碼研究室的範例:
...或透過指令列複製 GitHub 存放區:
git clone https://github.com/google-home/smarthome-washer.git
關於專案
範例專案包含下列子目錄:
public:
前端 UI 可讓您輕鬆控制及監控智慧型洗衣機的狀態。functions:
完全導入的雲端服務,使用 Cloud Functions for Firebase 和 Firebase 即時資料庫管理智慧洗衣服務。
連結至 Firebase
前往 washer-start
目錄,然後搭配 Actions 專案設定 Firebase CLI:
cd washer-start firebase use <project-id>
設定 Firebase 專案
初始化 Firebase 專案。
firebase init
選取 CLI 功能、即時資料庫、函式,以及含有 Firebase 託管的代管功能。
? Which Firebase CLI features do you want to set up for this directory? Press Space to select features, then Enter to confirm your choices. ❯◉ Realtime Database: Configure a security rules file for Realtime Database and (optionally) provision default instance ◯ Firestore: Configure security rules and indexes files for Firestore ◉ Functions: Configure a Cloud Functions directory and its files ◉ Hosting: Configure files for Firebase Hosting and (optionally) set up GitHub Action deploys ◯ Hosting: Set up GitHub Action deploys ◯ Storage: Configure a security rules file for Cloud Storage ◯ Emulators: Set up local emulators for Firebase products ◯ Remote Config: Configure a template file for Remote Config ◯ Extensions: Set up an empty Extensions manifest
這項操作會為專案初始化必要的 API 和功能。
出現提示時,初始化即時資料庫。您可以使用資料庫執行個體的預設位置。
? It seems like you haven't initialized Realtime Database in your project yet. Do you want to set it up? Yes ? Please choose the location for your default Realtime Database instance: us-central1
由於您使用範例專案程式碼,請選擇安全性規則的預設檔案,並確保不會覆寫現有的資料庫規則檔案。
? File database.rules.json already exists. Do you want to overwrite it with the Realtime Database Security Rules for <project-ID>-default-rtdb from the Firebase Console? No
如要重新初始化專案,請在系統詢問是否要初始化或覆寫程式碼集時,選取「Overwrite」。
? Would you like to initialize a new codebase, or overwrite an existing one? Overwrite
設定函式時,您應使用預設檔案,並確保不會覆寫專案範例中現有的 index.js 和 package.json 檔案。
? What language would you like to use to write Cloud Functions? JavaScript ? Do you want to use ESLint to catch probable bugs and enforce style? No ? File functions/package.json already exists. Overwrite? No ? File functions/index.js already exists. Overwrite? No
如要重新初始化專案,請在系統詢問是否要初始化或覆寫 function/.gitignore 時,選取「否」。
? File functions/.gitignore already exists. Overwrite? No
? Do you want to install dependencies with npm now? Yes
最後,將「託管」設定設為使用專案程式碼中的 public
目錄,並使用現有的 index.html 檔案。當系統要求使用 ESLint 時,請選取「否」。
? What do you want to use as your public directory? public ? Configure as a single-page app (rewrite all urls to /index.html)? Yes ? Set up automatic builds and deploys with GitHub? No ? File public/index.html already exists. Overwrite? No
如果不小心啟用了 ESLint,您可以透過兩種方法停用 ESLint:
- 使用 GUI 前往專案下方的
../functions
資料夾,選取隱藏的檔案.eslintrc.js
,然後刪除該檔案。請勿將其誤認為.eslintrc.json
名稱類似。 - 使用指令列:
cd functions rm .eslintrc.js
為確保 Firebase 設定正確且完整,請將 firebase.json
檔案從 app-done
目錄複製到 app-start
目錄,覆寫 app-start
中的檔案。
在 app-start
目錄中:
cp -vp ../app-done/firebase.json .
部署至 Firebase
安裝依附元件並設定專案後,即可開始首次執行應用程式。
firebase deploy
以下是您應該會看到的主控台輸出內容:
... ✔ Deploy complete! Project Console: https://console.firebase.google.com/project/<project-id>/overview Hosting URL: https://<project-id>.web.app
這個指令會部署網頁應用程式和數個 Cloud Functions for Firebase。
在瀏覽器中開啟代管網址 (https://<project-id>.web.app
) 查看網路應用程式。您會看到以下介面:
此網頁版 UI 代表可查看或修改裝置狀態的第三方平台。如要開始在資料庫中填入裝置資訊,請按一下「更新」。您不會在頁面上看到任何變更,但洗衣機目前的狀態將儲存在資料庫中。
現在可以使用 Actions 主控台將部署的雲端服務連結至 Google 助理了。
設定 Actions 主控台專案
在「Overview」>「Build your Action」下方,選取「Add Action(s)」。輸入可為智慧型住宅意圖提供執行要求的 Cloud 函式網址,然後按一下「Save」。
https://us-central1-<project-id>.cloudfunctions.net/smarthome
在「開發」>「叫用」分頁中,為動作新增「顯示名稱」,然後按一下「儲存」。這個名稱會顯示在 Google Home 應用程式中。
如要啟用帳戶連結功能,請在左側導覽面板中依序選取「開發」>「帳戶連結」選項。使用下列帳戶連結設定:
用戶端 ID |
|
用戶端密碼 |
|
驗證網址 |
|
權杖網址 |
|
按一下「儲存」儲存帳戶連結設定,然後點選「測試」為專案啟用測試功能。
系統會將您重新導向至模擬工具。如果沒有看到「立即測試已啟用」,請按一下「重設測試」,確認測試已啟用。
現在您可以開始導入將裝置狀態與 Google 助理連結時所需的 Webhook。
4. 建立洗衣機
設定動作後,您就可以新增裝置及傳送資料。您的雲端服務需要處理下列意圖:
- 如果 Google 助理想要瞭解使用者已連結的裝置,就會發生
SYNC
意圖。當使用者連結帳戶後,這個電子郵件會傳送至您的服務。您應以所有使用者裝置及其功能的 JSON 酬載回應。 - 如果 Google 助理想瞭解裝置目前狀態或狀態,就會發生
QUERY
意圖。您應該透過 JSON 酬載回應,內含每部要求裝置的狀態。 - 如果 Google 助理想為使用者控制裝置,就會發生
EXECUTE
意圖。您應該透過 JSON 酬載回應,其中包含每個要求裝置的執行狀態。 - 當使用者將帳戶與 Google 助理取消連結時,就會發生
DISCONNECT
意圖。建議你停止將這位使用者的裝置事件傳送給 Google 助理。
您將更新先前部署的函式,以處理下列各節中的這些意圖。
更新 SYNC 回應
開啟 functions/index.js
,其中包含用來回應 Google 助理要求的程式碼。
您必須傳回裝置中繼資料和功能,處理 SYNC
意圖。更新 onSync
陣列中的 JSON,加入裝置資訊和服飾洗衣機的建議 traits。
index.js
app.onSync((body) => {
return {
requestId: body.requestId,
payload: {
agentUserId: USER_ID,
devices: [{
id: 'washer',
type: 'action.devices.types.WASHER',
traits: [
'action.devices.traits.OnOff',
'action.devices.traits.StartStop',
'action.devices.traits.RunCycle',
],
name: {
defaultNames: ['My Washer'],
name: 'Washer',
nicknames: ['Washer'],
},
deviceInfo: {
manufacturer: 'Acme Co',
model: 'acme-washer',
hwVersion: '1.0',
swVersion: '1.0.1',
},
willReportState: true,
attributes: {
pausable: true,
},
}],
},
};
});
部署至 Firebase
使用 Firebase CLI 部署更新後的雲端執行要求:
firebase deploy --only functions
連結至 Google 助理
如要測試智慧型住宅動作,你必須將專案連結至 Google 帳戶。如此一來,即可透過已登入相同帳戶的 Google 助理介面和 Google Home 應用程式進行測試。
- 在手機上開啟 Google 助理設定。請注意,您登入的帳戶必須與控制台相同。
- 依序前往「Google 助理」>「設定」>「居家控制系統」 (位於「Google 助理」下方)。
- 按一下右上方的「搜尋」圖示。
- 使用 [test] 前置字串搜尋測試版應用程式,找出特定的測試應用程式。
- 選取該項目。接著,Google 助理會向您的服務進行驗證並傳送
SYNC
要求,要求您的服務為使用者提供裝置清單。
開啟 Google Home 應用程式,確認可看到你的洗衣裝置。
5. 處理指令和查詢
現在您的雲端服務能正確向 Google 回報洗衣機裝置,您必須新增要求裝置狀態及傳送指令的功能。
處理 QUERY 意圖
QUERY
意圖包含一組裝置。您應該針對每部裝置提供回應,指出裝置目前的狀態。
在 functions/index.js
中編輯 QUERY
處理常式,以處理意圖要求中包含的目標裝置清單。
index.js
app.onQuery(async (body) => {
const {requestId} = body;
const payload = {
devices: {},
};
const queryPromises = [];
const intent = body.inputs[0];
for (const device of intent.payload.devices) {
const deviceId = device.id;
queryPromises.push(queryDevice(deviceId)
.then((data) => {
// Add response to device payload
payload.devices[deviceId] = data;
}
));
}
// Wait for all promises to resolve
await Promise.all(queryPromises);
return {
requestId: requestId,
payload: payload,
};
});
針對要求中包含的每部裝置,傳回即時資料庫中儲存的目前狀態。更新 queryFirebase
和 queryDevice
函式,以傳回洗衣機的狀態資料。
index.js
const queryFirebase = async (deviceId) => {
const snapshot = await firebaseRef.child(deviceId).once('value');
const snapshotVal = snapshot.val();
return {
on: snapshotVal.OnOff.on,
isPaused: snapshotVal.StartStop.isPaused,
isRunning: snapshotVal.StartStop.isRunning,
};
};
const queryDevice = async (deviceId) => {
const data = await queryFirebase(deviceId);
return {
on: data.on,
isPaused: data.isPaused,
isRunning: data.isRunning,
currentRunCycle: [{
currentCycle: 'rinse',
nextCycle: 'spin',
lang: 'en',
}],
currentTotalRemainingTime: 1212,
currentCycleRemainingTime: 301,
};
};
處理執行意圖
EXECUTE
意圖會處理用於更新裝置狀態的指令。回應會傳回每個指令的狀態 (例如 SUCCESS
、ERROR
或 PENDING
),以及新裝置狀態。
在 functions/index.js
中編輯 EXECUTE
處理常式,以處理需要更新的特性清單,以及每個指令的目標裝置組合:
index.js
app.onExecute(async (body) => {
const {requestId} = body;
// Execution results are grouped by status
const result = {
ids: [],
status: 'SUCCESS',
states: {
online: true,
},
};
const executePromises = [];
const intent = body.inputs[0];
for (const command of intent.payload.commands) {
for (const device of command.devices) {
for (const execution of command.execution) {
executePromises.push(
updateDevice(execution, device.id)
.then((data) => {
result.ids.push(device.id);
Object.assign(result.states, data);
})
.catch(() => functions.logger.error('EXECUTE', device.id)));
}
}
}
await Promise.all(executePromises);
return {
requestId: requestId,
payload: {
commands: [result],
},
};
});
針對每個指令和目標裝置,更新即時資料庫中所要求特徵的值。修改 updateDevice
函式以更新適當的 Firebase 參照,並傳回更新後的裝置狀態。
index.js
const updateDevice = async (execution, deviceId) => {
const {params, command} = execution;
let state; let ref;
switch (command) {
case 'action.devices.commands.OnOff':
state = {on: params.on};
ref = firebaseRef.child(deviceId).child('OnOff');
break;
case 'action.devices.commands.StartStop':
state = {isRunning: params.start};
ref = firebaseRef.child(deviceId).child('StartStop');
break;
case 'action.devices.commands.PauseUnpause':
state = {isPaused: params.pause};
ref = firebaseRef.child(deviceId).child('StartStop');
break;
}
return ref.update(state)
.then(() => state);
};
6. 測試動作
實作所有三個意圖後,您可以測試動作是否控制洗衣機。
部署至 Firebase
使用 Firebase CLI 部署更新後的雲端執行要求:
firebase deploy --only functions
測試洗衣機
現在,當您透過手機嘗試下列任一語音指令時,可以看到這個值變更:
「Ok Google,打開洗衣機。」
「Ok Google,暫停使用洗衣機。」
「Ok Google,停止『洗衣』。」
你也可以提出問題,瞭解洗衣機目前的狀態。
「Ok Google,我的洗衣機是否開啟了?」
「Ok Google,我的洗衣機在跑步嗎?」
「Ok Google,我的洗衣週期是什麼?」
您可以前往 Firebase 控制台的「函式」部分,在函式下方的記錄檔中查看這些查詢和指令。如要進一步瞭解 Firebase 記錄,請參閱「寫入及查看記錄」。
您也可以在 Google Cloud 控制台中依序前往「Logging」 >「記錄檔探索工具」,找到這些查詢和指令。如要進一步瞭解 Google Cloud Logging,請參閱「透過 Cloud Logging 存取事件記錄」。
7. 向 Google 回報更新內容
您已完整整合雲端服務與智慧型住宅意圖,讓使用者能控制及查詢裝置的目前狀態。不過,導入這項功能後,您的服務仍無法主動將活動資訊 (例如裝置在家狀態或狀態變更) 傳送給 Google 助理。
啟用要求同步處理功能後,您就可以在使用者新增或移除裝置,或是裝置功能變更時觸發新的同步要求。有了回報狀態功能,您的雲端服務可在使用者實際變更裝置狀態 (例如開燈或使用其他服務) 時,主動將裝置的狀態傳送到 Home Graph。
在本節中,您將新增程式碼,以便從前端網頁應用程式呼叫這些方法。
啟用 HomeGraph API
HomeGraph API 可用於儲存及查詢使用者的 Home Graph 中的裝置及其狀態。如要使用這個 API,請先開啟 Google Cloud 控制台並啟用 HomeGraph API。
在 Google Cloud 控制台中,請務必選取與「動作」<project-id>.
相符的專案,然後在 HomeGraph API 的 API 程式庫畫面中按一下「啟用」。
啟用「報告狀態」
寫入即時資料庫,觸發範例專案中的 reportstate
函式。更新 functions/index.js
中的 reportstate
函式,擷取寫入資料庫的資料,並透過報告狀態將資料發布至 Home Graph。
index.js
exports.reportstate = functions.database.ref('{deviceId}').onWrite(
async (change, context) => {
functions.logger.info('Firebase write event triggered Report State');
const snapshot = change.after.val();
const requestBody = {
requestId: 'ff36a3cc', /* Any unique ID */
agentUserId: USER_ID,
payload: {
devices: {
states: {
/* Report the current state of our washer */
[context.params.deviceId]: {
on: snapshot.OnOff.on,
isPaused: snapshot.StartStop.isPaused,
isRunning: snapshot.StartStop.isRunning,
},
},
},
},
};
const res = await homegraph.devices.reportStateAndNotification({
requestBody,
});
functions.logger.info('Report state response:', res.status, res.data);
});
啟用要求同步處理
在前端網頁 UI 中重新整理圖示,會觸發範例專案中的 requestsync
函式。在 functions/index.js
中實作 requestsync
函式,以呼叫 HomeGraph API。
index.js
exports.requestsync = functions.https.onRequest(async (request, response) => {
response.set('Access-Control-Allow-Origin', '*');
functions.logger.info(`Request SYNC for user ${USER_ID}`);
try {
const res = await homegraph.devices.requestSync({
requestBody: {
agentUserId: USER_ID,
},
});
functions.logger.info('Request sync response:', res.status, res.data);
response.json(res.data);
} catch (err) {
functions.logger.error(err);
response.status(500).send(`Error requesting sync: ${err}`);
}
});
部署至 Firebase
使用 Firebase CLI 部署更新過的程式碼:
firebase deploy --only functions
測試實作成果
按一下網頁版 UI 中的「重新整理」 按鈕,然後確認 Firebase 控制台記錄中顯示同步處理要求。
接著,在前端網頁 UI 中調整洗衣機裝置的屬性,然後按一下「更新」。確認 Firebase 控制台記錄檔中會顯示向 Google 回報的狀態變更。
8. 恭喜
恭喜!您已成功透過智慧型住宅動作將 Google 助理與裝置雲端服務整合。
瞭解詳情
不妨採納下列建議,進一步瞭解這些做法:
您也可以進一步瞭解如何測試並提交動作以供審查,包括向使用者發布動作的認證程序。