Zanim użyjesz dowolnego interfejsu API Home, musisz zainicjować urządzenie domowe w aplikacji. Na tym etapie utwórz instancję singletonaHome
dla kontekstu lokalnego.
W danym momencie powinno być aktywne tylko jedno wystąpienie Home
.
Jest to punkt wejścia do interfejsów Home API. Polega ono na zadeklarowaniu, których atrybutów i typów urządzeń zamierzasz używać w interfejsach Device & Structure API oraz Automation API. Jeśli dopiero zaczynasz korzystać z ekosystemu Google Home i nie wiesz, jakie cechy lub typy urządzeń zarejestrować, w tym przewodniku znajdziesz kilka najpopularniejszych.
Tworzenie instancji domowej
Na początek zaimportuj do aplikacji te pakiety:
import android.content.Context
import com.google.home.FactoryRegistry
import com.google.home.HomeConfig
import com.google.home.Home
Aby zainicjować interfejsy Home API:
Pobierz odniesienie do kontekstu
Application
. Ten kontekst nie zależy od cyklu aktywności i będzie aktywny tak długo, jak aplikacja będzie działać. Możesz go uzyskać, dzwoniąc pod numerContext.getApplicationContext()
lubActivity.getApplication()
.val context = Context.getApplicationContext()
Utwórz instancję
FactoryRegistry
ze wszystkimi cechami i typami urządzeń, których chcesz używać w aplikacji.W tym przewodniku sugerujemy kilka typowych (oświetlenie, gniazdko, czujnik, przełącznik i termostat, cechy obecności i Asystenta do automatyzacji), jeśli nie masz pewności, czego potrzebujesz. Więcej informacji znajdziesz w artykule Rejestracja cech i typów urządzeń.
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))
Wymagany jest import instrukcji dotyczących każdego zarejestrowanego tutaj atrybutu i typu urządzenia (Android Studio powinien wyświetlić odpowiedni komunikat).
Utwórz instancję
HomeConfig
, używając kontekstuDispatchers.IO
coroutine i instancji rejestru.val homeConfig = HomeConfig( coroutineContext = Dispatchers.IO, factoryRegistry = registry)
Na koniec utwórz instancję singletona
Home
, która jest punktem wejścia do interfejsów API. Użyj do tego kontekstu i elementuHomeConfig
.val homeManager: HomeClient = Home.getClient(context, homeConfig)
Aby uniknąć błędów związanych z nieprawidłowymi sesjami, należy utworzyć tylko instancję pojedynczą obiektu Home
, otaczając ją deklaracją obiektu.
Na przykład aplikacja przykładowa robi to w ten sposób:
internal object HomeClientModule {
@Provides
@Singleton
fun provideHomeClient(@ApplicationContext context: Context): HomeClient {
return Home.getClient(
context,
HomeConfig(
coroutineContext = IODispatcherModule.provideIoDispatcher(),
factoryRegistry = registry,
),
)
}
}
Rejestrowanie cech i typów urządzeń
Klasa FactoryRegistry
pomaga deweloperom optymalizować rozmiar binarny aplikacji, umożliwiając im wyraźne wskazanie, które cechy i typy urządzeń są używane przez aplikację.
Uprawnienia i rejestr fabryczny są rozdzielone. Dlatego niezarejestrowane cechy i typy, które są dostępne dla aplikacji za pomocą uprawnień, ale nie są uwzględnione w rejestrze fabrycznym, są niedostępne za pomocą interfejsu Automation API. Nie są też zwracane w wywołaniach metody traits()
ani types()
.