8. Quick Start Quiz
Congratulations on completing the Quick Start!
Test your understanding with this quiz. All answers are based on what you have learned in Steps 1 through 7.
Test Your Knowledge
1. What software do you need installed before you can start building Kelvin SmartApps™?
Answer: You need three things:
- Python (3.10+)
- Docker (installed and running)
- Kelvin SDK (
pip install kelvin-sdk)
Docker is required for packaging and uploading your app. The Kelvin SDK provides the CLI tools for creating, testing, building, and uploading.
2. What command do you use to create a new SmartApp from a template?
Answer: kelvin app create
This scaffolds a new SmartApp project with the required file structure including the app.yaml configuration file and a starter Python script.
3. What is the app.yaml file and why is it important?
Answer: The app.yaml file is the configuration file for your SmartApp. It defines:
- The app name, title, description, and version
- Input variables (data the app reads from assets)
- Output variables (data the app writes back to assets)
- Asset parameters (configurable values that Operations can tune per asset)
- App configuration (developer-level settings)
Without a properly configured app.yaml, the SmartApp cannot be uploaded or deployed.
4. How do you test your SmartApp locally before uploading?
Answer: The Kelvin SDK provides two local testing methods:
- Simulator (
kelvin app test simulator) — generates random data based on yourapp.yamlinputs - CSV (
kelvin app test csv) — publishes data from a CSV file you provide for controlled, repeatable testing
Both methods run the SmartApp locally on your machine without needing a Kelvin Cloud connection.
5. What single command uploads your SmartApp to the App Registry?
Answer: kelvin app upload
This command builds the Docker image and pushes it to the App Registry on your Kelvin Cloud instance. Docker must be installed and running. You must be logged in via kelvin auth login first.
6. What happens if you try to upload an app with the same version number as one already in the App Registry?
Answer: You get an error. Every upload must have a unique version number. Always increment the version in app.yaml (e.g., from 1.0.0 to 1.0.1) before uploading again.
7. In the Configure step, what three things do you set up in the Kelvin UI?
Answer:
- Assets — import or create the assets that your SmartApp will process
- Data Streams — import or create the data streams associated with each asset
- Connection — create a connection (e.g., CSV Publisher for testing, or OPC UA / MQTT for production) that feeds data into the asset's data streams
8. When deploying, what does 'mapping inputs' mean?
Answer: Mapping inputs means linking the SmartApp's input variables (defined in app.yaml) to the actual data streams on the asset. For example, if your app has an input called motor_temperature, you map it to the asset's Motor Temperature data stream. This tells the SmartApp where to read its data from.
9. What is the difference between mapping inputs and mapping outputs?
Answer:
- Inputs = data the SmartApp reads from the asset (e.g., sensor readings)
- Outputs = data the SmartApp writes back to the asset (e.g., setpoint changes, computed values)
Both need to be mapped to actual data streams on the asset during deployment.
10. After deployment, where can you monitor your SmartApp's behaviour?
Answer: Multiple places in the Kelvin UI:
- Assets page — see asset status, add recommendation and data stream columns
- Data Explorer — see historical data with control change and recommendation markers on the timeline
- Applications page — see workload status, logs, and telemetry
- Asset Details — see recommendations, control changes, and parameters for a specific asset
11. What deployment statuses will you see after clicking Submit, and in what order?
Answer: Pending → Deploying → Running
If the target cluster is offline, the status stays at Pending until the cluster comes back online, then proceeds automatically.
12. Can Operations Engineers deploy your SmartApp to additional assets after you have uploaded it?
Answer: Yes. Once your SmartApp is in the App Registry, Operations Engineers can independently add any number of assets to it through the Kelvin UI — without needing any developer involvement or technical knowledge. This is one of the core design principles of the Kelvin platform.
How Did You Do?
| Score | Level |
|---|---|
| 12/12 | You are ready to build production SmartApps |
| 9-11 | Great foundation — review the steps you missed |
| 6-8 | Good start — go through Steps 2-6 again with the documentation open |
| Below 6 | No worries — the Quick Start is designed to be repeated. Go through it again hands-on. |
Next Steps
Now that you have completed the Quick Start, explore the full developer documentation for deeper topics:
- Consume Data — learn about windowing, data quality, and advanced data consumption
- Produce Recommendations — build rich recommendations with evidence
- Produce Custom Actions — create email notifications, work orders, and more
- Define Asset Parameters — let Operations tune your SmartApp per asset
Good luck and Happy Learning !