sensorkit
Access research-grade sensor data using SensorKit for approved studies
Install / Use
npx skills add dpearson2699/swift-ios-skills --skill sensorkitInstalls into whichever agent you are using.
SKILL.md
Installable skill definition
Quality Score
Category
Education & ResearchSupported Platforms
Tags
Our assessment of sensorkit
sensorkit scores 86/100 on our quality scale, 276th of 421 Education & Research skills we index.
Its SKILL.md is 13 KB long, well organised into 22 sections with 10 code examples: a thorough specification that gives an agent plenty to work with.
With 1,143 GitHub stars, it is one of the more widely adopted skills in the catalogue.
Maintenance, license and trust
- The repository was last updated about 4 months ago. That is recent enough to be usable, but agent tooling moves fast, so check the instructions against your agent's current version.
- Our last check on 2026-11-03 found the source still online.
- No license is declared. By default that means all rights are reserved: you can read it, but reusing or redistributing it is not clearly permitted. Ask the author before building on it commercially.
- Its trust signals score 86/100, with 1 caution from licensing, adoption, age or documentation. These come from repository metadata, not a code audit — read the skill file before letting an agent act on it.
Safety scan
No issues foundOur scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands. An AI review of the same text found nothing harmful.
AI review by kimi-k2.7-code on 2026-10-06. Automated pattern scan on 2026-10-05. It catches known dangerous patterns, not every risk — read a skill before letting an agent act on it.
sensorkit compared with similar skills
All 4 of these similar skills score higher than sensorkit; compare them before choosing.
| Skill | Score | Stars | Updated | Format |
|---|---|---|---|---|
| sensorkit (this skill)by dpearson2699 | 86 | 1.1k | 4mo ago | SKILL.md |
| last30days-skillby mvanhorn | 100 | 68.0k | today | CLAUDE.md |
| x402by browser-use | 100 | 121.0k | 3d ago | SKILL.md |
| algorithmic-artby anthropics | 100 | 177.9k | 55d ago | SKILL.md |
| pptxby anthropics | 100 | 177.9k | 55d ago | SKILL.md |
Frequently asked questions
- How do I install sensorkit?
- Run
npx skills add dpearson2699/swift-ios-skills --skill sensorkit. The install tabs above show the steps for each supported agent. - Which AI agents does sensorkit work with?
- It is written for Universal, as a SKILL.md file. Other agents that read the same format can often use it too.
- Is sensorkit safe to use?
- Our scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands. An AI review of the same text found nothing harmful. It declares no license and scores 86/100 on trust signals. Skills are instructions an agent will follow, so read the file before installing it and do not approve commands you do not understand.
- Is sensorkit still maintained?
- The repository was last updated about 4 months ago. That is recent enough to be usable, but agent tooling moves fast, so check the instructions against your agent's current version.
Skill content
View source on GitHubname: sensorkit description: "Access research-grade sensor data using SensorKit for approved studies. Use when an app needs SensorKit entitlement setup, Research Sensor & Usage Data authorization, ambient light, recorded motion, device usage, keyboard metrics, visits, speech, face, wrist temperature, ECG, PPG, acoustic settings, or sleep-session data. Route ordinary motion to CoreMotion and health records/workouts to HealthKit."
SensorKit
Choose the exact SRSensor and verify its individual availability. Use
CoreMotion for ordinary motion/activity features and HealthKit for health
records and workouts.
Contents
- Overview and Requirements
- Entitlements
- Info.plist Configuration
- Authorization
- Available Sensors
- SRSensorReader
- Recording and Fetching Data
- SRDevice
- Common Mistakes
- Review Checklist
- References
Overview and Requirements
SensorKit enables research apps to record and fetch sensor data across iPhone and Apple Watch. The framework requires:
- Apple-approved research study -- submit a proposal at researchandcare.org.
- SensorKit entitlement -- Apple grants
com.apple.developer.sensorkit.reader.allowonly for approved studies. - Manual provisioning profile -- Xcode requires an explicit App ID with the SensorKit capability enabled.
- User authorization -- the system presents a Research Sensor & Usage Data sheet that users approve per-sensor.
- Delayed retrieval -- design fetch timing around the canonical Data Holding Period.
An app can access up to 7 days of prior recorded data for an active sensor.
Entitlements
Add the SensorKit reader entitlement to a .entitlements file. List only the
sensors Apple approved for the study. Common entitlement values include:
<key>com.apple.developer.sensorkit.reader.allow</key>
<array>
<string>ambient-light-sensor</string>
<string>motion-accelerometer</string>
<string>device-usage</string>
<string>keyboard-metrics</string>
</array>
Load the Entitlement and Usage-Detail Catalog
when selecting the exact entitlement string and NSSensorKitUsageDetail key
for each approved sensor. Recheck specialized sensors against their individual
SRSensor pages.
For manual signing, set Code Signing Entitlements to the entitlements file,
Code Signing Identity to Apple Developer, Code Signing Style to Manual,
and Provisioning Profile to the explicit profile with SensorKit capability.
Info.plist Configuration
Three keys are required:
<!-- Study purpose shown in the authorization sheet -->
<key>NSSensorKitUsageDescription</key>
<string>This study monitors activity patterns for sleep research.</string>
<!-- Link to your study's privacy policy -->
<key>NSSensorKitPrivacyPolicyURL</key>
<string>https://example.com/privacy-policy</string>
<!-- Per-sensor usage explanations -->
<key>NSSensorKitUsageDetail</key>
<dict>
<key>SRSensorUsageMotion</key>
<dict>
<key>Description</key>
<string>Measures physical activity levels during the study.</string>
<key>Required</key>
<true/>
</dict>
<key>SRSensorUsageAmbientLightSensor</key>
<dict>
<key>Description</key>
<string>Records ambient light to assess sleep environment.</string>
</dict>
</dict>
If Required is true and the user denies that sensor, the system warns them
that the study needs it and offers a chance to reconsider.
Use the exact usage-detail dictionary for each requested sensor. Load the Entitlement and Usage-Detail Catalog when mapping sensors beyond the motion and ambient-light examples above.
Authorization
Request authorization for the sensors your study needs. The system shows the Research Sensor & Usage Data sheet on first request.
import SensorKit
let reader = SRSensorReader(sensor: .ambientLightSensor)
// Request authorization for multiple sensors at once
SRSensorReader.requestAuthorization(
sensors: [.ambientLightSensor, .accelerometer, .keyboardMetrics]
) { error in
if let error {
print("Authorization request failed: \(error)")
}
}
Use one status handler both for the initial check and delegate changes:
private func applyAuthorizationStatus(
_ status: SRAuthorizationStatus,
to reader: SRSensorReader
) {
switch status {
case .authorized:
reader.startRecording()
case .denied:
reader.stopRecording()
// Direct the user to Settings > Privacy > Research Sensor & Usage Data.
case .notDetermined:
break // Request authorization first.
@unknown default:
break
}
}
applyAuthorizationStatus(reader.authorizationStatus, to: reader)
func sensorReader(_ reader: SRSensorReader, didChange authorizationStatus: SRAuthorizationStatus) {
applyAuthorizationStatus(authorizationStatus, to: reader)
}
Available Sensors
Load the Sensor Catalog to map
each SRSensor to its sample type. Request only sensors approved for the study
and recheck the selected sensor's availability and usage-detail key.
SRSensorReader
SRSensorReader is the central class for accessing sensor data. Each instance
reads from a single sensor.
import SensorKit
// Create a reader for one sensor
let lightReader = SRSensorReader(sensor: .ambientLightSensor)
let keyboardReader = SRSensorReader(sensor: .keyboardMetrics)
// Assign delegate to receive callbacks
lightReader.delegate = self
keyboardReader.delegate = self
The reader communicates through SRSensorReaderDelegate. Load the
Delegate Method Catalog
when wiring the complete authorization, recording, device-fetch, and
sample-fetch lifecycle.
Recording and Fetching Data
Start and Stop Recording
// Begin recording -- sensor stays active as long as any app has a stake
reader.startRecording()
// Stop recording -- framework deactivates the sensor when
// no app or system process is using it
reader.stopRecording()
Fetch Data
Build an SRFetchRequest with a time range and target device, then pass it to
the reader:
let request = SRFetchRequest()
request.device = SRDevice.current
request.from = SRAbsoluteTime(CFAbsoluteTimeGetCurrent() - 86400 * 2) // 2 days ago
request.to = SRAbsoluteTime.current()
reader.fetch(request)
Receive results through the delegate:
func sensorReader(
_ reader: SRSensorReader,
fetching request: SRFetchRequest,
didFetchResult result: SRFetchResult<AnyObject>
) -> Bool {
let timestamp = result.timestamp
switch reader.sensor {
case .ambientLightSensor:
if let sample = result.sample as? SRAmbientLightSample {
let lux = sample.lux
let chromaticity = sample.chromaticity
let placement = sample.placement
processSample(lux: lux, chromaticity: chromaticity, at: timestamp)
}
case .keyboardMetrics:
if let sample = result.sample as? SRKeyboardMetrics {
let words = sample.totalWords
let speed = sample.typingSpeed
processKeyboard(words: words, speed: speed, at: timestamp)
}
case .deviceUsageReport:
if let sample = result.sample as? SRDeviceUsageReport {
let wakes = sample.totalScreenWakes
let unlocks = sample.totalUnlocks
processUsage(wakes: wakes, unlocks: unlocks, at: timestamp)
}
default:
break
}
return true // Return true to continue receiving results
}
func sensorReader(_ reader: SRSensorReader, didCompleteFetch request: SRFetchRequest) {
print("Fetch complete for \(reader.sensor)")
}
func sensorReader(
_ reader: SRSensorReader,
fetching request: SRFetchRequest,
failedWithError error: any Error
) {
print("Fetch failed: \(error)")
}
Cast result.sample to the sample shape for the reader's sensor. Some streams
return one object per result, while recorded motion, ECG, PPG, and ambient
pressure streams can return arrays of recorded samples.
Data Holding Period
SensorKit imposes a 24-hour holding period on newly recorded data. Fetch requests whose time range overlaps this period return no results. Design data collection workflows around this delay.
SRDevice
SRDevice identifies the hardware source for sensor samples. Use it to
distinguish data from iPhone versus Apple Watch.
// Get the current device
let currentDevice = SRDevice.current
print("Model: \(currentDevice.model)")
print("System: \(currentDevice.systemName) \(currentDevice.systemVersion)")
// Fetch all available devices for a sensor
reader.fetchDevices()
Handle fetched devices through the delegate:
func sensorReader(_ reader: SRSensorReader, didFetch devices: [SRDevice]) {
for device in devices {
let request = SRFetchRequest()
request.device = device
request.from = SRAbsoluteTime(CFAbsoluteTimeGetCurrent() - 86400)
request.to = SRAbsoluteTime.current()
reader.fetch(request)
}
}
func sensorReader(_ reader: SRSensorReader, fetchDevicesDidFailWithError error: any Error) {
print("Failed to fetch devices: \(error)")
}
SRDevice Properties
| Property | Type | Description |
|---|---|---|
| model | String | User-defined device name |
| name | String | Framework-defined device name |
| systemName | String | OS name (iOS, watchOS) |
| systemVersion | String | OS version |
| productType | String | Hardware identifier |
| current | SRDevice | Class property for the running device |
Common Mistakes
DON'T: Attempt to use SensorKit without the entitlement
Obtain Apple's study approval, the sensor-specific entitlement values, and a matching manual provisioning profile before constructing production readers.
DON'T: Expect immediate data access
Apply the Data Holding Period; a fetch overlapping the hold is not proof that recording failed.
DON'T: Forget to set the delegate before fetching
Assign the delegate before startRecording() or fetch(_:); results and
failures arrive through delegate callbacks.
DON'T: Skip per-sensor Info.plist usage detail
Add the exact Info.plist Configuration usage-detail entry for every requested sensor.
DON'T: Ignore SRError codes
Distinguish at least .invalidEntitlement, .noAuthorization,
.dataInaccessible, .fetchRequestInvalid, .promptDeclined, and unknown
future codes. Load the Full Delegate Implementation
for the complete switch and callback wiring.
Review Checklist
- [ ] Apple-approved research study in place before development
- [ ]
com.apple.developer.sensorkit.reader.allowentitlement lists only needed sensors - [ ] Manual provisioning profile with explicit App ID and SensorKit capability
- [ ]
NSSensorKitUsageDescriptionin Info.plist with clear study purpose - [ ]
NSSensorKitPrivacyPolicyURLin Info.plist with valid privacy policy URL - [ ]
NSSensorKitUsageDetailentries for every requested sensor - [ ]
Requiredkey set appropriately for essential vs. optional sensors - [ ] Authorization requested before recording, status checked before fetching
- [ ] Delegate assigned before calling
startRecording()orfetch(_:) - [ ] Fetch request time ranges account for 24-hour
Truncated for display — read the full file on GitHub.
Related Skills
last30days-skill
68.0kAI agent skill that researches any topic across Reddit, X, YouTube, HN, Polymarket, and the web - then synthesizes a grounded summary
x402
121.0kSet up Browser Use Cloud payments with x402 — pay per request from a crypto wallet (USDC on Base mainnet), no signup or API key.
algorithmic-art
177.9kCreating algorithmic art using p5.js with seeded randomness and interactive parameter exploration. Use this when users request creating art using code, generative art, algorithmic art, flow fields, or particle systems.
pptx
177.9kUse this skill any time a .pptx or .potx file is involved in any way — as input, output, or both. This includes: creating slide decks, pitch decks, or presentations; reading, parsing, or extracting text from any .pptx or .potx file (even if the extracted content will be used elsewhere, like in an em…
Languages
Trust signals
From repository metadata: license, adoption, age and documentation. Not a code audit — see the Safety scan above for what the skill file itself contains.
