Skip to content

Latest commit

 

History

History
321 lines (266 loc) · 9.95 KB

README.md

File metadata and controls

321 lines (266 loc) · 9.95 KB
Raw

Device.swiftpm

Device is a value-type replacement for device information on all supported platforms (very similar to DeviceKit but designed to be easier to maintain). Device definitions include clear initializers so anyone can add new devices and contribute to the project even on an iPad using Swift Playgrounds rather than requiring Xcode. No need to memorize mapping schema or use additional build tools.

The primary goals are to be easily maintainable by multiple individuals, employ a consistent API that can be used across all platforms, and to be maintainable using Swift Playgrounds on iPad and macOS. APIs are typically present even on platforms that don't support all features so that availability checks do not have to be performed in external code, and where irrelevant, code can simply return optionals.

This is actively maintained so if there is a feature request or change, we will strive to address within a week.

Features

  • Can develop and modify without Xcode using Swift Playgrounds on iPad!
  • Framework
    • Clearly labeled device identification
    • Device idiom detection
    • Environmental detections:
      • Simulator
      • Playground
      • Preview
      • Designed for iPad
      • macCataylst
  • Debugging
    • Provides UI for quickly showing information about devices and batteries.
  • Device Information
    • Identifier (ex: Mac14,10)
    • Name (ex: Ben's iPad Note: only available on some devices.)
    • Operating System (ex: iPad OS 17.4)
    • Official Name (ex: MacBook Pro (16-inch, 2023)
    • Image
    • Color
    • CPU (ex: M2 Pro)
    • Cellular technology
    • Thermal state
    • Orientation
    • Screen information
      • Size
      • Diagonal
      • Pixels Per Inch (PPI)
      • Ratio
  • Battery & Power Information
    • Battery availability
    • Battery state changes
    • Battery level
    • Low Power Mode
    • Plugged in
    • Battery View
    • Battery Symbols
    • Battery Coloring
  • User Hardware Settings
    • Disable Idle Timer (set permanently or automatically when plugged in)
    • Display Zoom
    • Guided Access
    • Screen Brightness (only available on iOS)
    • Available Disk Space
  • Capabilities (with symbols for each)
    • Model Attributes
      • Pro
      • Air
      • mini
      • Plus
      • Max
      • Mac form factor
      •  Watch size
    • Connections
      • Headphone Jack
      • 30-pin Connector
      • Lightning Connector
      • USB-C
      • Thunderbolt
    • Power
      • Battery
      • Wireless Charging
      • MagSafe (MacBook and iPhone)
    • Dislplay Features
      • Force/3D Touch
      • Rounded Corners
      • Notch
      • Dynamic Island
    • Additional Features
      • Ringer Switch
      •  Pay
      • NFC
      • Action Button
      •  Pencil Support
    • Sensors
      • Biometrics
      • LIDAR
      • Barometer
      • Crash Detection
      • Cameras

Requirements

  • iOS 11+ (15.2+ minimum required for Swift Playgrounds support)
  • macOS 10.5+ (UI only supported on macOS 12.0+)
  • macCatalyst 13.0+ (first version available)
  • tvOS 11.0+ (UI only supported on tvOS 15.0+, 17+ required for most SwiftUI features)
  • watchOS 4.0+ (UI only supported on watchOS 8.0+)
  • visionOS 1.0+
  • Theoretically should work with Linux, Windows, and Vapor, but haven't tested. If you would like to help, please let us know.

Known Issues

Built for macOS "Designed for iPad" returns an iPad profile instead of actual hardware profile. Custom Symbols likely won't work in macOS < 13 or watchOS < 7. LowPowerMode checks unavailable in macOS < 12. See CHANGELOG.md for more known issues and roadmap

Installation

Install by adding this as a package dependency to your code. This can be done in Xcode or Swift Playgrounds!

Swift Package Manager

Swift 5+

You can try these examples in a Swift Playground by adding package: https://github.com/kudit/Device

If the repository is private, use the following link to import: https://<your-PAT-string>@github.com/kudit/Device.git

Or you can manually enter the following in the Package.swift file:

dependencies: [
    .package(url: "https://github.com/kudit/Device.git", from: "2.0.0"),
]

Usage

First make sure to import the framework:

import Device

Here are some usage examples.

Get the version of Device that is imported.

let version = Device.version

Get the device You're Running On

let device = await Device.current // await required if not on the main thread (@MainActor isolated)

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

if device.has(.force3dTouch) {
    // do something that needs force-touch.
} else {
    // fallback for devices that do not support this.
}

if device.is(.plus) || device.is(.max) {
    // do something only available for "Plus" model devices.
}

if device.has(.battery) && device.has(.lidar) && device.has(.headphoneJack) {
    // do something only if there is a battery, lidar, and a headphoneJack
}

Get the full list of flags that can be queried for under the enum Capability in Hardware.swift.

Get the device idiom

let device = Device.current
if device.idiom == .pad {
  // iPad
} else if device.idiom == .phone {
  // iPhone
} else if device.idiom == .vision {
  // Apple Vision device
}

Check if running in a Simulator

if Device.isSimulator {
  // Running on one of the simulators
  // Skip doing something irrelevant for Simulator
}

Check if running in a Preview

if Device.isPreview {
  // Running in an XCode #Preview
}

Check if running in a Playground

if Device.isPlayground {
  // Running in an XCode #Preview
}

Check if running on a physical device

if Device.isRealDevice {
  // Running on physical hardware and not a simulator
}

Get the Current Battery State

Note:

When getting the current battery state, battery monitoring enabled will be temporarily set to true and then restored to whatever it was beforehand, so no need to manage monitoring separately. If you need to be notified when the battery state or level changes, you can add a monitor that will call your code whenever the level changes. However, typically this can just be dropped in as the DeviceBattery is an ObservableObject.

if let battery = Device.current.battery {
    // do things that need the battery
    if battery.currentState == .full || (battery.currentState == .charging && battery.currentLevel >= 75) {
        print("Your battery is happy! 😊")
    }
    
    // get the current battery level
    if battery.currentLevel >= 50 {
        install_iOS()
    } else {
        showLowBatteryWarning()
    }

    if battery.lowPowerMode {
        print("Low Power mode is enabled! 🔋")
    } else {
        print("Low Power mode is disabled! 😊")
    }

    // add monitor to do something whenever battery level changes (like updating UI)
    battery.addMonitor {
        localBatteryLevel = battery.currentLevel
        localBatteryState = battery.currentState
    }
} else {
    // handle behaviour on devices without a battery
}

Get the Current Battery Level

if let level = Device.current.battery?.currentLevel, level >= 50 {
  install_iOS()
} else {
  showError()
}

Check if a Guided Access session is currently active

if Device.current.isGuidedAccessSessionActive {
  print("Guided Access session is currently active")
} else {
  print("No Guided Access session is currently active")
}

Get Screen Brightness

if Device.current.screenBrightness > 50 {
  print("Take care of your eyes!")
}

Get Available Disk Space

if Device.current.volumeAvailableCapacityForOpportunisticUsage ?? 0 > Int64(1_000_000) {
  // download that nice-to-have huge file
}

if Device.current.volumeAvailableCapacityForImportantUsage ?? 0 > Int64(1_000) {
  // download that file you really need
}

Disabling the Idle Timer

Device.current.isIdleTimerDisabled = true // must be run on the main actor AFTER most of the UI is loaded (so do on a view onAppear and NOT during the app init)

// Disable automatically when plugged in.  Only call this once (This would be appropriate to call during init).
Device.current.disableIdleTimerWhenPluggedIn()

Displaying a BatteryView

// BatteryView() will default to a view with a live updating battery indicator.
BatteryView()
// you can have a larger one by changing the font size
BatteryView(fontSize: 80)

All these tests can be demonstrated using previews or by running the app executable that is bundled in the Development folder of the module.

Source of Information

Some information has been sourced from the following:

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 yourself and want others to use it too, please submit a pull request.

Donations

This was a lot of work. If you find this useful particularly if you use this in a commercial product, please consider making a donation to http://paypal.me/kudit

License

Feel free to use this in projects, however, please include a link back to this project and credit somewhere in the app. Example Markdown and string interpolation for the version:

Text("Open Source projects used include [Device](https://github.com/kudit/Device) v\(Device.version)

Contributors

The complete list of people who contributed to this project is available here. A big thanks to everyone who has contributed! 🙏