| Branch | Build Status | Versions |
|---|---|---|
| master |  |
≥ 2.0 |
| Swift 4 - 4.2 |  |
≥ 1.3 < 1.13 |
| Swift 3 |  |
≥ 1.0 < 1.3 |
| Swift 2.3 |  |
< 1.0 |
DeviceKit is a value-type replacement of UIDevice.
Current version 4.5.2
See our detailed changelog for the latest features, improvements and bug fixes.
Features
- Equatable
- Device identification
- Device family detection
- Device group detection
- Simulator detection
- Battery state
- Battery level
- Various device metrics (e.g. screen size, screen ratio, PPI)
- Low Power Mode detection
- Guided Access Session detection
- Screen brightness
- Display Zoom detection
- Detect available sensors (Touch ID, Face ID)
- Detect available disk space
- Apple Pencil support detection
Requirements
- iOS 9.0+ (linking against iOS 9.3 required)
- tvOS 9.0+ (linking against tvOS 9.2 required)
- watchOS 2.0+
Installation
DeviceKit can be installed in various ways.
CocoaPods
Swift 5
pod 'DeviceKit', '~> 4.0'
iOS 8.0 support
pod 'DeviceKit', '3.2'
Swift 4.0 - Swift 4.2
pod 'DeviceKit', '~> 1.3'
Swift 3
pod 'DeviceKit', '~> 1.2.3'
Swift 2.3 (Unsupported)
pod 'DeviceKit', :git => 'https://github.com/devicekit/DeviceKit.git', :branch => 'swift-2.3-unsupported'
Swift Package Manager
Swift 5
dependencies: [
.package(url: "https://github.com/devicekit/DeviceKit.git", from: "4.0.0"),
/// ...
]
iOS 8.0 support
dependencies: [
.package(url: "https://github.com/devicekit/DeviceKit.git", from: "3.2.0"),
/// ...
]
Carthage
Swift 5
github "devicekit/DeviceKit" ~> 4.0
iOS 8.0 support
github "devicekit/DeviceKit" ~> 3.2
Swift 4.0 - Swift 4.2
github "devicekit/DeviceKit" ~> 1.3
Swift 3
github "devicekit/DeviceKit" ~> 1.2.3
Swift 2.3 (Unsupported)
github "devicekit/DeviceKit" "swift-2.3-unsupported"
Manually
To install it manually, drag the DeviceKit project into your app project in Xcode. Or add it as a git submodule by running:
$ git submodule add https://github.com/devicekit/DeviceKit.git
Usage
First make sure to import the framework:
import DeviceKit
Here are some usage examples. All devices are also available as simulators:
.iPhone6 => .simulator(.iPhone6)
.iPhone6s => .simulator(.iPhone6s)
You can try these examples in Playground.
Note:
To try DeviceKit in the playground, open the
DeviceKit.xcworkspaceand build DeviceKit.framework for any simulator first by selecting "DeviceKit" as your current scheme.
Get the Device You're Running On
let device = Device.current
print(device) // prints, for example, "iPhone 6 Plus"
if device == .iPhone6Plus {
// Do something
} else {
// Do something else
}
Get the Device Family
let device = Device.current
if device.isPod {
// iPods (real or simulator)
} else if device.isPhone {
// iPhone (real or simulator)
} else if device.isPad {
// iPad (real or simulator)
}
Check If Running on Simulator
let device = Device.current
if device.isSimulator {
// Running on one of the simulators(iPod/iPhone/iPad)
// Skip doing something irrelevant for Simulator
}
Get the Simulator Device
let device = Device.current
switch device {
case .simulator(.iPhone6s): break // You're running on the iPhone 6s simulator
case .simulator(.iPadAir2): break // You're running on the iPad Air 2 simulator
default: break
}
Make Sure the Device Is Contained in a Preconfigured Group
let groupOfAllowedDevices: [Device] = [.iPhone6, .iPhone6Plus, .iPhone6s, .iPhone6sPlus, .simulator(.iPhone6), .simulator(.iPhone6Plus),.simulator(.iPhone6s),.simulator(.iPhone6sPlus).simulator(.iPhone8),.simulator(.iPhone8Plus),.simulator(.iPhoneX),.simulator(.iPhoneXS),.simulator(.iPhoneXSMax),.simulator(.iPhoneXR)]
let device = Device.current
if device.isOneOf(groupOfAllowedDevices) {
// Do your action
}
Get the Current Battery State
Note:
To get the current battery state we need to set
UIDevice.current.isBatteryMonitoringEnabledtotrue. To avoid any issues with your code, we read the current setting and reset it to what it was before when we're done.
if device.batteryState == .full || device.batteryState >= .charging(75) {
print("Your battery is happy! 😊")
}
Get the Current Battery Level
if device.batteryLevel >= 50 {
install_iOS()
} else {
showError()
}
Get Low Power mode status
if device.batteryState.lowPowerMode {
print("Low Power mode is enabled! 🔋")
} else {
print("Low Power mode is disabled! 😊")
}
Check if a Guided Access session is currently active
if device.isGuidedAccessSessionActive {
print("Guided Access session is currently active")
} else {
print("No Guided Access session is currently active")
}
Get Screen Brightness
if device.screenBrightness > 50 {
print("Take care of your eyes!")
}
Get Available Disk Space
if Device.volumeAvailableCapacityForOpportunisticUsage ?? 0 > Int64(1_000_000) {
// download that nice-to-have huge file
}
if Device.volumeAvailableCapacityForImportantUsage ?? 0 > Int64(1_000) {
// download that file you really need
}
Source of Information
All model identifiers are taken from the following website: https://www.theiphonewiki.com/wiki/Models or extracted from the simulator app bundled with Xcode.
Contributing
If you have the need for a specific feature that you want implemented or if you experienced a bug, please open an issue. If you extended the functionality of DeviceKit yourself and want others to use it too, please submit a pull request.
Contributors
The complete list of people who contributed to this project is available here. DeviceKit wouldn't be what it is without you! Thank you very much!
14 Oct 21, 2022
3.9k Dec 30, 2022
408 Dec 11, 2022
1.9k Dec 30, 2022
3 Nov 4, 2022
28 Oct 11, 2021
20 Aug 4, 2022
708 Jun 29, 2022
12 Feb 26, 2021
0 Jan 17, 2022
222 Dec 6, 2022
124 Nov 24, 2022
67 Aug 7, 2022
119 Dec 21, 2022
1.9k Dec 23, 2022
326 Dec 29, 2022
60 Aug 21, 2022
15 Apr 3, 2022