Access granular ambient, motion, biometric, and interaction sensor streams for approved research and clinical studies using SRSensorReader. Targets Swift 6.3 / iOS 26+.
Entitlement Warning: SensorKit requires Apple entitlement approval (
com.apple.developer.sensorkit.reader.allow). SensorKit cannot be tested on standard consumer apps or simulators without approved research provisioning.
Contents
- Setup & Entitlements
- Sensor Reader Lifecycle
- Fetching Sensor Data
- Available Sensor Categories
- Data Deletion & User Privacy
- Common Mistakes
- Review Checklist
- References
Setup & Entitlements
- Obtain the research entitlement
com.apple.developer.sensorkit.reader.allowfrom Apple. - Add sensor usage descriptions to Info.plist corresponding to each queried sensor (e.g.
NSSensorKitUsageDescription,NSSensorKitUsageDescriptionAmbientLightSensor). - Request authorization explicitly before instantiating readers:
import SensorKit
func requestSensorAccess(for sensors: Set<SRSensor>) async {
let status = await SRSensorReader.requestAuthorization(for: sensors)
// Handle authorization response
}
Sensor Reader Lifecycle
Create an SRSensorReader per sensor type and assign an SRSensorReaderDelegate:
final class AmbientLightCollector: NSObject, SRSensorReaderDelegate {
private let reader = SRSensorReader(sensor: .ambientLightSensor)
override init() {
super.init()
reader.delegate = self
}
func start() {
guard reader.authorizationStatus == .authorized else { return }
reader.startRecording()
}
func stop() {
reader.stopRecording()
}
}
Fetching Sensor Data
Query historical recorded samples by date interval:
func fetchSamples(from start: SRAbsoluteTime, to end: SRAbsoluteTime) {
let request = SRFetchRequest()
request.from = start
request.to = end
reader.fetch(request)
}
// SRSensorReaderDelegate
func sensorReader(_ reader: SRSensorReader, fetching request: SRFetchRequest, didFetchResult result: SRFetchResult) -> Bool {
if let sample = result.sample as? SRAmbientLightSample {
// Process sensor sample
}
return true // Return true to continue fetching remaining results
}
func sensorReader(_ reader: SRSensorReader, didCompleteFetch request: SRFetchRequest) {
// Finished fetch
}
Available Sensor Categories
- Motion & Environment:
.ambientLightSensor,.accelerometer,.rotationRate,.elevation. - User Interactions:
.keyboardMetrics,.deviceUsageReport,.messagesUsageReport,.phoneUsageReport. - Physiological & Health:
.speechMetrics,.faceMetrics,.wristTemperature,.heartRate.
Data Deletion & User Privacy
Research participants can delete recorded data. Honor deletion requests via SRSensorReader:
func purgeData(before timestamp: SRAbsoluteTime) async throws {
let request = SRDeletionRequest()
request.endTime = timestamp
try await reader.delete(request)
}
Common Mistakes
- Shipping without Apple entitlement approval: SensorKit APIs fail immediately unless signed with an approved provisioning profile.
- Returning false in fetch delegate prematurely: Returning
falsefromdidFetchResulthalts subsequent sample delivery. - Forgetting per-sensor usage descriptions: Each sensor type requires its dedicated Info.plist explanation key.
- Querying unbounded time intervals: Always constrain
SRFetchRequestto bounded start and end timestamps to avoid memory exhaustion. - Assuming simulator support: SensorKit does not record or simulate hardware sensor streams on iOS Simulator.
Review Checklist
-
com.apple.developer.sensorkit.reader.allowentitlement confirmed active - Required sensor usage descriptions declared in Info.plist
-
requestAuthorization(for:)called before starting reader recording -
didFetchResultreturnstruewhile iterating batch samples - Deletion requests supported for participant privacy compliance
References
- Setup, sensor/delegate catalogs, and multi-sensor manager
- Keyboard, device, phone, visit, media, and wrist samples
- Speech, face, temperature, ECG/PPG, deletion, and testing
- SensorKit framework
- SRSensorReader
- SRSensor
- SRDevice
- SRFetchRequest
- Configuring your project for sensor reading
- com.apple.developer.sensorkit.reader.allow