@mangar2/rules v3.0.0

Abstract

The rule history stores the history for each rule and each topic in the rule For all rulename entries , it stores the

• value : The current value of the message created by the rule
• firstFound : The date the same value was first found
• lastSent : The date the message was last sent

Contents

• Meta
• Type definitions
• Global Functions
  • timeInMillisecondsToLocalTimeString
• Class ProcessRule
  • Parameters
  • Members
  • Methods
    • _checkWeekday
    • _createMessage
    • _deriveAllMessagesFromRule
    • check
    • determineNeededVariables
    • setVariable
• Class Rules
  • Parameters
  • Methods
    • _addToNodeRec
    • _invalidateRule
    • checkRules
    • deleteRule
    • findRule
    • getInvalidRules
    • getRuleTree
    • getRules
    • setRule
• Class Variables
  • Parameters
  • Methods
    • _addInternVariable
    • calculateInternalVariables
    • getAllVariables
    • getValue
    • isExternVariable
    • setValue

Meta

Type definitions

HistoryEntry {Object}

Decision {Object}

Rule {Object}

Global functions

timeInMillisecondsToLocalTimeString

timeInMillisecondsToLocalTimeString (timestamp)

Converts a timestamp to a string with the local time of day in brackets

timeInMillisecondsToLocalTimeString Parameters

Class ProcessRule

new ProcessRule(date, longitude, latitude)

Processes rules based on a set of variables

ProcessRule Parameters

ProcessRule Members

ProcessRule Methods

_checkWeekday

_checkWeekday (rule, weekdays) => {}

Check , if the days of the week of the rule matches the current weekday

_checkWeekday Parameters

_checkWeekday returns

_createMessage

_createMessage (topic, valueProperty, reason, qos) => {Message}

Creates a message

_createMessage Parameters

_createMessage returns

_deriveAllMessagesFromRule

_deriveAllMessagesFromRule (rule, motionEvents, nonMotionEvents) => {Object.<messages:Message[], usedVariables>}

Derives all messages from the rule

_deriveAllMessagesFromRule Parameters

_deriveAllMessagesFromRule throws

_deriveAllMessagesFromRule returns

check

check (rule, motionEvents, nonMotionEvents) => {Object.<messages:Message[], usedVariables>}

Processes a rule and if the rule demands , create a message

check Parameters

check throws

check returns

determineNeededVariables

determineNeededVariables (rule) => {Object}

Gets a list of needed ( external ) variables for the rule

determineNeededVariables Parameters

determineNeededVariables returns

setVariable

setVariable (name, value)

Sets a single variable

setVariable Parameters

Class Rules

new Rules(rulesTree, check)

Creates an object holding automation rules

Example

const rulesTree =
 {
      location1: {
          rules: {
              rule1: {
                  title: 'hello'
              },
              rule2: {
                  title: 'world'
              }
          }
      },
      location2: {
          rule1: {
              error: 'faulty rule'
          }
      }
  }
const checkRule = new CheckInput({ type: 'object', properties: { title: { type: string } }, required: ['title'] })
const rules = new Rules(rulesTree, checkRules)
console.log(rules.rules.length) // prints 1, we have one correct rule
console.log(rules.invalidRules[0].messages) // prints the error messages for rule 'location2'

Rules Parameters

Rules Methods

_addToNodeRec

_addToNodeRec (node, nameChunks, rule)

Adds a rule to a tree node recursively

_addToNodeRec Parameters

_invalidateRule

_invalidateRule (name, messages, validFlag)

Invalidates a rule , because it generates an error

_invalidateRule Parameters

checkRules

checkRules (processRule) => {Object.<variables:{[index:string]:string|number>Array.<, messages:Message>}

Checks all rules for errors , prints errors to console

checkRules Parameters

checkRules returns

deleteRule

deleteRule (name)

Deletes a rule

deleteRule Parameters

findRule

findRule (name) => {Rule, null}

Finds a rule in the rule list

findRule Parameters

findRule returns

getInvalidRules

getInvalidRules () => {Array.<Rule>}

Get the invalid rules list

getInvalidRules returns

getRuleTree

getRuleTree () => {}

Returns all rules in a tree of rules

getRuleTree returns

getRules

getRules () => {Array.<Rule>}

Get the valid rules list

getRules returns

setRule

setRule (rule) => {}

Adds or updates a rule to the list of rules , checks its validity and sets a "isValid" property accordingly

setRule Parameters

setRule returns

Class Variables

new Variables(date, longitude, latitude)

Manages a set of variables

Variables Parameters

Variables Methods

_addInternVariable

_addInternVariable (name, value)

Adds a variable ( coming from the service itself ) to the variable list

_addInternVariable Parameters

calculateInternalVariables

calculateInternalVariables ()

Calculates all internal variables ( usually after a date change )

getAllVariables

getAllVariables () => {Object.<key:string, value:any>}

Gets a key/value map of all variables

getAllVariables returns

getValue

getValue (name) => {any}

Returns the value of the variable

getValue Parameters

getValue returns

isExternVariable

isExternVariable (name) => {boolean}

Returns true , if the variable is an external variable required from outside

isExternVariable Parameters

isExternVariable returns

setValue

setValue (name, value)

Sets the value of an existing variable

setValue Parameters