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

README.md

English / 日本語

Controller SDK for Windows

License

The Windows 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 USB

Prerequisites

  • Windows version: 8+.
  • .NET Framework: 4.5+.
  • For Aroma Shooter USB, please install device driver.

Installation

For Bluetooth version, please connect Aroma Shooter via Bluetooth Settings section in Windows before starting application. If you restart your app, make sure to reconnect it again.

Sample

You might want to try the sample app by using Visual Studio.

Usage

Firstly, get the reference of AromaShooterController

AromaShooterController aromaShooterController = AromaShooterController.SharedInstance;

Setup and connect devices

aromaShooterController.Setup();

Diffuse scents

Using Diffuse APIs :

aromaShooterController.Diffuse(durration, ports, booster);

For example, the following code will diffuse cartridge 1, 2, and 3 for 3 seconds.

aromaShooterController.Diffuse(3000, new int[]{1, 2, 3}, true);

Stop diffusing

aromaShooterController.Stop();

If you get any issues or require any new features, please create a new issue.

License

The Apache License (Apache)

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.