https://github.com/matis-schotte/vifra
Vifra is a framework for macOS, iOS and watchOS that provides simplified access to the device actuator to provide haptic feedback (vibration through the taptic engine).
https://github.com/matis-schotte/vifra
carthage cocoapods device-actuator haptic ios macos module package swift taptic-engine vibration watchos xcode
Last synced: 3 months ago
JSON representation
Vifra is a framework for macOS, iOS and watchOS that provides simplified access to the device actuator to provide haptic feedback (vibration through the taptic engine).
- Host: GitHub
- URL: https://github.com/matis-schotte/vifra
- Owner: matis-schotte
- License: mit
- Created: 2018-03-04T15:35:55.000Z (about 7 years ago)
- Default Branch: develop
- Last Pushed: 2018-04-21T08:53:23.000Z (about 7 years ago)
- Last Synced: 2024-03-15T13:10:32.931Z (about 1 year ago)
- Topics: carthage, cocoapods, device-actuator, haptic, ios, macos, module, package, swift, taptic-engine, vibration, watchos, xcode
- Language: Swift
- Homepage:
- Size: 2.04 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Vifra
[](https://travis-ci.org/matis-schotte/Vifra)
[](https://codebeat.co/projects/github-com-matis-schotte-vifra-develop)
[](https://codecov.io/gh/matis-schotte/Vifra)
[](https://codeclimate.com/github/matis-schotte/Vifra/maintainability)
[](https://matis-schotte.github.io/Vifra/)
[](./LICENSE)
[](http://cocoapods.org/pods/Vifra)
[](https://www.codetriage.com/matis-schotte/vifra)
[](http://twitter.com/matis_schotte)
Vifra is a framework for macOS, iOS and watchOS that provides simplified access to the device actuator to provide haptic feedback (vibration through the taptic engine).
## Requirements
- Swift >= 4
- macOS >= 10.12
- watchOS >= 2.0
## Installation
### Swift Package Manager
The [Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the `swift` compiler. It is in early development, but Vifra does support its use on supported platforms.
Once you have your Swift package set up, adding Vifra as a dependency is as easy as adding it to the `dependencies` value of your `Package.swift`.
```swift
dependencies: [
.package(url: "https://github.com/matis-schotte/Vifra.git", from: "0.4.0")
]
```
Do not forget to ensure that the deployment target is set to the correct version (e.g. macOS 10.12), and that all necessary Frameworks are linked (e.g. MultitouchSupport.framework). To avoid getting "undefined symbols" the Bridging header should be used. Possible build command could be:
```bash
$ swift build -Xswiftc "-target" -Xswiftc "x86_64-apple-macosx10.12" -Xswiftc "-import-objc-header" -Xswiftc ".build/checkouts/Vifra.git-6919244937016367571/Vifra/Vifra-Bridging-Header.h" -Xlinker -F/System/Library/PrivateFrameworks -Xlinker -lMultitouchSupport && swift run
```
### Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
```bash
$ brew update
$ brew install carthage
```
To integrate Vifra into your Xcode project using Carthage, specify it in your `Cartfile`:
```ogdl
github "matis-schotte/Vifra" ~> 0.4
```
Run `carthage update` to build the framework and drag the built `Vifra.framework` into your Xcode project.
### CocoaPods
[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
```bash
$ gem install cocoapods
```
To integrate Vifra into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
pod 'Vifra'
```
Then, run the following command:
```bash
$ pod install
```
### Manually
If you prefer not to use any of the aforementioned dependency managers, you can integrate Vifra into your project manually.
- Open up Terminal, `cd` into your top-level project directory, and run the following command "if" your project is not initialized as a git repository:
```bash
$ git init
```
- Add Vifra as a git [submodule](http://git-scm.com/docs/git-submodule) by running the following command:
```bash
$ git submodule add https://github.com/matis-schotte/Vifra.git
```
- Open the new `Vifra` folder, and drag the `Vifra.xcodeproj` into the Project Navigator of your application's Xcode project.
- Select the `Vifra.xcodeproj` in the Project Navigator and verify the deployment target matches that of your application target.
- Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.
- In the tab bar at the top of that window, open the "General" panel.
- Click on the `+` button under the "Embedded Binaries" section.
- You will see the `Vifra.framework` somewhere, just select the correct version.
- And that's it, try `import Vifra`!
## Usage
You can issue haptic feedback with just any of the following lines using any of the predefined enum values:
```swift
Vifra.feedback(.strong)
Vifra.feedback([.strong, .weak, .delay(usec: 500_000), .strong])
```
[//]: # (Example: See the example project snside the `examples/` folder.)
## Know problems
- macOS: A private framework is used; it is therefore unlikely to be accepted in the app store.
- macOS: You cannot enable the sandboxing entitlement; if you do you'll encounter the error -536870174 during `Vifra.setup()` which is internally being called from `Vifra.feedback()`.
## ToDo
- Add Carthage support
- Add iOS support (UIFeedbackGenerator and AudioServicesPlaySystemSound(kSystemSoundID_Vibrate))
- Update macOS support (NSHapticFeedbackPerformer)
[//]: # (Donations: ETH, LTC welcome.)
## License
Vifra is available under the MIT license. See the [LICENSE](https://github.com/matis-schotte/Vifra/blob/develop/LICENSE) file for more info.
## Author
Matis Schotte, [[email protected]](mailto:[email protected])
[https://github.com/matis-schotte/Vifra](https://github.com/matis-schotte/Vifra)