Soracom

Users

ドキュメント
Home ドキュメント SORACOM Flux (Public beta) はじめに

SORACOM Flux の概要

SORACOM Flux でできること

Flux アプリでは、Flux アプリを起動するトリガーを定義するコンポーネントを「イベントソース」、データを橋渡しするコンポーネントを「チャネル」、データを分析/判断して特定の操作を実行するするコンポーネントを「アクション」と呼びます。アクションの出力データを新たな「チャネル」に送信し、次の「アクション」をそれを繰り返すことで高度な Flux アプリを構築できます。

Flux アプリを構成するコンポーネント

Flux アプリは、SORACOM Flux Studio の [STUDIO] タブで構築します。

SORACOM Flux を構成するコンポーネント SORACOM Flux を構成するコンポーネント

コンポーネント説明
Flux アプリイベントソース、チャネル、アクションを組み合わせて、一連の処理フローが定義された IoT アプリケーションです。
イベントソース

イベントソースは、Flux アプリを起動するトリガーを定義するコンポーネントです。以下のイベントソースが用意されています。

イベントソース説明
IoT デバイスIoT デバイスが Unified Endpoint にデータを送信したときに、Flux アプリが起動します。詳しくは、IoT デバイスイベントソース を参照してください。
SORACOM Harvest FilesSORACOM Harvest Files にファイルをアップロード (保存、更新) したり削除したりしたときに、Flux アプリが起動します。詳しくは、SORACOM Harvest Files イベントソース を参照してください。
タイマー一定の時間間隔で Flux アプリが起動します。詳しくは、タイマーイベントソース を参照してください。
API/マニュアル実行イベントソースに連結したチャネルを表すエンドポイントにリクエストを送信したときに、Flux アプリを起動できます。Incoming Webhook への HTTPS リクエスト、SORACOM API の実行、ユーザーコンソールを操作することによって、イベントメッセージをチャネルに送信できます。詳しくは、API/マニュアル実行イベントソース を参照してください。
チャネル

チャネルは、データを橋渡しするコンポーネントです。チャネルには、複数のアクションを設定でき、同一のデータを複数のアクションの入力データにする役割があります。

すべてのチャネルは、Incoming Webhook を使用して、チャネルにデータを送信できます。詳しくは、Incoming Webhook を使用したデータの送信 を参照してください。

アクション

アクションは、データを分析/判断して特定の操作を実行するコンポーネントです。入力データによってアクションを実行するかどうかを判断したり (アクションの実行条件)、入力データを生成 AI や簡易物体検知で分析できます。また、Slack や LINE Notify、メールで通知する機能もアクションで実行されます。以下のアクションが用意されています。

アクション説明
AI アクションAI モデルとプロンプトを指定し、AI モデルに指示や質問をして、AI モデルからのレスポンスを、次のチャネルに送信します。
SORACOM API アクション指定した SORACOM API を SAM ユーザーの権限で実行します。
Republish アクション入力されたデータを変換して、次のチャネルに送信します。
簡易物体検知アクション静止画に写っている物体を簡易的に検知して、物体に関する情報を、次のチャネルに送信します。
Webhook アクション指定した URL に HTTP リクエストを送信します。
Slack 通知アクション指定された Slack チャンネルにメッセージを送信します。
LINE 通知アクション指定された LINE Notify の URL にメッセージを送信します。
Email 通知アクション指定されたメールアドレスにメールを送信します。

また、アクションの実行結果 (出力データ) を別のチャネルに送信することもできます。

MESSAGE と CONTEXTチャネルに送信されたデータには、MESSAGE と CONTEXT があります。MESSAGE と CONTEXT は 実行履歴 として確認できます。

実行履歴

Flux アプリの実行履歴や、チャネルのメッセージ履歴、アクションの実行履歴を確認できます。詳しくは、実行履歴/メッセージ履歴 (ログ) を確認する を参照してください。

Flux アプリの実行履歴 Flux アプリの実行履歴

Flux アプリに関する制限事項

  • Flux アプリは、カバレッジタイプごとに 3 つまで作成できます。
  • 1 つの Flux アプリには、チャネルを最大で 10 個作成できます。
  • 1 つのイベントでは、10 個のチャネルまでメッセージを送信できます。11 個目のチャネルにメッセージが送信されると当該イベントの処理は停止します。