Enable developers to connect and control Aroma Shooter.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
framework/AromaShooterControllerSwift.framework
sample
.gitignore
CHANGELOG.md
LICENSE.md
README-JP.md
README.md

README.md

English / 日本語

Controller SDK for iOS

License

The iOS version of AromaShooterController SDK which is used to communicate with Aroma Shooter devices.

Table of Contents

  1. Supported devices
  2. Prerequisites
  3. Installation
  4. Usage
  5. License

Supported devices

  • Aroma Shooter Bluetooth version

Prerequisites

  • iOS version: >= 8.0
  • Swift version: >= 3.0

Installation

  • Download the framework file at the release page.
  • Drag and drop it into your project. (Make sure that it is added in Embedded Binaries section in your project's target page).

Usage

Get Controller references

  • Import Controller module
import AromaShooterControlerSwift
  • Get the Controller class reference
var controller = AromaShooterController.sharedInstance

Connect devices

There are 2 options.

  • Use the existing connection screen (ConnectionViewController) inside sample app. This is easy and recommended.
    • Please check out this repository, grab ConnectionViewController.swift file to put in your project.
    • For further detail, please take a look our sample applicaton.
  • Write your own connection screen using our API.
    • Scan AromaShooter devices
    controller.startScanning()
    • Make sure that scanning is stopped when the view controller dissapear
     override func viewWillDisappear(_ animated: Bool) {
         // Stop searching
         controller.stopScanning()
     }
    • Connect
    controller.connect(aromaShooters: devices)
    • Disconnect
    controller.disconnect(aromaShooter: device)

Get connected devices

let connectedDevices = controller.connectedDevices

Diffuse scents

  • Diffuse scents of all connected devices
controller.diffuseAll(duration: 3000, booster: true, ports: [1, 2, 3])
  • Diffuse scents of specific devices
controller.diffuse(aromaShooters: devices, duration: 3000, booster: true, port: [1, 2, 3])

For more information, please checkout this repository and refer to the sample project.
If you get any issues or require any new features, please create a new issue.

License

Copyright (c) 2017 Aromajoin Corporation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.