Skip to content

Changelog

  • 2 min read

Release 4.5

June 2022 - (Release 4.5)

Whats New ?

  • Kelvin Maps alarm comments now timestamp the status change for easy historical reference to alarm evolution.
  • Kelvin Maps now support custom Symbols in the Line Editor Symbols Library.
  • Control Change Getting Started Guide now has a new API documented - /control-changes/list. This gives a full list of control change requests and its status on any asset(s).
  • Information and examples for the Control Change Manager has been embedded in many documentation locations for easy quick reference.
  • Kelvin API Reference is now embedded into the documentation. This allows the documentation versioning to also locks the version for the API reference documentation. So v4.5 documentation release references documentation for the v4.5 Kelvin API library (Previously the API reference documentation was only available for the latest version only regardless of documentation version you were looking at)
  • Kelvin API Reference Documentation (swagger.json) is getting refreshed on all comments and descriptions. This major update has started this cycle and will be an on-going process for a number of releases. Check back regularly to see the improved API swagger.json documentation.

New Documentation Pages

  • Kelvin Overview -> Recommended Reading page created
  • Documentation -> Kelvin API -> Kelvin API Reference is now upgraded to be linked to the version releases.

Updated Documentation Pages

  • Kelvin Overview -> Overview page updated
  • Kelvin Overview -> Cloud Server -> Kelvin Nodes page updated
  • Kelvin Overview -> Cloud Server -> Kelvin Bridges page updated
  • Kelvin Overview -> Cloud Server -> Kelvin Control Change page updated
  • Kelvin Overview -> Cloud Server -> Kelvin Assets page updated
  • Kelvin Overview -> Kelvin Maps page updated
  • Kelvin Overview -> Kelvin CoPilot page updated
  • Getting Started Guide -> Getting Started Guide Overview
  • Getting Started Guide -> GSG Guide by Profession page updated
  • Getting Started Guide -> GSG Kelvin API page updated
  • Getting Started Guide -> GSG Kelvin Control Change API page updated
  • Documentation -> Cloud Server -> Kelvin API -> Kelvin API Overview page updated
  • Documentation -> Cloud Server -> Kelvin Manager UI -> Management -> Assets -> Assets page updated
  • Documentation -> Cloud Server -> Kelvin SDK -> Kelvin SDK Overview page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Alarms page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Asset Details page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Line Editor page updated

Tutorial New & Updates

  • Updated tutorial compatibility with Kelvin Versions
  • New written tutorial for Create a New Control Change Request API
  • 1 min read

Release 4.4 Update 1

June 2022 - 1st Update (Mid-Release Update)

Whats New ?

  • Reorganized Getting Started Guides Order from Overview to Highly Technical
  • Added a Guide by Profession to Getting Started Guides to help advise which pages are useful to whom.
  • Kelvin Maps now has a Dashboard and Production Tabs on the home page allowing holistic view of all your assets in different metrics.
  • Improved information in Kelvin Metrics list and Kelvin Assets
  • New features in App Registry for deleting a Kelvin App or deleting one version of a Kelvin App.
  • Alarms in Kelvin Maps now has comments for group conversations on individual Kelvin Alarms.

New Documentation Pages

  • Getting Started Guides -> GSG Guide by Profession page added
  • Documentation -> Cloud Server -> Kelvin API -> Authentication page added
  • Documentation -> Cloud Server - Kelvin Manager UI -> Connections -> Bridges -> Bridges page added

Updated Documentation Pages

  • Kelvin Overview -> Cloud Server -> Kelvin Control Change Manager page updated
  • Documentation -> Cloud Server -> Kelvin Manager UI -> Management -> Metrics -> Metrics page updated
  • Documentation -> Cloud Server -> Kelvin Manager UI -> Management -> Assets -> Assets page updated
  • Documentation -> Cloud Server -> Kelvin Manager UI -> Repository -> App Registry page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Overview page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Dashboard page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Details page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Asset Details page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Alarms page updated
  • 1 min read

Release 4.4

Kelvin Maps

  • Added new Dashboard page that provide failure statistics for sites, production lines and assets
  • Added new Asset Detail page that provides a 3D detailed view of the asset
  • Added ability to start a conversation thread on the Alarm Detail
  • Added left side panel for quick access to the Asset Hierarchy
  • Left side panel with navigation Improvements
  • Added 200+ symbols to Line Editor page
  • Simplified flow for searching assets and associating metrics in the Line Editor page
  • Enhancements on OEE Calculation

Kelvin Manager

  • Added the option to delete an Application and an Application Version on the App Registry Detail page
  • Improved Dashboard Monitoring page to only show statistics for assets
  • Improved Asset Monitoring page UX by adding a “Data Viewer” button to quickly visualize data
  • Improved Metrics List page UX by adding additional table columns: “Data Type”, “Write” and “Updated”
  • Improved Bridge Detail page UX by adding additional table columns: “Data Type” and “Display Unit”
  • Added full UUID support for resources: Asset, Asset Type, Asset Class, Alarm Type, Alarm Class and App Registry

Control Change Manager

  • Added new API for sending control changes from the cloud to the edge nodes

Failure Detection

  • Added new API for retrieving Failure Detection Events
  • 2 min read

Release 4.4

May 2022 (Release 4.4)

Whats New ?

  • Home Page updated to add Kelvin Maps as a link.
  • Kelvin Maps now has a detailed assets page for viewing individual assets and it's corresponding alarms.
  • Kelvin Maps now has an Kelvin Asset list hierarchy that can appear on the left hand side bar.
  • Offline simulation with imported data feature is maturing
  • Many new UX improvements for Kelvin Maps
  • Kelvin SDK now has a cheatsheet you can download as a PDF
  • Improvements to Kelvin SDK and Kelvin API documentation has started. Many new working examples added in Hints and in GSG Kelvin SDK (CLI) and GSG Kelvin SDK (Python)

New Documentation Pages

  • Overview -> Kelvin Control Change page added
  • Getting Started Guides -> GSG Kelvin SDK (Python) page added
  • Documentation -> Cloud Server -> Kelvin API -> Kelvin API Hints -> Dashboard page added
  • Documentation -> Cloud Server -> Kelvin API -> Kelvin API Hints -> Assets Monitoring page added
  • Documentation -> Kelvin Maps -> Kelvin Maps Asset Details page added
  • Documentation -> Cloud Server -> Kelvin SDK -> Kelvin SDK Cheatsheet page added
  • Documentation -> Cloud Server -> Kelvin SDK -> Kelvin SDK Client Library page added
  • Documentation -> Cloud Server -> Kelvin SDK -> Python SDK Library -> Kelvin SDK (Python) page added
  • Documentation -> Cloud Server -> Kelvin SDK -> Python SDK Library -> Python Reference Library added
  • Documentation -> Cloud Server -> Kelvin API -> Kelvin API Overview page added
  • Documentation -> Cloud Server -> Kelvin API -> Kelvin API Reference page added

Updated Documentation Pages

  • Home page updated
  • Kelvin Overview -> Overview page updated
  • Kelvin Overview -> Kelvin Maps page updated
  • Getting Started Guides -> Getting Started Guide Overview page updated
  • Getting Started Guides -> GSG Cloud Server page updated
  • Getting Started Guides -> GSG Kelvin SDK (CLI) page updated
  • Documentation -> Cloud Server -> Kelvin SDK -> Kelvin SDK Overview page updated
  • Documentation -> Cloud Server -> Kelvin API -> Kelvin API Overview page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Overview page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Dashboard page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Details page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Alarms page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Line Editor page updated

Tutorial New & Updates

  • Updated the compatible Cloud Server versions for each tutorial
  • New written tutorial for Deploy a Modbus Simulator to a Kelvin Node
  • New written tutorial for Create a Modbus TCP Bridge
  • New written tutorial for Real Time Edge Computer Vision to Kelvin Metrics
  • New written tutorial for Create a New Alarm with Kelvin API > 4.1
  • Updated written tutorial Install Kelvin SDK in Ubuntu 20.04 (Written)
  • 3 min read

Release 4.3

April 2022 (Release 4.3)

Whats New ?

  • Major revamp on the Kelvin Asset structure with a new Kelvin Groups added to Device Type. Device Type now changed to Entity Type.
  • Documentation restructured to reflect Kelvin's three main product groups - Cloud Server, Kelvin Maps and Kelvin Copilot.
  • The themes for the documentation has been tweaked and improved to make titles and sections more clear and vibrant within the Kelvin color scheme.
  • A new "Was this Helpful?" feedback question has been put at the bottom of all pages.
  • A new Comments section has been put at the bottom of all pages to allow all users to interact and help.
  • Google analytics with GDPR compliance has been added to understand which document pages are most popular.
  • Search bar has been improved with search suggestions as you type.
  • When clicking on search link, the page will highlight all references to the searched word.
  • A "Back to Top" button now appears when scrolling long pages.
  • The tables in the documentation has been improved to be visually more pleasing and clear.
  • All tutorials from Documentation -> Kelvin Manager UI -> Video Tutorials page have been moved to a dedicated Tutorials section and the original page deleted.
  • Major restructure of the tutorials menu and layout. Tutorials now have a separate classification structure for easy searching.
  • Disabled XHR instant loading due to inconsistencies with the feedback question. To be reactivated in version 4.4 doc release.

Documentation New & Updates

  • Change the name Control Manager UI to Kelvin Manager UI throughout the Documentation
  • Kelvin Overview -> Kelvin Maps page added
  • Kelvin Overview -> Kelvin Copilot page added
  • Getting Started Guides -> Getting Started Guide Overview page added
  • Getting Started Guides -> GSG Kelvin Documentation page added
  • Getting Started Guides -> GSG Cloud Server page added
  • Getting Started Guides -> GSG Kelvin SDK page added.
  • Getting Started Guides -> GSG Kelvin Manager UI page added
  • Getting Started Guides -> GSG Kelvin API page added
  • Documentation -> Cloud Server -> Kelvin SDK -> Kelvin SDK Overview page added
  • Documentation -> Cloud Server -> Kelvin SDK -> Kelvin SDK Installation page added
  • Documentation -> Cloud Server - Kelvin API -> Kelvin API Overview page added
  • Documentation -> Kelvin Maps -> Kelvin Maps Overview page added
  • Documentation -> Kelvin Maps -> Kelvin Maps Dashboard page added
  • Documentation -> Kelvin Maps -> Kelvin Maps Details page added
  • Documentation -> Kelvin Maps -> Kelvin Maps Alarms page added
  • Documentation -> Kelvin Maps -> Kelvin Maps Line Editor page added
  • Kelvin Overview -> Overview page updated
  • Kelvin Overview -> Cloud Server -> Kelvin Assets page updated
  • Kelvin Overview -> Cloud Server -> Kelvin Alarms page updated
  • Kelvin Overview -> Cloud Server -> Kelvin Apps page updated
  • Getting Started Guides -> GSG Kelvin Documentation page updated
  • Getting Started Guides -> GSG Kelvin API page updated
  • Documentation -> Cloud Server -> Kelvin Manager UI -> Kelvin Manager UI Overview page updated
  • Documentation -> Cloud Server -> Kelvin Manager UI -> Management -> Assets -> Assets page updated
  • Documentation -> Cloud Server -> Kelvin Manager UI -> Management -> Assets -> Asset Types page updated
  • Documentation -> Cloud Server -> Kelvin Manager UI -> Management -> Assets -> Asset Classes page updated

Tutorial New & Updates

  • New video tutorial for How to Add New Kelvin Metric.
  • New video tutorial for Edit or Delete a Kelvin Metric
  • New video tutorial for How to Install a Kelvin Node
  • New written tutorial for From Scratch to MQTT Data Inflow. This covers;
  • Installing a Kelvin Node
  • Creating and deploying a Kelvin App (Python)
  • Creating Kelvin Assets and Metrics
  • Creating and deploying a Kelvin MQTT Bridge
  • Viewing the incoming data in the Time Series graphs
  • New written tutorial for Kelvin SDK Python Bridge Class Example. This covers;
  • Creating and deploying a Kelvin App (Python)
  • How to connect a python script to a third party API
  • Broadcasting the incoming data on the internal Kelvin Node MQTT Broker
  • Emulating the kelvin App (Python) on your computer
  • Using third party program to listen on the emulated Kelvin Node MQTT Broker
  • New written tutorial for Install Kelvin SDK in Windows
  • New written tutorial for Install Kelvin SDK in MacOS X
  • New written tutorial for Install Kelvin SDK in Ubuntu
  • New written tutorial to Deploy Node Red as a Kelvin App
  • New written tutorial Using Sensitive Information in a Kelvin App with Secrets
  • New video tutorial for Add a New Kelvin Asset for Cloud Server v4.3.0
  • New video tutorial for Add a New Sensor to Existing Kelvin Asset for Cloud Server v4.3.0