@mangar2/messagetree v1.5.0

Abstract

This function implements a cleanup of the message tree Elements with no actual message are deleted

This file includes helper functions to compress history entries of messages

History entry for data with same value and reason coming in regular intervals . These values are counted and not stored separately

This class manages a message store in tree format . yaha home automation uses it to store all communication between its components .

Contents

• Meta
• Type definitions
• Global Functions
  • addToHistory
  • cleanNodeRec
  • createIntervalEntryFromTimeEntry
  • decompress
  • getLastIntervalEntries
  • isIntervalEntry
  • splitTimeEntryIfAppropriate
  • splitTimeValueEntryIfAppropriate
• Class MessageTree
  • Parameters
  • Methods
    • _isRequiredReason
    • addData
    • cleanup
    • getNode
    • getNodes
    • getSection
    • persist
    • readTreeFromPersistedFile

Meta

Type definitions

Entry {Object}

Entry to add to the history | Name | Type | Description | | ---- | ---- | ------- | | time | timestamp | timestamp of the entry | | | value | Any | message value | | | reason | Array.<Object> | message trace information | |

SingleEntry {Object}

History entry holding a single value | Name | Type | Description | | ---- | ---- | ------- | | type | 'single' | type of the entry | | | time | timestamp | timestamp of the entry | | | value | Any | value of the entry | | | reason | Array.<Object> | reason of the entry | |

TimeValueEntry {Object}

History entry holding several different values with the same reason | Name | Type | Description | | ---- | ---- | ------- | | type | 'timeValue' | type of the entry | | | values | Array.<Object.<time:number, value:Any>> | time/value pairs | | | reason | Array.<Object> | reason of the oldest entry | |

TimeEntry {Object}

History entry holding several identical values with the same reason | Name | Type | Description | | ---- | ---- | ------- | | type | 'time' | type of the entry | | | timestamps | Array.<number> | timestampls of the entries | | | reason | Array.<Object> | reason of the oldest entry | |

HistoryEntry {SingleEntry, TimeValueEntry, TimeEntry, IntervalEntry}

Options {Object}

Options to manage the message tree and its history | Name | Type | Description | | ---- | ---- | ------- | | upperBoundFactor | number | factor to multiply the joined interval for the upper bound | | | upperBoundAddInMilliseconds | integer | constant to add to the joined interval for the upper bound | | | lowerBoundFactor | number | factor to multiply the joined interval for the lower bound | | | lowerBoundSubInMilliseconds | integer | constant to sub from the joined interval for the lower bound | | | maxHistoryLength | integer | maximal amount of entries in the history | | | historyHysterese | integer | amount of entries to delete , if history exeeds max length | | | maxValuesPerHistoryEntry | integer | maximum amount of values per history entry | | | lengthForFurtherCompression | integer | history timeValue length to look for additional compression | |

TimeEntry {Object}

History entry holding several identical values with the same reason | Name | Type | Description | | ---- | ---- | ------- | | type | 'time' | type of the entry | | | timestamps | Array.<number> | timestampls of the entries | | | reason | Array.<Object> | reason of the oldest entry | |

Reason {Array.}

Decompressed {Object}

IntervalEntry {Object}

History entry holding several identical values with the same reason and regular updates | Name | Type | Description | | ---- | ---- | ------- | | type | 'interval' | type of the entry | | | amount | number | amount of entries | | | value | number | value of the entry | | | reason | Array.<Object> | reason of the oldest entry | | | firstTime | timestamp | timestamp of the oldes entry | | | lastTime | timestamp | timestamp of the newest entry | |

MessageNode {Object}

Global functions

addToHistory

addToHistory (history, entryToAdd, options) => {Array.<HistoryEntry>}

Adds an entry to the history and possible add it or join it with the latest history entry

addToHistory Parameters

addToHistory returns

cleanNodeRec

cleanNodeRec (tree, three, daysWithoutUpdateToBeRemoved)

Removes all outdated nodes . An outdated node is a node with no update in the last days and without any child with an update in the last days

cleanNodeRec Parameters

tree properties

three properties

createIntervalEntryFromTimeEntry

createIntervalEntryFromTimeEntry (timeEntry)

Creates an History entry holding several identical values with same reason and regular updates by a time entry .

createIntervalEntryFromTimeEntry Parameters

decompress

decompress (history) => {Array.<Decompressed>}

Decomresses a history entry to an external format

decompress Parameters

decompress returns

getLastIntervalEntries

getLastIntervalEntries (timeEntry, options) => {IntervalEntry}

Checks , if last entries in a timeEntry can be converted to an interval entry

getLastIntervalEntries Parameters

getLastIntervalEntries returns

isIntervalEntry

isIntervalEntry (timeEntry, options) => {boolean}

Checks , if a time entry can be converted to a interval entry

isIntervalEntry Parameters

options properties

isIntervalEntry returns

splitTimeEntryIfAppropriate

splitTimeEntryIfAppropriate (history, options) => {Array.<HistoryEntry>}

Checks to split the last history time entry

splitTimeEntryIfAppropriate Parameters

splitTimeEntryIfAppropriate returns

splitTimeValueEntryIfAppropriate

splitTimeValueEntryIfAppropriate (history, options) => {Array.<HistoryEntry>}

Checks to split the last history timeValue entry

splitTimeValueEntryIfAppropriate Parameters

splitTimeValueEntryIfAppropriate returns

Class MessageTree

new MessageTree(options)

Data structure holding a large amount of messages with topic , value and reason in a tree organized according the topic . Each tree node containing data provides a "history" including recent messages . It includes several methods to "compress" the history of messages of each topic

MessageTree Parameters

MessageTree Methods

_isRequiredReason

_isRequiredReason (reason1, reason2) => {boolan}

Compares two reason objects

_isRequiredReason Parameters

_isRequiredReason returns

addData

addData (message, cur)

Adds data to the three node matching to the topic path . It will store the current time , data and descrition to the node and the former time and data entry is copied to the history array property .

addData Parameters

message properties

cleanup

cleanup (daysWithoutUpdateToBeRemoved)

Removes all outdated nodes . An outdated node is a node with no update in the last days and without any child with an update in the last days

cleanup Parameters

getNode

getNode (topic) => {Object}

Searches a node in the message tree corresponding to the topic .

getNode Parameters

getNode returns

getNodes

getNodes (requiredNodes, addHistory, addReason)

Gets a list of nodes - if different ( in value or reason ) than the provided nodes

getNodes Parameters

getSection

getSection (topic, levelAmount, nodes, addHistory, addReason) => {Object.<payload:Object[]>}

Gets several levels of child nodes in an array of nodes

getSection Parameters

getSection returns

persist

async persist (directory, filenameBasis)

Persists all connections

persist Parameters

readTreeFromPersistedFile

readTreeFromPersistedFile (directory, filenameBasis)

Reads the tree from a persisted file

readTreeFromPersistedFile Parameters