Configure Kelvin SmartApp™

← Upload SmartApp ④ ⑥ Deploy SmartApp →

In this section, you will learn how to configure your Kelvin Cloud instance. We will configure the environment to simulate a real-world scenario. Here is a high-level overview of the steps involved:

• Importing Assets: An Asset in Kelvin denotes a digital representation of a physical or virtual equipment. Each asset is characterized by a set of properties that detail its attributes and by datastreams, which are channels of continuous or time-stamped data related to the asset's operation or state

• Importing Data Streams: Data streams are the primary source of data for Kelvin SmartApps™. They represent the real-time data generated by assets and are used as inputs to the SmartApp to generate actionable recommendations and control system adjustments.

• CSV Connection: A connection in Kelvin is a data source that provides a data stream feed to the SmartApps. In this guide, we will create a CSV connection that will continously replay a CSV timeseries file.

This demonstration video was done in v5.9.

There may be slight differences with the latest version.

Check the latest documentation for the specific tasks should any feature not quite work as expected.

Video Guide

Watch this quick start guide performed in real time in less than 6 minutes.

Written Guide

Import Assets

In this brief demo you can see how to do this;

Open your browser and navigate to https://<instance>.kelvin.ai. Login with your credentials and you will be presented with the Kelvin UI.

Click on the Asset Management section on the left navigation menu

And then click on the Import Assets button on the top right of the page.

In the popup, you will have the option to download the sample template that gives you the structure you need to follow. Go ahead and click on the Download Template button and save the file.

Info

We have prepared an assets.csv file for you to test. You can download it from the link below and save it to your local machine:

Download assets.csv

Modify the template with the following data (or just download our ready made CSV file):

Display Name,Name ID,Asset Type Name ID,Field,Manufacturer
Motor #01,motor_01,motor,Eagle Ford,Siemens
Motor #02,motor_02,motor,Permian,ABB
Motor #03,motor_03,motor,Williston,Schneider
Motor #04,motor_04,motor,Williston,Siemens
Motor #05,motor_05,motor,Williston,ABB

...

Motor #30,motor_30,motor,Eagle Ford,Schneider

A brief explanation of the columns in the CSV file:

• Display Name: The name of the asset as it will appear in the Kelvin UI.
• Name ID: A unique identifier for the asset.
• Asset Type Name ID: The type of asset (e.g., motor, pump, compressor).
• Field: This is an optional Asset Property with metadata where the asset is located.
• Manufacturer: This is an optional Asset Property with metadata about the manufacturer of the asset.

You can add as many additional Asset Properties as needed, like Location, PLC Type, Well Depth, Motor Configuration, etc.

Next, let's import the assets into your Kelvin Cloud instance.

Upload the previously downloaded assets.csv file and click Next.

Note

In the screenshot you will see the file named assets-filled.csv. when uploading your file, you will see the name of your csv file here instead.

The contents of the file will be validated to make sure there are no errors. If there are any errors, you will be prompted to correct them before proceeding. Next, click on the Import button.

You will then see the assets you imported in the Asset Management section.

Success

Congratulations! You have successfully configured your assets.

Import Data Streams

In this brief demo you can see how to do this;

Go to the Kelvin UI. Click on the Data Streams section on the left navigation menu and then click on the Import Data Streams button on the top right of the page.

In the popup, you will have the option to download the sample template that gives you the structure you need to follow. Go ahead and click on the Download Template button and save the file.

Info

We have prepared a datastreams.csv file for you to test. You can download it from the link below and save it to your local machine:

Download datastreams.csv

Modify the template with the following data (or just download our ready made CSV file):

Display Name,Name ID,Type,Data Type ID,Unit Name ID,Semantic Type ID
Motor Speed SP,motor_speed_set_point,measurement,number,revolution_per_minute,angular_velocity
Motor Temperature,motor_temperature,measurement,number,degree_celsius,temperature

A brief explanation of the columns in the CSV file:

Column Name	Mandatory	Description
Display Name	Yes	The name of the data stream as it will appear in the Kelvin UI.
Name ID	Yes	A unique identifier for the data stream.
Type	Yes	The type of data stream (e.g., measurement or computed).
Data Type ID	Yes	The data type of the data stream (e.g., number, string, boolean).
Unit Name ID	No	The unit of measurement for the data stream (e.g., revolution_per_minute, degree_celsius, pound_per_square_inch). More information on the available units can be found in the API documentation.
Semantic Type ID	No	The semantic type of the data stream (e.g., temperature, pressure, volume_flow_rate). More information on the available semantic types can be found in the API documentation.

Next, let's import the data streams into your Kelvin Cloud instance.

Upload the previously downloaded datastreams.csv file and click Next.

Note

In the screenshot you will see the file named datastreams-bulk-import.csv. when uploading your file, you will see the name of your csv file here instead.

The contents of the file will be validated to make sure there are no errors. If there are any errors, you will be prompted to correct them before proceeding. Next, click on the Import button.

You should see the data streams you imported in the Data Streams section.

Success

Congratulations! You have successfully configured your data streams.

Create a CSV Connection

Go to the Kelvin UI. Click on the Connections section on the left navigation menu

And then click on the Create Connection button on the top right of the page.

Warning

The following screenshots for creating a CSV Publisher are from the general documentation in the Platform Administration section here.

The actual information you need to enter will differ from the defaults in the screenshots.

Step 1

Select Import Data and Control Setpoints and click Next.

Step 2

Select the Kelvin CSV Publisher Connector option, select a Version and click Next.

Step 3

Select the Asset where the data will be sent to.

You can only select one Asset. Select one of the Assets we created earlier, for example Motor #01.

When ready click Next.

Step 4

Now you can now download the time series template.

Info

We have prepared a connection.csv file for you to test. You can download it from the link below and save it to your local machine:

Download connection.csv

Modify the template with the following data (or just download our ready made CSV file):

timestamp,motor_temperature,motor_speed_set_point
2024-05-20 20:19:30,50.57,1615
2024-05-20 20:19:35,73.48,
2024-05-20 20:19:40,59.28,
2024-05-20 20:19:45,64.45,
2024-05-20 20:19:50,75.59,
2024-05-20 20:19:55,67.27,

...

2024-05-21 10:12:40,72.48,
2024-05-21 10:12:45,57.3,

A brief explanation of the columns in the CSV file:

• timestamp: The timestamp of the data point. There are a number of different formats that are accepted.

Accepted Timestamp formats

"YYYY-MM-DD",
"YYYY-MM-DD HH:mm",
"YYYY-MM-DD HH:mm:ss",
"YYYY/MM/DD",
"YYYY/MM/DD HH:mm",
"YYYY/MM/DD HH:mm:ss",
"YYYY.MM.DD",
"YYYY.MM.DD HH:mm",
"YYYY.MM.DD HH:mm:ss",
"YYYYMMDD",
"YYYYMMDD HH:mm",
"YYYYMMDD HH:mm:ss",
"YYYY-MM-DDTHH:mm:ss",
"YYYY-MM-DDTHH:mm:ss.SSS",
"YYYY-MM-DDTHH:mm:ssZ",
"YYYY-MM-DDTHH:mm:ss±HH:mm",

• motor_temperature: The motor temperature data stream.
• motor_speed_set_point: The motor speed set point data stream. We start with an initial value and leave the rest of the values empty, which means the set point will remain constant. This set point will be changed by our Event Detection SmartApp.

Drag and drop or select your file to upload.

When you have selected the file, it will be validated before the Next button is activated.

Once validated you can click Next.

Step 5

In Step 5 you have a range of options available.

Make sure all the options have a green check mark next to it.

For this example we will only highlight some key areas to be aware;

Information

Type in a memorable name in the Display Name text input. You can use any letters, numbers and special characters.

The Connection Name text input will be automatically converted and filled in as you type in the Display Name section. The conversion ensures the Connection Name only contains lowercase alphanumeric characters and ., _ or - characters.

Configuration

Configure the CSV Publisher connection to be CSV Playback and Replay File as Yes.

Info

Make sure you choose to use the UI view for easily setting the configuration.

Parameter	Setting	Description
Replay File	Yes	Loops the data to produce an infinite amount of data.
Timestamp	CSV Playback	Time interval to use to send data to the Asset / Data Stream pairs.

IO Mapping

For each Data Stream column name in the uploaded file, select the Data Stream on the Kelvin Platform where the data in the rows will be sent.

Note

Make sure you set the Data Stream motor_speed_set_point as Control Writable to ensure you can write the value to the Asset.

Cluster

Then select which Cluster to deploy the new Connector to.

Optionally you can also select the Node in the Cluster. If you do not then the system will automatically assign the Node.

It is important that the asset is reachable from the selected Cluster and Node.

Click on the Create button to deploy the connection.

Wait a few seconds for the connection to be deployed and you should see the connection status change to Running.

Then if you are interested, proceed to click on the connection name to see the connection details. This will show you the data stream feed and when the data stream values were last updated.

Important Reminder

This connection will only publish data for one single asset. If you need additional data for the other assets you need to create a new connection for each asset. This allows you to test different scenarios and configurations for each asset.

Success

Congratulations! You have successfully configured your CSV Publisher connection.

Next Step

The next step is to deploy your Kelvin SmartApp™ to the assets.

← Upload SmartApp ④ ⑥ Deploy SmartApp →