@mangar2/message v1.4.2

Abstract

This is the basic class holding MQTT message information The yaha home automation is based on messages . Nothing happens without a message . The message runs from creator to broker and then to the receiver . On every step , a reason will added to the mesage including a timestamp to get a full trace .

Contents

• Meta
• Type definitions
• Class Message
  • Parameters
  • Members
  • Methods
    • addReason
    • getDateOfNewestChange
    • isOn
    • toJSON
    • validate

Meta

Type definitions

ReasonEntry {Object}

Reason {Array.}

Class Message

new Message(topic, value, reason, now)

Creates a message for MQTT

Example

const message = new Message('this/is/a/topic', 'a value', 'a reason')

Message Parameters

Message Members

Message Methods

addReason

addReason (reason, now)

Adds a reason to the reason array

addReason Parameters

getDateOfNewestChange

getDateOfNewestChange () => {Date}

Gets the latest Date of the message by browsing the reasons

getDateOfNewestChange returns

isOn

readonly isOn ()

returns true , if the value is "on" ( 1 , 'on' , 'true' , true )

toJSON

toJSON ()

ensures that the JSON format is well formatted ( value instead of _value )

validate

static validate (object)

Checks the consistence of a message object

validate Parameters

validate throws