Khởi chạy trang chủ trên Android

Trước khi sử dụng bất kỳ Home API nào cho Android, bạn phải khởi chạy nhà trong ứng dụng của mình. Trong bước này, bạn sẽ tạo một thực thể singleton của Home cho ngữ cảnh cục bộ.

Mỗi lần, bạn chỉ nên kích hoạt một phiên bản của Home.

Đây là điểm truy cập vào Home API, đồng thời liên quan đến việc khai báo những đặc điểm và loại thiết bị mà bạn dự định sử dụng với Device & Structure và Automation API. Nếu bạn chỉ mới bắt đầu sử dụng hệ sinh thái Google Home và không biết nên đăng ký những đặc điểm hoặc loại thiết bị nào, thì chúng tôi đã đề xuất một số đặc điểm và loại thiết bị phổ biến nhất tại đây trong hướng dẫn này.

Tạo một phiên bản Home

Để bắt đầu, hãy nhập các gói này vào ứng dụng của bạn:

import android.content.Context
import com.google.home.FactoryRegistry
import com.google.home.HomeConfig
import com.google.home.Home

Cách khởi chạy Home API:

Tạo một tham chiếu đến ngữ cảnh Application. Ngữ cảnh này không phụ thuộc vào bất kỳ vòng đời hoạt động nào và sẽ tồn tại miễn là ứng dụng của bạn còn hoạt động. Bạn có thể lấy đối tượng này bằng cách gọi getApplicationContext() trong Activity hoặc Service:
```
val context = getApplicationContext()
```

Tạo một thực thể FactoryRegistry với tất cả các đặc điểm và loại thiết bị mà bạn dự định sử dụng trong ứng dụng của mình.

Trong hướng dẫn này, chúng tôi đã đề xuất một số loại phổ biến (các loại thiết bị Đèn, Ổ cắm, Cảm biến, Công tắc và Máy điều nhiệt, các đặc điểm về sự hiện diện và Trợ lý cho tính năng tự động hoá), phòng trường hợp bạn không chắc chắn về những gì mình cần. Để tìm hiểu thêm, hãy xem phần Đăng ký đặc điểm và loại thiết bị.

val registry = FactoryRegistry(
  traits = listOf(
            AirQuality,
            AreaAttendanceState,
            AreaPresenceState,
            AssistantBroadcast,
            AssistantFulfillment,
            BooleanState,
            ColorControl,
            ExtendedColorControl,
            FlowMeasurement,
            IlluminanceMeasurement,
            LevelControl,
            Notification,
            OccupancySensing,
            OnOff,
            RelativeHumidityMeasurement,
            Switch,
            TemperatureMeasurement,
            Thermostat),
  types = listOf(
            AirQualitySensorDevice,
            ColorDimmerSwitchDevice,
            ColorTemperatureLightDevice,
            ContactSensorDevice,
            DimmableLightDevice,
            DimmablePlugInUnitDevice,
            DimmerSwitchDevice,
            ExtendedColorLightDevice,
            FlowSensorDevice,
            GenericSwitchDevice,
            HumiditySensorDevice,
            LightSensorDevice,
            OccupancySensorDevice,
            OnOffLightDevice,
            OnOffLightSwitchDevice,
            OnOffPluginUnitDevice,
            OnOffSensorDevice,
            SpeakerDevice,
            TemperatureSensorDevice,
            ThermostatDevice))

Bạn phải nhập câu lệnh cho từng đặc điểm và loại thiết bị riêng lẻ đã đăng ký tại đây (Android Studio sẽ nhắc bạn thêm những câu lệnh này).

Tạo một HomeConfig bằng cách sử dụng ngữ cảnh coroutine Dispatchers.IO và phiên bản đăng ký của bạn.

val homeConfig = HomeConfig(
        coroutineContext = Dispatchers.IO,
        factoryRegistry = registry)

Cuối cùng, hãy tạo phiên bản singleton của Home (đây là điểm truy cập vào các API) bằng cách sử dụng ngữ cảnh và HomeConfig.
```
val homeManager: HomeClient = Home.getClient(context, homeConfig)
```

Để tránh lỗi với các phiên không hợp lệ, điều quan trọng là chỉ tạo một thực thể singleton của Home bằng cách gói thực thể đó trong một khai báo đối tượng.

Ví dụ: Ứng dụng mẫu thực hiện theo cách này:

internal object HomeClientModule {
  @Provides
  @Singleton
  fun provideHomeClient(@ApplicationContext context: Context): HomeClient {
    return Home.getClient(
      context,
      HomeConfig(
        coroutineContext = IODispatcherModule.provideIoDispatcher(),
        factoryRegistry = registry,
      ),
    )
  }
}

Tính năng đăng nhập bằng Google do ứng dụng khởi tạo

Bạn có thể muốn quản lý các hoạt động xác thực của người dùng bằng Google trong ứng dụng của mình. Việc này cho phép bạn sử dụng cùng một tài khoản người dùng trên nhiều dịch vụ của Google, chẳng hạn như Google Home, Drive, Maps, v.v.

Với tính năng đăng nhập bằng Google do ứng dụng khởi tạo, bạn có thể nhận được một phiên bản HomeClient được liên kết rõ ràng với một người dùng cụ thể, nhờ đó bỏ qua trình chọn Tài khoản Google và màn hình đồng ý khi tài khoản đã được uỷ quyền.

Ngoài ra, phương pháp này giúp người dùng không thấy hai màn hình chọn tài khoản riêng biệt – một màn hình từ quy trình đăng nhập của ứng dụng và một màn hình từ Google Home.

Để làm việc này, bạn phải tham khảo bài viết Xác thực người dùng bằng tính năng Đăng nhập bằng Google và hoàn tất các bước sau:

Tạo mã ứng dụng khách của ứng dụng web OAuth

Mở Google Cloud Console
- Chuyển đến trang Thông tin đăng nhập của Google Cloud Console.
- Chọn một dự án hiện có hoặc tạo một dự án mới.
Định cấu hình Màn hình đồng ý OAuth (nếu bạn chưa làm)
- Trước khi tạo thông tin đăng nhập, hãy đảm bảo rằng màn hình đồng ý OAuth được định cấu hình bằng thông tin chi tiết về ứng dụng của bạn, bao gồm cả URL chính sách quyền riêng tư và điều khoản dịch vụ.
Tạo mã ứng dụng OAuth (loại Ứng dụng web)
- Trên trang Thông tin xác thực, hãy nhấp vào + CREATE CREDENTIALS rồi chọn Mã ứng dụng khách OAuth trong trình đơn thả xuống.
- Đối với Loại ứng dụng, hãy chọn Ứng dụng web.
- Nhập tên cho ứng dụng web của bạn (ví dụ: "My App Web Backend" (Phần phụ trợ web của ứng dụng của tôi).
- Nhấp vào Tạo.
Truy xuất mã ứng dụng khách
- Sau khi tạo, bảng điều khiển sẽ hiển thị Mã ứng dụng mới của bạn. Đây là giá trị bạn sẽ sử dụng trong ứng dụng Android của mình (ví dụ: "{project number}-.....apps.googleusercontent.com")
- Bạn nên lưu trữ Mã nhận dạng máy khách bên ngoài (ví dụ: trong build.gradle) thay vì mã hoá cứng trực tiếp

Tạo thực thể cho yêu cầu Đăng nhập bằng Google

Sử dụng mã nhận dạng ứng dụng web để tạo yêu cầu đăng nhập bằng Google:

// Your Google Cloud console Web Client ID for Google Sign-In
val serverClientId = BuildConfig.DEFAULT_WEB_CLIENT_ID

// Build the request for Google ID token
val googleIdOption = GetGoogleIdOption.Builder()
    .setFilterByAuthorizedAccounts(false) // Show all Google Accounts on the device
    .setServerClientId(serverClientId) // embed WebClientID in token
    .build()

// Build the GetCredentialRequest
val request = GetCredentialRequest.Builder().addCredentialOption(googleIdOption).build()

Tạo quy trình Đăng nhập bằng Google

Để triển khai quy trình đăng nhập, hãy dùng CredentialManager để thực thi một yêu cầu Sign in with Google. Sau khi người dùng chọn một tài khoản, hãy trích xuất email của họ từ Mã thông báo nhận dạng của Google thu được để tạo một android.accounts.Account. Sau đó, tài khoản này được dùng để khởi chạy một phiên bản HomeClient được liên kết cụ thể với người dùng đã đăng nhập đó.

  try {
    // CredentialManager is responsible for interacting with various credential providers on the device
    val credentialManager = CredentialManager.create(context)
    // Credential returns when user has selected an account and the getCredential call completes
    val result = credentialManager.getCredential(context = context, request = request)
    val credential = result.credential

    if (
      credential is CustomCredential &&
      credential.type == GoogleIdTokenCredential.TYPE_GOOGLE_ID_TOKEN_CREDENTIAL
    ) {
      try {
        val googleCredential = GoogleIdTokenCredential.createFrom(credential.data)
        googleCredential.id.let { userEmail ->
          Log.i(TAG, "Email found in Google ID Token: $email")
          /*
           Why "com.google"?
           The string "com.google" is a standard identifier used in Android's android.accounts.
           Account system to represent accounts managed by Google. This is often used when
           interacting with Android's Account Manager or when using Google-specific APIs. So,
           even if the email ends in "@gmail.com", the underlying account type or provider is
           still considered "com.google" within the Android system.
          */
          val account = Account(userEmail, "com.google")
          Log.d(TAG,"Switched account to : $userEmail")
          // Get the new Home Client Instance with the userEmail
        }
        Log.i(TAG, "Account switch complete. Emitting navigation event.")
      } catch (e: Exception) {
        Log.e(TAG,"Could not convert CustomCredential to Google ID Token", e)
      }
    }
  } catch (e: Exception) {
    Log.e(TAG, "Google Sign-In failed with unexpected error", e)
  }

Lấy một phiên bản HomeClient mới

Làm theo các bước tương tự như trong phần Tạo một thực thể Home, nhưng thay vì gọi Home.getClient(context, homeConfig) ở Bước 4, hãy gọi Home.getClient(context, userAccount, homeConfig), trong đó tham số thứ hai là Lazy<UserAccount>. Thao tác này sẽ trả về một phiên bản của HomeClientWithProvidedAccount, một lớp con của HomeClient, được liên kết rõ ràng với Tài khoản Google đã chỉ định:

val client =
     Home.getClient(
       context = context.applicationContext,
       account =
         lazy {
         // 1. Create the Account object.
           val androidAccount = Account(userEmail,
                                        GoogleAuthUtil.GOOGLE_ACCOUNT_TYPE)
         // 2. Wrap it in UserAccount.GoogleAccount.
           UserAccount.GoogleAccount(androidAccount)
         },
       homeConfig = HomeConfig()
     )

Nếu người dùng được chỉ định không được uỷ quyền, hãy nhắc người dùng cấp quyền bằng cách gọi các phương thức sau trên thực thể HomeClientWithProvidedAccount:

registerActivityResultCallerForPermissions() có một tham chiếu đến ActivityResultCaller mà bạn muốn sử dụng.
requestPermissions(). Thao tác này sẽ mở ra màn hình Đồng ý của GHP, nơi người dùng có thể cấp quyền của họ.

Bạn có thể tạo một HomeClient bằng UserAccount rồi gọi requestPermissions() bằng forceLaunch==true để khởi chạy lại màn hình đồng ý nhằm cho phép người dùng cập nhật các quyền mà họ đã cấp:

val client =
     Home.getClient(
       context = context.applicationContext,
       account =
         lazy {
              UserAccount.GoogleAccount(androidAccount)
         },
       homeConfig = HomeConfig()
     )

client.registerActivityResultCallerForPermissions(this)
client.requestPermissions(forceLaunch= true)

Hãy xem Permissions API để biết thêm thông tin về cách quản lý quyền đối với Home API.

Làm mới toàn bộ hoạt động bằng HomeClient mới

Sau khi có một phiên bản HomeClient mới, bạn phải làm mới toàn bộ hoạt động để đăng ký lại và tìm nạp cấu trúc, thiết bị hoàn chỉnh cũng như các dữ liệu liên quan khác được liên kết với tài khoản người dùng này.

Đăng ký các trait và loại thiết bị

Lớp FactoryRegistry giúp nhà phát triển tối ưu hoá kích thước nhị phân của ứng dụng bằng cách cho phép họ chỉ rõ những đặc điểm và loại thiết bị mà ứng dụng của họ sử dụng.

Xin lưu ý rằng các quyền và sổ đăng ký gốc được tách rời. Do đó, các đặc điểm và loại chưa đăng ký mà ứng dụng của bạn có thể sử dụng bằng quyền nhưng không có trong sổ đăng ký của nhà máy sẽ không thể truy cập bằng Automation API và cũng không được trả về trong các lệnh gọi phương thức traits() hoặc types() hàng loạt.

2. Thiết lập OAuth

Tiếp

4. API Quyền

Khởi chạy trang chủ trên Android Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.