Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/bojan/Thingy

A modern device detection and querying library.
https://github.com/bojan/Thingy

apple applewatch carthage cocoa cocoa-framework cocoa-touch device device-detection framework ios ipad iphone ipod mobile spm swift tvos watchos

Last synced: 26 days ago
JSON representation

A modern device detection and querying library.

Lists

README 

        
# Thingy

A modern device detection and querying library.



[![Build Status](https://app.bitrise.io/app/5638e96850380bcf/status.svg?token=ATvHHXw6RMbyde-i0FPV_w&branch=master)](https://app.bitrise.io/app/5638e96850380bcf)

[![GitHub license](https://img.shields.io/badge/license-WTFPL-green)](https://raw.githubusercontent.com/bojan/Thingy/master/LICENSE)

[![SPM](https://img.shields.io/badge/SPM-compatible-brightgreen.svg)](https://github.com/apple/swift-package-manager)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg)](https://github.com/Carthage/Carthage)

[![codecov](https://codecov.io/gh/bojan/Thingy/branch/master/graph/badge.svg)](https://codecov.io/gh/bojan/Thingy)



## Features



- [x] Swift 5 support

- [x] Modern syntax

- [x] Documentation

- [x] Device detection

- [x] Device family detection

- [x] Device screens

- [x] Simulator detection

- [x] Simple querying



## Requirements



## Installation



### Swift Packager Manager (SPM)



Use Xcode 11 to add Thingy as a package or update your `Package.swift` for manual setups:



```swift

import PackageDescription



let package = Package(

    name: "HelloWorld",

    dependencies: [

        .Package(url: "https://github.com/bojan/Thingy.git", "3.0.0")

    ]

)

```



### Carthage



Add this to your `Cartfile`:



```ogdl

github "bojan/Thingy"

```



### Manually



Add the repository as a submodule to your project.



```bash

git submodule add https://github.com/bojan/Thingy.git Vendor/Thingy

```



Open the newly created folder in Finder and drag `Thingy.xcodeproj` to your project.



In your project's settings, select your target and under **General** > **Embedded Binaries**, add the framework depending on the target OS (iOS, watchOS or tvOS).



## Usage



Import the module where needed:



```swift

import Thingy

```



### Device properties



Inspect the current device:



```swift



let myDevice = Device()



// Compare models or product families

if myDevice.family == .tv {

    print("This is an Apple TV device.")

}



if myDevice.model != .iPhoneXSMax {

    print("This is NOT an iPhone XS Max.")

}



// Pretty printed device properties



print(myDevice.family.marketingName) // e.g. iPad

print(myDevice.model.marketingName) // e.g. iPhone 7 Plus

print(myDevice.productLine.marketingName) // e.g. Air



```



### Model comparison



```swift

let myDevice = Device()



do {

    let result = try myDevice.isEqual(to: Thingy.iPadPro12Inch)

}

catch {

    print("The devices are incompatible.")

}



do {

    let result = try myDevice.isOlder(than: Thingy.iPadPro10Inch)

}

catch {

    print("The devices are incompatible.")

}

```



### Device size



```swift

let myDevice = Device()



if myDevice.display == .screen10_5Inch {

    print("This is the 10.5in iPad Pro.")

}



```



## Contributions



All contributions and suggestions are welcome and very much appreciated.



Should you have a feature request or a problem that you may experience, feel free to [open an issue](https://github.com/bojan/Thingy/issues/new).



If you are willing to contribute by adding a feature or squashing a bug or two, please submit a pull request.



## Author



Bojan Dimovski

- [LinkedIn](http://linkedin.com/in/bdimovski)



## License



Thingy is available under the WTFPL license. Check the [LICENSE](https://raw.githubusercontent.com/bojan/Thingy/master/LICENSE) file for more info.