iOS örnek uygulamasını derleme

Bu örnek iOS uygulaması, Google Home API'lerini kullanır. Uygulamayı ilk kez oluşturup çalıştırmak için bu kılavuzu kullanın.

Ön koşullar

iOS için Home API'lerini kullanmak üzere minimum gereksinimleri karşıladığınızdan emin olun.

Örnek uygulamayı oluşturup yüklemek için Xcode 15.3 veya sonraki bir sürümün yüklü olduğu bir bilgisayar gerekir.

Xcode'u indirin

Uygulamayı test etmek için gerekenler:

  1. Bir Google Hesabı.
  2. Fiziksel cihaz yapılandırma dosyaları oluşturmak için Apple Developer Programı'na kayıtlı bir Apple Kimliği. Henüz oluşturulmadıysa kayıt için ek ücret alınır ve kayıt işleminin tamamlanması 48 saati bulabilir.
  3. Test hesabı ile ayarlanmış iOS 16.4 veya sonraki bir sürümün yüklü olduğu bir iOS cihaz (simülatör değil).
  4. Kablosuz ağ
  5. Home API'lerini destekleyen bir Google hub'ı.
  6. Cihazınız Thread gerektiriyorsa ve hub'ınız bu özelliği desteklemiyorsa Thread sınır yönlendirici.
  7. En az bir desteklenen cihaz türü.

Geliştirme için aşağıdaki koşulları karşılayan bir Mac'e ihtiyacınız vardır:

  • macOS Sonoma veya sonraki sürümler
  • Xcode 15.3 veya sonraki sürümler

Apple dağıtım yapılandırma dosyaları oluşturma

Öncelikle, bir uygulamanın App Attest özelliğinin etkinleştirilmesini gerektirdiğini belirtmek isteriz. Bu nedenle, simülatör cihazlara dağıtılamaz. Bunun için App Attest yetkisine sahip bir temel hazırlık profili oluşturmanız gerekir.

Kullanıcıları kademeli olarak dahil etme başlıklı makaleyi inceleyin.

İkincisi, uygulama ile MatterExtension arasında iletişim kurulabilmesi için uygulama gruplarının etkinleştirilmesi gerekir. Bunun için bir uygulama grubu tanımlayıcısı kaydetmeniz gerekir.

Daha fazla bilgi için Apple'ın Geliştirme için sağlama profili oluşturma başlıklı makalesini inceleyin.

Bir uygulamayı dağıtmak için gereken minimum adımlar aşağıda özetlenmiştir:

  1. MatterExtension ile iletişim kurmak için uygulamanız için bir uygulama grubu tanımlayıcısı oluşturun.
    1. Apple Developer Portal'da oturum açın.
    2. Uygulama grubu tanımlayıcısı ekleyin. Örneğin, group.com.company.commissioning olarak biçimlendirilebilir.
  2. Test cihazınızı geliştirici hesabına kaydedin.

  3. Uygulama hedefiniz için bir profil oluşturun.

    1. Uygulamanız için bir uygulama paketi tanımlayıcısı belirleyin. Tanımlayıcı benzersiz ve açıklayıcı olmalıdır. Örneğin, com.company.HomeApiSample olarak biçimlendirilebilir. Bu tanımlayıcı, bu bölümün geri kalanında kullanılacaktır.
    2. Uygulama kimliğinizi kaydettirin. İstendiğinde App Attest ve App Groups özelliğini ekleyin.

    3. Yeni oluşturulan uygulama kimliğini düzenleyin ve kayıtlı uygulama grubu tanımlayıcısını eklemek için Uygulama Grupları özelliğini yapılandırın.

    4. Uygulama geliştirme için geliştirme temel hazırlık profili oluşturun. Yeni oluşturduğunuz uygulama kimliğinizle ve seçtiğiniz test cihazlarıyla ilişkilendirin. Uygulamayı imzalamak için geliştirici sertifikanızın olduğundan emin olun.

  4. MatterExtension hedefiniz için bir profil oluşturun.

    1. MatterExtension için bir uygulama paketi tanımlayıcısı seçin. Tanımlayıcı, uygulama tanımlayıcısından devralınmalıdır. Örneğin, com.company.HomeApiSample.MatterExtension olarak biçimlendirilebilir.
    2. Uygulama kimliğinizi kaydettirin. İstendiğinde Uygulama Grubu özelliğini ekleyin.
    3. Yeni oluşturulan uygulama kimliğini düzenleyin ve önceki adımlarda oluşturulan kayıtlı uygulama grubu tanımlayıcısını eklemek için Uygulama Grupları özelliğini yapılandırın.
    4. MatterExtension için geliştirme temel hazırlık profili oluşturun.

OAuth istemci kimliğini oluşturma ve Ev API'lerini etkinleştirme

Uygulamanızın Google'ın kimlik doğrulama arka ucuna kendisini tanıtması için bir OAuth istemci kimliğine ihtiyacı vardır. iOS ve uygulamalar için OAuth istemci kimliği uygulama türü iOS olarak yapılandırılmalıdır. Uygulama, Home API'ye de çağrı yapar. Bu işlevin etkinleştirilmesi için API'nin Google Cloud projesinde etkinleştirilmesi gerekir.

OAuth istemci kimliğini oluşturma

  1. Google Cloud Console'da proje seçici kontrol paneline gidin ve OAuth kimlik bilgileri oluşturmak için kullanmak istediğiniz projeyi seçin.
  2. Sol üstteki menü düğmesini > Tüm Ürünleri Göster > API'ler ve Hizmetler'i tıklayarak API'ler ve Hizmetler sayfasına gidin.
  3. Gezinme menüsünde Kimlik bilgileri'ni tıklayın.

  4. Bu Google Cloud projesi için izin ekranınızı henüz yapılandırmadıysanız İzin ekranını yapılandır düğmesi görünür. Bu durumda, aşağıdaki prosedürü kullanarak izin ekranınızı yapılandırın. OAuth izin ekranınız zaten yapılandırılmışsa ve yayınlama durumu Test ise kullanacağınız test hesaplarının Test kullanıcıları grubuna eklendiğinden emin olun. Aksi durumda bir sonraki adıma geçin.

    1. Kullanım alanınıza bağlı olarak Dahili veya Harici'yi seçin ve Oluştur'u tıklayın. OAuth izin ekranı bölmesi gösterilir.
    2. Uygulama bilgileri sayfasında ekrandaki talimatlara göre bilgileri girin ve Kaydet ve devam et'i tıklayın. Kapsamlar bölmesi gösterilir.
    3. Kapsam eklemeniz gerekmez. Bu nedenle Kaydet ve devam et'i tıklayın. Test kullanıcıları bölmesi gösterilir.
    4. Dahili izin ekranı oluşturmayı seçtiyseniz uygulamanıza erişimi test etmek için kullanıcı eklemeniz gerekir. Kullanıcı ekle'yi tıklayın. Kullanıcı ekle bölmesi gösterilir. Test kullanıcıları, uygulamanızda izin verme ayrıcalığına sahiptir. Boş alana bir veya daha fazla Google Hesabı e-posta adresi ekleyin ve Ekle'yi tıklayın.
    5. Kaydet ve devam et'i tıklayın. Özet bölmesi gösterilir.
    6. OAuth kullanıcı rızası ekranı bilgilerinizi inceleyin ve Kontrol paneline geri dön'ü tıklayın.

  5. OAuth istemci kimliğinizi oluşturmak için sol menü panelinde Kimlik bilgileri'ni tıklayın.

    OAuth ekranını ayarlama

    1. KİMLİK BİLGİSİ OLUŞTUR düğmesini tıklayın ve OAuth istemci kimliği'ni seçin.
      1. Uygulama türü bölümünde iOS'i seçin.
    2. Uygulama tanımlayıcınız ve Apple Developer Team ID ile Bundle ID'yi girin. Diğer alanlar isteğe bağlıdır ve boş bırakılabilir.
    3. OLUŞTUR'u tıklayın ve oluşturulan istemci kimliğini not alın veya PLIST'İ İNDİR'i tıklayın. Bu, daha sonra izin akışı işlevini etkinleştirmek için kullanılacaktır. Daha fazla bilgi için Yetkilendirme kimlik bilgileri oluşturma bölümüne bakın.

Ev API'lerini etkinleştirme

Home API'lerine erişimi etkinleştirin.

  1. API'ler ve Hizmetler sekmesinde Etkin API'ler ve Hizmetler'i tıklayın.
  2. Sayfanın üst kısmındaki API'LERİ VE HİZMETLERİ ETKİNLEŞTİR'i tıklayın.
  3. HOME API simgesini arayıp seçin.
  4. Home API ayrıntılar sayfasında ETKİNLEŞTİR'i tıklayın.

Kaynak kodunu indirme

Örnek uygulamanın kaynak kodu GitHub'da mevcuttur.

Projeyi kaydetmek istediğiniz yere gidin ve projeyi klonlayın:

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

Projeyi Xcode'a yüklemek için File (Dosya) > Open'ı (Aç) tıklayın ve klonlanan deponun kök dizininde GoogleHomeAPISampleIOS.xcodeproj'ı seçin.

SDK'yı ayarlama

Örnek uygulama projesinin oluşturulması için bazı ek bilgiler gerekir. Buna, SDK Framework dosyalarını yerel olarak ekleme, geliştirici hesabı tanımlayıcı bilgilerinizi ve OAuth istemci kimliğinizi doldurma dahildir.

Uygulamayı oluşturma

Home API'leri iOS SDK'sını indirmek için öncelikle Google Home Developers'a giriş yapmanız gerekir.

Hemen oturum açın!

Örnek uygulama için Xcode projenizi yapılandırın:

  1. Proje yapılandırmasını düzenlemek için Xcode gezinme bölmesinde GoogleHomeAPISampleIOS dosyasını seçin.

    SDK örnek uygulamasını ayarlama

  2. En üstteki Genel sekmesini tıklayın ve sol tarafta hedefi seçin GoogleHomeAPISampleIOS.

  3. Framework'ler, Kitaplıklar ve Yerleştirilmiş İçerik bölümünü görene kadar aşağı kaydırın. İki Home API Framework'ü listelenmiş olarak görmelisiniz.

  4. Yerleştir sütununda, GoogleHomeSDK.xcframework için Yerleştir ve İmzala'yı seçin. Diğer çerçeve GoogleHomeTypes.xcframework, Yerleştirme olarak bırakılmalıdır.

  5. Listenin alt kısmındaki + simgesini tıklayın.

  6. İstendiğinde SafariServices.framework ifadesini arayın ve ekle'yi tıklayın. Bu giriş için Yerleştir sütununun Yerleştirme olarak ayarlandığından emin olun.

    Yerleştirme ve imzalama

  7. Hedefini düzenlemek için Hedef bölümündeki MatterAddDeviceExtension simgesini tıklayın.

  8. Frameworks and Libraries (Çerçeveler ve Kitaplıklar) bölümünü görene kadar aşağı kaydırın. GoogleHomeSDK.xcframework listelenmiş olmalıdır.

  9. Yerleştir sütununda Yerleştirme'yi seçin.

  10. Geliştirici ve OAuth istemci kimliklerini yapılandırın:

    1. Gezinme bölmesinde GoogleHomeAPISampleIOS klasörünü bulun ve düzenlemek için Info.plist dosyasını açın.

  11. Info.plist dosyasında, GIDClientID'yi OAuth istemci kimliğinizle (OAuth izni ayarlama bölümüne bakın), bulut projenize karşılık gelen Cloud Project Number ile ve GIDTeamID'yi OAuth kayıt işlemi sırasında kullanılan geliştirici hesabının Apple Developer Team ID'siyle doldurun.

  12. Uygulama Onaylama Özelliği Ekleme:

    1. Proje yapılandırmasını düzenlemek için Xcode gezinme bölmesinde GoogleHomeAPISampleIOS proje dosyasını seçin.
    2. En üstteki İmzalama ve Özellikler sekmesini tıklayın ve HEDEFLER bölümünün altındaki sol tarafta hedef GoogleHomeAPISampleIOS'i seçin.
    3. İmzalama ve Özellikler sekmesinin hemen altında + Özellik'i tıklayın ve App Attest'i arayın.
    4. Eklemek için App Attest'i tıklayın. Bu özellik aramada yoksa proje tarafından eklenmiş olabilir.

  13. Uygulama Grupları özelliğini ekleyin.

    Uygulama grupları ekleme

    1. GoogleHomeAPISampleIOS projesi > GoogleHomeAPISampleIOS hedefi'ne gidin.
    2. İmzalama ve Özellikler > + Özellik'i tıklayın.
    3. Uygulama Grupları özelliğini seçin.
    4. Uygulama Grupları bölümünde + simgesini tıklayın ve Apple Developer Portal'da eklediğiniz uygulamanızın uygulama grubu tanımlayıcısını ekleyin.
    5. MatterAddDeviceExtension hedefi için bu adımları tekrarlayarak hedefi Uygulama Grupları'na ekleyin.

  14. Paket kimliğini güncelleme

    1. Örnek uygulamayı geliştirici sertifikalarınızı ve sağlama profillerinizi kullanarak donanımda başarıyla çalıştırmak ve dağıtmak için benzersiz bir paket tanımlayıcı sağlamanız gerekir. Bu, OAuth istemci kimlik bilgilerinizle (yukarıya bakın) ilişkilendirilmiş tanımlayıcıyla aynı olmalıdır.
    2. Proje yapılandırmasını düzenlemek için Xcode gezinme bölmesinde GoogleHomeAPISampleIOS proje dosyasını seçin.
    3. En üstteki İmzalama ve Özellikler sekmesini tıklayın ve HEDEFLER bölümünün altındaki sol tarafta hedef GoogleHomeAPISampleIOS'i seçin.
    4. İmzalama bölümünde Paket Tanımlayıcısı alanını seçin ve uygulamanın benzersiz tanımlayıcısını girin.
    5. Gerekli yetkilendirmeleri içeren bu pakete ilişkin sağlama profilini seçin veya yükleyin.
    6. MatterAddDeviceExtension hedefi için bu adımları tekrarlayarak uzantının paket tanımlayıcısını girin ve kayıtlı sağlama profilini içe aktarın.

  15. Kayıtlı uygulama grubu tanımlayıcısını kodda güncelleyin.

    1. Uygulamanın, cihaz devreye alma gibi özellikler için uygulama grubu tanımlayıcısından yararlanmak üzere SDK örneğini yapılandırması gerekir. HOME_API_TODO_ADD_APP_GROUP dizesini arayarak ve her örneği bu dizeyle değiştirerek uygulamayı Apple Developer Portal'da kayıtlı uygulama grubu kimliğini kullanacak şekilde güncelleyin.

    Bu yapılandırmalar aşağıdaki dosyalarda yapılır:

    • GoogleHomeAPISampleIOS.swift SDK başlatıldığında
    • RequestHandler.swift
    • CommissioningManager.swift