開発を始める

概要

  • Node.jsにおいて、JINS MEMEと通信を行うSDKです。
  • Electronのmainプロセスにも配置できるよう、インタラクションが必要な部分はイベントハンドラを使用しています。
  • 複数台のJINS MEMEとの通信に対応しています(6台の同時通信まで確認済み@Windows10)。

License

JINS MEME 利用規約に準じます。

Samples

JinsMemeSDK-Samples-NodeJSに動作サンプルがあります。

SDK使用前の手続き

アプリID / アプリSecret の取得

JINS MEMEのアプリケーションを開発、配布するためにはアプリID / アプリSecretを取得する必要があります。JINSアカウントを作成して、アプリを作成してください。取得したアプリID / アプリSecretをsetAppClientIdの引数にセットする必要があります。この認証をおこなわない限り、MEMELibと接続できません。

Prerequisites 依存するライブラリ

以下のパッケージに依存しています。nobleかnoble-uwpはどちらかを使用してください。

  • noble
    • Mac/LinuxのBLEライブラリ
    • MIT License
    • ^1.9.1
  • noble-uwp
    • Windows10(Fall creators update以降)のBLEライブラリ
    • MIT License
    • ^0.6.2
  • node-rest-client
    • SDK認証の通信に必要なライブラリ
    • MIT License
    • ^3.1.0

インストール

npm i jinsmemesdk-node-noble(-uwp) 基本的にはMacを使用するときはjinsmemesdk-node-noble、WIndows10から利用するときはjinsmemesdk-node-noble-uwpをご利用ください。

動作の流れ

以下が最小限の実行シーケンスとなります

  • requireによるjinsmemesdk-node-noble(-uwp)の読み込み
  • setAppClientID によるアプリ認証を実行
  • memeDeviceインスタンスの作成
  • scanによるMEMEの検索
  • connectによるMEMEへの接続
  • startDataReport/stopDataReportによるデータの受信開始/終了
  • disconnectによるMEMEとの切断

scanAndConnectでscan~connect部分を連続処理することも可能です