iBeacon Advertising Settings
iBeacon is a Bluetooth advertising protocol designed by Apple, with native support in iPadOS. Kiosk Pro's iBeacon integration allows you to create a location-aware interactive presentation.
In this article
You can also advertise your device as an iBeacon while displaying content for visitor use. This makes it possible for the app to support contextual, location-aware experiences through another app on a visitor’s personal device or through Kiosk Pro on another iPad without requiring additional iBeacon hardware.
Advertise
Supported in:
Advertising uses Bluetooth, which can affect the device’s power usage and battery life. This setting allows you to choose when to advertise the device.
To successfully advertise a device as an iBeacon, a UUID, Major Value and Minor Value must all be defined.
Default Value:
- Never
Other Possible Values:
- Always
- On JavaScript API Call
The JavaScript calls required to advertise after an API call are included in our iBeacon Advertising API documentation.
Values for Remote Settings Control & Managed App Configuration
Key | kp_ibeaconAdvertiseMode |
---|---|
Key Type | integer |
Default Value | 2 |
Possible Values |
|
UUID
Supported in:
To successfully advertise a device as an iBeacon, a UUID (Universally Unique Identifier) must be defined.
The UUID must contain 32 hexadecimal digits, split into 5 groups, separated by hyphens.
Default Value: C9CA99FB-69AF-4AE1-B72C-3E5A95E349D3
If you’d prefer not to use this default, the UUID can be edited, but the format of the new UUID must be validated prior to use, which can be done by selecting this setting and then tapping the ‘Validate UUID’ button in the bottom navigation.
The app can also generate a new, valid UUID by tapping the ‘Generate UUID’ button in the bottom navigation.
In most cases, we recommend using a shared UUID for all beacons in your project and then monitoring based on the Major and/or Minor values.
Values for Remote Settings Control & Managed App Configuration
Key | kp_ibeaconAdvertiseUUID |
---|---|
Key Type | string |
Default Value | C9CA99FB-69AF-4AE1-B72C-3E5A95E349D3 |
Major Value
Supported in:
To successfully advertise a device as an iBeacon, a major value must be defined.
Default Value: 1
The Major Value gives you an additional identifier for an iBeacon and use case. For example, this could define a subregion within a larger region defined by the UUID.
This value must be number from 1 - 65,535.
Values for Remote Settings Control & Managed App Configuration
Key | kp_ibeaconAdvertiseMajorValue |
---|---|
Key Type | string |
Default Value | 1 |
Minor Value
Supported in:
To successfully advertise a device as an iBeacon, a Minor Value must be defined.
Default Value: 1
The Minor Value gives you a third identifier for an iBeacon and use case. For example, this could define a subregion within a larger region defined by the Major Value.
This value must be number from 1 - 65,535.
Values for Remote Settings Control & Managed App Configuration
Key | kp_ibeaconAdvertiseMinorValue |
---|---|
Key Type | string |
Default Value | 1 |
Identifier
Supported in:
This field is optional and can be used in certain scenarios as a human-readable identifier that could be used by a visitor to identify a beacon.
This identifier is not supported when using the iBeacon Navigation integration to detect the app advertising on another device.
Values for Remote Settings Control & Managed App Configuration
Key | kp_ibeaconAdvertiseIdentifier |
---|---|
Key Type | string |
Default Value | (blank) |
Change Log
Added in 8.5 version.