signalk-automation-plugin 0.0.9 → 0.0.11

package/README.md

@@ -31,8 +31,9 @@ Not Node-RED. Not a Home Assistant YAML clone. Actions are Signal K PUTs, helper
 | Allowed scripts directory | Only relative `run.file` paths under this dir |
 | Decision records to keep | Ring buffer per automation |
 | Script timeout | Seconds |
+| Startup silence | Seconds after start (default 60, 0 = off) during which path triggers do not fire; values are still recorded |
 
-Do not paste automations into the admin form. Runtime state is `~/.signalk/plugin-config-data/signalk-automation-plugin/` (`state.json`, `live/`, `traces/`).
+Do not paste automations into the admin form. Runtime state is `~/.signalk/plugin-config-data/signalk-automation-plugin/` (`state.json`, `live/`, `traces/`). `state.json` also keeps the last seen value of each trigger path (`pathValues`), so the same value republished after a restart does not re-trigger.
 
 ## Example
 

package/lib/engine.js

@@ -74,6 +74,23 @@ function evalClause (clause, ctx) {
       clause: { not: true }
     }
   }
+  if (clause.triggered) {
+    const want = clause.triggered
+    const fired = ctx.trigger && ctx.trigger.path
+    let expected = null
+    if (want && typeof want === 'object') {
+      if (want.helper) expected = helperPath(want.helper)
+      else if (want.path) expected = want.path
+    } else if (typeof want === 'string') {
+      expected = want
+    }
+    return {
+      pass: expected != null && fired === expected,
+      error: expected == null ? 'triggered needs helper or path' : null,
+      actual: fired || null,
+      expected
+    }
+  }
   if (Array.isArray(clause.all)) {
     const parts = clause.all.map((c) => withLabel(c, evalClause(c, ctx)))
     return {
@@ -212,6 +229,12 @@ function fmtVal (value) {
 function clauseLabel (clause, result) {
   if (!clause || typeof clause !== 'object') return ''
   if (clause.not) return 'not ' + clauseLabel(clause.not, result)
+  if (clause.triggered) {
+    const want = clause.triggered
+    if (want && want.helper) return 'triggered helper ' + want.helper
+    if (want && want.path) return 'triggered path ' + want.path
+    return 'triggered ' + fmtVal(want)
+  }
   if (Array.isArray(clause.all)) return 'all'
   if (Array.isArray(clause.any)) return 'any'
   if (clause.zone) {
@@ -636,6 +659,20 @@ function sameValue (a, b) {
   return false
 }
 
+function asSwitch (v) {
+  if (v === true || v === 1 || v === '1' || v === 'on' || v === 'ON') return 1
+  if (v === false || v === 0 || v === '0' || v === 'off' || v === 'OFF') return 0
+  return null
+}
+
+function valueUnchanged (previous, next) {
+  if (previous === undefined) return false
+  if (sameValue(previous, next)) return true
+  const a = asSwitch(previous)
+  const b = asSwitch(next)
+  return a !== null && a === b
+}
+
 function makeRunScript (opts) {
   return function (spec) {
     return runScript({
@@ -664,6 +701,8 @@ module.exports = {
   makeRunScript,
   parseDuration,
   sameValue,
+  asSwitch,
+  valueUnchanged,
   clauseLabel,
   triggerFiredLabel,
   triggerListMatched,

package/lib/runtime.js

@@ -17,6 +17,9 @@ class Runtime {
     this.scriptsDir = opts.scriptsDir
     this.traceCount = opts.traceCount || 20
     this.scriptTimeoutMs = (opts.scriptTimeoutSeconds || 30) * 1000
+    const silence = Number(opts.startupSilenceSeconds)
+    this.startupSilenceMs = (Number.isFinite(silence) && silence >= 0 ? silence : 0) * 1000
+    this.startedAt = null
     this.now = opts.now || (() => Date.now())
     this.sleep = opts.sleep || ((ms) => new Promise((r) => setTimeout(r, ms)))
     this.putFn = opts.put
@@ -39,6 +42,8 @@ class Runtime {
 
   load () {
     this.state = store.loadState(this.dataDir)
+    if (!this.state.pathValues || typeof this.state.pathValues !== 'object') this.state.pathValues = {}
+    this.startedAt = this.now()
     const live = store.liveDir(this.dataDir)
     const from = fs.existsSync(live) ? live : this.automationsDir
     this.doc = yaml.loadYamlDir(from)
@@ -145,12 +150,53 @@ class Runtime {
     }
   }
 
+  triggerPaths () {
+    const paths = new Set()
+    for (const auto of this.doc.automations) {
+      for (const t of auto.trigger || []) {
+        if (t && typeof t.path === 'string') paths.add(t.path)
+      }
+    }
+    return paths
+  }
+
+  inStartupSilence () {
+    if (this.startedAt == null || !(this.startupSilenceMs > 0)) return false
+    return this.now() - this.startedAt < this.startupSilenceMs
+  }
+
+  rememberPathValue (p, value) {
+    if (!this.triggerPaths().has(p)) return
+    const pv = this.state.pathValues || (this.state.pathValues = {})
+    const has = Object.prototype.hasOwnProperty.call(pv, p)
+    if (has && engine.sameValue(pv[p], value)) return
+    if (value === undefined) return
+    try {
+      pv[p] = JSON.parse(JSON.stringify(value))
+    } catch (_) {
+      return
+    }
+    store.saveState(this.dataDir, this.state)
+  }
+
   async handlePathChange (p, value, source) {
-    const previous = Object.prototype.hasOwnProperty.call(this.values, p)
+    let previous = Object.prototype.hasOwnProperty.call(this.values, p)
       ? this.values[p]
       : undefined
+    const inMemory = previous !== undefined
+    const pv = this.state.pathValues || {}
+    if (!inMemory && Object.prototype.hasOwnProperty.call(pv, p)) {
+      // Value remembered from before a restart.
+      previous = pv[p]
+    }
     this.setPathValue(p, value, { $source: source })
-    await this.applyLatches(p, source, previous)
+    this.rememberPathValue(p, value)
+    await this.applyLatches(p, source, inMemory ? previous : undefined)
+    if (engine.valueUnchanged(previous, value)) return
+    if (this.inStartupSilence()) {
+      this.log.debug('startup silence: not triggering on ' + p)
+      return
+    }
     await this.kickPath(p, value)
   }
 
@@ -159,8 +205,7 @@ class Runtime {
     if (fromSelf) return
     if (previous === undefined) return
     const next = this.values[p]
-    if (engine.sameValue(previous, next)) return
-    if (asSwitch(previous) !== null && asSwitch(previous) === asSwitch(next)) return
+    if (engine.valueUnchanged(previous, next)) return
     for (const def of Object.values(this.doc.helpers)) {
       if (def.latch_on_external_put === p && def.type === 'boolean') {
         await this.setHelper(def.id, true)
@@ -507,12 +552,6 @@ function newAbort () {
   return abort
 }
 
-function asSwitch (v) {
-  if (v === true || v === 1 || v === '1' || v === 'on' || v === 'ON') return 1
-  if (v === false || v === 0 || v === '0' || v === 'off' || v === 'OFF') return 0
-  return null
-}
-
 function holdMs (auto) {
   for (const t of auto.trigger || []) {
     if (t.for) {

package/lib/store.js

@@ -9,7 +9,8 @@ function emptyState () {
     enabled: {},
     verbose: {},
     activeSha: null,
-    lastRun: {}
+    lastRun: {},
+    pathValues: {}
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "signalk-automation-plugin",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "Home Assistant-like YAML automations for Signal K",
   "main": "plugin/index.js",
   "keywords": [

package/plugin/index.js

@@ -84,6 +84,13 @@ module.exports = function (app) {
         title: 'Script timeout (seconds)',
         default: 30,
         minimum: 1
+      },
+      startupSilence: {
+        type: 'number',
+        title: 'Startup silence (seconds)',
+        description: 'After start, path triggers do not fire for this many seconds (values are still recorded). 0 = off.',
+        default: 60,
+        minimum: 0
       }
     }
   }
@@ -424,6 +431,7 @@ module.exports = function (app) {
       scriptsDir: options.scriptsDir || '',
       traceCount: options.traceCount,
       scriptTimeoutSeconds: options.scriptTimeoutSeconds,
+      startupSilenceSeconds: options.startupSilence == null ? 60 : options.startupSilence,
       put: putPath,
       notify,
       onHelper: (id, value) => emitHelper(id, value),