Skip to content

Latest commit

 

History

History
120 lines (96 loc) · 5.31 KB

README-JP.md

File metadata and controls

120 lines (96 loc) · 5.31 KB

English / 日本語

ControllerSDK - Windows版

License Join the community on Spectrum

Aroma Shooterとの通信に使用されるAromaShooterController SDKのWindows版です。

目次

  1. 対応デバイス
  2. 前提条件
  3. インストール
  4. 使い方
  5. ライセンス

対応デバイス

  • Aroma Shooter 1 USBタイプ
  • Aroma Shooter 2 (USB接続の場合)

前提条件

  • Windows版: 10+
  • .NET Framework: >= 4.7.1
  • ドライバをインストールしてください。

インストール

  1. このリポジトリを複製するか、.zipファイルをダウンロードしてください。
  2. ’libs’フォルダでライブラリバイナリファイル(.dll)を入手してください。
  3. これらの.dllファイルをプロジェクトにReferencesとして追加してください。

サンプル

Visual Studioを使用してサンプルアプリケーションを試してみてください。

使い方

0. 接続

初めにAroma Shooter Controllerのリファレンスを作る。

AromaShooterController aromaShooterController = AromaShooterController.SharedInstance;

デバイスのセットアップと接続

aromaShooterController.Setup();

1. Aroma Shooter 1 & 2のどちらも使える関数

a. 接続されたアロマシューターすべて噴射

ASController.DiffuseAll(int durationMillisecs, int[] ports, bool booster);
/**
 * @param durationMillisecs     噴射持続時間(ミリ秒)。
 * @param ports        噴射する カートリッジ番号。値: 1 ~ 6.
 * @param booster      ブースターを使用するかどうかを判定する。(true: より強く噴射する , false: より弱く噴射する )
 */

例:以下のコードは、カートリッジ 1,2 および 5 を 3 秒間噴射します。

ASController.DiffuseAll(3000, new int[]{1, 2, 5}, true);

b. アロマシューターの名前を指定して噴射

ASController.Diffuse(int durationMillisecs, int[] ports, bool booster, string shooterName);

例:

ASController.Diffuse(3000, new int[]{1, 2, 5}, true,”ASN1UA0150”);
ASController.Diffuse(3000, new int[]{1, 2, 5}, true,”ASN2A00001”);

c. 接続されたアロマシューター全て噴射停止

ASController.StopAll();

d. アロマシューターの名前を指定して噴射停止

ASController.Stop(string shooterName);

e. 接続されたアロマシューターリスト取得

List<String> connectedAromaShooters = ASController.GetConnectedDevices();

2. Aroma Shooter 新バージョンのみ使える関数

a. 接続されたアロマシューター全て強度制御付き噴射

ASController.DiffuseAll(int durationMillisecs, List<AromaPort> ports, int boosterIntensity, int fanIntensity);

AromaPort クラスに number と intensity というメンバーがあります。 number は噴 射するポート番号で、 intensity は強度(0~100)です。

b. アロマシューターの名前を指定して強度制御付き噴射

ASController.Diffuse(int durationMillisecs, List<AromaPort> ports, int boosterIntensity, int fanIntensity, string shooterName);

c. 接続されたアロマシューター全て特定のポートなど噴射停止

ASController.Stop(int[] ports, bool stopBooster, bool stopFan);

stopBooster が true の時 booster が停止されます。 stopFan が true の時外部について いるファンが停止されます。

d. アロマシューターの名前を指定して特定のポートなど噴射停止

ASController.Stop(string shooterName, int[] ports, bool stopBooster, bool stopFan);	

問題が発生したり、新機能が必要な場合は、新しい問題を作成してください。

ライセンス

こちらを参照してください。