Gravio Action Component Reference

This document explains the functionality and usage of various action components available in the Gravio platform. Each component has specific functions and can be combined in action flows to perform various tasks such as sensor data processing and integration with external services.

Table of Contents

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

Amazon Nova

The Amazon Nova component uses Amazon Nova LLM hosted on AWS Bedrock to return model-generated messages. It can analyze text, images, and video files.

Properties

Amazon Polly Speech

Amazon Polly converts input text to speech and plays it as audio.

Properties

Note: ValidationException will occur if the voice engine does not support Neural Engine (NTTS).

Aqara Smart Plug

This component allows you to turn Aqara smart plugs On/Off.

Output Payload

Properties

AWS S3 Download

This component can be used to download files from AWS S3 when you want to use files in HubKit. Files are saved in the Action Manager's Data directory.

Properties

*Note: If no file path is specified, the file save destination is actmgr/data.

AWS S3 Upload

AWS S3 Upload uploads files to Amazon S3. Files in the action's data folder are the target.

Properties

BindingOnOff

You can change the binding settings of devices connected to areas/layers at the time of action execution.

Properties

Box Download

The Box Download component allows you to download files from Box.

Output Payload

Properties

Component Variables

Box List

The Box List component allows you to retrieve a list of files from Box.

Output Payload

File list is output.

Box List output Payload example:

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

Properties

Box Upload

The Box Upload component allows you to upload files to Box.

Output Payload

Properties

Component Variables

BrightSign

The BrightSign component allows you to send commands to BrightSign.

Output Payload

Properties

Call

The Call component executes another action and continues the current action after execution. It allows you to reuse previously created actions.

Properties

The action ID is the action filename without the extension (.acs).

Call If

The Call If component executes another action based on a condition and continues the current action after execution. It allows you to reuse previously created actions.

Properties

Condition examples: - Numeric Payload: cv.Payload > 10 - String: cv.Payload =~ "^abc" - JSON array: cv.Payload[1] > 10 - JSON Object: cv.Payload.key1 == "abc"

The action ID is the action filename without the extension (.acs).

Camera Take Photos

You can save photos from connected cameras at the time of action execution. Please check the physical device ID of the connected camera in the device list beforehand.

Output Payload

Properties

*Note: Component execution requires time equal to count × interval, so avoid settings that result in very long times.

Camera Take Video

You can save videos from connected cameras at the time of action execution. Please check the physical device ID of the connected camera in the device list beforehand.

Output Payload

Properties

Chatwork

The Chatwork component allows you to post messages to Chatwork.

*Note: To use the Chatwork component, an administrator must configure service integration and obtain an API token.

Properties

*Note: If both text and file are specified, both text and file will be sent.

Chromecast

The Chromecast component plays videos and audio specified by the Filename property on Chromecast devices.

Properties

Claude

The Claude component integrates with AI functionality provided by Anthropic.

*Note: To use this Claude component, you need to obtain an API Key in advance to call Anthropic's AI functionality.

Properties

Output Payload

Output Component Local Variables

CSV File Write

CSVFileWrite generates CSV from input payload as input. Interprets input payload as one record and saves. With the append property, data can be appended on each action execution. Therefore, header output is not performed.

Input Payload

Properties

CSV Read

The CSV Read component takes CSV data as input, parses it, and creates output payload in the format specified by the "Output Format" component property.

Output Payload

Properties

CSV Write

CSVWrite generates CSV from input payload. Accepts input payload as array of JSON arrays or array of JSON Objects.

Input Payload

The "Output Destination" property allows selecting file or payload as output destination.

Output Payload

Properties

Exec

The Exec component allows you to execute OS standard scripts. When HubKit is running on Windows, batch files and programs callable from command line can be executed. When running on Linux or Mac, shell scripts and programs callable from command line can be executed.

Properties

Execute Inference Model

You can execute inference on photos by specifying a deployed image inference file.

Output Payload

Properties

Filter

Used to extract only results matching conditions from inference results:

Transform

Used to transform inference results:

Draw

Used when saving inference results as image:

File Copy

Component that copies files specified by the filename property.

Properties

File Delete

The File Delete component deletes files in the specified directory.

Output Payload

Properties

File List

The File List component retrieves a list of files in the specified directory.

Output Payload

Directory contents have the following data:

Properties

File Read

The FileRead component reads the file specified by the Filename property and outputs it as a stream.

Output Payload

Properties

File Rename

Component that renames files specified by the filename property.

Properties

File Write

The File Write component writes contents passed in input payload to a file.

Output Payload

Properties

Filter

The Filter component filters data from input payload and outputs to output payload for the next component.

You can input a condition expression to determine whether to pass action processing. When true, passes through; when false, does not pass. When not passing, action terminates.

Properties

When Condition Type is "Expression"

Condition examples: - Numeric Payload: cv.Payload > 10 - String: cv.Payload =~ "^abc" - JSON array: cv.Payload[1] > 10 - JSON Object: cv.Payload.key1 == "abc"

Component Local Variables Available in Expression

GCS Download

The GCS Download component can receive data from Google Cloud Storage as a file. Using this component requires a Google Cloud contract and pre-configuration.

Properties

GCS Upload

The GCS Upload component can send data to Google Cloud Storage as a file. Using this component requires a Google Cloud contract and pre-configuration.

Properties

Gemini

The Gemini component allows you to use Gemini including VQA functionality. You can do the following:

Get answers based on user messages

• Specify a model and enter system instructions and user messages to get answers.

Get answers by analyzing photos and video files

• Specify photos/video files and a model, then get answers analyzing photos/videos based on system instructions and user messages.

Output Payload

Component Properties

Supported MIME Types

Image types: - PNG – image/png - JPEG – image/jpeg - WEBP – image/webp - HEIC – image/heic - HEIF – image/heif - WAV – audio/wav - MP3 – audio/mp3 - AIFF – audio/aiff - AAC – audio/aac - OGG Vorbis – audio/ogg - FLAC – audio/flac

Video types: - video/mp4, video/mpeg, video/mov, video/avi, video/x-flv, video/mpg, video/webm, video/wmv, video/3gpp

Text types: - PDF – application/pdf - JavaScript – application/x-javascript, text/javascript - Python – application/x-python, text/x-python - TXT – text/plain - HTML – text/html - CSS – text/css - Markdown – text/md - CSV – text/csv - XML – text/xml - RTF – text/rtf

Component Variables

Go To

The Go To component continues execution in another action. It allows you to reuse previously created actions.

Properties

The action ID is the action filename without the extension (.acs).

Go To If

The Go To If component continues execution in another action when conditions match. It allows you to reuse previously created actions.

You can input a condition expression to determine whether to process another action. When true, executes another action; when false, does not execute. When not executing another action, action processing continues.

Properties

Condition examples: - Numeric Payload: cv.Payload > 10 - String: cv.Payload =~ "^abc" - JSON array: cv.Payload[1] > 10 - JSON Object: cv.Payload.key1 == "abc"

The action ID is the action filename without the extension (.acs).

Google Analytics Send Event

The GoogleAnalyticsSendEvent component sends events using Google Analytics Measurement Protocol.

Output Payload

Properties

GoogleDriveDownload

The Google Drive Download component can download files from Google Drive.

Output Payload

Properties

Component Variables

GoogleDriveList

The Google Drive List component can retrieve a list of files from Google Drive.

Output Payload

Google Drive List output Payload example:

{
  "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
}

Note: For Google Drive directories, "Size" is 0.

Properties

GoogleDriveUpload

The Google Drive Upload component can upload files to Google Drive.

Output Payload

Properties

Component Variables

GPS

You can receive and output GPS data from GPS devices.

Output Payload

When data is RMC:

When data is GGA:

Properties

Gravio Distance

The Gravio Distance component can retrieve measured distance values from Gravio Distance. To use this component, Gravio Distance must be paired in advance.

Output Payload

Properties

Execution Errors

Gravio Matrix

The Gravio Matrix component can set text or images on Gravio Matrix. To use this component, Gravio Matrix must be paired in advance.

Output Payload

Properties

Template Display

HTTP Request

The HTTP Request component allows you to send HTTP requests to specified URLs. The HTTP Request component executes HTTP requests with input payload as HTTP request Body content according to properties, and writes HTTP response Body to output payload.

If

The If component jumps to the specified component when the condition expression evaluates to true.

Properties

Join

The Join component combines multiple input payloads into an array and outputs.

Output Payload

Properties

LINE Notify

The LINE Notify action component can post messages specified in component properties using LINE Notify service.

Properties

LINE Push

The LINE Push action component can post messages from official LINE account specified in properties using LINE Messaging API.

Properties

LINE WORKS

The LINE WORKS component can post messages specified in component properties using LINE WORKS.

Properties

LINE WORKS (API 2.0)

The LINE WORKS (API 2.0) component posts messages to LINE WORKS using API 2.0. It can send text messages, stamps, images, and files.

Properties

Note: Using LINE WORKS API 2.0 requires configuration in LINE WORKS Developer Console and OAuth2 authentication.

Mail Send

The Mail Send component sends email. It sends email with input payload as mail body.

Component Variables

Properties

Microsoft Drive Download

The Microsoft Drive Download component downloads files from Microsoft Drive including OneDrive and SharePoint. Uses OAuth2 Client Credentials.

Properties

Microsoft Drive Upload

The Microsoft Drive Upload component uploads files to Microsoft Drive endpoints including OneDrive and SharePoint. Uses OAuth2 Client Credentials.

Properties

Microsoft Exchange List Events

The Microsoft Exchange List Events component retrieves calendar events from Microsoft Exchange 365 Online. Uses OAuth2 Client Credentials.

Properties

Microsoft Exchange Update Event

The Microsoft Exchange Update Event component updates calendar events on Microsoft Exchange 365 Online. Uses OAuth2 Client Credentials.

Properties

MQTT Publish

The MQTT publisher action component allows you to publish messages to topics within an MQTT PubSub system.

Output Payload

Properties

MSTeams Send Message

The MSTeams Send Message action component can post messages to channels specified in component properties using Microsoft Teams API.

Output Payload

Properties

MySQL Exec

The MySQL Exec component can execute SQL statements against MySQL to update/delete data. Supports MySQL 5.6 and above.

Output Payload

Properties

MySQL Query

The MySQL Query component can execute query statements against MySQL to retrieve data. Supports MySQL 5.6 and above.

Output Payload

Properties

OpenAIAudio

The OpenAIAudio component integrates with AI functionality provided by OpenAI. OpenAIAudio can call the function to transcribe input audio files.

Properties

Output Payload

OpenAIChat

The OpenAIChat component integrates with AI functionality provided by OpenAI. OpenAIChat uses language models specialized for chat completion. It can call chat-based functionality designed to facilitate conversations with multiple exchanges.

Properties

Output Payload

OpenAICompletion

The OpenAICompletion component integrates with AI functionality provided by OpenAI. Returns completions for given prompts. For chat-based functionality, use the OpenAIChat component.

Properties

Output Payload

OpenAIImage

The OpenAIImage component integrates with AI functionality provided by OpenAI. OpenAIImage can call the function to generate images from input prompts.

Properties

Output Payload

Parallel

The Parallel component continues executing the current action while also executing another action. It allows you to reuse previously created actions.

Properties

The action ID is the action filename without the extension (.acs).

Parallel If

The Parallel If component continues executing the current action while also executing another action when conditions match. It allows you to reuse previously created actions.

You can input a condition expression to determine whether to process another action. When true, also executes another action; when false, does not execute another action. When not executing another action, action processing still continues.

Properties

Condition examples: - Numeric Payload: cv.Payload > 10 - String: cv.Payload =~ "^abc" - JSON array: cv.Payload[1] > 10 - JSON Object: cv.Payload.key1 == "abc"

The action ID is the action filename without the extension (.acs).

PATLITE

The PATLITE action component can control lights and play audio on PATLITE network-compatible signal towers. The signal tower must support HTTP commands.

Output Payload

Properties

Philips Hue

This component allows you to change settings for specific Philips Hue lights. You need to specify color and opacity, and set the bridge IP address, user ID, and light ID.

Output Payload

Properties

PostgreSQL Exec

The PostgreSQL Exec component can execute SQL statements against PostgreSQL to update/delete data. Supports PostgreSQL 11 and above.

Output Payload

Properties

PostgreSQL Query

The PostgreSQL Query component can execute query statements against PostgreSQL to retrieve data. Supports PostgreSQL 11 and above.

Output Payload

Properties

Sensor Data DB

The SensorDataDB component can retrieve sensor data stored in Coordinator or HubKit.

Output Payload

Properties

Round Time

Rounds the datetime when component is executed by the specified Timescale (unit of latest data to retrieve), and retrieves data going back by the value specified in From Previous (number to retrieve).

Sensor Data DB If Zero

The SensorDataDBIfZero component outputs input payload as output payload when zero records are found. When one or more records exist, outputs nothing.

Output Payload

Properties

SharePoint Download

The SharePoint Download component downloads files from Microsoft SharePoint sites. Uses OAuth2 Client Credentials.

Properties

SharePoint Upload

The SharePoint Upload component uploads files to Microsoft SharePoint sites. Uses OAuth2 Client Credentials.

Properties

Slack Files Upload

The Slack Files Upload action component can post messages and files to Slack channels specified in component properties using Slack API.

Output Payload

Properties

Slack Files Upload2

The Slack Files Upload action component can post messages and files to Slack channels specified in component properties using Slack API.

Output Payload

Properties

Slack Post Message

The Slack Post Message action component can post messages to Slack channels specified in component properties using Slack API.

Output Payload

Properties

Sleep

The Sleep action component allows you to insert a pause between two steps of an action. The entered number is the time (in milliseconds) the action pauses.

Output Payload

Properties

SORACOMDataPost

The SORACOM Data Post component can send data to SORACOM Harvest.

Input and Output Payload

Properties

Component Variables

SORACOMFileUpload

The SORACOM File Upload component can send files to SORACOM Harvest.

Input and Output Payload

Properties

Component Variables

Sound Effect

You can play sound effects.

Output Payload

Properties

Sound Play

You can play specified mp3 files.

Output Payload

Properties

Split

The Split component splits input payload by newlines if it's a string, or by elements if it's a JSON array, and passes to the next component. The Split component has filter functionality to determine whether to pass split output data to the next component.

You can input conditions as expressions. The following two variables are available in condition expressions for this component:

Condition examples: - Pass only lines (or elements in JSON array) starting with abc to next component: Value =~ "^abc" - Pass only even-numbered lines: Index % 2 == 0

Properties

SQL Server Exec

The SQL Server Exec component can execute SQL statements against SQL Server to update/delete data. Supports SQL Server 2005 and above.

Output Payload

Properties

SQL Server Query

The SQL Server Query component can execute query statements against SQL Server to retrieve data. Supports SQL Server 2005 and above.

Output Payload

Properties

Statistics

The Statistics component adds statistics (Min, Max, Mean/Average, Median, StandardDeviation, Sum, Mode) to component variables for specified values.

Output Payload/Variables

Properties

Template

The Template component generates strings (text) from specified templates. Template syntax follows Go text/template syntax.

Output Payload

Properties

Transform

The Transform component processes Pre Mapping and Post Mapping. It is a dedicated component used for transforming input and output data.

Output Payload

Twilio SMS

The Twilio SMS action component can post messages specified in component properties to mobile phone SMS using Twilio service.

Properties

Write To Excel (365)

The WriteToExcel365 component can output data in Excel format to Microsoft365. Using this component requires a Microsoft365 for Business contract and pre-configuration.

Input Payload

Properties

Write To Excel (Local)

The WriteToExcelLocal component can output data in Excel format to xlsx files.

Input Payload

Properties

Write To GoogleSheets

The Write To GoogleSheets component can output data to Google Spreadsheets. Using this component requires a Google account and pre-configuration.

Input payload (cv.Payload) accepts array of JSON arrays or array of JSON Objects. Otherwise, converts to string and outputs as 1-row, 1-column spreadsheet.

Input Payload Examples

• JSON array payload example: [[123, "abc", "xxx"], [456, "def", "yyy"], [789, "hij", "zzz"]]
• JSON Object payload example: [{"field1": 123, "field2":"abc", "field3":"xxx"}, {"field1": 456, "field2":"def", "field3":"yyy"}, {"field1": 789, "field2":"hij", "field3":"zzz"}]

Properties

Component Variables

Zigbee Light

The Zigbee Light component controls Gravio (Zigbee) Lights that have been paired in advance. It allows turning lights on or off, setting predefined colors (red, yellow, green, blue), and adjusting brightness by percentage. Multiple device IDs can be specified, or all paired lights will be affected if none are configured.

Properties