機械属性APIの使用方法

マシン属性APIの使い方

Node-RED、Python、その他のサービスからのデータを使用してTulip Machineを作成します。

:::(Info) (注意）上級者向け記事 - REST APIの使用経験があることが前提です。ここをクリックして、Machines APIドキュメントをご覧ください：

要約

Machine Attributes API を使用すると、/attributes/reportエンドポイントを使用して、RESTful API 経由でマシンの特定の属性にデータを送信できます。これにより、Node-RED、Python、または他の言語やサービスからTulipと統合するための多くの柔軟なオプションが可能になります。

マシンAPIのセットアップ

注：すでにTulipテーブルAPIを設定している場合は、そのAPIキーとシークレットを使用できます。

1. 設定 > APIトークンに移動します**。**
2. 画面右上の「Create API Token」をクリックします。
3. APIトークンに名前を付け、スコープに**attributes:writeを**選択します：

1. API Key、Secret、Auth Headerを含むモーダルが表示されます。この情報は二度とアクセスできないので、保存してください！

これでMachine APIの正式なセットアップが完了です！

新しいマシンのセットアップ

Machine APIをセットアップすると、インスタンスに新しいMachine Data Sourceが表示されます。このデータソースを表示するには、[Shop Floor] >[Machines] をクリックし、[Machine Data Sources] に移動します：

このデータソースにリンクされた新しいマシンを作成する必要があります。新しいマシンを作成するには、Machine Libraryに移動し、Create Machineをクリックします。

以下のモーダルが表示されます：

1. マシン名（必須）：マシンの名前
2. マシン・データ・ソース（必須）：Tulip APIを選択します。
3. ステーション（オプション）
4. タイプ（必須）：この例では、作成されたタイプはdefaultという名前です。

これでマシンが作成されたので、属性を追加する必要があります。画面右上のEditをクリックしてください。次に画面右上の＋ボタンをクリックする：

マシン属性がまだ作成されていないので、青字のマシンタイプを押してください。

これでマシンに関連するマシン・タイプが表示されます。画面右上の*Edit（編集）*ボタンを押す。

次に、左下隅にある機械属性の隣にある+ボタンを押す。

次に、右下隅にある***+ Create Machine Attributeを***押します。

この例では、Integer タイプのCounter属性を作成します。

属性が作成されたら、マシン属性のリストでCounterAttributeをクリックし、右上のsaveを押す。

マシン・ページに戻る。

マシン属性が作成されたので、それをマシンに追加することができます。右上の*Edit（編集）ボタンを押してください。次に、右上の*+ボタンをクリックし、今作成したカウンター**属性を選択します：

右上の**「保存**」をクリックしてください。

これで、TulipインスタンスがマシンAPI、マシン、マシン属性でセットアップされました。これで、どこからでもTulipマシンにデータを送信できるようになりました！

ここから、カウンター属性のattributeIdと machineIDを見ることができます。この情報はアイコンをクリックすることでコピーでき、httpリクエストのボディで使用されます。

これを行うには、REST APIに精通している必要があります。クエリ・パラメータやボディ・フォーマットを含む、/attributes/reportエンドポイントの使用方法に関する完全なドキュメントは、your-company.tulip.co/apidocsにあります。

... ドキュメントには、マシン・モニタリングのセクションがあります。

さらに読む

APIをさらに発展させ、Edge MCやNode-REDでどのように利用できるかを確認したい場合は、こちらの記事をご覧ください！