import DeviceMessage from 'opengate-js/src/collection/devices/DeviceMessage.js'

public class | source

DeviceMessage

Extends:

Event → DeviceMessage

This is a base object contains methods to send unstructured IoT information to be processed & collected by the platform.

Constructor Summary

Public Constructor
public	constructor(Reference: InternalOpenGateAPI) Constructor

Method Summary

Public Methods
public	create(): *
public	withDataStream(datastream: Datastream): deviceMessages Set the datastream attribute
public	withDataStreamVersion(version: string): deviceMessages Set the dataStream version attribute
public	withDeviceId(deviceId: string): deviceMessages Set the deviceId attribute
public	withDmmVersion(version: string): deviceMessages Set the version attribute
public	withId(id: string): deviceMessages Set the id attribute

Inherited Summary

From class Event
public	composeElement(): *
public	withCommsModule(communicationsModules: *): Event Set the powerSupply attribute
public	withCpuUsage(cpuUsage: *): Event Set the cpuUsage attribute
public	withCurrentTemperature(currentTemperature: string): Event Set the currentTemperature attribute
public	withDateLocation(date: string): Event Set the date attribute
public	withDeviceId(deviceId: string): Event Set the deviceId attribute
public	withEventDescription(description: string): Event Set the description attribute
public	withEventId(id: string): Event Set the id attribute
public	withEventName(name: string): Event Set the name attribute
public	withHardware(hardware: Hardware): Event Set the hardware attribute
public	withLatitude(latitude: number): Event Set the latitude attribute
public	withLongitude(longitude: number): Event Set the longitude attribute
public	withMaximumTemperature(maximumTemperature: string): Event Set the maximum attribute
public	withMinimumTemperature(minimumTemperature: string): Event Set the minimum attribute
public	withNonVolatilStorage(nonVolatilStorage: *): Event Set the nonVolatilStorage attribute
public	withOperationalStatus(operationalStatus: string): Event Set the operationalStatus attribute
public	withPath(path: string): Event Set the path attribute
public	withPowerSupply(powerSupply: *): Event Set the powerSupply attribute
public	withRam(ram: *): Event Set the Ram attribute
public	withSoftware(software: software): Event Set the software attribute
public	withStatusTemperature(unitTemperature: string): Event Set the unitTemperature attribute
public	withTemperatureAverage(averageTemperature: string): Event Set the average attribute
public	withTrendTemperature(unitTemperature: string): Event Set the unitTemperature attribute
public	withUnitTemperature(unitTemperature: string): Event Set the unitTemperature attribute
public	withUpTime(upTime: number): Event Set the upTime attribute
public	withVolatilStorage(volatilStorage: *): Event Set the volatilStorage attribute

Public Constructors

public constructor(Reference: InternalOpenGateAPI) source

Constructor

Override:

Event#constructor

Params:

Name	Type	Attribute	Description
Reference	InternalOpenGateAPI		to the API object.

Public Methods

public create(): * source

Return:

public withDataStream(datastream: Datastream): deviceMessages source

Set the datastream attribute

Params:

Name	Type	Attribute	Description
datastream	Datastream		required field

Return:

deviceMessages

public withDataStreamVersion(version: string): deviceMessages source

Set the dataStream version attribute

Params:

Name	Type	Attribute	Description
version	string		required field

Return:

deviceMessages

public withDeviceId(deviceId: string): deviceMessages source

Set the deviceId attribute

Override:

Event#withDeviceId

Params:

Name	Type	Attribute	Description
deviceId	string		optional field

Return:

deviceMessages

public withDmmVersion(version: string): deviceMessages source

Set the version attribute

Params:

Name	Type	Attribute	Description
version	string		required field

Return:

deviceMessages

public withId(id: string): deviceMessages source

Set the id attribute

Params:

Name	Type	Attribute	Description
id	string		required field

Return:

deviceMessages