Gravio Action 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 within action flows to perform various operations such as processing sensor data and integrating with external services.
Table of Contents
- Amazon Polly Speech
- Aqara Smart Plug
- AWS S3 Download
- AWS S3 Upload
- BindingOnOff
- Box List
- Box Download
- Box Upload
- BrightSign
- Call
- Call If
- Camera Take Photos
- Camera Take Video
- Chatwork
- Chromecast
- Claude
- CSV Read
- CSV Write
- CSV File Write
- Exec
- Execute Inference Model
- File Copy
- File Delete
- File List
- File Read
- File Rename
- File Write
- Filter
- GCS Upload
- GCS Download
- Google Analytics Send Event
- GoogleDriveList
- GoogleDriveDownload
- GoogleDriveUpload
- Go To
- Go To If
- GPS
- Zigbee Light
- Gravio Distance
- Gravio Matrix
- HTTP Request
- Join
- LINE Push
- LINE Notify
- LINE WORKS
- Mail Send
- MQTT Publish
- SQL Server Exec
- SQL Server Query
- MSTeams Send Message
- MySQL Exec
- MySQL Query
- OpenAICompletion
- OpenAIChat
- OpenAIImage
- OpenAIAudio
- Parallel
- Parallel If
- PATLITE
- Philips Hue
- PostgreSQL Exec
- PostgreSQL Query
- Sensor Data DB
- Sensor Data DB If Zero
- Slack Post Message
- Slack Files Upload
- Slack Files Upload2
- Sleep
- SORACOMDataPost
- SORACOMFileUpload
- Sound Effect
- Sound Play
- Split
- Statistics
- Template
- Transform
- Twilio SMS
- Write To Excel (365)
- Write To Excel (Local)
Amazon Polly Speech
Amazon Polly converts input text to speech and plays it as audio.
Properties
| Property Name |
Description |
| Text |
Specify the message text to be spoken |
| Voice |
Specify the type of speaker’s voice. Select a voice type that matches the language of the text |
| Voice Engine |
Choose either Standard or Neural |
| Voice Processing |
Choose either Play or Save to File |
| Filename |
Filename when saving the audio to a file |
| Timeout |
Specify the transmission timeout period |
| Access Key ID |
Access key obtained from AWS |
| Secret Access Key |
Secret access key obtained from AWS |
| Region |
Specify the AWS region to use |
Note: If the voice engine does not support Neural Text-to-Speech (NTTS), a ValidationException will occur.
Aqara Smart Plug
This component allows you to turn Aqara smart plugs On/Off.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the previous component’s output payload as is (pass-through) |
Properties
| Property Name |
Description |
| Basic Properties |
Specify the basic properties in the “Aqara Smart Plug” category |
| Device ID |
Device ID to turn On/Off. If not set, On/Off will be executed for all Aqara smart plugs. Multiple devices can be specified using comma separation |
| On |
Specify On/Off. The value specified for cp.On should be “true” or “false” |
AWS S3 Download
This component is used to download files from AWS S3 when you want to use them within HubKit. Files are saved in the Action Manager’s Data directory.
Properties
| Property Name |
Description |
| Output |
Specify whether to keep in the Action program’s Payload or as a file. The value set to cp.Output should be either “Payload” or “File” |
| Filename |
Filename when keeping as a file |
| Bucket |
Bucket name in AWS S3 |
| Object Key |
Object key in AWS S3 |
| Timeout |
Specify the transmission timeout period |
| Access Key ID |
Access key obtained from AWS |
| Secret Access Key |
Secret access key obtained from AWS |
| Region |
Specify the AWS region to use |
Note: Files without a specified file path will be saved in actmgr/data.
AWS S3 Upload
AWS S3 Upload uploads files to Amazon S3. The files in the action’s data folder are the target.
Properties
| Property Name |
Description |
| Input |
Specify whether to read from Action program’s Payload or from a file. When setting with cp.Input value, choose either “Payload” or “File” |
| Filename |
Input filename |
| Bucket |
AWS S3 bucket name for upload |
| Object Key |
Object key in AWS S3 |
| ACL |
Access control permissions in AWS S3 |
| Storage Class |
Type of storage in AWS S3 |
| Timeout |
Specify the transmission timeout period |
| Access Key ID |
Access key obtained from AWS |
| Secret Access Key |
Secret access key obtained from AWS |
| Region |
Specify the AWS region to use |
BindingOnOff
This component allows you to change the binding settings of devices connected to areas/layers at the time of action execution.
Properties
| Property Name |
Description |
| Field |
Specify whether to identify the device by Device ID or Logical Device ID |
| Device ID |
Specify the device to set binding using Device ID |
| Logical Device ID |
Specify the device to set binding using Logical Device ID |
| On/Off |
Specify binding on and off for the specified device (settings will not change if “No Change” is selected) |
Box List
The Box List component allows you to retrieve a list of files from Box.
Output Payload
A list of files is output.
Example of Box List output 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
}
Properties
| Property Name |
Description |
| Box Folder Path |
Box folder path for download target |
| Search Target |
Specify the filename to search |
| Search Type |
Search method for the string in “Search Target”, specify exact match or partial match for filename |
| Include Files |
Include files in search results |
| Include Directories |
Include directories in search results |
| Sort Order |
Output order of search results: Filename (ascending), Filename (descending), Modified Time (ascending), Modified Time (descending), File Size (ascending), File Size (descending) |
| Files Added/Changed Today |
Specify files added or updated on the day of execution |
| Get Files Modified After This Time |
Reference time for download, download those changed after the specified time |
| Get Files Modified Before This Time |
Reference time for download, download those changed before the specified time |
| Timeout |
HTTP request response timeout value |
| Timezone |
Timezone for specified times including “Files Added/Changed Today” |
| OAuth2 Client ID |
Specify Client ID from Box API 2.0 |
| OAuth2 Client Secret |
Specify Client Secret from Box |
| OAuth2 Redirect URL |
Specify Redirect URL from Box |
| OAuth2 Access Token |
Obtain by pressing the “Get Token” button. Can also be updated by pressing the “Update Token” button |
Box Download
The Box Download component allows you to download files from Box.
Output Payload
| Output Payload |
Description |
| cv.Payload |
If output property specifies payload, the downloaded file. If filename is specified, outputs the previous component’s output payload as is (pass-through) |
Properties
| Property Name |
Description |
| Output |
Payload or File |
| Overwrite Existing Files |
When “Output Property” specifies a file and an existing file exists, if “Overwrite Existing Files” is off, a number will be added to the filename |
| Specification Method |
Search by specifying file path and filename, search by specifying folder ID and filename, or search by specifying file ID |
| Download Only Newest |
When multiple files are targeted in the search result, whether to download only the newest file or all files |
| Target |
When “Specification Method Property” is not file ID, specify Box filename with exact match or partial match |
| Box Folder Path |
When “Specification Method Property” specifies file path, Box folder path for download target |
| Box Filename |
When “Specification Method Property” specifies filename, Box filename to download |
| File ID |
When “Specification Method Property” specifies file ID, file ID to download |
| Files Added/Changed Today |
Specify files added or updated on the day of execution |
| Get Files Modified After This Time |
Reference time for download, download those changed after the specified time |
| Get Files Modified Before This Time |
Reference time for download, download those changed before the specified time |
| Timeout |
HTTP request response timeout value |
| Timezone |
Timezone for specified times |
| OAuth2 Client ID |
Specify Client ID from Box API 2.0 |
| OAuth2 Client Secret |
Specify Client Secret from Box |
| OAuth2 Redirect URL |
Specify Redirect URL from Box |
| OAuth2 Access Token |
Obtain by pressing the “Get Token” button. Can also be updated by pressing the “Update Token” button |
Component Variables
| Component Variable |
Description |
| cv.FileID |
File ID |
| cv.ReadLength |
Number of bytes read |
| cv.Filename |
When “Output” property is filename, the downloaded filename |
Box Upload
The Box Upload component allows you to upload files to Box.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the previous component’s output payload as is (pass-through) |
Properties
| Property Name |
Description |
| Input |
Payload or filename |
| Filename |
When “Input” property is filename, specify the filename to send. Path is specified relative to the Data folder |
| Specification Method |
Folder path or folder ID |
| Box Folder Path |
Box destination folder name |
| Folder ID |
Box destination folder ID |
| Box Filename |
When “Input Property” specifies filename and “Box Filename” property is not specified, sends with original filename |
| Timeout |
HTTP request response timeout value |
| OAuth2 Client ID |
Specify Client ID from Box API 2.0 |
| OAuth2 Client Secret |
Specify Client Secret from Box |
| OAuth2 Redirect URL |
Specify Redirect URL from Box |
| OAuth2 Access Token |
Obtain by pressing the “Get Token” button. Can also be updated by pressing the “Update Token” button |
Component Variables
| Component Variable |
Description |
| cv.FileID |
File ID |
| cv.FolderID |
Folder ID |
| cv.BoxFilename |
Box destination filename |
BrightSign
The BrightSign component allows you to send commands to BrightSign.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the previous component’s output payload as is (pass-through) |
Properties
| Property Name |
Description |
| Hostname |
BrightSign hostname or IP address |
| Port Number |
BrightSign UDP port number |
| Command |
Command to send to BrightSign |
Call
The Call component executes another action and continues the current action after execution.
It allows you to reuse previously created actions.
Properties
| Property Name |
Description |
| Action ID |
Action ID to execute |
The Action ID is the name of the action file 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
| Property Name |
Description |
| Action ID |
Action ID to execute |
| Condition |
Condition for executing the action |
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 name of the action file 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
| Output Payload |
Description |
| cv.Payload |
Outputs an array of saved photo filenames |
Properties
| Property Name |
Description |
| Physical Device ID |
Specify the physical device ID of the camera connected in the device list |
| Number of Photos |
Specify the number of photos to save when the component executes (maximum 5) |
| Interval (seconds) |
Specify the interval for saving photos |
| Save Location |
Specify a subfolder of actmgr/data as the file save location. Photos will be saved in this subfolder |
Note: Component execution requires time equal to the number of photos × interval, so please avoid settings that result in very long execution 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
| Output Payload |
Description |
| cv.Payload |
Outputs an array of saved video filenames |
Properties
| Property Name |
Description |
| Physical Device ID |
Specify the physical device ID of the camera connected in the device list |
| Video Length (seconds) |
Specify the recording time for the video when the component executes (in seconds) |
| Interval (seconds) |
Specify the interval for saving videos |
| Save Location |
Specify a subfolder of actmgr/data as the file save location. Videos will be saved in this subfolder |
| Auto Naming |
Automatically generate filenames |
| Filename |
Specify when not using automatic filename generation in the auto naming property |
Chatwork
The Chatwork component allows you to send messages to Chatwork.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the previous component’s output payload as is (pass-through) |
Properties
| Property Name |
Description |
| Room ID |
Specify the Chatwork room ID |
| Message |
Specify the message to send |
| API Token |
Specify the API token for Chatwork |
Chromecast
The Chromecast component allows you to send commands to Chromecast.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the previous component’s output payload as is (pass-through) |
Properties
| Property Name |
Description |
| Hostname |
Chromecast hostname or IP address |
| Port Number |
Chromecast UDP port number |
| Command |
Command to send to Chromecast |
Claude
The Claude component allows you to send messages to Claude.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the previous component’s output payload as is (pass-through) |
Properties
| Property Name |
Description |
| Room ID |
Specify the Claude room ID |
| Message |
Specify the message to send |
| API Token |
Specify the API token for Claude |
CSV Read
The CSV Read component allows you to read data from a CSV file.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the data read from the CSV file |
Properties
| Property Name |
Description |
| Filename |
Specify the CSV file name |
| Delimiter |
Specify the delimiter for the CSV file |
| Header Row |
Specify whether the CSV file has a header row |
CSV Write
The CSV Write component allows you to write data to a CSV file.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the data written to the CSV file |
Properties
| Property Name |
Description |
| Filename |
Specify the CSV file name |
| Delimiter |
Specify the delimiter for the CSV file |
| Header Row |
Specify whether the CSV file has a header row |
CSV File Write
The CSV File Write component allows you to write data to a CSV file.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the data written to the CSV file |
Properties
| Property Name |
Description |
| Filename |
Specify the CSV file name |
| Delimiter |
Specify the delimiter for the CSV file |
| Header Row |
Specify whether the CSV file has a header row |
Exec
The Exec component allows you to execute a command or script.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the executed command or script |
Properties
| Property Name |
Description |
| Command |
Specify the command or script to execute |
Execute Inference Model
The Execute Inference Model component allows you to execute a machine learning model.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the executed machine learning model |
Properties
| Property Name |
Description |
| Model ID |
Specify the ID of the machine learning model |
| Input |
Specify the input data for the machine learning model |
File Copy
The File Copy component allows you to copy files from one location to another.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the file copy operation |
Properties
| Property Name |
Description |
| Source |
Specify the source file path |
| Destination |
Specify the destination file path |
File Delete
The File Delete component allows you to delete files from a specified location.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the file delete operation |
Properties
| Property Name |
Description |
| File Path |
Specify the file path to delete |
File List
The File List component allows you to retrieve a list of files from a specified location.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs a list of files from the specified location |
Properties
| Property Name |
Description |
| File Path |
Specify the file path to list files from |
File Read
The File Read component allows you to read data from a file.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the data read from the file |
Properties
| Property Name |
Description |
| Filename |
Specify the file name to read |
File Rename
The File Rename component allows you to rename a file.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the file rename operation |
Properties
| Property Name |
Description |
| Source |
Specify the source file path |
| Destination |
Specify the destination file path |
File Write
The File Write component allows you to write data to a file.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the data written to the file |
Properties
| Property Name |
Description |
| Filename |
Specify the file name to write |
Filter
The Filter component allows you to filter data based on a condition.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the filtered data |
Properties
| Property Name |
Description |
| Condition |
Specify the condition for filtering |
GCS Upload
The GCS Upload component allows you to upload files to Google Cloud Storage (GCS).
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the file upload operation |
Properties
| Property Name |
Description |
| Input |
Specify whether to read from Action program’s Payload or from a file. When setting with cp.Input value, choose either “Payload” or “File” |
| Filename |
Input filename |
| Bucket |
Google Cloud Storage bucket name for upload |
| Object Key |
Object key in Google Cloud Storage |
| ACL |
Access control permissions in Google Cloud Storage |
| Storage Class |
Type of storage in Google Cloud Storage |
| Timeout |
Specify the transmission timeout period |
| Access Key ID |
Access key obtained from Google Cloud |
| Secret Access Key |
Secret access key obtained from Google Cloud |
| Region |
Specify the Google Cloud region to use |
GCS Download
The GCS Download component allows you to download files from Google Cloud Storage (GCS).
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the file download operation |
Properties
| Property Name |
Description |
| Output |
Specify whether to keep in the Action program’s Payload or as a file. The value set to cp.Output should be either “Payload” or “File” |
| Filename |
Filename when keeping as a file |
| Bucket |
Google Cloud Storage bucket name for download |
| Object Key |
Object key in Google Cloud Storage |
| Timeout |
Specify the transmission timeout period |
| Access Key ID |
Access key obtained from Google Cloud |
| Secret Access Key |
Secret access key obtained from Google Cloud |
| Region |
Specify the Google Cloud region to use |
Note: Files without a specified file path will be saved in actmgr/data.
Google Analytics Send Event
The Google Analytics Send Event component allows you to send events to Google Analytics.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the event sending operation |
Properties
| Property Name |
Description |
| Event Category |
Specify the event category |
| Event Action |
Specify the event action |
| Event Label |
Specify the event label |
| Event Value |
Specify the event value |
| Tracking ID |
Specify the Google Analytics tracking ID |
GoogleDriveList
The GoogleDriveList component allows you to retrieve a list of files from Google Drive.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs a list of files from Google Drive |
Properties
| Property Name |
Description |
| Folder ID |
Specify the Google Drive folder ID |
| Search Target |
Specify the filename to search |
| Search Type |
Search method for the string in “Search Target”, specify exact match or partial match for filename |
| Include Files |
Include files in search results |
| Include Directories |
Include directories in search results |
| Sort Order |
Output order of search results: Filename (ascending), Filename (descending), Modified Time (ascending), Modified Time (descending), File Size (ascending), File Size (descending) |
| Files Added/Changed Today |
Specify files added or updated on the day of execution |
| Get Files Modified After This Time |
Reference time for download, download those changed after the specified time |
| Get Files Modified Before This Time |
Reference time for download, download those changed before the specified time |
| Timeout |
HTTP request response timeout value |
| Timezone |
Timezone for specified times including “Files Added/Changed Today” |
| OAuth2 Client ID |
Specify Client ID from Google Drive API |
| OAuth2 Client Secret |
Specify Client Secret from Google Drive |
| OAuth2 Redirect URL |
Specify Redirect URL from Google Drive |
| OAuth2 Access Token |
Obtain by pressing the “Get Token” button. Can also be updated by pressing the “Update Token” button |
GoogleDriveDownload
The GoogleDriveDownload component allows you to download files from Google Drive.
Output Payload
| Output Payload |
Description |
| cv.Payload |
If output property specifies payload, the downloaded file. If filename is specified, outputs the previous component’s output payload as is (pass-through) |
Properties
| Property Name |
Description |
| Output |
Payload or File |
| Overwrite Existing Files |
When “Output Property” specifies a file and an existing file exists, if “Overwrite Existing Files” is off, a number will be added to the filename |
| Specification Method |
Search by specifying file path and filename, search by specifying folder ID and filename, or search by specifying file ID |
| Download Only Newest |
When multiple files are targeted in the search result, whether to download only the newest file or all files |
| Target |
When “Specification Method Property” is not file ID, specify Google Drive filename with exact match or partial match |
| Folder ID |
When “Specification Method Property” specifies folder ID, Google Drive folder ID for download target |
| File ID |
When “Specification Method Property” specifies file ID, file ID to download |
| Files Added/Changed Today |
Specify files added or updated on the day of execution |
| Get Files Modified After This Time |
Reference time for download, download those changed after the specified time |
| Get Files Modified Before This Time |
Reference time for download, download those changed before the specified time |
| Timeout |
HTTP request response timeout value |
| Timezone |
Timezone for specified times |
| OAuth2 Client ID |
Specify Client ID from Google Drive API |
| OAuth2 Client Secret |
Specify Client Secret from Google Drive |
| OAuth2 Redirect URL |
Specify Redirect URL from Google Drive |
| OAuth2 Access Token |
Obtain by pressing the “Get Token” button. Can also be updated by pressing the “Update Token” button |
Component Variables
| Component Variable |
Description |
| cv.FileID |
File ID |
| cv.ReadLength |
Number of bytes read |
| cv.Filename |
When “Output” property is filename, the downloaded filename |
GoogleDriveUpload
The GoogleDriveUpload component allows you to upload files to Google Drive.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the file upload operation |
Properties
| Property Name |
Description |
| Input |
Payload or filename |
| Filename |
When “Input” property is filename, specify the filename to send. Path is specified relative to the Data folder |
| Specification Method |
Folder path or folder ID |
| Folder ID |
Google Drive folder ID for upload |
| Timeout |
HTTP request response timeout value |
| OAuth2 Client ID |
Specify Client ID from Google Drive API |
| OAuth2 Client Secret |
Specify Client Secret from Google Drive |
| OAuth2 Redirect URL |
Specify Redirect URL from Google Drive |
| OAuth2 Access Token |
Obtain by pressing the “Get Token” button. Can also be updated by pressing the “Update Token” button |
Component Variables
| Component Variable |
Description |
| cv.FileID |
File ID |
| cv.FolderID |
Folder ID |
| cv.Filename |
Google Drive filename |
Go To
The Go To component allows you to jump to a specified action.
Properties
| Property Name |
Description |
| Action ID |
Action ID to execute |
The Action ID is the name of the action file without the extension (.acs).
Go To If
The Go To If component allows you to jump to a specified action based on a condition.
Properties
| Property Name |
Description |
| Action ID |
Action ID to execute |
| Condition |
Condition for executing the action |
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 name of the action file without the extension (.acs).
GPS
The GPS component allows you to retrieve the current GPS coordinates.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the current GPS coordinates |
Properties
| Property Name |
Description |
| Latitude |
Specify the latitude |
| Longitude |
Specify the longitude |
Zigbee Light
The Zigbee Light component allows you to control the brightness of a connected light.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the light control operation |
Properties
| Property Name |
Description |
| Device ID |
Specify the device ID of the connected light |
| Brightness |
Specify the brightness level (0-100) |
Gravio Distance
The Gravio Distance component allows you to retrieve the distance between two points.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the distance between two points |
Properties
| Property Name |
Description |
| Latitude1 |
Specify the latitude of the first point |
| Longitude1 |
Specify the longitude of the first point |
| Latitude2 |
Specify the latitude of the second point |
| Longitude2 |
Specify the longitude of the second point |
Gravio Matrix
The Gravio Matrix component allows you to control a matrix display.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the matrix control operation |
Properties
| Property Name |
Description |
| Device ID |
Specify the device ID of the connected matrix |
| Command |
Specify the command to send to the matrix |
HTTP Request
The HTTP Request component allows you to send HTTP requests.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the HTTP request operation |
Properties
| Property Name |
Description |
| URL |
Specify the HTTP request URL |
| Method |
Specify the HTTP request method |
| Headers |
Specify the HTTP request headers |
| Body |
Specify the HTTP request body |
| Timeout |
Specify the HTTP request timeout period |
Join
The Join component allows you to concatenate multiple strings.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the concatenated string |
Properties
| Property Name |
Description |
| Strings |
Specify the strings to concatenate |
LINE Push
The LINE Push component allows you to send messages to LINE.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the message sending operation |
Properties
| Property Name |
Description |
| Room ID |
Specify the LINE room ID |
| Message |
Specify the message to send |
| API Token |
Specify the API token for LINE |
LINE Notify
The LINE Notify component allows you to send messages to LINE Notify.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the message sending operation |
Properties
| Property Name |
Description |
| Room ID |
Specify the LINE Notify room ID |
| Message |
Specify the message to send |
| API Token |
Specify the API token for LINE Notify |
LINE WORKS
The LINE WORKS component allows you to send messages to LINE WORKS.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the message sending operation |
Properties
| Property Name |
Description |
| Room ID |
Specify the LINE WORKS room ID |
| Message |
Specify the message to send |
| API Token |
Specify the API token for LINE WORKS |
Mail Send
The Mail Send component allows you to send emails.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the email sending operation |
Properties
| Property Name |
Description |
| To |
Specify the email recipient |
| Subject |
Specify the email subject |
| Body |
Specify the email body |
| Attachment |
Specify the email attachment |
| SMTP Server |
Specify the SMTP server address |
| SMTP Port |
Specify the SMTP server port |
| SMTP Authentication |
Specify whether to use SMTP authentication |
| SMTP User |
Specify the SMTP user |
| SMTP Password |
Specify the SMTP password |
MQTT Publish
The MQTT Publish component allows you to publish messages to an MQTT broker.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the message publishing operation |
Properties
| Property Name |
Description |
| Topic |
Specify the MQTT topic |
| Message |
Specify the MQTT message |
| Broker |
Specify the MQTT broker address |
| Port |
Specify the MQTT broker port |
| QoS |
Specify the MQTT Quality of Service |
| Retain |
Specify whether to retain the message |
| SSL |
Specify whether to use SSL |
| SSL Key |
Specify the SSL key |
| SSL Cert |
Specify the SSL certificate |
SQL Server Exec
The SQL Server Exec component allows you to execute SQL commands on a SQL Server.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the SQL execution operation |
Properties
| Property Name |
Description |
| Connection String |
Specify the SQL Server connection string |
| Command |
Specify the SQL command to execute |
SQL Server Query
The SQL Server Query component allows you to execute SQL queries on a SQL Server.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the SQL query operation |
Properties
| Property Name |
Description |
| Connection String |
Specify the SQL Server connection string |
| Query |
Specify the SQL query to execute |
MSTeams Send Message
The MSTeams Send Message component allows you to send messages to Microsoft Teams.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the message sending operation |
Properties
| Property Name |
Description |
| Webhook URL |
Specify the Microsoft Teams webhook URL |
| Message |
Specify the message to send |
MySQL Exec
The MySQL Exec component allows you to execute SQL commands on a MySQL database.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the SQL execution operation |
Properties
| Property Name |
Description |
| Connection String |
Specify the MySQL connection string |
| Command |
Specify the SQL command to execute |
MySQL Query
The MySQL Query component allows you to execute SQL queries on a MySQL database.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the SQL query operation |
Properties
| Property Name |
Description |
| Connection String |
Specify the MySQL connection string |
| Query |
Specify the SQL query to execute |
OpenAICompletion
The OpenAICompletion component allows you to complete text using OpenAI.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the completed text |
Properties
| Property Name |
Description |
| Model ID |
Specify the ID of the OpenAI model |
| Input |
Specify the input text for completion |
OpenAIChat
The OpenAIChat component allows you to chat with OpenAI.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the chat response |
Properties
| Property Name |
Description |
| Model ID |
Specify the ID of the OpenAI model |
| Input |
Specify the input text for the chat |
OpenAIImage
The OpenAIImage component allows you to generate an image using OpenAI.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the generated image |
Properties
| Property Name |
Description |
| Model ID |
Specify the ID of the OpenAI model |
| Input |
Specify the input text for image generation |
OpenAIAudio
The OpenAIAudio component allows you to generate audio using OpenAI.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the generated audio |
Properties
| Property Name |
Description |
| Model ID |
Specify the ID of the OpenAI model |
| Input |
Specify the input text for audio generation |
Parallel
The Parallel component allows you to execute multiple actions concurrently.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the parallel execution operation |
Properties
| Property Name |
Description |
| Actions |
Specify the actions to execute concurrently |
Parallel If
The Parallel If component allows you to execute multiple actions concurrently based on a condition.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the parallel execution operation |
Properties
| Property Name |
Description |
| Actions |
Specify the actions to execute concurrently |
| Condition |
Condition for executing the actions |
Condition examples:
- Numeric Payload:
cv.Payload > 10
- String:
cv.Payload =~ "^abc"
- JSON Array:
cv.Payload[1] > 10
- JSON Object:
cv.Payload.key1 == "abc"
PATLITE
The PATLITE component allows you to control a PATLITE device.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the PATLITE control operation |
Properties
| Property Name |
Description |
| Device ID |
Specify the device ID of the connected PATLITE |
| Command |
Specify the command to send to the PATLITE |
Philips Hue
The Philips Hue component allows you to control Philips Hue lights.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the light control operation |
Properties
| Property Name |
Description |
| Device ID |
Specify the device ID of the connected Philips Hue light |
| Brightness |
Specify the brightness level (0-100) |
PostgreSQL Exec
The PostgreSQL Exec component allows you to execute SQL commands on a PostgreSQL database.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the SQL execution operation |
Properties
| Property Name |
Description |
| Connection String |
Specify the PostgreSQL connection string |
| Command |
Specify the SQL command to execute |
PostgreSQL Query
The PostgreSQL Query component allows you to execute SQL queries on a PostgreSQL database.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the SQL query operation |
Properties
| Property Name |
Description |
| Connection String |
Specify the PostgreSQL connection string |
| Query |
Specify the SQL query to execute |
Sensor Data DB
The Sensor Data DB component allows you to store sensor data in a database.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the sensor data |
Properties
| Property Name |
Description |
| Connection String |
Specify the database connection string |
| Table Name |
Specify the table name to store sensor data |
| Sensor ID |
Specify the sensor ID |
| Data |
Specify the sensor data |
Sensor Data DB If Zero
The Sensor Data DB If Zero component allows you to store sensor data in a database only when the sensor data is zero.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the sensor data |
Properties
| Property Name |
Description |
| Connection String |
Specify the database connection string |
| Table Name |
Specify the table name to store sensor data |
| Sensor ID |
Specify the sensor ID |
| Data |
Specify the sensor data |
Slack Post Message
The Slack Post Message component allows you to send messages to Slack.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the message sending operation |
Properties
| Property Name |
Description |
| Webhook URL |
Specify the Slack webhook URL |
| Message |
Specify the message to send |
Slack Files Upload
The Slack Files Upload component allows you to upload files to Slack.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the file uploading operation |
Properties
| Property Name |
Description |
| File Path |
Specify the file path to upload |
| File Name |
Specify the file name to upload |
| Slack Webhook URL |
Specify the Slack webhook URL |
Slack Files Upload2
The Slack Files Upload2 component allows you to upload files to Slack.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the file uploading operation |
Properties
| Property Name |
Description |
| File Path |
Specify the file path to upload |
| File Name |
Specify the file name to upload |
| Slack Webhook URL |
Specify the Slack webhook URL |
Sleep
The Sleep component allows you to pause the action for a specified period.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the sleep operation |
Properties
| Property Name |
Description |
| Duration (seconds) |
Specify the duration of the sleep |
SORACOMDataPost
The SORACOMDataPost component allows you to send data to SORACOM.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the data sending operation |
Properties
| Property Name |
Description |
| URL |
Specify the SORACOM data posting URL |
| Data |
Specify the data to send |
SORACOMFileUpload
The SORACOMFileUpload component allows you to upload files to SORACOM.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the file uploading operation |
Properties
| Property Name |
Description |
| File Path |
Specify the file path to upload |
| File Name |
Specify the file name to upload |
| URL |
Specify the SORACOM file uploading URL |
Sound Effect
The Sound Effect component allows you to play a sound effect.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the sound effect playing operation |
Properties
| Property Name |
Description |
| Sound Effect ID |
Specify the ID of the sound effect |
Sound Play
The Sound Play component allows you to play a sound.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the sound playing operation |
Properties
| Property Name |
Description |
| Sound ID |
Specify the ID of the sound |
Split
The Split component allows you to split a string into multiple parts.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the split string |
Properties
| Property Name |
Description |
| String |
Specify the string to split |
| Delimiter |
Specify the delimiter for splitting |
Statistics
The Statistics component allows you to calculate statistics from a dataset.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the calculated statistics |
Properties
| Property Name |
Description |
| Dataset |
Specify the dataset for calculating statistics |
| Statistic Type |
Specify the type of statistic to calculate |
Template
The Template component allows you to use a template to generate text.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the generated text |
Properties
| Property Name |
Description |
| Template |
Specify the template text |
| Variables |
Specify the variables to use in the template |
The Transform component allows you to transform data.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the transformed data |
Properties
| Property Name |
Description |
| Transformation Type |
Specify the type of transformation to apply |
| Input |
Specify the input data for transformation |
Twilio SMS
The Twilio SMS component allows you to send SMS messages using Twilio.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the SMS sending operation |
Properties
| Property Name |
Description |
| To |
Specify the recipient’s phone number |
| From |
Specify the sender’s phone number |
| Message |
Specify the SMS message |
| Twilio Account SID |
Specify the Twilio Account SID |
| Twilio Auth Token |
Specify the Twilio Auth Token |
Write To Excel (365)
The Write To Excel (365) component allows you to write data to an Excel file in Microsoft 365.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the Excel writing operation |
Properties
| Property Name |
Description |
| Connection String |
Specify the Excel connection string |
| Table Name |
Specify the table name to write |
| Data |
Specify the data to write |
Write To Excel (Local)
The Write To Excel (Local) component allows you to write data to an Excel file on a local machine.
Output Payload
| Output Payload |
Description |
| cv.Payload |
Outputs the result of the Excel writing operation |
Properties
| Property Name |
Description |
| File Path |
Specify the Excel file path |
| Table Name |
Specify the table name to write |
| Data |
Specify the data to write |