はじめに
2020/11/12に開催されたSORACOM UG Online #2にて、SORACOM LTE-M Button for Enterprise(通称しろボタン)から送られるデータにタグ情報つけたい、という話をされていました。それは以前はできなかったのですが、現在はデータをSORACOMプラットフォーム内で加工できるSORACOM Orbitで対応可能になっています。
対応するWASMを作ったので紹介しておきます。
使い方
こちらのGitHubのリポジトリに簡単な対応コードを置いておきました。
https://github.com/1stship/AddTagsSoralet
これをビルドしても良いのですが、幸いSORACOM OrbitおよびWASMはコンパイル済みの生成物をアップロードすれば動作するようになっていますので、使うだけなら各自の環境でビルドする必要はありません。
以下に手順を記載いたします。
- WASMをダウンロード
- Soralet作成、WASMアップロード
- SIMグループ作成、設定
- SIMにグループとタグを設定
それぞれ説明します。
1. WASMをダウンロード
以下のURLからaddtags.wasmをダウンロードします。
https://github.com/1stship/AddTagsSoralet/releases/download/0.0.1/addtags.wasm
2. Soralet作成、WASMアップロード
基本的には以下のページに記載されている手順です。
https://dev.soracom.io/jp/orbit/deployment/
Soralet管理を開く
新規作成をクリックし、適当なSORALET IDを入力して作成をクリックする
新しいWASMをアップロードをクリックし、ファイルを選択をクリックしダウンロードしたWASMを選択し、アップロードをクリックする
SoraletとWASMの準備はこれで終わりです。
3. SIMグループ作成、設定
基本的には以下のページに記載されている手順です。
https://dev.soracom.io/jp/orbit/running/
SIMグループを選択、もしくは新規作成します。
SORACOM Air for Cellular設定のメタデータをONにします。
SORACOM Air for Cellular設定のバイナリパーサーをONにし、フォーマットに@buttonを指定して保存します。
SORACOM OrbitをONにし、CODE SRNにてアップロードしたSORALET、VERSIONは$LATESTとして選択します。DIRECTIONはUplinkにチェック、メタデータをONにして保存します。
連携するアプリケーションサービス(Beam/Funnel/Funk/Harvest Dataのいずれか)をONにします。今回はひとまずHarvest DataをONにします。
SIMグループの設定はこれで終わりです。
4. SIMにグループとタグを設定
SIM管理画面にて対象のボタンのSIMをチェックし、詳細をクリックしてダイアログを表示する。ダイアログにてグループを3. にて設定したグループに変更する。「tags」というタグを追加し、その中にボタンデータに追加したいタグ名をカンマ区切りで設定する。その他必要なタグを設定する。
使い勝手を考えると設定されているタグ全てが自動的にデータにつくようにしたかったのですが、SORACOM OrbitのSDKではタグ名を指定して取得する方法しか提供されていなかったため、ひとまず取得すべきタグを指定する方法としました。また、SIM名をデータに追加したい場合は「name」というタグ名を指定すればよいです。
これで設定は終了です。
動作確認
ボタンをシングルクリックしてHarvest Dataを確認すると、ボタンデータと一緒に指定したDSNとLocationが入っていることが確認できました。
コード
WASMのコードは以下になります。
詳細はGitHubのリポジトリをご確認ください。
https://github.com/1stship/AddTagsSoralet
#include <cstdlib>
#include <string>
#include <sstream>
#include <vector>
#include <emscripten.h>
#include "soracom/orbit.h"
#include "nlohmann/json.hpp"
using nlohmann::json;
int32_t uplink_body();
extern "C" {
EMSCRIPTEN_KEEPALIVE
int32_t uplink() {
return uplink_body();
}
}
std::string get_tag(const std::string& tag_name) {
const char* tag_value = NULL;
size_t tag_value_len = 0;
int32_t err = soracom_get_tag_value(tag_name.c_str(), tag_name.size(), &tag_value, &tag_value_len);
if (err < 0) {
return "";
}
return std::string(tag_value);
}
std::vector<std::string> split(std::string& input, char delimiter)
{
std::istringstream stream(input);
std::string field;
std::vector<std::string> result;
while (getline(stream, field, delimiter)) {
result.push_back(field);
}
return result;
}
int32_t uplink_body() {
const char* buf = NULL;
size_t siz = 0;
int32_t err = soracom_get_input_buffer_as_string(&buf, &siz);
if (err < 0) {
return err;
}
json j = json::parse(buf);
soracom_release_input_buffer(buf);
std::string tagNames = get_tag("tags");
std::vector<std::string> tags = split(tagNames, ',');
for (int i = 0; i < tags.size(); i++){
std::string tagName = tags.at(i);
std::string tagValue = get_tag(tagName);
j[tagName] = tagValue;
}
std::string output = j.dump();
soracom_set_json_output(output.c_str(), output.size());
return 0;
}
今回はとりあえずタグだけ入れていますが、コードを追加すればIMSI、ユーザーデータ、簡易位置測位機能の位置をデータに入れることも可能です。
また、ボタン以外のデバイスでも同じように使えます。やっていることはJSONに追加しているだけなので。
おわりに
SORACOM Orbitで今までできなかった色々なことができるようになりましたね。
また、汎用的な用途であれば自分でコード書かなくても、だれかが用意したWASMをそのまま使う、というやり方もできそうです。
無料ではないのでその点はご注意を(料金はこちらでご確認ください。 https://soracom.jp/services/orbit/price/)