Developer Docs - Mobile Docs - Proximity Attendance
M v7.0C v17.1
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
This is especially helpful for busy check-in stations or children's ministry check-ins where speed and simplicity matter.
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.
You can also customize the content of the instruction if you wish to do so.
Properties
StopBeaconMonitoring
Stops all active beacon monitoring. When the app is deleted, it also stops monitoring.
Example
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.
The view will not work unless beacon monitoring has been started. It refreshes every 6 seconds.
We recommend maintaining at least a Yellow signal strength level.
To learn how to configure Beacon Hardware, see the Proximity Attendance core docs.
Merge Field
You can use a merge field to verify whether Proximity Attendance is configured correctly.