HomeModule.kt

/* Copyright 2025 Google LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package com.example.googlehomeapisampleapp

import com.google.home.DeviceType
import com.google.home.DeviceTypeFactory
import com.google.home.FactoryRegistry
import com.google.home.HomeClient
import com.google.home.HomeConfig
import com.google.home.Trait
import com.google.home.TraitFactory
import com.google.home.google.AreaAttendanceState
import com.google.home.google.AreaPresenceState
import com.google.home.google.Assistant
import com.google.home.google.AssistantBroadcast
import com.google.home.google.AssistantFulfillment
import com.google.home.google.CameraAvStreamManagement
import com.google.home.google.CameraHistory
import com.google.home.google.Chime
import com.google.home.google.ChimeThemes
import com.google.home.google.ExtendedApplicationLauncher
import com.google.home.google.ExtendedLevelControl
import com.google.home.google.ExtendedMediaInput
import com.google.home.google.ExtendedMediaPlayback
import com.google.home.google.GoogleCameraDevice
import com.google.home.google.GoogleDisplayDevice
import com.google.home.google.GoogleDoorbellDevice
import com.google.home.google.GoogleTVDevice
import com.google.home.google.MediaActivityState
import com.google.home.google.Notification
import com.google.home.google.PushAvStreamTransport
import com.google.home.google.RecordingMode
import com.google.home.google.Time
import com.google.home.google.VoiceStarter
import com.google.home.google.Volume
import com.google.home.google.WebRtcLiveView
import com.google.home.matter.standard.AudioOutput
import com.google.home.matter.standard.BasicInformation
import com.google.home.matter.standard.BooleanState
import com.google.home.matter.standard.ColorTemperatureLightDevice
import com.google.home.matter.standard.ContactSensorDevice
import com.google.home.matter.standard.DimmableLightDevice
import com.google.home.matter.standard.DoorLock
import com.google.home.matter.standard.DoorLockDevice
import com.google.home.matter.standard.ExtendedColorLightDevice
import com.google.home.matter.standard.FanControl
import com.google.home.matter.standard.FanDevice
import com.google.home.matter.standard.GenericSwitchDevice
import com.google.home.matter.standard.LevelControl
import com.google.home.matter.standard.MediaInput
import com.google.home.matter.standard.MediaPlayback
import com.google.home.matter.standard.OccupancySensing
import com.google.home.matter.standard.OccupancySensorDevice
import com.google.home.matter.standard.OnOff
import com.google.home.matter.standard.OnOffLightDevice
import com.google.home.matter.standard.OnOffLightSwitchDevice
import com.google.home.matter.standard.OnOffPluginUnitDevice
import com.google.home.matter.standard.OnOffSensorDevice
import com.google.home.matter.standard.RootNodeDevice
import com.google.home.matter.standard.SpeakerDevice
import com.google.home.matter.standard.TemperatureControl
import com.google.home.matter.standard.TemperatureMeasurement
import com.google.home.matter.standard.TemperatureSensorDevice
import com.google.home.matter.standard.Thermostat
import com.google.home.matter.standard.ThermostatDevice
import com.google.home.matter.standard.WindowCovering
import com.google.home.matter.standard.WindowCoveringDevice
import dagger.Module
import dagger.Provides
import dagger.hilt.InstallIn
import dagger.hilt.components.SingletonComponent
import kotlinx.coroutines.Dispatchers
import javax.inject.Singleton

/**
 * Hilt module for providing dependencies related to the Google Home APIs.
 */
@Module
@InstallIn(SingletonComponent::class)
object HomeModule {

  /**
   * Provides a list of supported device types.
   */
  @Provides
  @Singleton
  fun provideSupportedDeviceTypes(): @JvmSuppressWildcards List<DeviceTypeFactory<out DeviceType>> =
    listOf(
      ColorTemperatureLightDevice,
      ContactSensorDevice,
      DimmableLightDevice,
      DoorLockDevice,
      ExtendedColorLightDevice,
      FanDevice,
      GenericSwitchDevice,
      GoogleCameraDevice,
      GoogleDisplayDevice,
      GoogleDoorbellDevice,
      GoogleTVDevice,
      OccupancySensorDevice,
      OnOffLightDevice,
      OnOffLightSwitchDevice,
      OnOffPluginUnitDevice,
      OnOffSensorDevice,
      RootNodeDevice,
      SpeakerDevice,
      TemperatureSensorDevice,
      ThermostatDevice,
      WindowCoveringDevice,
    )

  /**
   * Provides a list of supported device traits.
   */
  @Provides
  @Singleton
  fun provideSupportedTraits(): @JvmSuppressWildcards List<TraitFactory<out Trait>> = listOf(
      AreaAttendanceState,
      AreaPresenceState,
      Assistant,
      AssistantBroadcast,
      AssistantFulfillment,
      AudioOutput,
      BasicInformation,
      BooleanState,
      CameraAvStreamManagement,
      CameraHistory,
      Chime,
      ChimeThemes,
      DoorLock,
      ExtendedApplicationLauncher,
      ExtendedLevelControl,
      ExtendedMediaInput,
      ExtendedMediaPlayback,
      FanControl,
      LevelControl,
      MediaActivityState,
      MediaInput,
      MediaPlayback,
      Notification,
      OccupancySensing,
      OnOff,
      PushAvStreamTransport,
      RecordingMode,
      TemperatureControl,
      TemperatureMeasurement,
      Thermostat,
      Time,
      Volume,
      VoiceStarter,
      WebRtcLiveView,
      WindowCovering,
  )

  /**
   * Provides the [FactoryRegistry] for the Home SDK.
   *
   * @param types The list of supported device types.
   * @param traits The list of supported device traits.
   */
  @Provides
  @Singleton
  fun provideFactoryRegistry(
    types: @JvmSuppressWildcards List<DeviceTypeFactory<out DeviceType>>,
    traits: @JvmSuppressWildcards List<TraitFactory<out Trait>>,
  ): FactoryRegistry = FactoryRegistry(
    types = types,
    traits = traits
  )

  /**
   * Provides the [HomeConfig] for the Home SDK.
   *
   * @param registry The [FactoryRegistry] for the Home SDK.
   */
  @Provides
  @Singleton
  fun provideHomeConfig(registry: FactoryRegistry): HomeConfig = HomeConfig(
    coroutineContext = Dispatchers.IO,
    factoryRegistry = registry
  )

  /**
   * Provides the [HomeClient] instance.
   *
   * @param homeClientProvider The provider for obtaining a [HomeClient] instance.
   */
  @Provides
  @Singleton
  fun provideHomeClient(
    homeClientProvider: HomeClientProvider,
  ): HomeClient = homeClientProvider.getClient()
}