signalk-automation-plugin 0.0.3 → 0.0.5

package/README.md

@@ -36,34 +36,34 @@ Do not paste automations into the admin form. Runtime state is `~/.signalk/plugi
 
 ## Example
 
-See `examples/automations.yaml`. Boatnet live YAML is `git@github.com:htool/boatnet_automations.git` (`automationsDir` on the Pi). On/off and Verbose are plugin-data switches, not YAML keys.
+See `examples/automations.yaml` (fictional sample). Live YAML is whatever directory you set as `automationsDir` — usually a separate git. On/off and Verbose are plugin-data switches, not YAML keys.
 
 ```yaml
 helpers:
-  starlink_manual:
+  dish_manual:
     type: boolean
     default: false
     on_start: restore   # survive reboot
-    latch_on_external_put: electrical.switches.starlink.state
+    latch_on_external_put: electrical.switches.dish.state
 
 automations:
-  - id: starlink_standby
+  - id: dish_standby
     trigger:
       - schedule: "0 4 * * *"
     condition:
       - zone: home_harbour
-      - helper: starlink_manual
+      - helper: dish_manual
         is: false
     action:
-      - put: electrical.switches.starlink.state
+      - put: electrical.switches.dish.state
         value: true
       - delay: 15m
-      - put: electrical.switches.starlink.state
+      - put: electrical.switches.dish.state
         value: false
 ```
 
 ```yaml
-- path: electrical.switches.dolphinCharger.voltage
+- path: electrical.switches.charger.voltage
   round: 1          # nearest volt; 230.1 and 230.4 do not both fire
 ```
 

package/examples/automations.yaml

@@ -1,103 +1,105 @@
+# Bundled sample only. Site YAML belongs in the git you set as automationsDir,
+# not in this plugin.
+
 helpers:
-  starlink_manual:
+  dish_manual:
     type: boolean
-    name: Starlink handmatig
+    name: Dish manual
     default: false
     on_start: restore
-    latch_on_external_put: electrical.switches.starlink.state
-  depart_prep:
+    latch_on_external_put: electrical.switches.dish.state
+  trip_prep:
     type: boolean
-    name: Maak klaar voor vertrek
+    name: Prepare to leave
     default: false
     on_start: restore
 
 automations:
   - id: shore_charge
-    alias: Walstroom laadbeleid
+    alias: Shore charge
     zones:
       home_harbour:
-        name: Thuishaven
-        lat: 52.37
-        lon: 5.22
+        name: Home harbour
+        lat: 52.1
+        lon: 4.9
         radius: 150
     trigger:
-      - path: sensors.presence.dolphinshelly
+      - path: sensors.presence.shore
       - path: electrical.batteries.house.capacity.stateOfCharge
         round: 0.01
-      - helper: depart_prep
+      - helper: trip_prep
     choose:
-      - alias: onderweg volladen
+      - alias: charge underway
         conditions:
-          - path: sensors.presence.dolphinshelly
+          - path: sensors.presence.shore
             is: true
           - not:
               zone: home_harbour
         action:
-          - put: electrical.switches.dolphinCharger.state
+          - put: electrical.switches.charger.state
             value: 1
-      - alias: klaar voor vertrek laden
+      - alias: charge to leave
         conditions:
-          - path: sensors.presence.dolphinshelly
+          - path: sensors.presence.shore
             is: true
           - zone: home_harbour
-          - helper: depart_prep
+          - helper: trip_prep
             is: true
           - path: electrical.batteries.house.capacity.stateOfCharge
             below: 0.98
         action:
-          - put: electrical.switches.dolphinCharger.state
+          - put: electrical.switches.charger.state
             value: 1
-      - alias: klaar voor vertrek vol
+      - alias: leave charged
         conditions:
-          - path: sensors.presence.dolphinshelly
+          - path: sensors.presence.shore
             is: true
           - zone: home_harbour
-          - helper: depart_prep
+          - helper: trip_prep
             is: true
           - path: electrical.batteries.house.capacity.stateOfCharge
             above: 0.97
         action:
-          - put: electrical.switches.dolphinCharger.state
+          - put: electrical.switches.charger.state
             value: 0
-          - helper: depart_prep
+          - helper: trip_prep
             value: false
-      - alias: thuis onder 60%
+      - alias: home below 60%
         conditions:
-          - path: sensors.presence.dolphinshelly
+          - path: sensors.presence.shore
             is: true
           - zone: home_harbour
-          - helper: depart_prep
+          - helper: trip_prep
             is: false
           - path: electrical.batteries.house.capacity.stateOfCharge
             below: 0.6
         action:
-          - put: electrical.switches.dolphinCharger.state
+          - put: electrical.switches.charger.state
             value: 1
-      - alias: thuis boven 80%
+      - alias: home above 80%
         conditions:
-          - path: sensors.presence.dolphinshelly
+          - path: sensors.presence.shore
             is: true
           - zone: home_harbour
-          - helper: depart_prep
+          - helper: trip_prep
             is: false
           - path: electrical.batteries.house.capacity.stateOfCharge
             above: 0.8
         action:
-          - put: electrical.switches.dolphinCharger.state
+          - put: electrical.switches.charger.state
             value: 0
 
-  - id: starlink_standby
-    alias: Starlink standby-update
+  - id: dish_standby
+    alias: Dish standby update
     trigger:
       - schedule: "0 4 * * *"
     condition:
-      # home_harbour is defined on shore_charge (Walstroom laadbeleid).
       - zone: home_harbour
-      - helper: starlink_manual
+      - helper: dish_manual
         is: false
     action:
-      - put: electrical.switches.starlink.state
+      - put: electrical.switches.dish.state
         value: true
       - delay: 15m
-      - put: electrical.switches.starlink.state
+      - put: electrical.switches.dish.state
         value: false

package/lib/engine.js

@@ -69,7 +69,7 @@ function evalClause (clause, ctx) {
     }
   }
   if (Array.isArray(clause.all)) {
-    const parts = clause.all.map((c) => evalClause(c, ctx))
+    const parts = clause.all.map((c) => withLabel(c, evalClause(c, ctx)))
     return {
       pass: parts.every((p) => p.pass),
       error: parts.find((p) => p.error)?.error || null,
@@ -78,10 +78,11 @@ function evalClause (clause, ctx) {
     }
   }
   if (Array.isArray(clause.any)) {
-    const parts = clause.any.map((c) => evalClause(c, ctx))
+    const parts = clause.any.map((c) => withLabel(c, evalClause(c, ctx)))
+    const pass = parts.some((p) => p.pass)
     return {
-      pass: parts.some((p) => p.pass),
-      error: parts.find((p) => p.error)?.error || null,
+      pass,
+      error: pass ? null : (parts.find((p) => p.error)?.error || null),
       actual: parts,
       clause: { any: true }
     }
@@ -131,6 +132,18 @@ function evalClause (clause, ctx) {
     return { pass: false, error: 'clause needs path, helper, zone, or run', actual: null }
   }
   const actual = getByPath(ctx.values, path)
+  const needsValue = ['is', 'equals', 'above', 'below', 'to'].some((k) =>
+    Object.prototype.hasOwnProperty.call(clause, k)
+  )
+  if (needsValue && (actual === undefined || actual === null)) {
+    return {
+      pass: false,
+      error: 'missing',
+      actual,
+      path,
+      expected: expectedOf(clause)
+    }
+  }
   let pass = false
   if (Object.prototype.hasOwnProperty.call(clause, 'is')) {
     pass = actual === clause.is
@@ -228,10 +241,20 @@ function clauseLabel (clause, result) {
 
 function markPass (r) {
   if (!r) return '✗'
-  if (r.error) return '✗'
+  if (r.error && !r.pass) return '✗'
   return r.pass ? '✓' : '✗'
 }
 
+function appendClauseLines (lines, r, indent) {
+  if (!r) return
+  lines.push(indent + markPass(r) + ' ' + (r.label || ''))
+  const inner = r.clause && (r.clause.any || r.clause.all)
+  if (!inner || !Array.isArray(r.actual)) return
+  for (const part of r.actual) {
+    appendClauseLines(lines, part, indent + '  ')
+  }
+}
+
 function withLabel (clause, result) {
   const row = result && typeof result === 'object' ? result : { pass: false }
   row.clause = clause
@@ -279,9 +302,13 @@ async function evalListAll (list, ctx) {
   return { pass, results }
 }
 
+function resultLabel (result) {
+  return result === 'failure' ? 'Failed' : 'OK'
+}
+
 function formatVerboseLog (auto, record) {
   const name = (auto && (auto.alias || auto.id)) || (record && record.id) || 'automation'
-  const result = record.result || 'skipped'
+  const result = resultLabel(record.result)
   const head = name + ' → ' + result + (record.reason ? ' (' + record.reason + ')' : '')
   const lines = [head]
   if (record.firedBy) lines.push('  trigger: ' + record.firedBy)
@@ -297,7 +324,7 @@ function formatVerboseLog (auto, record) {
   for (const b of record.branches || []) {
     lines.push('  ' + (b.picked ? '→ ' : '  ') + b.alias + (b.picked ? '' : ''))
     for (const c of b.conditions || []) {
-      lines.push('    ' + markPass(c) + ' ' + (c.label || ''))
+      appendClauseLines(lines, c, '    ')
     }
   }
   return lines.join('\n')
@@ -392,7 +419,7 @@ async function evaluateAutomation (auto, ctx) {
   const record = {
     ts: new Date(ctx.now || Date.now()).toISOString(),
     id: auto.id,
-    result: 'skipped',
+    result: 'ok',
     trigger: ctx.trigger || null,
     firedBy: triggerFiredLabel(ctx.trigger),
     conditions: [],
@@ -416,7 +443,7 @@ async function evaluateAutomation (auto, ctx) {
   record.conditions = cond.results
   if ((auto.condition || []).length && !cond.pass) {
     const failed = cond.results.find((r) => r.error)
-    record.result = failed ? 'failure' : 'skipped'
+    record.result = failed ? 'failure' : 'ok'
     record.reason = failed ? failed.error : 'condition not met'
     return finishRecord(auto, record)
   }
@@ -441,6 +468,7 @@ async function evaluateAutomation (auto, ctx) {
       record.branches.push(row)
     }
     if (!picked) {
+      record.result = 'ok'
       record.reason = 'no matching choose branch'
       return finishRecord(auto, record)
     }

package/lib/runtime.js

@@ -135,17 +135,24 @@ class Runtime {
   }
 
   async handlePathChange (p, value, source) {
+    const previous = Object.prototype.hasOwnProperty.call(this.values, p)
+      ? this.values[p]
+      : undefined
     this.setPathValue(p, value, { $source: source })
-    await this.applyLatches(p, source)
+    await this.applyLatches(p, source, previous)
     await this.kickPath(p, value)
   }
 
-  async applyLatches (p, source) {
+  async applyLatches (p, source, previous) {
     const fromSelf = source && String(source).includes(this.pluginId)
     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
     for (const def of Object.values(this.doc.helpers)) {
       if (def.latch_on_external_put === p && def.type === 'boolean') {
-        if (this.values[p]) await this.setHelper(def.id, true)
+        await this.setHelper(def.id, true)
       }
     }
   }
@@ -439,6 +446,12 @@ class Runtime {
   }
 }
 
+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/package.json

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

package/plugin/index.js

@@ -305,15 +305,36 @@ module.exports = function (app) {
     })
   }
 
-  function putPath (p, value) {
-    return new Promise((resolve, reject) => {
-      if (typeof app.putSelfPath !== 'function') {
-        app.handleMessage(PLUGIN_ID, {
-          updates: [{ values: [{ path: p, value }] }]
-        })
-        resolve()
-        return
+  function isMultipleSources (err) {
+    return /multiple sources for the given path/i.test(String((err && err.message) || err || ''))
+  }
+
+  function putSources (p) {
+    const out = []
+    const seen = Object.create(null)
+    const add = (s) => {
+      if (!s) return
+      const id = String(s)
+      if (seen[id] || id.includes(PLUGIN_ID)) return
+      seen[id] = true
+      out.push(id)
+    }
+    const node = typeof app.getSelfPath === 'function' ? app.getSelfPath(p) : null
+    if (node && typeof node === 'object' && !Array.isArray(node)) {
+      add(node.$source)
+      const vals = node.values
+      if (vals && typeof vals === 'object') {
+        Object.keys(vals)
+          .sort((a, b) => Number(/^mqtt\b/i.test(b)) - Number(/^mqtt\b/i.test(a)))
+          .forEach(add)
       }
+    }
+    if (runtime && runtime.values) add(runtime.values[p + '.$source'])
+    return out
+  }
+
+  function callPutSelf (p, value, source) {
+    return new Promise((resolve, reject) => {
       let settled = false
       const finish = (err) => {
         if (settled) return
@@ -332,7 +353,9 @@ module.exports = function (app) {
         finish(null)
       }
       try {
-        const ret = app.putSelfPath(p, value, fromReply)
+        const ret = source
+          ? app.putSelfPath(p, value, fromReply, source)
+          : app.putSelfPath(p, value, fromReply)
         if (ret && typeof ret.then === 'function') {
           ret.then(fromReply, finish)
         }
@@ -342,6 +365,30 @@ module.exports = function (app) {
     })
   }
 
+  async function putPath (p, value) {
+    if (typeof app.putSelfPath !== 'function') {
+      app.handleMessage(PLUGIN_ID, {
+        updates: [{ values: [{ path: p, value }] }]
+      })
+      return
+    }
+    try {
+      await callPutSelf(p, value)
+    } catch (err) {
+      if (!isMultipleSources(err)) throw err
+      let last = err
+      for (const source of putSources(p)) {
+        try {
+          await callPutSelf(p, value, source)
+          return
+        } catch (e) {
+          last = e
+        }
+      }
+      throw last
+    }
+  }
+
   function notify (p, state, message) {
     const npath = String(p).startsWith('notifications.') ? p : 'notifications.' + p
     app.handleMessage(PLUGIN_ID, {

package/public/app.js

@@ -73,9 +73,15 @@ async function checkLogin () {
 
 function el (id) { return document.getElementById(id) }
 
+function displayResult (result) {
+  if (!result) return '—'
+  if (result === 'failure') return 'Failed'
+  return 'OK'
+}
+
 function badge (result) {
-  const r = result || '—'
-  return '<span class="badge ' + (result || '') + '">' + r + '</span>'
+  const klass = !result ? '' : result === 'failure' ? 'failure' : 'ok'
+  return '<span class="badge ' + klass + '">' + displayResult(result) + '</span>'
 }
 
 function fmtVal (v) {
@@ -136,15 +142,18 @@ function fmtRunRecord (t) {
 function fmtTime (iso) {
   if (!iso) return ''
   try {
-    return new Date(iso).toLocaleString('nl-NL', {
+    const d = new Date(iso)
+    if (Number.isNaN(d.getTime())) return iso
+    return new Intl.DateTimeFormat('nl-NL', {
+      timeZone: 'Europe/Amsterdam',
       year: 'numeric',
       month: '2-digit',
       day: '2-digit',
       hour: '2-digit',
       minute: '2-digit',
       second: '2-digit',
-      hour12: false
-    })
+      hourCycle: 'h23'
+    }).format(d)
   } catch (_) { return iso }
 }
 

package/public/index.html

@@ -5,7 +5,7 @@
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <title>Signal K Automations</title>
     <link rel="icon" href="icon.png" />
-    <link rel="stylesheet" href="style.css?v=20260915h24" />
+    <link rel="stylesheet" href="style.css?v=20260918ok" />
   </head>
   <body>
     <header>
@@ -61,6 +61,6 @@
         </div>
       </section>
     </main>
-    <script src="app.js?v=20260915h24"></script>
+    <script src="app.js?v=20260918ok"></script>
   </body>
 </html>