Skip to main content

Host App Setup

Here you will learn what the Host App needs to configure for the Group Link SDK to work correctly.

Note: iOS only reads these settings from the app, so they cannot come from inside your SDK or the Group Link SDK.

Step 1 - Editing the Info.plist file with the Xcode visual editor​

All the Host App permissions are listed in the Custom iOS Target Properties section of the Info.plist.

  1. Select the Host App TARGET in TARGETS.
  2. Go to the Info tab.

IMG-14 — Host App Info tab

Host App Info tab in Xcode

Step 2 - Adding permissions​

Note: The description messages are shown when the Host App asks the user for permission to use a service. Make sure to add a message that is meaningful to your users.

Enable Location Services​

To get beacon ranging results, the Group Link One technology requires Always location authorization. When implementing location services in the Host App, Apple requires the following keys to be added to the Info.plist file:

  • NSLocationWhenInUseUsageDescription
  • NSLocationAlwaysAndWhenInUseUsageDescription

Description Example: Location helps ensure more accurate readings and correct alerts about water consumption. This allows the app to deliver your home consumption data.

IMG-15 — Location permissions setup in the Host App

Location permissions setup in the Host App

Enable Bluetooth Services​

Since iOS 13, apps are required to add the Bluetooth permission key to the Info.plist file.

  • NSBluetoothAlwaysUsageDescription

Description Example: To ensure the quality of the consumption readings, the app needs to access Bluetooth, which helps collect the data more accurately.

IMG-16 — Bluetooth permission setup in the Host App

Bluetooth permission setup in the Host App

[OPTIONAL] - Apps compatible with iOS 12 and below​

If the Host App can run on older iOS versions (iOS 12 and below), you will need to add the following key to your Info.plist file:

  • NSBluetoothPeripheralUsageDescription

Description Example: To ensure the quality of the consumption readings, the app needs to access Bluetooth, which helps collect the data more accurately.

IMG-17 — Bluetooth Peripheral permission setup in the Host App

Bluetooth Peripheral permission setup in the Host App

Enable the Background Tasks Feature​

To enable background tasks in the Host App, you need to add the following key to your Info.plist file:

  • BGTaskSchedulerPermittedIdentifiers

Open the created key, Permitted background task scheduler identifiers, and add the Group Link SDK identifier:

com.grouplinknetwork.bgtask

IMG-18 — Background tasks permission setup in the Host App

Background tasks permission setup in the Host App

Step 3 - Signing Permissions and Capabilities​

  1. Select the Host App TARGET in TARGETS.
  2. Go to the Signing & Capabilities tab.
  3. Click the + Capability button to add the following capabilities:

IMG-19 — Signing Capabilities in the Host App

Signing Capabilities in the Host App

Enable Access to Wi-Fi Information​

The Host App must be able to access the Wi-Fi network information for the Group Link One technology to work correctly. To do so, you must add the following capability:

  • Access Wi-Fi Information

IMG-20 — Access Wi-Fi Information capability in the Host App

Access Wi-Fi Information capability in the Host App

Enable the Required Background Modes​

The Host App must be able to run in the background for the Group Link One technology to work correctly. To do so, you must add the following capability:

  • Background Modes

IMG-21 — Background Modes capability in the Host App

Background Modes capability in the Host App

Select the following authorizations in the list:

  1. Acts as a Bluetooth LE accessory
  2. Background fetch
  3. Background processing
  4. Location updates
  5. Uses Bluetooth LE accessories

IMG-22 — Background Modes authorizations in the Host App

Background Modes authorizations in the Host App