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

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

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

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

  • 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
  • หากต้องการเข้าถึงและควบคุมMatter คุณต้องมีฮับของ Google ที่รองรับ Home API ด้วย ดูรายละเอียดได้ที่การเชื่อมต่อใน Android

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

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

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

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

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

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

ตั้งค่า SDK

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

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

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

สร้างแอป

  1. เปิด Android Studio จากนั้นเปิดโฟลเดอร์โปรเจ็กต์ google-home-api-sample-app-android ที่โคลนไปยังเครื่องในพื้นที่

  2. ในระหว่างการตั้งค่าครั้งแรก Android Studio อาจใช้เวลาถึง 10 นาทีในการดาวน์โหลดการอ้างอิงทั้งหมดของโปรเจ็กต์และสร้าง Gradle ให้เสร็จสมบูรณ์

  3. เชื่อมต่อคอมพิวเตอร์กับโทรศัพท์ Android จริงผ่านสาย USB และ เปิดใช้ ADB ในตัวเลือกสำหรับนักพัฒนาแอป ตรวจสอบว่า Android Studio เชื่อมต่อกับโทรศัพท์ Android ผ่าน ADB ได้

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

    1. เปิดโปรเจ็กต์
    2. ขยายลำดับชั้นของแหล่งข้อมูล
    3. เลือกส่วนของแพ็กเกจที่ต้องการเปลี่ยนแปลง กล่าวคือ com.example
    4. คลิกขวาที่แพ็กเกจ แล้วเลือกปรับโครงสร้าง > เปลี่ยนชื่อ... ปรับโครงสร้างใหม่ > เมนูเปลี่ยนชื่อ
    5. ป้อนชื่อใหม่แล้วคลิกจัดระเบียบใหม่
    6. แก้ไขไฟล์ build.gradle.kts โดยเปลี่ยน android namespace และ applicationId เป็นชื่อแพ็กเกจใหม่

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

สร้างใบรับรองการลงนาม

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

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

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

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

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

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

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

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

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

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

ตั้งค่าข้อมูลเข้าสู่ระบบ OAuth

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

เรียกใช้แอป

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

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