Rock Mobile Docs

Proximity Attendance

Proximity Attendance lets people automatically check in and out when they enter or leave a location, using small Bluetooth devices called beacons. This removes the need for manual check-ins at events or services.

These beacons use a technology called iBeacon, which broadcasts a small signal that your phone can detect.

How It Works

  1. A beacon continuously broadcasts its iBeacon signal.
  2. A nearby mobile device detects this signal and triggers the app to wake up in the background.
  3. The app then automatically checks the person in or out of the event or service.

This is especially helpful for busy check-in stations or children's ministry check-ins where speed and simplicity matter.

Note

For more on Proximity Attendance, and how to configure it within Rock, see our Proximity Attendance core docs.

Mobile Shell Configuration 

After configuring your Rock instance and physical beacons, use the following commands in your mobile app:

StartBeaconMonitoring

Begins monitoring entry and exit events for the RockInstanceId region. This command guides the user through enabling location permissions so the app can begin monitoring nearby beacons.

Examples

This is a basic example to start the beacon monitoring process.

<Button Text="Start Beacon Monitoring"
    StyleClass="btn, btn-primary"
    Command="{Binding StartBeaconMonitoring}" />

You can also customize the content of the instruction if you wish to do so.

<Button Text="Start Beacon Monitoring"
    StyleClass="btn, btn-primary"
    Command="{Binding StartBeaconMonitoring}">
    <Button.CommandParameter>
        <Rock:StartBeaconMonitoringCommandParameters AllowLocationPermissionTitle="Allow Permission Location">
        </Rock:StartBeaconMonitoringCommandParameters>
    </Button.CommandParameter>
</Button>

Properties

PropertyTypeDescription
AllowLocationPermissionTitlestringThe title on the AllowLocationPermission Page
AllowLocationPermissionSubtitlestringThe subtitle on the AllowLocationPermission Page
AllowLocationPermissionViewViewYour custom view on the AllowLocationPermission Page
OpenSettingsTitlestringThe title on the OpenSettings Page
OpenSettingsSubtitlestringThe subtitle on the OpenSettings Page
OpenSettingsViewViewYour custom view on the OpenSettings Page
SuccessScreenTitlestringThe title on the Success Page
SuccessScreenSubtitlestringThe subtitle on the Success Page
SuccessScreenViewViewYour custom view on the Success Page

StopBeaconMonitoring

Stops all active beacon monitoring. When the app is deleted, it also stops monitoring.

Example

<Button Text="Stop Beacon Monitoring"
    StyleClass="btn, btn-primary"
    Command="{Binding StopBeaconMonitoring}" />

Beacon Debug View 

After setting up a physical beacon, it can be difficult to know if the area has adequate signal coverage. To help with this, we created a Debug View that measures the signal strength of your organization’s beacons. The Beacon View displays all detected beacons broadcasting the UUID that matches your RockInstanceId.

Important

The view will not work unless beacon monitoring has been started. It refreshes every 6 seconds.

<Rock:BeaconRangingDebugView />

We recommend maintaining at least a Yellow signal strength level.

Note

To learn how to configure Beacon Hardware, see the Proximity Attendance core docs.