Beacon Scanner Start Ranging

Kalipso - Form - Actions - Actions Description - Group Communications - Beacon Scanner Start Ranging

Starts Ranging a region to detect the proximity and other detailed information of that region.

Beacons are a class of BLE devices. Kalipso Supports Eddystone and iBeacon. Nomenclature from Eddystone to iBeacon may vary. Please read notes.

Action available for the following operating systems:

Parameters

  • Region Code <string>

  • Beacon Type <numeric>

    • 1 - iBeacon

    • 2 - Eddystone

iBeacon

  • ID1 UUID <String>

  • ID2 Major <numeric>

  • ID3 Minor <numeric>

Eddystone

  • ID1 Namespace ID <String>

  • ID2 Instance ID <String>

  • ID3 Minor <String>

The concept of ranging a region is to receive imediate information about that region, with all the information specified in the call to Beacon Scanner Initialize being returned in a normally high rate of triggered events.

Normally you start by monitoring a region, when when you detect that the region has been entered you can start Ranging for the same region, or for new regions with more specific IDs to get more information about the region/beacons, like distance etc.

A region is an abstract concept that can represent a single beacon or a group of beacons. For example if you specify a Region Code for iBeacon and you fill in only the ID1 (UUID) parameter, all the beacons that have that UUID independently of their major or minor IDs will be considered to belong to that region. But if you specify all 3 IDs (UUID, Major and Minor), then the region will actually only target that specific beacon. The same concept can be applied to Eddystone.

On iOS, for iBeacons you have to specify at lest the UUID, you cannot specify a region that is valid for all beacons.

To range Eddystone beacons that only transmit the URL frame you need to specify a region with empty IDs. This happens because the URL frame does not have Eddystone ID information.

If you call this action with a region code that already existed, that region will be replaced by this one.

Last updated