Sony MESHのカスタムタグの作り方（複数タグの識別）

# はじめに
この記事は[Aizu Advent Calendar 2020](https://adventar.org/calendars/5037) 21日目の記事です。今回は[Sony MESHタグ](https://meshprj.com/jp/) （以下MESH）で取得したデータを[Firebase Realtime Database](https://firebase.google.com/docs/database?hl=ja)に保存しようとしたときの話です。序盤はカスタムタグの作り方から始めています。タグの識別を読みたい方はタグの識別まで読み飛ばしてください。

# 背景
普通であれば、[IFTTT](https://ifttt.com/)のWebhookあたりを使ってMESHで取得した情報をFirebase Realtime Databaseに保存することが出来ると思うのですが、うまくいかず困っていました。このような経緯があり、題目の通りMESHのカスタムタグを使ってデータを保存することとなりました。（最近のMESHアプリはボタンの反応が遅かったりiPad Proを使っているせいか画面比がおかしかったり不具合多めです。←これ僕だけ？）

# 実装のイメージ

![IMG_C48C04F1A00F-1.jpeg](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/571670/c404581a-d31e-8e82-becd-3d5411425613.jpeg)
上のようなレシピがあったとして（右側が今回作成するカスタムタグ）、人間をタグが感知したらデータベースに保存するようにしています。

![スクリーンショット 2020-12-20 10.45.56.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/571670/f73c5ae4-fb72-e297-8d53-e17d59423d35.png)
結果としてデータベースには、上のようなデータが追加されていることがゴールとなります。

# カスタムタグの作り方
MESH SDK上でカスタムタグを作るのですが、詳しくは[リファレンス](https://meshprj.com/sdk/doc/ja/)を参照してください。今回は人感タグの情報をデータベース保存するためのタグの作り方を簡単に以下に示します。（MESH SDKの登録は既に完了している前提。）

## 1. 新規タグ作成
![スクリーンショット 2020-12-20 11.01.10.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/571670/3d151dd3-e857-32b4-faf8-083f6085b31f.png)
上のボタンを押してタグを新しくタグを作成しましょう。
## 2. タグ名、説明などを記入
ここを
![スクリーンショット 2020-12-20 12.46.05.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/571670/56e525da-1c68-df33-09c3-87f308f5e100.png)
こんな感じで書いてください。New Blockがタグ名でNew Functionが関数名になります。アイコンなども自由に設定出来ます。自分が分かるようなものであれば、なんでも大丈夫です。
![スクリーンショット 2020-12-20 12.48.59.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/571670/c8faf9bd-59a8-12e5-8880-f1758a43f623.png)

## 3. コネクタを設定する
human_FBのタブを開いて、ConnectorのInput Conncetorを(1)にしましょう。緑色のプラスボタンで追加出来ます。これでセンサーなどの他のタグからの連結を可能にします。
![スクリーンショット 2020-12-20 12.58.17.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/571670/af91067c-0666-5db2-292f-16b5d9996036.png)

## 4. コードを書く
CodeのExecuteの部分にソースコードを書きましょう。言語はjsです。
![スクリーンショット 2020-12-20 13.02.21.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/571670/755a0d83-eee6-f0bc-9cbd-f7a7811310aa.png)
以下はajaxを利用してタグから取得した情報をデータベースに送信するコードです。書き慣れていないjsなので変なコードかもしれませんが、とりあえずこれで送れます。

```js:
var apiURL = "URL";
 
//APIを叩く際のパラメータ
//プロパティの値を渡す
var data = {
	"type": "human",
    "humanValue" : messageValues.stateValue
};
 
ajax ({
    url : apiURL,
    data : JSON.stringify( data ),
    type : "post",
	contentType : "application/json",
    dataType : "json",
    timeout : 5000,
    success : function ( contents ) {
        log("Done");
    },
    error : function ( request, errorMessage ) {
        log("Error");
        runtimeValues.outputIndex = -1;
        callbackSuccess( {
            resultType : "continue",
            runtimeValues : runtimeValues
        } );
    }
});
```
これでカスタムタグが完成しました。最後にSaveしてください。

# カスタムタグを応用したレシピ
以下が先ほどの手順で作成したカスタムタグを利用したレシピです。人感タグの他に明るさタグや温湿度タグ、GPIOタグなどの情報もデータベースに保存するレシピになっています。明るさタグや温湿度タグ、GPIOタグなどのカスタムタグは人感タグと中身は基本一緒ですが、タグからデータを取り出す処理だけそれぞれ異なります。

![IMG_83B328F1C5C5-1.jpeg](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/571670/089d199e-8399-0be5-a1ee-75362f15873c.jpeg)

## このレシピの問題点
このレシピはそれぞれのタグに合ったカスタムタグを用意しなければならないという問題点を抱えています。目的は、データベースにデータを保存することなのに同じ目的を持ったカスタムタグが５つもあるなんて変ですよね。そこで一つのカスタムタグに集約する方法を考えましょう。先ほどのタグを改良します。


### タグの識別
タグの識別はReceiveで行います。厳密に言うと、Receiveで入力コネクタの識別を行い、入力を受け取ったコネクタの番号に応じてタグへの情報アクセスの処理を切り替えます。
![スクリーンショット 2020-12-20 13.28.38.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/571670/faa192d2-fda7-28aa-3443-33ae315ec39f.png)
### コネクタを増やす
先ほどConnectorで設定したInput Conncetorを(６)にしましょう。（上のレシピの場合）Input label(Optional)の部分にラベルを設定してあげると分かりやすいでしょう。
![スクリーンショット 2020-12-20 13.37.02.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/571670/171ca19e-50f7-f4d9-ee44-b187b74b9b89.png)

### Initializeの部分に書くコード
CodeのInitializeの部分に以下のコードを記述してください。

```js:
// 変数を定義して初期化する
return {
    runtimeValues : { 
        // 入力receive内のindexを保存する変数
		input_id : 0,
        // 取得した情報を保管する変数
		num : 0
	} 
}
```

### Receiveの部分に識別を行うコードを書く
CodeのReceiveの部分に以下のコードを記述してください。

```js:
input_id = index;
if ( index == 1 ) {     //2番目のコネクタから入力（Temperature ）
	num = messageValues.temperatureValue;
} else if ( index == 2 ) {     //3番目のコネクタから入力（brightness）
	num = messageValues.brightnessValue;
} else if ( index == 3 ) {     //4番目のコネクタから入力（humidity ）
	num = messageValues.humidityValue;
} else if ( index == 4 ) {     //5番目のコネクタから入力（human）
	num = messageValues.stateValue;
} else if ( index == 5 ) {     //6番目のコネクタから入力（bright2）
	num = messageValues.brightnessValue;
}
```

### Executeの部分に書くコード
CodeのExecuteの部分に以下のコードを記述してください。

```js:
var apiURL = "URL";

if (input_id == 0 ) {     //1番目のコネクタから入力（GPIO）
    var data = {
		"type": "water_plant",
    	"brightnessValue" : 1
	};
} else if (input_id == 1 ) {     //2番目のコネクタから入力（Temperature ）
    var data = {
		"type": "temp",
		"tempValue":num
	};
} else if (input_id == 2 ) {     //3番目のコネクタから入力（brightness）
    var data = {
		"type": "bright",
    	"brightnessValue" : num
	};
} else if (input_id == 3 ) {     //4番目のコネクタから入力（humidity ）
    var data = {
		"type": "humi",
		"humiValue":num
	};
} else if (input_id == 4 ) {     //5番目のコネクタから入力（human）
    var data = {
		"type": "human",
		"humanValue" : num
	};
} else if (input_id == 5 ) {     //6番目のコネクタから入力（bright2）
    var data = {
		"type": "bright_h",
   		 "brightnessValue" : num
	};
}

 
ajax ({
    url : apiURL,
    data : JSON.stringify( data ),
    type : "post",
	contentType : "application/json",
    dataType : "json",
    timeout : 5000,
    success : function ( contents ) {
        log("Done");
    },
    error : function ( request, errorMessage ) {
        log("Error");
        runtimeValues.outputIndex = -1;
        callbackSuccess( {
            resultType : "continue",
            runtimeValues : runtimeValues
        } );
    }
});
```

###  カスタムタグを応用したレシピ改良版

こちらが上の改良を施した結果、完成したカスタムタグです。最初のレシピと比較してシンプルで無駄のない構造になっています。
![IMG_E0D7A902CCA2-1.jpeg](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/571670/d4a01bbd-d9e5-a597-d324-9ebb372a3651.jpeg)

# まとめ
カスタムタグは大きく、Initialize,Receive,Execute,Resultに別れていますがそれぞれに処理を加えることで様々な動作を実装することが出来るようになりました。これまで、ReceiveとExecuteぐらいしか処理を書かなかった人もぜひ試してみてください。世界が広がります。

# 参考リンク
・[Sony MESH タグ](https://meshprj.com/jp/)
・[Mesh SDK リファレンス](https://meshprj.com/sdk/doc/ja/)