/DeviceKit

DeviceKit is a value-type replacement of UIDevice.

Primary LanguageSwiftMIT LicenseMIT

GitHub license CocoaPods Compatible Carthage Compatible Platform

Branch Build Status
master Build Status
Swift 3 Build Status
Swift 2.3 Build Status

Device is a value-type replacement of UIDevice.

##Features

  • Device identification
  • Device family detection
  • Device group detection
  • Simulator detection
  • Battery state
  • Battery level
  • Equatable

Requirements

  • iOS 8.0+ / tvOS 9.0+ (linking against iOS 9.3 and tvOS 9.2 required)
  • Xcode 8.0+

Installation

DeviceKit can be installed in various ways.

CocoaPods

Swift 3.0

pod 'DeviceKit', '~> 1.0'

Swift 2.3 (Unsupported)

pod 'DeviceKit', :git => 'https://github.com/dennisweissmann/DeviceKit.git', :branch => 'swift-2.3-unsupported'

Carthage

Swift 3.0

github "dennisweissmann/DeviceKit" "HEAD"

Swift 2.3 (Unsupported)

github "dennisweissmann/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. In your project folder enter:

$ git submodule add https://github.com/dennisweissmann/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)

Get the Device You're Running On

let device = Device()

print(device)     // prints, for example, "iPhone 6 Plus"

if device == .iPhone6Plus {
  // Do something
} else {
  // Do something else
}

Get the Device Family

let device = Device()
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()
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()
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)]
let device = Device()
 
if device.isOneOf(groupOfAllowedDevices) {
  // Do you action
}

Get the Current Battery State

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()
}

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 following people (in alphabetical order) contributed to this project - it wouldn't be what it is without you! Thank you very much! 🙏