Code Monkey home page Code Monkey logo

devicekit's Introduction

GitHub license Build Status CocoaPods Compatible Carthage Compatible Platform

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 7.3+

Installation

DeviceKit can be installed in various ways.

CocoaPods

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!

pod 'DeviceKit', '~> 0.3.2'

Carthage

github "dennisweissmann/DeviceKit" ~> 0.3.2

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

Here are some usage examples. All devices are also available as simulators:

.iPhone6 => .Simulator(.iPhone6)
.iPhone6s => .Simualtor(.iPhone6s)

etc.

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

To 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.

devicekit's People

Contributors

dearprakash avatar dennisweissmann avatar phiren avatar ruipfcosta avatar stevemoser avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.