Skip to content

2022

  • 2 min read

Release 4.8

November 2022 - (Release 4.8)

Whats New ?

  • Kelvin API Data Label detailed documentation update
  • Updated and tested all the documentation on the Kelvin SDK Clients - Command Line / Terminal, Javascript, Python.
  • Kelvin Maps improvements in the Process and Rules sections
  • Multi-Instance tools guides added
  • Added hover-over information for glossary terms to all pages
  • Major update to Changelog structure and converted to blog format for easy RSS (future feature) connections.
  • Tutorial Descriptions page improvements on layout and information

Upgraded Kelvin API Documentation

All API requests listed here have gone through a rigorous upgrade to its documentation on the API description, parameter details, defaults, options and warnings.

  • Data Label API

Get Data Labels Clustering, Create Data Label, Filter Data Label, Create Label, List Label, Create Label Metadata Bulk, Delete Label Metadata Bulk, Delete Label, Get Label, Create Label Metadata, List Label Metadata, Delete Label Metadata, Get Label Metadata, Update Label Metadata, Update Label, Get Data Label Last, List Data Label, Get Data Label Range, Delete Data Label, Get Data Label, Update Data Label

New Documentation Pages

  • Getting Started Guides -> GSG Working with Dev, Test & Prod Instances page created
  • Documentation -> Cloud Server -> Kelvin API Categories -> Data Labels page created
  • Documentation -> Cloud Server -> Kelvin API Categories -> Labels page created
  • Documentation -> Kelvin SDK -> SDK Clients -> Javascript -> Node.js page created
  • Documentation -> Kelvin SDK -> SDK Clients -> Javascript -> Vue page created
  • Documentation -> Kelvin SDK -> SDK Clients -> Javascript -> React page created
  • Documentation -> Kelvin SDK -> SDK Clients -> Javascript -> Angular page created

Updated Documentation Pages

  • Kelvin Overview -> Recommended Reading page updated
  • Getting Started Guides -> Getting Started Guide Overview page updated
  • Getting Started Guide -> GSG Guide by Profession page updated
  • Getting Started Guide -> GSG Kelvin Documentation page updated
  • Getting Started Guides -> GSG Cloud Server -> GSG Kelvin Manager UI page updated
  • Getting Started Guides -> GSG Cloud Server -> GSG Kelvin SDK page updated
  • Kelvin Overview -> Cloud Server -> Kelvin Nodes page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Dashboard page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Asset Details page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Rules Editor page updated

Updated Tutorials

  • Kelvin Tutorials -> Cloud Server Tutorials -> Kelvin API Tutorials -> Create a New Control Change Request API page updated
  • Kelvin Tutorials -> Cloud Server Tutorials -> Kelvin API Tutorials -> Create and Monitor a Control Change with Kelvin API page updated
  • Kelvin Tutorials -> Cloud Server Tutorials -> Foundational Tutorials -> From Scratch to MQTT Data Inflow (Written) ≧ 4.3.0 page updated
  • Kelvin Tutorials -> Cloud Server Tutorials -> Kelvin Bridges -> Creating an OPC UA Bridge (Video) ≥ 4.0 page updated
  • Kelvin Tutorials -> Cloud Server Tutorials -> Kelvin Bridges -> Create a Modbus Bridge page updated
  • Kelvin Tutorials -> Cloud Server Tutorials -> Machine Learning Tutorials -> Real Time Edge Computer Vision to Kelvin Metrics page updated
  • Kelvin Tutorials -> Kelvin Maps Tutorials -> Create a Kelvin Maps Process and Control an Air Conditioner page updated

Tested Tutorials

  • Kelvin Tutorials -> Kelvin Bridges -> Creating an OPC UA Bridge (Video) ≥ 4.0 was tested with some notes added for the minor differences between v4.0 and v4.8.
  • 1 min read

Release 4.7 Update 1

October 2022 - (Release 4.7 / 1)

Whats New ?

  • Kelvin Maps has a new Kelvin Rules Editor for creating complex control change algorithms.
  • Kelvin Apps and Kelvin Bridges can be installed at a Kelvin Node offline physically by downloading the image, transporting by USB stick and installing through the terminal interface of the Kelvin Node.
  • Some minor improvements to the documentation pages

New Documentation Pages

  • Documentation -> Kelvin Maps -> Kelvin Map Editors -> Kelvin Maps Rules Editor page created

Updated Documentation Pages

  • Kelvin Overview -> Recommended Reading page updated
  • Kelvin Overview -> Cloud Server -> Kelvin Nodes page updated
  • Kelvin Overview -> Cloud Server -> Kelvin Apps page updated
  • Kelvin Overview -> Kelvin Maps -> Kelvin Maps Overview page updated
  • Getting Started Guides -> GSG Kelvin Maps -> GSG Create Enterprise Hierarchy page updated
  • Documentation -> Cloud Server -> Kelvin Manager UI -> Connection -> Bridges -> Bridges page updated
  • Documentation -> Cloud Server -> Kelvin Manager UI -> Connection -> Nodes page updated

New Tutorials

  • Install a Kelvin App or Kelvin Bridge to Offline Kelvin Node (Written) ≧ 4.7 tutorial created

Tested Tutorials

This section shows all tutorials that have been tested with later versions of the Kelvin release package from when they were first written.

  • Bridge Tutorials -> Create a Modbus Bridge (Written) tested on v4.7
  • 3 min read

Release 4.7

October 2022 - (Release 4.7)

Whats New ?

  • Kelvin Maps continues its rapid development cycle and incorporates the new features;
  • "Blueprint" tag which means this is a complete simulation process.
  • Carbon Maps KWH Cost and Carbon Offset Price can now be set by users.
  • Kelvins new structure using Kelvin Assets Group Enterprise & Business Units which replaces Sites & Production Lines.
  • Kelvin layout changes and now fixed information is located on the left sidebar.
  • You can now send dynamic parameter information from Kelvin Maps to Kelvin Apps using AI Control rather than having to create Kelvin Metrics. *
  • Kelvin Assets Group has a new type - Business Unit which is used in Kelvin Maps to group together common Kelvin Maps Processes.
  • Last Modified on pages from now on will have more details to make it easier to keep up with new developments in the documentation pages.
  • The Getting Started Guides have been broken up for easily finding the area of interest and the pages improved.

Upgraded Kelvin API Documentation

All API requests listed here have gone through a rigorous upgrade to its documentation on the API description, parameter details, defaults, options and warnings.

  • Bridge API

Deploy Bridge, List Bridge, List MQTT Topics, List Bridge Assets, List Bridge Data Streams, Delete Bridge, Get Bridge, List Bridge Metrics, Start Bridge, Stop Bridge

  • Storage API

Create Historian Metric, Get Historian Metric Last, Get Historian Metric Last Advanced, List Historian Metric, Delete Historian Range, Download Historian Metrics, Get Historian Metric Range, Get Historian Metric Advanced Range, Update Historian Metric, Upload Historian Metrics

New Documentation Pages

  • Getting Started Guides -> GSG Cloud Server -> GSG Kelvin Node page created
  • Getting Started Guides -> GSG Cloud Server -> GSG Kelvin Assets page created
  • Getting Started Guides -> GSG Cloud Server -> GSG Kelvin Metrics page created
  • Getting Started Guides -> GSG Kelvin Maps -> GSG Create Kelvin Maps Process page created
  • Getting Started Guides -> GSG Kelvin Maps -> GSG Create Enterprise Hierarchy page created
  • Getting Started Guides -> GSG Kelvin Maps -> GSG Assets Control page created

Updated Documentation Pages

  • Kelvin Overview -> Overview page updated
  • Kelvin Overview -> Cloud Server -> Kelvin Assets page updated
  • Kelvin Overview -> Kelvin Maps -> Kelvin Maps Overview page updated
  • Kelvin Overview -> Kelvin Maps -> OEE in Kelvin page updated
  • Kelvin Overview -> Kelvin Maps -> Carbon Maps page updated
  • Kevin Overview -> Kelvin CoPilots page updated
  • Getting Started Guides -> Getting Started Guide Overview page updated
  • Getting Started Guides -> GSG Kelvin 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 -> Kelvin Maps -> Kelvin Maps Overview page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Dashboard page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Process View page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Asset Details page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Alarms page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Process Maps Editor page updated
  • Kelvin Tutorials -> Tutorial List by Description page updated

New Tutorials

  • New written Kelvin SDK tutorial on Copy Assets and Metrics using Python SDK
  • New written Kelvin SDK tutorial on Copy Kelvin Bridge using Python SDK
  • New written Kelvin SDK tutorial on Create Custom Symbol for Kelvin Maps from SVG using Python SDK
  • New written Kelvin SDK tutorial on Create Simulated OEE Data for Kelvin Assets & Processes using Python SDK
  • New written Kelvin SDK tutorial on Copy Kelvin Maps Processes using Python SDK
  • New written Kelvin SDK tutorial on Create Simulated Production, Shift and Team Info using Python SDK
  • New written Kelvin Bridge tutorial on Deploy a Kelvin App OPC UA Simulation Server
  • New written Kelvin Maps tutorial on Create a Kelvin Maps Process and Control an Air Conditioner.

Updated Tutorials

  • Updated written Kelvin ML tutorial on Real Time Edge Computer Vision to Kelvin Metrics.

Tested Tutorials

This section shows all tutorials that have been tested with later versions of the Kelvin release package from when they were first written.

  • From Scratch to MQTT Data Inflow tutorial tested successfully with v4.6 (original tests on v4.3.0).
  • 3 min read

Release 4.6

August 2022 - (Release 4.6)

Whats New ?

  • Kelvin API reference documentation is going through a major upgrade in descriptions and key links to Kelvin Documentation for easy terminology reference.
  • Kelvin API now has two swagger.json files to download - one with HTML links and one a plain text version. This is useful for API clients that can not process HTML in descriptions.
  • Kelvin API reference theme and UX overhaul.
  • Kelvin Maps continues to go through major development cycles. Most infographics, terminology and UX is updated to reflect the changes.
  • Carbon Maps is a major new feature documented.
  • Upgraded pipeline and software for the auto-generated file swagger.json following latest standards.
  • Rearranging the Kelvin Overview -> Kelvin Maps structure to give better structure on information of key features.
  • New Security Policy and Certifications that document Kelvin's security conscious approach to management, development and deployment. Also listed CSA Level 1 and SSAE 18 SOC 2 Type II certifications Kelvin has attained.
  • Split GSG Kelvin API section with a sub-menu to allow for separated detailed GSG's for different API functions.
  • Many minor updates including Control Change Infographic speed reduced for easier viewing of the change process

Upgraded Kelvin API Documentation

All API requests listed here have gone through a rigorous upgrade to its documentation on the API description, parameter details, defaults, options and warnings.

  • Asset API

/assets/class/create, /assets/class/list, /assets/class/{asset_class_name}/delete, /assets/class/{asset_class_name}/get, /assets/class/{asset_class_name}/update, /assets/create, /assets/create/upload, /assets/failure-overview/list, /assets/hierarchy/get, /assets/hierarchy/update, /assets/list, /assets/oee/get, /assets/statistics/get, /assets/status/count/get, /assets/status/current/get, /assets/templates/create, /assets/templates/list, /assets/templates/{asset_template_name}/delete, /assets/templates/{asset_template_name}/get, /assets/templates/{asset_template_name}/update, /assets/types/create, /assets/types/list, /assets/types/{asset_type_name}/delete, /assets/types/{asset_type_name}/get, /assets/types/{asset_type_name}/metadata/create, /assets/types/{asset_type_name}/metadata/list, /assets/types/{asset_type_name}/metadata/{asset_type_metadata_name}/delete``/assets/types/{asset_type_name}/metadata/{asset_type_metadata_name}/get, /assets/types/{asset_type_name}/metadata/{asset_type_metadata_name}/update, /assets/types/{asset_type_name}/update, /assets/{asset_name}/datastreams/list, /assets/{asset_name}/delete, /assets/{asset_name}/get, /assets/{asset_name}/hierarchy/get, /assets/{asset_name}/update

  • Metrics API

/metrics/create, /metrics/create/upload, /metrics/list, /metrics/{metric_name}/delete, /metrics/{metric_name}/get, /metrics/{metric_name}/update

  • Control Changes API

/control-changes/create, /control-changes/last/get, /control-changes/list, /control-changes/range/get, /control-changes/sync/{node}/download, /control-changes/sync/{node}/upload, /control-changes/{control_change_id}/get

New Documentation Pages

  • Kelvin Overview -> Security Policy & Certifications page added
  • Kelvin Overview -> Kelvin Maps -> OEE in Kelvin page added
  • Kelvin Overview -> Kelvin Maps -> Carbon Maps page added
  • Getting Started Guides -> GSG Kelvin API -> GSG Kelvin API - Online Reference page added
  • Documentation -> Cloud Server -> Kelvin SDK -> SDK Authentication page added

Updated Documentation Pages

  • Kelvin Overview -> Overview page updated
  • Kelvin Overview -> Recommended Reading page updated
  • Kelvin Overview -> Cloud Server -> Kelvin Assets page updated
  • Kelvin Overview -> Cloud Server -> Kelvin Apps page updated
  • Kelvin Overview -> Cloud Server -> Kelvin Alarms page updated
  • Kelvin Overview -> Cloud Server -> Kelvin Control Change page updated
  • Kelvin Overview -> Kelvin Maps -> Kelvin Maps Overview page updated
  • Kelvin Overview -> Kelvin CoPIlot page updated
  • Getting Started Guides -> GSG Kelvin Manager UI page updated
  • Getting Started Guides -> GSG Kelvin API page updated
  • Getting Started Guides -> GSG Kelvin API -> GSG Kelvin API - Control Change page updated
  • Getting Started Guides -> GSG Kelvin SDK page updated
  • Documentation -> Cloud Server -> Kelvin API -> Kelvin API Overview page updated
  • Documentation -> Cloud Server -> Kelvin Manager UI -> Kelvin Manager UI Overview page updated
  • Documentation -> Cloud Server -> Kelvin Manager UI -> Monitoring -> Alarms Monitoring 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 SDK -> Kelvin SDK Installation page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Overview page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Dashboard page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Process View page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Asset Details page updated
  • Documentation -> Kelvin Maps -> Kelvin Maps Process Map Editor page updated
  • Some legacy documentation and tutorials updated for consistent terminology only (content may not be consistent with latest versions of Cloud Server)

New Tutorials

  • New written API tutorial on Create/Edit a Custom Kelvin Template
  • New written API tutorial on Create Kelvin Asset and Kelvin Metric with Kelvin API
  • New written API tutorial on Install and Setup Postman for API Requests
  • New written API tutorial on Create, Read, Delete Kelvin Alarms with Kelvin API
  • Duplicate GSG Kelvin API - Control Change to API tutorial on Create and Monitor a Control Change with Kelvin API
  • 1 min read

Release 4.6

Kelvin Maps

  • Added Carbon Maps with inefficiency calculations
  • New Data Explorer integrated into Kelvin Maps
  • Added control change & alarm trigger points into Data Explorer
  • Kelvin Maps UX improvements

Kelvin Manager

  • New endpoints rules engine API