ตัวอย่างแอป Android สำหรับ Home API

แอปตัวอย่างแสดงความสามารถพื้นฐานของ Google Home API

ข้อกำหนดเบื้องต้น

หากต้องการสร้าง ติดตั้ง และทดสอบแอป คุณจะต้องมีคุณสมบัติตรงตามข้อกําหนดเบื้องต้นต่อไปนี้

  • Android Studio เวอร์ชัน 2024.2.1 ("Ladybug") ขึ้นไป โปรดทราบว่าเวอร์ชันที่เก่ากว่านี้อาจใช้งานร่วมกับ Home APIs SDK อย่างไม่ถูกต้อง

    ดาวน์โหลด Android Studio

  • โปรแกรมแก้ไขข้อบกพร่อง Android (adb)

    ติดตั้ง adb

    ซึ่งทําได้ด้วย SDK Manager

และหากต้องการทดสอบ Home API คุณจะต้องมีสิ่งต่อไปนี้

  • อุปกรณ์ Android ที่ใช้ Android 10 ขึ้นไปซึ่งตั้งค่าด้วยบัญชี Google ที่คุณตั้งใจจะใช้สำหรับการพัฒนา ตรวจสอบว่าได้ติดตั้ง Android Studio เวอร์ชันล่าสุดและลงชื่อเข้าใช้ด้วยบัญชีการพัฒนานี้
  • เครือข่าย Wi-Fi
  • Google Hub ที่รองรับ Home API

  • อุปกรณ์ที่รองรับอย่างน้อย 1 เครื่องในบ้าน หากอุปกรณ์นี้ (หรืออุปกรณ์อื่นๆ ที่ต้องการทดสอบ) ใช้ Thread ฮับจะต้องเป็น Thread Border Router ด้วย แอปตัวอย่าง Android รองรับประเภทและลักษณะของอุปกรณ์ต่อไปนี้

    • หลอดไฟอุณหภูมิสี (เปิดและปิด ความสว่าง)
    • เซ็นเซอร์ตรวจจับสัญญาณ (สถานะบูลีน)
    • หลอดไฟหรี่แสงได้ (เปิดและปิด ความสว่าง)
    • ไฟสีแบบขยาย (เปิดและปิด ความสว่าง)
    • สวิตช์ทั่วไป
    • เซ็นเซอร์ตรวจจับคน (การตรวจจับว่ามีคนอยู่ในบ้าน)
    • เปิด/ปิดไฟ (เปิดและปิด ความสว่าง)
    • สวิตช์เปิด/ปิดไฟ
    • หน่วยปลั๊กอินเปิด/ปิด (เปิดและปิด)
    • เซ็นเซอร์เปิด/ปิด

  1. ในคอนโซล Google Cloud ให้ไปที่แดชบอร์ดเครื่องมือเลือกโปรเจ็กต์ แล้วเลือกโปรเจ็กต์ที่ต้องการใช้สร้างข้อมูลเข้าสู่ระบบ OAuth
  2. ไปที่หน้า API และบริการ แล้วคลิกข้อมูลเข้าสู่ระบบในเมนูการนำทาง

  3. หากยังไม่ได้กําหนดค่าหน้าจอขอความยินยอมสําหรับโปรเจ็กต์ Google Cloud นี้ ปุ่มกําหนดค่าหน้าจอขอความยินยอมจะปรากฏขึ้น ในกรณีนี้ ให้กําหนดค่าหน้าจอความยินยอมโดยใช้ขั้นตอนต่อไปนี้ ไม่เช่นนั้น ให้ไปที่ส่วนถัดไป

    1. คลิกกําหนดค่าหน้าจอความยินยอม หน้าหน้าจอขอความยินยอม OAuth จะปรากฏขึ้น
    2. เลือกภายในหรือภายนอก โดยขึ้นอยู่กับกรณีการใช้งาน แล้วคลิกสร้าง แผงหน้าจอขอความยินยอม OAuth จะปรากฏขึ้น
    3. ป้อนข้อมูลในหน้าข้อมูลแอปตามวิธีการบนหน้าจอ แล้วคลิกบันทึกและดำเนินการต่อ แผงขอบเขตจะปรากฏขึ้น
    4. คุณไม่จําเป็นต้องเพิ่มขอบเขตใดๆ ให้คลิกบันทึกและต่อไป แผงผู้ใช้ทดสอบจะปรากฏขึ้น
    5. หากต้องการเพิ่มผู้ใช้เพื่อทดสอบสิทธิ์เข้าถึงแอป ให้คลิกเพิ่มผู้ใช้ แผงเพิ่มผู้ใช้จะปรากฏขึ้น ผู้ใช้ทดสอบมีสิทธิ์ให้สิทธิ์ในแอป
    6. ในช่องว่าง ให้เพิ่มอีเมลของบัญชี Google อย่างน้อย 1 รายการ แล้วคลิกเพิ่ม
    7. คลิกบันทึกและต่อไป บานหน้าต่างสรุปจะปรากฏขึ้น
    8. ตรวจสอบข้อมูลหน้าจอขอความยินยอม OAuth แล้วคลิกกลับไปยังแดชบอร์ด

ดูรายละเอียดทั้งหมดได้ที่การตั้งค่าหน้าจอขอความยินยอม OAuth ในเว็บไซต์ความช่วยเหลือของ Google Cloud Console

ดาวน์โหลดซอร์สโค้ด

ซอร์สโค้ดของแอปตัวอย่างมีอยู่ใน GitHub

ไปยังตำแหน่งที่ต้องการบันทึกโปรเจ็กต์ แล้วทําการโคลน ดังนี้

git clone https://github.com/google-home/google-home-api-sample-app-android.git

ตั้งค่า SDK

Home API ในรุ่นเบต้าแบบเปิดนี้ยังไม่เป็นส่วนหนึ่งของไลบรารีมาตรฐานที่ Google ให้บริการสำหรับการพัฒนา หากต้องการพัฒนาแอปพลิเคชันด้วย Home API คุณต้องดาวน์โหลดและโฮสต์ไลบรารีในเครื่อง

หากต้องการดาวน์โหลด Android SDK ของ Home APIs คุณต้องลงชื่อเข้าใช้ Google Home Developers ก่อน

ลงชื่อเข้าใช้เลย

สร้างและเรียกใช้

  1. เปิด Android Studio แล้วเปิดโฟลเดอร์โปรเจ็กต์ google-home-api-sample-app-android ที่โคลนไปยังเครื่อง
  2. ในระหว่างการตั้งค่าครั้งแรก Android Studio อาจใช้เวลาถึง 10 นาทีในการดาวน์โหลดไลบรารีทั้งหมดของโปรเจ็กต์และสร้าง Gradle ให้เสร็จสมบูรณ์
    • หากพบข้อผิดพลาดระหว่างขั้นตอนนี้ เช่น Gradle Sync Failed ให้คลิกลองอีกครั้งเพื่อเริ่มการซิงค์อีกครั้ง
  3. เปลี่ยนชื่อแพ็กเกจของแอปตัวอย่างเป็นชื่อใหม่ที่ไม่ได้ลงทะเบียนไว้ก่อนหน้านี้ เช่น ชื่อที่อิงตามชื่อองค์กรของคุณ ดังนี้
    1. เปิดโปรเจ็กต์
    2. ขยายลําดับชั้นแหล่งที่มา
    3. เลือกส่วนในแพ็กเกจที่ต้องการเปลี่ยน หรือพูดอีกอย่างคือ com.example
    4. คลิกขวาที่แพ็กเกจ แล้วเลือกปรับโครงสร้าง > เปลี่ยนชื่อ...
    5. คลิกไดเรกทอรีทั้งหมด
    6. ป้อนชื่อใหม่แล้วคลิกปรับโครงสร้าง
    7. แก้ไขไฟล์ build.gradle.kts โดยเปลี่ยน android namespace และ applicationId เป็นชื่อแพ็กเกจใหม่
    8. แก้ไขไฟล์ AndroidManifest.xml และเปลี่ยนแพ็กเกจเป็นชื่อแพ็กเกจใหม่ในทุกที่ที่ปรากฏในไฟล์

  4. สร้างคีย์ OAuth โดยเรียกใช้แอปใน Android Studio เมื่อคุณเรียกใช้หรือแก้ไขข้อบกพร่องของแอปใน Android Studio Android Studio จะสร้างคีย์ OAuth โดยอัตโนมัติเพื่อการพัฒนาและการแก้ไขข้อบกพร่อง ดูคำอธิบายทั้งหมดได้ที่ Android Studio: ลงนามในบิลด์แก้ไขข้อบกพร่อง

    เชื่อมต่ออุปกรณ์เคลื่อนที่กับเครื่องคอมพิวเตอร์ Android Studio จะแสดงรายการอุปกรณ์ที่เชื่อมต่อตามหมายเลขรุ่น เลือกอุปกรณ์จากรายการ แล้วคลิกเรียกใช้โปรเจ็กต์ ซึ่งจะสร้างและติดตั้งแอปตัวอย่างในอุปกรณ์เคลื่อนที่

    ดูวิธีการโดยละเอียดได้ที่เรียกใช้แอปในอุปกรณ์ฮาร์ดแวร์ในเว็บไซต์ของนักพัฒนาแอป Android

    จากนั้นให้หยุดแอปที่ทำงานอยู่

  5. รับลายนิ้วมือ SHA-1 ของใบรับรอง OAuth โดยทําตามวิธีการที่ระบุไว้อย่างละเอียดในหัวข้อการตั้งค่า OAuth 2.0 / แอปพลิเคชันเนทีฟ / Android ในเว็บไซต์ความช่วยเหลือของ Google Cloud Console

  6. ลงทะเบียนแอปตัวอย่างสําหรับ OAuth 2.0 และสร้างข้อมูลเข้าสู่ระบบ OAuth โดยทําตามวิธีการที่ระบุไว้ในการตั้งค่า OAuth 2.0

    1. ระบุประเภทแอปพลิเคชัน ซึ่งก็คือแอป Android ที่มาพร้อมเครื่อง
    2. เพิ่มลายนิ้วมือ SHA-1 ลงในไคลเอ็นต์ OAuth โดยทําตามวิธีการในหัวข้อการตั้งค่า OAuth 2.0 / แอปพลิเคชันเนทีฟ / Android ในเว็บไซต์ความช่วยเหลือของคอนโซล Google Cloud คุณควรสร้างคีย์ SHA-1 จากคีย์เริ่มต้นของ Android Studio ตลอดกระบวนการพัฒนา
    3. เพิ่มผู้ใช้ทดสอบ ผู้ใช้ทดสอบมีสิทธิ์ให้สิทธิ์ในแอปตัวอย่าง

  7. เมื่ออุปกรณ์เคลื่อนที่เชื่อมต่อกับเครื่องในเครื่องแล้ว ให้คลิกเรียกใช้โปรเจ็กต์อีกครั้งเพื่อเรียกใช้แอปตัวอย่างบนอุปกรณ์เคลื่อนที่

เมื่อติดตั้งแล้ว แอปจะพร้อมใช้งานบนอุปกรณ์เคลื่อนที่เป็นตัวอย่างแอป Home API