signalk-automation-plugin 0.0.4 → 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "signalk-automation-plugin",
-  "version": "0.0.4",
+  "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, {