Hierarchy

Index

Constructors

constructor

Properties

created

created: Date

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

dataTypeName

dataTypeName: string

Type of data being recorded to this Kelvin Metric.

there are 13 types of data type options; raw.boolean, raw.dynacard, raw.float32, raw.float64, raw.int8, raw.int16, raw.int32, raw.int64, raw.uint8, raw.uint16, raw.uint32, raw.uint64 and raw.text.

dataTypeVersion

dataTypeVersion: string

Version of the data type.

For example 2.0.0.

displayUnit

displayUnit: string

Units for the Kelvin Metric.

This can be anything to describe the Kelvin Metric units. For example Amp, Hz, ॰F, etc.

name

name: string

Unique identifier name for the Kelvin Metric.

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.

semanticTypeName

semanticTypeName: string

Type of sensor that is streaming data to the Kelvin Metric. Depending on the options chosen, there may be more properties available which will be saved to the SemanticTypeProperties parameters.

There are currently 28 Semantic Type Names available; None, Accelerometer, Current, Dynacard, Event Flow Rate, Force, Frequency, Gas Flow Rate, Gas Volume, Humidity, Latitude, Length, Location, Longitude, Mass, Power, Pressure, Relative Humidity, State, Temperature, Time Date, Time Span, Torque, Velocity, Vibration, Voltage, Volume, Volume Flow Rate.

semanticTypeProperties

semanticTypeProperties: any

Additional properties depending on the selected SemanticTypeName parameter chosen.

For example; if the semantic type chosen is temperature, then there will be an additional parameter in semantic type properties for temperature unit where fahrenheit or celsius can be chosen.

title

title: string

Display name (title) for the Kelvin Metric . 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 Metric in ISO 8601 UTC date/time format. Example; "2022-07-08T08:41:01.657916Z".

write

write: boolean

Defines whether this Kelvin Metric is read only (false) or read/write (true).

If the Kelvin Control Change feature is used on this Kelvin Metric, then this parameter must be true.

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