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

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

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

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

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

    ดาวน์โหลด Android Studio

  • ดีบักเกอร์ Android (adb)

    ติดตั้ง adb

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

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

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

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

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

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

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

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

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

ตั้งค่า SDK

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

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

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

สร้างแอป

  1. เปิด Android Studio แล้วเปิดโฟลเดอร์โปรเจ็กต์ google-home-api-sample-app-android ที่โคลนลงใน เครื่องของคุณ

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

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

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

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

  5. กำหนดค่าขอบเขต OAuth ใน HomeModule.kt โดยค่าเริ่มต้น ซอร์สโค้ดของแอปตัวอย่างจะใช้ขอบเขต https://www.googleapis.com/auth/home.platform.v2 ฟีเจอร์หลายอย่างในแอปตัวอย่างถูกจำกัดด้วยขอบเขต home.platform.v2 และต้องได้รับการอนุมัติจากพาร์ทเนอร์จึงจะเข้าถึงได้ หากต้องการเรียกใช้แอปตัวอย่างด้วยขอบเขต https://www.googleapis.com/auth/home.platform.selected.devices มาตรฐาน ให้เปิด HomeModule.kt แล้วเปลี่ยน homePlatformScope ใน HomeConfig เป็น HOME_PLATFORM_SCOPE_VERSION_1 ดังนี้

    val homeConfig = HomeConfig(
  coroutineContext = Dispatchers.IO,
  factoryRegistryProvider = {
    FactoryConstants.factoryRegistryAllTraitsAllTypes
  },
  homePlatformScope =
    HomeConfig.HomePlatformScope.HOME_PLATFORM_SCOPE_VERSION_1
)

นอกจากนี้ ให้อัปเดต homePlatformScope เป็น HOME_PLATFORM_SCOPE_VERSION_1 ใน switchAccount() ใน HomeClientProvider.kt ด้วย มิเช่นนั้น การเลือกไอคอนโปรไฟล์เพื่อเปลี่ยนบัญชีจะเปลี่ยนแอปกลับเป็น HOME_PLATFORM_SCOPE_VERSION_2

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

สร้างใบรับรองการลงชื่อ

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

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

    เชื่อมต่ออุปกรณ์เคลื่อนที่กับเครื่องของคุณ 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 คุณควรสร้างคีย์ SHA-1 จากคีย์เริ่มต้นของ Android Studio ตลอดกระบวนการพัฒนา

เรียกใช้แอป

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

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