Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nugu-developers/nugu-ios
NUGU SDK for iOS
https://github.com/nugu-developers/nugu-ios
ios nugu sdk swift
Last synced: 3 months ago
JSON representation
NUGU SDK for iOS
- Host: GitHub
- URL: https://github.com/nugu-developers/nugu-ios
- Owner: nugu-developers
- License: apache-2.0
- Created: 2019-10-22T07:25:46.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-15T02:30:00.000Z (10 months ago)
- Last Synced: 2024-04-20T15:13:37.893Z (10 months ago)
- Topics: ios, nugu, sdk, swift
- Language: Swift
- Homepage: https://developers-doc.nugu.co.kr/
- Size: 50.1 MB
- Stars: 21
- Watchers: 7
- Forks: 16
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# nugu-ios
[](https://travis-ci.org/nugu-developers/nugu-ios)
[](https://github.com/nugu-developers/nugu-ios)
[](https://github.com/Carthage/Carthage)
[](https://github.com/apple/swift-package-manager)
## Requirements
- iOS 12.0+ (v1.3.0 or more) iOS 10.0+ (less than v1.3.0)
- Xcode 11.0+
- Swift 5.1+
## Components
NUGU SDK for iOS is composed of following Libraries
- [NuguCore](NuguCore/) - Main Framework of NUGU SDK, which has implementation of core functions such as network management, data transmission, media control, etc
- [NuguAgents](NuguAgents/) - The Framework which includes built-in capability-agents.
- [NuguClientKit](NuguClientKit/) - The Framework for initializing essential components and inject dependency between components to use NUGU SDK
- [NuguLoginKit](NuguLoginKit/) - The Framework for user authentication with OAuth2.0
- [NuguUIKit](NuguUIKit/) - The Framework for user interface components
- [NuguServiceKit](NuguServiceKit/) - The Framework provides customized webview for NUGU service
## Sample Application
### Run
We have sample application in `nugu-ios.xcodeproj`.
To use it download or clone this repository, and run `carthage update --use-xcframeworks --platform iOS` to install required frameworks.
Open `nugu-ios.xcodeproj` and you can run it through `SampleApp` scheme.
### See also
Unfortunately, we still have some step to use sample application.
For more information, See the [How to use sample application](https://github.com/nugu-developers/nugu-ios/wiki/How-to-use-sample-application).
## Installation
### CocoaPods
Each components of `NUGU SDK for iOS` is available through [CocoaPods](https://cocoapods.org).
To install it for easy use, simply add the following line to your `Podfile`:
```ruby
pod 'NuguClientKit'
```
### Carthage
NUGU SDK for iOS is available through [Carthage](https://github.com/Carthage/Carthage).
To install it, add the following line to your `Cartfile`:
```
github "nugu-developers/nugu-ios"
```
Then run `carthage update --platform iOS`.
If your application is first time adopting carthage, you'll need to set additional steps.
For more information, See the [Carthage for Application](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application)
## Usage
### Get Started
Using `NUGU SDK for iOS` is easy after some setup.
Here are some basic examples for some capability-agent.
#### Initialize & Enable
Before using `NUGU SDK for iOS`, enable to nugu when using NuguClientKit. like this:
```swift
class SomeClass: NuguClientDelegate {
let client = NuguClient(delegate: self)
...
}
```
#### Using ASRAgent (Automatic Speech Recognition Agent)
```swift
client.asrAgent.startRecognition(initiator: .user)
```
### See also
For more information, See the [How to use NUGU SDK for iOS](https://github.com/nugu-developers/nugu-ios/wiki/How-to-use-NUGU-SDK-for-iOS)
## License
The contents of this repository is licensed under the
[Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
## See Also
Please visit [Nugu Developers Guide page](https://developers-doc.nugu.co.kr/nugu-sdk/platform/ios)