Gravio アクションコンポーネント リファレンス

このドキュメントは、Gravio プラットフォームで使用できる様々なアクションコンポーネントの機能と使い方を説明します。各コンポーネントは特定の機能を持ち、アクションフローの中で組み合わせることで、センサーデータの処理や外部サービスとの連携など様々な処理を実現できます。

目次

1. Amazon Polly Speech
2. Aqara Smart Plug
3. AWS S3 Download
4. AWS S3 Upload
5. BindingOnOff
6. Box List
7. Box Download
8. Box Upload
9. BrightSign
10. Call
11. Call If
12. Camera Take Photos
13. Camera Take Video
14. Chatwork
15. Chromecast
16. Claude
17. CSV Read
18. CSV Write
19. CSV File Write
20. Exec
21. Execute Inference Model
22. File Copy
23. File Delete
24. File List
25. File Read
26. File Rename
27. File Write
28. Filter
29. GCS Upload
30. GCS Download
31. Google Analytics Send Event
32. GoogleDriveList
33. GoogleDriveDownload
34. GoogleDriveUpload
35. Go To
36. Go To If
37. GPS
38. Zigbee Light
39. Gravio Distance
40. Gravio Matrix
41. HTTP Request
42. Join
43. LINE Push
44. LINE Notify
45. LINE WORKS
46. Mail Send
47. MQTT Publish
48. SQL Server Exec
49. SQL Server Query
50. MSTeams Send Message
51. MySQL Exec
52. MySQL Query
53. OpenAICompletion
54. OpenAIChat
55. OpenAIImage
56. OpenAIAudio
57. Parallel
58. Parallel If
59. PATLITE
60. Philips Hue
61. PostgreSQL Exec
62. PostgreSQL Query
63. Sensor Data DB
64. Sensor Data DB If Zero
65. Slack Post Message
66. Slack Files Upload
67. Slack Files Upload2
68. Sleep
69. SORACOMDataPost
70. SORACOMFileUpload
71. Sound Effect
72. Sound Play
73. Split
74. Statistics
75. Template
76. Transform
77. Twilio SMS
78. Write To Excel (365)
79. Write To Excel (Local)

Amazon Polly Speech

Amazon Pollyは入力テキストをスピーチに変換して音声として再生します。

プロパティ

注意: 音声エンジンがニューラルエンジン（NTTS）に対応していない場合はValidationExceptionが発生します。

Aqara Smart Plug

このコンポーネントでは、Aqaraスマートプラグを On/Offすることができます。

出力ペイロード

プロパティ

AWS S3 Download

AWSのS3にあるファイルを HubKit内で利用したいときに、S3からファイルをダウンロードするときに利用できるコンポーネントです。ファイルは Action ManagerのDataディレクトリに保存されます。

プロパティ

※ファイルパスを指定しないファイルの保存先はactmgr/dataとなります。

AWS S3 Upload

AWS S3 UploadはAmazon S3にファイルをアップロードします。ファイルはアクションのデータフォルダのファイルが対象となります。

プロパティ

BindingOnOff

エリア/レイヤーに接続しているデバイスのバインド設定をアクションの実行タイミングで変更することができます。

プロパティ

Box List

Box Listコンポーネントは、Boxからファイルの一覧を取得することができます。

出力ペイロード

ファイルリストが出力されます。

Box Listの出力Payloadの例:

{
  "Filename": "test.txt",
  "ID": "1365057753092",
  "IsDir": false,
  "ModifiedTime": "2023-11-17T01:20:35-08:00",
  "ParentFolderID": "235207463831",
  "Path": "a/b/test.txt",
  "Size": 6
}

プロパティ

Box Download

Box Downloadコンポーネントは、Boxからファイルをダウンロードすることができます。

出力ペイロード

プロパティ

コンポーネント変数

Box Upload

Box Uploadコンポーネントは、Boxにファイルをアップロードすることができます。

出力ペイロード

プロパティ

コンポーネント変数

BrightSign

BrightSignコンポーネントは、BrightSignにコマンドを送信することができます。

出力ペイロード

プロパティ

Call

Callコンポーネントは別のアクションを実行して、実行後にアクションを継続するコンポーネントです。一度作成したアクションを再利用することができます。

プロパティ

アクションのファイル名の拡張子（.acs部分）を除いた名前がアクションIDとなります。

Call If

Call Ifコンポーネントは条件に合う場合に別のアクションを実行して、実行後にアクションを継続するコンポーネントです。一度作成したアクションを再利用することができます。

プロパティ

条件例：

• Payloadが数値系: cv.Payload > 10
• 文字列系: cv.Payload =~ "^abc"
• JSON配列: cv.Payload[1] > 10
• JSON Object: cv.Payload.key1 == "abc"

アクションのファイル名の拡張子（.acs部分）を除いた名前がアクションIDとなります。

Camera Take Photos

接続されているカメラからアクションの実行タイミングで写真を保存することができます。 事前にデバイス一覧を表示して、接続されているカメラの物理デバイスIDを確認してください。

出力ペイロード

プロパティ

※コンポーネントの実行は枚数×間隔で指定された時間が必要となりますので、あまり長時間になる設定は避けてください。

Camera Take Video

接続されているカメラからアクションの実行タイミングでビデオを保存することができます。 事前にデバイス一覧を表示して、接続されているカメラの物理デバイスIDを確認してください。

出力ペイロード

プロパティ

Chatwork

Chatworkコンポーネントは、Chatworkを使用してコンポーネントのプロパティに指定されたメッセージをポストすることができます。センサーからの情報を人に通知したりすると便利です。

※Chatworkコンポーネントを使用するには、管理者が初期設定としてサービス連携で設定し、APIトークンを取得する必要があります。

プロパティ

※テキストとファイルの両方を指定した場合は、テキストとファイルが送信されます。

Chromecast

Chromecastコンポーネントは Chromecast デバイスでFilenameプロパティで指定されたビデオ、音声を再生するコンポーネントです。

プロパティ

Claude

Claudeコンポーネントは、Anthropic社が提供しているAI機能と連携するコンポーネントです。

※このClaudeコンポーネントを使用するにはAnthropicのAI機能を呼び出すためにAPI Keyを予め取得する必要があります。

プロパティ

出力ペイロード

出力のコンポーネントローカル変数

CSV Read

CSV Readコンポーネントは入力としてCSVデータをとり、これを解析して、「出力形式」コンポーネントプロパティで指定された形式で出力ペイロードを作成します。

出力ペイロード

プロパティ

CSV Write

CSVWriteは入力ペイロードを入力としてCSVを生成します。入力ペイロードはJSON配列の配列か、JSON Objectの配列での入力を受け付けます。

入力ペイロード

「出力先」プロパティによって出力先をファイルかペイロードかを選択できます。

出力ペイロード

プロパティ

CSV File Write

CSVFileWriteは入力ペイロードを入力としてCSVを生成します。入力ペイロードを1レコード分と解釈して保存します。追加プロパティでアクションの実行毎に追記ができます。そのためヘッダ出力はされません。

入力ペイロード

プロパティ

Exec

Execコンポーネントを使用すると、OS標準のスクリプトを実行することができます。HubKitがWindowsで実行されている場合はバッチファイルおよびコマンドラインで呼び出せるプログラム、Linux、Macで実行されている場合はシェルスクリプトおよびコマンドラインで呼び出せるプログラムを実行することができます。

プロパティ

Execute Inference Model

配置している画像推論ファイルを指定して写真に推論を実行することができます。

出力ペイロード

プロパティ

フィルター

推論の結果から条件に合う結果のみを抽出する場合に使用します：

変換

推論の結果を変換する場合に使用します：

描く

推論の結果を画像として保存する場合に使用します：

File Copy

ファイル名プロパティで指定されたファイルをコピーするコンポーネントです。

プロパティ

File Delete

File Delete コンポーネントは指定されたディレクトリにあるファイルを削除します。

出力ペイロード

プロパティ

File List

File Listコンポーネントは指定したディレクトリにあるファイルの一覧を取得します。

出力ペイロード

ディレクトリの内容は以下のデータを持ちます：

プロパティ

File Read

FileReadコンポーネントはFilenameプロパティで指定されたファイルを読み込んでストリームとして出力するコンポーネント

出力ペイロード

プロパティ

File Rename

ファイル名プロパティで指定されたファイルの名前を変更するコンポーネントです。

プロパティ

File Write

File Writeコンポーネントは入力ペイロードに渡された内容をファイルに書き出します。

出力ペイロード

プロパティ

Filter

Filterコンポーネントは入力ペイロードの内容を次のコンポーネントに引き渡すデータをフィルタリングして出力ペイロードに出力するコンポーネントです。

Actionの処理を通過させるかの条件を式で入力することができます。trueの時は通過させ、falseの時は通過しません。通過しない場合はActionは終了します。

プロパティ

条件タイプが”式”の場合

条件例：

• Payloadが数値系: cv.Payload > 10
• 文字列系: cv.Payload =~ "^abc"
• JSON配列: cv.Payload[1] > 10
• JSON Object: cv.Payload.key1 == "abc"

式で使用できる、コンポーネントローカル変数

GCS Upload

GCS Uploadコンポーネントは、データをGoogle Cloud Storageにファイルとして送信することができます。このコンポーネントを使用するには、Google Cloudの契約と事前設定が必要です。

プロパティ

GCS Download

GCS Downloadコンポーネントは、データをGoogle Cloud Storageからファイルとして受信することができます。このコンポーネントを使用するには、Google Cloudの契約と事前設定が必要です。

プロパティ

Google Analytics Send Event

GoogleAnalyticsSendEventコンポーネントを使用すると、GoogleアナリティクスのMeasurement Protocolを使用してイベントを送信します。

出力ペイロード

プロパティ

GoogleDriveList

Google Drive Listコンポーネントは、Google Driveからファイルの一覧を取得することができます。

出力ペイロード

Google Drive Listの出力Payloadの例:

{
  "Filename": "test.txt",
  "ID": "17CMCa4dsNDD6U0duQEBhVI7QZzXqIPYL",
  "IsDir": false,
  "MimeType": "text/plain",
  "ModifiedTime": "2023-09-28T10:33:46.189Z",
  "ParentFolderID": "1-KTO7YslI4iFD-7sxn7CKDNs-UkKMtf8",
  "Path": "a/b/test.txt",
  "Size": 8
}

注意：Google Driveでディレクトリの場合は”Size”は0になります。

プロパティ

GoogleDriveDownload

Google Drive Downloadコンポーネントは、Google Driveからファイルをダウンロードすることができます。

出力ペイロード

プロパティ

コンポーネント変数

GoogleDriveUpload

Google Drive Uploadコンポーネントは、Google Driveにファイルをアップロードすることができます。

出力ペイロード

プロパティ

コンポーネント変数

Go To

Go Toコンポーネントは別のアクションで実行を継続するコンポーネントです。一度作成したアクションを再利用することができます。

プロパティ

アクションのファイル名の拡張子（.acs部分）を除いた名前がアクションIDとなります。

Go To If

Go To Ifコンポーネントは条件に合う場合に別のアクションで実行を継続するコンポーネントです。一度作成したアクションを再利用することができます。

別のアクションの処理をさせるかの条件を式で入力することができます。trueの時は別のアクションを実行し、falseの時は別のアクションを実行しません。別のアクションを実行しない場合はアクションの処理は継続します。

プロパティ

条件例：

• Payloadが数値系: cv.Payload > 10
• 文字列系: cv.Payload =~ "^abc"
• JSON配列: cv.Payload[1] > 10
• JSON Object: cv.Payload.key1 == "abc"

アクションのファイル名の拡張子（.acs部分）を除いた名前がアクションIDとなります。

GPS

GPSデバイスからGPSデータを受信して出力することができます。

出力ペイロード

データがRMCの場合：

データがGGAの場合：

データにGSAが含まれる場合：

プロパティ

用語

• RMS、GGA、GSA: GPSから出力されるNMEAフォーマットのセンテンスの種類のこと。GPSデバイスによってサポートされているセンテンスが異なります。センテンスは他にもGSV、VTGがあります。

• DMM形式: dddmm.mmmmのデータ形式で、dddは度数、mm.mmmmは分数で、60進法ですので60分で1度となります。Googleマップで使用されている ddd.dddd度表記は、(度数 + 分数/60) で計算することが出来ます。

Zigbee Light

Zigbee Lightコンポーネントは、Zigbee LightのOn/Offならびに色と明るさの変更ができます。このコンポーネントを利用するにはあらかじめZigbee Lightをペアリングしておく必要があります。

出力ペイロード

プロパティ

Gravio Distance

Gravio Distanceコンポーネントは、Gravio Distanceから距離を測定した値を取得できます。このコンポーネントを利用するにはあらかじめGravio Distanceをペアリングしておく必要があります。

出力ペイロード

プロパティ

実行エラー

Gravio Matrix

Gravio Matrixコンポーネントは、Gravio Matrixに文字または画像を設定できます。このコンポーネントを利用するにはあらかじめGravio Matrixをペアリングしておく必要があります。

出力ペイロード

プロパティ

テンプレートを使用した表示

HTTP Request

HTTP Requestコンポーネントを使用すると、指定したURLへHTTPリクエストを送信することができます。HTTP Requestコンポーネントは入力ペイロードをプロパティに応じてHTTPリクエストのBodyコンテンツとしてHTTPリクエストを実行し、そのHTTPレスポンスのBodyを出力ペイロードに書き出します。

Content-Typeプロパティによるリクエスト時のBodyの内容

入力と出力のペイロード

プロパティ

コンポーネント変数

Join

Joinコンポーネントは、複数の入力ペイロードを配列にまとめて出力します。

出力ペイロード

プロパティ

LINE Push

LINE Pushアクションコンポーネントは、LINE Messaging APIを使用して、プロパティに指定されたメッセージを公式LINEアカウントからポストすることができます。

プロパティ

LINE Notify

LINE Notifyアクションコンポーネントは、LINE Notifyサービスを使用して、コンポーネントのプロパティに指定されたメッセージをポストすることができます。

プロパティ

LINE WORKS

LINE WORKSコンポーネントは、LINE WORKSを使用してコンポーネントのプロパティに指定されたメッセージをポストすることができます。

プロパティ

Mail Send

Mail Sendコンポーネントは、電子メールを送信します。入力ペイロードをメール本文としてメールを送信します。

コンポーネント変数

プロパティ

MQTT Publish

MQTTパブリッシャー・アクション・コンポーネントを使用すると、MQTT PubSubシステム内のトピックにメッセージをパブリッシュできます。

出力ペイロード

プロパティ

SQL Server Exec

SQL Server Execcコンポーネントは、SQL Serverに対してSQL文を実行してデータを更新/削除することができます。SQL Server 2005以上に対応しています。

出力ペイロード

プロパティ

SQL Server Query

SQL Server Queryコンポーネントは、SQL Serverに対してクエリー文を実行してデータを取得することができます。SQL Server 2005以上に対応しています。

出力ペイロード

プロパティ

MSTeams Send Message

MSTeams Send Messageアクションコンポーネントは、マイクロソフト Teams APIを使用して、コンポーネントのプロパティに指定されたチャネルにメッセージをポストすることができます。

出力ペイロード

プロパティ

MySQL Exec

MySQL Execcコンポーネントは、MySQLに対してSQL文を実行してデータを更新/削除することができます。MySQL 5.6以上に対応しています。

出力ペイロード

プロパティ

MySQL Query

MySQL Queryコンポーネントは、MySQLに対してクエリー文を実行してデータを取得することができます。MySQL 5.6以上に対応しています。

出力ペイロード

プロパティ

OpenAICompletion

OpenAICompletionコンポーネントは、OpenAI社が提供しているAI機能と連携するコンポーネントです。与えられたプロンプトに対する補完を返します。チャットベースの機能はOpenAIChatコンポーネントを使用してください。

プロパティ

出力ペイロード

OpenAIChat

OpenAIChatコンポーネントは、OpenAI社が提供しているAI機能と連携するコンポーネントです。OpenAIChatはチャット補完に特化した言語モデルを使用しています。複数のやりとりをする会話を簡単にするように設計されているチャットベースの機能を呼び出すことが出来ます。

プロパティ

出力ペイロード

OpenAIImage

OpenAIImageコンポーネントは、OpenAI社が提供しているAI機能と連携するコンポーネントです。OpenAIImageは入力されたプロンプトから画像を生成する機能を呼び出すことが出来ます。

プロパティ

出力ペイロード

OpenAIAudio

OpenAIAudioコンポーネントは、OpenAI社が提供しているAI機能と連携するコンポーネントです。OpenAIAudioは入力された音声ファイルから文字起こしを行う機能を呼び出すことが出来ます。

プロパティ

出力ペイロード

Parallel

Parallelコンポーネントは実行しているアクションも継続して実行しながら、別のアクションも実行するコンポーネントです。一度作成したアクションを再利用することができます。

プロパティ

アクションのファイル名の拡張子（.acs部分）を除いた名前がアクションIDとなります。

Parallel If

Parallel Ifコンポーネントは条件に合う場合に実行しているアクションも継続して実行しながら、別のアクションも実行するコンポーネントです。一度作成したアクションを再利用することができます。

別のアクションの処理をさせるかの条件を式で入力することができます。trueの時は別のアクションも実行し、falseの時は別のアクションを実行しません。別のアクションを実行しない場合でもアクションの処理は継続します。

プロパティ

条件例：

• Payloadが数値系: cv.Payload > 10
• 文字列系: cv.Payload =~ "^abc"
• JSON配列: cv.Payload[1] > 10
• JSON Object: cv.Payload.key1 == "abc"

アクションのファイル名の拡張子（.acs部分）を除いた名前がアクションIDとなります。

PATLITE

PATLITEアクションコンポーネントは、パトライト社製のネットワーク対応監視塔のライトを制御したり、音声を再生したりすることができます。監視塔はHTTPコマンドに対応している必要があります。

出力ペイロード

プロパティ

Philips Hue

このコンポーネントでは、特定のPhilips Hueライトの設定を変更できます。色と不透明度を指定し、ブリッジのIPアドレス、ユーザーID、ライトIDを設定する必要があります。

出力ペイロード

プロパティ

PostgreSQL Exec

PostgreSQL Execcコンポーネントは、PostgreSQLに対してSQL文を実行してデータを更新/削除することができます。PostgreSQL 11以上に対応しています。

出力ペイロード

プロパティ

PostgreSQL Query

PostgreSQL Queryコンポーネントは、PostgreSQLに対してクエリー文を実行してデータを取得することができます。PostgreSQL 11以上に対応しています。

出力ペイロード

プロパティ

Sensor Data DB

SensorDataDBコンポーネントは、CoordinatorまたはHubKitに格納されているセンサデータを取得することができます。

出力ペイロード

プロパティ

時間を丸める

コンポーネントが実行された日時を指定されたタイムスケール（取得する最新データの単位）で丸め、From Previous（取得する数）で指定された値分遡ってデータを取得します。

Sensor Data DB If Zero

SensorDataDBIfZeroコンポーネントは１行も検索されなかった場合に入力ペイロードを出力ペイロードとして出力します。１行でもレコードがあった場合は、何も出力しません。

出力ペイロード

プロパティ

Slack Post Message

Slack Post Messageアクションコンポーネントは、SlackAPIを使用して、コンポーネントのプロパティにしてされたSlackチャンネルにメッセージをポストすることができます。

出力ペイロード

プロパティ

Slack Files Upload

Slack Files Uploadアクションコンポーネントは、SlackAPIを使用して、コンポーネントのプロパティにしてされたSlackチャンネルにメッセージとファイルをポストすることができます。

出力ペイロード

プロパティ

Slack Files Upload2

Slack Files Uploadアクションコンポーネントは、SlackAPIを使用して、コンポーネントのプロパティにしてされたSlackチャンネルにメッセージとファイルをポストすることができます。

出力ペイロード

プロパティ

Sleep

Sleepアクションコンポーネントでは、アクションの2つのステップの間にポーズを挿入できます。入力された数字は、アクションが一時停止する時間（ミリ秒）です。

出力ペイロード

プロパティ

SORACOMDataPost

SORACOM Data Postコンポーネントは、SORACOMのHarvestにデータを送信することができます。

入力と出力のペイロード

プロパティ

コンポーネント変数

SORACOMFileUpload

SORACOM File Uploadコンポーネントは、SORACOMのHarvestにファイルを送信することができます。

入力と出力のペイロード

プロパティ

コンポーネント変数

Harvestフォルダ名で使用できるプレースホルダー

Harvestフォルダ名には以下のプレースホルダーが使用できます：

Sound Effect

効果音を鳴らすことができます。

出力ペイロード

プロパティ

Sound Play

指定したmp3ファイルを再生することができます。

出力ペイロード

プロパティ

Split

Splitコンポーネントは入力ペイロードが文字列なら改行毎に、JSON配列なら要素毎に分割して次のコンポーネントに渡すコンポーネントです。Splitコンポーネントでは分割後の出力データを次にコンポーネントに渡すかどうかのフィルタ機能があります。

条件を式で入力することができます。以下の２つの変数がこのコンポーネントの条件式内で利用できます：

条件例：

• abcで始まる行（JSON配列の場合は要素）だけを次のコンポーネントに渡す: Value =~ "^abc"
• 偶数番目の行だけを渡す: Index % 2 == 0

プロパティ

Statistics

Statisticsコンポーネントは、指定された値で統計（最低値(Min)、最高値(Max)、平均(Mean/Average)、中央値(Median)、標準偏差(StandardDeviation)、合計(Sum)、最頻値(Mode)）をコンポーネント変数に付加します。

出力ペイロード・変数

プロパティ

Template

Templateコンポーネントは、指定されたテンプレートから文字列（テキスト）を生成するコンポーネントです。テンプレート構文としてはGoのtext/templateで説明されている構文が利用できます。

出力ペイロード

プロパティ

Transform

Transformコンポーネントは Pre MappingとPost Mappingを処理するコンポーネントです。入力と出力のデータを変換する時に使用する専用のコンポーネントです。

出力ペイロード

Twilio SMS

Twilio SMSアクションコンポーネントは、Twilioサービスを使用して、コンポーネントのプロパティに指定されたメッセージを携帯電話のSMSにポストすることができます。

プロパティ

WhatsAppへのメッセージの送信方法

WhatsApp等へのメッセージ送信の仕様についてはTwilioのProgrammable Messaging APIを参照してください。この機能を利用するには、Twilio Sandbox for WhatsAppを有効にする必要があります。

Write To Excel (365)

WriteToExcel365コンポーネントは、データをExcel形式でMicrosoft365に出力することができます。このコンポーネントを使用するには、Microsoft365 for Businessの契約と事前設定が必要です。

入力ペイロード

プロパティ

Write To Excel (Local)

WriteToExcelLocalコンポーネントは、データをExcel形式でxlsxファイルに出力することができます。

入力ペイロード

プロパティ