Testing with historical CSV file

In the Kelvin SDK there is a test tool to help you ingest data to the inputs and debug the outputs to test the performance of your Kelvin SmartApp™.

The Kelvin SDK test csv tool is designed to allow testers to ingest messages from a CSV file for testing purposes.

CSV Tool Overview

The test csv tool supports a variety of options to customize its behavior. Below is a list of the available options:

Parameter	Required	Description	Note
--csv TEXT	required	Path to the CSV file	N/A
--config TEXT	optional	Path to the app.yaml	Default: Current directory
--publish-rate FLOAT	optional	Overrides CSV Publishing rate (in seconds)	0 forces instant feed
--playback	optional	Offsets the first csv timestamp to the current time	N/A
--replay	optional	Continuously publish data from CSV when reaching EOF	N/A
--asset-count INTEGER	optional	Number of Assets (test-asset-N)	Default: 1
--asset-parameter TEXT	optional	Sets Asset Parameter	Can be used multiple times

CSV File Structure

To structure the CSV file for your application, please follow the rules outlined below:

1. Timestamp Column:

   • The first column should be labeled as timestamp.
   • The timestamp should follow one of the supported formats by the Arrow library. Examples of accepted formats include:
     • YYYY-MM-DD HH:mm:ss
     • YYYY/M/D HH:mm
     • YYYYDDDD HH:mm
     • Other Arrow-compatible formats

2. Input Columns:

   • Include additional columns for each input defined in your app.yaml file. These columns represent the various data stream inputs your application receives.
   • Example input columns might include:
     • motor_temperature
     • pressure
     • gas_flow

3. Optional Asset Parameters:

   • If you have optional asset parameters defined in your app.yaml file, include them as additional columns. These parameters can be useful for evaluating different operational behaviors.
   • Example optional parameter columns might include:
     • temperature_max_threshold
     • speed_decrease_set_point
     • closed_loop

Download CSV Test File

Now that you're familiar with the basics of the test csv tool, it's time to put the Event Detection SmartApp to the test using a CSV file.

Download the CSV file from the link below and save it to your local machine:

Download test.csv

Important Reminder

Make sure to copy the downloaded CSV file into the directory of your Kelvin SmartApp™ project before proceeding.

The CSV file you downloaded contains the following data:

timestamp,motor_temperature
2023-10-27 10:00:01.0,50
2023-10-27 10:00:02.0,51
2023-10-27 10:00:03.0,52
2023-10-27 10:00:04.0,53
2023-10-27 10:00:05.0,54
2023-10-27 10:00:06.0,55
2023-10-27 10:00:07.0,56
2023-10-27 10:00:08.0,57
2023-10-27 10:00:09.0,58
2023-10-27 10:00:10.0,59
2023-10-27 10:00:11.0,60

Test your SmartApp

Open a terminal window on the folder of your Kelvin SmartApp™ project and follow the steps below to test your Event Detection SmartApp using the CSV file you downloaded:

1. Run the CSV Test Tool:

   kelvin app test csv --replay --playback --csv test.csv
   

   and you should see the following output:

   Publisher started.
   

2. Open a NEW terminal window and run the SmartApp:

   python3 main.py
   

   and you should see the following output:

   Received Motor Temperature | Asset: test-asset-1 | Value: 50.0
   
   Received Motor Temperature | Asset: test-asset-1 | Value: 51.0
   
   Received Motor Temperature | Asset: test-asset-1 | Value: 52.0
   
   Received Motor Temperature | Asset: test-asset-1 | Value: 53.0
   
   Received Motor Temperature | Asset: test-asset-1 | Value: 54.0
   
   Received Motor Temperature | Asset: test-asset-1 | Value: 55.0
   
   Received Motor Temperature | Asset: test-asset-1 | Value: 56.0
   
   Received Motor Temperature | Asset: test-asset-1 | Value: 57.0
   
   Received Motor Temperature | Asset: test-asset-1 | Value: 58.0
   
   Received Motor Temperature | Asset: test-asset-1 | Value: 59.0
   
   Received Motor Temperature | Asset: test-asset-1 | Value: 60.0
   
   Published Motor Speed SetPoint (Control Change) Recommendation: 1000.0
   
   (...)
   

3. Go to the CSV Tool terminal and check the logs:

   Publisher started.
   Connected
   
   CSV ingestion is complete
   
   Received Recommendation Message:
   RecommendationMsg(id=UUID('e5cc136a-5ae1-4014-a106-6699b6423e62'), type=KMessageTypeRecommendation('recommendation', ''), trace_id=None, source=None, timestamp=datetime.datetime(2024, 8, 9, 18, 10, 40, 231994, tzinfo=datetime.timezone(datetime.timedelta(seconds=3600), 'WEST')), resource=KRNAsset(asset='test-asset-1'), payload=RecommendationPayload(source=None, resource=KRNAsset(asset='test-asset-1'), type='decrease_speed', description=None, confidence=None, expiration_date=None, actions=RecommendationActions(control_changes=[RecommendationControlChange(timeout=None, retries=None, expiration_date=datetime.datetime(2024, 8, 9, 18, 20, 40, 231843, tzinfo=datetime.timezone(datetime.timedelta(seconds=3600), 'WEST')), payload=1000.0, from_value=None, state=None, resource=KRNAssetDataStream(asset='test-asset-1', data_stream='motor_speed_set_point'), control_change_id=None)]), metadata={}, state=None))
   

And here is a video showing the test in action:

As you can see, the SmartApp is receiving the motor temperature data and publishing a control change recommendation to decrease the motor speed set point.