Hierarchy

Index

Constructors

constructor

Properties

acpName

acpName: string

Unique identifier name of the acp_name ( This is a Kelvin Node ) linked to this Kelvin Bridge.

created

created: Date

Time of creation of this Kelvin Bridge in ISO 8601 UTC date/time format. Example; "2022-07-08T08:41:01.657916Z".

name

name: string

Unique identifier name for the Kelvin Bridge.

This contains only lowercase alphanumeric characters. The ., _ and - characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.

payload

payload: any

Contains the configuration dictionary, metrics_map dictionary and logging_level parameter of the Kelvin Bridge.

The configuration dictionary contains all the information required to connect to the assets. The information supplied will depend on which type of protocol the Kelvin Bridge uses. There are four protocols; modbus, opc-ua, mqtt, roc.

The metrics_map dictionary contains a list of all Kelvin Assets / Kelvin Metric pairs on this Kelvin Bridge and their configuration details.

protocol

protocol: string

Type of protocol used by the Kelvin Bridge.

there are 4 types of protocol type options; opc-ua, mqtt, modbus, roc.

title

title: string

Display name (title) for the Kelvin Bridge . This is the friendly name displayed.

It can use any character, numeric, space and special character in this parameter.

updated

updated: Date

Time of modifying any variable of this Kelvin Bridge in ISO 8601 UTC date/time format. Example; "2022-07-08T08:41:01.657916Z".

workloadName

workloadName: string

Unique identifier name of the workload_name ( This is a Kelvin App, which is in this case is a Kelvin Bridge ) linked to this Kelvin Bridge.

Methods

clone

getClass

  • getClass(): Function

mapping

  • mapping(): {}

serializeArray

  • serializeArray(obj: any[]): Object

serializeObject

  • serializeObject(obj: any): any

serializeObjectInstance

  • serializeObjectInstance(obj: Object): Object

stringify

  • stringify(): string

toJSONObject

  • toJSONObject(): Object