Skip to content

Changelog

Release 4.5 Update 1

July 2022 - Midcycle Release (Release 4.5 / 1)

Whats New ?

  • All references to KICS and KSOS have been removed. It is all now known officially as Kelvin for short and Kelvin Collaborative Control Platform in full.
  • All references to KSDK have been removed. It is now officially known as Kelvin SDK and the Python package is kelvin-sdk with the command line command is kelvin.
  • Added information on Kelvin Failure Detection AI alarm details and analysis tabs in Kelvin Maps.
  • A number of minor improvements to the documentation

Updated Documentation Pages

  • Kelvin Overview -> Overview page updated
  • Kelvin Overview -> Kelvin Maps -> Kelvin Maps Overview page updated
  • Getting Started Guide -> GSG Kelvin SDK page updated
  • Documentation -> Cloud Server -> Kelvin SDK -> Kelvin SDK Installation page updated
  • Documentation -> Cloud Server -> Kelvin SDK -> SDK Authentication legacy page reinstated (temporarily)
  • Documentation -> Kelvin Maps -> Kelvin Maps Asset Details page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Alarms page updated
  • Legacy documentation pages updated for consistent terminology only (content may not be consistent with latest versions of Cloud Server)

Tutorial New & Updates

  • Updated tutorial for Install Kelvin SDK in MacOS X Catalina (Written)
  • Updated tutorial for Install Kelvin SDK in Windows (Written)
  • Updated tutorial for Install Kelvin SDK in Ubuntu 20.04 (Written)
  • Updated tutorial for From Scratch to MQTT Data Inflow (Written)
  • Legacy tutorial pages updated for consistent terminology only (content may not be consistent with latest versions of Cloud Server)

Release 4.5

Kelvin Maps

  • Added Asset 2D and 3D view with metrics and alarms
  • Added option to upload custom image symbols to the line editor
  • Added Asset Settings page that allows making control changes on the setpoints of an Asset
  • Improved Alarm Detail with list of failure modes and chart view

Kelvin Manager

  • New endpoints on Control Changes API to retrieve historical view of control changes for an asset
  • Removed unnecessary entity types and replaced them with "group" entity type
  • Replaced the hardcoded alarm severity name/title with configurable values.

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

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

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