準備する

このチュートリアルでは、以下の手順で開発環境の準備を行います。

  1. サーバー側の設定を変更する

  2. ローカルPCに開発用のワークスペースを作成する

  3. ビジュアルパーツをローカルサーバーでホストする

  4. サンプルビジュアルパーツの動作を確認する

サーバー側の設定を変更する

注釈

  • 既に設定が変更されている場合は、この手順は必要ありません。

  • Data Visualizerのサーバー側の設定変更は、サーバー運用担当者が行います。アプトポッドにて運用を行っているサーバーの場合は、アプトポッドが設定を行いますのでご依頼ください。

開発中のビジュアルパーツをData Visualizerに表示できるように、サーバー側の設定を変更します。

これにより、Data Visualizerに、 plg (Visual Parts Plugin Settings)ボタンが表示され、ローカルサーバーでホストされているビジュアルパーツを読み込むことができるようになります。

  1. sshを使ってintdashサーバーに接続し、Data Visualizerの設定ファイル /etc/vm2m-dataviz-backend/vm2m-2nd-config.production.json を以下のように編集します。

    設定ファイルはJSON形式です。編集する際は末尾カンマの付け忘れや消し忘れに注意してください。

    {
      ...
      "devTools": {
        "showVisualPartsPluginSettings": true  <--
      },
      ...
    }
    

    注釈

    サーバー側の showVisualPartsPluginSettings の設定は、ビジュアルパーツ開発を行う環境でのみtrueにしてください。

  2. 設定変更を反映するため、以下のコマンドを実行し、Data Visualizerアプリケーションを再起動します。

    # systemctl restart vm2m-dataviz-backend
    

    以上でサーバー側の設定は完了です。

  3. ローカルPCのウェブブラウザーでData Visualizerを開き(すでに表示されている場合は再読み込みを行い)、画面の左側に plg (Visual Parts Plugin Settings)ボタンが表示されていることを確認します。

    ../_images/visual-parts-plugin-settings-displayed.png

    図 4 Visual Parts Plugin Settings

ローカルPCに開発用のワークスペースを作成する

ワークスペース作成ツール data-viz-create-visual-parts-react を使って開発用のワークスペースを作成します。

注釈

ビジュアルパーツを開発する際に data-viz-create-visual-parts-react を使用することは必須ではありませんが、使用すると効率的に開発を進めることができます。 本ドキュメントでは、このツールを使って開発手順を説明します。

  1. ローカルPCの任意の場所で以下のコマンドを実行します。 <workspace-directory> には、作成したいワークスペースのディレクトリパスを指定してください。

    $ npx @aptpod/data-viz-create-visual-parts-react -o <workspace-directory>
    

    これにより、 <workspace-directory> にワークスペースが作成され、サンプルファイルが展開されます。

  2. ワークスペースに移動します。

    $ cd <workspace-directory>
    

    ワークスペースに以下のようなディレクトリとファイルが作成されていることを確認してください。

    README.md
    package.json
    package-lock.json
    src/
    configs/
    tsconfig.json
    ...
    
  3. 必要なパッケージをインストールします。

    $ npm ci
    

    これにより、ワークスペースの node_modules ディレクトリ内に、 SDKの本体である data-viz-visual-parts-sdk や、その他の必要なパッケージがインストールされます。

ビジュアルパーツをローカルサーバーでホストする

開発中のビジュアルパーツをホストするローカルサーバーを起動し、Data Visualizerからローカルサーバーにアクセスします。

  1. ワークスペースで以下のコマンドを実行してサーバーを起動します。

    $ npm run start
    

    ローカルサーバーが正しく起動すると、ローカルサーバーのURLが表示されます。

    --------------------------------
    
    Set the Plugin URL under development to Visual M2M Data Visualizer.
    Please set the following URL in Local Plugin URL Settings of Function Menu.
    
    - http://localhost:8080/app.js
    
    --------------------------------
    
  2. ウェブブラウザーでData Visualizerを開き、 plg をクリックします。

  3. ローカルサーバーのURL( http://localhost:8080/app.js )を入力し、[Save]をクリックします。

    ../_images/visual-parts-plugin-settings.png

    図 5 ローカルサーバーのURLを設定する

    以降、ローカルPCのウェブブラウザーでは、ローカルサーバーでホストされているビジュアルパーツを使用できます。

  4. Data Visualizer画面下部の[Visual Parts]をクリックし、ビジュアルパーツ一覧の最後に、付属するサンプル (Sampleグループ)が表示されることを確認してください。

    ../_images/sample-visual-parts.png

    図 6 使用できるビジュアルパーツのリスト

サンプルビジュアルパーツの動作を確認する

上記手順により読み込まれたビジュアルパーツは、標準のビジュアルパーツと同じように使用することができます。

注釈

ビジュアルパーツをパネルに設置する方法や、データのバインド方法など、ビジュアルパーツの一般的な使用法については、 Data Visualizer操作マニュアル を参照してください。

ここでは、準備が正しく完了していることを確認するため、例として、ワークスペースに添付されているサンプルビジュアルパーツ「Sensor Value」を画面に配置し、iOSアプリintdash Motionから送信されるリアルタイムデータを表示します。

注釈

付属するサンプルビジュアルパーツの詳細については 付属するビジュアルパーツのサンプルについて を参照してください。

ビジュアルパーツをData Visualizer上に配置する

サンプルビジュアルパーツを画面に配置します。

  1. 任意のブランクパネルをクリックして、[2 x 2]をクリックします。

    ../_images/2x2.png

    図 7 パネルを選択する

  2. ビジュアルパーツの選択画面で、[Sample] → [Sensor Value]を選択します。

    ../_images/select-sensor-value.png

    図 8 [Sensor Value]を選択する

データをバインドする

表示したい時系列データをビジュアルパーツにバインドします。

注釈

以下の手順では、iOSアプリ「intdash Motion」から送信されるリアルタイムデータをData Visualizerで表示します。

intdash MotionのデータをData Visualizerで表示するには、Data Settingsに「General Sensor CH001」の設定が読み込まれている必要があります。 Data Settingsに「General Sensor CH001」が表示されない場合は、以下の手順でインポートしてください。

  1. config (Config)→ [Download DAT File] をクリックします。

  2. general_sensor_ch001.dat をダウンロードします。

  3. data-settings (Data Settings)→ [Import]をクリックし、 general_sensor_ch001.dat を選択します。

  1. iOSデバイスでintdash Motionを起動し、エッジアカウント(例: test_device_1 )を使ってログインします。

    ../_images/sign-in-motion.jpeg

    図 9 intdash Motionでログインする

  2. Data Visualizer上に配置したSensor Valueビジュアルパーツのタイトル部分をクリックしてPanel Settingsを開きます。 intdash Motionのエッジ(ここでは test_device_1 )の「1_0001.ax」(X軸方向加速度)をバインドします。

    ../_images/bind-data.png

    図 10 データをバインドする

  3. intdash Motionの設定画面で、センサーデータをチャンネル1で送信するように設定し、▶をタップしてデータの送信を開始します。

    ../_images/start-motion.jpeg

    図 11 intdash Motionからデータを送信する

  4. Data Visualizerでライブ表示にします。

    以下のようにX軸方向加速度がビジュアルパーツに表示されます。

    ../_images/sensor-value.png

    図 12 Sensor Valueの表示

    ビジュアルパーツにデータが表示されれば、ワークスペースの準備とサーバー側の設定がいずれも正しく完了していたことになります。

  5. ローカルサーバーを起動したターミナルでCtrl+Cを入力し、ローカルサーバーを終了します。

次の手順 ビジュアルパーツを実装する に進んでください。